simple_oauth2 0.0.0

data/lib/simple_oauth2.rb

@@ -0,0 +1,62 @@
+require 'rack/oauth2'
+
+require 'simple_oauth2/configuration/class_accessors'
+require 'simple_oauth2/configuration/constants'
+require 'simple_oauth2/configuration'
+require 'simple_oauth2/scopes'
+require 'simple_oauth2/uniq_token'
+require 'simple_oauth2/resource/bearer'
+
+# Mixins
+if defined?(NoBrainer::Document)
+  require 'simple_oauth2/mixins/nobrainer/access_token'
+  require 'simple_oauth2/mixins/nobrainer/access_grant'
+  require 'simple_oauth2/mixins/nobrainer/client'
+end
+
+# Authorization Grants aka Flows (Strategies)
+require 'simple_oauth2/strategies/base'
+require 'simple_oauth2/strategies/password'
+require 'simple_oauth2/strategies/authorization_code'
+require 'simple_oauth2/strategies/refresh_token'
+require 'simple_oauth2/strategies/code'
+require 'simple_oauth2/strategies/token'
+require 'simple_oauth2/strategies/client_credentials'
+
+# Generators
+require 'simple_oauth2/generators/base'
+require 'simple_oauth2/generators/token'
+require 'simple_oauth2/generators/authorization'
+
+# Helpers
+require 'simple_oauth2/helpers'
+
+# Responses
+require 'simple_oauth2/responses'
+
+# Simple namespace for the gem
+module Simple
+  # Main Simple::OAuth2 module
+  module OAuth2
+    class << self
+      # Simple::OAuth2 configuration
+      #
+      # @return [Simple::OAuth2::Configuration] configuration object with default values
+      #
+      def config
+        @config ||= Simple::OAuth2::Configuration.new
+      end
+
+      # Configures Simple::OAuth2.
+      # Yields Simple::OAuth2::Configuration instance to the block
+      def configure
+        yield config if block_given?
+      end
+
+      # Simple::OAuth2 default middleware
+      def middleware
+        Simple::OAuth2::Resource::Bearer
+      end
+    end
+  end
+end

data/simple_oauth2.gemspec

@@ -0,0 +1,22 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+require 'simple_oauth2/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'simple_oauth2'
+  s.version     = Simple::OAuth2.gem_version
+  s.date        = '2017-01-03'
+  s.summary     = 'OAuth2 authorization'
+  s.description = 'A flexible OAuth2 server authorization'
+  s.authors     = ['Volodimir Partytskyi']
+  s.email       = 'volodimir.partytskyi@gmail.com'
+  s.homepage    = 'https://github.com/simple-oauth2/simple_oauth2'
+  s.license     = 'MIT'
+
+  s.require_paths = %w(lib)
+  s.files         = `git ls-files`.split($RS)
+
+  s.required_ruby_version = '>= 2.2.2'
+
+  s.add_runtime_dependency 'rack-oauth2', '~> 1.3.0', '>= 1.3.0'
+end

