signet-rails 0.0.8 → 0.0.9

data/lib/signet/rails/version.rb

@@ -1,5 +1,5 @@
 module Signet
   module Rails
-    VERSION = "0.0.8"
+    VERSION = "0.0.9"
   end
 end

data/lib/signet/rails/wrappers/active_record.rb

@@ -2,18 +2,16 @@ module Signet
   module Rails
     module Wrappers
       class ActiveRecord
-        def initialize obj, client
-          @obj = obj
+        def initialize(credentials, client)
+          @credentials = credentials
           @client = client
         end
 
-	attr_reader :obj
-	attr_reader :client
+        attr_reader :credentials
+        attr_reader :client
 
         def persist
-          if @obj.changed?
-            @obj.save
-          end
+          @credentials.save if @credentials.changed?
         end
       end
     end

data/signet-rails.gemspec

@@ -4,22 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'signet/rails/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "signet-rails"
+  spec.name          = 'signet-rails'
   spec.version       = Signet::Rails::VERSION
-  spec.authors       = ["Paul Jolly"]
-  spec.email         = ["paul@myitcv.org.uk"]
+  spec.authors       = ['Paul Jolly']
+  spec.email         = ['paul@myitcv.org.uk']
   spec.description   = %q{A wrapper around the Google Signet OAuth Library}
   spec.summary       = %q{Incorporate Signet goodness into Rails}
-  spec.homepage      = "https://github.com/myitcv/signet-rails"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/myitcv/signet-rails'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_dependency "signet"
-  spec.add_dependency "rack"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.14.1'
+  spec.add_development_dependency 'sinatra'
+  spec.add_development_dependency 'factory_girl', '~> 4.2.0'
+  spec.add_development_dependency 'faraday', '~> 0.8.1'
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'jwt'
+  spec.add_dependency 'signet', '~> 0.4.5'
+  spec.add_dependency 'rack', '>= 1.4.5'
 end

data/spec/factories/fakeapp_factory.rb

@@ -0,0 +1,11 @@
+class FakeApp < Sinatra::Base
+  attr_accessor :callback
+  get '/' do
+    @callback.call env if @callback
+    'Root'
+  end
+  get '/signet/google/auth_callback' do
+    @callback.call env if @callback
+    'Auth Callback'
+  end
+end

data/spec/factories/user_factory.rb

@@ -0,0 +1,10 @@
+class User < ActiveRecord::Base
+  validates_uniqueness_of :uid
+  has_many :o_auth2_credentials, dependent: :destroy
+end
+
+class OAuth2Credential < ActiveRecord::Base
+  belongs_to :user
+  serialize :signet, Hash
+  validates_uniqueness_of :name, scope: :id
+end

