truelayer-signing 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b85aabeca0591f5c775275d9b0b338583ca1d62483ed0f97be215b112cfefc68
-  data.tar.gz: 89c46174ff39b02a4353184f0dd4fc46c5ff8cc519386efba30fa7ef6e789a23
+  metadata.gz: 8cc4b5beb4b79ccfafd7350d4882927d45abea2580d4d4d869d39faae157498d
+  data.tar.gz: ab43241ee2475b2797ff43fc5c142b778ff4e4ef28d042a123b9ac8179d913aa
 SHA512:
-  metadata.gz: f79271f810bc3638a73743489a689cf8dc31f886588450815124e4ee2f7632006a54152d371aaab4ea46b4bac8279dc42bb706e92c5639be505c7459c60e547f
-  data.tar.gz: 2546aa36fb8126be0e2f666aa38fe9a4062916b886eec87f00d91df56d1ad7ba1c7e43974a3ca8b62c1fd05e0b1b621a03d522e02e37b1c6d23691fdd583bc64
+  metadata.gz: 6e208e6b3ed16190946cdeceae856ebcddc42b472458b86c527e0dfe52a67fe0d33e954c018f63fcb8502b659081aa35522516f9dacfb12f492b36a7830fe6b6
+  data.tar.gz: 3282b084e0907c8c709dfa2f3d2bef71527bca7181c342a24de63262c70ffa3a9e41f4437eb77f667a1e9c6a45776b8db6549ce709b244128b5fb58006b4afea

data/CHANGELOG.md

@@ -9,6 +9,14 @@ 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
+
 ## [0.1.0] – 2023-01-09
 
 - Add `TrueLayerSigning.sign_with_pem` and `TrueLayerSigning.verify_with_pem(pem)`.

data/README.md

@@ -1,5 +1,9 @@
 # truelayer-signing
 
