active_zuora 2.1.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f3c48bc1e363410cf7a84fca07fed5d587ba239
-  data.tar.gz: cb5ef8f0177caf1b567742d5ac6ad21b56f278bb
+  metadata.gz: 0a193209e8dc321e159f45d360a0b1b5a0f4458f
+  data.tar.gz: 5994cf1d464ebde4d2e674763eee752c8f6c6f13
 SHA512:
-  metadata.gz: 054d3ed6fd6f6a0392f7033a582ccaa5f24842438b59270c0710c69af3aa1f422552d501eb5fba854bafd421cd939a15bd7f88702b466ab145ca60a7662a99a8
-  data.tar.gz: 069f93a4cf88d10604174212f6b6ea947f55cede6fdca257c6772b64350b5ae90b3e266a08473b9aeb5bd066833369d23f5c4a3be6b139245b23e0fed8bb2644
+  metadata.gz: bcc832f90122ccc3e4d12bba198d83d28cee4c8fba77fcdbb6b42c86d1761fe69c032d175a1e520800ca71f0db4db528136cbfcd3b47026cf162d845d4469431
+  data.tar.gz: be5417128f8bce2c3d484c9a2403482472854b424a90e2b92ed3f7aef3db312158e25b828ca8eed941181b166f2b46b15c545bf68a55336df138c182a8f04aa5

data/CHANGELOG.markdown

@@ -1,3 +1,4 @@
+#### v2.2.0
 #### v2.1.4
 #### v2.1.3
 #### v2.1.2

data/README.md

@@ -33,6 +33,11 @@ fields to a list of filtered fields.
       :wsdl => 'path/to/zuora.wsdl'
     )
 ```
+Override the default endpoint or host loaded from the wsdl
+
+```
+ActiveZuora::Base.connection.soap_client.wsdl.endpoint.host = "www.zuora.com" if Rails.env.production?
+````
 
 ## Defining Classes
 
@@ -156,6 +161,14 @@ You can also delete all records matching a query as well.  The method returns th
 
     ActiveZuora::Account.where(:status => "Draft").delete_all # 56
 
+## Batch Subscribe
+
+You can submit up to 50 subscribe requests on a single subscribe call per the Zuora documentation.  To batch subscribe requests, use the CollectionProxy to build a collection of subscribe requests, then call batch_subscribe
+
+    ActiveZuora::CollectionProxy.new([ActiveZuora::SubscribeRequest.new({account: {}, bill_to: {}, subscription_data:{}}), 
+                                      ActiveZuora::SubscribeRequest.new({account: {}, bill_to: {}, subscription_data:{}})]).batch_subscribe
+
+
 ## License
 
 Active Zuora is released under the MIT license:

data/lib/active_zuora.rb

@@ -16,6 +16,8 @@ require 'active_zuora/z_object'
 require 'active_zuora/subscribe'
 require 'active_zuora/amend'
 require 'active_zuora/generate'
+require 'active_zuora/batch_subscribe'
+require 'active_zuora/collection_proxy'
 
 module ActiveZuora
 

data/lib/active_zuora/batch_subscribe.rb

@@ -0,0 +1,53 @@
+module ActiveZuora
+  module BatchSubscribe
+
+    # This is meant to be included onto the CollectionProxy class.
+    # Returns true if every SubscribeRequest was a success
+    # Returns false if any single subsciption Request fails
+    # Result hash of each subscribe request is stored in the Subscribe Request #result.
+    # If success, the subscription id and account id will be set in those objects.
+    # If failure, errors will be present on the request object(s) that had error(s).
+    
+    extend ActiveSupport::Concern
+
+    included do
+      include Base
+      attr_accessor :result
+    end
+    
+    def batch_subscribe
+      raise "object must be an ActiveZuora::CollectionProxy object instance" unless self.zuora_object_name == "CollectionProxy"
+      self.result = self.class.connection.request(:subscribe) do |soap|
+        soap.body do |xml| 
+          inject(xml) do |memo, el|
+            el.build_xml(xml, soap, 
+              :namespace => soap.namespace,
+              :element_name => :subscribes,
+              :force_type => true)
+          end
+        end
+      end[:subscribe_response][:result]
+      
+      self.result = [result] unless result.is_a?(Array)
+      result.each_with_index do |result, i|
+        self.records[i].result = result
+        if result[:success]
+          #we assume order is maintained by zuora.  is it?
+          self.records[i].account.id = result[:account_id]
+          self.records[i].subscription_data.subscription.id = result[:subscription_id]
+          self.records[i].clear_changed_attributes
+          @status = true
+        else
+          add_zuora_errors(result[:errors])
+          @status = false
+        end
+      end
+      @status
+    end
+    
+    def batch_subscribe!
+      raise "Could not batch subscribe: #{errors.full_messages.join ', '}" unless batch_subscribe
+    end
+  
+  end
+end

data/lib/active_zuora/collection_proxy.rb

@@ -0,0 +1,38 @@
+module ActiveZuora
+  class CollectionProxy
+    
+    include ZObject
+    include Enumerable
+    include BatchSubscribe
+    
+    attr_reader :records, :zobject_class
+
+    def initialize(ary = [])
+      unless ary.empty?
+        raise "objects in collection must be ActiveZuora object instances" unless class_names = ary.map{|object| object.zuora_object_name}.uniq
+        raise "objects in collection must be ActiveZuora object instances of the same class" unless class_names.length == 1
+        @zobject_class = class_names.first
+      end
+      @records = ary
+    end
+    
+    def add object
+      raise "object must be an ActiveZuora object instance" unless object.zuora_object_name
+      if records.empty?
+        @zobject_class = object.zuora_object_name
+      else
+        raise "object must be must be ActiveZuora object instances of the same class as other elements in the Collection" unless object.zuora_object_name == zobject_class
+      end
+      @records.push object
+    end
+
+    def each
+      records.each { |r| yield r }
+    end
+     
+    def empty?
+      records.empty?
+    end
+    
+  end
+end

data/lib/active_zuora/generator.rb

@@ -8,6 +8,7 @@ module ActiveZuora
       @document = document
       @classes = []
       @class_nesting = options[:inside] || ActiveZuora
+      @class_nesting.const_set("CollectionProxy", CollectionProxy) unless @class_nesting.constants.include?(:CollectionProxy)
     end
 
     def generate_classes

data/lib/active_zuora/version.rb

@@ -1,3 +1,3 @@
 module ActiveZuora
-  VERSION = "2.1.4"
+  VERSION = "2.2.0"
 end

data/spec/collection_proxy_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe "ActiveZuora::CollectionProxy" do
+
+  it "should initialize" do
+    cp = Z::CollectionProxy.new
+    expect(cp).to be_empty
+    cp = Z::CollectionProxy.new([Z::SubscribeRequest.new])
+    expect(cp).not_to be_empty
+  end
+
+  it "should respond to enumerable methods" do
+    cp = Z::CollectionProxy.new([Z::SubscribeRequest.new])
+    cp.each do |cp|
+      expect(cp)
+    end
+    cp.inject do |memo,cp|
+      expect(memo)
+      expect(cp)
+    end
+  end
+
+  it "should respond to the batch_subscribe method" do
+    cp = Z::CollectionProxy.new([Z::SubscribeRequest.new])
+    expect(cp.respond_to?(:batch_subscribe)).to eq(true)
+  end
+
+end

data/spec/subscribe_integration_spec.rb

@@ -39,8 +39,9 @@ describe "Subscribe" do
     end
 
     after do
-      @account.delete
       @product.delete
+      @account.delete
+      @account_2.delete if !!@account_2
     end
 
     it "Can successfully subscribe and amend using a new account" do
@@ -214,5 +215,118 @@ describe "Subscribe" do
       expect(invoice.account_id).to eq(subscribe_request.account.id)
     end
 
+    it "Can successfully batch subscribe from a collection proxy of subscribe requests and generate an invoice for the first subscription" do
+      subscribe_request_1 = Z::SubscribeRequest.new(
+        :account => {
+          :name => "Joe Customer",
+          :currency => Tenant.currency,
+          :bill_cycle_day => 1,
+          :payment_term => "Due Upon Receipt",
+          :batch => "Batch1"
+        },
+        :payment_method => {
+          :type => "CreditCard",
+          :credit_card_holder_name => "Robert Paulson",
+          :credit_card_type => "MasterCard",
+          :credit_card_number => "4111111111111111",
+          :credit_card_expiration_month => 1,
+          :credit_card_expiration_year => (Date.today.year + 1)
+        },
+        :bill_to_contact => {
+          :first_name => "Conny",
+          :last_name => "Client",
+          :work_email => "conny.client@example.com",
+          :country => "AU"
+        },
+        :subscription_data => {
+          :subscription => {
+            :contract_effective_date => Date.today,
+            :service_activation_date => Date.today,
+            :initial_term => 12,
+            :renewal_term => 12,
+            :term_type => 'TERMED'
+          },
+          :rate_plan_data => {
+            :rate_plan => {
+              :product_rate_plan_id => @product_rate_plan.id,
+            },
+            :rate_plan_charge_data => {
+              :rate_plan_charge => {
+                :product_rate_plan_charge_id => @product_rate_plan_charge.id,
+                :price => 45.00
+              }
+            }
+          }
+        }
+      )
+      
+      subscribe_request_2 = Z::SubscribeRequest.new(
+        :account => {
+          :name => "Joe Customer",
+          :currency => Tenant.currency,
+          :bill_cycle_day => 1,
+          :payment_term => "Due Upon Receipt",
+          :batch => "Batch1"
+        },
+        :payment_method => {
+          :type => "CreditCard",
+          :credit_card_holder_name => "Robert Paulson",
+          :credit_card_type => "MasterCard",
+          :credit_card_number => "4111111111111111",
+          :credit_card_expiration_month => 1,
+          :credit_card_expiration_year => (Date.today.year + 1)
+        },
+        :bill_to_contact => {
+          :first_name => "Conny",
+          :last_name => "Client",
+          :work_email => "conny.client@example.com",
+          :country => "AU"
+        },
+        :subscription_data => {
+          :subscription => {
+            :contract_effective_date => Date.today,
+            :service_activation_date => Date.today,
+            :initial_term => 12,
+            :renewal_term => 12,
+            :term_type => 'TERMED'
+          },
+          :rate_plan_data => {
+            :rate_plan => {
+              :product_rate_plan_id => @product_rate_plan.id,
+            },
+            :rate_plan_charge_data => {
+              :rate_plan_charge => {
+                :product_rate_plan_charge_id => @product_rate_plan_charge.id,
+                :price => 45.00
+              }
+            }
+          }
+        }
+      )
+      
+      collection = Z::CollectionProxy.new([subscribe_request_1,subscribe_request_2])
+      collection.batch_subscribe!
+      
+      #subscribe reqeust 1
+      @account = subscribe_request_1.account
+      expect(subscribe_request_1.new_record?).to be_falsey
+      expect(subscribe_request_1changed?).to be_falsey
+      expect(subscribe_request_1.subscription_data.subscription.new_record?).to be_falsey
+      expect(subscribe_request_1.subscription_data.subscription.rate_plans.first.
+        rate_plan_charges.first.
+        product_rate_plan_charge).to eq(@product_rate_plan_charge)
+      expect(subscribe_request_1.result).to be_present
+      
+      #subscribe reqeust 2
+      @account_2 = subscribe_request_2.account
+      expect(subscribe_request_2.new_record?).to be_falsey
+      expect(subscribe_request_2changed?).to be_falsey
+      expect(subscribe_request_2.subscription_data.subscription.new_record?).to be_falsey
+      expect(subscribe_request_2.subscription_data.subscription.rate_plans.first.
+        rate_plan_charges.first.
+        product_rate_plan_charge).to eq(@product_rate_plan_charge)
+      expect(subscribe_request_2.result).to be_present
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_zuora
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.2.0
 platform: ruby
 authors:
 - Ed Lebert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -117,7 +117,9 @@ files:
 - lib/active_zuora.rb
 - lib/active_zuora/amend.rb
 - lib/active_zuora/base.rb
+- lib/active_zuora/batch_subscribe.rb
 - lib/active_zuora/belongs_to_associations.rb
+- lib/active_zuora/collection_proxy.rb
 - lib/active_zuora/connection.rb
 - lib/active_zuora/fields.rb
 - lib/active_zuora/fields/array_field_decorator.rb
@@ -141,6 +143,7 @@ files:
 - spec/account_integration_spec.rb
 - spec/base_spec.rb
 - spec/belongs_to_associations_spec.rb
+- spec/collection_proxy_spec.rb
 - spec/connection_spec.rb
 - spec/has_many_integration_spec.rb
 - spec/spec_helper.rb
@@ -175,6 +178,7 @@ test_files:
 - spec/account_integration_spec.rb
 - spec/base_spec.rb
 - spec/belongs_to_associations_spec.rb
+- spec/collection_proxy_spec.rb
 - spec/connection_spec.rb
 - spec/has_many_integration_spec.rb
 - spec/spec_helper.rb