simpleapikeyengine 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8070d5d66770bf384b261321ccf434bc83ca6ec7
-  data.tar.gz: a48cd9e4a9eede6fbb6f92a78beb1bd85eb4ecc9
+  metadata.gz: 536016096a163e0a2561c8352de594f35cf25a9f
+  data.tar.gz: 5624f9f5ca889ac170588bd336c309d60092bf8b
 SHA512:
-  metadata.gz: 783b22cc87e54a08050a913a70802a6917311d07fc5e51c616aa69afa0311e8214098c9cfe95efdf8ab2531f79bd49745a22e7496c75b9010dbed1dc232f91a6
-  data.tar.gz: 4da1741a188c6c4b06534eea73ed19d33eab80efd0ab7d1a6aa51983b383518a71252009728df5cea7e48d1a7cfa85707a92174d221a0831e8bb5da47465264d
+  metadata.gz: 8c84fe3a41311e386485db06438e5e9c3f28c6e13b2151b5f94200a337f41a5472cf15ba00a6d16601d7ae01555439650bd6859e0bdaa7c6222a48e5350189b7
+  data.tar.gz: eec86b2c43670628520600ef751ee55cb01de78c735b99e941d52bf7406087efbc114911c5c62750a88aa042487ee1589ba5f9ed784955bf880ec160e2542f63

data/MIT-LICENSE

@@ -1,20 +1,20 @@
-Copyright 2014 YOURNAME
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,4 +1,4 @@
-simpleapikeyengine
-=====================
-
-Simple API Key Engine.
+simpleapikeyengine
+=====================
+
+Simple API Key Engine.

data/Rakefile

@@ -1,8 +1,8 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-Bundler::GemHelper.install_tasks
-
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+

data/app/models/simple_api_key_engine/api_key.rb

@@ -1,37 +1,37 @@
-module SimpleApiKeyEngine
-  class ApiKey < ActiveRecord::Base
-    before_create :generate_token
-    before_create :set_expiration
-
-    def self.activate(token)
-      api_key = where(token: token).first
-      return api_key && !api_key.expired? ? api_key : nil
-    end
-
-    def user_class
-      Class.const_get(user_type)
-    end
-
-    def user=(obj)
-      self.user_ident = obj.to_param
-      self.user_type = obj.class.name
-      @user = obj
-    end
-
-    def expired?
-      Time.current >= expires_at
-    end
-
-    private
-    def generate_token
-      begin
-        self.token = SecureRandom.hex
-      end while self.class.exists?(token: token)
-    end
-
-    def set_expiration
-      self.expires_at = Time.current + 30.days
-    end
-
-  end
-end
+module SimpleApiKeyEngine
+  class ApiKey < ActiveRecord::Base
+    before_create :generate_token
+    before_create :set_expiration
+
+    def self.activate(token)
+      api_key = where(token: token).first
+      return api_key && !api_key.expired? ? api_key : nil
+    end
+
+    def user_class
+      Class.const_get(user_type)
+    end
+
+    def user=(obj)
+      self.user_ident = obj.to_param
+      self.user_type = obj.class.name
+      @user = obj
+    end
+
+    def expired?
+      Time.current >= expires_at
+    end
+
+    private
+    def generate_token
+      begin
+        self.token = SecureRandom.hex
+      end while self.class.exists?(token: token)
+    end
+
+    def set_expiration
+      self.expires_at = Time.current + 30.days
+    end
+
+  end
+end

data/app/models/simple_api_key_engine/authentication.rb

@@ -1,46 +1,46 @@
-module SimpleApiKeyEngine
-  class Authentication < ActiveRecord::Base
-    store :auth_hash
-
-    class << self
-      def auth(auth_hash, &block)
-        get_provider(auth_hash).auth(&block)
-      end
-
-      def activate(auth_hash, &block)
-        authentication = auth(auth_hash, &block)
-        return nil unless authentication
-        SimpleApiKeyEngine::ApiKey.create!(user_type: authentication.user_type,
-                                           user_ident: authentication.user_ident)
-      end
-
-      private
-      def provider_classes
-        ObjectSpace.each_object(Class).select{|klass| klass < SimpleApiKeyEngine::Providers::AbstractProvider}.reject { |klass|
-          klass.priority.nil?
-        }.sort_by { |klass| klass.priority }
-      end
-
-      private
-      def get_provider(auth_hash)
-        provider_class = provider_classes.find do |klass|
-          klass.acceptable? auth_hash
-        end
-        raise 'Unknown authentication provider' unless provider_class
-        provider_class.new auth_hash
-      end
-    end
-
-    def user_class
-      Class.const_get(user_type)
-    end
-
-    def user=(obj)
-      self.user_ident = obj.to_param
-      self.user_type = obj.class.name
-      @user = obj
-    end
-
-  end
-end
-
+module SimpleApiKeyEngine
+  class Authentication < ActiveRecord::Base
+    store :auth_hash
+
+    class << self
+      def auth(request, &block)
+        get_provider(request).auth(&block)
+      end
+
+      def activate(request, &block)
+        authentication = auth(request, &block)
+        return nil unless authentication
+        SimpleApiKeyEngine::ApiKey.create!(user_type: authentication.user_type,
+                                           user_ident: authentication.user_ident)
+      end
+
+      private
+      def provider_classes
+        ObjectSpace.each_object(Class).select{|klass| klass < SimpleApiKeyEngine::Providers::AbstractProvider}.reject { |klass|
+          klass.priority.nil?
+        }.sort_by { |klass| klass.priority }
+      end
+
+      private
+      def get_provider(request)
+        provider_class = provider_classes.find do |klass|
+          klass.acceptable? request
+        end
+        raise 'Unknown authentication provider' unless provider_class
+        provider_class.new request
+      end
+    end
+
+    def user_class
+      Class.const_get(user_type)
+    end
+
+    def user=(obj)
+      self.user_ident = obj.to_param
+      self.user_type = obj.class.name
+      @user = obj
+    end
+
+  end
+end
+