data/spec/configuration/config_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+
+describe Simple::OAuth2::Configuration do
+  let(:config) { described_class.new }
+
+  class CustomClient
+    def self.authenticate(_key, _secret = nil)
+      'Test'
+    end
+  end
+
+  class CustomAccessToken
+    def self.create_for(_client, _resource_owner, _scopes = nil); end
+
+    def self.authenticate(_token, _type = nil)
+      'Test'
+    end
+
+    def client; end
+
+    def resource_owner; end
+
+    def expired?; end
+
+    def revoked?; end
+
+    def revoke!(_revoked_at = Time.now); end
+
+    def to_bearer_token; end
+  end
+
+  class CustomResourceOwner
+    def self.oauth_authenticate(_client, _username, _password)
+      'Test'
+    end
+  end
+
+  context 'default config' do
+    it { expect(config.access_token_lifetime).to eq(7200) }
+    it { expect(config.authorization_code_lifetime).to eq(1800) }
+
+    it { expect(config.realm).to eq(Simple::OAuth2::Configuration::DEFAULT_REALM) }
+    it { expect(config.allowed_grant_types).to eq(%w(password authorization_code refresh_token client_credentials)) }
+
+    it { expect(config.issue_refresh_token).to be_falsey }
+    it { expect(config.on_refresh).to eq(:nothing) }
+
+    it { expect(config.scopes_validator_class_name).to eq(Simple::OAuth2::Scopes.name) }
+
+    it { expect { config.resource_owner_authenticator.call('test') }.to raise_error(RuntimeError) }
+  end
+
+  context 'custom config' do
+    class CustomScopesValidator
+      def self.valid?(_access_token, _scopes)
+        false
+      end
+    end
+
+    class CustomTokenGenerator
+      def self.generate(options = {})
+        if options[:custom]
+          'custom_token'
+        else
+          'default_token'
+        end
+      end
+    end
+
+    before do
+      config.access_token_class_name = 'CustomAccessToken'
+      config.resource_owner_class_name = 'CustomResourceOwner'
+      config.client_class_name = 'CustomClient'
+      config.access_grant_class_name = 'Object'
+      config.scopes_validator_class_name = 'CustomScopesValidator'
+    end
+
+    after do
+      config.access_token_class_name = 'AccessToken'
+      config.resource_owner_class_name = 'ResourceOwner'
+      config.client_class_name = 'Client'
+      config.access_grant_class_name = 'AccessGrant'
+      config.scopes_validator_class_name = 'ScopesValidator'
+    end
+
+    context 'works with custom token generator' do
+      before do
+        Simple::OAuth2.configure do |c|
+          c.token_generator_class_name = 'CustomTokenGenerator'
+        end
+      end
+
+      after do
+        Simple::OAuth2.configure do |c|
+          c.token_generator_class_name = Simple::OAuth2::UniqToken.name
+        end
+      end
+
+      it { expect(Simple::OAuth2.config.token_generator.generate).to eq('default_token') }
+      it { expect(Simple::OAuth2.config.token_generator.generate(custom: true)).to eq('custom_token') }
+    end
+
+    context 'invokes custom scopes validator' do
+      it { expect(config.scopes_validator.valid?(nil, nil)).to be_falsey }
+    end
+
+    context 'works with custom Access Token class' do
+      it { expect(config.access_token_class.authenticate('')).to eq('Test') }
+    end
+
+    context 'works with custom Client class' do
+      it { expect(config.client_class.authenticate('')).to eq('Test') }
+    end
+
+    context 'works with custom Resource Owner class' do
+      it { expect(config.resource_owner_class.oauth_authenticate('', '', '')).to eq('Test') }
+    end
+
+    context 'works with custom token authenticator' do
+      let(:request) { AccessToken.create }
+
+      before do
+        Simple::OAuth2.configure do |c|
+          c.token_authenticator do
+            raise ArgumentError, 'Test'
+          end
+        end
+      end
+
+      after do
+        Simple::OAuth2.configure do |c|
+          c.token_authenticator = config.default_token_authenticator
+        end
+      end
+
+      it { expect { config.token_authenticator.call }.to raise_error(ArgumentError) }
+    end
+
+    context 'works with custom on_refresh callback' do
+      let(:token) { AccessToken.create }
+
+      before do
+        Simple::OAuth2.configure do |c|
+          c.on_refresh do |access_token|
+            access_token.update(scopes: 'test')
+          end
+        end
+      end
+
+      after(:all) do
+        Simple::OAuth2.configure do |c|
+          c.on_refresh = :nothing
+        end
+      end
+
+      it do
+        expect { Simple::OAuth2::Strategies::RefreshToken.send(:run_callback_on_refresh_token, token) }
+          .to change { token.scopes }.to('test')
+      end
+    end
+
+    context 'raises an error with invalid on_refresh callback' do
+      before do
+        Simple::OAuth2.configure do |c|
+          c.on_refresh = 'invalid'
+        end
+      end
+
+      after(:all) do
+        Simple::OAuth2.configure do |c|
+          c.on_refresh = :nothing
+        end
+      end
+
+      it do
+        expect { Simple::OAuth2::Strategies::RefreshToken.send(:run_callback_on_refresh_token, nil) }
+          .to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/configuration/version_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'Simlpe::OAuth2 Version' do
+  context 'has a version string' do
+    it { expect(Simple::OAuth2::VERSION::STRING).to be_present }
+  end
+
+  context 'returns version as an instance of Gem::Version' do
+    it { expect(Simple::OAuth2.gem_version).to be_an_instance_of(Gem::Version) }
+  end
+end

