killbill-client 2.4.0 → 3.3.0

data/README.md

@@ -10,7 +10,8 @@ Kill Bill compatibility
 | -------------: | ----------------: |
 | 0.x.y          | 0.16.z            |
 | 1.x.y          | 0.18.z            |
-| 2.x.y          | 0.19.z            |
+| 2.x.y          | 0.20.z            |
+| 3.x.y          | 0.22.z            |
 
 Installation
 ------------

data/bin/retry

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+x() {
+    echo "+ $*" >&2
+    "$@"
+}
+
+retry_delay_seconds=10
+
+i="0"
+while [ $i -lt 4 ]
+do
+    x "$@" && exit 0
+    sleep "${retry_delay_seconds}"
+    i=$[$i+1]
+done
+
+echo "$0: retrying [$*] timed out" >&2
+exit 1

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

@@ -0,0 +1,21 @@
+version: '3.8'
+
+services:
+  killbill:
+    network_mode: host
+    image: killbill/killbill:0.22.20
+    environment:
+      - KILLBILL_CATALOG_URI=SpyCarAdvanced.xml
+      - KILLBILL_DAO_URL=jdbc:mysql://127.0.0.1:3306/killbill
+      - KILLBILL_DAO_USER=root
+      - KILLBILL_DAO_PASSWORD=root
+      - KILLBILL_SERVER_TEST_MODE=true
+      - KILLBILL_INVOICE_SANITY_SAFETY_BOUND_ENABLED=false
+      - KILLBILL_INVOICE_MAX_DAILY_NUMBER_OF_ITEMS_SAFETY_BOUND=-1
+    depends_on:
+      - db
+  db:
+    network_mode: host
+    image: killbill/mariadb:0.22
+    environment:
+      - MYSQL_ROOT_PASSWORD=root

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

@@ -0,0 +1,21 @@
+version: '3.8'
+
+services:
+  killbill:
+    network_mode: host
+    image: killbill/killbill:0.22.20
+    environment:
+      - KILLBILL_CATALOG_URI=SpyCarAdvanced.xml
+      - KILLBILL_DAO_URL=jdbc:postgresql://127.0.0.1:5432/killbill
+      - KILLBILL_DAO_USER=postgres
+      - KILLBILL_DAO_PASSWORD=postgres
+      - KILLBILL_SERVER_TEST_MODE=true
+      - KILLBILL_INVOICE_SANITY_SAFETY_BOUND_ENABLED=false
+      - KILLBILL_INVOICE_MAX_DAILY_NUMBER_OF_ITEMS_SAFETY_BOUND=-1
+    depends_on:
+      - db
+  db:
+    network_mode: host
+    image: killbill/postgresql:0.22
+    environment:
+      - POSTGRES_PASSWORD=postgres

data/killbill_client.gemspec

@@ -19,7 +19,7 @@ require 'killbill_client/version'
 
 Gem::Specification.new do |s|
   s.name        = 'killbill-client'
-  s.version     = KillBillClient::Version.to_s
+  s.version     = KillBillClient::VERSION
   s.summary     = 'Kill Bill client library.'
   s.description = 'An API client library for Kill Bill.'
 
@@ -43,6 +43,7 @@ Gem::Specification.new do |s|
     s.add_dependency 'json', '>= 1.2.0', '< 2.0.0'
   end
 
+  s.add_development_dependency 'gem-release', '~> 2.2'
   s.add_development_dependency 'rake', '>= 10.0.0', '< 11.0.0'
   s.add_development_dependency 'rspec', '~> 3.4'
 end

data/lib/killbill_client.rb

@@ -41,6 +41,8 @@ module KillBillClient
 
     attr_writer :url
 
+    attr_accessor :read_timeout
+    attr_accessor :connection_timeout
     attr_accessor :disable_ssl_verification
     attr_accessor :return_full_stacktraces
 

data/lib/killbill_client/api/api.rb

@@ -70,7 +70,7 @@ module KillBillClient
 
       # @return [String]
       def user_agent
