killbill-client 4.0.6 → 4.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31adb602c314f8de1252ffe021141878f4fcac84
-  data.tar.gz: 21c6b2aa1caed17c653f9b68bab2f4486f64fcc6
+  metadata.gz: 8e86e4cbc6c49a01a442aeb497caacd4a7893948
+  data.tar.gz: f02a33231d29d69f6be5b5f8987b87cc7f62514f
 SHA512:
-  metadata.gz: 955feb2439672126f43a76b3163560e3cf15ff150ae832c5e80b3c7fc9369dbcdca0e4480a2f7bc3f82b2e5740a6c48254a00110a9e7343685a846a6d8b73cfc
-  data.tar.gz: b45da24a25e77779133b17338f50ac2ff5d41de5c7276701c72cbe7ebe51865b4583abbb5532add4f1005f61f4bd2d5835be506225f8870eb3ee2878d057098a
+  metadata.gz: a5d298382c7555f66ce46ceae00be264f335a419682671ec1233c9c3c22aa706f318563a287b270c638e815c8d09f8e152f9c6226ce6b349623762706d673ec4
+  data.tar.gz: 8de6e6aea0a680b4301c1d8cb688a89b939ce68ee7b40b12f1acf34986b5e2d74dc79c5679046339c10a4d039bc7ed47eb027587070870658bfeec3c318cf178

data/.github/workflows/ci.yml

@@ -1,8 +1,9 @@
 name: ci
 
 on:
-  push:
-  workflow_dispatch:
+  - push
+  - workflow_dispatch
+  - pull_request
 
 env:
   COMPOSE_DOCKER_CLI_BUILD: 1
@@ -15,11 +16,11 @@ env:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
         include:
-          - ruby-version: '2.4.2'
+          - ruby-version: '3.2.2'
             database-adapter: 'mysql2'
             database-user: 'root'
             database-password: 'root'
@@ -31,13 +32,13 @@ jobs:
             database-password: 'postgres'
             database-port: '5432'
             docker-compose-file: 'docker-compose.ci.postgresql.yml'
-          - ruby-version: 'jruby-9.1.17.0'
+          - ruby-version: 'jruby-9.4.2.0'
             database-adapter: 'mysql2'
             database-user: 'root'
             database-password: 'root'
             database-port: '3306'
             docker-compose-file: 'docker-compose.ci.mysql.yml'
-          - ruby-version: '2.4.2'
+          - ruby-version: '3.3.5'
             database-adapter: 'postgresql'
             database-user: 'postgres'
             database-password: 'postgres'
@@ -49,7 +50,7 @@ jobs:
             database-password: 'postgres'
             database-port: '5432'
             docker-compose-file: 'docker-compose.ci.postgresql.yml'
-          - ruby-version: 'jruby-9.1.17.0'
+          - ruby-version: 'jruby-9.4.2.0'
             database-adapter: 'postgresql'
             database-user: 'postgres'
             database-password: 'postgres'
@@ -57,7 +58,7 @@ jobs:
             docker-compose-file: 'docker-compose.ci.postgresql.yml'
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -66,8 +67,8 @@ jobs:
       - name: Start stack
         run: |
           cd docker
-          docker-compose -p it -f ${{ matrix.docker-compose-file }} up --no-start
-          docker start it_db_1
+          docker compose -p it -f ${{ matrix.docker-compose-file }} up --no-start
+          docker start it-db-1
       - name: Wait for MySQL
         if: ${{ matrix.docker-compose-file == 'docker-compose.ci.mysql.yml' }}
         run: |
@@ -100,7 +101,7 @@ jobs:
         # Sometimes it gets stuck (if Kill Bill starts when the DB isn't ready?)
         timeout-minutes: 4
         run: |