data/spec/dummy/endpoints/authorization.rb

@@ -0,0 +1,15 @@
+module Twitter
+  module Endpoints
+    module Authorization
+      def call(env)
+        response = Simple::OAuth2::Generators::Authorization.generate_for(env)
+
+        status = response.status
+        headers = response.headers
+        body = JSON.generate(response.body)
+
+        [status, headers, [body]]
+      end
+    end
+  end
+end

data/spec/dummy/endpoints/custom_authorization.rb

@@ -0,0 +1,21 @@
+module Twitter
+  module Endpoints
+    module CustomAuthorization
+      def request
+        @request
+      end
+
+      def call(env)
+        @request = Rack::Request.new(env)
+
+        response = Simple::OAuth2::Generators::Authorization.generate_for(env, &:unsupported_response_type!)
+
+        status = response.status
+        headers = response.headers
+        body = JSON.generate(response.body)
+
+        [status, headers, [body]]
+      end
+    end
+  end
+end

data/spec/dummy/endpoints/custom_token.rb

@@ -0,0 +1,21 @@
+module Twitter
+  module Endpoints
+    module CustomToken
+      def request
+        @request
+      end
+
+      def call(env)
+        @request = Rack::Request.new(env)
+
+        response = Simple::OAuth2::Generators::Token.generate_for(env, &:unsupported_grant_type!)
+
+        status = response.status
+        headers = response.headers
+        body = JSON.generate(response.body)
+
+        [status, headers, [body]]
+      end
+    end
+  end
+end

data/spec/dummy/endpoints/status.rb

@@ -0,0 +1,51 @@
+module Twitter
+  module Endpoints
+    module StatusSingleScope
+      def request
+        @request
+      end
+
+      def call(env)
+        @request = Rack::Request.new(env)
+        @current_resource_owner = nil # Refresh cache instance variable
+        @current_access_token = nil # Refresh cache instance variable
+
+        access_token_required! :read
+        body = JSON.dump(value: 'Access read', current_user_name: current_resource_owner.username)
+        [200, { 'content-type' => 'application/json' }, [body]]
+      end
+    end
+
+    module StatusMultipleScopes
+      def request
+        @request
+      end
+
+      def call(env)
+        @request = Rack::Request.new(env)
+        @current_resource_owner = nil # Refresh cache instance variable
+        @current_access_token = nil # Refresh cache instance variable
+
+        access_token_required! :read, :write
+        body = JSON.dump(value: 'Access read, write', current_user_name: current_resource_owner.username)
+        [200, { 'content-type' => 'application/json' }, [body]]
+      end
+    end
+
+    module Status
+      def request
+        @request
+      end
+
+      def call(env)
+        @request = Rack::Request.new(env)
+        @current_resource_owner = nil # Refresh cache instance variable
+        @current_access_token = nil # Refresh cache instance variable
+
+        access_token_required!
+        body = JSON.dump(value: 'Access', current_user_name: current_resource_owner.username)
+        [200, { 'content-type' => 'application/json' }, [body]]
+      end
+    end
+  end
+end

data/spec/dummy/endpoints/token.rb

@@ -0,0 +1,22 @@
+module Twitter
+  module Endpoints
+    module Token
+      def call(env)
+        response = Simple::OAuth2::Generators::Token.generate_for(env)
+
+        status = response.status
+        headers = response.headers
+        body = JSON.generate(response.body)
+
+        [status, headers, [body]]
+      end
+    end
+
+    module RevokeToken
+      def call(env)
+        params = Rack::Request.new(env).params
+        Simple::OAuth2::Generators::Token.revoke(params['token'], env)
+      end
+    end
+  end
+end

data/spec/dummy/orm/nobrainer/app/config/db.rb

