signinable 2.0.11 → 2.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f6b4e11c8d02ff119c491cbcd8a21ac67cf1c14e8964d690c517facb547773a
-  data.tar.gz: '06836449980727858552681d9cbf919803e960f1dac59e214d10de82bc547dc5'
+  metadata.gz: dcefec413ade50e4c25e5092ce23033646cb6ed3b7e19bbe473011ecbf4bb649
+  data.tar.gz: e9c6374287e726ce2007b3a6654063d017138161cfaf51cb2076167e629708d2
 SHA512:
-  metadata.gz: 0673f78fb8302317f41fa5df6f0956069bf6a255fbab3e931fe2f3f4b17807b098f1efb09c2da2126345923c43b676a8384d1dfae73849014993fead611f9b6c
-  data.tar.gz: 258c6e565a86bbf68b303469af5bff069bf035edac10dcdb63421389b40f3db3e4c2b889fdac70ad871e0be1767f283db842a12305d36d011e15fa1dea239303
+  metadata.gz: '07509bfee44ecffa2072e9c7730c8b9aa557c60bf1d3d599366f9b793b77b7a4934f7de800a77157bfdba2773be1e7908343ef11d90550a6d52fccb8d8982786'
+  data.tar.gz: ecd7ec4b2e43ff9d6a219d255674a8ee0663d190549123af5998300ba1ce52d4c972b9636b433fe685fa43d9da6159303a650c9f2937453c01e40b35719da91f

data/Rakefile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
@@ -12,7 +14,7 @@ Bundler::GemHelper.install_tasks
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
-desc "Run all specs in spec directory (excluding plugin specs)"
-RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
 
-task :default => :spec
+task default: :spec

data/app/models/signin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'resolv'
 
 class Signin < ActiveRecord::Base
@@ -13,11 +15,19 @@ class Signin < ActiveRecord::Base
   end
 
   def expire!
-    update!(expiration_time: Time.zone.now)
+    renew!(0)
   end
 
   def expired?
-    expiration_time && expiration_time <= Time.zone.now
+    expireable? && expiration_time.past?
+  end
+
+  def expireable?
+    !expiration_time.nil?
+  end
+
+  def renew!(period)
+    update!(expiration_time: (Time.zone.now + period))
   end
 
   serialize :custom_data if ActiveRecord::Base.connection.instance_values['config'][:adapter].match('mysql')

data/config/routes.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 Rails.application.routes.draw do
 end

data/db/migrate/20140103165607_create_signins.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 migration_kls = Rails::VERSION::MAJOR > 4 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
 class CreateSignins < migration_kls
   def self.up
@@ -5,18 +7,18 @@ class CreateSignins < migration_kls
       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    :referer, default: ''
+      t.string    :user_agent, default: ''
       t.string    :ip, null: false
       t.datetime  :expiration_time
       t.timestamps
     end
 
-    if ActiveRecord::Base.connection.instance_values["config"][:adapter] == "postgresql"
-      execute "ALTER TABLE signins ALTER COLUMN ip TYPE inet USING ip::inet"
+    if ActiveRecord::Base.connection.instance_values['config'][:adapter] == 'postgresql'
+      execute 'ALTER TABLE signins ALTER COLUMN ip TYPE inet USING ip::inet'
     end
 
-    add_index :signins, [:signinable_id, :signinable_type]
+    add_index :signins, %i[signinable_id signinable_type]
     add_index :signins, :token
   end
 

data/db/migrate/20180530131006_add_custom_data_to_sigins.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 migration_kls = Rails::VERSION::MAJOR > 4 ? ActiveRecord::Migration[5.0] : ActiveRecord::Migration
 
 class AddCustomDataToSigins < migration_kls
   def change
-
-    if ActiveRecord::Base.connection.instance_values["config"][:adapter] == "postgresql"
-      add_column :signins, :custom_data, :jsonb, null:false, default: {}
+    if ActiveRecord::Base.connection.instance_values['config'][:adapter] == 'postgresql'
+      add_column :signins, :custom_data, :jsonb, null: false, default: {}
     else
-      add_column :signins, :custom_data, :string, null:false, default: {}.to_json
+      add_column :signins, :custom_data, :string, null: false, default: {}.to_json
     end
