signinable 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7de1e58aefc74e883667a5030469615849840c67
-  data.tar.gz: dc5919405a68c6f8e28e43ef7901093b833fee9d
+  metadata.gz: 28561853b037485e6c9c747c720a93078287ff6a
+  data.tar.gz: 1bb5d4f681708be5ea63eb0421afe7c82eb05527
 SHA512:
-  metadata.gz: e9f22cfbf7422d93dddc5679ace3dd9e0b1650330529ef94add9e77d12abc69a3711898320aa9e59fa15b1cee4621d7fb382dfea6d5b6878d9fd335a0c68dabe
-  data.tar.gz: d0b5549808e353d889d38cc1a7217571d8da4e0dfa7376432297bcd64eca943907a8b40565b437973a7de301d6a496f71efc980dc8a06965c3574448dd69fa4d
+  metadata.gz: 76e28218c0bc1efa7c35c57fd6c1f759ed9d2c838a6f44559e639572031aae5031e7ee3095462548de3c504eaebd9d692289f5c385e0321677a1d95699350088
+  data.tar.gz: 9a7b11fd507a3fc63478cf5024033f3e1705766bb98ca8c99f4d28b67d491806d26467a66f22273d02ad118281a3646cd9614c005750d09e7b8359b048bf26fc

data/README.rdoc

@@ -1,3 +1,109 @@
 = Signinable
+{<img src="https://badge.fury.io/rb/signinable.png" alt="Gem Version" />}[http://badge.fury.io/rb/signinable]
+{<img src="https://travis-ci.org/novozhenets/signinable.png?branch=master" alt="Build Status" />}[https://travis-ci.org/novozhenets/signinable]
 
-This project rocks and uses MIT-LICENSE.
+Signinable is an authentication library for Ruby on Rails which allows token authentication for any user model.
+
+== Installation
+
+Add this to your Gemfile and run the +bundle+ command to install it.
+
+  gem "signinable"
+
+After that run
+
+  rails generate signinable
+
+and migrate the database.
+
+Gem does not work with <b>Rails < 4</b>.
+
+<b>Requires Ruby 1.9.2 or later.</b>
+
+== Usage
+
+Call signinable in an ActiveRecord class to make your model token signinable.
+
+  class User < ActiveRecord::Base
+    signinable
+  end
+
+=== 1. Instance methods
+
+  User.signin(ip, user_agent, referer)
+
+This will create and return signin token, which you can store in user cookies or session. For example, in your +session_controller+
+
+  class SessionsController < ApplicationController
+
+    def create
+      # check user credentials
+
+      # create signin token and set it into cookies
+      cookies[:signin_token] = user.signin(request.remote_ip, request.user_agent, request.referer)
+
+      # more code here
+    end
+
+  end
+
+To signout user in your +session_controller+
+
+  def destroy
+    # your code here
+
+    user.signout(cookies[:signin_token], request.remote_ip, request.user_agent, request.referer)
+
+    # more code here
+  end
+
+This will expire passed token.
+
+  user.last_signin
+
+This will return instance of +Signin+ model unless +User+ hasn't signed in yet.
+
+=== 2. Class methods
+
+Token is passed to +authenticate_with_token+ method on model class. For example, in your +application_controller+
+
+  class ApplicationController < ActionController::Base
+    # your code here
+
+    before_action :require_login
+    helper_method :current_user
+
+    protected
+    def current_user
+      @current_user ||= User.authenticate_with_token(cookies[:signin_token], request.remote_ip, request.user_agent, request.referer) if cookies[:signin_token]
+    end
+
+    # you should change this to whatever logic you need
+    def require_login
+      unless current_user
+        session[:return_to] ||= request.referer
+        redirect_to login_url
+      end
+    end
+
+    # more code here
+  end
+
+=== 3. Options
+
+Optional parameters can be passed in +signinable+ method.
+
+  signinable expiration: 1.day
+
+Expiration time of token is increased by +expiration+ value every time +authenticate_with_token+ gets called. <b>Default</b> is +2.hours+.
+
+  signinable simultaneous: false
+
+If false then all user signin tokens become expired except the last one, once the user is signed in. <b>Default</b> is +true+.
+
+  signinable restrictions: [:ip, :user_agent]
+
++restriction+ can be passed as an array of parameters, which have to be checked every time user tries to +authenticate_with_token+.
+This is done to prevent unauthorized access to tokens or to forbid using one token from different IPs or browsers. Posibble values are: +ip+ and +user_agent+ <b>Default</b> is empty array.
+
+All options can be combined any way.

data/Rakefile

@@ -14,4 +14,10 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task(:default).clear
+task :default => :spec
+
 Bundler::GemHelper.install_tasks

data/lib/signinable/model_additions.rb

@@ -14,7 +14,7 @@ module Signinable
         has_many :signins, as: :signinable, dependent: :destroy
       end
 
-      def authenticate_with_token(token, ip, user_agent, referer)
+      def authenticate_with_token(token, ip, user_agent)
         if(signin = Signin.find_by_token(token))
           if self.signin_expiration > 0
             return nil if signin.expired?
@@ -24,18 +24,18 @@ module Signinable
             return nil unless signin == signin.signinable.last_signin
           end
 
-          return nil unless self.check_signin_permission(signin, ip, user_agent, referer)
+          return nil unless self.check_signin_permission(signin, ip, user_agent)
           signin.update!(expiration_time: (Time.zone.now + self.signin_expiration)) unless self.signin_expiration == 0
           signin.signinable
         end
       end
 
-      def check_signin_permission(signin, ip, user_agent, referer)
-        signin_permitted?(signin, ip, user_agent, referer)
+      def check_signin_permission(signin, ip, user_agent)
+        signin_permitted?(signin, ip, user_agent)
       end
 
       private
-      def signin_permitted?(signin, ip, user_agent, referer)
+      def signin_permitted?(signin, ip, user_agent)
         self.signin_restrictions.each do |field|
           if(local_variables.include?(field.to_sym) && signin.respond_to?("#{field}"))
             return false unless signin.send("#{field}") == eval("#{field}")
@@ -51,9 +51,9 @@ module Signinable
       Signin.create!(signinable: self, ip: ip, referer: referer, user_agent: user_agent, expiration_time: expiration_time).token
     end
 
-    def signout(token, ip, user_agent, referer)
+    def signout(token, ip, user_agent)
       if(signin = Signin.find_by_token(token))
-        return nil unless self.class.check_signin_permission(signin, ip, user_agent, referer)
+        return nil unless self.class.check_signin_permission(signin, ip, user_agent)
         signin.expire!
 
         return true

data/lib/signinable/version.rb

@@ -1,3 +1,3 @@
 module Signinable
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signinable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ivan Novozhenets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails