firebase-auth-id_token_keeper 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9788905a37d9079fe4b06072e7971256b3fb3a755bf93d4865daa57c9331929b
-  data.tar.gz: 421a110d3a665a3e7a714a04a120de4e99cb2689a50d88bc6ee5c37c66ab43dd
+  metadata.gz: 3b54959ace13bc7c20d267f3479311115a1c8b79c1d98d07de5486da0f3e1329
+  data.tar.gz: a6d1ee1877bb6db27f8093efa0a94f1dfccf90954a071ea3cbf58a625e241128
 SHA512:
-  metadata.gz: 1f9b82094cd0ecd478cebb6df0ff995d2fb79e7d2b7a97e5e4ada740da56cbcf412d30826b544a96447321e508b9aa88d941c7ce9b96803dcabb3e39477c6182
-  data.tar.gz: c6ab11dbafbcb958945f402b65dbe6608b2c069772527b6f975033c6fababffb5c73ea089a54599e067e17e8aa5edc7de36295e43d420b2e837383cd861217a5
+  metadata.gz: e5c1024769e1fae108c4c0f0610342b867ae9a8c8e878a469ed18a6e91e3c3843fa2f4033c2406c58980ef8bf527bd3ade3287ac14a1462c0ade5e25cf5b1c46
+  data.tar.gz: 5e04d018ea3fe0fbd120b45df7de1abac4f068dca8b5bea0125d14ead395e9b8650861edcb2ecc06c926a36a0620240aba1fdc151d2ef1f23e138cdb9bac8be4

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -1,8 +1,89 @@
 # Firebase::Auth::IDTokenKeeper
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/firebase/auth/id_token_keeper`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Errors
 
-TODO: Delete this and the text above, and describe your gem
+### Response body
+
+```json
+{
+  "error": "<message>"
+}
+```
+
+### Type
+
+- `JWT::ExpiredSignature`
+    - code: 401
+    - message: "Signature has expired."
+    - You should refresh your token on the client side.
+- `JWT::DecodeError`
+    - code: 401
+    - message: "Invalid JWT format."
+    - You should send JWT with valid format.
+
+
+## Test
+
+We provide test id token generate method.
+
+It can use like this.
+
+```ruby
+decoded_jwt = {
+  "iss"=>"https://example.com/project-id",
+  "name"=>"Test Example",
+  "picture"=>"https://example.com",
+  "aud"=>"project-id",
+  "auth_time"=>1535353624,
+  "user_id"=>"badcd9971aa1ba6a46bf3379db78",
+  "sub"=>"teyOh0wMQyZQboYCW18wammaFkH2",
+  "iat"=>1535353624,
+  "exp"=>1535357224,
+  "email"=>"test.example@example.com",
+  "email_verified"=>false,
+  "firebase"=>{"identities"=>{"github.com"=>["xxxxxx"], "email"=>["test.example@example.com"]}, "sign_in_provider"=>"github.com"}
+}
+
+encoded_jwt = Firebase::Auth::IDTokenKeeper::Testing.generate_test_id_token(decoded_jwt)
+# => "eyJ0eXAiOiJKV1QiLCJhbGciOiJub25lIn0.eyJpc3MiOiJodHRwczovL2V4YW1wbGUuY29tL3Byb2plY3QtaWQiLCJuYW1lIjoiVGVzdCBFeGFtcGxlIiwicGljdHVyZSI6Imh0dHBzOi8vZXhhbXBsZS5jb20iLCJhdWQiOiJwcm9qZWN0LWlkIiwiYXV0aF90aW1lIjoxNTM1MzUzNjI0LCJ1c2VyX2lkIjoiYmFkY2Q5OTcxYWExYmE2YTQ2YmYzMzc5ZGI3OCIsInN1YiI6InRleU9oMHdNUXlaUWJvWUNXMTh3YW1tYUZrSDIiLCJpYXQiOjE1MzUzNTM2MjQsImV4cCI6MTUzNTM1NzIyNCwiZW1haWwiOiJ0ZXN0LmV4YW1wbGVAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6ZmFsc2UsImZpcmViYXNlIjp7ImlkZW50aXRpZXMiOnsiZ2l0aHViLmNvbSI6WyJ4eHh4eHgiXSwiZW1haWwiOlsidGVzdC5leGFtcGxlQGV4YW1wbGUuY29tIl19LCJzaWduX2luX3Byb3ZpZGVyIjoiZ2l0aHViLmNvbSJ9fQ."
+
+Firebase::Auth::IDTokenKeeper::Testing.decode_test_id_token(encoded_jwt)
+# => {
+#      "iss"=>"https://example.com/project-id",
+#      "name"=>"Test Example",
+#      "picture"=>"https://example.com",
+#      "aud"=>"project-id",
+#      "auth_time"=>1535353624,
+#      "user_id"=>"badcd9971aa1ba6a46bf3379db78",
+#      "sub"=>"teyOh0wMQyZQboYCW18wammaFkH2",
+#      "iat"=>1535353624,
+#      "exp"=>1535357224,
+#      "email"=>"test.example@example.com",
+#      "email_verified"=>false,
+#      "firebase"=>{"identities"=>{"github.com"=>["xxxxxx"], "email"=>["test.example@example.com"]}, "sign_in_provider"=>"github.com"}
+#    }
+```
+
+### For RSpec
+
+Make a support file `spec/support/firebase_auth_id_token_keeper.rb` which contains following code.
+
+```ruby
+RSpec.configure do |config|
+  config.include Firebase::Auth::IDTokenKeeper::Test::Helpers, type: :request
+end
+```
+
+Load the support file in your `spec/rails_helper.rb`.
+
+```ruby
+...
+# Add additional requires below this line. Rails is not loaded until this point!
+require 'support/firebase_auth_id_token_keeper'
+...
+```
+
+Now, we can decode test ID Token which is generated via `Firebase::Auth::IDTokenKeeper::Testing.generate_test_id_token` method in `Firebase::Auth::IDTokenKeeper::IDToken#verified_id_token` method.
 
 ## Installation
 

