tiddle 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 636a498dc602f9309c1baf81f3f34276aad7e710fd14d170c02ba5af381b40f1
-  data.tar.gz: 670f3801abc579331c721d66ee5cf68e46817a89bdadfc6356d0f02ce0276176
+  metadata.gz: a2c0bdb8f5aeabf3e9c1528e84b993f900860d4fdfa09d2f22138cbe698a82fd
+  data.tar.gz: 37c83e2682e4eafaba3ab2d4ec360367e81595b632da2f3d504f6de49d9fa39d
 SHA512:
-  metadata.gz: d5305d3d877befdee9203d7001f05e07ef38a3ad77abcc74563140f2217f69319d39d723be4453410b1935ed01a839995e8c296c767349b2355657b36ba7532b
-  data.tar.gz: c114628903a18817a6a99ab3e233639d4e2c428e7216c06e46eed4407aac243f89533db8cae5edf05335d351c4903ea3559da60e1b42821b3c98ffdbf984eb0b
+  metadata.gz: '0936ed71652bec98eb6e0ad7fcc16e7508be99d6bef7b7e0aa3281533b9e8960356c7efe7088a0367da8139b279f54540c759837b06c679a66037cd0ad9220ff'
+  data.tar.gz: 29d80705f0ce7a7004c89669ebcfc36667e0dd0d48f0c5fa2c4994eeedb4da1884ee0ae18b9ce09886788107f636a6e1b246966f6619f4f0ffb84adf66a9c668

data/.gitignore

@@ -17,3 +17,4 @@ mkmf.log
 *.sqlite3
 *.log
 *.gemfile.lock
+.idea

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.3
   Include:
     - 'lib'
     - 'spec'

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
 before_install: gem update --system
+services:
+- mongodb
 rvm:
-  - "2.2.8"
   - "2.3.5"
   - "2.4.2"
   - "2.5.0"
@@ -10,3 +11,6 @@ gemfile:
   - "gemfiles/rails5.0.gemfile"
   - "gemfiles/rails5.1.gemfile"
   - "gemfiles/rails5.2.gemfile"
+env:
+  - BACKEND=mongoid
+  - BACKEND=active_record

data/Appraisals

@@ -1,15 +1,20 @@
 appraise "rails4.2" do
   gem "rails", "~> 4.2.0"
+  gem "mongoid", "~> 5"
 end
 
 appraise "rails5.0" do
   gem "rails", "~> 5.0.0"
+  gem "mongoid", "~> 6"
 end
 
 appraise "rails5.1" do
   gem "rails", "~> 5.1.0"
+  gem "mongoid", "~> 6"
 end
 
 appraise "rails5.2" do
-  gem "rails", "5.2.0.beta2"
+  gem "rails", "5.2.0.rc1"
+  gem "devise", "4.4.1"
+  gem "mongoid", "~> 6"
 end

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.2.0
+
+Adds support for MongoDB.
+
 ### 1.1.0
 
 New feature: optional token expiration after period of inactivity - #37

data/gemfiles/rails4.2.gemfile

@@ -4,5 +4,6 @@ source "https://rubygems.org"
 
 gem "rubocop", "~> 0.52.0"
 gem "rails", "~> 4.2.0"
+gem "mongoid", "~> 5"
 
 gemspec path: "../"

data/gemfiles/rails5.0.gemfile

@@ -4,5 +4,6 @@ source "https://rubygems.org"
 
 gem "rubocop", "~> 0.52.0"
 gem "rails", "~> 5.0.0"
+gem "mongoid", "~> 6"
 
 gemspec path: "../"

data/gemfiles/rails5.1.gemfile

@@ -4,5 +4,6 @@ source "https://rubygems.org"
 
 gem "rubocop", "~> 0.52.0"
 gem "rails", "~> 5.1.0"
+gem "mongoid", "~> 6"
 
 gemspec path: "../"

data/gemfiles/rails5.2.gemfile

@@ -3,6 +3,8 @@
 source "https://rubygems.org"
 
 gem "rubocop", "~> 0.52.0"
-gem "rails", "5.2.0.beta2"
+gem "rails", "5.2.0.rc1"
+gem "devise", "4.4.1"
+gem "mongoid", "~> 6"
 
 gemspec path: "../"

data/lib/tiddle/token_issuer.rb

@@ -31,7 +31,8 @@ module Tiddle
     def find_token(resource, token_from_headers)
       token_class = authentication_token_class(resource)
       token_body = Devise.token_generator.digest(token_class, :body, token_from_headers)
-      resource.authentication_tokens.find_by(body: token_body)
+      # 'find_by' behaves differently in AR vs Mongoid, so using 'where' instead
+      resource.authentication_tokens.where(body: token_body).first
     end
 
     def purge_old_tokens(resource)
@@ -46,7 +47,13 @@ module Tiddle
     attr_accessor :maximum_tokens_per_user
 
     def authentication_token_class(resource)
-      resource.association(:authentication_tokens).klass
+      if resource.respond_to?(:association) # ActiveRecord
+        resource.association(:authentication_tokens).klass
+      elsif resource.respond_to?(:relations) # Mongoid
+        resource.relations['authentication_tokens'].klass
+      else
+        raise 'Cannot determine authentication token class, unsupported ORM/ODM?'
+      end
     end
 
     def token_attributes(token_body, request, expires_in)

data/lib/tiddle/version.rb

@@ -1,3 +1,3 @@
 module Tiddle
-  VERSION = "1.1.0".freeze
+  VERSION = "1.2.0".freeze
 end

data/spec/{rails_app → rails_app_active_record}/config/application.rb

@@ -8,8 +8,8 @@ require "action_view/railtie"
 module RailsApp
   class Application < Rails::Application
     config.eager_load = true
-    config.root =  File.expand_path('../../.', __FILE__)
+    config.root = File.expand_path('../../.', __FILE__)
     config.consider_all_requests_local = true
+    config.active_record.sqlite3.represent_boolean_as_integer = true if config.active_record.sqlite3
   end
 end
-

data/spec/{rails_app → rails_app_active_record}/db/migrate/20150217000000_create_tables.rb

@@ -1,10 +1,12 @@
-if Rails::VERSION::MAJOR > 4
-  migration_class = ActiveRecord::Migration[4.2]
-else
-  migration_class = ActiveRecord::Migration
-end
+migration_class = if Rails::VERSION::MAJOR > 4
+                    ActiveRecord::Migration[4.2]
+                  else
+                    ActiveRecord::Migration
+                  end
 
 class CreateTables < migration_class
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Metrics/MethodLength
   def change
     create_table(:users) do |t|
       ## Database authenticatable
@@ -63,4 +65,6 @@ class CreateTables < migration_class
       t.timestamps null: false
     end
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 end

data/spec/rails_app_mongoid/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/rails_app_mongoid/app/controllers/long_secrets_controller.rb

@@ -0,0 +1,7 @@
+class LongSecretsController < ApplicationController
+  before_action :authenticate_admin_user!
+
+  def index
+    head :ok
+  end
+end

data/spec/rails_app_mongoid/app/controllers/secrets_controller.rb

@@ -0,0 +1,7 @@
+class SecretsController < ApplicationController
+  before_action :authenticate_user!
+
+  def index
+    head :ok
+  end
+end

data/spec/rails_app_mongoid/app/models/admin_user.rb

@@ -0,0 +1,2 @@
+class AdminUser < User
+end

data/spec/rails_app_mongoid/app/models/authentication_token.rb

@@ -0,0 +1,11 @@
+class AuthenticationToken
+  include Mongoid::Document
+
+  belongs_to :user
+
+  field :body, type: String
+  field :last_used_at, type: Time
+  field :ip_address, type: String
+  field :user_agent, type: String
+  field :expires_in, type: Integer, default: 0
+end

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

