signinable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7de1e58aefc74e883667a5030469615849840c67
+  data.tar.gz: dc5919405a68c6f8e28e43ef7901093b833fee9d
+SHA512:
+  metadata.gz: e9f22cfbf7422d93dddc5679ace3dd9e0b1650330529ef94add9e77d12abc69a3711898320aa9e59fa15b1cee4621d7fb382dfea6d5b6878d9fd335a0c68dabe
+  data.tar.gz: d0b5549808e353d889d38cc1a7217571d8da4e0dfa7376432297bcd64eca943907a8b40565b437973a7de301d6a496f71efc980dc8a06965c3574448dd69fa4d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Ivan Novozhenets
+
+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.rdoc

@@ -0,0 +1,3 @@
+= Signinable
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Signinable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/lib/generators/signinable/USEGA

@@ -0,0 +1,6 @@
+Description:
+  Copies signin.rb to app/models/.
+  Copies create_signins.rb to db/migrate
+
+Examples:
+  `rails generate signinable`

data/lib/generators/signinable/signinable_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/migration'
+
+class SigninableGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def create_model_file
+    template "signin.rb", "app/models/signin.rb"
+    migration_template "create_signins.rb", "db/migrate/create_signins.rb"
+  end
+end

data/lib/generators/signinable/templates/create_signins.rb

@@ -0,0 +1,21 @@
+class CreateSignins < ActiveRecord::Migration
+  def self.up
+    create_table :signins do |t|
+      t.integer   :signinable_id, null: false
+      t.string    :signinable_type, null: false
+      t.string    :token, null: false
+      t.string    :referer, default: ""
+      t.string    :user_agent, default: ""
+      t.string    :ip, null: false
+      t.datetime  :expiration_time
+      t.timestamps
+    end
+
+    add_index :signins, [:signinable_id, :signinable_type]
+    add_index :signins, :token
+  end
+
+  def self.down
+    drop_table :signins
+  end
+end

data/lib/generators/signinable/templates/signin.rb

@@ -0,0 +1,20 @@
+class Signin < ActiveRecord::Base
+  belongs_to :signinable, polymorphic: true
+
+  validates :token, presence: true
+  validates :ip,
+            presence: true,
+            format: { with: /\A([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])){3}\z/ }
+
+  before_validation on: :create do
+    self.token = SecureRandom.urlsafe_base64(rand(50..100))
+  end
+
+  def expire!
+    update_attributes(expiration_time: Time.zone.now)
+  end
+
+  def expired?
+    expiration_time && expiration_time <= Time.zone.now
+  end
+end

data/lib/signinable/model_additions.rb

@@ -0,0 +1,71 @@
+module Signinable
+  module ModelAdditions
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def signinable(options = {})
+        cattr_accessor :signin_expiration
+        cattr_accessor :signin_simultaneous
+        cattr_accessor :signin_restrictions
+        self.signin_expiration = options[:expiration] || 2.hours
+        self.signin_simultaneous = options[:simultaneous] || true
+        self.signin_restrictions = (options[:restrictions] && options[:restrictions].is_a?(Array)) ? options[:restrictions] : []
+
+        has_many :signins, as: :signinable, dependent: :destroy
+      end
+
+      def authenticate_with_token(token, ip, user_agent, referer)
+        if(signin = Signin.find_by_token(token))
+          if self.signin_expiration > 0
+            return nil if signin.expired?
+          end
+
+          unless self.signin_simultaneous
+            return nil unless signin == signin.signinable.last_signin
+          end
+
+          return nil unless self.check_signin_permission(signin, ip, user_agent, referer)
+          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)
+      end
+
+      private
+      def signin_permitted?(signin, ip, user_agent, referer)
+        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}")
+          end
+        end
+
+        return true
+      end
+    end
+
+    def signin(ip, user_agent, referer)
+      expiration_time = self.class.signin_expiration == 0 ? nil : (Time.zone.now + self.class.signin_expiration)
+      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)
+      if(signin = Signin.find_by_token(token))
+        return nil unless self.class.check_signin_permission(signin, ip, user_agent, referer)
+        signin.expire!
+
+        return true
+      end
+
+      return nil
+    end
+
+    def last_signin
+      signins.last unless signins.empty?
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Signinable::ModelAdditions)

data/lib/signinable/version.rb

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

data/lib/signinable.rb

@@ -0,0 +1,2 @@
+require 'signinable/version'
+require 'signinable/model_additions'

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: signinable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ivan Novozhenets
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.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: rspec-rails
+  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: capybara
+  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: guard-rspec
+  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: guard-spork
+  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: shoulda
+  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: timecop
+  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: factory_girl_rails
+  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: database_cleaner
+  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'
+description: Allows authentication with tokens
+email:
+- novozhenets@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/generators/signinable/USEGA
+- lib/generators/signinable/signinable_generator.rb
+- lib/generators/signinable/templates/create_signins.rb
+- lib/generators/signinable/templates/signin.rb
+- lib/signinable.rb
+- lib/signinable/model_additions.rb
+- lib/signinable/version.rb
+homepage: https://github.com/novozhenets/signinable
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0.rc.1
+signing_key: 
+specification_version: 4
+summary: Token based signin
+test_files: []