killbill-client 0.7.2 → 0.7.3

data/lib/killbill_client/models/invoice_payment.rb

@@ -0,0 +1,67 @@
+module KillBillClient
+  module Model
+    class InvoicePayment < InvoicePaymentAttributes
+      KILLBILL_API_INVOICE_PAYMENTS_PREFIX = "#{KILLBILL_API_PREFIX}/invoicePayments"
+
+      has_many :transactions, KillBillClient::Model::Transaction
+      has_many :audit_logs, KillBillClient::Model::AuditLog
+
+      class << self
+        def find_by_id(payment_id, with_plugin_info = false, options = {})
+          get "#{KILLBILL_API_INVOICE_PAYMENTS_PREFIX}/#{payment_id}",
+              {
+                  :withPluginInfo => with_plugin_info
+              },
+              options
+        end
+
+        def refund(payment_id, amount, adjustments = nil, user = nil, reason = nil, comment = nil, options = {})
+          payload             = InvoicePaymentTransactionAttributes.new
+          payload.amount      = amount
+          payload.is_adjusted = !adjustments.nil?
+          payload.adjustments = adjustments
+
+          invoice_payment = post "#{KILLBILL_API_INVOICE_PAYMENTS_PREFIX}/#{payment_id}/refunds",
+                                 payload.to_json,
+                                 {},
+                                 {
+                                     :user    => user,
+                                     :reason  => reason,
+                                     :comment => comment,
+                                 }.merge(options)
+
+          invoice_payment.refresh(options)
+        end
+      end
+
+      def create(external_payment = false, user = nil, reason = nil, comment = nil, options = {})
+        created_invoice_payment = self.class.post "#{Invoice::KILLBILL_API_INVOICES_PREFIX}/#{target_invoice_id}/payments",
+                                                  to_json,
+                                                  {
+                                                      :externalPayment => external_payment
+                                                  },
+                                                  {
+                                                      :user    => user,
+                                                      :reason  => reason,
+                                                      :comment => comment,
+                                                  }.merge(options)
+        created_invoice_payment.refresh(options)
+      end
+
+      def bulk_create(external_payment = false, user = nil, reason = nil, comment = nil, options = {})
+        # Nothing to return (nil)
+        self.class.post "#{Account::KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/invoicePayments",
+                        {},
+                        {
+                            :externalPayment => external_payment,
+                            :paymentAmount   => purchased_amount
+                        },
+                        {
+                            :user    => user,
+                            :reason  => reason,
+                            :comment => comment,
+                        }.merge(options)
+      end
+    end
+  end
+end

data/lib/killbill_client/models/models.rb

@@ -3,17 +3,25 @@ require 'killbill_client/models/resources'
 
 require 'killbill_client/models/gen/require_gen'
 
+require 'killbill_client/models/helpers/tag_helper'
+require 'killbill_client/models/helpers/custom_field_helper'
+
 require 'killbill_client/models/audit_log'
 require 'killbill_client/models/event_subscription'
+require 'killbill_client/models/phase'
+require 'killbill_client/models/plan'
+require 'killbill_client/models/plan_detail'
+require 'killbill_client/models/product'
+require 'killbill_client/models/catalog'
 require 'killbill_client/models/credit'
 require 'killbill_client/models/invoice_item'
-require 'killbill_client/models/chargeback'
 require 'killbill_client/models/custom_field'
 require 'killbill_client/models/subscription'
 require 'killbill_client/models/bundle'
-require 'killbill_client/models/refund'
 require 'killbill_client/models/account'
 require 'killbill_client/models/invoice'
+require 'killbill_client/models/transaction'
+require 'killbill_client/models/invoice_payment'
 require 'killbill_client/models/payment'
 require 'killbill_client/models/payment_method'
 require 'killbill_client/models/security'

data/lib/killbill_client/models/payment.rb

@@ -3,26 +3,13 @@ module KillBillClient
     class Payment < PaymentAttributes
       KILLBILL_API_PAYMENTS_PREFIX = "#{KILLBILL_API_PREFIX}/payments"
 
-      has_many :refunds, KillBillClient::Model::Refund
-      has_many :chargebacks, KillBillClient::Model::Chargeback
+      has_many :transactions, KillBillClient::Model::Transaction
       has_many :audit_logs, KillBillClient::Model::AuditLog
 
-      create_alias :bundle_keys, :external_bundle_keys
-
       class << self
-        def find_by_id(payment_id, with_refunds_and_chargebacks = false, options = {})
+        def find_by_id(payment_id, options = {})
           get "#{KILLBILL_API_PAYMENTS_PREFIX}/#{payment_id}",
-              {
-                  :withRefundsAndChargebacks => with_refunds_and_chargebacks
-              },
-              options
-        end
-
-        def find_all_by_invoice_id(invoice_id, with_refunds_and_chargebacks = false, options = {})
-          get "#{Invoice::KILLBILL_API_INVOICES_PREFIX}/#{invoice_id}/payments",
-              {
-                  :withRefundsAndChargebacks => with_refunds_and_chargebacks
-              },
+              {},
               options
         end
 
@@ -30,7 +17,7 @@ module KillBillClient
           get "#{KILLBILL_API_PAYMENTS_PREFIX}/#{Resource::KILLBILL_API_PAGINATION_PREFIX}",
               {
                   :offset => offset,
-                  :limit => limit
+                  :limit  => limit
               },
               options
         end
@@ -39,25 +26,11 @@ module KillBillClient
           get "#{KILLBILL_API_PAYMENTS_PREFIX}/search/#{search_key}",
               {
                   :offset => offset,
-                  :limit => limit
+                  :limit  => limit
               },
               options
         end
       end
-
-      def create(external_payment = false, user = nil, reason = nil, comment = nil, options = {})
-        # Nothing to return (nil)
-        self.class.post "#{Account::KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/payments",
-                        to_json,
-                        {
-                            :externalPayment => external_payment
-                        },
-                        {
-                            :user => user,
-                            :reason => reason,
-                            :comment => comment,
-                        }.merge(options)
-      end
     end
   end
 end

data/lib/killbill_client/models/payment_method.rb

@@ -53,6 +53,7 @@ module KillBillClient
 
         def destroy(payment_method_id, set_auto_pay_off = false, user = nil, reason = nil, comment = nil, options = {})
           delete "#{KILLBILL_API_PAYMENT_METHODS_PREFIX}/#{payment_method_id}",
+                 {},
                  {
                      :deleteDefaultPmWithAutoPayOff => set_auto_pay_off
                  },
@@ -64,11 +65,11 @@ module KillBillClient
         end
       end
 
-      def create(set_default = true, user = nil, reason = nil, comment = nil, options = {})
+      def create(user = nil, reason = nil, comment = nil, options = {})
         created_pm = self.class.post "#{Account::KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/paymentMethods",
                                      to_json,
                                      {
-                                         :isDefault => set_default
+                                         :isDefault => is_default
                                      },
                                      {
                                          :user => user,
@@ -87,12 +88,10 @@ module KillBillClient
         @plugin_info.properties = []
         return if info.nil?
 
-        info.each { |k, v| @plugin_info.send("#{Utils.underscore k}=", v) unless k == 'properties' }
-
         if info['properties'].nil?
           # Convenience method to create properties to add a payment method
           info.each do |key, value|
-            property = PaymentMethodProperties.new
+            property = PluginPropertyAttributes.new
             property.key = key
             property.value = value
             property.is_updatable = false
@@ -101,7 +100,7 @@ module KillBillClient
         else
           # De-serialization from JSON payload
           info['properties'].each do |property_json|
-            property = PaymentMethodProperties.new
+            property = PluginPropertyAttributes.new
             property.key = property_json['key']
             property.value = property_json['value']
             property.is_updatable = property_json['isUpdatable']

data/lib/killbill_client/models/phase.rb

@@ -0,0 +1,9 @@
+module KillBillClient
+  module Model
+    class Phase < PhaseAttributes
+
+      has_many :prices, KillBillClient::Model::PriceAttributes
+
+    end
+  end
+end

data/lib/killbill_client/models/plan.rb

@@ -0,0 +1,9 @@
+module KillBillClient
+  module Model
+    class Plan < PlanAttributes
+
+      has_many :phases, KillBillClient::Model::Phase
+
+    end
+  end
+end

data/lib/killbill_client/models/plan_detail.rb

@@ -0,0 +1,9 @@
+module KillBillClient
+  module Model
+    class PlanDetail < PlanDetailAttributes
+
+      has_many :prices, KillBillClient::Model::PriceAttributes
+
+    end
+  end
+end

data/lib/killbill_client/models/product.rb

@@ -0,0 +1,9 @@
+module KillBillClient
+  module Model
+    class Product < ProductAttributes
+
+      has_many :plans, KillBillClient::Model::Plan
+
+    end
+  end
+end

data/lib/killbill_client/models/resource.rb

@@ -14,6 +14,15 @@ module KillBillClient
 
       @@attribute_names = {}
 
+      def initialize(hash = nil)
+        # Make sure we support ActiveSupport::HashWithIndifferentAccess for Kaui
+        if hash.respond_to?(:each)
+          hash.each do |key,value|
+            send("#{Utils.underscore key.to_s}=", value)
+          end
+        end
+      end
+
       class << self
         def head(uri, params = {}, options = {}, clazz = self)
           response = KillBillClient::API.head uri, params, options
@@ -35,8 +44,8 @@ module KillBillClient
           from_response clazz, response
         end
 
-        def delete(uri, params = {}, options = {}, clazz = self)
-          response = KillBillClient::API.delete uri, params, options
+        def delete(uri, body = nil, params = {}, options = {}, clazz = self)
+          response = KillBillClient::API.delete uri, body, params, options
           from_response clazz, response
         end
 
@@ -49,6 +58,7 @@ module KillBillClient
         def from_response(resource_class, response)
           case response['Content-Type']
           when %r{application/pdf}
+          when %r{text/html}
             response.body
           when %r{application/json}
             record = from_json resource_class, response.body
@@ -105,7 +115,13 @@ module KillBillClient
 
           data.each do |name, value|
             name = Utils.underscore name
-            attr_desc = @@attribute_names[record.class.name][name.to_sym] rescue nil
+            attr_desc = nil
+
+            # Allow for inheritance. TODO What's the performance hit?
+            resource_class.ancestors.each do |ancestor|
+              attr_desc = @@attribute_names[ancestor.name][name.to_sym] rescue nil
+              break unless attr_desc.nil?
+            end
 
             unless attr_desc.nil?
               type = attr_desc[:type]
@@ -124,7 +140,8 @@ module KillBillClient
               end
             end #end unless attr_desc.nil? or data_elem.blank?
 
-            record.send("#{Utils.underscore name}=", value )
+            # TODO Be lenient for now to support different API formats
+            record.send("#{Utils.underscore name}=", value) rescue nil
 
           end #end data.each
 
@@ -230,6 +247,6 @@ module KillBillClient
        def hash
          to_hash.hash
        end
-     end
+    end
    end
  end

data/lib/killbill_client/models/subscription.rb

@@ -21,8 +21,8 @@ module KillBillClient
                                               to_json,
                                               {},
                                               {
-                                                  :user => user,
-                                                  :reason => reason,
+                                                  :user    => user,
+                                                  :reason  => reason,
                                                   :comment => comment,
                                               }.merge(options)
         created_entitlement.refresh(options)
@@ -37,19 +37,19 @@ module KillBillClient
       # @ call_completion : whether the call should wait for invoice/payment to be completed before calls return
       #
       def change_plan(input, user = nil, reason = nil, comment = nil,
-          requested_date = nil, billing_policy = nil, call_completion = false, options = {})
+                      requested_date = nil, billing_policy = nil, call_completion = false, options = {})
 
-        params = {}
+        params                  = {}
         params[:callCompletion] = call_completion
-        params[:requestedDate] = requested_date unless requested_date.nil?
-        params[:billingPolicy] = billing_policy unless billing_policy.nil?
+        params[:requestedDate]  = requested_date unless requested_date.nil?
+        params[:billingPolicy]  = billing_policy unless billing_policy.nil?
 
         return self.class.put "#{KILLBILL_API_ENTITLEMENT_PREFIX}/#{@subscription_id}",
                               input.to_json,
                               params,
                               {
-                                  :user => user,
-                                  :reason => reason,
+                                  :user    => user,
+                                  :reason  => reason,
                                   :comment => comment,
                               }.merge(options)
       end
@@ -61,37 +61,35 @@ module KillBillClient
       # @billing_policy : the override for the billing policy {END_OF_TERM, IMMEDIATE}
       #
       def cancel(user = nil, reason = nil, comment = nil, requested_date = nil, entitlementPolicy = nil, billing_policy = nil, use_requested_date_for_billing = nil, options = {})
-
-        params = {}
-        params[:requestedDate] = requested_date unless requested_date.nil?
-        params[:billingPolicy] = billing_policy unless billing_policy.nil?
-        params[:entitlementPolicy] = entitlementPolicy unless entitlementPolicy.nil?
+        params                              = {}
+        params[:requestedDate]              = requested_date unless requested_date.nil?
+        params[:billingPolicy]              = billing_policy unless billing_policy.nil?
+        params[:entitlementPolicy]          = entitlementPolicy unless entitlementPolicy.nil?
         params[:useRequestedDateForBilling] = use_requested_date_for_billing unless use_requested_date_for_billing.nil?
 