+![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/TrueLayer/truelayer-signing/ruby.yml?branch=main)
+![Gem](https://img.shields.io/gem/v/truelayer-signing)
+![Gem](https://img.shields.io/gem/dt/truelayer-signing)
+
 Ruby gem to produce and verify TrueLayer API requests signatures.
 
 ## Installation

data/examples/sign-request/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.1)
+    addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
@@ -23,7 +23,7 @@ GEM
       rake (~> 13.0)
     public_suffix (5.0.1)
     rake (13.0.6)
-    truelayer-signing (0.1.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/examples/webhook-server/Gemfile

@@ -1,3 +1,4 @@
 source "https://rubygems.org"
 
 gem "truelayer-signing"
+gem "webrick"

data/examples/webhook-server/Gemfile.lock

@@ -2,14 +2,16 @@ GEM
   remote: https://rubygems.org/
   specs:
     jwt (2.6.0)
-    truelayer-signing (0.1.0)
+    truelayer-signing (0.1.1)
       jwt (= 2.6)
+    webrick (1.8.1)
 
 PLATFORMS
   arm64-darwin-21
 
 DEPENDENCIES
   truelayer-signing
+  webrick
 
 BUNDLED WITH
-   2.4.1
+   2.4.13

data/examples/webhook-server/main.rb

@@ -1,57 +1,54 @@
-require "socket"
-require "truelayer-signing"
+require 'securerandom'
+require 'truelayer-signing'
+require 'webrick'
 
 class TrueLayerSigningExamples
   # Note: the webhook path can be whatever is configured for your application.
   # Here a unique path is used, matching the example signature in the README.
   WEBHOOK_PATH = "/hook/d7a2c49d-110a-4ed2-a07d-8fdb3ea6424b".freeze
-  PUBLIC_KEY_PEM = "-----BEGIN PUBLIC KEY-----\n" +
-    "MIGbMBAGByqGSM49AgEGBSuBBAAjA4GGAAQBJ6ET9XeVCyMy+yOetZaNNCXPhwr5\n" +
-    "BlyDDg1CLmyNM5SvqOs8RveL6dYl4lpPur4xrPQl04ggYlVd9wnHkZnp3jcBlXw8\n" +
-    "Lc5phyYF1q2/QV/5wp2WHIhKDqUiXC0TvlE8d7MdTAN9yolcwrh6aWZ3kesTMZif\n" +
-    "BgItyT6PXUab8mMdI8k=\n-----END PUBLIC KEY-----"
+  PUBLIC_KEY_PEM = <<~TXT.freeze
+    -----BEGIN PUBLIC KEY-----
+    MIGbMBAGByqGSM49AgEGBSuBBAAjA4GGAAQBJ6ET9XeVCyMy+yOetZaNNCXPhwr5
+    BlyDDg1CLmyNM5SvqOs8RveL6dYl4lpPur4xrPQl04ggYlVd9wnHkZnp3jcBlXw8
+    Lc5phyYF1q2/QV/5wp2WHIhKDqUiXC0TvlE8d7MdTAN9yolcwrh6aWZ3kesTMZif
+    BgItyT6PXUab8mMdI8k=
+    -----END PUBLIC KEY-----
+  TXT
 
   class << self
     def run_webhook_server
-      server = TCPServer.new(4567)
+      TrueLayerSigning.certificate_id ||= SecureRandom.uuid
+      server = WEBrick::HTTPServer.new(Port: 4567)
 
       puts "Server running at http://localhost:4567"
 
-      loop do
-        Thread.start(server.accept) do |client|
-          begin
-            request = parse_request(client)
-            status, body = handle_request.call(request)
-            headers = { "Content-Type" => "text/plain" }
-
-            send_response(client, status, headers, body)
-          rescue => error
-            puts error
-          ensure
-            client.close
-          end
-        end
+      server.mount_proc('/') do |req, res|
+        request = parse_request(req)
+        status, body = handle_request.call(request)
+        headers = { "Content-Type" => "text/plain" }
+
+        send_response(res, status, headers, body)
+      rescue => error
+        puts error
       end
-    end
 
-    private def parse_request(client)
-      request = client.gets
-      headers, body = client.readpartial(2048).split("\r\n\r\n", 2)
-      method, remainder = request.split(" ", 2)
-      url = remainder.split(" ").first
-      path, _query_strings = url.split("?", 2)
+      server.start
+    ensure
+      server.shutdown
+    end
 
+    private def parse_request(request)
       {
-        method: method,
-        path: path,
-        headers: headers_to_hash(headers),
-        body: body
+        method: request.request_method,
+        path: request.path,
+        headers: headers_to_hash(request.header),
+        body: request.body
       }
     end
 
     private def handle_request
       Proc.new do |request|
-        if request[:method] == "POST" and request[:path] == WEBHOOK_PATH
+        if request[:method] == "POST" && request[:path] == WEBHOOK_PATH
           verify_webhook(request[:path], request[:headers], request[:body])
         else
           ["403", "Forbidden"]
@@ -65,7 +62,8 @@ class TrueLayerSigningExamples
       return ["400", "Bad Request – Header `Tl-Signature` missing"] unless tl_signature
 
       begin
-        TrueLayerSigning.verify_with_pem(PUBLIC_KEY_PEM)
+        TrueLayerSigning
+          .verify_with_pem(PUBLIC_KEY_PEM)
           .set_method(:post)
           .set_path(path)
           .set_headers(headers)
@@ -73,24 +71,22 @@ class TrueLayerSigningExamples
           .verify(tl_signature)
 
         ["202", "Accepted"]
-      rescue TrueLayerSigning::Error
+      rescue TrueLayerSigning::Error => error
+        puts error
+
         ["401", "Unauthorized"]
       end
     end
 
-    private def send_response(client, status, headers, body)
-      client.print("HTTP/1.1 #{status}\r\n")
-      headers.each { |key, value| client.print("#{key}: #{value}\r\n") }
-      client.print("\r\n#{body}")
+    private def headers_to_hash(headers)
+      headers.transform_keys { |key| key.to_s.strip.downcase }.transform_values(&:first)
     end
 
-    private def headers_to_hash(headers_string, hash = Hash.new)
-      headers_string.split("\r\n").each do |line|
-        pair = line.split(":")
-        hash[pair.first.to_s.strip.downcase] = pair.last.to_s.strip
-      end
-
-      hash
+    private def send_response(response, status, headers, body)
+      response.status = status
+      response.header.merge!(headers)
+      response.body = body
+      response
     end
   end
 end

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,19 +2,19 @@ $LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
 
 Gem::Specification.new do |s|
   s.name = "truelayer-signing"
-  s.version = "0.1.0"
+  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." \
     "This helps easily sign TrueLayer API requests using a JSON web signature."
   s.author = "Kevin Plattret"
   s.email = "kevin@truelayer.com"
-  s.homepage = "https://github.com/truelayer/truelayer-signing/ruby"
+  s.homepage = "https://github.com/TrueLayer/truelayer-signing/tree/main/ruby"
   s.licenses = ["Apache-2.0", "MIT"]
 
   s.metadata = {
-    "bug_tracker_uri" => "https://github.com/truelayer/truelayer-signing/issues",
-    "changelog_uri" => "https://github.com/truelayer/truelayer-signing/tree/ruby/CHANGELOG.md",
+    "bug_tracker_uri" => "https://github.com/TrueLayer/truelayer-signing/issues",
+    "changelog_uri" => "https://github.com/TrueLayer/truelayer-signing/blob/main/ruby/CHANGELOG.md",
   }
 
   s.files = Dir["./**/*"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: truelayer-signing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Kevin Plattret
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -122,13 +122,13 @@ files:
 - "./lib/truelayer-signing/verifier.rb"
 - "./test/test-truelayer-signing.rb"
 - "./truelayer-signing.gemspec"
-homepage: https://github.com/truelayer/truelayer-signing/ruby
+homepage: https://github.com/TrueLayer/truelayer-signing/tree/main/ruby
 licenses:
 - Apache-2.0
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/truelayer/truelayer-signing/issues
-  changelog_uri: https://github.com/truelayer/truelayer-signing/tree/ruby/CHANGELOG.md
+  bug_tracker_uri: https://github.com/TrueLayer/truelayer-signing/issues
+  changelog_uri: https://github.com/TrueLayer/truelayer-signing/blob/main/ruby/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -144,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Ruby gem to produce and verify TrueLayer API requests signatures