killbill-client 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fb152afe9243696fea3189a25c5639ada554316
-  data.tar.gz: 9b0a59633af847621e851625b644e8848a6d7e0d
+  metadata.gz: 7fa054d6429ec8d29d211fe1d581ecd3e1cb8f90
+  data.tar.gz: 9658639f68539f0f6d7ea5d77b96027e3485045d
 SHA512:
-  metadata.gz: 919cc47a13b3a8b4cfe9ff8fe4a8bdd17d91b7f09f46a570e2ea20d0a135fabcc7055eb929298a6bd6df12f84b774393e25f13d5a76136f22632a34a3cf92a75
-  data.tar.gz: 29cdf321a9355f641ad1994c3f2e1fd6442c4e025125819d40a5a88b9a15203a104c38f23b05d63fd978cabcabb94e138774b68eb22c9a1dd185e59b08681ac2
+  metadata.gz: 058d93cbc47043cfbaa068f1c15e09ff1c48386768b2af5d85d8a9e903d914d8040feaefe4fbf1b510deeb63e000a2d638a42cab10085f513ada53d90b9f3ecb
+  data.tar.gz: aad960ae930ae5057c3c4b3a1a9a0dd87737dafbd588e8572bd5beee1b2e70a1d14954f2f2a681f1d48583b3ecaeb1df50dfec882be72829af89745b757ba41b

data/lib/killbill_client/api/net_http_adapter.rb

@@ -50,6 +50,8 @@ module KillBillClient
           # Configure auth, if enabled
           if KillBillClient.api_key and KillBillClient.api_secret
             request.basic_auth(*[KillBillClient.api_key, KillBillClient.api_secret].flatten[0, 2])
+            request['X-Killbill-ApiKey'] = KillBillClient.api_key
+            request['X-Killbill-ApiSecret'] = KillBillClient.api_secret
           end
 
           if options[:body]

data/lib/killbill_client/models/account_timeline.rb

@@ -0,0 +1,20 @@
+module KillBillClient
+  module Model
+    class AccountTimeline < AccountTimelineAttributes
+
+      has_one :account, KillBillClient::Model::Account
+      has_many :payments, KillBillClient::Model::Payment
+      has_many :bundles, KillBillClient::Model::Bundle
+      has_many :invoices, KillBillClient::Model::Invoice
+
+      class << self
+        def find_by_account_id(account_id, audit = 'MINIMAL')
+          get "#{Account::KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/timeline",
+              {
+                :audit => audit
+              }
+        end
+      end
+    end
+  end
+end

data/lib/killbill_client/models/audit_log.rb

@@ -0,0 +1,6 @@
+module KillBillClient
+  module Model
+    class AuditLog < AuditLogAttributes
+    end
+  end
+end

data/lib/killbill_client/models/bundle.rb

@@ -0,0 +1,10 @@
+module KillBillClient
+  module Model
+    class Bundle < BundleAttributesSimple
+      has_many :subscriptions, KillBillClient::Model::SubscriptionEvent
+      has_many :audit_logs, KillBillClient::Model::AuditLog
+    end
+  end
+end
+
+

data/lib/killbill_client/models/chargeback.rb

@@ -0,0 +1,7 @@
+module KillBillClient
+  module Model
+    class Chargeback < ChargebackAttributes
+      has_many :audit_logs, KillBillClient::Model::AuditLog
+    end
+  end
+end

data/lib/killbill_client/models/credit.rb

@@ -0,0 +1,7 @@
+module KillBillClient
+  module Model
+    class Credit < CreditAttributes
+      has_many :audit_logs, KillBillClient::Model::AuditLog      
+    end
+  end
+end

data/lib/killbill_client/models/event.rb

@@ -0,0 +1,10 @@
+module KillBillClient
+  module Model
+    class Event < SubscriptionReadEventAttributes
+      has_many :audit_logs, KillBillClient::Model::AuditLog
+
+      create_alias :requested_date, :requested_dt
+      create_alias :effective_date, :effective_dt
+    end
+  end
+end

data/lib/killbill_client/models/invoice.rb