-        "killbill/#{Version}; #{RUBY_DESCRIPTION}"
+        "killbill/#{VERSION}; #{RUBY_DESCRIPTION}"
       end
 
       private

data/lib/killbill_client/api/net_http_adapter.rb

@@ -35,6 +35,25 @@ module KillBillClient
             :delete => ::Net::HTTP::Delete
         }
 
+        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.escape(relative_uri)
+          if URI(encoded_relative_uri).scheme.nil?
+            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
+            # See https://github.com/killbill/killbill/issues/221#issuecomment-151980263
+            base_path = uri.request_uri == '/' ? '' : uri.request_uri
+            uri += (base_path + URI::DEFAULT_PARSER.escape(relative_uri))
+          else
+            uri = encoded_relative_uri
+            uri = URI.parse(uri) unless uri.is_a?(URI)
+          end
+          uri += encode_params(options).to_s
+
+          uri
+        end
+
         def encode_params(options = {})
           # Plugin properties and controlPluginNames are passed in the options but we want to send them as query parameters,
           # so remove with from global hash and insert them under :params
@@ -67,8 +86,16 @@ module KillBillClient
 
         def create_http_client(uri, options = {})
           http = ::Net::HTTP.new uri.host, uri.port
-          http.read_timeout = options[:read_timeout].to_f / 1000 if options[:read_timeout].is_a? Numeric
-          http.open_timeout = options[:connection_timeout].to_f / 1000 if options[:connection_timeout].is_a? Numeric
+          if options[:read_timeout].is_a? Numeric
+            http.read_timeout = options[:read_timeout].to_f / 1000
+          elsif KillBillClient.read_timeout.is_a? Numeric
+            http.read_timeout = KillBillClient.read_timeout.to_f / 1000
+          end
+          if options[:connection_timeout].is_a? Numeric
+            http.open_timeout = options[:connection_timeout].to_f / 1000
+          elsif KillBillClient.connection_timeout.is_a? Numeric
+            http.open_timeout = KillBillClient.connection_timeout.to_f / 1000
+          end
           http.use_ssl = uri.scheme == 'https'
           http.verify_mode = OpenSSL::SSL::VERIFY_NONE if (options[:disable_ssl_verification] || KillBillClient.disable_ssl_verification)
           http
@@ -79,20 +106,7 @@ module KillBillClient
           head.update options[:head] if options[:head]
           head.delete_if { |_, value| value.nil? }
 
-          # Need to encode in case of spaces (e.g. /1.0/kb/security/users/Mad Max/roles)
-          encoded_relative_uri = URI::DEFAULT_PARSER.escape(relative_uri)
-          if URI(encoded_relative_uri).scheme.nil?
-            uri = (options[:base_uri] || 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
-            # See https://github.com/killbill/killbill/issues/221#issuecomment-151980263
-            base_path = uri.request_uri == '/' ? '' : uri.request_uri
-            uri += (base_path + URI::DEFAULT_PARSER.escape(relative_uri))
-          else
-            uri = encoded_relative_uri
-            uri = URI.parse(uri) unless uri.is_a?(URI)
-          end
-          uri += encode_params(options).to_s
+          uri = build_uri(relative_uri, options)
           request = METHODS[method].new uri.request_uri, head
 
           # Configure multi-tenancy headers, if enabled

data/lib/killbill_client/models/account.rb

@@ -65,6 +65,14 @@ module KillBillClient
               },
               options
         end
+
+        def blocking_state_audit_logs_with_history(blocking_state_id, options = {})
+          get "#{KILLBILL_API_ACCOUNTS_PREFIX}/block/#{blocking_state_id}/auditLogsWithHistory",
+              {},
+              options,
+              AuditLog
+        end
+
       end
 
       def create(user = nil, reason = nil, comment = nil, options = {})
@@ -135,20 +143,18 @@ module KillBillClient
                        Bundle
       end
 
-      def invoices(with_items=false, options = {})
+      def invoices(options = {})
         self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/invoices",
                        {
-                           :withItems => with_items
                        },
                        options,
                        Invoice
       end
 
