tiddle 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbff5c3f0edbfb99abd2f26f6d5df6abb065e814
-  data.tar.gz: bdc3e06b474d85e37250d7381cc29fcd182a4b68
+  metadata.gz: 6a327afb3806faebd6aa17722b4ddff876ac5fea
+  data.tar.gz: 0bed056d47ab99d9f71a950ae726dd4c2aaa3014
 SHA512:
-  metadata.gz: a507666669e952ab4267a1aa4da9848d50729ae64dc992ff1413ced2edd5ab1abdfc3283ff7eccb596512d958819a0ebe028563854dcab6cba0ef48e5e2d59a9
-  data.tar.gz: 470dc04acced63b0c4af4288721e0e9040b26dfffeac2f9830c8c364e5986714307b04612fbb37f64d321a668866145737f954b2811f56a6ff7d01724ce14e4a
+  metadata.gz: 73afe53b86797c78eb94df557e5ddd5471430d9aa29b57f5ed25abb086ff5d9d4794b18b5d203c26d0ed1056b505f8b4dab31c1c924111a2fc3e916eb24e932c
+  data.tar.gz: b70910abafa897356cb6b1e5035d9d2ced057e781e34412f98b224c867d78288e14fa2fc9f6de977fe7dcac660c0bbfeb767ea0914fdb1f1f89f9f368197990f

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  TargetRubyVersion: 2.3
   Include:
     - 'lib'
     - 'spec'
@@ -7,19 +8,11 @@ AllCops:
     - 'spec/spec_helper.rb'
 Style/StringLiterals:
   Enabled: false
-Style/EmptyLinesAroundBlockBody:
-  Enabled: false
-Style/BracesAroundHashParameters:
-  EnforcedStyle: context_dependent
 Style/Documentation:
   Enabled: false
-Style/EmptyLinesAroundClassBody:
-  Enabled: false
-Style/IndentationConsistency:
+Style/FrozenStringLiteralComment:
   Enabled: false
-Style/EmptyLinesAroundModuleBody:
+Style/SignalException:
   Enabled: false
-Style/MultilineOperationIndentation:
-  EnforcedStyle: indented
 Metrics/LineLength:
   Max: 100

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 1.0.0
+
+No major changes - just a stable version release.
+
 ### 0.7.0
 
 Adds support for Rails 5. Requires Devise 4.

data/lib/tiddle.rb

@@ -5,7 +5,6 @@ require "tiddle/rails"
 require "tiddle/token_issuer"
 
 module Tiddle
-
   def self.create_and_return_token(resource, request)
     TokenIssuer.build.create_and_return_token(resource, request)
   end

data/lib/tiddle/model_name.rb

@@ -1,6 +1,5 @@
 module Tiddle
   class ModelName
-
     def with_underscores(model)
       model.model_name.to_s.underscore.upcase
     end

data/lib/tiddle/strategy.rb

@@ -5,7 +5,6 @@ require 'tiddle/token_issuer'
 module Devise
   module Strategies
     class TokenAuthenticatable < Authenticatable
-
       def authenticate!
         env["devise.skip_trackable"] = true
 
@@ -31,27 +30,27 @@ module Devise
 
       private
 
-        def authentication_keys_from_headers
-          authentication_keys.map do |key|
-            { key => env["HTTP_X_#{model_name}_#{key.upcase}"] }
-          end.reduce(:merge)
-        end
+      def authentication_keys_from_headers
+        authentication_keys.map do |key|
+          { key => env["HTTP_X_#{model_name}_#{key.upcase}"] }
+        end.reduce(:merge)
+      end
 
-        def token_from_headers
-          env["HTTP_X_#{model_name}_TOKEN"]
-        end
+      def token_from_headers
+        env["HTTP_X_#{model_name}_TOKEN"]
+      end
 
-        def model_name
-          Tiddle::ModelName.new.with_underscores(mapping.to)
-        end
+      def model_name
+        Tiddle::ModelName.new.with_underscores(mapping.to)
+      end
 
-        def authentication_keys
-          mapping.to.authentication_keys
-        end
+      def authentication_keys
+        mapping.to.authentication_keys
+      end
 
-        def touch_token(token)
-          token.update_attribute(:last_used_at, DateTime.current) if token.last_used_at < 1.hour.ago
-        end
+      def touch_token(token)
+        token.update_attribute(:last_used_at, DateTime.current) if token.last_used_at < 1.hour.ago
+      end
     end
   end
 end

data/lib/tiddle/token_issuer.rb