@@ -1,7 +1,22 @@
 module KillBillClient
   module Model
-    class Invoice < InvoiceAttributesSimple
+    class Invoice < InvoiceAttributesWithBundleKeys
       KILLBILL_API_INVOICES_PREFIX = "#{KILLBILL_API_PREFIX}/invoices"
+
+      has_many :audit_logs, KillBillClient::Model::AuditLog
+      has_many :items, KillBillClient::Model::InvoiceItem
+      has_many :credits, KillBillClient::Model::Credit
+
+      create_alias :bundle_keys, :external_bundle_keys
+
+      class << self
+        def find_by_id_or_number(id_or_number, with_items = true)
+          get "#{KILLBILL_API_INVOICES_PREFIX}/#{id_or_number}",
+              {
+                :withItems => with_items
+              }
+        end
+      end
     end
   end
 end

data/lib/killbill_client/models/models.rb

@@ -2,13 +2,23 @@ require 'killbill_client/models/resource'
 
 require 'killbill_client/models/gen/require_gen'
 
+require 'killbill_client/models/audit_log'
+require 'killbill_client/models/event'
+require 'killbill_client/models/credit'
+require 'killbill_client/models/invoice_item'
+require 'killbill_client/models/subscription_deleted_event'
+require 'killbill_client/models/subscription_new_event'
+require 'killbill_client/models/chargeback'
+require 'killbill_client/models/subscription_event'
+require 'killbill_client/models/bundle'
+require 'killbill_client/models/refund'
 require 'killbill_client/models/account'
 require 'killbill_client/models/invoice'
-require 'killbill_client/models/invoice_item'
 require 'killbill_client/models/payment'
 require 'killbill_client/models/payment_method'
 require 'killbill_client/models/tag'
 require 'killbill_client/models/tag_definition'
+require 'killbill_client/models/account_timeline'
 
 module KillBillClient
   module Model

data/lib/killbill_client/models/payment.rb

@@ -1,6 +1,11 @@
 module KillBillClient
   module Model
-    class Payment < PaymentAttributesSimple
+    class Payment < PaymentAttributesWithBundleKeys
+      has_many :refunds, KillBillClient::Model::Refund
+      has_many :chargebacks, KillBillClient::Model::Chargeback
+      has_many :audit_logs, KillBillClient::Model::AuditLog
+
+      create_alias :bundle_keys, :external_bundle_keys
     end
   end
 end

data/lib/killbill_client/models/payment_method.rb

@@ -18,6 +18,13 @@ module KillBillClient
               }
         end
 
+        def find_all_by_search_key(search_key, with_plugin_info = false)
+          get "#{KILLBILL_API_PAYMENT_METHODS_PREFIX}/search/#{search_key}",
+              {
+                  :withPluginInfo => with_plugin_info
+              }
+        end
+
         def set_default(payment_method_id, account_id, user = nil, reason = nil, comment = nil)
           put "#{Account::KILLBILL_API_ACCOUNTS_PREFIX}/#{account_id}/paymentMethods/#{payment_method_id}/setDefault",
               nil,

data/lib/killbill_client/models/refund.rb

@@ -0,0 +1,8 @@
+module KillBillClient
+  module Model
+    class Refund < RefundAttributes
+      has_many :audit_logs, KillBillClient::Model::AuditLog
+      has_many :adjustments, KillBillClient::Model::InvoiceItem
+    end
+  end
+end

data/lib/killbill_client/models/resource.rb

@@ -5,6 +5,7 @@ module KillBillClient
     class Resource
 
       KILLBILL_API_PREFIX = '/1.0/kb/'
+      @@attribute_names = {}
 
       class << self
         def head(uri, params = {}, options = {}, clazz = self)
@@ -40,14 +41,14 @@ module KillBillClient
         # @param response [Net::HTTPResponse]
         def from_response(resource_class, response)
           case response['Content-Type']
-            when %r{application/pdf}
-              response.body
-            when %r{application/json}
-              record = from_json resource_class, response.body
-              record.instance_eval { @etag, @response = response['ETag'], response }
-              record
-            else
-              raise ArgumentError, "#{response['Content-Type']} is not supported by the library"
+          when %r{application/pdf}
+            response.body
+          when %r{application/json}
+            record = from_json resource_class, response.body
+            record.instance_eval { @etag, @response = response['ETag'], response }
+            record
+          else
+            raise ArgumentError, "#{response['Content-Type']} is not supported by the library"
           end
         end
 
@@ -60,8 +61,8 @@ module KillBillClient
         def from_json(resource_class, json)
           # e.g. DELETE
           return nil if json.nil? or json.size == 0
-
           data = JSON.parse json
+
           if data.is_a? Array
             records = []
             data.each do |data_element|
@@ -75,10 +76,34 @@ module KillBillClient
 
         def instantiate_record_from_json(resource_class, data)
           record = resource_class.send :new
-          data.each { |k, v| record.send("#{Utils.underscore k}=", v) }
+          
+          data.each do |name, value|
+            name = Utils.underscore name
+            attr_desc = @@attribute_names[record.class.name][name.to_sym] rescue nil
+
+            unless attr_desc.nil?
+              type = attr_desc[:type]
+              if attr_desc[:cardinality] == :many && !type.nil? && value.is_a?(Array)
+                newValue = []
+                value.each do |val|
+                  if val.is_a?(Hash)
+                    newValue << instantiate_record_from_json(type, val)
+                  else
+                    newValue << val
+                  end
+                end
+                value = newValue
+              elsif attr_desc[:cardinality] == :one && !type.nil? && value.is_a?(Hash)
+                value = instantiate_record_from_json(type, value)
+              end
+            end #end unless attr_desc.nil? or data_elem.blank?
+
+            record.send("#{Utils.underscore name}=", value )
+          end #end data.each
+
           record
         end
-
+        
         def attribute(name)
           self.send('attr_accessor', name.to_sym)
 
@@ -86,40 +111,65 @@ module KillBillClient
           self.instance_variable_get('@json_attributes') << name.to_s
 
           attributes = self.instance_variable_get('@json_attributes')
-          (
-          class << self;
-            self
-          end).send(:define_method, :json_attributes) do
-            attributes
-          end
-        end
-      end
-
-      # Set on create call
-      attr_accessor :uri
 
-      def to_hash
-        json_hash = {}
-        self.class.json_attributes.each do |name|
-          value = self.send(name)
-          if value
-            json_hash[Utils.camelize name, :lower] = value.is_a?(Resource) ? value.to_hash : value
-          end
-        end
-        json_hash
-      end
-
-      def to_json
-        to_hash.to_json
-      end
-
-      def refresh(clazz=self.class)
-        if @uri
-          self.class.get @uri, {}, {}, clazz
-        else
-          self
-        end
-      end
-    end
-  end
-end
+          (
+           class << self;
+             self
+           end).send(:define_method, :json_attributes) do
+             attributes
+           end
+         end
+
+         def has_many(attr_name, type = nil)
+           send("attr_accessor", attr_name.to_sym)
+
+           #add it to attribute_names
+           @@attribute_names[self.name] = {} unless @@attribute_names[self.name]
+           @@attribute_names[self.name][attr_name.to_sym] = {:type => type,  :cardinality => :many }
+         end
+
+         def has_one(attr_name, type = nil)
+           send("attr_accessor", attr_name.to_sym)
+           
+           #add it to attribute_names
+           @@attribute_names[self.name] = {} unless @@attribute_names[self.name]
+           @@attribute_names[self.name][attr_name.to_sym] = { :type => type, :cardinality => :one }
+         end
+
+         #hack to cater the api return attributes and javax attributes without editing gen scripts
+         #call only after its declared as a instance_method using attr_accessor
+         def create_alias(new_name, old_name)
+           alias_method new_name.to_sym, old_name.to_sym #getter
+           alias_method "#{new_name}=".to_sym, "#{old_name}=".to_sym #setter
+         end
+
+       end #end self methods
+
+       # Set on create call
+       attr_accessor :uri
+
+       def to_hash
+         json_hash = {}
+         self.class.json_attributes.each do |name|
+           value = self.send(name)
+           if value
+             json_hash[Utils.camelize name, :lower] = value.is_a?(Resource) ? value.to_hash : value
+           end
+         end
+         json_hash
+       end
+
+       def to_json
+         to_hash.to_json
+       end
+
+       def refresh(clazz=self.class)
+         if @uri
+           self.class.get @uri, {}, {}, clazz
+         else
+           self
+         end
+       end
+     end
+   end
+ end

data/lib/killbill_client/models/subscription_deleted_event.rb

@@ -0,0 +1,6 @@
+module KillBillClient
+  module Model
+    class SubscriptionDeletedEvent < SubscriptionDeletedEventAttributes
+    end
+  end
+end

data/lib/killbill_client/models/subscription_event.rb

@@ -0,0 +1,9 @@
+module KillBillClient
+  module Model
+    class SubscriptionEvent < SubscriptionAttributesNoEvents
+      has_many :events, KillBillClient::Model::Event
+      has_many :deleted_events, KillBillClient::Model::SubscriptionDeletedEvent
+      has_many :new_events, KillBillClient::Model::SubscriptionNewEvent
+    end
+  end
+end

data/lib/killbill_client/models/subscription_new_event.rb

@@ -0,0 +1,6 @@
+module KillBillClient
+  module Model
+    class SubscriptionNewEvent < SubscriptionNewEventAttributes
+    end
+  end
+end

data/lib/killbill_client/version.rb

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

data/spec/killbill_client/model_relation_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe KillBillClient::Model::Resource do
+  class_var_name = '@@attribute_names'
+  
+  it 'should test has_one property' do
+    #test account_timeline has one account
+    #has_one :account, KillBillClient::Model::Account
+    #expected "KillBillClient::Model::AccountTimeline"=>{:account=>{:type=>KillBillClient::Model::Account, :cardinality=>:one}, :payments=>{:type=>KillBillClient::Model::Payment, :cardinality=>:many}, :bundles=>{:type=>KillBillClient::Model::Bundle, :cardinality=>:many}, :invoices=>{:type=>KillBillClient::Model::Invoice, :cardinality=>:many}}
+    test_var = KillBillClient::Model::AccountTimeline.class_variable_defined? class_var_name
+    test_var.should_not be_false
+
+    var = KillBillClient::Model::AccountTimeline.class_variable_get class_var_name
+    var.size.should > 0
+    var.should have_key "KillBillClient::Model::AccountTimeline"
+    var["KillBillClient::Model::AccountTimeline"].should have_key :account
+
+    attr = var["KillBillClient::Model::AccountTimeline"][:account]
+
+    attr.should have_key :type
+    attr.should have_key :cardinality
+
+    attr[:type].should == KillBillClient::Model::Account
+    attr[:cardinality].should == :one #has one
+
+    #should also be accessible by attr_accessors
+
+    methods = KillBillClient::Model::AccountTimeline.instance_methods
+    methods.should include :account     # attr_reader
+    methods.should include :account= #attr_writer
+  end
+
+  it 'should test has_many property' do
+    #test event has many audit_logs
+    #has_many :audit_logs, KillBillClient::Model::AuditLog
+    #expected {"KillBillClient::Model::Event"=>{:audit_logs=>{:type=>KillBillClient::Model::AuditLog, :cardinality=>:many}}}
+
+    test_var = KillBillClient::Model::Event.class_variable_defined? class_var_name
+    test_var.should_not be_false
+
+    var = KillBillClient::Model::Event.class_variable_get class_var_name
+    var.size.should > 0
+    var.should have_key "KillBillClient::Model::Event"
+    var["KillBillClient::Model::Event"].should have_key :audit_logs
+
+    attr = var["KillBillClient::Model::Event"][:audit_logs]
+
+    attr.should have_key :type
+    attr.should have_key :cardinality
+
+    attr[:type].should == KillBillClient::Model::AuditLog
+    attr[:cardinality].should == :many #has many
+
+    #should also be accessible by attr_accessors
+
+    methods = KillBillClient::Model::Event.instance_methods
+    methods.should include :audit_logs     # attr_reader
+    methods.should include :audit_logs= #attr_writer
+  end
+
+  it 'should create alias attr accessors' do
+    KillBillClient::Model::Event.create_alias :alias_date, :requested_dt
+
+    methods = KillBillClient::Model::Event.instance_methods
+    methods.should include :alias_date
+    methods.should include :alias_date=
+
+    evt = KillBillClient::Model::Event.new
+    evt.alias_date = "devaroop"
+    evt.requested_dt.should == "devaroop"
+    evt.alias_date.should == "devaroop"
+  end
+end
+ 