-
   end
 end

data/lib/signinable/engine.rb

@@ -1,18 +1,13 @@
+# frozen_string_literal: true
+
 module Signinable
   class Engine < ::Rails::Engine
     initializer :append_migrations do |app|
       unless app.root.to_s.match(root.to_s)
-        config.paths["db/migrate"].expanded.each do |path|
-          app.config.paths["db/migrate"] << path
+        config.paths['db/migrate'].expanded.each do |path|
+          app.config.paths['db/migrate'] << path
         end
       end
     end
-
-    config.generators do |g|
-      g.test_framework      :rspec,        :fixture => false
-      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
-      g.assets false
-      g.helper false
-    end
   end
 end

data/lib/signinable/model_additions.rb

@@ -1,87 +1,113 @@
+# frozen_string_literal: true
+
 module Signinable
   module ModelAdditions
     extend ActiveSupport::Concern
 
     module ClassMethods
+      ALLOWED_RESTRICTIONS = %i[ip user_agent].freeze
+      DEFAULT_EXPIRATION = 7200
+
+      cattr_reader :signin_expiration
+      cattr_reader :simultaneous_signings
+      cattr_reader :signin_restrictions
+
       def signinable(options = {})
-        cattr_accessor :signin_expiration
-        cattr_accessor :signin_simultaneous
-        cattr_accessor :signin_restrictions
-        self.signin_expiration = options.fetch(:expiration, 2.hours)
-        self.signin_simultaneous = options.fetch(:simultaneous, true)
+        self.signin_expiration = options.fetch(:expiration, DEFAULT_EXPIRATION)
+        self.simultaneous_signings = options.fetch(:simultaneous, true)
         self.signin_restrictions = options[:restrictions]
 
         has_many :signins, as: :signinable, dependent: :destroy
       end
 
-      def authenticate_with_token(token, ip, user_agent, skip_restrictions=[])
-        if(signin = Signin.find_by_token(token))
-          if self.signin_expiration.respond_to?(:call)
-            self.signin_expiration = self.signin_expiration.call(signin.signinable)
-          end
+      def authenticate_with_token(token, ip, user_agent, skip_restrictions: [])
+        signin = Signin.find_by(token: token)
 
-          if self.signin_expiration > 0
-            return nil if signin.expired?
-          end
+        return unless signin
+        return nil if signin.expired?
+        return nil unless check_simultaneous_signings(signin)
+        return nil unless check_signin_permission(signin, { ip: ip, user_agent: user_agent }, skip_restrictions)
 
-          unless self.signin_simultaneous
-            return nil unless signin == signin.signinable.last_signin
-          end
+        signin.renew!(expiration_period) if signin.expireable?
+        signin.signinable
+      end
 
-          return nil unless self.check_signin_permission(signin, ip, user_agent, skip_restrictions)
-          signin.update!(expiration_time: (Time.zone.now + self.signin_expiration)) unless signin.expiration_time.nil? || self.signin_expiration == 0
-          signin.signinable
-        end
+      def check_signin_permission(signin, restrictions_to_check, skip_restrictions)
+        signin_permitted?(signin, restrictions_to_check, skip_restrictions)
       end
 
-      def check_signin_permission(signin, ip, user_agent, skip_restrictions)
-        signin_permitted?(signin, ip, user_agent, skip_restrictions)
+      def expiration_period
+        return signin_expiration.call if signin_expiration.respond_to?(:call)
+
+        signin_expiration
       end
 
       private
-      def signin_permitted?(signin, ip, user_agent, skip_restrictions)
-        restriction_fields = case
-        when self.signin_restrictions.respond_to?(:call)
-          self.signin_restrictions.call(signin.signinable)
-        when self.signin_restrictions.is_a?(Array)
-          self.signin_restrictions
-        else
-          []
-        end
 
-        (restriction_fields - skip_restrictions).each do |field|
-          if(local_variables.include?(field.to_sym) && signin.respond_to?("#{field}"))
-            return false unless signin.send("#{field}") == eval("#{field}")
-          end
+      cattr_writer :signin_expiration
+      cattr_writer :simultaneous_signings
+      cattr_writer :signin_restrictions
+
+      def signin_permitted?(signin, restrictions_to_check, skip_restrictions)
+        restriction_fields = signin_restriction_fields(signin, skip_restrictions)
+
+        restrictions_to_check.slice(*restriction_fields).each do |field, value|
+          return false unless signin.send(field) == value
         end
 