@@ -0,0 +1,8 @@
+NoBrainer::Document::PrimaryKey.__send__(:remove_const, :DEFAULT_PK_NAME)
+NoBrainer::Document::PrimaryKey.__send__(:const_set,    :DEFAULT_PK_NAME, :_id_)
+
+NoBrainer.configure do |config|
+  config.reset!
+  config.rethinkdb_url = "rethinkdb://localhost/#{"#{ENV['ORM']}_#{ENV['RAILS_ENV']}"}"
+  config.environment = ENV['RAILS_ENV']
+end

data/spec/dummy/orm/nobrainer/app/models/access_grant.rb

@@ -0,0 +1,3 @@
+class AccessGrant
+  include Simple::OAuth2::NoBrainer::AccessGrant
+end

data/spec/dummy/orm/nobrainer/app/models/access_token.rb

@@ -0,0 +1,3 @@
+class AccessToken
+  include Simple::OAuth2::NoBrainer::AccessToken
+end

data/spec/dummy/orm/nobrainer/app/models/client.rb

@@ -0,0 +1,3 @@
+class Client
+  include Simple::OAuth2::NoBrainer::Client
+end

data/spec/dummy/orm/nobrainer/app/models/user.rb

@@ -0,0 +1,11 @@
+class User
+  include NoBrainer::Document
+
+  field :username, type: String, index: true
+  field :encrypted_password, type: String
+
+  def self.oauth_authenticate(_client, username, password)
+    user = where(username: username.to_s).first
+    user if user && user.encrypted_password == password
+  end
+end

data/spec/dummy/orm/nobrainer/app/twitter.rb

@@ -0,0 +1,51 @@
+require File.expand_path('../../../../../../lib/simple_oauth2', __FILE__)
+
+require_relative 'models/access_token'
+require_relative 'models/access_grant'
+require_relative 'models/client'
+require_relative 'models/user'
+
+require_relative '../../../endpoints/authorization'
+require_relative '../../../endpoints/custom_authorization'
+require_relative '../../../endpoints/token'
+require_relative '../../../endpoints/custom_token'
+require_relative '../../../endpoints/status'
+
+load File.expand_path('../config/db.rb', __FILE__)
+load File.expand_path('../../../../simple_oauth2_config.rb', __FILE__)
+
+include Simple::OAuth2::Helpers
+
+module Twitter
+  class Token
+    extend Twitter::Endpoints::Token
+  end
+
+  class RevokeToken
+    extend Twitter::Endpoints::RevokeToken
+  end
+
+  class CustomToken
+    extend Twitter::Endpoints::CustomToken
+  end
+
+  class Authorization
+    extend Twitter::Endpoints::Authorization
+  end
+
+  class CustomAuthorization
+    extend Twitter::Endpoints::CustomAuthorization
+  end
+
+  class Status
+    extend Twitter::Endpoints::Status
+  end
+
+  class StatusSingleScope
+    extend Twitter::Endpoints::StatusSingleScope
+  end
+
+  class StatusMultipleScopes
+    extend Twitter::Endpoints::StatusMultipleScopes
+  end
+end

data/spec/dummy/orm/nobrainer/config.ru

@@ -0,0 +1,37 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'app/twitter'
+
+use Simple::OAuth2.middleware
+
+map '/oauth/token' do
+  run Twitter::Token
+end
+
+map '/oauth/revoke_token' do
+  run Twitter::RevokeToken
+end
+
+map '/oauth/authorization' do
+  run Twitter::Authorization
+end
+
+map '/oauth/custom_token' do
+  run Twitter::CustomToken
+end
+
+map '/oauth/custom_authorization' do
+  run Twitter::CustomAuthorization
+end
+
+map '/api/v1/status' do
+  run Twitter::Status
+end
+
+map '/api/v1/status/single_scope' do
+  run Twitter::StatusSingleScope
+end
+
+map '/api/v1/status/multiple_scopes' do
+  run Twitter::StatusMultipleScopes
+end

data/spec/dummy/simple_oauth2_config.rb

@@ -0,0 +1,7 @@
+Simple::OAuth2.configure do |config|
+  config.resource_owner_authenticator do |_request|
+    User.first
+  end
+
+  config.realm = 'Custom Realm'
+end