active_zuora 1.3.0 → 2.6.0

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'rspec'
+require 'active_zuora'
+
+I18n.enforce_available_locales = true
+
+ActiveZuora.configure(
+  :log => !!ENV['DEBUG'],
+  :pretty_print_xml => !!ENV['DEBUG'],
+  :username => ENV['ZUORA_USER'],
+  :password => ENV['ZUORA_PASS']
+)
+
+module Z; end
+ActiveZuora.generate_classes :inside => Z
+
+def integration_test
+  # Block helper.  Integration tests should be wrapped in this block.
+  if ENV['ZUORA_USER'] && ENV['ZUORA_PASS']
+    yield
+  else
+    $stderr.puts "Integration tests skipped because ZUORA_USER or ZUORA_PASS are not set."
+  end
+end
+
+def now(_message)
+  yield
+end
+
+module Tenant
+  def self.currency
+    ENV['ZUORA_CURRENCY'] || 'USD'
+  end
+end

data/spec/subscribe_integration_spec.rb

@@ -0,0 +1,344 @@
+require 'spec_helper'
+
+describe "Subscribe" do
+  integration_test do
+    before(:all) do
+      # Setup product.
+      @product = Z::Product.where(:name => "Awesome Product").first ||
+        Z::Product.create!(
+          :name => "Awesome Product",
+          :effective_start_date => Date.today,
+          :effective_end_date => Date.today + 10.years
+        )
+      @product_rate_plan = @product.product_rate_plans.first ||
+        Z::ProductRatePlan.create!(
+          :product => @product,
+          :name => "Awesome Plan"
+        )
+      @product_rate_plan_charge = @product_rate_plan.product_rate_plan_charges.first ||
+        Z::ProductRatePlanCharge.create!(
+          :product_rate_plan => @product_rate_plan,
+          :name => "Monthly Service",
+          :charge_model => "Flat Fee Pricing",
+          :charge_type => "Recurring",
+          :billing_period => "Month",
+          :trigger_event => "ContractEffective",
+          :product_rate_plan_charge_tier_data => {
+            :product_rate_plan_charge_tier => {
+              :active => true,
+              :currency => Tenant.currency,
+              :tier => 1,
+              :price => 50.00,
+              :starting_unit => 1,
+              :ending_unit => 1000
+            }
+          }
+        )
+    end
+
+    after(:all) { @product.try(:delete) }
+
+    it "Can successfully subscribe and amend using a new account" do
+
+      subscribe_request = 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 => "5424000000000015",
+          :credit_card_expiration_month => 1,
+          :credit_card_expiration_year => (Date.today.year + 1)
+        },
+        :bill_to_contact => {
+          :first_name => "Conny",
+          :last_name => "Client",
+          :country => "AU",
+          :work_email => "conny.client@example.com"
+        },
+        :subscription_data => {
+          :subscription => {
+            :contract_effective_date => Date.today,
+            :service_activation_date => Date.today,
+            :initial_term => 12,
+            :renewal_term => 12
+          },
+          :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.subscribe!
+      account = subscribe_request.account
+
+      expect(account.new_record?).to be_falsey
+      expect(account.changed?).to be_falsey
+      expect(subscribe_request.subscription_data.subscription.new_record?).to be_falsey
+      expect(subscribe_request.subscription_data.subscription.rate_plans.first.
+        rate_plan_charges.first.
+        product_rate_plan_charge).to eq(@product_rate_plan_charge)
+      expect(subscribe_request.result).to be_present
+
+      # Now amend the subscription
+      subscription = subscribe_request.subscription_data.subscription.reload
+      amend_request = Z::AmendRequest.new(
+        :amendments => {
+          :name => "Remove Awesome Plan",
+          :contract_effective_date => Date.today,
+          :service_activation_date => Date.today,
+          :subscription_id => subscription.id,
+          :type => "RemoveProduct",
+          :rate_plan_data => {
+            :rate_plan => {
+              :amendment_subscription_rate_plan_id => subscription.rate_plans.first.id
+            }
+          }
+        },
+        :amend_options => {
+          :generate_invoice => false,
+          :process_payments => false
+        }
+      )
+      amend_request.amend!
+      expect(amend_request.amendments.first.new_record?).to be_falsey
+      expect(amend_request.result).to be_present
+
+      account.delete
+    end
+
+    it "Can successfully subscribe and generate a bill preview and an invoice" do
+
+      subscribe_request = 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.subscribe!
+      account = subscribe_request.account
+
+      expect(account.new_record?).to be_falsey
+      expect(account.changed?).to be_falsey
+      expect(subscribe_request.subscription_data.subscription.new_record?).to be_falsey
+      expect(subscribe_request.subscription_data.subscription.rate_plans.first.
+        rate_plan_charges.first.
+        product_rate_plan_charge).to eq(@product_rate_plan_charge)
+      expect(subscribe_request.result).to be_present
+
+      # Now renew the subscription
+      subscription = subscribe_request.subscription_data.subscription.reload
+
+      amend_request = Z::AmendRequest.new(
+        :amendments => {
+          :name => "Renew",
+          :contract_effective_date => Date.today + 12.months,
+          :effective_date => Date.today,
+          :subscription_id => subscription.id,
+          :type => "Renewal",
+          :auto_renew => false,
+          :renewal_term => 12
+        },
+        :amend_options => {
+          :generate_invoice => false,
+          :process_payments => false
+        }
+      )
+      amend_request.amend!
+      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,
+          target_date: Date.today + 12.months,
+          includes_one_time: false,
+          includes_recurring: true,
+          includes_usage: false
+      )
+      invoice.generate!
+      expect(invoice.id).to be_present
+      expect(invoice.account_id).to eq(subscribe_request.account.id)
+      expect(invoice.body).to be_present
+
+      account.delete
+    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!
+
+      account_1 = subscribe_request_1.account
+      account_2 = subscribe_request_2.account
+
+      #subscribe reqeust 1
+      expect(account_1.new_record?).to be_falsey
+      expect(account_1.changed?).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
+      expect(account_2.new_record?).to be_falsey
+      expect(account_2.changed?).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
+
+      [account_1, account_2].each(&:delete)
+    end
+  end
+end

data/spec/zobject_integration_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe "ZObject" do
+
+  integration_test do
+
+    after do
+      # Delete the account to cleanup in case a test failed.
+      @account.delete if @account
+      @child.delete if @child
+    end
+
+    it "can be created, queried, updated, and destroyed" do
+
+      # Test failed creation.
+      @account = Z::Account.create
+      expect(@account.new_record?).to be_truthy
+      expect(@account.errors).to be_present
+
+      # Test creation.
+      @account = Z::Account.new(
+        :name => "ZObject Integration Test Account",
+        :currency => Tenant.currency,
+        :status => "Draft",
+        :bill_cycle_day => 1)
+      expect(@account.changes).to be_present
+      expect(@account.save).to be_truthy
+      expect(@account.new_record?).to be_falsey
+      expect(@account.errors).to be_blank
+      expect(@account.changes).to be_blank
+
+      # Test update.
+      @account.name = "ZObject Integration Test Account 2"
+      expect(@account.changes).to be_present
+      expect(@account.save).to be_truthy
+      expect(@account.changes).to be_blank
+
+      # Test querying.
+      expect(Z::Account.where(:name => "Some Random Name").all.to_a).to_not include(@account)
+      expect(Z::Account.where(:name => "Some Random Name").or(:name => @account.name).all.to_a).to include(@account)
+      expect(Z::Account.where(:created_date => { ">=" => Date.yesterday }).all.to_a).to include(@account)
+      expect(Z::Account.where(:created_date => { ">" => Time.now }).or(:name => @account.name).all.to_a).to include(@account)
+      Z::Account.where(:created_date => { ">=" => Date.today }).find_each do |account|
+        expect(account).to be_present
+      end
+
+      # Test ordering
+      unordered = Z::Account.where(:created_date => { ">=" => Date.today })
+      ordered = unordered.order(:name, :desc)
+      expect(unordered.order_attribute).to eq(:created_date)
+      expect(unordered.order_direction).to eq(:asc)
+      expect(ordered.order_attribute).to eq(:name)
+      expect(ordered.order_direction).to eq(:desc)
+
+      # Test scopes and chaining.
+      Z::Account.instance_eval do
+        scope :draft, :status => "Draft"
+        scope :active, where(:status => "Active")
+        scope :since, lambda { |datetime| where(:created_date => { ">=" => datetime }) }
+      end
+      expect(Z::Account.select(:id).draft.to_zql).to eq("select Id from Account where Status = 'Draft'")
+      expect(Z::Account.select(:id).active.since(Date.new 2012).to_zql).to eq("select Id from Account where Status = 'Active' and CreatedDate >= '2012-01-01T00:00:00+08:00'")
+
+      # Update all.
+      expect(Z::Account.where(:name => @account.name).update_all(:name => "ZObject Integration Test Account 3")).to eq(1)
+      expect(@account.reload.name).to eq("ZObject Integration Test Account 3")
+      # Block-style update_all
+      expect(Z::Account.where(:name => @account.name).update_all { |account| account.name += "4" }).to eq(1)
+      expect(@account.reload.name).to eq("ZObject Integration Test Account 34")
+      # No changes, so no records were updated.
+      expect(Z::Account.where(:name => @account.name).update_all(:name => "ZObject Integration Test Account 34")).to eq(0)
+
+      # Associations
+      @child = Z::Account.create!(
+        :parent_id => @account.id,
+        :name => "ZObject Integration Test Child Account",
+        :currency => Tenant.currency,
+        :status => "Draft",
+        :bill_cycle_day => 1)
+      expect(@account.children.to_a).to include(@child)
+      expect(@child.parent).to eq(@account)
+      # Make sure that the has_many pre-loads the inverse relationship.
+      @account.children.each { |child| expect(child.parent_loaded?).to be_truthy }
+
+      # Testing batch creates
+      batch_accounts = []
+      batch_number = 55
+      (1..batch_number).each do |i|
+        batch_accounts << Z::Account.new(
+          :name => @account.name,
+          :currency => Tenant.currency,
+          :status => "Draft",
+          :bill_cycle_day => 1)
+      end
+      expect(Z::Account.save(batch_accounts)).to eq(batch_number)
+
+      # Delete all
+      expect(Z::Account.where(:name => @account.name).delete_all).to be >= 1
+      @account = nil
+
+    end
+
+  end
+end