data/spec/killbill_client/remote/model_spec.rb

@@ -82,6 +82,28 @@ describe KillBillClient::Model do
 
     account = KillBillClient::Model::Account.find_by_id account.account_id
     account.payment_method_id.should be_nil
+
+    # Get its timeline
+    timeline = KillBillClient::Model::AccountTimeline.find_by_account_id account.account_id
+
+    timeline.account.external_key.should == external_key
+    timeline.account.account_id.should_not be_nil
+    
+    timeline.invoices.should be_a_kind_of Array
+    timeline.invoices.should_not be_empty
+    timeline.payments.should be_a_kind_of Array
+    timeline.bundles.should be_a_kind_of Array
+
+    # Let's find the invoice by two methods
+    invoice = timeline.invoices.first
+    invoice_id = invoice.invoice_id
+    invoice_number = invoice.invoice_number
+
+    invoice_with_id = KillBillClient::Model::Invoice.find_by_id_or_number invoice_id
+    invoice_with_number = KillBillClient::Model::Invoice.find_by_id_or_number invoice_number
+
+    invoice_with_id.invoice_id.should == invoice_with_number.invoice_id
+    invoice_with_id.invoice_number.should == invoice_with_number.invoice_number
   end
 
   it 'should manipulate tag definitions' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill-client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Killbill core team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -55,6 +55,12 @@ files:
 - lib/killbill_client/api/errors.rb
 - lib/killbill_client/api/net_http_adapter.rb
 - lib/killbill_client/models/account.rb
+- lib/killbill_client/models/account_timeline.rb
+- lib/killbill_client/models/audit_log.rb
+- lib/killbill_client/models/bundle.rb
+- lib/killbill_client/models/chargeback.rb
+- lib/killbill_client/models/credit.rb
+- lib/killbill_client/models/event.rb
 - lib/killbill_client/models/gen/account_attributes.rb
 - lib/killbill_client/models/gen/account_attributes_simple.rb
 - lib/killbill_client/models/gen/account_attributes_with_balance.rb
@@ -109,13 +115,18 @@ files:
 - lib/killbill_client/models/models.rb
 - lib/killbill_client/models/payment.rb
 - lib/killbill_client/models/payment_method.rb
+- lib/killbill_client/models/refund.rb
 - lib/killbill_client/models/resource.rb
+- lib/killbill_client/models/subscription_deleted_event.rb
+- lib/killbill_client/models/subscription_event.rb
+- lib/killbill_client/models/subscription_new_event.rb
 - lib/killbill_client/models/tag.rb
 - lib/killbill_client/models/tag_definition.rb
 - lib/killbill_client/utils.rb
 - lib/killbill_client/version.rb
 - lib/rails/generators/killbill_client/config_generator.rb
 - lib/rails/killbill_client.rb
+- spec/killbill_client/model_relation_spec.rb
 - spec/killbill_client/remote/api_spec.rb
 - spec/killbill_client/remote/model_spec.rb
 - spec/spec_helper.rb
@@ -146,6 +157,7 @@ signing_key:
 specification_version: 4
 summary: Kill Bill client library.
 test_files:
+- spec/killbill_client/model_relation_spec.rb
 - spec/killbill_client/remote/api_spec.rb
 - spec/killbill_client/remote/model_spec.rb
 - spec/spec_helper.rb