active_zuora 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a193209e8dc321e159f45d360a0b1b5a0f4458f
-  data.tar.gz: 5994cf1d464ebde4d2e674763eee752c8f6c6f13
+  metadata.gz: 1715d2a357d7e6e3e86de70a3895226ecec72db3
+  data.tar.gz: 9f2695af063c29dce60dd31ef7ffcfdbccf2e522
 SHA512:
-  metadata.gz: bcc832f90122ccc3e4d12bba198d83d28cee4c8fba77fcdbb6b42c86d1761fe69c032d175a1e520800ca71f0db4db528136cbfcd3b47026cf162d845d4469431
-  data.tar.gz: be5417128f8bce2c3d484c9a2403482472854b424a90e2b92ed3f7aef3db312158e25b828ca8eed941181b166f2b46b15c545bf68a55336df138c182a8f04aa5
+  metadata.gz: 853f119981d3ba11d661c7d8d79c9e0d53c63d34922c64520efdb9993c1238523b3c6a1c9a5cd06c123de767874f858f2ed55a9f16e76b7dd1ad41d0d3cc70df
+  data.tar.gz: eaa53ba199a1aac5e0520778b21034a54267211077cf691e2e78125a0b5ada2c151d52d076eb4b4874b7a59dc1b4b26feffabe6fc7f1706f4b18ad058010d2ac

data/CHANGELOG.markdown

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

data/lib/active_zuora.rb

@@ -18,6 +18,7 @@ require 'active_zuora/amend'
 require 'active_zuora/generate'
 require 'active_zuora/batch_subscribe'
 require 'active_zuora/collection_proxy'
+require 'active_zuora/lazy_attr'
 
 module ActiveZuora
 

data/lib/active_zuora/generator.rb

@@ -144,7 +144,12 @@ module ActiveZuora
 
       customize 'Invoice' do
         include Generate
-        exclude_from_queries :regenerate_invoice_pdf
+        include LazyAttr
+        # The body field can only be accessed for a single invoice at a time, so
+        # exclude it here to not break collections of invoices. The contents of
+        # the body field will be lazy loaded in when needed.
+        exclude_from_queries :regenerate_invoice_pdf, :body
+        lazy_load :body
       end
 
       customize 'InvoiceItemAdjustment' do

data/lib/active_zuora/lazy_attr.rb

@@ -0,0 +1,41 @@
+module ActiveZuora
+  module LazyAttr
+
+    # This is meant to be included onto an Invoice class.
+    # Returns true/false on success.
+    # Result hash is stored in #result.
+    # If success, the id will be set in the object.
+    # If failure, errors will be present on object.
+
+    extend ActiveSupport::Concern
+
+    included do
+      include Base
+    end
+
+
+    def fetch_field(field_name)
+      return nil unless self.id
+      query_string = "select #{self.class.get_field!(field_name).zuora_name} from #{zuora_object_name} where Id = '#{self.id}'"
+      response = self.class.connection.request(:query){ |soap| soap.body = { :query_string => query_string } }
+      response[:query_response][:result][:records][field_name.to_sym]
+    end
+    private :fetch_field
+
+    module ClassMethods
+      def lazy_load(*field_names)
+        Array(field_names).map(&:to_sym).each do |field_name|
+          define_lazy_field field_name
+        end
+      end
+
+      def define_lazy_field(field)
+        instance_eval do
+          define_method field do
+            instance_variable_get("@#{field}") || instance_variable_set("@#{field}", fetch_field(field))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_zuora/relation.rb

@@ -57,7 +57,7 @@ module ActiveZuora
       if relation.is_a?(Hash)
         where(relation)
       else
-        dup.tap do |dup| 
+        dup.tap do |dup|
           dup.filters.concat relation.filters
           dup.filters.uniq!
           dup.order_attribute = relation.order_attribute
@@ -155,7 +155,7 @@ module ActiveZuora
     protected
 
     def method_missing(method, *args, &block)
-      # This is how the chaing can happen on class methods or named scopes on the 
+      # This is how the chaing can happen on class methods or named scopes on the
       # ZObject class.
       if Array.method_defined?(method)
         to_a.send(method, *args, &block)
@@ -219,11 +219,11 @@ module ActiveZuora
       # Sometimes Zuora will return only a single record, not in an array.
       results = [results] unless results.is_a?(Array)
       results.map do |attributes|
-        # Strip any noisy attributes from the results that have to do with 
+        # Strip any noisy attributes from the results that have to do with
         # SOAP namespaces.
         attributes.delete_if { |key, value| key.to_s.start_with? "@" }
         # Instantiate the zobject class, but don't track the changes.
-        zobject_class.new(attributes).tap { |record| record.clear_changed_attributes }
+        zobject_class.new(attributes).tap { |record| record.changed_attributes.clear }
       end
     end
 
@@ -248,6 +248,6 @@ end
 
 
 
-    
+
 
 

data/lib/active_zuora/version.rb

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

data/spec/lazy_attr_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'LazyAttr' do
+  class TestInovice
+    include ActiveZuora::LazyAttr
+    lazy_load :test_body
+  end
+
+  subject { TestInovice.new }
+
+  it "should fetch a lazy loaded attribute from the api" do
+    expect(subject).to receive(:fetch_field).with(:test_body){ 'Jesse "The Body"' }
+    subject.test_body
+  end
+
+  it "should should not refetch an attribute after it's been loaded once" do
+    expect(subject).to receive(:fetch_field).with(:test_body).once { 'Jesse "The Body"' }
+    subject.test_body
+    subject.test_body
+  end
+
+end

data/spec/subscribe_integration_spec.rb

@@ -213,6 +213,7 @@ describe "Subscribe" do
       invoice.generate!
       expect(invoice.id).to be_present
       expect(invoice.account_id).to eq(subscribe_request.account.id)
+      expect(invoice.body).to be_present
     end
 
     it "Can successfully batch subscribe from a collection proxy of subscribe requests and generate an invoice for the first subscription" do
@@ -259,7 +260,7 @@ describe "Subscribe" do
           }
         }
       )
-      
+
       subscribe_request_2 = Z::SubscribeRequest.new(
         :account => {
           :name => "Joe Customer",
@@ -303,24 +304,20 @@ describe "Subscribe" do
           }
         }
       )
-      
+
       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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_zuora
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Ed Lebert
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -134,6 +134,7 @@ files:
 - lib/active_zuora/generator.rb
 - lib/active_zuora/has_many_associations.rb
 - lib/active_zuora/has_many_proxy.rb
+- lib/active_zuora/lazy_attr.rb
 - lib/active_zuora/persistence.rb
 - lib/active_zuora/relation.rb
 - lib/active_zuora/scoping.rb
@@ -146,6 +147,7 @@ files:
 - spec/collection_proxy_spec.rb
 - spec/connection_spec.rb
 - spec/has_many_integration_spec.rb
+- spec/lazy_attr_spec.rb
 - spec/spec_helper.rb
 - spec/subscribe_integration_spec.rb
 - spec/zobject_integration_spec.rb
@@ -181,6 +183,7 @@ test_files:
 - spec/collection_proxy_spec.rb
 - spec/connection_spec.rb
 - spec/has_many_integration_spec.rb
+- spec/lazy_attr_spec.rb
 - spec/spec_helper.rb
 - spec/subscribe_integration_spec.rb
 - spec/zobject_integration_spec.rb