truelayer-signing 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f61552b78e6c1d17312bf90a73802f4c904ca3b673aaf17ac12fe46119055f3e
-  data.tar.gz: c4d2c95f57008b3c127064861a429da56cea91b666d277b8504aea8e4fb8508b
+  metadata.gz: 8cc4b5beb4b79ccfafd7350d4882927d45abea2580d4d4d869d39faae157498d
+  data.tar.gz: ab43241ee2475b2797ff43fc5c142b778ff4e4ef28d042a123b9ac8179d913aa
 SHA512:
-  metadata.gz: 9c9ea1c63adc5268afa8c784bf7deef7ee1d54c00c2467b014340c6c166e92a57ef3e8e5c534953fb2533edf519155adc4a9f005d18e34a08340a876acb39af2
-  data.tar.gz: 9b523032ac94b35fd8d38370d10662951b68204d2b3e30caebdcbe64c9134bf7773a712c992d28c8b8a2ed63d7e449ff2141f636d23cd1704c95419275b12615
+  metadata.gz: 6e208e6b3ed16190946cdeceae856ebcddc42b472458b86c527e0dfe52a67fe0d33e954c018f63fcb8502b659081aa35522516f9dacfb12f492b36a7830fe6b6
+  data.tar.gz: 3282b084e0907c8c709dfa2f3d2bef71527bca7181c342a24de63262c70ffa3a9e41f4437eb77f667a1e9c6a45776b8db6549ce709b244128b5fb58006b4afea

data/CHANGELOG.md

@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - ...
 
+## [0.1.2] – 2023-05-19
+
+- Fix conflict with JWT library
+
 ## [0.1.1] – 2023-05-17
 
 - Fix webhook server example

data/examples/sign-request/Gemfile.lock

@@ -23,7 +23,7 @@ GEM
       rake (~> 13.0)
     public_suffix (5.0.1)
     rake (13.0.6)
-    truelayer-signing (0.2.0)
+    truelayer-signing (0.1.2)
       jwt (= 2.6)
     unf (0.1.4)
       unf_ext
@@ -31,11 +31,10 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
-  ruby
 
 DEPENDENCIES
   http
   truelayer-signing
 
 BUNDLED WITH
-   2.4.1
+   2.4.13

data/lib/truelayer-signing/jwt.rb

@@ -2,14 +2,16 @@
 # It prevents the payload from being systematically converted to and from JSON.
 # To be changed in the 'jwt' gem directly, or hard-coded in this library.
 module JWT
-  class Encode
+  module_function
+
+  class TrueLayerEncode < Encode
     # See https://github.com/jwt/ruby-jwt/blob/main/lib/jwt/encode.rb#L53-L55
     private def encode_payload
       ::JWT::Base64.url_encode(@payload)
     end
   end
 
-  class Decode
+  class TrueLayerDecode < Decode
     # See https://github.com/jwt/ruby-jwt/blob/main/lib/jwt/decode.rb#L154-L156
     private def payload
       @payload ||= ::JWT::Base64.url_decode(@segments[1])
@@ -17,4 +19,23 @@ module JWT
       raise JWT::DecodeError, 'Invalid segment encoding'
     end
   end
+
+  def truelayer_encode(payload, key, algorithm, headers)
+    TrueLayerEncode.new(
+      payload: payload,
+      key: key,
+      algorithm: algorithm,
+      headers: headers
+    ).segments
+  end
+
+  def truelayer_decode(jwt, key, verify, options, &keyfinder)
+    TrueLayerDecode.new(
+      jwt,
+      key,
+      verify,
+      configuration.decode.to_h.merge(options),
+      &keyfinder
+    ).decode_segments
+  end
 end

data/lib/truelayer-signing/signer.rb

@@ -9,7 +9,8 @@ module TrueLayerSigning
       jws_header_args = { tl_headers: headers }
       jws_header_args[:jku] = jws_jku if jws_jku
       jws_header = TrueLayerSigning::JwsHeader.new(jws_header_args).to_h
-      jwt = JWT.encode(build_signing_payload, private_key, TrueLayerSigning.algorithm, jws_header)
+      jwt = JWT.truelayer_encode(build_signing_payload, private_key, TrueLayerSigning.algorithm,
+        jws_header)
       header, _, signature = jwt.split(".")
 
       "#{header}..#{signature}"

data/lib/truelayer-signing/verifier.rb

@@ -27,7 +27,7 @@ module TrueLayerSigning
       jwt_options = { algorithm: TrueLayerSigning.algorithm }
 
       begin
