authentication 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a79cf272b8049c3c5c4079363518bea601ef966
+  data.tar.gz: ebcdb430bc467c2586e1ac3d9adc2787c3a25996
+SHA512:
+  metadata.gz: 1504438b306f6a02d00b1aab3122fa95833b0a74bfe03b6187ef70974ed37850e220d47106cb4ed77ea06e1ae3077ee2c55c596aa811aa65fcf5365a348958de
+  data.tar.gz: 2597a069244ef5ffde178d66d2005ce1f037447f3e690747e61448b9e4ea90d65b6b1a1abf84497cfdb63f63b9c3174bd7c0bfcbd5cfe6ff0b378e632c0753c5

data/.travis.yml

@@ -1,5 +1,10 @@
 language: ruby
 rvm:
   - 1.9.3
-  - jruby-19mode # JRuby in 1.9 mode
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - jruby-19mode
   - rbx-19mode
+
+sudo: false

data/Gemfile.lock

@@ -1,21 +1,26 @@
 PATH
   remote: .
   specs:
-    authentication (0.0.1)
+    authentication (0.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
-    rake (0.9.2.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.0)
 
 PLATFORMS
   ruby
@@ -24,3 +29,6 @@ DEPENDENCIES
   authentication!
   rake
   rspec
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -2,19 +2,34 @@
 
 ## Minimalist authentication library for Ruby
 
-## How to use
+## Install
 
-See an [example](https://github.com/fujimura/authentication-rails-example) or [spec](https://github.com/fujimura/authentication/blob/master/spec/authentication_spec.rb)
+```
+$ gem install authentication
+```
 
-## Requirements
+or add ```gem 'authentication'``` to your Gemfile.
 
-* Included class should have a method called `find_current_user` which returns the user object.
-* Included class should have a method called `session` method which returns Hash-like object.
+## How to use in a Rails app
+
+0. Include `Authentication` to your controller.
+1. Define `#find_current_user` in your controller.
+2. That's all. You can use the method below in the controller:
+  - `#login!` and `#logout!` to log in/out.
+  - `#current_user` and `#current_user_id` to get current user or its id.
+  - `#logged_in?` to ask logged in or not.
+
+[Example](https://github.com/fujimura/authentication_rails_example) and [spec](https://github.com/fujimura/authentication/blob/master/spec/lib/authentication_spec.rb) might be also helpful.
+
+## Advanced usage
+
+Under the hood, methods above(`current_user` etc.) are delegated to the instance of `Authentication::Authenticator`, which is built for "current_user". So, it's possible to create custom authenticator for a client which isn't a current user.
 
 ## Side-effects
 
-* ```session[:current_user_id]``` in included module will be changed.
-* ```@current_user``` in included module will be changed.
+* ```session[:current_user_id]``` of the class includes `Authentication` will be changed.
+* The class includes `Authentication` will include `Forwardable`.
+* The class includes `Authentication` will have a method called `current_user_authenticator`.
 
 ## Goal
 

data/lib/authentication.rb

@@ -1,45 +1,30 @@
 require "authentication/version"
+require "authentication/authenticator"
 
+# Top-level namespace of this library, also works as a convenient module to supply authentication-related methods for Rails controller etc.
+#
+# By including this, the class will have methods like "login!" or "current_user!". See method list for the documentation of Authenticator.
+#
+# To find current_user, this module uses "find_current_user" method defined in included module to find current user, and "current_user_id" as the session key.
 module Authentication
-
+  # Raised when authentication was failed.
   class Unauthenticated < StandardError; end
 
-  # Log in with given object.
-  #
-  # @param [Object] user The object you want to store as `current_user`.
-  def login!(user)
-    raise Unauthenticated unless user
-    @current_user = user
-    session[:current_user_id] = user.id
-  end
-
-  # Return current_user.
-  # If it does not exist, returns nil.
-  #
-  # @return [Object] The object stored as user or nil
-  def current_user
-    @current_user ||= find_current_user
-  end
-
-  # Return id of given current_user.
-  # If it does not exist, returns nil.
-  #
-  # @return [Object] The id of object stored as user or nil
-  def current_user_id
-    session[:current_user_id]
-  end
-
-  # Return current_user exists or not.
-  #
-  # @return [Boolean]
-  def logged_in?
-    not current_user.nil?
+  def self.included(base)
+    base.class_eval do
+      extend Forwardable
+      def_delegators :current_user_authenticator, :login!, :current_user, :current_user_id, :logged_in?, :logout!
+    end
   end
 
-  # Delete current_user from database and session.
+  # Return authenticator for current_user.
   #
-  def logout!
-    return unless current_user
-    @current_user = session[:current_user_id] = nil
+  # @return [Authentication::Authenticator]
+  def current_user_authenticator
+    @__authenticator ||= Authentication::Authenticator.new(
+      session: session,
+      session_key: :current_user_id,
+      finder: -> { find_current_user }
+    )
   end
 end

data/lib/authentication/authenticator.rb

@@ -0,0 +1,56 @@
+module Authentication
+  # A object to authenticate client.
+  # @since 0.0.2
+  class Authenticator
+    # @param [Hash] options the options to create a authenticator with.
+    # @option options [Hash] :session Hash-like session object.
+    # @option options [Symbol] :session_key Key of session_id.
+    # @option options [Proc] :finder A proc which returns client to authenticate.
+    def initialize(options)
+      @session = options.fetch :session
+      @session_key = options.fetch :session_key
+      @finder = options.fetch :finder
+    end
+
+    # Set current_client.
+    #
+    # @raise [Unauthenticated] Raised when given client doesn't exist.
+    def login!(client)
+      raise Unauthenticated unless client
+      @current_client = client
+      @session[@session_key] = client.id
+    end
+
+    # Return current_client.
+    # If it does not exist, returns nil.
+    #
+    # @return [Object] The object stored as client or nil
+    def current_client
+      @current_client ||= @finder.call
+    end
+    alias current_user current_client
+
+    # Return id of given current_client.
+    # If it does not exist, returns nil.
+    #
+    # @return [Object] The id of object stored as client or nil
+    def current_client_id
+      @session[@session_key]
+    end
+    alias current_user_id current_client_id
+
+    # Return current_client exists or not.
+    #
+    # @return [Boolean]
+    def logged_in?
+      not current_client.nil?
+    end
+
+    # Delete current_client from database and session.
+    #
+    def logout!
+      return unless current_client
+      @current_client = @session[@session_key] = nil
+    end
+  end
+end

data/lib/authentication/version.rb

@@ -1,3 +1,3 @@
 module Authentication
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/authentication_spec.rb

@@ -8,7 +8,7 @@ class Controller
     self.session = {}
   end
 
-  def find_current_user success = true
+  def find_current_user
     if session[:current_user_id]
       true
     else
@@ -44,13 +44,13 @@ describe Authentication do
     context 'when logged in' do
       it "should return user" do
         controller.login! user
-        controller.current_user.should == user
+        expect(controller.current_user).to eq user
       end
     end
     context 'when not logged in' do
       it "should call #find_current_user and return its result" do
-        controller.should_receive(:find_current_user).and_return "something"
-        controller.current_user.should == "something"
+        expect(controller).to receive(:find_current_user).and_return "something"
+        expect(controller.current_user). to eq "something"
       end
     end
   end
@@ -59,12 +59,12 @@ describe Authentication do
     context 'when logged in' do
       it "should return user_id" do
         controller.login! user
-        controller.current_user_id.should == user.id
+        expect(controller.current_user_id).to eq user.id
       end
     end
     context 'when not logged in' do
       it "should return nil" do
-        controller.current_user_id.should == nil
+        expect(controller.current_user_id).to eq nil
       end
     end
   end
@@ -73,7 +73,7 @@ describe Authentication do
     context 'when logged in' do
       it "should return true" do
         controller.login! user
-        controller.logged_in?.should == true
+        expect(controller).to be_logged_in
       end
     end
   end
@@ -83,8 +83,8 @@ describe Authentication do
       it "should set current_user to nil" do
         controller.login! user
         controller.logout!
-        controller.current_user.should == nil
-        controller.session[:current_user_id].should == nil
+        expect(controller.current_user).to eq nil
+        expect(controller.session[:current_user_id]).to eq nil
       end
     end
   end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: authentication
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Fujimura Daisuke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-07 00:00:00.000000000 Z
+date: 2015-11-24 00:00:00.000000000 Z
 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: rspec
   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'
 description: Minimalist authentication library for Ruby
@@ -50,8 +45,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -59,34 +54,33 @@ files:
 - Rakefile
 - authentication.gemspec
 - lib/authentication.rb
+- lib/authentication/authenticator.rb
 - lib/authentication/version.rb
 - spec/lib/authentication_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/fujimura/authentication
 licenses: []
+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: authentication
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Minimalist authentication library for Ruby
 test_files:
 - spec/lib/authentication_spec.rb
 - spec/spec_helper.rb
-has_rdoc: