zuora-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5415a26e1054e37bd49d820c0a79ce67afee2b23
+  data.tar.gz: be862d326b31f2f0133fd7b19084034ca30b55bf
+SHA512:
+  metadata.gz: 818e018dfaac566ef45e4824cc2de1c7c7910be67e89486a068b185f26a95b9b9c182c8d443b6dcb03fa5a7b6789dc487c6ccb45cef2d874fb70afd6935dbe3f
+  data.tar.gz: 24bed325e1caab98bda4d1fa7f9492346215392c2a5710106775102a0679673b55f484802126efba89de796117fdb2d889ae031083736bd3e4ae979c12e716af

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+.byebug_history

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  Exclude:
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'vendor/**/*'
+
+Style/Encoding:
+  Enabled: true
+
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+AbcSize:
+  Enabled: false
+
+MethodLength:
+  Enabled: true
+  Max: 25

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zuora.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 John Gerhardt
+
+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,198 @@
+[![Circle CI](https://circleci.com/gh/contactually/zuora-ruby.svg?style=shield&circle-token=808be5d625e91e331bedb37a2fe94412bb3bc15e)](https://circleci.com/gh/contactually/zuora-ruby)
+[![Code Climate](https://codeclimate.com/repos/569444dfa3d810003a00313f/badges/416bae00acf65d690efe/gpa.svg)](https://codeclimate.com/repos/569444dfa3d810003a00313f/feed)
+[![Test Coverage](https://codeclimate.com/repos/569444dfa3d810003a00313f/badges/416bae00acf65d690efe/coverage.svg)](https://codeclimate.com/repos/569444dfa3d810003a00313f/coverage)
+
+# Zuora REST API: Ruby Client
+
+This library implements a Ruby client wrapping Zuora's REST API.
+- **Validations** (via `activemodel`)
+- **HTTP** (via `faraday`)
+- **Serialization**: To/from Ruby / JSON
+
+## Quickstart
+```ruby
+# Connect
+client = Zuora::Client.new(username, password) 
+# Create a model
+account = Zuora::Models::Account.new(...)
+# Validate
+account.valid? # true or false, check account.errors if false
+# Select a serializer (snake_case -> lowerCamelCase)
+serializer = Zuora::Serializers::Attribute
+# Low level HTTP API
+client.get('/rest/v1/accounts', serializer.serialze account)
+# High Level Resource API 
+Zuora::Resources::Account.create! client, account, serializer
+```
+## Key Features & Concepts 
+1. ***Client:*** Create a client by providing username and password.
+This authenticates and stores the returned session cookie 
+used in subsequent requests. An optional third, truthy value enables Sandbox instead of production mode.
+
+2. ***HTTP:***
+Use `client.<get|post|put>(url, params)` to make HTTP requests via the authenticated client. Request and response body will be converted to/from Ruby via `farraday_middleware`. 
+
+3. ***Models:***  Ruby interface for constructing valid Zuora objects.
+  - `account = Zuora::Models::Account.new(:attribute => 'name')`
+  - `account.valid?`  a boolean indicating validity
+  - `account.errors`  a hash of error message(s)
+  - `account.attributes` an array of attribute names
+
+4. **Serializers:** Recursive data transformations for mapping between formats; a Ruby -> JSON serializer is included; `snake_case` attributes are transformed into JSON `lowerCamelCase` recursively in a nested structure.
+  - ex. `Zuora::Serializers::Attribute.serialize account` 
+  
+
+5. **Resources:** Wraps Zuora REST API endpoints. Hand a valid model and (optionally) a serializer to a Resource to trigger a request. Request will be made for valid models only. An exception will be raised if the model is invalid. Otherwise, a `Farraday::Response` object will be returned (responding to `.status`, `.headers`, and `.body`).
+
+6. **Factories:** Factories are set up for easily constructing Zuora requests in development (via `factory_girl`) 
+```ruby
+account = create :account, :credit_card => create(:credit_card),
+                           :sold_to_contact => create(:contact),
+                           :bill_to_contact => create(:contact)
+                           
+account.valid? # => true
+```
+7. **Test coverage:** Unit and integration specs coverage via `rspec`. Coming soon: HTTP response caching (using `VCR`)
+
+## Models
+Models implement (recursive, nested) Zuora validations using `ActiveModel::Model` and soon, dirty attribute tracking via `ActiveModel::Dirty`
+* Account
+* CardHolder
+* Contact
+* PaymentMethod::CreditCard
+* RatePlan
+* RatePlanCharge
+* Subscription
+* Tier
+
+## Resources 
+In module  `Zuora::Resources::` 
+* `Account.create!` **[working]**
+* `Account.update!` [in progress]
+* `Subscription.create!` [in progress]
+* `Subscription.update!` [in progress]
+* `Subscription.cancel!` [in progress]
+* `PaymentMethod.update!` [in progress]
+
+## Examples
+### Creating an Account
+
+```ruby
+username = 'your@username.com'
+password = 'super_secure_password'
+
+client = Zuora::Client.new(username, password, true) # true for sandbox
+
+account = Zuora::Models::Account.new(
+  :name => 'Abc',
+  :auto_pay => true,
+  :currency => 'USD',
+  :bill_cycle_day => '0',
+  :payment_term => 'Net 30',
+  :bill_to_contact => Zuora::Models::Contact.new(
+    :first_name => 'Abc',
+    :last_name => 'Def',
+    :address_1 => '123 Main St',
+    :city => 'Palm Springs',
+    :state => 'FL',
+    :zip_code => '90210',
+    :country => 'US'
+  ),
+  :sold_to_contact => Zuora::Models::Contact.new(
+    :first_name => 'Abc',
+    :last_name => 'Def',
+    :country => 'US'
+  ),
+  :credit_card => Zuora::Models::PaymentMethod.new(
+    :card_type => 'Visa',
+    :card_number => '4111111111111111',
+    :expiration_month => '03',
+    :expiration_year => '2017',
+    :security_code => '122',
+  )
+)
+
+# Create an account in one of two ways:
+
+serializer = Zuora::Serializers::Attribute
+
+# Using the low-level API exposed by `Client`
+response = client.post('/rest/v1/accounts', serializer.serialize accont)
+
+# or using the higher-level resource API
+response = Zuora::Resources::Accounts.create!(client, account, serializer)
+
+# Le response
+
+pp response
+
+#<Faraday::Response:0x007f8033b05f08
+ @env=
+  #<struct Faraday::Env
+   method=:post,
+   body=
+    {"success"=>true,
+     "accountId"=>"2c92c0fa521b466c0152250822741a71",
+     "accountNumber"=>"A00000038",
+     "paymentMethodId"=>"2c92c0fa521b466c0152250829c81a7b"},
+   url=#<URI::HTTPS https://apisandbox-api.zuora.com/rest/v1/accounts>,
+   request=
+    #<struct Faraday::RequestOptions
+     params_encoder=nil,
+     proxy=nil,
+     bind=nil,
+     timeout=nil,
+     open_timeout=nil,
+     boundary=nil,
+     oauth=nil>,
+   request_headers=
+    {"User-Agent"=>"Faraday v0.9.2",
+     "Content-Type"=>"application/json",
+     "Cookie"=>
+      "ZSession=LBToVw72ZCAQLjdZ9Ksj8rx2BlP3NbgmMYwCzuf_slSJqIhMbJjdQ1T-4otbdfjUOImQ_XJOCbJgdCd7jHmGsnnJyG49NyRkI7FVKOukVQtdJssJ5n1xAXJeVjxj3qj97iiIZp697v3G2w86iCTN6kWycUlSVezBElbC8_EhScbx8YmaP4QJxXRIFHHdOQPq3IN-9ezk21Cpq3fdXn6s0fIPMU7NUFj7-kD4dcYNBAyd7i2fJVAIV31mXNBH2MuU;"},
+   ssl=
+    #<struct Faraday::SSLOptions
+     verify=false,
+     ca_file=nil,
+     ca_path=nil,
+     verify_mode=nil,
+     cert_store=nil,
+     client_cert=nil,
+     client_key=nil,
+     certificate=nil,
+     private_key=nil,
+     verify_depth=nil,
+     version=nil>,
+   parallel_manager=nil,
+   params=nil,
+   response=#<Faraday::Response:0x007f8033b05f08 ...>,
+   response_headers=
+    {"server"=>"Zuora App",
+     "content-type"=>"application/json;charset=utf-8",
+     "expires"=>"Sat, 09 Jan 2016 06:17:18 GMT",
+     "cache-control"=>"max-age=0, no-cache, no-store",
+     "pragma"=>"no-cache",
+     "date"=>"Sat, 09 Jan 2016 06:17:18 GMT",
+     "content-length"=>"165",
+     "connection"=>"close",
+     "set-cookie"=>
+      "ZSession=dOz9WgdPQbb9J9wzwhuR_t1j9feD4dYBUEZ_sjK6pS9KAaJtPdKN-jAivNELsaANWMJrvHW_1eLxT7XqzjLVBJKzLDJT7_0ucvzcrwNcwMW8mUGpeUhQQu_h2HzNH1kZjc1HX6pfw-BH66BafLemLIdqL75ifmglk8YuTOf_wTg54GsovkrgJCAp9zferw6pYHkZoQUXyH7zmUmmWvMAZ1ZVamhLOf1P3FrrHaw6eIiUj0ehlKvrtxB-GHIgYxh6; Path=/; Secure; HttpOnly"},
+   status=200>,
+ @on_complete_callbacks=[]>
+```
+# Changelog
+* **[0.1.0] Initial release** 
+# Roadmap
+* **[0.1.1] Additional resources** See Resource list above
+* **[0.2.0] Add VCR** Fast, deterministic HTTP requests and responses
+* **[0.3.0] Dirty attribute tracking:** only serialize attributes that have been explicitly set. Currently, unset attributes are sent as `nil` which might override Zuora defaults.
+
+# Commit rights
+Anyone who has a patch accepted may request commit rights. Please do so inside the pull request post-merge.
+
+# Contributors
+* [John Gerhardt](https://github.com/jwg2s)
+* [Shaun Robinson](https://github.com/env)
+
+# License
+MIT License. Copyright 2016 Contactually, Inc. http://contactually.com

data/Rakefile

@@ -0,0 +1,7 @@
+# encoding: utf-8
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'bundler/setup'
+require 'zuora'
+
+# 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 'factory_girl'
+FactoryGirl.definition_file_paths = ['spec/zuora/factories']
+FactoryGirl.find_definitions
+# Short hand factory girl syntax
+include FactoryGirl::Syntax::Methods
+
+require 'irb'
+IRB.start

data/bin/setup

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

data/circle.yml

@@ -0,0 +1,3 @@
+test:
+  post:
+    - bundle exec rubocop

data/lib/zuora.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+# Dependencies
+require 'faraday'
+require 'json'
+require 'active_model'
+require 'active_model_serializers'
+require 'active_support'
+
+module Zuora
+  API_URL = 'https://api.zuora.com/rest/v1/'
+  SANDBOX_URL = 'https://apisandbox-api.zuora.com/rest/v1/'
+
+  STATE_ABBREVIATIONS = %w(AA AE AP AK AL AR AZ CA CO CT DC DE FL
+                           GA GU HI IA ID IL IN KS KY LA MA MD ME
+                           MI MN MO MS MT NC ND NE NH NJ NM NV NY
+                           OH OK OR PA PR RI SC SD TN TX UT VA VI
+                           VT WA WI WV WY)
+
+  CREDIT_CARD_TYPES = %w(Visa MasterCard Amex Discover)
+
+  MONTHS = %w(01 02 03 04 05 06 07 08 09 10 11 12)
+
+  PAYMENT_TERMS = ['Due Upon Receipt', 'Net 30', 'Net 60', 'Net 90']
+
+  SUBSCRIPTION_TERM_TYPES = %w(TERMED EVERGREEN)
+end
+
+require_relative 'zuora/version'
+require_relative 'zuora/client'
+require_relative 'zuora/models'
+require_relative 'zuora/serializers'
+require_relative 'zuora/resources'

data/lib/zuora/client.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+
+module Zuora
+  # Unable to connect. Check username / password
+  ConnectionError = Class.new StandardError
+
+  # Non-success response
+  ErrorResponse = Class.new StandardError
+
+  class Client
+    attr_accessor :connection
+
+    # Creates a connection instance.
+    # Makes an initial HTTP request to fetch session token.
+    # Subsequent requests made with .get, .post, and .put
+    # contain the authenticated session id in their headers.
+    # @param [String] username
+    # @param [String] password
+    # @param [Boolean] sandbox
+    # @return [Zuora::Client] with .connection, .put, .post
+    def initialize(username, password, sandbox = false)
+      url = api_url sandbox
+
+      response = connection(url).post do |req|
+        req.url '/rest/v1/connections'
+        req.headers['apiAccessKeyId'] = username
+        req.headers['apiSecretAccessKey'] = password
+        req.headers['Content-Type'] = 'application/json'
+      end
+
+      if response.status == 200
+        @auth_cookie = response.headers['set-cookie'].split(' ')[0]
+        @connection = connection(url)
+      else
+        fail ConnectionError, response.body['reasons']
+      end
+    end
+
+    # @param [String] url - URL of request
+    # @return [Faraday::Response] A response, with .headers, .status & .body
+    def get(url)
+      @connection.get do |req|
+        req.url url
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['Cookie'] = @auth_cookie
+      end
+    end
+
+    # @param [String] url - URL for HTTP POST request
+    # @param [Params] params - Data to be sent in request body
+    # @return [Faraday::Response] A response, with .headers, .status & .body
+    def post(url, params)
+      response = @connection.post do |req|
+        req.url url
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['Cookie'] = @auth_cookie
+        req.body = JSON.generate params
+      end
+
+      response
+      # if response.body['success']
+      #  return response
+      # else
+      #  raise ErrorResponse.new(response)
+      # end
+    end
+
+    # @param [String] url - URL for HTTP PUT request
+    # @param [Params] params - Data to be sent in request body
+    # @return [Faraday::Response] A response, with .headers, .status & .body
+    def put(url, params)
+      response = @connection.put do |req|
+        req.url url
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['Cookie'] = @auth_cookie
+        req.body = JSON.generate params
+      end
+
+      response
+      # if response.body['success']
+      #  return response
+      # else
+      #  raise ErrorResponse.new(response)
+      # end
+    end
+
+    private
+
+    # @param [String] url
+    # @return [Faraday::Client]
+    def connection(url)
+      Faraday.new(url, ssl: { verify: false }) do |conn|
+        conn.request :json
+        conn.response :json, content_type: /\bjson$/
+        conn.use :instrumentation
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    # @param [Boolean] sandbox - Use the sandbox url?
+    # @return [String] the API url
+    def api_url(sandbox)
+      if sandbox
+        Zuora::SANDBOX_URL
+      else
+        Zuora::API_URL
+      end
+    end
+  end
+end