zuora4r 1.0.0

data/LICENSE

@@ -0,0 +1,202 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.rdoc

@@ -0,0 +1,22 @@
+= zuora4r
+
+Client for Zuora API
+
+This is a wrapper for sample code provided by Zuora - http://developer.zuora.com/samplecode.html
+It contains minor changes as well as added support for 'generate' API call
+It also provides scripts to run arbitrary Zuora Object queries and make payment & bill runs.
+
+== Installing the Gem
+    $ sudo gem sources -a http://gemcutter.org
+    $ sudo gem install zuora4r
+
+== Usage
+   zuora-query -u <username> -p <password> -e [prod|sandbox] <query>
+
+   zuora-payment-run -u <username> -p <password> -e [prod|sandbox] -a <account id> -i <invoice id> -d <effective date> -m <payment method id>
+
+   zuora-bill-run -u <username> -p <password> -e [prod|sandbox] -a <account id> -i <invoice date> -t <target date>
+
+== Copyright
+
+Copyright (c) 2010 Ning. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "zuora4r"
+    gem.version = "1.0.0"
+    gem.summary = "Zuora4r"
+    gem.description = "A client for Zuora API"
+    gem.email = "gene@ning.com"
+    gem.homepage = "http://github.com/cloocher/zuora4r"
+    gem.authors = ["Cloocher"]
+    gem.files = FileList["CHANGES", "zuora4r.gemspec", "Rakefile", "README", "VERSION",
+        "lib/**/*", "bin/**/*"]
+    gem.add_dependency "soap4r", ">= 1.5.8"
+    gem.add_dependency "json_pure", ">= 1.4.6"
+    gem.executables = ['zuora-query', 'zuora-bill-run', 'zuora-payment-run', 'zq']
+    gem.requirements = ["none"]
+    gem.bindir = "bin"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+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
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "zuora4r #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/zq

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+load File.dirname(__FILE__) + '/zuora-query'

data/bin/zuora-bill-run

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2010 Ning
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+$:.unshift(File::join(File::dirname(File::dirname(__FILE__)), 'lib'))
+
+require 'rubygems'
+require 'optparse'
+require 'json/pure'
+require 'zuora_client'
+
+username = nil
+password = nil
+environment = 'prod'
+account_id = nil
+invoice_date = nil
+target_date = nil
+
+
+opts = OptionParser.new do |opts|
+  opts.banner = 'Usage: zuora-payment-run -u <username> -p <password> -e [prod|sandbox] -a <account id> -i <invoice date> -t <target date>'
+  opts.on('-u', '--user USERNAME', 'username') { |u| username = u }
+  opts.on('-p', '--pass PASSWORD', 'password') { |p| password = p }
+  opts.on('-e', '--env ENVIRONMENT', '[prod|sandbox] (default: prod)') { |e| environment = e }
+  opts.on('-a', '--accountId ACCOUNT ID', 'account id') { |e| account_id = e }
+  opts.on('-i', '--invoiceDate INVOICE DATE', 'invoice date') { |e| invoice_date = e }
+  opts.on('-t', '--targetDate TARGET DATE', 'target date') { |e| target_date = e }
+  opts.on('-v', '--verbose', 'log harder') { $ZUORA_VERBOSE = true }
+end
+
+if ARGV.empty?
+  puts opts
+  exit
+end
+
+opts.parse!(ARGV)
+
+unless username and password and account_id and invoice_date and target_date
+  puts opts
+  exit 1
+end
+
+url = case environment.downcase
+  when 'sandbox'
+    ZuoraClient::SANDBOX_URL
+  else
+    ZuoraClient::PROD_URL
+end
+
+zuora_client = ZuoraClient.new(username, password, url)
+
+
+bill_run = ZUORA::BillRun.new
+bill_run.accountId = account_id
+bill_run.includesOneTime = true
+bill_run.includesRecurring = true
+bill_run.includesUsage = true
+bill_run.invoiceDate = invoice_date
+bill_run.targetDate = target_date
+
+result = zuora_client.generate([bill_run])
+
+if result && result.first[:success]
+  invoice = ZUORA::Invoice.new
+  invoice.id = result.first[:id]
+  invoice.status = 'Posted'
+
+  result = zuora_client.update([invoice])
+end
+
+
+puts JSON.pretty_generate(result) if result

data/bin/zuora-payment-run

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2010 Ning
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+$:.unshift(File::join(File::dirname(File::dirname(__FILE__)), 'lib'))
+
+require 'rubygems'
+require 'optparse'
+require 'json/pure'
+require 'zuora_client'
+
+username = nil
+password = nil
+environment = 'prod'
+account_id = nil
+invoice_id = nil
+effective_date = nil
+payment_method_id = nil
+
+
+opts = OptionParser.new do |opts|
+  opts.banner = 'Usage: zuora-payment-run -u <username> -p <password> -e [prod|sandbox] -a <account id> -i <invoice id> -d <effective date> -m <payment method id>'
+  opts.on('-u', '--user USERNAME', 'username') { |u| username = u }
+  opts.on('-p', '--pass PASSWORD', 'password') { |p| password = p }
+  opts.on('-e', '--env ENVIRONMENT', '[prod|sandbox] (default: prod)') { |e| environment = e }
+  opts.on('-a', '--accountId ACCOUNT ID', 'account id') { |e| account_id = e }
+  opts.on('-i', '--invoiceId INVOICE_ID', 'invoice_id') { |e| invoice_id = e }
+  opts.on('-d', '--effectiveDate EFFECTIVE DATE', 'effective date') { |e| effective_date = e }
+  opts.on('-m', '--paymentMethodId PAYMENT_METHOD_ID', 'payment method id') { |e| payment_method_id = e }
+  opts.on('-v', '--verbose', 'log harder') { $ZUORA_VERBOSE = true }
+end
+
+if ARGV.empty?
+  puts opts
+  exit
+end
+
+opts.parse!(ARGV)
+
+unless username and password and account_id and invoice_id and effective_date and payment_method_id
+  puts opts
+  exit 1
+end
+
+url = case environment.downcase
+  when 'sandbox'
+    ZuoraClient::SANDBOX_URL
+  else
+    ZuoraClient::PROD_URL
+end
+
+zuora_client = ZuoraClient.new(username, password, url)
+
+result = zuora_client.query("select Balance from Invoice where Id = '%s'" % invoice_id)
+if result.empty?
+  puts "Invalid invoice_id '#{invoice_id}'"
+  exit 1
+end
+amount = result.first['balance']
+
+payment = ZUORA::Payment.new
+payment.accountId = account_id
+payment.amount = amount
+payment.effectiveDate = effective_date
+payment.paymentMethodId = payment_method_id
+payment.status = 'Draft'
+payment.type = 'Electronic'
+
+result = zuora_client.create([payment])
+
+if result && result.first[:success]
+  payment_id = result.first[:id]
+  invoice_payment = ZUORA::InvoicePayment.new
+  invoice_payment.amount = amount
+  invoice_payment.invoiceId = invoice_id
+  invoice_payment.paymentId = payment_id
+
+  result = zuora_client.create([invoice_payment])
+
+  if result && result.first[:success]
+    payment = ZUORA::Payment.new
+    payment.id = payment_id
+    payment.status = 'Processed'
+
+    result = zuora_client.update([payment])
+  end
+
+end
+
+puts JSON.pretty_generate(result) if result

data/bin/zuora-query

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2010 Ning
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+$:.unshift(File::join(File::dirname(File::dirname(__FILE__)), 'lib'))
+
+require 'rubygems'
+require 'optparse'
+require 'json/pure'
+require 'zuora_client'
+
+username = nil
+password = nil
+environment = 'prod'
+
+opts = OptionParser.new do |opts|
+  opts.banner = 'Usage: zuora-client -u <username> -p <password> -e [prod|sandbox] <query>'
+  opts.on('-u', '--user USERNAME', 'username') { |u| username = u }
+  opts.on('-p', '--pass PASSWORD', 'password') { |p| password = p }
+  opts.on('-e', '--env ENVIRONMENT', '[prod|sandbox] (default: prod)') { |e| environment = e }
+  opts.on('-v', '--verbose', 'log harder') { $ZUORA_VERBOSE = true }
+end
+
+if ARGV.empty?
+  puts opts
+  exit
+end
+
+remainder = opts.parse!(ARGV)
+query_string = remainder.join ' '
+
+unless username and password
+  puts opts
+  exit 1
+end
+
+url = case environment.downcase
+  when 'sandbox'
+    ZuoraClient::SANDBOX_URL
+  else
+    ZuoraClient::PROD_URL
+end
+
+zuora_client = ZuoraClient.new(username, password, url)
+
+result = zuora_client.query(query_string)
+
+puts JSON.pretty_generate(result) if result