-      def migration_invoices(with_items=false, options = {})
+      def migration_invoices(options = {})
         self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/invoices",
                        {
-                           :withMigrationInvoices => true,
-                           :withItems => with_items
+                           :withMigrationInvoices => true
                        },
                        options,
                        Invoice
@@ -286,26 +292,7 @@ module KillBillClient
                        AuditLog
       end
 
-      def email_notifications(options = {})
-        self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/emailNotifications",
-                       {},
-                       options,
-                       InvoiceEmailAttributes
-      end
-
-      def update_email_notifications(user = nil, reason = nil, comment = nil, options = {})
-        self.class.put "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/emailNotifications",
-                       to_json,
-                       {},
-                       {
-                           :user => user,
-                           :reason => reason,
-                           :comment => comment,
-                       }.merge(options)
-      end
-
       def all_tags(object_type, included_deleted, audit = 'NONE', options = {})
-
         params = {}
         params[:objectType] = object_type if object_type
         params[:includedDeleted] = included_deleted if included_deleted
@@ -389,6 +376,7 @@ module KillBillClient
                        options,
                        AuditLog
       end
+
     end
   end
 end

data/lib/killbill_client/models/admin.rb

@@ -0,0 +1,131 @@
+module KillBillClient
+  module Model
+    class Admin < AdminPaymentAttributes
+
+      KILLBILL_API_ADMIN_PREFIX = "#{KILLBILL_API_PREFIX}/admin"
+      KILLBILL_API_QUEUES_PREFIX = "#{KILLBILL_API_ADMIN_PREFIX}/queues"
+
+      KILLBILL_API_CLOCK_PREFIX = "#{KILLBILL_API_PREFIX}/test/clock"
+
+      class << self
+        def get_queues_entries(account_id, options = {})
+          get KILLBILL_API_QUEUES_PREFIX,
+                    {
+                        :accountId => account_id,
+                        :withHistory => options[:withHistory],
+                        :minDate => options[:minDate],
+                        :maxDate => options[:maxDate]
+                    },
+                    {
+                        :accept => 'application/octet-stream'
+                    }.merge(options)
+        end
+
+        def fix_transaction_state(payment_id, transaction_id, transaction_status, user = nil, reason = nil, comment = nil, options = {})
+          put "#{KILLBILL_API_ADMIN_PREFIX}/payments/#{payment_id}/transactions/#{transaction_id}",
+              {:transactionStatus => transaction_status}.to_json,
+              {},
+              {
+                  :user => user,
+                  :reason => reason,
+                  :comment => comment,
+              }.merge(options)
+        end
+
+        def trigger_invoice_generation_for_parked_accounts(offset = 0, limit = 100, user =nil, options = {})
+          post "#{KILLBILL_API_ADMIN_PREFIX}/invoices",
+               {},
+               {
+                   :offset => offset,
+                   :limit => limit
+               },
+               {
+                   :user => user
+               }.merge(options)
+        end
+
+        def put_in_rotation(options = {})
+          put "#{KILLBILL_API_ADMIN_PREFIX}/healthcheck",
+               {},
+               {},
+               {}.merge(options)
+        end
+
+        def put_out_of_rotation(options = {})
+          delete "#{KILLBILL_API_ADMIN_PREFIX}/healthcheck",
+              {},
+              {},
+              {}.merge(options)
+        end
+
+        def invalidates_cache(cache_name = nil, options = {})
+          delete "#{KILLBILL_API_ADMIN_PREFIX}/cache",
+                 {},
+                 {
+                     :cacheName => cache_name
+                 },
+                 {}.merge(options)
+        end
+
+        def invalidates_cache_by_account(account_id = nil, options = {})
+          delete "#{KILLBILL_API_ADMIN_PREFIX}/cache/accounts/#{account_id}",
+                 {},
+                 {},
+                 {}.merge(options)
+        end
+
+        def invalidates_cache_by_tenant(options = {})
+          delete "#{KILLBILL_API_ADMIN_PREFIX}/cache/tenants",
+                 {},
+                 {},
+                 {}.merge(options)
+        end
+
+        def get_clock(time_zone, options)
+          params = {}
+          params[:timeZone] = time_zone unless time_zone.nil?
+
+          res = get KILLBILL_API_CLOCK_PREFIX,
+                    params,
+                    options
+          JSON.parse res.body
+        end
+
+        def set_clock(requested_date, time_zone, options)
+          params = {}
+          params[:requestedDate] = requested_date unless requested_date.nil?
+          params[:timeZone] = time_zone unless time_zone.nil?
+
+          # The default 5s is not always enough
+          params[:timeoutSec] ||= 10
+
+          res = post KILLBILL_API_CLOCK_PREFIX,
+                     {},
+                     params,
+                     {}.merge(options)
+          JSON.parse res.body
+        end
+
+        def increment_kb_clock(days, weeks, months, years, time_zone, options)
+          params = {}
+          params[:days] = days unless days.nil?
+          params[:weeks] = weeks unless weeks.nil?
+          params[:months] = months unless months.nil?
+          params[:years] = years unless years.nil?
+          params[:timeZone] = time_zone unless time_zone.nil?
+
+          # The default 5s is not always enough
+          params[:timeoutSec] ||= 10
+
+          res = put KILLBILL_API_CLOCK_PREFIX,
+                    {},
+                    params,
+                    {}.merge(options)
+
+          JSON.parse res.body
+        end
+
+      end
+    end
+  end
+end