@@ -0,0 +1,22 @@
+class User
+  include Mongoid::Document
+
+  devise :database_authenticatable,
+         :registerable,
+         :recoverable,
+         :trackable,
+         #:validatable Triggers callback to will_save_change_to_email?, fails with mongoid
+         :token_authenticatable
+
+  has_many :authentication_tokens
+
+  field :email, type: String, default: ''
+  field :encrypted_password, type: String, default: ''
+  field :reset_password_token, type: String
+  field :reset_password_sent_at, type: Time
+  field :sign_in_count, type: Integer, default: 0
+  field :current_sign_in_at, type: Time
+  field :last_sign_in_at, type: Time
+  field :current_sign_in_ip, type: String
+  field :nick_name, type: String
+end

data/spec/rails_app_mongoid/config/application.rb

@@ -0,0 +1,16 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_job/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+
+module RailsApp
+  class Application < Rails::Application
+    config.eager_load = true
+    config.root = File.expand_path('../../.', __FILE__)
+    config.consider_all_requests_local = true
+    config.active_record.sqlite3.represent_boolean_as_integer = true if config.active_record.sqlite3
+  end
+end

data/spec/rails_app_mongoid/config/boot.rb

@@ -0,0 +1,2 @@
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../../../../Gemfile', __FILE__)
+require 'bundler/setup'

data/spec/rails_app_mongoid/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/rails_app_mongoid/config/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  clients:
+    default:
+      database: tiddle_test
+      hosts:
+        - 0.0.0.0:27017

data/spec/rails_app_mongoid/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  devise_for :users
+  devise_for :admin_users
+  resources :secrets, only: [:index], defaults: { format: 'json' }
+  resources :long_secrets, only: [:index], defaults: { format: 'json' }
+end

data/spec/rails_app_mongoid/config/secrets.yml

@@ -0,0 +1,2 @@
+test:
+  secret_key_base: 01c37cff57639eef8aa511ae6ab64298c1da89dc32dfdda363473716f49e25d2473e48b6253c69d17c8ae8c9b6a027ec5a4ac0ffbd6c06defe1b70dd2ef32df8

data/spec/spec_helper.rb

@@ -16,13 +16,13 @@ ENV["DATABASE_URL"] = "sqlite3:db/test.sqlite3"
 require 'rails/all'
 require 'rspec/rails'
 require 'devise'
-require 'devise/orm/active_record'
 require 'tiddle'
 
-require 'rails_app/config/environment'
-
 Dir[__dir__ + "/support/**/*.rb"].each { |f| require f }
 
+backend = Backend.from_name(ENV['BACKEND'])
+backend.load!
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause
@@ -66,8 +66,12 @@ RSpec.configure do |config|
   end
 
   config.before(:suite) do
-    # Do initial migration
-    ActiveRecord::Migrator.migrate(File.expand_path("rails_app/db/migrate/", File.dirname(__FILE__)))
+    backend.setup_database_cleaner
+    backend.migrate!
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.clean if defined?(DatabaseCleaner)
   end
 
   config.use_transactional_fixtures = true

data/spec/strategy_spec.rb

@@ -32,7 +32,7 @@ describe "Authentication using Tiddle strategy", type: :request do
                 "X-USER-TOKEN" => @token
               }
             )
-          end.to(change { @user.authentication_tokens.last.last_used_at })
+          end.to(change { @user.reload.authentication_tokens.last.last_used_at })
         end
       end
 
@@ -181,7 +181,7 @@ describe "Authentication using Tiddle strategy", type: :request do
 
     describe "token is expired" do
       before do
-        token = @user.authentication_tokens.order(:id).last
+        token = @user.authentication_tokens.sort_by(&:id).last
         token.update_attribute(:last_used_at, 1.month.ago)
       end
 

data/spec/support/backend.rb

@@ -0,0 +1,50 @@
+module Backend
+  def self.from_name(name)
+    puts "Backend: #{name}"
+    case name
+    when 'mongoid'
+      MongoidBackend.new
+    else
+      ActiveRecordBackend.new
+    end
+  end
+
+  class ActiveRecordBackend
+    def load!
+      require 'devise/orm/active_record'
+      require 'rails_app_active_record/config/environment'
+    end
+
+    def setup_database_cleaner
+      # Not necessary
+    end
+
+    def migrate!
+      # Do initial migration
+      path = File.expand_path("../rails_app_active_record/db/migrate/", File.dirname(__FILE__))
+
+      if Gem::Requirement.new(">= 5.2.0.rc1") =~ Rails.gem_version
+        ActiveRecord::MigrationContext.new(path).migrate
+      else
+        ActiveRecord::Migrator.migrate(path)
+      end
+    end
+  end
+
+  class MongoidBackend
+    def load!
+      require 'mongoid'
+      require 'devise/orm/mongoid'
+      require 'rails_app_mongoid/config/environment'
+      require 'database_cleaner'
+    end
+
+    def setup_database_cleaner
+      DatabaseCleaner[:mongoid].strategy = :truncation
+    end
+
+    def migrate!
+      # Not necessary
+    end
+  end
+end

data/spec/support/warningless_get.rb

@@ -1,5 +1,5 @@
 def warningless_get(path, headers:)
-  if Rails::VERSION::MAJOR >= 5
+  if Gem::Requirement.new(">= 5") =~ Rails.gem_version
     get path, headers: headers
   else
     get path, {}, headers

data/spec/tiddle_spec.rb

@@ -23,7 +23,7 @@ describe Tiddle do
 
     it "sets last_used_at field" do
       Tiddle.create_and_return_token(@user, FakeRequest.new)
-      expect(@user.authentication_tokens.last.last_used_at)
+      expect(@user.authentication_tokens.last.last_used_at.to_time)
         .to be_within(1).of(Time.current)
     end
 

data/tiddle.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.2.0'
+  spec.required_ruby_version = '>= 2.3.0'
 
   spec.add_dependency "devise", ">= 4.0.0.rc1", "< 4.5"
   spec.add_dependency "activerecord", ">= 4.2.0"
@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "database_cleaner"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiddle
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Adam Niedzielski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2018-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -156,6 +156,20 @@ dependencies:
     - - ">="
       - !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: 
 email:
 - adamsunday@gmail.com
@@ -186,20 +200,33 @@ files:
 - lib/tiddle/strategy.rb
 - lib/tiddle/token_issuer.rb
 - lib/tiddle/version.rb
-- spec/rails_app/app/controllers/application_controller.rb
-- spec/rails_app/app/controllers/long_secrets_controller.rb
-- spec/rails_app/app/controllers/secrets_controller.rb
-- spec/rails_app/app/models/admin_user.rb
-- spec/rails_app/app/models/authentication_token.rb
-- spec/rails_app/app/models/user.rb
-- spec/rails_app/config/application.rb
-- spec/rails_app/config/boot.rb
-- spec/rails_app/config/environment.rb
-- spec/rails_app/config/routes.rb
-- spec/rails_app/config/secrets.yml
-- spec/rails_app/db/migrate/20150217000000_create_tables.rb
+- spec/rails_app_active_record/app/controllers/application_controller.rb
+- spec/rails_app_active_record/app/controllers/long_secrets_controller.rb
+- spec/rails_app_active_record/app/controllers/secrets_controller.rb
+- spec/rails_app_active_record/app/models/admin_user.rb
+- spec/rails_app_active_record/app/models/authentication_token.rb
+- spec/rails_app_active_record/app/models/user.rb
+- spec/rails_app_active_record/config/application.rb
+- spec/rails_app_active_record/config/boot.rb
+- spec/rails_app_active_record/config/environment.rb
+- spec/rails_app_active_record/config/routes.rb
+- spec/rails_app_active_record/config/secrets.yml
+- spec/rails_app_active_record/db/migrate/20150217000000_create_tables.rb
+- spec/rails_app_mongoid/app/controllers/application_controller.rb
+- spec/rails_app_mongoid/app/controllers/long_secrets_controller.rb
+- spec/rails_app_mongoid/app/controllers/secrets_controller.rb
+- spec/rails_app_mongoid/app/models/admin_user.rb
+- spec/rails_app_mongoid/app/models/authentication_token.rb
+- spec/rails_app_mongoid/app/models/user.rb
+- spec/rails_app_mongoid/config/application.rb
+- spec/rails_app_mongoid/config/boot.rb
+- spec/rails_app_mongoid/config/environment.rb
+- spec/rails_app_mongoid/config/mongoid.yml
+- spec/rails_app_mongoid/config/routes.rb
+- spec/rails_app_mongoid/config/secrets.yml
 - spec/spec_helper.rb
 - spec/strategy_spec.rb
