open-banking-io 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b6ab2de9b335f7edc7203e5723066756103876c5f986dfd6ac6ff1ac7bf263f
-  data.tar.gz: 4ede77b0da39a399387d49d7b47ec4c76b7c7277c4983b61d928fbca320adf7f
+  metadata.gz: 52d72498c008ed13bec684867aef1f1b693c6f9ba0ed824e981ae554787c19a8
+  data.tar.gz: 47d0c4dbfc8511f80b0ac8b9d2270fbd68f969141b222c7dda61a2c8254e577c
 SHA512:
-  metadata.gz: e8af173269a9036665b494976ccb5292754a6984f6f18f356e2e7946edc6cd7387919cf348c73d226f96bed1ae6e65dc6fb35b8881a64dfc5788b6574c53a8b9
-  data.tar.gz: 5a91e86f5fdfaf166b1e1fe691efb86fc39cdeb2b9246838af679b2c8693f222100d6dafaa1db92df1ea976ec87b9947072eef93ee553f2e46090c0b34cf4472
+  metadata.gz: 13cce72e500507d12756086fc0d3dd6595556fb4200f6d9da9c69bc112558aefafa684043814988b8e58a0ee1907a2480d9d29b0721c9f6de73677afb3b25818
+  data.tar.gz: f607fde4595bf4b1499d32db231d7939d60b064dfe2308cdcecd80557735bf7c0ad062052003d11787c5f2d661269b24518130dd41c5c5a1e52dd8963c97b6fe

data/README.md

@@ -1,3 +1,9 @@
+<p align="center">
+  <a href="https://open-banking.io">
+    <img src="https://raw.githubusercontent.com/open-banking-io/clients/main/.github/logo.png" alt="open-banking.io" height="56">
+  </a>
+</p>
+
 # open-banking-io (Ruby)
 
 Server-to-server client for [open-banking.io](https://open-banking.io). It authenticates with your
@@ -55,8 +61,9 @@ Every request sets connect/read timeouts (15s/60s) and a `User-Agent: open-banki
 
 Envelopes use **ECDH P-256 → HKDF-SHA256 → AES-256-GCM**, implemented entirely with Ruby's OpenSSL
 standard library. Decryption requires the private key from your credentials bundle and happens fully
-in-process. See the [repo README](https://github.com/open-banking-io/clients) for the full scheme and
-the other language clients (.NET, Node, Python, Rust, Go, Java).
+in-process. Full wire format and the other language clients:
+[repo README](https://github.com/open-banking-io/clients) ·
+[`THREAT_MODEL.md`](https://github.com/open-banking-io/clients/blob/main/THREAT_MODEL.md).
 
 ## Development
 

data/lib/open_banking_io/client.rb

@@ -32,7 +32,12 @@ module OpenBankingIO
     USER_AGENT = "open-banking-io/ruby/#{VERSION}".freeze
 
     # Builds a client from a credentials-bundle JSON string or a path to a bundle file.
-    def self.from_credentials(path_or_json)
+    #
+    # Optional +open_timeout+/+read_timeout+ (seconds) and a caller-supplied +http_client+
+    # (an object responding to +#request+, e.g. a preconfigured Net::HTTP) are threaded
+    # straight through to +#initialize+; the defaults preserve the previous behaviour.
+    def self.from_credentials(path_or_json, open_timeout: DEFAULT_OPEN_TIMEOUT,
+      read_timeout: DEFAULT_READ_TIMEOUT, http_client: nil)
       raw = if File.file?(path_or_json.to_s)
         File.read(path_or_json)
       else
@@ -50,17 +55,37 @@ module OpenBankingIO
         raise ArgumentError, "The credentials bundle has no encryption private key"
       end
 
-      new(api_base_url: api_base_url, api_key: api_key, private_key_pkcs8: private_key)
+      new(
+        api_base_url: api_base_url,
+        api_key: api_key,
+        private_key_pkcs8: private_key,
+        open_timeout: open_timeout,
+        read_timeout: read_timeout,
+        http_client: http_client
+      )
     end
 
-    def initialize(api_base_url:, api_key:, private_key_pkcs8:)
+    # +open_timeout+/+read_timeout+ are seconds applied to the internally built Net::HTTP.
+    # +http_client+, when given, is any object responding to +#request+ (e.g. a preconfigured
+    # Net::HTTP for a proxy, custom CA/mTLS or connection pooling); it is used as-is instead
+    # of building one internally. All three are optional and default to the previous behaviour.
+    def initialize(api_base_url:, api_key:, private_key_pkcs8:,
+      open_timeout: DEFAULT_OPEN_TIMEOUT, read_timeout: DEFAULT_READ_TIMEOUT,
+      http_client: nil)
       raise ArgumentError, "api_base_url is required" if blank?(api_base_url)
       raise ArgumentError, "api_key is required" if blank?(api_key)
       raise ArgumentError, "private_key_pkcs8 is required" if blank?(private_key_pkcs8)
 
-      @base_uri = URI.parse(api_base_url.to_s.sub(%r{/+\z}, "") + "/")
+      # Strip any trailing slashes without a backtracking regex (avoids ReDoS on
+      # pathological input) then re-append a single one, so the base always ends in "/".
+      base = api_base_url.to_s
+      base = base.chomp("/") while base.end_with?("/")
+      @base_uri = URI.parse(base + "/")
       @api_key = api_key
       @private_key = Envelope.load_private_key(private_key_pkcs8)
+      @open_timeout = open_timeout
+      @read_timeout = read_timeout
+      @http_client = http_client
     end
 
     # Lists the user's accounts with all sensitive fields decrypted.
@@ -255,10 +280,7 @@ module OpenBankingIO
       request["Accept"] = "application/json"
       request["User-Agent"] = USER_AGENT
 
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = (uri.scheme == "https")
-      http.open_timeout = DEFAULT_OPEN_TIMEOUT
-      http.read_timeout = DEFAULT_READ_TIMEOUT
+      http = @http_client || build_http(uri)
 
       response = http.request(request)
       code = response.code.to_i
@@ -269,5 +291,13 @@ module OpenBankingIO
 
       JSON.parse(body)
     end
+
+    def build_http(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = (uri.scheme == "https")
+      http.open_timeout = @open_timeout
+      http.read_timeout = @read_timeout
+      http
+    end
   end
 end

data/lib/open_banking_io/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenBankingIO
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open-banking-io
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - open-banking.io
@@ -85,22 +85,19 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-    - - "<"
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :development
@@ -108,9 +105,6 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-    - - "<"
       - !ruby/object:Gem::Version
         version: '3.4'
 - !ruby/object:Gem::Dependency