active_zuora 1.5.2 → 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    active_zuora (2.0.0)
+      activemodel (>= 3.0.0, < 4.0.0)
+      activesupport (>= 3.0.0, < 4.0.0)
+      savon (~> 0.9.9)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    akami (1.0.0)
+      gyoku (>= 0.4.0)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    gyoku (0.4.5)
+      builder (>= 2.1.2)
+    httpi (0.9.7)
+      rack
+    i18n (0.6.0)
+    multi_json (1.5.0)
+    nokogiri (1.5.2)
+    nori (1.1.0)
+    rack (1.4.1)
+    rake (0.8.7)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    savon (0.9.9)
+      akami (~> 1.0)
+      builder (>= 2.1.2)
+      gyoku (>= 0.4.0)
+      httpi (~> 0.9)
+      nokogiri (>= 1.4.0)
+      nori (~> 1.1)
+      wasabi (~> 2.1)
+    wasabi (2.1.1)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_zuora!
+  rake (~> 0.8.7)
+  rspec (~> 2.8.0)

data/README.md

@@ -0,0 +1,155 @@
+# active_zuora - Auto-Generated ActiveModel Interface for Zuora
+
+[![TravisCI](https://secure.travis-ci.org/tstmedia/active_zuora.png "TravisCI")](http://travis-ci.org/tstmedia/active_zuora "Travis-CI ActiveZuora") [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/tstmedia/active_zuora)
+
+Use Zuora's API like ActiveRecord.  Auto-generate all the classes from the wsdl file, or easily declare your own.
+
+## Configuration
+
+    ActiveZuora.configure(
+      :username => 'user@example.com',
+      :password => 'password'
+    )
+
+Enable SOAP logging to stderr or provide your own wsdl file.
+
+    ActiveZuora.configure(
+      :username => 'user@example.com',
+      :password => 'password',
+      :log => true,
+      :wsdl => 'path/to/zuora.wsdl'
+    )
+
+## Defining Classes
+
+You can auto-generate all your Zuora classes from the wsdl file.  It will generate all Z-Objects, like Account and Subscription, and Zuora Complex objects, such as SubscribeRequest.
+
+    ActiveZuora.generate_classes
+
+By default, it will generate the classes inside the ActiveZuora module.  But you can specify a different nesting if you'd like.
+
+    ActiveZuora.generate_classes :under => SomeOtherModule
+
+Or, if you prefer, you can define your ZObjects or Complex Types manually.
+
+    class Account
+
+      include ActiveZuora::ZObject
+
+      field :name, :string
+      field :auto_pay, :boolean, :default => true
+      field :balance, :decimal
+      field :created_date, :datetime
+
+      has_many :subscriptions, :order => :name
+      has_many :active_subscriptions, :class_name => 'Subscription',
+        :conditions => { :status => 'Active' }, 
+        :order => [ :name, :desc ]
+      belongs_to :parent, :class_name => 'Account'
+      has_many :children, :class_name => 'Account', :foreign_key => :parent_id, :inverse_of => :parent
+
+      validates_presence_of :name
+
+    end
+
+    class SubscriptionData
+
+      include ActiveZuora::Base
+
+      field :subscription, :object
+      field :rate_plan_data, :object, :array => true
+
+    end
+
+## Saving, Updating, and Deleting
+
+These familiar functions are available: save, create, and update_attributes, along with ! versions that raise exceptions upon failure.
+
+    account = ActiveZuora::Account.new :name => "Frank's Pest Control"
+    account.new_record?
+    account.save
+
+    account = ActiveZuora::Account.create! :name => "Frank's Pest Control"
+    account.update_attributes :auto_pay => false, :currency => "USD"
+
+Changes are also tracked.
+
+    account = ActiveZuora::Account.new :name => "Frank's Pest Control"
+    account.changes # { :name => [nil, "Frank's Pest Control"] }
+    account.save!
+    account.changes # []
+
+Errors are captured using ActiveModel::Validations, or from error messages received from the server.
+  
+    account = ActiveZuora::Account.new
+    account.save # false
+    account.errors # { :base => ["Missing attribute: Name"] } # Returned from server.
+
+Delete a record with #delete.
+
+    account.delete
+
+## Querying
+
+    ActiveZuora::Account.find(id)
+
+    ActiveZuora::Account.where(:name => "Frank's Pest Control").all
+
+    ActiveZuora::Account.where(:name => { :like => '%Pest Control' }).count
+
+    ActiveZuora::Account.where(:auto_pay => true).or(:balance => 0).all
+
+    ActiveZuora::Account.select(:id, :name).where(:created_date => { "<" => Date.yesterday })
+
+There is no "order by" clause in the ZQL query language, but ActiveZuora's query system can post-sort results for you:
+
+    ActiveZuora::Account.where(:status => "Active").order(:name)
+
+    ActiveZuora::Account.where(:status => "Draft").order(:created_date, :desc)
+
+By default, every Query object caches the results once you call an array-like method on it.  However, if you know you'll have a very large result set and you just want to iterate through them without keeping them, you can use `find_each`.
+
+    ActiveZuora::Account.where(:status => "Active").find_each do |account|
+      ...
+    end
+
+## Scopes
+
+    ActiveZuora::Account.instance_eval do
+      scope :active, :status => "Active"
+      scope :draft, where(:status => "Draft")
+      scope :since, lambda { |datetime| where(:created_date => { ">=" => datetime }) }
+    end
+
+    ActiveZuora::Account.select(:id).draft.since(Date.new 2012).to_zql 
+    # => "select Id from Account where Status = 'Draft' and CreatedDate >= '2012-01-01T00:00:00+08:00'"
+
+Like ActiveRecord, you can also chain any class method on the ZObject, since named scopes are nothing more than class methods that return a Relation object.
+
+## Update or Delete Using Queries
+
+You can update or delete multiple records at once.  The following command issues two requests to the Zuora API server: the first to query for the records, and the second to update them all at once.  The method returns the count of records that were successfully updated.
+
+    ActiveZuora::Account.where(:status => "Draft").update_all :status => "Active" # 56
+
+You can also use a block to update your records, in case your updates depend on the records themselves.
+
+    ActiveZuora::Account.where(:status => "Draft").update_all do |account|
+      account.name += " (#{account.currency})"
+    end
+
+You can also delete all records matching a query as well.  The method returns the amount of records deleted.
+
+    ActiveZuora::Account.where(:status => "Draft").delete_all # 56
+
+## License
+
+Active Zuora is released under the MIT license: 
+
+http://www.opensource.org/licenses/MIT
+
+## Support
+
+Bug reports and feature requests can be filed as github issues here: 
+
+https://github.com/tstmedia/active_zuora/issues

data/Rakefile

@@ -1,28 +1,12 @@
 require "bundler/gem_tasks"
 require 'bundler'
 Bundler.setup
-require 'rake'
-require 'test-unit'
+require 'rspec/core/rake_task'
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+desc 'Default: run library specs.'
+task :default => :spec
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
+desc "Run library specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = ["./spec/**/*_spec.rb"]
 end
-
-task :default => :test
-

data/TODO.md

@@ -0,0 +1,2 @@
+* add deeper customizations for more classes in generator
+* add get_user_info and other operations

data/active_zuora.gemspec

@@ -1,72 +1,29 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: active_zuora 1.4.21 ruby lib
-
+$:.push File.expand_path("../lib", __FILE__)
+require "active_zuora/version"
+authors = {
+  "Ed Lebert" => "edlebert@gmail.com",
+  "Andy Fleener" => "andy.fleener@tstmedia.com",
+}
 Gem::Specification.new do |s|
-  s.name = "active_zuora"
-  s.version = "1.5.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.name        = "active_zuora"
+  s.version     = ActiveZuora::VERSION.to_s
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = authors.keys
+  s.email       = authors.values
+  s.homepage    = "https://github.com/tstmedia/active_zuora"
+  s.summary     = %q{ActiveZuora - Zuora API that looks and feels like ActiveRecord.}
+  s.description = %q{ActiveZuora - Zuora API based on ActiveModel and auto-generated from your zuora.wsdl.}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.authors = ["Andy Fleener", "Ed Lebert", "Nate Greene"]
-  s.date = "2015-04-10"
-  s.description = "A client for Zuora API"
-  s.email = "andy.fleener@tstmedia.com"
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    "Rakefile",
-    "VERSION",
-    "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/soap/property",
-    "lib/zuora/ZUORA.rb",
-    "lib/zuora/ZUORADriver.rb",
-    "lib/zuora/ZUORAMappingRegistry.rb",
-    "lib/zuora/ZuoraServiceClient.rb",
-    "lib/zuora/api.rb",
-    "lib/zuora_client.rb",
-    "lib/zuora_interface.rb"
-  ]
-  s.homepage = "http://github.com/tstmedia/active_zuora"
-  s.requirements = ["none"]
-  s.rubygems_version = "2.4.6"
-  s.summary = "Active Zuora"
-  s.add_dependency('soap4r-ng')
-  s.add_development_dependency('rake')
-  s.add_development_dependency('test-unit')
-end
+  s.extra_rdoc_files = [ "README.md" ]
 
+  s.add_runtime_dependency('savon', ["~> 0.9.9"])
+  s.add_runtime_dependency('activesupport', [">= 3.0.0", "< 4.0.0"])
+  s.add_runtime_dependency('activemodel', [">= 3.0.0", "< 4.0.0"])
+
+  s.add_development_dependency('rake', ["~> 0.8.7"])
+  s.add_development_dependency('rspec', ["~> 2.8.0"])
+end

data/lib/active_zuora.rb

@@ -1,8 +1,39 @@
-require 'delegate'
-require 'zuora_client'
-require 'active_zuora/zobject.rb'
-Dir[File.join(File.dirname(__FILE__),"active_zuora","*.rb")].each do |file| 
-  require file
-end
+require 'savon'
+require 'active_model'
+require 'active_support/all'
+
+require 'active_zuora/connection'
+require 'active_zuora/generator'
+require 'active_zuora/fields'
+require 'active_zuora/belongs_to_associations'
+require 'active_zuora/base'
+require 'active_zuora/relation'
+require 'active_zuora/scoping'
+require 'active_zuora/persistence'
+require 'active_zuora/has_many_proxy'
+require 'active_zuora/has_many_associations'
+require 'active_zuora/z_object'
+require 'active_zuora/subscribe'
+require 'active_zuora/amend'
+require 'active_zuora/generate'
+
+module ActiveZuora
 
+  # Setup configuration.  None of this sends a request.
+  def self.configure(configuration)
+    # Set some sensible defaults with the savon SOAP client.
+    Savon.configure do |config|
+      config.log = HTTPI.log = configuration[:log] || false
+      config.log_level = configuration[:log_level] || :info
+      config.raise_errors = true
+    end
+    # Create a default connection on Base
+    Base.connection = Connection.new(configuration)
+  end
 
+  def self.generate_classes(options={})
+    generator = Generator.new(Base.connection.soap_client.wsdl.parser, options)
+    generator.generate_classes
+  end
+
+end

data/lib/active_zuora/amend.rb

@@ -0,0 +1,43 @@
+module ActiveZuora
+  module Amend
+
+    # This is meant to be included onto a AmendRequest class.
+    # Returns true/false on success.
+    # Result hash is stored in #result.
+    # If success, the ids will be set in the given amendments.
+    # If failure, errors will be present on object.
+
+    extend ActiveSupport::Concern
+
+    included do
+      include Base
+      attr_accessor :result
+    end
+
+    def amend
+      self.result = self.class.connection.request(:amend) do |soap|
+        soap.body do |xml| 
+          build_xml(xml, soap, 
+            :namespace => soap.namespace,
+            :element_name => :requests,
+            :force_type => true)
+        end
+      end[:amend_response][:results]
+      if result[:success]
+        [result[:amendment_ids]].flatten.compact.each_with_index do |id, i|
+          amendments[i].id = id
+        end
+        clear_changed_attributes
+        true
+      else
+        add_zuora_errors(result[:errors])
+        false
+      end
+    end
+
+    def amend!
+      raise "Could not amend: #{errors.full_messages.join ', '}" unless amend
+    end
+
+  end
+end

data/lib/active_zuora/base.rb

@@ -0,0 +1,73 @@
+require 'bigdecimal'
+require 'bigdecimal/util'
+
+module ActiveZuora
+  module Base
+
+    extend ActiveSupport::Concern
+
+    # This is the default connection object to use for all Base classes.
+    # Each individual Base class can overwrite it.
+    class << self
+      attr_accessor :connection
+    end
+
+    included do
+      include Fields
+      include ActiveModel::Validations
+      include BelongsToAssociations
+      class << self
+        attr_accessor :namespace
+        attr_writer :zuora_object_name
+        attr_writer :connection
+      end
+      delegate :namespace, :zuora_object_name, :to => 'self.class'
+    end
+
+    def xml_field_names
+      # Which field names should be rendered during build_xml.
+      # Choose only field names that have been changed.
+      # Make sure the order in fields is maintained.
+      field_names & changed.map(&:to_sym)
+    end
+
+    def build_xml(xml, soap, options={})
+      namespace = options.delete(:namespace) || self.namespace
+      qualifier = soap.namespace_by_uri(namespace)
+      custom_element_name = options.delete(:element_name)
+      element_name = custom_element_name || zuora_object_name
+      attributes = options.delete(:force_type) ? 
+        { "xsi:type" => "#{qualifier}:#{zuora_object_name}" } : {}
+      xml.tag!(qualifier, element_name.to_sym, attributes) do
+        xml_field_names.map { |field_name| get_field!(field_name) }.each do |field|
+          field.build_xml(xml, soap, send(field.name), options)
+        end
+      end
+    end
+
+    def add_zuora_errors(zuora_errors)
+      return if zuora_errors.blank?
+      zuora_errors = [zuora_errors] unless zuora_errors.is_a?(Array)
+      zuora_errors.each { |error| errors.add(:base, error[:message].capitalize) }
+    end
+
+    module ClassMethods
+
+      def zuora_object_name
+        @zuora_object_name ||= self.name.split("::").last
+      end
+
+      def connection
+        @connection || Base.connection
+      end
+
+      def nested_class_name(unnested_class_name)
+        # This helper method will take a class name, and nest it inside
+        # the same module/class as self.
+        (name.split("::")[0..-2] << unnested_class_name).join("::")
+      end
+
+    end
+
+  end
+end