+- spec/support/backend.rb
 - spec/support/fake_request.rb
 - spec/support/warningless_get.rb
 - spec/tiddle_spec.rb
@@ -216,7 +243,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -229,20 +256,33 @@ signing_key:
 specification_version: 4
 summary: Token authentication for Devise which supports multiple tokens per model
 test_files:
-- spec/rails_app/app/controllers/application_controller.rb
-- spec/rails_app/app/controllers/long_secrets_controller.rb
-- spec/rails_app/app/controllers/secrets_controller.rb
-- spec/rails_app/app/models/admin_user.rb
-- spec/rails_app/app/models/authentication_token.rb
-- spec/rails_app/app/models/user.rb
-- spec/rails_app/config/application.rb
-- spec/rails_app/config/boot.rb
-- spec/rails_app/config/environment.rb
-- spec/rails_app/config/routes.rb
-- spec/rails_app/config/secrets.yml
-- spec/rails_app/db/migrate/20150217000000_create_tables.rb
+- spec/rails_app_active_record/app/controllers/application_controller.rb
+- spec/rails_app_active_record/app/controllers/long_secrets_controller.rb
+- spec/rails_app_active_record/app/controllers/secrets_controller.rb
+- spec/rails_app_active_record/app/models/admin_user.rb
+- spec/rails_app_active_record/app/models/authentication_token.rb
+- spec/rails_app_active_record/app/models/user.rb
+- spec/rails_app_active_record/config/application.rb
+- spec/rails_app_active_record/config/boot.rb
+- spec/rails_app_active_record/config/environment.rb
+- spec/rails_app_active_record/config/routes.rb
+- spec/rails_app_active_record/config/secrets.yml
+- spec/rails_app_active_record/db/migrate/20150217000000_create_tables.rb
+- spec/rails_app_mongoid/app/controllers/application_controller.rb
+- spec/rails_app_mongoid/app/controllers/long_secrets_controller.rb
+- spec/rails_app_mongoid/app/controllers/secrets_controller.rb
+- spec/rails_app_mongoid/app/models/admin_user.rb
+- spec/rails_app_mongoid/app/models/authentication_token.rb
+- spec/rails_app_mongoid/app/models/user.rb
+- spec/rails_app_mongoid/config/application.rb
+- spec/rails_app_mongoid/config/boot.rb
+- spec/rails_app_mongoid/config/environment.rb
+- spec/rails_app_mongoid/config/mongoid.yml
+- spec/rails_app_mongoid/config/routes.rb
+- spec/rails_app_mongoid/config/secrets.yml
 - spec/spec_helper.rb
 - spec/strategy_spec.rb
+- spec/support/backend.rb
 - spec/support/fake_request.rb
 - spec/support/warningless_get.rb
 - spec/tiddle_spec.rb