@@ -17,10 +17,10 @@ module Tiddle
       token, token_body = Devise.token_generator.generate(token_class, :body)
 
       resource.authentication_tokens
-        .create! body: token_body,
-                 last_used_at: DateTime.current,
-                 ip_address: request.remote_ip,
-                 user_agent: request.user_agent
+              .create! body: token_body,
+                       last_used_at: DateTime.current,
+                       ip_address: request.remote_ip,
+                       user_agent: request.user_agent
 
       token
     end
@@ -40,17 +40,17 @@ module Tiddle
 
     def purge_old_tokens(resource)
       resource.authentication_tokens
-        .order(last_used_at: :desc)
-        .offset(maximum_tokens_per_user)
-        .destroy_all
+              .order(last_used_at: :desc)
+              .offset(maximum_tokens_per_user)
+              .destroy_all
     end
 
     private
 
-      attr_accessor :maximum_tokens_per_user
+    attr_accessor :maximum_tokens_per_user
 
-      def authentication_token_class(resource)
-        resource.association(:authentication_tokens).klass
-      end
+    def authentication_token_class(resource)
+      resource.association(:authentication_tokens).klass
+    end
   end
 end

data/lib/tiddle/version.rb

@@ -1,3 +1,3 @@
 module Tiddle
-  VERSION = "0.7.0"
+  VERSION = "1.0.0".freeze
 end

data/spec/strategy_spec.rb

@@ -1,112 +1,136 @@
 describe "Authentication using Tiddle strategy", type: :request do
-
   context "with valid email and token" do
-
     before do
       @user = User.create!(email: "test@example.com", password: "12345678")
       @token = Tiddle.create_and_return_token(@user, FakeRequest.new)
     end
 
     it "allows to access endpoints which require authentication" do
-      get secrets_path, {},
-          { "X-USER-EMAIL" => "test@example.com", "X-USER-TOKEN" => @token }
+      warningless_get(
+        secrets_path,
+        headers: {
+          "X-USER-EMAIL" => "test@example.com",
+          "X-USER-TOKEN" => @token
+        }
+      )
       expect(response.status).to eq 200
     end
 
     describe "touching token" do
-
       context "when token was last used more than hour ago" do
-
         before do
           @user.authentication_tokens.last
-            .update_attribute(:last_used_at, 2.hours.ago)
+               .update_attribute(:last_used_at, 2.hours.ago)
         end
 
         it "updates last_used_at field" do
           expect do
-            get secrets_path, {},
-                { "X-USER-EMAIL" => "test@example.com", "X-USER-TOKEN" => @token }
+            warningless_get(
+              secrets_path,
+              headers: {
+                "X-USER-EMAIL" => "test@example.com",
+                "X-USER-TOKEN" => @token
+              }
+            )
           end.to change { @user.authentication_tokens.last.last_used_at }
         end
       end
 
       context "when token was last used less than hour ago" do
-
         before do
           @user.authentication_tokens.last.update_attribute(:last_used_at, 30.minutes.ago)
         end
 
         it "does not update last_used_at field" do
           expect do
-            get secrets_path, {},
-                { "X-USER-EMAIL" => "test@example.com", "X-USER-TOKEN" => @token }
+            warningless_get(
+              secrets_path,
+              headers: {
+                "X-USER-EMAIL" => "test@example.com",
+                "X-USER-TOKEN" => @token
+              }
+            )
           end.not_to change { @user.authentication_tokens.last.last_used_at }
         end
       end
     end
 
     context "when email contains uppercase letters" do
-
       it "converts email to lower case and authenticates user" do
-        get secrets_path, {},
-            { "X-USER-EMAIL" => "TEST@example.com", "X-USER-TOKEN" => @token }
+        warningless_get(
+          secrets_path,
+          headers: {
+            "X-USER-EMAIL" => "TEST@example.com",
+            "X-USER-TOKEN" => @token
+          }
+        )
         expect(response.status).to eq 200
       end
     end
   end
 
   context "with invalid email and valid token" do
-
     before do
       @user = User.create!(email: "test@example.com", password: "12345678")
       @token = Tiddle.create_and_return_token(@user, FakeRequest.new)
     end
 
     it "does not allow to access endpoints which require authentication" do
-      get secrets_path, {},
-          { "X-USER-EMAIL" => "wrong@example.com", "X-USER-TOKEN" => @token }
+      warningless_get(
+        secrets_path,
+        headers: {
+          "X-USER-EMAIL" => "wrong@example.com",
+          "X-USER-TOKEN" => @token
+        }
+      )
       expect(response.status).to eq 401
     end
   end
 
   context "with valid email and invalid token" do
-
     before do
       @user = User.create!(email: "test@example.com", password: "12345678")
       @token = Tiddle.create_and_return_token(@user, FakeRequest.new)
     end
 
     it "does not allow to access endpoints which require authentication" do
-      get secrets_path, {},
-          { "X-USER-EMAIL" => "test@example.com", "X-USER-TOKEN" => "wrong" }
+      warningless_get(
+        secrets_path,
+        headers: {
+          "X-USER-EMAIL" => "test@example.com",
+          "X-USER-TOKEN" => "wrong"
+        }
+      )
       expect(response.status).to eq 401
     end
   end
 
   context "when no headers are passed" do
-
     it "does not allow to access endpoints which require authentication" do
-      get secrets_path, {}, {}
+      warningless_get secrets_path, headers: {}
       expect(response.status).to eq 401
     end
   end
 
   context "when model name consists of two words" do
-
     before do
       @admin_user = AdminUser.create!(email: "test@example.com", password: "12345678")
       @token = Tiddle.create_and_return_token(@admin_user, FakeRequest.new)
     end
 
     it "allows to access endpoints which require authentication" do
-      get long_secrets_path, {},
-          { "X-ADMIN-USER-EMAIL" => "test@example.com", "X-ADMIN-USER-TOKEN" => @token }
+      warningless_get(
+        long_secrets_path,
+        headers: {
+          "X-ADMIN-USER-EMAIL" => "test@example.com",
+          "X-ADMIN-USER-TOKEN" => @token
+        }
+      )
       expect(response.status).to eq 200
     end
   end
 
   describe "using field other than email" do
-
     before do
       Devise.setup do |config|
         config.authentication_keys = [:nick_name]
@@ -128,8 +152,10 @@ describe "Authentication using Tiddle strategy", type: :request do
 
     it "allows to access endpoints which require authentication with valid \
       nick name and token" do
-      get secrets_path, {},
-          { "X-USER-NICK-NAME" => "test", "X-USER-TOKEN" => @token }
+      warningless_get(
+        secrets_path,
+        headers: { "X-USER-NICK-NAME" => "test", "X-USER-TOKEN" => @token }
+      )
       expect(response.status).to eq 200
     end
   end

data/spec/support/fake_request.rb

@@ -1,5 +1,4 @@
 class FakeRequest
-
   def initialize(
     remote_ip: "23.12.54.111",
     user_agent: "I am not a bot",

data/spec/support/warningless_get.rb

@@ -0,0 +1,7 @@
+def warningless_get(path, headers:)
+  if Rails::VERSION::MAJOR >= 5
+    get path, headers: headers
+  else
+    get path, {}, headers
+  end
+end

data/spec/tiddle_spec.rb

@@ -1,7 +1,5 @@
 describe Tiddle do
-
   describe "create_and_return_token" do
-
     before do
       @user = User.create!(email: "test@example.com", password: "12345678")
     end
@@ -43,7 +41,6 @@ describe Tiddle do
   end
 
   describe "find_token" do
-
     before do
       @admin_user = AdminUser.create!(email: "test@example.com", password: "12345678")
       @token = Tiddle.create_and_return_token(@admin_user, FakeRequest.new)
@@ -62,7 +59,6 @@ describe Tiddle do
   end
 
   describe "expire_token" do
-
     before do
       @admin_user = AdminUser.create!(email: "test@example.com", password: "12345678")
       token = Tiddle.create_and_return_token(@admin_user, FakeRequest.new)
@@ -77,7 +73,6 @@ describe Tiddle do
   end
 
   describe "purge_old_tokens" do
-
     before do
       @user = User.create!(email: "test@example.com", password: "12345678")
       Tiddle.create_and_return_token(@user, FakeRequest.new)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiddle
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Adam Niedzielski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2016-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -199,6 +199,7 @@ files:
 - spec/spec_helper.rb
 - spec/strategy_spec.rb
 - spec/support/fake_request.rb
+- spec/support/warningless_get.rb
 - spec/tiddle_spec.rb
 - tiddle.gemspec
 homepage: ''
@@ -241,4 +242,5 @@ test_files:
 - spec/spec_helper.rb
 - spec/strategy_spec.rb
 - spec/support/fake_request.rb
+- spec/support/warningless_get.rb
 - spec/tiddle_spec.rb