aptible-auth 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db3c1ba550b3a777611816a3828b182d0e2d3a27
-  data.tar.gz: 97fe3444852024e2c306c40a85ac900179a4bfb1
+  metadata.gz: 9ead7f15f6ad01c4a7b9b7bed9a8840b07afe5c2
+  data.tar.gz: 34335f77ccea4353b373664ba3682d79c7fcbba1
 SHA512:
-  metadata.gz: 2e106b93c20c79b736d18a7d7def5d381a1b6a956fce65c60acf06363f96d8ee336627e5d897bbe791be543900a1bc16e4a8d32c54cfcc1153c2a2a983d6b9c9
-  data.tar.gz: af94ac3a6532389de1a5daece03a11aee35441189dcc77ba63e9f9aca11a1a6c54f967a54d4314c5481118e2f42206a9dfd9fac7a01ca171259f7f4518e32e16
+  metadata.gz: baa2716fc686c7adb7f45087b8ab63d0aadf82c8a392d5176a25d84cfc799e4d74660acc267e5e0d0cf146d058a810c7e31b816a5d3d5ebf345bc7f8ee680a04
+  data.tar.gz: 4f73fa2447498ebaf7ea19373fbfc592fd6c320f7ed0f587212e759d50c71d10a4169f2e04d81a2ad8c868641f965a41799edb4ef2a9ab1a4f6d8be105f56b78

data/Procfile

@@ -0,0 +1 @@
+console: bundle exec pry -r aptible/auth

data/README.md