data/lib/firebase/auth/id_token_keeper/id_token.rb

@@ -73,6 +73,8 @@ module Firebase
 
         def decoded_jwt
           @decoded_jwt ||= JWT.decode(encoded_jwt, nil, false, { algorithm: FIREBASE_ALGORITHM })
+        rescue JWT::DecodeError => e
+          raise 'Invalid JWT format.'
         end
 
         def jwt_header

data/lib/firebase/auth/id_token_keeper/testing.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Firebase
+  module Auth
+    module IDTokenKeeper
+      module Testing
+
+        def self.generate_test_id_token(decoded_jwt)
+          JWT.encode(decoded_jwt, nil, 'none')
+        end
+
+        def self.decode_test_id_token(encoded_jwt)
+          JWT.decode(encoded_jwt, nil, false)
+        end
+
+        module Helpers
+          extend ActiveSupport::Concern
+
+          ::Firebase::Auth::IDTokenKeeper::IDToken.class_eval do
+            def verified_id_token
+              ::Firebase::Auth::IDTokenKeeper::Testing.decode_test_id_token(encoded_jwt)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/firebase/auth/id_token_keeper/version.rb

@@ -1,7 +1,7 @@
 module Firebase
   module Auth
     module IDTokenKeeper
-      VERSION = '0.1.1'
+      VERSION = '0.2.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firebase-auth-id_token_keeper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Rui Onodera
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2018-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -88,6 +88,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -101,6 +102,7 @@ files:
 - lib/firebase/auth/id_token_keeper/config.rb
 - lib/firebase/auth/id_token_keeper/id_token.rb
 - lib/firebase/auth/id_token_keeper/public_keys_endpoint.rb
+- lib/firebase/auth/id_token_keeper/testing.rb
 - lib/firebase/auth/id_token_keeper/version.rb
 - lib/generators/firebase/auth/id_token_keeper/install_generator.rb
 - lib/generators/firebase/auth/id_token_keeper/templates/firebase_auth_id_token_keeper.rb