-        return self.class.delete "#{KILLBILL_API_ENTITLEMENT_PREFIX}/#{@subscription_id}",
-                                 params,
-                                 {
-                                     :user => user,
-                                     :reason => reason,
-                                     :comment => comment,
-                                 }.merge(options)
+        self.class.delete "#{KILLBILL_API_ENTITLEMENT_PREFIX}/#{subscription_id}",
+                          {},
+                          params,
+                          {
+                              :user    => user,
+                              :reason  => reason,
+                              :comment => comment,
+                          }.merge(options)
       end
 
       #
       # Uncancel a future cancelled entitlement
       #
-      #
       def uncancel(user = nil, reason = nil, comment = nil, options = {})
-
         params = {}
-        return self.class.put "#{KILLBILL_API_ENTITLEMENT_PREFIX}/#{@subscription_id}/uncancel",
-                                 nil,
-                                 params,
-                                 {
-                                     :user => user,
-                                     :reason => reason,
-                                     :comment => comment,
-                                 }.merge(options)
+        self.class.put "#{KILLBILL_API_ENTITLEMENT_PREFIX}/#{subscription_id}/uncancel",
+                       nil,
+                       params,
+                       {
+                           :user    => user,
+                           :reason  => reason,
+                           :comment => comment,
+                       }.merge(options)
       end
 
     end

data/lib/killbill_client/models/tag.rb

@@ -1,25 +1,17 @@
 module KillBillClient
   module Model
     class Tag < TagAttributes
+
       KILLBILL_API_TAGS_PREFIX = "#{KILLBILL_API_PREFIX}/tags"
 
       has_many :audit_logs, KillBillClient::Model::AuditLog
 
       class << self
-        def find_all_by_account_id(account_id, included_deleted = false, audit = "NONE", options = {})
-          get "#{Account::KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/tags",
-              {
-                  :includedDeleted => included_deleted,
-                  :audit => audit
-              },
-              options
-        end
-
         def find_in_batches(offset = 0, limit = 100, options = {})
           get "#{KILLBILL_API_TAGS_PREFIX}/#{Resource::KILLBILL_API_PAGINATION_PREFIX}",
               {
                   :offset => offset,
-                  :limit => limit
+                  :limit  => limit
               },
               options
         end
@@ -28,11 +20,15 @@ module KillBillClient
           get "#{KILLBILL_API_TAGS_PREFIX}/search/#{search_key}",
               {
                   :offset => offset,
-                  :limit => limit
+                  :limit  => limit
               },
               options
         end
       end
+
+      def <=>(tag)
+        tag_definition_name.downcase <=> tag.tag_definition_name.downcase
+      end
     end
   end
 end

data/lib/killbill_client/models/tag_definition.rb

@@ -4,14 +4,24 @@ module KillBillClient
       KILLBILL_API_TAG_DEFINITIONS_PREFIX = "#{KILLBILL_API_PREFIX}/tagDefinitions"
 
       class << self
-        def all(options = {})
+        def all(audit = 'NONE', options = {})
           get KILLBILL_API_TAG_DEFINITIONS_PREFIX,
-              {},
+              {
+                  :audit => audit
+              },
               options
         end
 
-        def find_by_name(name, options = {})
-          self.all(options).select { |tag_definition| tag_definition.name == name }.first
+        def find_by_id(id, audit = 'NONE', options = {})
+          get "#{KILLBILL_API_TAG_DEFINITIONS_PREFIX}/#{id}",
+              {
+                  :audit => audit
+              },
+              options
+        end
+
+        def find_by_name(name, audit = 'NONE', options = {})
+          self.all(audit, options).select { |tag_definition| tag_definition.name == name }.first
         end
       end
 
@@ -20,12 +30,23 @@ module KillBillClient
                                                  to_json,
                                                  {},
                                                  {
-                                                     :user => user,
-                                                     :reason => reason,
+                                                     :user    => user,
+                                                     :reason  => reason,
                                                      :comment => comment,
                                                  }.merge(options)
         created_tag_definition.refresh(options)
       end
+
+      def delete(user = nil, reason = nil, comment = nil, options = {})
+        self.class.delete "#{KILLBILL_API_TAG_DEFINITIONS_PREFIX}/#{id}",
+                          to_json,
+                          {},
+                          {
+                              :user    => user,
+                              :reason  => reason,
+                              :comment => comment,
+                          }.merge(options)
+      end
     end
   end
 end

data/lib/killbill_client/models/transaction.rb

@@ -0,0 +1,104 @@
+module KillBillClient
+  module Model
+    class Transaction < PaymentTransactionAttributes
+
+      has_many :audit_logs, KillBillClient::Model::AuditLog
+
+      def auth(account_id, payment_method_id = nil, user = nil, reason = nil, comment = nil, options = {})
+        query_map                   = {}
+        query_map[:paymentMethodId] = payment_method_id unless payment_method_id.nil?
+
+        @transaction_type   = 'AUTHORIZE'
+        created_transaction = self.class.post "#{Account::KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/payments",
+                                              to_json,
+                                              query_map,
+                                              {
+                                                  :user    => user,
+                                                  :reason  => reason,
+                                                  :comment => comment,
+                                              }.merge(options)
+        created_transaction.refresh(options, Payment)
+      end
+
+      def purchase(account_id, payment_method_id = nil, user = nil, reason = nil, comment = nil, options = {})
+        query_map                   = {}
+        query_map[:paymentMethodId] = payment_method_id unless payment_method_id.nil?
+
+        @transaction_type   = 'PURCHASE'
+        created_transaction = self.class.post "#{Account::KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/payments",
+                                              to_json,
+                                              query_map,
+                                              {
+                                                  :user    => user,
+                                                  :reason  => reason,
+                                                  :comment => comment,
+                                              }.merge(options)
+        created_transaction.refresh(options, Payment)
+      end
+
+      def credit(account_id, payment_method_id = nil, user = nil, reason = nil, comment = nil, options = {})
+        query_map                   = {}
+        query_map[:paymentMethodId] = payment_method_id unless payment_method_id.nil?
+
+        @transaction_type   = 'CREDIT'
+        created_transaction = self.class.post "#{Account::KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/payments",
+                                              to_json,
+                                              query_map,
+                                              {
+                                                  :user    => user,
+                                                  :reason  => reason,
+                                                  :comment => comment,
+                                              }.merge(options)
+        created_transaction.refresh(options, Payment)
+      end
+
+      def capture(user = nil, reason = nil, comment = nil, options = {})
+        created_transaction = self.class.post "#{Payment::KILLBILL_API_PAYMENTS_PREFIX}/#{payment_id}",
+                                              to_json,
+                                              {},
+                                              {
+                                                  :user    => user,
+                                                  :reason  => reason,
+                                                  :comment => comment,
+                                              }.merge(options)
+        created_transaction.refresh(options, Payment)
+      end
+
+      def refund(user = nil, reason = nil, comment = nil, options = {})
+        created_transaction = self.class.post "#{Payment::KILLBILL_API_PAYMENTS_PREFIX}/#{payment_id}/refunds",
+                                              to_json,
+                                              {},
+                                              {
+                                                  :user    => user,
+                                                  :reason  => reason,
+                                                  :comment => comment,
+                                              }.merge(options)
+        created_transaction.refresh(options, Payment)
+      end
+
+      def void(user = nil, reason = nil, comment = nil, options = {})
+        created_transaction = self.class.delete "#{Payment::KILLBILL_API_PAYMENTS_PREFIX}/#{payment_id}",
+                                                to_json,
+                                                {},
+                                                {
+                                                    :user    => user,
+                                                    :reason  => reason,
+                                                    :comment => comment,
+                                                }.merge(options)
+        created_transaction.refresh(options, Payment)
+      end
+
+      def chargeback(user = nil, reason = nil, comment = nil, options = {})
+        created_transaction = self.class.post "#{Payment::KILLBILL_API_PAYMENTS_PREFIX}/#{payment_id}/chargebacks",
+                                              to_json,
+                                              {},
+                                              {
+                                                  :user    => user,
+                                                  :reason  => reason,
+                                                  :comment => comment,
+                                              }.merge(options)
+        created_transaction.refresh(options, Payment)
+      end
+    end
+  end
+end

data/lib/killbill_client/version.rb

@@ -2,7 +2,7 @@ module KillBillClient
   module Version
     MAJOR = 0
     MINOR = 7
-    PATCH = 2
+    PATCH = 3
     PRE = nil
 
     VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join('.').freeze

data/spec/killbill_client/remote/api_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe KillBillClient::API do
-  it 'should get all tag definitions' do
+  it 'should get all tag definitions', :integration => true  do
     response = KillBillClient::API.get '/1.0/kb/tagDefinitions'
     response.code.to_i.should == 200
     tag_definitions = KillBillClient::Model::Resource.from_response KillBillClient::Model::TagDefinition, response