data/lib/killbill_client/models/bundle.rb

@@ -6,12 +6,14 @@ module KillBillClient
 
       include KillBillClient::Model::TagHelper
       include KillBillClient::Model::CustomFieldHelper
+      include KillBillClient::Model::AuditLogWithHistoryHelper
 
       has_custom_fields KILLBILL_API_BUNDLES_PREFIX, :bundle_id
       has_tags KILLBILL_API_BUNDLES_PREFIX, :bundle_id
 
       has_many :subscriptions, KillBillClient::Model::Subscription
       has_many :audit_logs, KillBillClient::Model::AuditLog
+      has_audit_logs_with_history KILLBILL_API_BUNDLES_PREFIX, :bundle_id
 
       class << self
         def find_in_batches(offset = 0, limit = 100, options = {})

data/lib/killbill_client/models/credit.rb

@@ -1,6 +1,6 @@
 module KillBillClient
   module Model
-    class Credit < CreditAttributes
+    class Credit < InvoiceItemAttributes
       KILLBILL_API_CREDITS_PREFIX = "#{KILLBILL_API_PREFIX}/credits"
       has_many :audit_logs, KillBillClient::Model::AuditLog
 
@@ -9,13 +9,13 @@ module KillBillClient
           get "#{KILLBILL_API_CREDITS_PREFIX}/#{credit_id}",
               {},
               options,
-              CreditAttributes
+              InvoiceItemAttributes
         end
       end
 
       def create(auto_commit = false, user = nil, reason = nil, comment = nil, options = {})
-        created_credit = self.class.post KILLBILL_API_CREDITS_PREFIX,
-                                         to_json,
+        created_credits = self.class.post KILLBILL_API_CREDITS_PREFIX,
+                                         [to_hash].to_json,
                                          {
                                              :autoCommit => auto_commit
                                          },
@@ -24,7 +24,7 @@ module KillBillClient
                                              :reason => reason,
                                              :comment => comment,
                                          }.merge(options)
-        created_credit.refresh(options)
+        created_credits
       end
 
     end

data/lib/killbill_client/models/custom_field.rb

@@ -28,6 +28,23 @@ module KillBillClient
               },
               options
         end
+
+        def find_in_batches_by_search_type_name(object_type, field_name, field_value, offset = 0, limit = 100, options = {})
+
+          query_fields = {
+              :objectType => object_type,
+              :fieldName => field_name,
+              :fieldValue => field_value,
+              :offset => offset,
+              :limit  => limit
+          }
+          query_fields[:fieldValue] = field_value if field_value
+
+          get "#{KILLBILL_API_CUSTOM_FIELDS_PREFIX}/search",
+              query_fields,
+              options
+        end
+
       end
     end
   end