-          docker start it_killbill_1
+          docker start it-killbill-1
           count=0
           until $(curl --connect-timeout 10 --max-time 30 --output /dev/null --silent --fail http://${KB_ADDRESS}:${KB_PORT}/1.0/healthcheck); do
             if [[ "$count" == "180" ]]; then
@@ -148,10 +149,10 @@ jobs:
           echo "[DEBUG] docker ps -a"
           docker ps -a
           echo "[DEBUG] killbill env"
-          docker exec it_killbill_1 env || true
+          docker exec it-killbill-1 env || true
           echo "[DEBUG] db env"
-          docker exec it_db_1 env || true
+          docker exec it-db-1 env || true
           echo "[DEBUG] killbill logs"
-          docker logs -t --details it_killbill_1 || true
+          docker logs -t --details it-killbill-1 || true
           echo "[DEBUG] db logs"
-          docker logs -t --details it_db_1 || true
+          docker logs -t --details it-db-1 || true

data/docker/docker-compose.ci.mysql.yml

@@ -3,7 +3,7 @@ version: '3.8'
 services:
   killbill:
     network_mode: host
-    image: killbill/killbill:0.22.20
+    image: killbill/killbill:0.24.0
     environment:
       - KILLBILL_CATALOG_URI=SpyCarAdvanced.xml
       - KILLBILL_DAO_URL=jdbc:mysql://127.0.0.1:3306/killbill
@@ -16,6 +16,6 @@ services:
       - db
   db:
     network_mode: host
-    image: killbill/mariadb:0.22
+    image: killbill/mariadb:0.24
     environment:
       - MYSQL_ROOT_PASSWORD=root

data/docker/docker-compose.ci.postgresql.yml

@@ -3,7 +3,7 @@ version: '3.8'
 services:
   killbill:
     network_mode: host
-    image: killbill/killbill:0.22.20
+    image: killbill/killbill:0.24.0
     environment:
       - KILLBILL_CATALOG_URI=SpyCarAdvanced.xml
       - KILLBILL_DAO_URL=jdbc:postgresql://127.0.0.1:5432/killbill
@@ -16,6 +16,6 @@ services:
       - db
   db:
     network_mode: host
-    image: killbill/postgresql:0.22
+    image: killbill/postgresql:0.24
     environment:
       - POSTGRES_PASSWORD=postgres

data/lib/killbill_client/api/net_http_adapter.rb

@@ -36,9 +36,79 @@ module KillBillClient
         }
 
         def build_uri(relative_uri, options)
