killbill-client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c703102c2d5b0ca273db8faa154cc6875b2b6021
-  data.tar.gz: 660786f1bf17d6bec10c01720ac0550de1f59f5c
+  metadata.gz: d524b522d967389b15689ae165caed6c0a01dfaf
+  data.tar.gz: 04d0b19fbb503cb3c6cc23eb7634b3171af89bfd
 SHA512:
-  metadata.gz: fe35609bef6402e72d22dd442f8c2dc875e69a49cd3ececf6fda7e04a7fc455178d41ab2f239fc8e8364b86f4e8db91f8cd35774702ee4b35b5547d343272ad9
-  data.tar.gz: 72a29072e1eafcc1c6f1b0fedca4fa248191b1fe5498892411f671c9a5be7e9bf79ce2967752706b1d7b04edf6857c09ef55ecae5e00b4f9eab8f5a82cd6d638
+  metadata.gz: c296fb2a05dfbaed883f39d7f567706028e66d67019525caa7fdb55edaea86008786cbe4e35fa2eb359a7bae0bf79a42235b01a96ba6ccc1d66ae1e6834771fc
+  data.tar.gz: f2656590d9c4b94ff82ca5c67fd5d3b2d86c2d7437845362ed3ec100a404bea4d629743a48e52db60272cdfb840a01bf1dedb6b305cfbddd6bfca18b92441aea

data/README.md

@@ -1,19 +1,16 @@
-[![Build Status](https://travis-ci.org/killbill/killbill-client-ruby.png)](https://travis-ci.org/killbill/killbill-client-ruby)
-[![Code Climate](https://codeclimate.com/github/killbill/killbill-client-ruby.png)](https://codeclimate.com/github/killbill/killbill-client-ruby)
-
-------------------------------------------------
-| Ruby client              | Kill Bill version |
-| -----------------------: | ----------------: |
-| 0.x.y                    | 0.16.z            |
-| -----------------------: | ----------------: |
-| 1.x.y                    | 0.18.z(and 0.17.x)|
-
-
 killbill-client-ruby
 ====================
 
 Kill Bill Ruby client library.
 
+Kill Bill compatibility
+-----------------------
+
+| Client version | Kill Bill version |
+| -------------: | ----------------: |
+| 0.x.y          | 0.16.z            |
+| 1.x.y          | 0.18.z            |
+
 Installation
 ------------
 
@@ -26,7 +23,7 @@ gem install killbill-client
 Alternatively, add the dependency in your Gemfile:
 
 ```
-gem 'killbill-client', '~> 0.24'
+gem 'killbill-client', '~> 1.0'
 ```
 
 Examples

data/killbill_client.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
 
   s.rdoc_options << '--exclude' << '.'
 
-  s.add_dependency 'json', '>= 1.2.0'
+  s.add_dependency 'json', '>= 1.2.0', '< 2.0.0'
 
   s.add_development_dependency 'rake', '>= 10.0.0', '< 11.0.0'
   s.add_development_dependency 'rspec', '~> 3.4'

data/lib/killbill_client/api/net_http_adapter.rb

@@ -63,6 +63,14 @@ module KillBillClient
           "?#{pairs.join '&'}"
         end
 
+        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
+          http.use_ssl = uri.scheme == 'https'
+          http
+        end
+
         def request(method, relative_uri, options = {})
           head = headers.dup
           head.update options[:head] if options[:head]
@@ -74,7 +82,7 @@ module KillBillClient
             # 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.escape(relative_uri))
+            uri += (base_path + URI::DEFAULT_PARSER.escape(relative_uri))
           else
             uri = relative_uri
             uri = URI.parse(uri) unless uri.is_a?(URI)
@@ -140,8 +148,7 @@ module KillBillClient
             request['X-Request-Id'] = options[:request_id]
           end
 
-          http = ::Net::HTTP.new uri.host, uri.port
-          http.use_ssl = uri.scheme == 'https'
+          http = create_http_client uri, options
           net_http.each_pair { |key, value| http.send "#{key}=", value }
 
           if KillBillClient.logger

data/lib/killbill_client/models/account.rb

@@ -79,6 +79,19 @@ module KillBillClient
         updated_account.refresh(options)
       end
 
+
+      def transfer_child_credit(user = nil, reason = nil, comment = nil, options = {})
+        self.class.post "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/transferCredit",
+                                         {},
+                                         {},
+                                         {
+                                             :user    => user,
+                                             :reason  => reason,
+                                             :comment => comment,
+                                         }.merge(options)
+      end
+
+
       def bundles(options = {})
         self.class.get "#{KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/bundles",
                        {},

data/lib/killbill_client/models/bundle.rb

@@ -39,10 +39,15 @@ module KillBillClient
         end
 
         # Return the active one
-        def find_by_external_key(external_key, options = {})
-          get "#{KILLBILL_API_BUNDLES_PREFIX}?externalKey=#{external_key}",
-              {},
+        def find_by_external_key(external_key, included_deleted, options = {})
+          params = {}
+          params[:externalKey] = external_key
+          params[:includedDeleted] = included_deleted if included_deleted
+
+          result  = get "#{KILLBILL_API_BUNDLES_PREFIX}",
+              params,
               options
+          return included_deleted ? result : result[0]
         end
 
         # Return active and inactive ones

data/lib/killbill_client/models/catalog.rb

@@ -29,15 +29,21 @@ module KillBillClient
               PlanDetail
         end
 
-        def get_tenant_catalog(options = {})
+        def get_tenant_catalog(format, requested_date=nil, options = {})
 
           require_multi_tenant_options!(options, "Retrieving a catalog is only supported in multi-tenant mode")
 
+          params = {}
+          params[:requestedDate] = requested_date if requested_date
+
           get KILLBILL_API_CATALOG_PREFIX,
-              {},
+              params,
               {
-                  :head => {'Accept' => 'application/xml'},
-              }.merge(options)
+                  :head => {'Accept' => "application/#{format}"},
+                  :content_type => "application/#{format}",
+
+          }.merge(options)
+
         end
 
         def upload_tenant_catalog(catalog_xml, user = nil, reason = nil, comment = nil, options = {})
@@ -55,9 +61,24 @@ module KillBillClient
                    :reason => reason,
                    :comment => comment,
                }.merge(options)
-          get_tenant_catalog(options)
+          get_tenant_catalog('xml', nil, options)
         end
 
+
+        def add_tenant_catalog_simple_plan(simple_plan, user = nil, reason = nil, comment = nil, options = {})
+
+          require_multi_tenant_options!(options, "Uploading a catalog is only supported in multi-tenant mode")
+
+          post "#{KILLBILL_API_CATALOG_PREFIX}/simplePlan",
+               simple_plan.to_json,
+               {
+               },
+               {
+                   :user => user,
+                   :reason => reason,
+                   :comment => comment,
+               }.merge(options)
+        end
       end
     end
   end

data/lib/killbill_client/models/gen/account_attributes.rb

@@ -35,6 +35,8 @@ module KillBillClient
       attribute :email
       attribute :bill_cycle_day_local
       attribute :currency
+      attribute :parent_account_id
+      attribute :is_payment_delegated_to_parent
       attribute :payment_method_id
       attribute :time_zone
       attribute :address1
@@ -46,6 +48,7 @@ module KillBillClient
       attribute :country
       attribute :locale
       attribute :phone
+      attribute :notes
       attribute :is_migrated
       attribute :is_notified_for_invoices
       attribute :account_balance

data/lib/killbill_client/models/gen/bulk_base_subscription_and_add_ons_attributes.rb

@@ -0,0 +1,34 @@
+#############################################################################################
+#                                                                                           #
+#                   Copyright 2010-2013 Ning, Inc.                                          #
+#                   Copyright 2014 Groupon, Inc.                                            #
+#                   Copyright 2014 The Billing Project, LLC                                 #
+#                                                                                           #
+#      The Billing Project licenses this file to you under the Apache License, version 2.0  #
+#      (the "License"); you may not use this file except in compliance with the             #
+#      License.  You may obtain a copy of the License at:                                   #
+#                                                                                           #
+#          http://www.apache.org/licenses/LICENSE-2.0                                       #
+#                                                                                           #
+#      Unless required by applicable law or agreed to in writing, software                  #
+#      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT            #
+#      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the            #
+#      License for the specific language governing permissions and limitations              #
+#      under the License.                                                                   #
+#                                                                                           #
+#############################################################################################
+
+
+#
+#                       DO NOT EDIT!!!
+#    File automatically generated by killbill-java-parser (git@github.com:killbill/killbill-java-parser.git)
+#
+
+
+module KillBillClient
+  module Model
+    class BulkBaseSubscriptionAndAddOnsAttributes < Resource
+      attribute :base_entitlement_and_add_ons
+    end
+  end
+end

data/lib/killbill_client/models/gen/invoice_attributes.rb

@@ -30,6 +30,7 @@ module KillBillClient
     class InvoiceAttributes < Resource
       attribute :amount
       attribute :currency
+      attribute :status
       attribute :credit_adj
       attribute :refund_adj
       attribute :invoice_id
@@ -41,6 +42,7 @@ module KillBillClient
       attribute :external_bundle_keys
       attribute :credits
       attribute :items
+      attribute :is_parent_invoice
       attribute :audit_logs
     end
   end

data/lib/killbill_client/models/gen/invoice_item_attributes.rb

@@ -32,6 +32,7 @@ module KillBillClient
       attribute :invoice_id
       attribute :linked_invoice_item_id
       attribute :account_id
+      attribute :child_account_id
       attribute :bundle_id
       attribute :subscription_id
       attribute :plan_name
@@ -43,6 +44,7 @@ module KillBillClient
       attribute :end_date
       attribute :amount
       attribute :currency
+      attribute :child_items
       attribute :audit_logs
     end
   end

data/lib/killbill_client/models/gen/invoice_payment_attributes.rb

@@ -41,6 +41,7 @@ module KillBillClient
       attribute :currency
       attribute :payment_method_id
       attribute :transactions
+      attribute :payment_attempts
       attribute :audit_logs
     end
   end

data/lib/killbill_client/models/gen/limit_attributes.rb

@@ -0,0 +1,36 @@
+#############################################################################################
+#                                                                                           #
+#                   Copyright 2010-2013 Ning, Inc.                                          #
+#                   Copyright 2014 Groupon, Inc.                                            #
+#                   Copyright 2014 The Billing Project, LLC                                 #
+#                                                                                           #
+#      The Billing Project licenses this file to you under the Apache License, version 2.0  #
+#      (the "License"); you may not use this file except in compliance with the             #
+#      License.  You may obtain a copy of the License at:                                   #
+#                                                                                           #
+#          http://www.apache.org/licenses/LICENSE-2.0                                       #
+#                                                                                           #
+#      Unless required by applicable law or agreed to in writing, software                  #
+#      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT            #
+#      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the            #
+#      License for the specific language governing permissions and limitations              #
+#      under the License.                                                                   #
+#                                                                                           #
+#############################################################################################
+
+
+#
+#                       DO NOT EDIT!!!
+#    File automatically generated by killbill-java-parser (git@github.com:killbill/killbill-java-parser.git)
+#
+
+
+module KillBillClient
+  module Model
+    class LimitAttributes < Resource
+      attribute :unit
+      attribute :max
+      attribute :min
+    end
+  end
+end

data/lib/killbill_client/models/gen/overdue_attributes.rb

@@ -0,0 +1,35 @@
+#############################################################################################
+#                                                                                           #
+#                   Copyright 2010-2013 Ning, Inc.                                          #
+#                   Copyright 2014 Groupon, Inc.                                            #
+#                   Copyright 2014 The Billing Project, LLC                                 #
+#                                                                                           #
+#      The Billing Project licenses this file to you under the Apache License, version 2.0  #
+#      (the "License"); you may not use this file except in compliance with the             #
+#      License.  You may obtain a copy of the License at:                                   #
+#                                                                                           #
+#          http://www.apache.org/licenses/LICENSE-2.0                                       #
+#                                                                                           #
+#      Unless required by applicable law or agreed to in writing, software                  #
+#      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT            #
+#      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the            #
+#      License for the specific language governing permissions and limitations              #
+#      under the License.                                                                   #
+#                                                                                           #
+#############################################################################################
+
+
+#
+#                       DO NOT EDIT!!!
+#    File automatically generated by killbill-java-parser (git@github.com:killbill/killbill-java-parser.git)
+#
+
+
+module KillBillClient
+  module Model
+    class OverdueAttributes < Resource
+      attribute :initial_reevaluation_interval
+      attribute :overdue_states
+    end
+  end
+end

data/lib/killbill_client/models/gen/overdue_condition_attributes.rb

@@ -0,0 +1,39 @@
+#############################################################################################
+#                                                                                           #
+#                   Copyright 2010-2013 Ning, Inc.                                          #
+#                   Copyright 2014 Groupon, Inc.                                            #
+#                   Copyright 2014 The Billing Project, LLC                                 #
+#                                                                                           #
+#      The Billing Project licenses this file to you under the Apache License, version 2.0  #
+#      (the "License"); you may not use this file except in compliance with the             #
+#      License.  You may obtain a copy of the License at:                                   #
+#                                                                                           #
+#          http://www.apache.org/licenses/LICENSE-2.0                                       #
+#                                                                                           #
+#      Unless required by applicable law or agreed to in writing, software                  #
+#      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT            #
+#      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the            #
+#      License for the specific language governing permissions and limitations              #
+#      under the License.                                                                   #
+#                                                                                           #
+#############################################################################################
+
+
+#
+#                       DO NOT EDIT!!!
+#    File automatically generated by killbill-java-parser (git@github.com:killbill/killbill-java-parser.git)
+#
+
+
+module KillBillClient
+  module Model
+    class OverdueConditionAttributes < Resource
+      attribute :time_since_earliest_unpaid_invoice_equals_or_exceeds
+      attribute :control_tag_inclusion
+      attribute :control_tag_exclusion
+      attribute :number_of_unpaid_invoices_equals_or_exceeds
+      attribute :response_for_last_failed_payment
+      attribute :total_unpaid_invoice_balance_equals_or_exceeds
+    end
+  end
+end

data/lib/killbill_client/models/gen/overdue_state_config_attributes.rb

@@ -0,0 +1,41 @@
+#############################################################################################
+#                                                                                           #
+#                   Copyright 2010-2013 Ning, Inc.                                          #
+#                   Copyright 2014 Groupon, Inc.                                            #
+#                   Copyright 2014 The Billing Project, LLC                                 #
+#                                                                                           #
+#      The Billing Project licenses this file to you under the Apache License, version 2.0  #
+#      (the "License"); you may not use this file except in compliance with the             #
+#      License.  You may obtain a copy of the License at:                                   #
+#                                                                                           #
+#          http://www.apache.org/licenses/LICENSE-2.0                                       #
+#                                                                                           #
+#      Unless required by applicable law or agreed to in writing, software                  #
+#      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT            #
+#      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the            #
+#      License for the specific language governing permissions and limitations              #
+#      under the License.                                                                   #
+#                                                                                           #
+#############################################################################################
+
+
+#
+#                       DO NOT EDIT!!!
+#    File automatically generated by killbill-java-parser (git@github.com:killbill/killbill-java-parser.git)
+#
+
+
+module KillBillClient
+  module Model
+    class OverdueStateConfigAttributes < Resource
+      attribute :name
+      attribute :is_clear_state
+      attribute :condition
+      attribute :external_message
+      attribute :block_changes
+      attribute :disable_entitlement
+      attribute :subscription_cancellation_policy
+      attribute :auto_reevaluation_interval_days
+    end
+  end
+end

data/lib/killbill_client/models/gen/payment_attempt_attributes.rb

@@ -0,0 +1,46 @@
+#############################################################################################
+#                                                                                           #
+#                   Copyright 2010-2013 Ning, Inc.                                          #
+#                   Copyright 2014 Groupon, Inc.                                            #
+#                   Copyright 2014 The Billing Project, LLC                                 #
+#                                                                                           #
+#      The Billing Project licenses this file to you under the Apache License, version 2.0  #
+#      (the "License"); you may not use this file except in compliance with the             #
+#      License.  You may obtain a copy of the License at:                                   #
+#                                                                                           #
+#          http://www.apache.org/licenses/LICENSE-2.0                                       #
+#                                                                                           #
+#      Unless required by applicable law or agreed to in writing, software                  #
+#      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT            #
+#      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the            #
+#      License for the specific language governing permissions and limitations              #
+#      under the License.                                                                   #
+#                                                                                           #
+#############################################################################################
+
+
+#
+#                       DO NOT EDIT!!!
+#    File automatically generated by killbill-java-parser (git@github.com:killbill/killbill-java-parser.git)
+#
+
+
+module KillBillClient
+  module Model
+    class PaymentAttemptAttributes < Resource
+      attribute :account_id
+      attribute :payment_method_id
+      attribute :payment_external_key
+      attribute :transaction_id
+      attribute :transaction_external_key
+      attribute :transaction_type
+      attribute :effective_date
+      attribute :state_name
+      attribute :amount
+      attribute :currency
+      attribute :plugin_name
+      attribute :plugin_properties
+      attribute :audit_logs
+    end
+  end
+end