data/config/routes.rb

@@ -1,2 +1,2 @@
-SimpleApiKeyEngine::Engine.routes.draw do
-end
+SimpleApiKeyEngine::Engine.routes.draw do
+end

data/db/migrate/20141110041333_create_simple_api_key_engine_api_keys.rb

@@ -1,12 +1,12 @@
-class CreateSimpleApiKeyEngineApiKeys < ActiveRecord::Migration
-  def change
-    create_table :simple_api_key_engine_api_keys do |t|
-      t.string :token, index: true
-      t.datetime :expires_at
-      t.string :user_ident
-      t.string :user_type
-      t.timestamps
-      t.index [:user_type, :user_ident], name: :simple_api_key_engine_api_keys_user
-    end
-  end
-end
+class CreateSimpleApiKeyEngineApiKeys < ActiveRecord::Migration
+  def change
+    create_table :simple_api_key_engine_api_keys do |t|
+      t.string :token, index: true
+      t.datetime :expires_at
+      t.string :user_ident
+      t.string :user_type
+      t.timestamps
+      t.index [:user_type, :user_ident], name: :simple_api_key_engine_api_keys_user
+    end
+  end
+end

data/db/migrate/20141110041340_create_simple_api_key_engine_authentications.rb

@@ -1,15 +1,15 @@
-class CreateSimpleApiKeyEngineAuthentications < ActiveRecord::Migration
-  def change
-    create_table :simple_api_key_engine_authentications do |t|
-      t.string :user_ident
-      t.string :user_type
-      t.string :provider
-      t.string :uid
-      t.string :token
-      t.text :auth_hash
-      t.timestamps
-      t.index [:user_type, :user_ident], name: :simple_api_key_engine_authentications_user
-    end
-
-  end
-end
+class CreateSimpleApiKeyEngineAuthentications < ActiveRecord::Migration
+  def change
+    create_table :simple_api_key_engine_authentications do |t|
+      t.string :user_ident
+      t.string :user_type
+      t.string :provider
+      t.string :uid
+      t.string :token
+      t.text :auth_hash
+      t.timestamps
+      t.index [:user_type, :user_ident], name: :simple_api_key_engine_authentications_user
+    end
+
+  end
+end

data/db/migrate/20141117060900_add_expires_at_to_simple_api_key_engine_authentications.rb

@@ -1,7 +1,7 @@
-class AddExpiresAtToSimpleApiKeyEngineAuthentications < ActiveRecord::Migration
-  def change
-    change_table :simple_api_key_engine_authentications do |t|
-      t.datetime :expires_at
-    end
-  end
-end
+class AddExpiresAtToSimpleApiKeyEngineAuthentications < ActiveRecord::Migration
+  def change
+    change_table :simple_api_key_engine_authentications do |t|
+      t.datetime :expires_at
+    end
+  end
+end

data/lib/simpleapikeyengine.rb

@@ -1,17 +1,17 @@
-require "simpleapikeyengine/engine"
-
-module SimpleApiKeyEngine
-  class << self
-    attr_writer :configuration
-  end
-
-  def self.configuration
-    @configuration ||= SimpleApiKeyEngine::Configuration.new
-  end
-
-  def self.configure
-    yield(configuration)
-  end
-end
-
-require "simpleapikeyengine/providers"
+require "simpleapikeyengine/engine"
+
+module SimpleApiKeyEngine
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= SimpleApiKeyEngine::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end
+
+require "simpleapikeyengine/providers"

data/lib/simpleapikeyengine/engine.rb

@@ -1,5 +1,5 @@
-module SimpleApiKeyEngine
-  class Engine < ::Rails::Engine
-    isolate_namespace SimpleApiKeyEngine
-  end
-end
+module SimpleApiKeyEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace SimpleApiKeyEngine
+  end
+end

data/lib/simpleapikeyengine/provider_configuration.rb