@@ -16,7 +16,7 @@ Add the following lines to your application's Gemfile.
 
 The forked version of the OAuth2 gem is necessary until [intridea/oauth2#165](https://github.com/intridea/oauth2/pull/165) and [intridea/oauth2#166](https://github.com/intridea/oauth2/pull/166) are merged.
 
-The forked version of the HyperResource gem is necessary until [gamache/hyperresource#19](https://github.com/gamache/hyperresource/pull/19) is merged.
+The forked version of the HyperResource gem is necessary until [gamache/hyperresource#22](https://github.com/gamache/hyperresource/pull/22) and [gamache/hyperresource#23](https://github.com/gamache/hyperresource/pull/23) are merged.
 
 And then run `bundle install`.
 
@@ -28,9 +28,9 @@ First, get a token:
 token = Aptible::Auth::Token.new(email: 'user0@example.com', password: 'password')
 ```
 
-Then, initialize a client:
+Then, initialize a resource agent:
 ```ruby
-auth = Aptible::Auth::Client.new(token: token)
+auth = Aptible::Auth::Resource.new(token: token)
 ```
 
 From here, you can interact with the Authorization API however you wish:

data/aptible-auth.gemspec

@@ -3,11 +3,10 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'English'
-require 'aptible/auth/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'aptible-auth'
-  spec.version       = Aptible::Auth::VERSION
+  spec.version       = '0.2.0'
   spec.authors       = ['Frank Macreery']
   spec.email         = ['frank@macreery.com']
   spec.description   = 'Ruby client for auth.aptible.com'
@@ -23,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'oauth2'
   spec.add_dependency 'hyperresource'
   spec.add_dependency 'fridge'
+  spec.add_dependency 'activesupport'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'aptible-tasks', '>= 0.2.0'

data/lib/aptible/auth.rb

@@ -1,13 +1,13 @@
-require 'aptible/auth/version'
-require 'aptible/auth/token'
-require 'aptible/auth/client'
-
 require 'gem_config'
+require 'hyperresource'
+require 'fridge'
 
 module Aptible
-  module Auth
+  class Auth < HyperResource
     include GemConfig::Base
 
+    attr_accessor :token, :config
+
     with_configuration do
       has :root_url,
           classes: [String],
@@ -15,7 +15,62 @@ module Aptible
     end
 
     def self.public_key
-      Client.new.get.public_key
+      Resource.new.get.public_key
+    end
+
+    def self.get_data_type_from_response(response)
+      return nil unless response && response.body
+      adapter.get_data_type_from_object(adapter.deserialize(response.body))
+    end
+
+    def self.adapter
+      Aptible::Auth::Adapter
+    end
+
+    def adapter
+      self.class.adapter
+    end
+
+    def initialize(options = {})
+      if options.is_a?(Hash)
+        self.token = options[:token]
+
+        options[:root] ||= config.root_url
+        options[:namespace] ||= 'Aptible::Auth'
+        options[:headers] ||= { 'Content-Type' => 'application/json' }
+        options[:headers].merge!(
+          'Authorization' => "Bearer #{bearer_token}"
+        ) if options[:token]
+      end
+
+      super(options)
+    end
+
+    def find_by_url(url)
+      fail "URL must be rooted at #{root}" unless /^#{root}/.match url
+
+      resource = dup
+      resource.href = url.gsub(/^#{root}/, '')
+      resource.get
+    end
+
+    def organizations
+      orgs
+    end
+
+    def bearer_token
+      case token
+      when Aptible::Auth::Token then token.access_token
+      when Fridge::AccessToken then token.to_s
+      when String then token
+      end
+    end
+
+    def config
+      @config ||= Aptible::Auth.configuration
     end
   end
 end
+
+require 'aptible/auth/adapter'
+require 'aptible/auth/resource'

data/lib/aptible/auth/adapter.rb

@@ -0,0 +1,23 @@
+module Aptible
+  class Auth::Adapter < HyperResource::Adapter::HAL_JSON
+    class << self
+      # rubocop:disable MethodLength
+      def get_data_type_from_object(object)
+        return nil unless object
+
+        if (type = object['type'])
+          if type == 'org'
+            'Organization'
+          elsif type.respond_to?(:camelize)
+            type.camelize
+          else
+            type[0].upcase + type[1..-1]
+          end
+        else
+          'Resource'
+        end
+      end
+      # rubocop:enable MethodLength
+    end
+  end
+end

data/lib/aptible/auth/client.rb

@@ -1,38 +1,4 @@
-require 'hyperresource'
-require 'fridge'
-
 module Aptible
-  module Auth
-    class Client < HyperResource
-      attr_accessor :token, :config
-
-      def initialize(options = {})
-        unless options.is_a?(Hash)
-          fail ArgumentError, 'Call Aptible::Auth::Client.new with a Hash'
-        end
-        self.token = options[:token]
-
-        options[:root] ||= config.root_url
-        options[:headers] ||= { 'Content-Type' => 'application/json' }
-        options[:headers].merge!(
-          'Authorization' => "Bearer #{bearer_token}"
-        ) if options[:token]
-
-        super(options)
-      end
-
-      def bearer_token
-        # REVIEW: Should we really allow any token type here?
-        case token
-        when Aptible::Auth::Token then token.access_token
-        when Fridge::AccessToken then token.to_s
-        when String then token
-        end
-      end
-
-      def config
-        @config ||= Aptible::Auth.configuration
-      end
-    end
+  class Auth::Client < Auth::Resource
   end
 end

data/lib/aptible/auth/membership.rb

@@ -0,0 +1,4 @@
+module Aptible
+  class Auth::Membership < Auth::Resource
+  end
+end

data/lib/aptible/auth/resource.rb

@@ -0,0 +1,15 @@
+module Aptible
+  class Auth::Resource < Auth
+    def self.find_by_url(url)
+      # REVIEW: Should exception be raised if return type mismatch?
+      new.find_by_url(url)
+    end
+  end
+end
+
+require 'aptible/auth/client'
+require 'aptible/auth/membership'
+require 'aptible/auth/role'
+require 'aptible/auth/session'
+require 'aptible/auth/token'
+require 'aptible/auth/user'

data/lib/aptible/auth/role.rb

@@ -0,0 +1,4 @@
+module Aptible
+  class Auth::Role < Auth::Resource
+  end
+end

data/lib/aptible/auth/session.rb

@@ -0,0 +1,4 @@
+module Aptible
+  class Auth::Session < Auth::Resource
+  end
+end

data/lib/aptible/auth/token.rb

@@ -1,79 +1,78 @@
 require 'oauth2'
 
 module Aptible
-  module Auth
-    class Token
-      attr_accessor :client, :access_token, :refresh_token, :expires_at
+  class Auth::Token < Auth::Resource
+    attr_accessor :access_token, :refresh_token, :expires_at
 
-      def initialize(options = {})
-        oauth_params = {
-          site: Aptible::Auth.configuration.root_url,
-          token_url: '/tokens'
-        }
-        @client = OAuth2::Client.new(nil, nil, oauth_params)
-
-        process_options(options)
-      end
+    def self.create(options)
+      token = new
+      token.process_options(options)
+      token
+    end
 
-      def authenticate_user(email, password, options = {})
-        options[:scope] ||= 'manage'
-        response = client.password.get_token(email, password, options)
-        parse_oauth_response(response)
-      end
+    def authenticate_user(email, password, options = {})
+      options[:scope] ||= 'manage'
+      response = oauth.password.get_token(email, password, options)
+      parse_oauth_response(response)
+    end
 
-      def authenticate_client(id, secret, user, options = {})
-        options[:scope] ||= 'manage'
-        response = client.assertion.get_token({
-          iss: id,
-          sub: user
-        }.merge(signing_params_from_secret(secret).merge(options)))
-        parse_oauth_response(response)
-      end
+    def authenticate_client(id, secret, subject, options = {})
+      options[:scope] ||= 'manage'
+      response = oauth.assertion.get_token({
+        iss: id,
+        sub: subject
+      }.merge(signing_params_from_secret(secret).merge(options)))
+      parse_oauth_response(response)
+    end
 
-      private
+    def oauth
+      options = { site: config.root_url, token_url: '/tokens' }
+      @oauth ||= OAuth2::Client.new(nil, nil, options)
+    end
 
-      def process_options(options)
-        if (email = options.delete(:email)) &&
-           (password = options.delete(:password))
-          authenticate_user(email, password, options)
-        elsif (client_id = options.delete(:client_id)) &&
-              (client_secret = options.delete(:client_secret)) &&
-              (user = options.delete(:user))
-          authenticate_client(client_id, client_secret, user, options)
-        end
+    def process_options(options)
+      if (email = options.delete(:email)) &&
+         (password = options.delete(:password))
+        authenticate_user(email, password, options)
+      elsif (client_id = options.delete(:client_id)) &&
+            (client_secret = options.delete(:client_secret)) &&
+            (subject = options.delete(:subject))
+        authenticate_client(client_id, client_secret, subject, options)
       end
+    end
 
-      def parse_oauth_response(response)
-        @access_token = response.token
-        @refresh_token = response.refresh_token
-        @expires_at = Time.at(response.expires_at)
-      end
+    private
 
-      def signing_params_from_secret(secret)
-        private_key = parse_private_key(secret)
-        {
-          private_key: private_key,
-          algorithm:  "RS#{key_length(private_key) / 2}"
-        }
-      end
+    def parse_oauth_response(response)
+      @access_token = response.token
+      @refresh_token = response.refresh_token
+      @expires_at = Time.at(response.expires_at)
+    end
 
-      def parse_private_key(string)
-        if string =~ /\A-----/
-          OpenSSL::PKey::RSA.new(string)
-        else
-          formatted_string = <<PRIVATE_KEY
------BEGIN RSA PRIVATE KEY-----
-#{string.scan(/.{1,64}/).join("\n")}
------END RSA PRIVATE KEY-----
-PRIVATE_KEY
-          OpenSSL::PKey::RSA.new(formatted_string)
-        end
-      end
+    def signing_params_from_secret(secret)
+      private_key = parse_private_key(secret)
+      {
+        private_key: private_key,
+        algorithm:  "RS#{key_length(private_key) / 2}"
+      }
+    end
 
-      def key_length(private_key)
-        # http://stackoverflow.com/questions/13747212
-        private_key.n.num_bytes * 8
+    def parse_private_key(string)
+      if string =~ /\A-----/
+        OpenSSL::PKey::RSA.new(string)
+      else
+        formatted_string = <<-PRIVATE_KEY.gsub(/^\s+/, '')
+          -----BEGIN RSA PRIVATE KEY-----
+          #{string.scan(/.{1,64}/).join("\n")}
+          -----END RSA PRIVATE KEY-----
+        PRIVATE_KEY
+        OpenSSL::PKey::RSA.new(formatted_string)
       end
     end
+
+    def key_length(private_key)
+      # http://stackoverflow.com/questions/13747212
+      private_key.n.num_bytes * 8
+    end
   end
 end

data/lib/aptible/auth/user.rb

@@ -0,0 +1,7 @@
+module Aptible
+  class Auth::User < Auth::Resource
+    def verified?
+      !!attributes['verified']
+    end
+  end
+end

data/spec/aptible/auth/resource_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+# describe Aptible::Auth::Resource do
+# end

data/spec/aptible/auth/token_spec.rb

@@ -1,32 +1,35 @@
 require 'spec_helper'
 
 describe Aptible::Auth::Token do
-  let(:client) { double OAuth2::Client }
+  let(:oauth) { double OAuth2::Client }
   let(:response) { double OAuth2::AccessToken }
 
+  before { subject.stub(:oauth) { oauth } }
   before { response.stub(:token) }
   before { response.stub(:refresh_token) }
   before { response.stub(:expires_at) { Time.now.to_i } }
 
-  describe '#initialize' do
+  describe '.create' do
     it 'should call #authenticate_user if passed :email and :password' do
       Aptible::Auth::Token.any_instance.should_receive(
         :authenticate_user
       ).with 'user@example.com', 'foobar', {}
-      described_class.new(email: 'user@example.com', password: 'foobar')
+      described_class.create(email: 'user@example.com', password: 'foobar')
     end
 
     it 'should #authenticate_client if passed a client ID and secret' do
       Aptible::Auth::Token.any_instance.should_receive(
         :authenticate_client
       ).with 'id', 'secret', 'user@example.com', {}
-      described_class.new(
+      described_class.create(
         client_id: 'id',
         client_secret: 'secret',
-        user: 'user@example.com'
+        subject: 'user@example.com'
       )
     end
+  end
 
+  describe '#initialize' do
     it 'should not raise error if given no arguments' do
       expect { described_class.new }.not_to raise_error
     end
@@ -35,23 +38,22 @@ describe Aptible::Auth::Token do
   describe '#authenticate_user' do
     let(:args) { %w(user@example.com foobar) }
 
-    before { subject.stub(:client) { client } }
-    before { client.stub_chain(:password, :get_token) { response } }
+    before { oauth.stub_chain(:password, :get_token) { response } }
 
     it 'should use the password strategy' do
       params = { scope: 'manage' }
-      expect(client.password).to receive(:get_token).with(*(args + [params]))
+      expect(oauth.password).to receive(:get_token).with(*(args + [params]))
       subject.authenticate_user(*args)
     end
 
     it 'should allow the token scope to be specified' do
       args << { scope: 'read' }
-      expect(client.password).to receive(:get_token).with(*args)
+      expect(oauth.password).to receive(:get_token).with(*args)
       subject.authenticate_user(*args)
     end
 
     it 'should set the access_token' do
-      client.stub_chain(:password, :get_token, :token) { 'access_token' }
+      oauth.stub_chain(:password, :get_token, :token) { 'access_token' }
       subject.authenticate_user(*args)
       expect(subject.access_token).to eq 'access_token'
     end
@@ -63,11 +65,10 @@ describe Aptible::Auth::Token do
     before do
       subject.stub(:signing_params_from_secret) { { algorithm: 'foobar' } }
     end
-    before { subject.stub(:client) { client } }
-    before { client.stub_chain(:assertion, :get_token) { response } }
+    before { oauth.stub_chain(:assertion, :get_token) { response } }
 
     it 'should use the assertion strategy' do
-      expect(client.assertion).to receive(:get_token).with(
+      expect(oauth.assertion).to receive(:get_token).with(
         iss: 'id',
         sub: 'user@example.com',
         algorithm: 'foobar',
@@ -78,7 +79,7 @@ describe Aptible::Auth::Token do
 
     it 'should allow the token scope to be specified' do
       args << { scope: 'read' }
-      expect(client.assertion).to receive(:get_token).with(
+      expect(oauth.assertion).to receive(:get_token).with(
         iss: 'id',
         sub: 'user@example.com',
         algorithm: 'foobar',
@@ -88,7 +89,7 @@ describe Aptible::Auth::Token do
     end
 
     it 'should set the access_token' do
-      client.stub_chain(:assertion, :get_token, :token) { 'access_token' }
+      oauth.stub_chain(:assertion, :get_token, :token) { 'access_token' }
       subject.authenticate_client(*args)
       expect(subject.access_token).to eq 'access_token'
     end

data/spec/aptible/auth_spec.rb

@@ -17,8 +17,35 @@ describe Aptible::Auth do
 
   it 'should expose the server public key' do
     get = double 'get'
-    Aptible::Auth::Client.any_instance.stub(:get) { get }
+    Aptible::Auth.any_instance.stub(:get) { get }
     expect(get).to receive :public_key
     described_class.public_key
   end
+
+  describe '#initialize' do
+    it 'should be a HyperResource instance' do
+      expect(subject).to be_a HyperResource
+    end
+  end
+
+  describe '#bearer_token' do
+    it 'should accept an Aptible::Auth::Token' do
+      token = Aptible::Auth::Token.new
+      token.stub(:access_token) { 'abtible_auth_token' }
+      subject.stub(:token) { token }
+      expect(subject.bearer_token).to eq token.access_token
+    end
+
+    it 'should accept an Fridge::AccessToken' do
+      token = Fridge::AccessToken.new
+      token.stub(:to_s) { 'fridge_access_token' }
+      subject.stub(:token) { token }
+      expect(subject.bearer_token).to eq token.to_s
+    end
+
+    it 'should accept a String' do
+      subject.stub(:token) { 'token' }
+      expect(subject.bearer_token).to eq 'token'
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aptible-auth
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Frank Macreery
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_config
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -148,14 +162,20 @@ files:
 - .travis.yml
 - Gemfile
 - LICENSE.md
+- Procfile
 - README.md
 - Rakefile
 - aptible-auth.gemspec
 - lib/aptible/auth.rb
+- lib/aptible/auth/adapter.rb
 - lib/aptible/auth/client.rb
+- lib/aptible/auth/membership.rb
+- lib/aptible/auth/resource.rb
+- lib/aptible/auth/role.rb
+- lib/aptible/auth/session.rb
 - lib/aptible/auth/token.rb
-- lib/aptible/auth/version.rb
-- spec/aptible/auth/client_spec.rb
+- lib/aptible/auth/user.rb
+- spec/aptible/auth/resource_spec.rb
 - spec/aptible/auth/token_spec.rb
 - spec/aptible/auth_spec.rb
 - spec/shared/set_env.rb
@@ -185,7 +205,7 @@ signing_key:
 specification_version: 4
 summary: Ruby client for auth.aptible.com
 test_files:
-- spec/aptible/auth/client_spec.rb
+- spec/aptible/auth/resource_spec.rb
 - spec/aptible/auth/token_spec.rb
 - spec/aptible/auth_spec.rb
 - spec/shared/set_env.rb

data/lib/aptible/auth/version.rb

@@ -1,5 +0,0 @@
-module Aptible
-  module Auth
-    VERSION = '0.1.4'
-  end
-end

data/spec/aptible/auth/client_spec.rb

@@ -1,30 +0,0 @@
-require 'spec_helper'
-
-describe Aptible::Auth::Client do
-  describe '#initialize' do
-    it 'should be a HyperResource instance' do
-      expect(subject).to be_a HyperResource
-    end
-  end
-
-  describe '#bearer_token' do
-    it 'should accept an Aptible::Auth::Token' do
-      token = Aptible::Auth::Token.new
-      token.stub(:access_token) { 'abtible_auth_token' }
-      subject.stub(:token) { token }
-      expect(subject.bearer_token).to eq token.access_token
-    end
-
-    it 'should accept an Fridge::AccessToken' do
-      token = Fridge::AccessToken.new
-      token.stub(:to_s) { 'fridge_access_token' }
-      subject.stub(:token) { token }
-      expect(subject.bearer_token).to eq token.to_s
-    end
-
-    it 'should accept a String' do
-      subject.stub(:token) { 'token' }
-      expect(subject.bearer_token).to eq 'token'
-    end
-  end
-end