challah-jwt 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d0e70a00bf7f163dcc79d200a28b5848f1bbb78
-  data.tar.gz: ef354f85f0201bd2b5159f772fe6beb3d3022549
+  metadata.gz: 7c3fcba21e9b182c4522ceef036a576dc980409d
+  data.tar.gz: ae4e5f372f24f542bf9c1018461395e7af1e7347
 SHA512:
-  metadata.gz: 822500c6516ae7b2f909a423daaab1471afeb27adbf7e5c8d5ccc609c0987478a5e47987394e5696009f6bf50db8e3fd1d43f99f2fca14f1de7e839facd02472
-  data.tar.gz: 9911d5cb1aa541dae8ee9bd4daaa381efabcc5274b08987efcc37386498b7be465d9b60d31446cb5033ba9cc2253e4bf8834eae3c53b451036453467aee83145
+  metadata.gz: 9cc59e0ab65029e3e5534453ff9b307915195d220817e9dd83da0bd6dfced1087aeaefab55562a0ae19b4f2bbd9a50bf88f5248d33483bba51ae93d0fdb9e4a1
+  data.tar.gz: '0379a709decc5837e6b5188f2a67222b4bba2e0782aa13027707bc23162d97b25b97481c6558a6b9e0a87565f8aa9b2835b23ba2d19bad96ae4b4eda97d28d67'

data/README.md

@@ -47,6 +47,34 @@ GET /
 Authorization: Bearer adi8e98uie.saxbbbgudinocgeigc84y9834.8ui9odeion
 ```
 
+### Tokenizer
+
+Challah-JWT adds a few methods to your User model that make it easy to tokenize and look up users:
+
+```ruby
+user = User.first
+# => #<User id=1...>
+
+# Convert the user to a JWT
+jwt = user.to_jwt
+
+# Look up user by JWT
+user = User.find_by_jwt(jwt)
+```
+
+The tokenizer only includes the user's ID in the payload by deafult, to override this behavior, override the `jwt_attrs` method in your user model:
+
+```ruby
+class User < ApplicationRecord
+  include Challah::Jwt::Tokenizer
+  
+  def jwt_attrs
+    # make sure you include id, otherwise the lookup will fail
+    serializable_hash.slice("id", "email", "status")
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can

data/lib/challah/jwt/configuration.rb

@@ -0,0 +1,23 @@
+module Challah
+  module Jwt
+    class Configuration
+      attr_accessor :use_api_key
+
+      def initialize(options = {})
+        @use_api_key = options.fetch(:use_api_key, false)
+      end
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configuration=(config)
+      @configuration = config
+    end
+
+    def self.configure(&block)
+      yield(configuration)
+    end
+  end
+end

data/lib/challah/jwt/tokenizer.rb

@@ -8,8 +8,14 @@ module Challah
       class_methods do
         def find_by_jwt(token)
           payload = ::JWT.decode(token, Challah::Jwt.secret_key)
-          model_id = payload.dig(0, jwt_root, "id")
-          find(model_id)
+          id = payload.dig(0, jwt_root, "id")
+
+          if Challah::Jwt.configuration.use_api_key
+            api_key = payload.dig(0, jwt_root, "api_key")
+            find_by(id: id, api_key: api_key)
+          else
+            find_by(id: id)
+          end
         rescue JWT::DecodeError
           nil
         end
@@ -24,7 +30,11 @@ module Challah
       end
 
       def jwt_attrs
-        serializable_hash.slice("id")
+        if Challah::Jwt.configuration.use_api_key
+          serializable_hash.slice("id", "api_key")
+        else
+          serializable_hash.slice("id")
+        end
       end
 
       def jwt_payload

data/lib/challah/jwt/version.rb

@@ -1,5 +1,5 @@
 module Challah
   module Jwt
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/challah/jwt.rb

@@ -1,6 +1,7 @@
 require "challah"
 require "jwt"
 
+require "challah/jwt/configuration"
 require "challah/jwt/technique"
 require "challah/jwt/tokenizer"
 require "challah/jwt/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: challah-jwt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Phillip Ridlen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2016-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: challah
@@ -82,6 +82,7 @@ files:
 - challah-jwt.gemspec
 - lib/challah-jwt.rb
 - lib/challah/jwt.rb
+- lib/challah/jwt/configuration.rb
 - lib/challah/jwt/technique.rb
 - lib/challah/jwt/tokenizer.rb
 - lib/challah/jwt/version.rb