@@ -1,9 +1,9 @@
-class SimpleApiKeyEngine::Configuration < Hash
-  def method_missing(method, *params)
-    if method.to_s =~ /^(.+)=$/
-      self[$1.to_sym] = params.first
-    else
-      self[method.to_sym]
-    end
-  end
-end
+class SimpleApiKeyEngine::Configuration < Hash
+  def method_missing(method, *params)
+    if method.to_s =~ /^(.+)=$/
+      self[$1.to_sym] = params.first
+    else
+      self[method.to_sym]
+    end
+  end
+end

data/lib/simpleapikeyengine/providers.rb

@@ -1,7 +1,7 @@
-module SimpleApiKeyEngine
-  module Providers
-
-  end
-end
-
-require 'simpleapikeyengine/providers/abstract_provider'
+module SimpleApiKeyEngine
+  module Providers
+
+  end
+end
+
+require 'simpleapikeyengine/providers/abstract_provider'

data/lib/simpleapikeyengine/providers/abstract_provider.rb

@@ -1,61 +1,67 @@
-require 'simpleapikeyengine/provider_configuration'
-
-module SimpleApiKeyEngine::Providers
-  class AbstractProvider
-    class << self
-      @@priorities = {}
-      def priority(val=nil)
-        if val.present?
-          @@priorities[self] = val
-        else
-          @@priorities[self]
-        end
-      end
-
-      def acceptable?(auth_hash)
-        raise NotImplementedError
-      end
-    end
-
-    def initialize(params)
-      @params = params
-    end
-
-    def auth(&block)
-      auth_hash = get_auth_hash!
-      authentication = ::SimpleApiKeyEngine::Authentication.find_by_provider_and_uid(auth_hash[:provider], auth_hash[:uid])
-      unless authentication
-        authentication = ::SimpleApiKeyEngine::Authentication.new(provider: auth_hash[:provider],
-                                                                  uid: auth_hash[:uid])
-        authentication.user = block.call(auth_hash)
-      end
-      authentication.token = auth_hash[:credentials][:token]
-      authentication.expires_at = auth_hash[:credentials][:expires] ?
-        Time.at(auth_hash[:credentials][:expires_at]) : nil
-      authentication.auth_hash = auth_hash
-      authentication.save!
-      return authentication
-    end
-
-    def get_auth_hash!
-      # {
-      #     provider: 'provider_key',
-      #     uid: user_info['id'],
-      #     credentials: {
-      #         token: 'OAuth2Token',
-      #         expires_at: expires_at,
-      #         expires: expires
-      #     },
-      #     info: {
-      #         email: user_info['email'],
-      #         name: user_info['name']
-      #     },
-      #     extra: {
-      #         raw_info: user_info.to_h
-      #     }
-      # }
-      raise NotImplementedError
-    end
-
-  end
-end
+require 'simpleapikeyengine/provider_configuration'
+
+module SimpleApiKeyEngine::Providers
+  class AbstractProvider
+    class << self
+      @@priorities = {}
+      def priority(val=nil)
+        if val.present?
+          @@priorities[self] = val
+        else
+          @@priorities[self]
+        end
+      end
+
+      def acceptable?(request)
+        raise NotImplementedError
+      end
+    end
+
+    def initialize(request)
+      @request = request
+      @params = request.params
+    end
+
+    def auth(&block)
+      auth_hash = get_auth_hash!
+      authentication = ::SimpleApiKeyEngine::Authentication.find_by_provider_and_uid(auth_hash[:provider], auth_hash[:uid])
+      unless authentication
+        authentication = ::SimpleApiKeyEngine::Authentication.new(provider: auth_hash[:provider],
+                                                                  uid: auth_hash[:uid])
+        authentication.user = block.call(auth_hash)
+      end
+      authentication.token = auth_hash[:credentials][:token]
+      authentication.expires_at = auth_hash[:credentials][:expires] ?
+        Time.at(auth_hash[:credentials][:expires_at]) : nil
+      authentication.auth_hash = auth_hash
+      authentication.save!
+      after_authentication(authentication)
+      return authentication
+    end
+
+    def get_auth_hash!
+      # {
+      #     provider: 'provider_key',
+      #     uid: user_info['id'],
+      #     credentials: {
+      #         token: 'OAuth2Token',
+      #         expires_at: expires_at,
+      #         expires: expires
+      #     },
+      #     info: {
+      #         email: user_info['email'],
+      #         name: user_info['name']
+      #     },
+      #     extra: {
+      #         raw_info: user_info.to_h
+      #     }
+      # }
+      raise NotImplementedError
+    end
+
+    def after_authentication(authentication)
+      true
+    end
+
+  end
+end

data/lib/simpleapikeyengine/version.rb

@@ -1,3 +1,3 @@
-module SimpleApiKeyEngine
-  VERSION = "0.0.7"
-end
+module SimpleApiKeyEngine
+  VERSION = "0.1.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simpleapikeyengine
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Yuichi Takeuchi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2015-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails