10:51 a.m.
This implements the fixes/suggestions that Jan had from my earlier send. Of note:
- The key for providers is now the base URL, e.g., 'http://example.com:5000/api'
instead of 'example.com'.
- The methods are "get", "post", etc., instead of
"authenticated_get", etc.
10:51 a.m.
New subject: [PATCH 1/2] Implements OAuthClient library
---
aeolus-conductor.spec.in | 1 +
src/Gemfile | 1 +
src/Gemfile.lock | 2 +
src/config/settings.yml | 4 +++
src/lib/oauth_client.rb | 61 ++++++++++++++++++++++++++++++++++++++++++++++
5 files changed, 69 insertions(+), 0 deletions(-)
create mode 100644 src/lib/oauth_client.rb
diff --git a/aeolus-conductor.spec.in b/aeolus-conductor.spec.in
index 9f5b6c2..b974a1d 100644
--- a/aeolus-conductor.spec.in
+++ b/aeolus-conductor.spec.in
@@ -36,6 +36,7 @@ Requires: rubygem(rails_warden)
Requires: rubygem(aeolus-image)
Requires: rubygem(pg)
Requires: rubygem(ruby-net-ldap)
+Requires: rubygem(oauth)
Requires: postgresql
Requires: postgresql-server
diff --git a/src/Gemfile b/src/Gemfile
index db6f949..2d8e8df 100644
--- a/src/Gemfile
+++ b/src/Gemfile
@@ -21,6 +21,7 @@ gem 'fastercsv'
gem 'rails_warden'
gem 'ruby-net-ldap'
gem 'aeolus-image'
+gem 'oauth'
group :development, :test do
gem 'rspec-rails'
gem 'rspec-core'
diff --git a/src/Gemfile.lock b/src/Gemfile.lock
index 5c0b601..51c00f4 100644
--- a/src/Gemfile.lock
+++ b/src/Gemfile.lock
@@ -84,6 +84,7 @@ GEM
treetop (~> 1.4.8)
mime-types (1.16)
nokogiri (1.5.0.beta.4)
+ oauth (0.4.4)
pg (0.11.0)
polyglot (0.3.1)
rack (1.3.0)
@@ -174,6 +175,7 @@ DEPENDENCIES
json
launchy
nokogiri
+ oauth
pg
rack-restful_submit
rails (>= 3.0.7)
diff --git a/src/config/settings.yml b/src/config/settings.yml
index 0a629f1..974dd83 100644
--- a/src/config/settings.yml
+++ b/src/config/settings.yml
@@ -12,3 +12,7 @@
# :port: 389
:iwhd:
:url: http://localhost:9090
+# :oauth:
+# 'http://example.com:5000/api':
+# :consumer_key: consumer_key_here
+# :consumer_secret: consumer_secret_here
diff --git a/src/lib/oauth_client.rb b/src/lib/oauth_client.rb
new file mode 100644
index 0000000..b378030
--- /dev/null
+++ b/src/lib/oauth_client.rb
@@ -0,0 +1,61 @@
+class OAuthClient
+ require 'oauth'
+
+ def initialize(resource)
+ @consumer = OAuth::Consumer.new(
+ consumer_key_for_resource(resource),
+ consumer_secret_for_resource(resource),
+ :site => resource
+ )
+ @access_token = OAuth::AccessToken.new(@consumer)
+ end
+
+ def delete(uri, headers=nil)
+ headers ||= default_headers
+ @access_token.delete(uri, headers)
+ end
+
+ def get(uri, headers=nil)
+ headers ||= default_headers
+ @access_token.get(uri, headers)
+ end
+
+ def head(uri, headers=nil)
+ headers ||= default_headers
+ @access_token.head(uri, headers)
+ end
+
+ def post(uri, body='', headers=nil)
+ headers ||= default_headers
+ @access_token.post(uri, body, headers)
+ end
+
+ def put(uri, body='', headers=nil)
+ headers ||= default_headers
+ @access_token.put(uri, body, headers)
+ end
+
+ private
+
+ # Default headers - override in specific clients
+ def default_headers
+ nil
+ end
+
+ def consumer_key_for_resource(resource)
+ @consumer_key ||= consumer_credentials_for_resource(resource)[:consumer_key]
+ end
+
+ def consumer_secret_for_resource(resource)
+ @consumer_secret ||= consumer_credentials_for_resource(resource)[:consumer_secret]
+ end
+
+ def consumer_credentials_for_resource(resource)
+ begin
+ SETTINGS_CONFIG[:oauth][resource].reject{|k,v| ![:consumer_key,
:consumer_secret].include?(k) }
+ rescue
+ raise "No credentials found in settings.yml for provider #{resource}"
+ end
+ end
+
+end
--
1.7.6.2
10:51 a.m.
New subject: [PATCH 2/2] RSpec tests to support OAuthClient code
---
src/spec/models/oauth_client_spec.rb | 61 ++++++++++++++++++++++++++++++++++
src/spec/vcr/cassettes/oauth.yml | 61 ++++++++++++++++++++++++++++++++++
src/spec/vcr_setup.rb | 10 +++++
3 files changed, 132 insertions(+), 0 deletions(-)
create mode 100644 src/spec/models/oauth_client_spec.rb
create mode 100644 src/spec/vcr/cassettes/oauth.yml
diff --git a/src/spec/models/oauth_client_spec.rb b/src/spec/models/oauth_client_spec.rb
new file mode 100644
index 0000000..e9f5630
--- /dev/null
+++ b/src/spec/models/oauth_client_spec.rb
@@ -0,0 +1,61 @@
+#
+# Copyright (C) 2011 Red Hat, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1301, USA. A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+
+require 'spec_helper'
+require 'oauth_client'
+
+describe OAuthClient do
+
+ before(:each) do
+ # Make sure this is initalized; we don't want test data in our global config
+ SETTINGS_CONFIG[:oauth] ||= {}
+ end
+
+ it "should get authenticated resource with custom header" do
+ # These are the proper configurations
+ SETTINGS_CONFIG[:oauth]['http://example.com:5000/api'] = {
+ :consumer_key => 'valid',
+ :consumer_secret => 'good_secret'
+ }
+ client = OAuthClient.new('http://example.com:5000/api')
+ consumer = client.instance_variable_get('@consumer')
+ # We need to stub out sign! since it's otherwise unique on every request
+ consumer.stub('sign!') do |request, *args|
+ request['authorization'] = 'OAuth
oauth_consumer_key="cloud_forms",
oauth_nonce="ieQTc0gxyo6Z4PlQkgPvxdRCyvrtsLAVU9zfVdyDsnE",
oauth_signature="u%2B9yniABqqpQgTAmQQJS5tNEv4g%3D",
oauth_signature_method="HMAC-SHA1", oauth_timestamp="1317068969",
oauth_version="1.0"'
+ request['user-agent'] = 'OAuth gem v0.4.4'
+ end
+ response = client.get('/katello/api/organizations', {'katello-user'
=> 'admin'})
+ response.code.should match("200")
+ end
+
+ it "should return a 401 for invalid credentials" do
+ SETTINGS_CONFIG[:oauth]['http://example.com:5000/api'] = {
+ :consumer_key => 'test',
+ :consumer_secret => 'failure'
+ }
+ client = OAuthClient.new('http://example.com:5000/api')
+ consumer = client.instance_variable_get('@consumer')
+ consumer.stub('sign!') do |request, *args|
+ request['authorization'] = 'OAuth oauth_consumer_key="test",
oauth_nonce="zoT39JgdwI0fjqg9ZfJ2xN4QxyJyIghW7wWUHAxfY",
oauth_signature="UFM87n9CcQXGsOUbHttPJs9NQOg%3D",
oauth_signature_method="HMAC-SHA1", oauth_timestamp="1317068970",
oauth_version="1.0"'
+ request['user-agent'] = 'OAuth gem v0.4.4'
+ end
+ response = client.get('/katello/api/organizations', {'katello-user'
=> 'admin'})
+ response.code.should match("401")
+ end
+
+end
diff --git a/src/spec/vcr/cassettes/oauth.yml b/src/spec/vcr/cassettes/oauth.yml
new file mode 100644
index 0000000..46ca6ae
--- /dev/null
+++ b/src/spec/vcr/cassettes/oauth.yml
@@ -0,0 +1,61 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+ request: !ruby/struct:VCR::Request
+ method: :get
+ uri: http://example.com:5000/katello/api/organizations
+ body:
+ headers:
+ user-agent:
+ - OAuth gem v0.4.4
+ authorization:
+ - OAuth oauth_consumer_key="cloud_forms",
oauth_nonce="ieQTc0gxyo6Z4PlQkgPvxdRCyvrtsLAVU9zfVdyDsnE",
oauth_signature="u%2B9yniABqqpQgTAmQQJS5tNEv4g%3D",
oauth_signature_method="HMAC-SHA1", oauth_timestamp="1317068969",
oauth_version="1.0"
+ katello-user:
+ - admin
+ response: !ruby/struct:VCR::Response
+ status: !ruby/struct:VCR::ResponseStatus
+ code: 200
+ message: OK
+ headers:
+ x-ua-compatible:
+ - IE=Edge,chrome=1
+ etag:
+ - "\"4f3973e2332582b0da3bec1870776fbb\""
+ content-type:
+ - application/json; charset=utf-8
+ x-runtime:
+ - "0.058187"
+ server:
+ - thin 1.2.11 codename Bat-Shit Crazy
+ cache-control:
+ - max-age=0, private, must-revalidate
+ body:
"[{\"name\":\"ACME_Corporation\",\"created_at\":\"2011-09-20T17:45:42Z\",\"updated_at\":\"2011-09-20T17:45:42Z\",\"id\":1,\"cp_key\":\"ACME_Corporation\",\"description\":\"ACME
Corporation Organization\"}]"
+ http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction
+ request: !ruby/struct:VCR::Request
+ method: :get
+ uri: http://example.com:5000/katello/api/organizations
+ body:
+ headers:
+ user-agent:
+ - OAuth gem v0.4.4
+ katello-user:
+ - admin
+ authorization:
+ - OAuth oauth_consumer_key="test",
oauth_nonce="zoT39JgdwI0fjqg9ZfJ2xN4QxyJyIghW7wWUHAxfY",
oauth_signature="UFM87n9CcQXGsOUbHttPJs9NQOg%3D",
oauth_signature_method="HMAC-SHA1", oauth_timestamp="1317068970",
oauth_version="1.0"
+ response: !ruby/struct:VCR::Response
+ status: !ruby/struct:VCR::ResponseStatus
+ code: 401
+ message: Unauthorized
+ headers:
+ x-ua-compatible:
+ - IE=Edge,chrome=1
+ content-type:
+ - text/html; charset=utf-8
+ server:
+ - thin 1.2.11 codename Bat-Shit Crazy
+ x-runtime:
+ - "0.017754"
+ cache-control:
+ - no-cache
+ body: " "
+ http_version: "1.1"
diff --git a/src/spec/vcr_setup.rb b/src/spec/vcr_setup.rb
index 6163ac7..0b65432 100644
--- a/src/spec/vcr_setup.rb
+++ b/src/spec/vcr_setup.rb
@@ -61,3 +61,13 @@ DeployableXML.class_eval do
end
end
end
+
+require 'oauth'
+OAuth::AccessToken.class_eval do
+ def request(method, path, *args)
+ # By default, headers are ignored:
https://www.relishapp.com/myronmarston/vcr/v/1-6-0/docs/cassettes/request...
+ VCR.use_cassette('oauth', :record => :new_episodes, :match_requests_on
=> [:method, :uri, :body, :headers]) do
+ super(method, path, *args)
+ end
+ end
+end
--
1.7.6.2
4:15 a.m.
On 09/30/2011 05:51 PM, Matt Wagner wrote:
This implements the fixes/suggestions that Jan had from my earlier send. Of note:
- The key for providers is now the base URL, e.g., 'http://example.com:5000/api'
instead of 'example.com'.
- The methods are "get", "post", etc., instead of
"authenticated_get", etc.
ACK to patchset with one nit I missed before:
rspec test could be moved from spec/models to spec/lib dir as it's not a
model.
Jan
4594
days inactive
4597
days old
aeolus-devel@lists.fedorahosted.org
3 comments
2 participants
participants (2)
-
Jan Provazník -
Matt Wagner