-          # Need to encode in case of spaces (e.g. /1.0/kb/security/users/Mad Max/roles)
-          encoded_relative_uri = URI::DEFAULT_PARSER.regexp[:UNSAFE].match?(relative_uri) ? relative_uri : URI::DEFAULT_PARSER.escape(relative_uri)
-          if URI(encoded_relative_uri).scheme.nil?
+          # Split the URI into path and query parts
+          uri_parts = relative_uri.split('?', 2)
+          path_part = uri_parts[0]
+          query_part = uri_parts[1]
+          
+          # Check if this is an absolute URI (has scheme) by looking for protocol pattern
+          is_absolute_uri = path_part.match?(/\A[a-z][a-z0-9+.-]*:\/\//i)
+          
+          if is_absolute_uri
+            # This is an absolute URI, parse it carefully
+            begin
+              # Parse the URI components manually to handle spaces properly
+              if path_part.match(/\A([a-z][a-z0-9+.-]*):\/\/([^\/]+)(\/.*)?/i)
+                scheme = $1
+                authority = $2  # host:port
+                path = $3 || '/'
+                
+                # Encode only the path segments, not the scheme or authority
+                if path && path != '/'
+                  path_segments = path.split('/')
+                  encoded_segments = path_segments.map do |segment|
+                    # Skip encoding if the segment is already encoded (contains %XX patterns)
+                    if segment.match?(/%[0-9A-Fa-f]{2}/)
+                      segment
+                    else
+                      unsafe_regex = /[^a-zA-Z0-9\-_.!~*'()]/
+                      if unsafe_regex.match?(segment)
+                        CGI.escape(segment).gsub('+', '%20')
+                      else
+                        segment
+                      end
+                    end
+                  end
+                  encoded_path = encoded_segments.join('/')
+                else
+                  encoded_path = path
+                end
+                
+                encoded_relative_uri = "#{scheme}://#{authority}#{encoded_path}"
+                encoded_relative_uri += "?#{query_part}" if query_part
+              else
+                # Fallback: treat as relative if parsing fails
+                is_absolute_uri = false
+              end
+            rescue
+              # Fallback: treat as relative if any error occurs
+              is_absolute_uri = false
+            end
+          end
+          
+          unless is_absolute_uri
+            # This is a relative URI, encode path segments individually
+            path_segments = path_part.split('/')
+            encoded_segments = path_segments.map do |segment|
+              # Skip encoding if the segment is already encoded (contains %XX patterns)
+              if segment.match?(/%[0-9A-Fa-f]{2}/)
+                segment
+              else
+                # Only encode segments that contain unsafe characters
+                unsafe_regex = /[^a-zA-Z0-9\-_.!~*'()]/
+                if unsafe_regex.match?(segment)
+                  # Use CGI.escape and replace + with %20 for URL path encoding
+                  CGI.escape(segment).gsub('+', '%20')
+                else
+                  segment
+                end
+              end
+            end
+            encoded_path = encoded_segments.join('/')
+            encoded_relative_uri = query_part ? "#{encoded_path}?#{query_part}" : encoded_path
+          end
+
+          if !is_absolute_uri
             uri = (options[:base_uri] || KillBillClient::API.base_uri)
             uri = URI.parse(uri) unless uri.is_a?(URI)
             # Note: make sure to keep the full path (if any) from URI::HTTP, for non-ROOT deployments
@@ -49,7 +119,19 @@ module KillBillClient
             uri = encoded_relative_uri
             uri = URI.parse(uri) unless uri.is_a?(URI)
           end
-          uri += encode_params(options).to_s
+
+          query_params = encode_params(options)
+          if query_params && !query_params.empty?
+            # encode_params returns "?param=value", so remove the leading "?"
+            params_without_question = query_params[1..-1]
+            if uri.query && !uri.query.empty?
+              # If there's already a query string, append with &
+              uri.query = uri.query + '&' + params_without_question
+            else
+              # If no existing query string, set it directly
+              uri.query = params_without_question
+            end
+          end
 
           uri
         end
@@ -59,17 +141,25 @@ module KillBillClient
           # so remove with from global hash and insert them under :params
           plugin_properties = options.delete :pluginProperty
           if plugin_properties && plugin_properties.size > 0
+            options[:params] ||= {}
             options[:params][:pluginProperty] = plugin_properties.map { |p| "#{CGI.escape p.key.to_s}=#{CGI.escape p.value.to_s}" }
           end
 
           control_plugin_names = options.delete(:controlPluginNames)
-          options[:params][:controlPluginName] = control_plugin_names if control_plugin_names
+          if control_plugin_names
+            options[:params] ||= {}
+            options[:params][:controlPluginName] = control_plugin_names
+          end
 
           return nil unless (options[:params] && !options[:params].empty?)
 
-          options[:params][:withStackTrace] = true if (options[:return_full_stacktraces] || KillBillClient.return_full_stacktraces)
+          if (options[:return_full_stacktraces] || KillBillClient.return_full_stacktraces)
+            options[:params][:withStackTrace] = true
+          end
 
           pairs = options[:params].map { |key, value|
+            next if value.nil?
+
             # If the value is an array, we 'demultiplex' into several
             if value.is_a? Array
               internal_pairs = value.map do |simple_value|
@@ -79,8 +169,9 @@ module KillBillClient
             else
               "#{CGI.escape key.to_s}=#{CGI.escape value.to_s}"
             end
-          }
+          }.compact
           pairs.flatten!
+          return nil if pairs.empty?
           "?#{pairs.join '&'}"
         end
 

data/lib/killbill_client/models/invoice.rb

@@ -212,7 +212,7 @@ module KillBillClient
         def get_invoice_template(is_manual_pay, locale = nil, options = {})
 
           require_multi_tenant_options!(options, "Retrieving an invoice template supported in multi-tenant mode")
-
+          locale ||= 'en'
 
           get "#{KILLBILL_API_INVOICES_PREFIX}/#{is_manual_pay ? "manualPayTemplate/#{locale}" : "template"}",
               {},

data/lib/killbill_client/version.rb

@@ -1,3 +1,3 @@
 module KillBillClient
-  VERSION = '4.0.6'
+  VERSION = '4.0.7'
 end

data/spec/killbill_client/http_adapter_spec.rb

@@ -106,6 +106,256 @@ describe KillBillClient::API do
     uri = http_adapter.send(:build_uri, KillBillClient::Model::Account::KILLBILL_API_ACCOUNTS_PREFIX, options)
     expect(uri).to eq(URI.parse("#{KillBillClient::API.base_uri.to_s}/1.0/kb/accounts"))
   end
+
+  describe '#build_uri' do
+    let(:http_adapter) { DummyForHTTPAdapter.new }
+
+    before do
+      KillBillClient.url = 'http://example.com:8080'
+    end
+
+    context 'with basic relative URI' do
+      it 'should combine base URI with relative URI' do
+        relative_uri = '/1.0/kb/accounts'
+        options = {}
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.to_s).to eq('http://example.com:8080/1.0/kb/accounts')
+      end
+
+      it 'should handle relative URI without leading slash' do
+        relative_uri = '1.0/kb/accounts'
+        options = {}
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.to_s).to eq('http://example.com:8080/1.0/kb/accounts')
+      end
+    end
+
+    context 'with custom base_uri in options' do
+      it 'should use custom base_uri from options' do
+        relative_uri = '/1.0/kb/accounts'
+        options = { base_uri: 'https://custom.example.com:9090' }
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.to_s).to eq('https://custom.example.com:9090/1.0/kb/accounts')
+      end
+    end
+
+    context 'with absolute URI' do
+      it 'should use absolute URI as-is' do
+        relative_uri = 'https://absolute.example.com/api/test'
+        options = {}
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.to_s).to eq('https://absolute.example.com/api/test')
+      end
+    end
+
+    context 'with path encoding' do
+      it 'should handle already encoded URIs without double encoding' do
+        relative_uri = '/1.0/kb/accounts/my%20account%20with%20spaces'
+        options = {}
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.to_s).to eq('http://example.com:8080/1.0/kb/accounts/my%20account%20with%20spaces')
+      end
+
+      it 'should not encode safe characters in path' do
+        relative_uri = '/1.0/kb/accounts/abc-1234'
+        options = {}
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.to_s).to eq('http://example.com:8080/1.0/kb/accounts/abc-1234')
+      end
+
+      it 'should handle already encoded URI with query string without double encoding' do
+        relative_uri = '/1.0/kb/accounts/my%20account?search=test%20value'
+        options = {}
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.to_s).to eq('http://example.com:8080/1.0/kb/accounts/my%20account?search=test%20value')
+      end
+    end
+
+    context 'with query parameters in options' do
+      it 'should add simple query parameters' do
+        relative_uri = '/1.0/kb/accounts'
+        options = { params: { accountId: '123', limit: 10 } }
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.query).to include('accountId=123')
+        expect(uri.query).to include('limit=10')
+      end
+
+      it 'should handle array parameters' do
+        relative_uri = '/1.0/kb/accounts'
+        options = { params: { tags: ['premium', 'business'] } }
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.query).to include('tags=premium')
+        expect(uri.query).to include('tags=business')
+      end
+
+      it 'should merge with existing query string in relative URI' do
+        relative_uri = '/1.0/kb/accounts?existing=value'
+        options = { params: { new: 'param' } }
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.query).to include('existing=value')
+        expect(uri.query).to include('new=param')
+      end
+
+      it 'should handle empty params hash' do
+        relative_uri = '/1.0/kb/accounts'
+        options = { params: {} }
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.query).to be_nil
+      end
+
+      it 'should encode special characters in query parameters' do
+        relative_uri = '/1.0/kb/accounts'
+        options = { params: { search: 'test & special chars' } }
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.query).to include('search=test+%26+special+chars')
+      end
+    end
+
+    context 'with plugin properties' do
+      it 'should handle pluginProperty option' do
+        contract_property = KillBillClient::Model::PluginPropertyAttributes.new
+        contract_property.key = :contractId
+        contract_property.value = 'test-123'
+        relative_uri = '/1.0/kb/accounts'
+        options = {
+          params: {},
+          pluginProperty: [contract_property]
+        }
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.query).to include('pluginProperty=contractId%3Dtest-123')
+      end
+    end
+
+    context 'with control plugin names' do
+      it 'should handle controlPluginNames option' do
+        relative_uri = '/1.0/kb/accounts'
+        options = {
+          params: {},
+          controlPluginNames: ['plugin1', 'plugin2']
+        }
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.query).to include('controlPluginName=plugin1')
+        expect(uri.query).to include('controlPluginName=plugin2')
+      end
+    end
+
+    context 'with spaces in path segments' do
+      it 'should encode spaces in relative URI path segments' do
+        relative_uri = '/1.0/kb/accounts/search/Kill Bill Client'
+        options = {}
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.to_s).to eq('http://example.com:8080/1.0/kb/accounts/search/Kill%20Bill%20Client')
+      end
+
+      it 'should handle absolute URI with spaces in path' do
+        relative_uri = 'http://127.0.0.1:8080/1.0/kb/accounts/search/Kill Bill Client'
+        options = {}
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.to_s).to eq('http://127.0.0.1:8080/1.0/kb/accounts/search/Kill%20Bill%20Client')
+      end
+
+      it 'should preserve scheme and host when encoding spaces in absolute URI' do
+        relative_uri = 'https://api.example.com:9090/search/My Test Account'
+        options = {}
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.to_s).to eq('https://api.example.com:9090/search/My%20Test%20Account')
+        expect(uri.scheme).to eq('https')
+        expect(uri.host).to eq('api.example.com')
+        expect(uri.port).to eq(9090)
+      end
+    end
+
+    context 'with nil values in query parameters' do
+      it 'should skip nil values in params' do
+        relative_uri = '/1.0/kb/accounts'
+        options = {
+          params: {
+            account: nil,
+            withStackTrace: true,
+            limit: 10
+          }
+        }
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.query).not_to include('account=')
+        expect(uri.query).to include('withStackTrace=true')
+        expect(uri.query).to include('limit=10')
+      end
+
+      it 'should handle all nil values in params' do
+        relative_uri = '/1.0/kb/accounts'
+        options = {
+          params: {
+            account: nil,
+            tenant: nil
+          }
+        }
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.query).to be_nil
+      end
+
+      it 'should handle mixed nil and valid values' do
+        relative_uri = '/1.0/kb/accounts'
+        options = {
+          params: {
+            account: nil,
+            withStackTrace: true,
+            offset: 0,
+            search: nil,
+            limit: 50
+          }
+        }
+        uri = http_adapter.send(:build_uri, relative_uri, options)
+        expect(uri.query).not_to include('account=')
+        expect(uri.query).not_to include('search=')
+        expect(uri.query).to include('withStackTrace=true')
+        expect(uri.query).to include('offset=0')
+        expect(uri.query).to include('limit=50')
+      end
+    end
+  end
+
+  describe '#encode_params' do
+    let(:http_adapter) { DummyForHTTPAdapter.new }
+
+    it 'should filter out nil values from params' do
+      options = {
+        params: {
+          account: nil,
+          withStackTrace: true,
+          limit: 10,
+          search: nil
+        }
+      }
+      query_string = http_adapter.send(:encode_params, options)
+      expect(query_string).to include('withStackTrace=true')
+      expect(query_string).to include('limit=10')
+      expect(query_string).not_to include('account=')
+      expect(query_string).not_to include('search=')
+    end
+
+    it 'should return nil when all params are nil' do
+      options = {
+        params: {
+          account: nil,
+          tenant: nil
+        }
+      }
+      query_string = http_adapter.send(:encode_params, options)
+      expect(query_string).to be_nil
+    end
+
+    it 'should return nil when params hash is empty' do
+      options = { params: {} }
+      query_string = http_adapter.send(:encode_params, options)
+      expect(query_string).to be_nil
+    end
+
+    it 'should handle options without params key' do
+      options = { account: nil, withStackTrace: true }
+      query_string = http_adapter.send(:encode_params, options)
+      expect(query_string).to be_nil
+    end
+  end
 end
 
 class DummyForHTTPAdapter

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill-client
 version: !ruby/object:Gem::Version
-  version: 4.0.6
+  version: 4.0.7
 platform: ruby
 authors:
 - Killbill core team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-10 00:00:00.000000000 Z
+date: 2025-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem-release