-        JWT.decode(full_signature, public_key, true, jwt_options)
+        JWT.truelayer_decode(full_signature, public_key, true, jwt_options)
       rescue JWT::VerificationError
         @path = path.end_with?("/") && path[0...-1] || path + "/"
         payload_b64 = Base64.urlsafe_encode64(build_signing_payload(ordered_headers),
@@ -35,7 +35,7 @@ module TrueLayerSigning
         full_signature = [jws_header_b64, payload_b64, signature_b64].join(".")
 
         begin
-          JWT.decode(full_signature, public_key, true, jwt_options)
+          JWT.truelayer_decode(full_signature, public_key, true, jwt_options)
         rescue
           raise(Error, "Signature verification failed")
         end

data/test/test-truelayer-signing.rb

@@ -369,4 +369,58 @@ class TrueLayerSigningTest < Minitest::Test
     assert(result.first
       .start_with?("POST /merchant_accounts/a61acaef-ee05-4077-92f3-25543a11bd8d/sweeping\n"))
   end
+
+  # TODO: remove if/when we get rid of `lib/truelayer-signing/jwt.rb`
+  def test_jwt_encode_and_decode_should_succeed
+    payload_object = { currency: "GBP", max_amount_in_minor: 50_000_00 }
+    token_when_object = "eyJhbGciOiJIUzI1NiJ9.eyJjdXJyZW5jeSI6IkdCUCIsIm1heF9hbW" +
+      "91bnRfaW5fbWlub3IiOjUwMDAwMDB9.SjbwZCqTl6G7LQNs_M6oQhwl3a9rbqO7p3cVncLtgZY"
+    token_when_json = "eyJhbGciOiJIUzI1NiJ9.IntcImN1cnJlbmN5XCI6XCJHQlBcIixcIm1h" +
+      "eF9hbW91bnRfaW5fbWlub3JcIjo1MDAwMDAwfSI.rvCcgu-JevsNxbjUwJiFOuTd0hzVKvPK5RvGmaoDc7E"
+
+    # succeeds with a hash object
+    assert_equal(token_when_object, JWT.encode(payload_object, "12345", "HS256", {}))
+    assert_equal(
+      [{ "currency" => "GBP", "max_amount_in_minor" => 50_000_00 }, { "alg" => "HS256" }],
+      JWT.decode(token_when_object, "12345", true, algorithm: "HS256")
+    )
+
+    # succeeds with a JSON string
+    assert_equal(token_when_json, JWT.encode(payload_object.to_json, "12345", "HS256", {}))
+    assert_equal(
+      ["{\"currency\":\"GBP\",\"max_amount_in_minor\":5000000}", { "alg" => "HS256" }],
+      JWT.decode(token_when_json, "12345", true, algorithm: "HS256")
+    )
+  end
+
+  # TODO: remove if/when we get rid of `lib/truelayer-signing/jwt.rb`
+  def test_jwt_truelayer_encode_and_decode_when_given_json_should_succeed
+    payload_json = { currency: "GBP", max_amount_in_minor: 50_000_00 }.to_json
+    token_when_json = "eyJhbGciOiJIUzI1NiJ9.eyJjdXJyZW5jeSI6IkdCUCIsIm1heF9hbW9" +
+      "1bnRfaW5fbWlub3IiOjUwMDAwMDB9.SjbwZCqTl6G7LQNs_M6oQhwl3a9rbqO7p3cVncLtgZY"
+
+    assert_equal(token_when_json, JWT.truelayer_encode(payload_json, "12345", "HS256", {}))
+    assert_equal(
+      ["{\"currency\":\"GBP\",\"max_amount_in_minor\":5000000}", { "alg" => "HS256" }],
+      JWT.truelayer_decode(token_when_json, "12345", true, algorithm: "HS256")
+    )
+  end
+
+  # TODO: remove if/when we get rid of `lib/truelayer-signing/jwt.rb`
+  def test_jwt_truelayer_encode_when_given_a_hash_should_not_succeed
+    payload_object = { currency: "GBP", max_amount_in_minor: 50_000_00 }
+    error = assert_raises(TypeError) { JWT.truelayer_encode(payload_object, "12345", "HS256", {}) }
+    assert_equal("no implicit conversion of Hash into String", error.message)
+  end
+
+  # TODO: remove if/when we get rid of `lib/truelayer-signing/jwt.rb`
+  def test_jwt_truelayer_decode_when_given_a_hash_should_succeed
+    token_when_object = "eyJhbGciOiJIUzI1NiJ9.eyJjdXJyZW5jeSI6IkdCUCIsIm1heF9hbW" +
+      "91bnRfaW5fbWlub3IiOjUwMDAwMDB9.SjbwZCqTl6G7LQNs_M6oQhwl3a9rbqO7p3cVncLtgZY"
+
+    assert_equal(
+      ["{\"currency\":\"GBP\",\"max_amount_in_minor\":5000000}", { "alg" => "HS256" }],
+      JWT.truelayer_decode(token_when_object, "12345", true, algorithm: "HS256")
+    )
+  end
 end

data/truelayer-signing.gemspec

@@ -2,7 +2,7 @@ $LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
 
 Gem::Specification.new do |s|
   s.name = "truelayer-signing"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
   s.summary = "Ruby gem to produce and verify TrueLayer API requests signatures"
   s.description = "TrueLayer provides instant access to open banking to " \
     "easily integrate next-generation payments and financial data into any app." \

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: truelayer-signing
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Kevin Plattret
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-17 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt