active_zuora 1.3.0 → 1.4.0

data/README.rdoc

@@ -1,4 +1,8 @@
-== ActiveZoura
+== Active Zuora Version 2
+* This fork has been moved from its {original location}[https://github.com/anfleene/active_zuora] to its {current location}[https://github.com/tstmedia/active_zuora_v1]
+* The Active Zuora Version 2 gem can be found at https://github.com/tstmedia/active_zuora.
+
+== Active Zoura Version 1
 
 Client for Zuora API
 
@@ -9,7 +13,24 @@ The fork is adding a new interface to the gem along with removing parts deemed u
 The underlying implementation of the zuora4r gem is still in place but that is going to change in the future.
 
 
+
 == Installing the Gem
     $ sudo gem sources -a http://gemcutter.org
     $ sudo gem install active_zuora
 
+== Future Releases
+
+In the short term this gem will hold on to most of the existing zuora api code with more active recordy style additions to its interface
+In the long term the underlying implementation will be refactored and condensed into something smaller and more idiomatic
+
+=== Important Missing Features
+
+Completion of active zuora's CRUD actions on instance methods
+Support for Zuora's queryMore api call
+
+Remove weird error handling Anti Pattern that rescues and prints all Exceptions
+
+BUG:
+  Auto quote where calls
+
+

data/Rakefile

@@ -45,12 +45,3 @@ task :test => :check_dependencies
 
 task :default => :test
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "active_zuora #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.4.0

data/active_zuora.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "active_zuora"
-  s.version = "1.3.0"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["anfleene"]
-  s.date = "2012-01-20"
+  s.date = "2013-02-18"
   s.description = "A client for Zuora API"
   s.email = "anfleene@gmail.com"
   s.extra_rdoc_files = [
@@ -22,41 +22,71 @@ Gem::Specification.new do |s|
     "active_zuora.gemspec",
     "custom_fields.yml",
     "lib/active_zuora.rb",
+    "lib/active_zuora/account.rb",
+    "lib/active_zuora/amendment.rb",
+    "lib/active_zuora/bill_run.rb",
+    "lib/active_zuora/contact.rb",
+    "lib/active_zuora/invoice.rb",
+    "lib/active_zuora/invoice_item.rb",
+    "lib/active_zuora/invoice_item_adjustment.rb",
+    "lib/active_zuora/invoice_payment.rb",
+    "lib/active_zuora/payment.rb",
+    "lib/active_zuora/payment_method.rb",
+    "lib/active_zuora/product.rb",
+    "lib/active_zuora/product_rate_plan.rb",
+    "lib/active_zuora/product_rate_plan_charge.rb",
+    "lib/active_zuora/product_rate_plan_charge_tier.rb",
+    "lib/active_zuora/product_rate_plan_charge_tier_data.rb",
+    "lib/active_zuora/rate_plan.rb",
+    "lib/active_zuora/rate_plan_charge.rb",
+    "lib/active_zuora/rate_plan_charge_data.rb",
+    "lib/active_zuora/rate_plan_charge_tier.rb",
+    "lib/active_zuora/rate_plan_data.rb",
+    "lib/active_zuora/refund.rb",
+    "lib/active_zuora/subscribe_options.rb",
+    "lib/active_zuora/subscribe_request.rb",
+    "lib/active_zuora/subscribe_with_existing_account_request.rb",
+    "lib/active_zuora/subscription.rb",
+    "lib/active_zuora/subscription_data.rb",
+    "lib/active_zuora/usage.rb",
+    "lib/active_zuora/zobject.rb",
     "lib/zuora/ZUORA.rb",
     "lib/zuora/ZUORADriver.rb",
     "lib/zuora/ZUORAMappingRegistry.rb",
     "lib/zuora/ZuoraServiceClient.rb",
-    "lib/zuora/account.rb",
     "lib/zuora/api.rb",
-    "lib/zuora/contact.rb",
-    "lib/zuora/rate_plan.rb",
-    "lib/zuora/rate_plan_data.rb",
-    "lib/zuora/subscribe_options.rb",
-    "lib/zuora/subscribe_request.rb",
-    "lib/zuora/subscribe_with_existing_account_request.rb",
-    "lib/zuora/subscription.rb",
-    "lib/zuora/subscription_data.rb",
-    "lib/zuora/zobject.rb",
     "lib/zuora_client.rb",
     "lib/zuora_interface.rb"
   ]
   s.homepage = "http://github.com/anfleene/active_zuora"
   s.require_paths = ["lib"]
   s.requirements = ["none"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.24"
   s.summary = "Active Zuora"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<soap4r>, ["~> 1.5"])
+      s.add_runtime_dependency(%q<json_pure>, ["~> 1.4"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_runtime_dependency(%q<soap4r>, [">= 1.5.8"])
       s.add_runtime_dependency(%q<json_pure>, [">= 1.4.6"])
     else
+      s.add_dependency(%q<soap4r>, ["~> 1.5"])
+      s.add_dependency(%q<json_pure>, ["~> 1.4"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<soap4r>, [">= 1.5.8"])
       s.add_dependency(%q<json_pure>, [">= 1.4.6"])
     end
   else
+    s.add_dependency(%q<soap4r>, ["~> 1.5"])
+    s.add_dependency(%q<json_pure>, ["~> 1.4"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<soap4r>, [">= 1.5.8"])
     s.add_dependency(%q<json_pure>, [">= 1.4.6"])
   end

data/lib/active_zuora.rb

@@ -1,13 +1,8 @@
 require 'delegate'
 require 'zuora_client'
-require 'zuora/zobject'
-require 'zuora/account'
-require 'zuora/contact'
-require 'zuora/rate_plan'
-require 'zuora/rate_plan_data'
-require 'zuora/subscribe_options'
-require 'zuora/subscribe_request'
-require 'zuora/subscribe_with_existing_account_request'
-require 'zuora/subscription'
-require 'zuora/subscription_data'
+require 'active_zuora/zobject.rb'
+Dir[File.join(File.dirname(__FILE__),"active_zuora","*.rb")].each do |file| 
+  require file
+end
+
 

data/lib/active_zuora/account.rb

@@ -0,0 +1,27 @@
+module Zuora
+  class Account < ZObject
+    def billTo
+      @billTo ||= Contact.find(self.billToId)
+    end
+
+    def soldTo
+      @soldTo ||= Contact.find(self.soldToId)
+    end
+
+    def subscriptions
+      @subscriptions ||= Subscription.where(:accountid => self.id)
+    end
+
+    def invoices
+      @invoices ||= Invoice.where(:accountid => self.id)
+    end
+
+    def payment_methods
+      @payment_methods ||= PaymentMethod.where(:accountid => self.id)
+    end
+
+    def contacts
+      @contacts ||= Contact.where(:accountid => self.id)
+    end
+  end
+end

data/lib/active_zuora/amendment.rb

@@ -0,0 +1,7 @@
+module Zuora
+  class Amendment < ZObject
+
+    exclude_query_attributes :ratePlanData, :termCommitment
+
+  end
+end

data/lib/active_zuora/bill_run.rb

@@ -0,0 +1,4 @@
+module Zuora
+  class BillRun < ZObject
+  end
+end

data/lib/active_zuora/contact.rb

@@ -0,0 +1,7 @@
+module Zuora
+  class Contact < ZObject
+    def account
+      @account ||= Account.find(self.accountId)
+    end
+  end
+end

data/lib/active_zuora/invoice.rb

@@ -0,0 +1,46 @@
+module Zuora
+  class Invoice < ZObject
+    def self.extra_attributes(attributes=[])
+      super([:body])
+    end
+
+    def self.create(attributes={})
+      self.client.generate([self.new(attributes).to_zobject]).first
+    end
+
+    def save
+      result = self.class.create(self.attributes)
+      if result[:success]
+        @errors = []
+        __setobj__(self.class.find(result[:id]).to_zobject)
+      else
+        @errors = result[:errors]
+      end
+      result[:success]
+    end
+
+    def errors
+      @errors || []
+    end
+
+    def post
+      return false unless self.id
+      result = self.class.update_attributes(:id => self.id, :status => "Posted").first
+      @errors = result[:errors]
+      result[:success]
+    end
+
+    def invoice_items
+      @invoice_items ||= InvoiceItem.where(:invoiceid => self.id)
+    end
+
+    def account
+      @account ||= Account.find(self.accountId)
+    end
+
+    def payments
+      # Payments, sorted by date.
+      @payments ||= InvoicePayment.where(:invoiceId => self.id).map(&:payment).sort { |a, b| a.effectiveDate <=> b.effectiveDate }
+    end
+  end
+end

data/lib/active_zuora/invoice_item.rb

@@ -0,0 +1,26 @@
+module Zuora
+  class InvoiceItem < ZObject
+
+    def invoice
+      @invoice ||= Invoice.find(invoiceId)
+    end
+
+    def rate_plan_charge
+      @rate_plan_charge ||= RatePlanCharge.find(ratePlanChargeId)
+    end
+
+    def adjustments
+      @adjustments ||= InvoiceItemAdjustment.where(:sourceType => 'InvoiceDetail', :sourceId => id)
+    end
+
+    def adjusted_charge_amount
+      @adjusted_charge_amount ||=
+        adjustments.inject(chargeAmount) do |amount, adjustment|
+          # Adjustment types are either Credit or Charge
+          # Credits will have a reducing (subtracting) effect on the invoice item charge.
+          adjustment.type == "Credit" ? amount - adjustment.amount : amount + adjustment.amount
+        end
+    end
+
+  end
+end

data/lib/active_zuora/invoice_item_adjustment.rb

@@ -0,0 +1,4 @@
+module Zuora
+  class InvoiceItemAdjustment < ZObject
+  end
+end

data/lib/active_zuora/invoice_payment.rb

@@ -0,0 +1,11 @@
+module Zuora
+  class InvoicePayment < ZObject
+    def invoice
+      @invoice ||= Invoice.find(self.invoiceId)
+    end
+
+    def payment
+      @payment ||= Payment.find(self.paymentId)
+    end
+  end
+end

data/lib/active_zuora/payment.rb

@@ -0,0 +1,18 @@
+module Zuora
+  class Payment < ZObject
+    
+    exclude_query_attributes :appliedInvoiceAmount, :invoiceId
+
+    def account
+      @account ||= Account.find(self.accountId)
+    end
+
+    def payment_method
+      @payment_method ||= PaymentMethod.find(self.paymentMethodId)
+    end
+
+    def invoices
+      @invoices ||= InvoicePayment.where(:paymentId => self.id).map(&:invoice)
+    end
+  end
+end

data/lib/active_zuora/payment_method.rb

@@ -0,0 +1,10 @@
+module Zuora
+  class PaymentMethod < ZObject
+
+    exclude_query_attributes :achAccountNumber, :creditCardNumber, :creditCardSecurityCode
+
+    def account
+      @account ||= Account.find(self.accountId)
+    end
+  end
+end

data/lib/active_zuora/product.rb

@@ -0,0 +1,4 @@
+module Zuora
+  class Product < ZObject
+  end
+end

data/lib/active_zuora/product_rate_plan.rb

@@ -0,0 +1,9 @@
+module Zuora
+  class ProductRatePlan < ZObject
+
+    def charges
+      @charges ||= ProductRatePlanCharge.where(:productRatePlanId => id)
+    end
+
+  end
+end

data/lib/active_zuora/product_rate_plan_charge.rb

@@ -0,0 +1,11 @@
+module Zuora
+  class ProductRatePlanCharge < ZObject
+    def product_rate_plan
+      @product_rate_plan ||= ProductRatePlan.find(self.ProductRatePlanId)
+    end
+
+    def product_rate_plan_charge_tiers
+      @product_rate_plan_charge_tiers ||= ProductRatePlanChargeTier.where(:productRatePlanChargeId => self.id)
+    end
+  end
+end

data/lib/active_zuora/product_rate_plan_charge_tier.rb

@@ -0,0 +1,7 @@
+module Zuora
+  class ProductRatePlanChargeTier < ZObject
+    def product_rate_plan_charge
+      @product_rate_plan_charge ||= ProductRatePlanCharge.find(self.productRatePlanChargeId)
+    end
+  end
+end

data/lib/active_zuora/product_rate_plan_charge_tier_data.rb

@@ -0,0 +1,4 @@
+module Zuora
+  class ProductRatePlanChargeTierData < ZObject
+  end
+end

data/lib/active_zuora/rate_plan.rb

@@ -0,0 +1,16 @@
+module Zuora
+  class RatePlan < ZObject
+    def rate_plan_charges
+      @rate_plan_charges ||= RatePlanCharge.where(:ratePlanId => self.id)
+    end
+
+    def subscription
+      @subscription ||= Subscription.find(self.subscriptionId)
+    end
+
+    def product_rate_plan
+      @product_rate_plan ||= ProductRatePlan.find(self.productRatePlanId)
+    end
+
+  end
+end

data/lib/active_zuora/rate_plan_charge.rb

@@ -0,0 +1,44 @@
+module Zuora
+  class RatePlanCharge < ZObject
+    
+    exclude_query_attributes :overagePrice, :includedUnits, :discountAmount, :discountPercentage
+
+    def rate_plan
+      @rate_plan ||= RatePlan.find(self.ratePlanId)
+    end
+
+    def product_rate_plan_charge
+      @product_rate_plan_charge ||= ProductRatePlanCharge.find(self.productRatePlanChargeId)
+    end
+
+    def usages
+      @usages ||= Usage.where(:chargeId => id)
+    end
+
+    def unload_usages
+      @usages = nil
+      self
+    end
+
+    def total_price
+      (quantity || 1) * price
+    end
+
+    def list_price
+      product_rate_plan_charge.product_rate_plan_charge_tiers.first.price
+    end
+
+    def total_list_price
+      (quantity || 1) * list_price
+    end
+
+    def discount?
+      price < list_price
+    end
+
+    def discount_percent
+      list_price.zero? ? nil : (1 - price / list_price) * 100
+    end
+
+  end
+end