-        return true
+        true
       end
-    end
 
-    def signin(ip, user_agent, referer, permanent = false, custom_data = {})
-      if self.class.signin_expiration.respond_to?(:call)
-        self.class.signin_expiration = self.class.signin_expiration.call(self)
+      def signin_restriction_fields(signin, skip_restrictions)
+        fields = if signin_restrictions.respond_to?(:call)
+                   signin_restrictions.call(signin.signinable)
+                 elsif signin_restrictions.is_a?(Array)
+                   signin_restrictions
+                 else
+                   []
+                 end
+        (fields - skip_restrictions) & ALLOWED_RESTRICTIONS
       end
-      expiration_time = (self.class.signin_expiration == 0 || permanent) ? nil : (Time.zone.now + self.class.signin_expiration)
-      Signin.create!(custom_data: custom_data, signinable: self, ip: ip, referer: referer, user_agent: user_agent, expiration_time: expiration_time).token
-    end
 
-    def signout(token, ip, user_agent, skip_restrictions=[])
-      if(signin = Signin.find_by_token(token))
-        return nil unless self.class.check_signin_permission(signin, ip, user_agent, skip_restrictions)
-        signin.expire!
+      def check_simultaneous_signings(signin)
+        return true if simultaneous_signings
 
-        return true
+        signin == signin.signinable.last_signin
       end
+    end
+
+    def signin(ip, user_agent, referer, permanent: false, custom_data: {})
+      expires_in = self.class.expiration_period
+      expiration_time = expires_in.zero? || permanent ? nil : expires_in.seconds.from_now
+      Signin.create!(
+        signinable: self,
+        ip: ip,
+        referer: referer,
+        user_agent: user_agent,
+        expiration_time: expiration_time,
+        custom_data: custom_data
+      ).token
+    end
+
+    def signout(token, ip, user_agent, skip_restrictions: [])
+      signin = Signin.find_by_token(token)
+
+      return unless signin
+      return unless self.class.check_signin_permission(
+        signin,
+        { ip: ip, user_agent: user_agent },
+        skip_restrictions
+      )
+
+      signin.expire!
 
-      return nil
+      true
     end
 
     def last_signin
-      signins.last unless signins.empty?
+      signins.last
     end
   end
 end
 
-ActiveRecord::Base.send(:include, Signinable::ModelAdditions)
+ActiveRecord::Base.include Signinable::ModelAdditions

data/lib/signinable/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Signinable
-  VERSION = '2.0.11'
+  VERSION = '2.0.12'
 end

data/lib/signinable.rb

@@ -1,3 +1,5 @@
-require "signinable/engine"
+# frozen_string_literal: true
+
+require 'signinable/engine'
 require 'signinable/version'
 require 'signinable/model_additions'

data/spec/dummy/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path('config/application', __dir__)
 
 Dummy::Application.load_tasks

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class User < ActiveRecord::Base
   signinable
 end

data/spec/dummy/bin/bundle

@@ -1,3 +1,5 @@
 #!/usr/bin/env ruby
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+# frozen_string_literal: true
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
 load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
+# frozen_string_literal: true
+
+APP_PATH = File.expand_path('../config/application', __dir__)
 require_relative '../config/boot'
 require 'rails/commands'

data/spec/dummy/bin/rake

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require_relative '../config/boot'
 require 'rake'
 Rake.application.run

data/spec/dummy/config/application.rb

@@ -1,28 +1,13 @@
-require File.expand_path('../boot', __FILE__)
+# frozen_string_literal: true
 
-# Pick the frameworks you want:
-require "active_record/railtie"
-require "action_controller/railtie"
-require "action_mailer/railtie"
-require "sprockets/railtie"
-# require "rails/test_unit/railtie"
+require File.expand_path('boot', __dir__)
+
+require 'active_record/railtie'
 
 Bundler.require(*Rails.groups)
-require "signinable"
+require 'signinable'
 
 module Dummy
   class Application < Rails::Application
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
-
-    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
-    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
   end
 end
-

data/spec/dummy/config/boot.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
 
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
-$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/environment.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # Load the Rails application.
-require File.expand_path('../application', __FILE__)
+require File.expand_path('application', __dir__)
 
 # Initialize the Rails application.
 Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 
@@ -14,7 +16,7 @@ Dummy::Application.configure do
   config.action_controller.perform_caching = false
 
   # Don't care if the mailer can't send.
-  config.action_mailer.raise_delivery_errors = false
+  # config.action_mailer.raise_delivery_errors = false
 
   # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
@@ -25,5 +27,5 @@ Dummy::Application.configure do
   # Debug mode disables concatenation and preprocessing of assets.
   # This option may cause significant delays in view rendering with a large
   # number of complex assets.
-  config.assets.debug = true
+  # config.assets.debug = true
 end

data/spec/dummy/config/environments/production.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 

data/spec/dummy/config/environments/test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Dummy::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 
@@ -14,7 +16,7 @@ Dummy::Application.configure do
 
   # Configure static asset server for tests with Cache-Control for performance.
   config.serve_static_assets  = true
-  config.static_cache_control = "public, max-age=3600"
+  config.static_cache_control = 'public, max-age=3600'
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
@@ -29,7 +31,7 @@ Dummy::Application.configure do
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the
   # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
+  # config.action_mailer.delivery_method = :test
 
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Be sure to restart your server when you modify this file.
 
 # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.

data/spec/dummy/config/initializers/filter_parameter_logging.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Be sure to restart your server when you modify this file.
 
 # Configure sensitive parameters which will be filtered from the log file.

data/spec/dummy/config/initializers/inflections.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Be sure to restart your server when you modify this file.
 
 # Add new inflection rules using the following format. Inflections

data/spec/dummy/config/initializers/mime_types.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Be sure to restart your server when you modify this file.
 
 # Add new mime types for use in respond_to blocks:

data/spec/dummy/config/initializers/secret_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Be sure to restart your server when you modify this file.
 
 # Your secret key is used for verifying the integrity of signed cookies.

data/spec/dummy/config/initializers/session_store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Be sure to restart your server when you modify this file.
 
 Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Be sure to restart your server when you modify this file.
 
 # This file contains settings for ActionController::ParamsWrapper which

data/spec/dummy/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Dummy::Application.routes.draw do
   # The priority is based upon order of creation: first created -> highest priority.
   # See how all your routes lay out with "rake routes".

data/spec/dummy/config.ru

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('config/environment', __dir__)
 run Rails.application

data/spec/dummy/db/migrate/20140103165606_create_users.rb

@@ -1,4 +1,6 @@
-class CreateUsers < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class CreateUsers < ActiveRecord::Migration[5.0]
   def self.up
     create_table :users do |t|
       t.string :name

data/spec/dummy/db/schema.rb

@@ -1,35 +1,34 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
 #
-# Note that this schema.rb definition is the authoritative source for your
-# database schema. If you need to create the application database on another
-# system, you should be using db:schema:load, not running all the migrations
-# from scratch. The latter is a flawed and unsustainable approach (the more migrations
-# you'll amass, the slower it'll run and the greater likelihood for issues).
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20140103165607) do
-
-  create_table "signins", force: true 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.datetime "created_at"
-    t.datetime "updated_at"
+ActiveRecord::Schema.define(version: 20_180_530_131_006) do
+  create_table 'signins', force: :cascade 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.datetime 'created_at', null: false
+    t.datetime 'updated_at', null: false
+    t.string 'custom_data', default: '{}', null: false
+    t.index %w[signinable_id signinable_type], name: 'index_signins_on_signinable_id_and_signinable_type'
+    t.index ['token'], name: 'index_signins_on_token'
   end
 
-  add_index "signins", ["signinable_id", "signinable_type"], name: "index_signins_on_signinable_id_and_signinable_type"
-  add_index "signins", ["token"], name: "index_signins_on_token"
-
-  create_table "users", force: true do |t|
-    t.string "name"
+  create_table 'users', force: :cascade do |t|
+    t.string 'name'
   end
-
 end