faraday-jwt 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d387f8e950b87fc7e98e7fc6b2f2ce049a299364bbfcd3f02ce2827f60928ac
-  data.tar.gz: b7c83196801124dc3f1c0ef985d921b642cd726ec0e3a72ce49d1a0621d2f62d
+  metadata.gz: 10706b798dca52baafed6fa07367d18101f394c6514f5efa4ba61e0445258ddc
+  data.tar.gz: 4af304d1ef1455d323a26df2213b634254e59abe9606bb04fcf99525dd33d649
 SHA512:
-  metadata.gz: 91f19a69285f8311699e64eb98c1bdf647d525640b629f659243d75a12c6076c4b7d97ac547fdd474556901d73c4ea95021d2ba5d6eac331ef1727b6fbc69dc5
-  data.tar.gz: 0353ef061b50283180e8dd9c63728829fe28ea5bfb6562cd0b3a0f85e8657e64aaf454c9c32e262dfdbcb9ba0fcf88c555eb55e70e4e1afc1bd3f3bb213ee112
+  metadata.gz: c6a0c14376301d8a3d6f07f591b4aa57b230a871041b318e8ae9be803e0e5b3dae6b9ce4a8297af057173fabecbe65e819651dc18f62307edbe4258b32c9f145
+  data.tar.gz: 5049412c9a8fe61c1a047aacd76c68891d8cadd1c1e84aed95fbf930465d1e9408ccb46d5e3b258645bcd68896e288f7c2e8afece2fdc50fbdb25e90938d784c

data/README.md

@@ -1,4 +1,4 @@
-# Faraday::Jwt
+# Faraday::JWT
 
 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/faraday/jwt`. To experiment with that code, run `bin/console` for an interactive prompt.
 
@@ -16,7 +16,50 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+### Request
+
+```ruby
+conn = Faraday.new(...) do |f|
+  f.request :jwt
+  ...
+end
+
+conn.post('/', { foo: :bar })
+# POST with
+# Content-Type: application/jwt
+# Body: eyJ0eXAiOiJKV1QiLCJhbGciOiJub25lIn0.eyJmb28iOiJiYXIifQ.
+```
+
+or optionally signing
+
+```ruby
+conn = Faraday.new(...) do |f|
+  f.request :jwt, signing_key: private_key
+  ...
+end
+```
+
+### Response
+
+```ruby
+conn = Faraday.new(...) do |f|
+  f.response :jwt
+  ...
+end
+
+res = conn.get('jwt')
+res.body
+# => JSON::JWT instance
+```
+
+or optionally verifying
+
+```ruby
+conn = Faraday.new(...) do |f|
+  f.response :jwt, verification_key: public_key
+  ...
+end
+```
 
 ## Development
 
@@ -34,4 +77,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Faraday::Jwt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/faraday-jwt/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Faraday::JWT project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/faraday-jwt/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,8 +1,20 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
+namespace :coverage do
+  desc "Open coverage report"
+  task :report do
+    require 'simplecov'
+    `open "#{File.join SimpleCov.coverage_path, 'index.html'}"`
+  end
+end
+
+task :spec do
+  Rake::Task[:'coverage:report'].invoke unless ENV['GITHUB_ACTIONS']
+end
+
 task default: :spec

data/faraday-jwt.gemspec

@@ -4,7 +4,7 @@ require_relative 'lib/faraday/jwt/version'
 
 Gem::Specification.new do |spec|
   spec.name = 'faraday-jwt'
-  spec.version = Faraday::Jwt::VERSION
+  spec.version = Faraday::JWT::VERSION
   spec.authors = ['nov']
   spec.email = ['nov@matake.jp']
 
@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'faraday', '~> 2.0'
+  spec.add_dependency 'json-jwt', '~> 1.16'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'simplecov'

data/lib/faraday/jwt/request.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faraday
+  module JWT
+    class Request < Middleware
+      def initialize(app = nil, signing_key: nil, signing_alg: :autodetect, content_type: 'application/jwt')
+        super app
+        @signing_key = signing_key
+        @signing_alg = signing_alg
+        @content_types = Array(content_type)
+      end
+
+      def on_request(env)
+        encode_body!(env) if encodable_content?(env)
+      end
+
+      private
+
+      def encode_body!(env)
+        jwt = JSON::JWT.new env[:body]
+        env[:body] = if @signing_key.present?
+          jwt.sign @signing_key, @signing_alg
+        else
+          jwt
+        end.to_s
+      end
+
+      def encodable_content?(env)
+        !env[:body].respond_to?(:to_str) &&
+        encodable_content_type?(env[:request_headers])
+      end
+
+      def encodable_content_type?(headers)
+        @content_types.any? do |content_type|
+          content_type_of(headers) == content_type
+        end
+      end
+
+      def content_type_of(headers)
+        type = headers[CONTENT_TYPE].to_s
+        type = type.split(';', 2).first if type.index(';')
+        type
+      end
+    end
+  end
+end
+
+Faraday::Request.register_middleware(jwt: Faraday::JWT::Request)

data/lib/faraday/jwt/response.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Faraday
+  module JWT
+    class Response < Middleware
+      def initialize(app = nil, verification_key: :skip_verification, signing_algs: nil, content_type: 'application/jwt')
+        super app
+        @verification_key = verification_key
+        @signing_algs = signing_algs
+        @content_types = Array(content_type)
+      end
+
+      def on_complete(env)
+        decode_body!(env) if decodable_content?(env)
+      end
+
+      private
+
+      def decode_body!(env)
+        env[:raw_body] = env[:body]
+        env[:body] = JSON::JWT.decode(env[:body], @verification_key, @signing_algs)
+      rescue => e
+        raise Faraday::ParsingError.new(e, env[:response])
+      end
+
+      def decodable_content?(env)
+        env[:body].respond_to?(:to_str) && !env[:body].strip.empty? &&
+        decodable_content_type?(env[:response_headers])
+      end
+
+      def decodable_content_type?(headers)
+        @content_types.any? do |content_type|
+          content_type_of(headers) == content_type
+        end
+      end
+
+      def content_type_of(headers)
+        type = headers[CONTENT_TYPE].to_s
+        type = type.split(';', 2).first if type.index(';')
+        type
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware(jwt: Faraday::JWT::Response)

data/lib/faraday/jwt/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Faraday
-  module Jwt
-    VERSION = '0.0.0'
+  module JWT
+    VERSION = '0.1.0'
   end
 end

data/lib/faraday/jwt.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require 'faraday'
+require 'json/jwt'
 require_relative 'jwt/version'
+require_relative 'jwt/request'
+require_relative 'jwt/response'
 
 module Faraday
-  module Jwt
-    class Error < StandardError; end
-    # Your code goes here...
+  module JWT
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-jwt
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - nov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-10 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json-jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +95,8 @@ files:
 - Rakefile
 - faraday-jwt.gemspec
 - lib/faraday/jwt.rb
+- lib/faraday/jwt/request.rb
+- lib/faraday/jwt/response.rb
 - lib/faraday/jwt/version.rb
 homepage: https://github.com/nov/faraday-jwt
 licenses: