zuora_rest_client 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8688e729d34d999158bf6a54f7d81684847b419f
+  data.tar.gz: 395af0820799b67d2d158bb6ef652b95c5ab53fe
+SHA512:
+  metadata.gz: f5d8fbf991658ef2e255e76061710d51328041637e7868735fb84e1c16a6ec27cf9e4bd4fe476dc6c1f47d05b32726f7508dd7c498ef3276bf6f67f1a5fac283
+  data.tar.gz: 0c7c86429d7048cb515abde95353ede90fd046814c035897b34850c866c1cdcde206adac7bf1a5371f64a8f4fd2d9cc7af6e26d01a0d24aa2a29dc5aae10a1e9

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.idea
+/.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zuora_rest_client.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright 2017 Frontera Consulting, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# ZuoraRestClient
+
+This is a simple Zuora client for Ruby.  It mainly consists of methods that 
+wrap the operations described in the Zuora API Reference 
+(https://www.zuora.com/developer/api-reference), as well as a few helper methods.
+
+Most of the methods take either the query parameters and/or a hash representing the JSON
+request body as arguments.  The methods return a `ZuoraRestClient::Result` object which
+represents ths JSON response.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zuora_rest_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zuora_rest_client
+
+## Usage
+
+First, construct a client object:
+```ruby
+username = 'zuora_username@example.com'
+password = 'mypassword'
+client = ZuoraRestClient::Client.new(username, password)  # Create a production client
+```
+
+For a sandbox tenant, you can specify the following:
+```ruby
+client = ZuoraRestClient::Client.new(username, password, :api_sandbox)  # Create an api sandbox client
+```
+
+Call one of the client methods.  For example, to create an account:
+```ruby
+account_to_create = {
+    Batch: 'Batch1',
+    BillCycleDay: 15,
+    Currency: 'USD',
+    Name: 'Test Account',
+    PaymentTerm: 'Due Upon Receipt',
+    Status: 'Draft' }
+result = client.create_account_object(account_to_create) # Returns an object representation of the JSON response
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/FronteraConsulting/zuora_rest_client.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zuora_rest_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fixtures/vcr_cassettes/zuora/create_account_object_success.yml

@@ -0,0 +1,59 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://rest.zuora.com/v1/object/account
+    body:
+      encoding: UTF-8
+      string: '{"Batch":"Batch1","BillCycleDay":15,"Currency":"USD","Name":"Test Account","PaymentTerm":"Due
+        Upon Receipt","Status":"Draft"}'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Fri, 09 Jun 2017 17:38:31 GMT
+      Content-Type:
+      - application/json
+      Apiaccesskeyid:
+      - "{ZUORA_USERNAME}"
+      Apisecretaccesskey:
+      - "{ZUORA_PASSWORD}"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - kong/0.9.9
+      X-Request-Id:
+      - 5c7bf3bb-9808-4343-9843-b3bac54d3445
+      X-Kong-Upstream-Latency:
+      - '363'
+      X-Kong-Proxy-Latency:
+      - '0'
+      Expires:
+      - Fri, 09 Jun 2017 17:38:31 GMT
+      Cache-Control:
+      - max-age=0, no-cache, no-store
+      Pragma:
+      - no-cache
+      Date:
+      - Fri, 09 Jun 2017 17:38:31 GMT
+      Content-Length:
+      - '57'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"Success":true,"Id":"2c92a0fe5c7d8185015c8defa5374aa8"}
+
+'
+    http_version: 
+  recorded_at: Fri, 09 Jun 2017 17:38:31 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/zuora/create_account_success.yml

@@ -0,0 +1,66 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://rest.zuora.com/v1/accounts
+    body:
+      encoding: UTF-8
+      string: '{"batch":"Batch1","billCycleDay":15,"billToContact":{"country":"US","firstName":"Test","lastName":"User","state":"TX"},"creditCard":{"cardHolderInfo":{"addressLine1":"123
+        Anystreet Lane","cardHolderName":"Test User","city":"Anytown","country":"US","state":"TX","zipCode":"00000"},"cardNumber":"4111111111111111","cardType":"Visa","expirationMonth":"12","expirationYear":"2099","securityCode":"123"},"currency":"USD","name":"Test
+        Account","paymentTerm":"Due Upon Receipt"}'
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Fri, 09 Jun 2017 17:38:30 GMT
+      Content-Type:
+      - application/json
+      Apiaccesskeyid:
+      - "{ZUORA_USERNAME}"
+      Apisecretaccesskey:
+      - "{ZUORA_PASSWORD}"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json;charset=utf-8
+      Server:
+      - Zuora App
+      X-Request-Id:
+      - 7ab05a60-723b-4a2e-9f5b-fa352908261f
+      X-Kong-Upstream-Latency:
+      - '188'
+      X-Kong-Proxy-Latency:
+      - '0'
+      Expires:
+      - Fri, 09 Jun 2017 17:38:30 GMT
+      Cache-Control:
+      - max-age=0, no-cache, no-store
+      Pragma:
+      - no-cache
+      Date:
+      - Fri, 09 Jun 2017 17:38:30 GMT
+      Content-Length:
+      - '165'
+      Connection:
+      - keep-alive
+      Set-Cookie:
+      - ZSession={ZUORA_SESSION_ID}; Path=/; Secure; HttpOnly
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "success" : true,
+          "accountId" : "2c92a0fd5c832adb015c8def9fd9081c",
+          "accountNumber" : "Z00324059",
+          "paymentMethodId" : "2c92a0fd5c832adb015c8def9fff0822"
+        }
+    http_version: 
+  recorded_at: Fri, 09 Jun 2017 17:38:30 GMT
+recorded_with: VCR 3.0.3

data/fixtures/vcr_cassettes/zuora/delete_account_object_success.yml

@@ -0,0 +1,223 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://rest.zuora.com/v1/object/account/2c92a0fd5c832adb015c8def9fd9081c
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Fri, 09 Jun 2017 17:38:32 GMT
+      Content-Type:
+      - application/json
+      Apiaccesskeyid:
+      - "{ZUORA_USERNAME}"
+      Apisecretaccesskey:
+      - "{ZUORA_PASSWORD}"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - kong/0.9.9
+      X-Request-Id:
+      - 13ee5884-cbc3-4803-8948-db99ac4436fc
+      X-Kong-Upstream-Latency:
+      - '262'
+      X-Kong-Proxy-Latency:
+      - '0'
+      Expires:
+      - Fri, 09 Jun 2017 17:38:32 GMT
+      Cache-Control:
+      - max-age=0, no-cache, no-store
+      Pragma:
+      - no-cache
+      Date:
+      - Fri, 09 Jun 2017 17:38:32 GMT
+      Content-Length:
+      - '57'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"id":"2c92a0fd5c832adb015c8def9fd9081c","success":true}
+
+'
+    http_version: 
+  recorded_at: Fri, 09 Jun 2017 17:38:32 GMT
+- request:
+    method: get
+    uri: https://rest.zuora.com/v1/object/account/2c92a0fd5c832adb015c8def9fd9081c
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Fri, 09 Jun 2017 17:38:32 GMT
+      Content-Type:
+      - application/json
+      Apiaccesskeyid:
+      - "{ZUORA_USERNAME}"
+      Apisecretaccesskey:
+      - "{ZUORA_PASSWORD}"
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - kong/0.9.9
+      X-Request-Id:
+      - 5a5b0781-f65c-463b-a032-71e7b4ff47a8
+      X-Kong-Upstream-Latency:
+      - '84'
+      X-Kong-Proxy-Latency:
+      - '0'
+      Expires:
+      - Fri, 09 Jun 2017 17:38:33 GMT
+      Cache-Control:
+      - max-age=0, no-cache, no-store
+      Pragma:
+      - no-cache
+      Date:
+      - Fri, 09 Jun 2017 17:38:33 GMT
+      Content-Length:
+      - '36'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"records":[],"size":0,"done":true}
+
+'
+    http_version: 
+  recorded_at: Fri, 09 Jun 2017 17:38:33 GMT
+- request:
+    method: delete
+    uri: https://rest.zuora.com/v1/object/account/2c92a0fe5c7d8185015c8defa5374aa8
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Fri, 09 Jun 2017 17:38:33 GMT
+      Content-Type:
+      - application/json
+      Apiaccesskeyid:
+      - "{ZUORA_USERNAME}"
+      Apisecretaccesskey:
+      - "{ZUORA_PASSWORD}"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - kong/0.9.9
+      X-Request-Id:
+      - 5a6fc2fc-2b07-46fd-853a-35c61b8fc770
+      X-Kong-Upstream-Latency:
+      - '200'
+      X-Kong-Proxy-Latency:
+      - '0'
+      Expires:
+      - Fri, 09 Jun 2017 17:38:33 GMT
+      Cache-Control:
+      - max-age=0, no-cache, no-store
+      Pragma:
+      - no-cache
+      Date:
+      - Fri, 09 Jun 2017 17:38:33 GMT
+      Content-Length:
+      - '57'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"id":"2c92a0fe5c7d8185015c8defa5374aa8","success":true}
+
+'
+    http_version: 
+  recorded_at: Fri, 09 Jun 2017 17:38:33 GMT
+- request:
+    method: get
+    uri: https://rest.zuora.com/v1/object/account/2c92a0fe5c7d8185015c8defa5374aa8
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - HTTPClient/1.0 (2.8.3, ruby 2.4.1 (2017-03-22))
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip,deflate
+      Date:
+      - Fri, 09 Jun 2017 17:38:33 GMT
+      Content-Type:
+      - application/json
+      Apiaccesskeyid:
+      - "{ZUORA_USERNAME}"
+      Apisecretaccesskey:
+      - "{ZUORA_PASSWORD}"
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Server:
+      - kong/0.9.9
+      X-Request-Id:
+      - 64cf96fb-47c0-49f1-9df3-28fd8f714843
+      X-Kong-Upstream-Latency:
+      - '289'
+      X-Kong-Proxy-Latency:
+      - '0'
+      Expires:
+      - Fri, 09 Jun 2017 17:38:33 GMT
+      Cache-Control:
+      - max-age=0, no-cache, no-store
+      Pragma:
+      - no-cache
+      Date:
+      - Fri, 09 Jun 2017 17:38:33 GMT
+      Content-Length:
+      - '36'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"records":[],"size":0,"done":true}
+
+'
+    http_version: 
+  recorded_at: Fri, 09 Jun 2017 17:38:33 GMT
+recorded_with: VCR 3.0.3