active_zuora 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f5302e3adec5088e1386b7b8cbfb2e8e5ab802b
-  data.tar.gz: 57ff7f96be0fa495509a9a18593b9393e862a47e
+  metadata.gz: 65ef7a2fd66b972b6a70886b761192cc1fe479db
+  data.tar.gz: 742f84177e47b462ec319369fe934b2969155c73
 SHA512:
-  metadata.gz: b633b481e1497d5c59e5221ed656953a6460b9a5e9d689e1e9c46cc53da4aebedae3fbf9f57080a6654826441f002d84e2dcc60e00d1c58ebb18ea2825a6bbc2
-  data.tar.gz: 9630192d73bf3852d21fc44c6803b8f1980dad167d49ec0b2baa2292e3ac1d2c5cea36a4e66c3c5d797a07bb3eff8023b253681da5de6bd50893b37bbe9209eb
+  metadata.gz: a57f894f4afd97482f7f2e03584a8b9839b4a85a1b56c370bb07278d037d9123ff9fb14030213cdf87bda47f68ebb12a36b337b4bf17a36539225fbf6786523a
+  data.tar.gz: 584a68481832b02a117519bdb2a64f68f9ed635685ff80ca2f9dcf008dd31fff12bd48900927016b1b1ee7eac877598e65afd6bbeb872d2254e03a366d3b07e6

data/CHANGELOG.markdown

@@ -1,3 +1,6 @@
+#### v2.3.1
+*  Add billing preview capability
+*  Capitalize first letter of wsdl object name to ensure that it is a valid Ruby constant
 #### v2.3.0
 #### v2.2.7
 #### v2.2.6
@@ -10,8 +13,6 @@
 * Fix #43 - Add invoice_payment_data to exclusions list
 
   > David: : https://github.com/sportngin/active_zuora/pull/44
-
-#### v2.2.1
 #### v2.2.0
 #### v2.1.4
 #### v2.1.3

data/lib/active_zuora.rb

@@ -16,6 +16,7 @@ require 'active_zuora/z_object'
 require 'active_zuora/subscribe'
 require 'active_zuora/amend'
 require 'active_zuora/generate'
+require 'active_zuora/billing_preview'
 require 'active_zuora/batch_subscribe'
 require 'active_zuora/collection_proxy'
 require 'active_zuora/lazy_attr'

data/lib/active_zuora/billing_preview.rb

@@ -0,0 +1,49 @@
+module ActiveZuora
+  module BillingPreview
+
+    # This is meant to be included onto an BillingPreviewRequest class.
+    # Returns a BillingPreviewResponse object on success.
+    # Result hash is stored in #result.
+    # If failure, errors will be present on object.
+
+    extend ActiveSupport::Concern
+
+    included do
+      include Base
+      attr_accessor :result
+    end
+
+    def billing_preview
+      self.result = self.class.connection.request(:billing_preview) do |soap|
+        soap.body do |xml|
+          build_xml(xml, soap,
+            :namespace => soap.namespace,
+            :element_name => :requests,
+            :force_type => true)
+        end
+      end[:billing_preview_response][:results]
+
+      if result[:success]
+        clear_changed_attributes
+        filtered_invoice_items = self.result[:invoice_item].map do |invoice_item|
+          #Filter out data in the return value that are not valid invoice item fields such as
+          #    :"@xmlns:ns2"=>"http://object.api.zuora.com/",
+          #    :"@xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+          #    :"@xsi:type"=>"ns2:InvoiceItem"
+          invoice_item.select{|key, v| ActiveZuora::InvoiceItem.field_names.include?(key)}
+        end
+        ActiveZuora::BillingPreviewResult.new(self.result.merge(invoice_item: filtered_invoice_items))
+      else
+        add_zuora_errors(result[:errors])
+        false
+      end
+    end
+
+    def billing_preview!
+      billing_preview.tap do |preview|
+        raise "Could not billing preview: #{errors.full_messages.join ', '}" unless preview
+      end
+    end
+
+  end
+end

data/lib/active_zuora/generator.rb

@@ -30,6 +30,7 @@ module ActiveZuora
           # Skip the zObject base class, we define our own.
           next if class_name == "zObject"
 
+          class_name[0] = class_name[0].upcase
           zuora_class = Class.new
           @class_nesting.const_set(class_name, zuora_class)
           @classes << zuora_class
@@ -72,7 +73,7 @@ module ActiveZuora
                 :zuora_name => zuora_name, :array => is_array,
                 :class_name => zuora_class.nested_class_name(field_type.split(':').last)
             else
-              puts "Unkown field type: #{field_type}"
+              puts "Unknown field type: #{field_type}"
             end
           end # each element
 
@@ -156,6 +157,10 @@ module ActiveZuora
         exclude_from_queries :product_rate_plan_charge_id
       end
 
+      customize 'BillingPreviewRequest' do
+        include BillingPreview
+      end
+
       customize 'InvoiceItemAdjustment' do
         exclude_from_queries :customer_name, :customer_number
       end

data/lib/active_zuora/version.rb

@@ -1,3 +1,3 @@
 module ActiveZuora
-  VERSION = "2.3.0"
+  VERSION = "2.3.1"
 end

data/spec/subscribe_integration_spec.rb

@@ -121,7 +121,7 @@ describe "Subscribe" do
       account.delete
     end
 
-    it "Can successfully subscribe and generate an invoice" do
+    it "Can successfully subscribe and generate a bill preview and an invoice" do
 
       subscribe_request = Z::SubscribeRequest.new(
         :account => {
@@ -200,6 +200,15 @@ describe "Subscribe" do
       expect(amend_request.amendments.first.new_record?).to be_falsey
       expect(amend_request.result).to be_present
 
+      billing_preview_request = Z::BillingPreviewRequest.new(
+          account_id: subscribe_request.account.id,
+          target_date: Date.today + 2.months
+      )
+
+      billing_preview_result = billing_preview_request.billing_preview!
+      expect(billing_preview_result).to be_present
+      expect(billing_preview_result.invoice_item).to be_present
+
       invoice = Z::Invoice.new(
           account_id: subscribe_request.account.id,
           invoice_date: Date.today,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_zuora
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Ed Lebert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -119,6 +119,7 @@ files:
 - lib/active_zuora/base.rb
 - lib/active_zuora/batch_subscribe.rb
 - lib/active_zuora/belongs_to_associations.rb
+- lib/active_zuora/billing_preview.rb
 - lib/active_zuora/collection_proxy.rb
 - lib/active_zuora/connection.rb
 - lib/active_zuora/fields.rb