data/spec/handler_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+require 'securerandom'
+require 'jwt'
+require 'uri'
+require 'faraday'
+require 'sinatra/base'
+require 'faraday/adapter/test'
+require 'signet/rails'
+
+
+describe Signet::Rails::Handler do
+
+  # creates a basic Rack stack with an instance of a Signet::Rails::Handler in place
+  #
+  # Top    lightweight sinatra app for testing 
+  #        Rack::Lint
+  #        Signet::Rails::Handler
+  #        Rack:Lint
+  #        Rack::Session::Cookie
+  # Bot    Rack::Lint
+  #
+  def create_base_app opts = {}
+    app_1 = FakeApp.new
+    app_2 = Rack::Lint.new app_1
+    app_3 = Signet::Rails::Builder.new app_2 do
+      provider opts
+    end
+    app_4 = Rack::Lint.new app_3
+    app_5 = Rack::Session::Cookie.new app_4, secret: SecureRandom.hex(64)
+    app_6 = Rack::Lint.new app_5
+
+    # Sinatra wraps our top app... let's get it back out again
+    # for @top. See 
+    # https://github.com/sinatra/sinatra/blob/master/lib/sinatra/base.rb#L1448-L1456
+    @top = app_1.instance_variable_get :@instance
+
+    @base = app_6
+    @app_env = nil
+    @top.callback = lambda do |env|
+      @app_env = env
+    end
+    @req = request @base
+
+    @base
+  end
+
+  def req_get uri, env_opts = {}
+    @req.get uri, env(env_opts)
+  end
+
+  def create_login_app opts = {}
+    create_base_app opts.merge({type: :login})
+  end
+
+  DEFAULT_ENV = {
+    "SERVER_NAME" => "myitcv.org.uk",
+    "SERVER_PORT" => "4321"
+  }.freeze
+
+  def request app
+    req = Rack::MockRequest.new app
+  end
+
+  def env opts = {}
+    # a slight abuse of options that are passed to Rack::MockRequest.env_for
+    # we overload opts to also allow the setting of :cookie
+    # This option is stripped out if set and translated into an HTTP_COOKIE 
+    # option
+    opts = opts.dup
+    if opts.include? :cookie
+      cookie = if options[:cookie].is_a?(Rack::Response)
+                 options[:cookie]["Set-Cookie"]
+               else
+                 options[:cookie]
+               end
+      opts.delete :cookie
+      opts["HTTP_COOKIE"] = cookie || ""
+    end
+    e = DEFAULT_ENV.dup.merge opts
+  end
+
+  before do
+    @faraday = Faraday.new do |builder|
+      builder.adapter :test do |stub|
+        stub.post('/o/oauth2/token') {
+          id_token = {"iss"=>"accounts.google.com", "aud"=>"id", "token_hash"=>"my_token_hash", "at_hash"=>"M0rVHD8aKqJRMwlpkWuvrw", "cid"=>"id", "azp"=>"id", "id"=>"myitcv", "sub"=>"105997489348527668257", "iat"=>12, "exp"=>42}
+          resp_body = { "access_token" => "my_access_token", "token_type" => "Bearer", "expires_in" => 1234, "id_token" => JWT.encode(id_token, 'secret'), "refresh_token" => "my_refresh_token" }
+          [ 200, {}, JSON.dump(resp_body) ]
+        }
+      end
+    end
+  end
+
+  # **********************************************
+
+  context 'that is login based' do
+
+    it 'should require a string client id' do
+      expect { create_login_app }.
+        to raise_error(ArgumentError, 'Client id is required for a type: :login provider')
+    end
+
+    it 'should require a scope to be defined' do
+      expect {create_login_app client_id: 'id'}.
+        to raise_error(ArgumentError, 'Scope is required')
+    end
+
+    it 'should require scope to be a(n array of) string(s)'
+    it 'should handle scope strings that contain commas'
+
+    it 'should handle untrimmed scope strings' do
+      create_login_app client_id: 'id', scope: ' test '
+      resp = req_get '/signet/google/auth'
+      redirect = URI 'https://accounts.google.com/o/oauth2/auth?access_type=offline&approval_prompt=auto&client_id=id&redirect_uri=http://myitcv.org.uk:4321/signet/google/auth_callback&response_type=code&scope=test'
+      query_params = URI.decode_www_form redirect.query
+      scope_params = query_params.select { |p| p[0] == 'scope' }
+      expect(scope_params.length).to eq(1)
+      expect(scope_params[0][1]).to eq('test')
+    end
+
+    context 'with default arguments' do
+
+      it 'should redirect to google' do
+        create_login_app client_id: 'id', scope: 'test'
+        resp = req_get '/signet/google/auth'
+        expect(resp.body).to be_empty
+        expect(resp.original_headers['Location']).to eq('https://accounts.google.com/o/oauth2/auth?access_type=offline&approval_prompt=auto&client_id=id&redirect_uri=http://myitcv.org.uk:4321/signet/google/auth_callback&response_type=code&scope=test')
+      end
+
+      it 'should redirect for an auth request'
+
+      it 'errors if rack.session is not available'
+
+      it 'should handle multiple scopes' do
+        create_login_app client_id: 'id', scope: ['test','trial']
+        resp = req_get '/signet/google/auth'
+        expect(resp.body).to be_empty
+        expect(resp.original_headers['Location']).to eq('https://accounts.google.com/o/oauth2/auth?access_type=offline&approval_prompt=auto&client_id=id&redirect_uri=http://myitcv.org.uk:4321/signet/google/auth_callback&response_type=code&scope=test%20trial')
+      end
+
+      it 'should handle url scopes' do
+        create_login_app client_id: 'id', scope: ['https://www.googleapis.com/auth/userinfo.email']
+        resp = req_get '/signet/google/auth'
+        expect(resp.body).to be_empty
+        expect(resp.original_headers['Location']).to eq('https://accounts.google.com/o/oauth2/auth?access_type=offline&approval_prompt=auto&client_id=id&redirect_uri=http://myitcv.org.uk:4321/signet/google/auth_callback&response_type=code&scope=https://www.googleapis.com/auth/userinfo.email')
+      end
+
+      it 'should require an auth_code on auth callback' do
+        create_login_app client_id: 'id', scope: 'scope'
+        expect { resp = req_get '/signet/google/auth_callback' }.
+          to raise_error(ArgumentError, 'Missing authorization code in auth_callback')
+      end
+
+      it 'should attempt to get an access_token on auth_callback' do
+        create_login_app client_id: 'id', scope: 'scope', connection: @faraday
+
+        # TODO this could be made stronger
+        @faraday.app.should_receive(:call).with(1).and_call_original
+        resp = req_get '/signet/google/auth_callback', params: {code: '123'}
+        credentials = @app_env['signet.google.persistence_obj']
+        expect(resp.body).to eq('Auth Callback')
+        expect(@app_env['signet.google']).to be_a(Signet::Rails::Handler)
+        expect(credentials).not_to be_nil
+        expect(credentials.signet).not_to be_nil
+        expect(credentials.signet['refresh_token']).to eq('my_refresh_token')
+      end
+    end
+  end
+  context 'that is google-based' do
+    it 'should redirect based on provider name' do
+      base, top = create_base_app name: :google, type: :login, client_id: 'id', client_secret: 456, scope: 'myscope'
+      req = request base
+      resp = req.get '/signet/google/auth'
+    end
+  end
+  it 'should be google-based'
+  it 'should test default options'
+  it 'should handle option :handle_auth_callback false'
+  it 'should handle multiple users'
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'signet/rails'
+require 'sinatra/base'
+require 'factory_girl'
+require 'faraday'
+require 'faraday/adapter/test'
+require 'securerandom'
+require 'jwt'
+require 'uri'
+
+Dir[File.dirname(__FILE__)+"/support/*.rb"].each {|file| require file }
+Dir[File.dirname(__FILE__)+"/*factory.rb"].each {|file| require file }
+Dir[File.dirname(__FILE__)+"/factories/*.rb"].each {|file| require file }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end
+

data/spec/support/active_record.rb

@@ -0,0 +1,45 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Migration.create_table :users do |t|
+  t.string :uid
+  t.timestamps
+end
+
+ActiveRecord::Migration.create_table :o_auth2_credentials do |t|
+  t.string :name
+  t.references :user, index: true
+  t.string :signet
+  t.timestamps
+end
+
+# http://iain.nl/testing-activerecord-in-isolation
+module ActiveModel::Validations
+  # Extension to enhance `should have` on AR Model instances.  Calls
+  # model.valid? in order to prepare the object's errors object.
+  #
+  # You can also use this to specify the content of the error messages.
+  #
+  # @example
+  #
+  #     model.should have(:no).errors_on(:attribute)
+  #     model.should have(1).error_on(:attribute)
+  #     model.should have(n).errors_on(:attribute)
+  #
+  #     model.errors_on(:attribute).should include("can't be blank")
+  def errors_on(attribute)
+    self.valid?
+    [self.errors[attribute]].flatten.compact
+  end
+  alias :error_on :errors_on
+end
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: signet-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.8
-  prerelease: 
+  version: 0.0.9
 platform: ruby
 authors:
 - Paul Jolly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-27 00:00:00.000000000 Z
+date: 2013-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,51 +27,143 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: signet
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: signet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.5
 description: A wrapper around the Google Signet OAuth Library
 email:
 - paul@myitcv.org.uk
@@ -83,6 +172,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .rubocop.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -94,30 +185,39 @@ files:
 - lib/signet/rails/version.rb
 - lib/signet/rails/wrappers/active_record.rb
 - signet-rails.gemspec
-- tags
+- spec/factories/fakeapp_factory.rb
+- spec/factories/user_factory.rb
+- spec/handler_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
 homepage: https://github.com/myitcv/signet-rails
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Incorporate Signet goodness into Rails
-test_files: []
+test_files:
+- spec/factories/fakeapp_factory.rb
+- spec/factories/user_factory.rb
+- spec/handler_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+has_rdoc: