iron_bank 0.1.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dd100e5b7115b9b39dbfcd109c4adae615678d57
-  data.tar.gz: 58ff1e70efa3e8c0ca9094f822d1da26e9690975
+SHA256:
+  metadata.gz: 2baff3984f831ae315a8b7bf48a2c72156cfcef01aa83fa54622afc85d81c23a
+  data.tar.gz: 15b484fd7ba61b56617e1c12e1fa29d3438cf6d77824fe2f5c923c3bfde7c03a
 SHA512:
-  metadata.gz: af879669462e137f9ac997c19aa846ee59a78fa0999b0086ad385887be45029b5ed99fd6858cf71458a4ce5b425d4bafb8007c52a4f2e4206f87b783c3bc391c
-  data.tar.gz: 571c46b0f7d8ae9d34de174e923a195020e710bbf24ec395a176a4b73e59e22e34d2b63e75ae0697fa28a4273c858f0294b6813b147d8d68f0c898f57b130b72
+  metadata.gz: 5cc8e60a59e548572627bc9546e5e81f481f7f19b83ca6602925e9776fc4d8e8c60a237b3ee644d822b557c470d45fd9b5b9acfa2e8807f3484b71195189d78e
+  data.tar.gz: 31652f97be5d13281b0cd63cb72b11d6ddc14e2838ca6f7da51cf391117e2c6cf56b4ebe7d0636abce3e6c472db13a61408be484f41eb06c92e1885aa154782c

data/.env.example

@@ -0,0 +1,7 @@
+ZUORA_CLIENT_ID=something
+ZUORA_CLIENT_SECRET=secret
+ZUORA_AUTH_TYPE=token
+ZUORA_DOMAIN=rest.apisandbox.zuora.com
+ZUORA_TENANT_ID=00000
+OPEN_TRACING_ENABLED=false
+OPEN_TRACING_SERVICE_NAME=ironbank

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @zendesk/narwhals @zendesk/walrus

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+cc: :whale2: @zendesk/billing
+
+### Description
+Describe what your changes are and what is the motivation behind them.
+
+### Notes
+Extra information (technical references, etc.) that you would like the reviewers
+to be aware of.
+
+### Tasks
+- [ ] TODO item before it can be reviewed and/or merged
+- [ ] Another TODO item
+
+### References
+- JIRA ticket or PR link
+- Another JIRA ticket or PR link
+
+### Risks
+**High.** Because reasons. Use **High**, **Medium**, or **Low** to indicate risk
+profile of the change.

data/.gitignore

@@ -1,13 +1,18 @@
 /.bundle/
 /.yardoc
+/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
-Gemfile.lock
+/config/
 *.gem
+.env
 
 # rspec failure tracking
 .rspec_status
+
+# byebug history
+.byebug_history

data/.reek

@@ -0,0 +1,95 @@
+---
+
+# Exclude vendor/bundle directory for Travis
+exclude_paths:
+  - vendor/bundle
+
+Attribute:
+  exclude:
+    - IronBank#client
+    - IronBank#configuration
+    - IronBank::Configuration#auth_type
+    - IronBank::Configuration#cache
+    - IronBank::Configuration#client_id
+    - IronBank::Configuration#client_secret
+    - IronBank::Configuration#domain
+    - IronBank::Configuration#export_directory
+    - IronBank::Configuration#instrumenter
+    - IronBank::Configuration#instrumenter_options
+    - IronBank::Configuration#logger
+    - IronBank::Configuration#open_tracing_enabled
+    - IronBank::Configuration#open_tracing_service_name
+    - IronBank::Configuration#schema_directory
+
+BooleanParameter:
+  exclude:
+    - IronBank::Cacheable::ClassMethods#find
+
+DuplicateMethodCall:
+  exclude:
+    - IronBank::Utils#camelize
+    - IronBank::Local#all
+
+FeatureEnvy:
+  exclude:
+    - IronBank::Client#connection
+    - IronBank::Authentications::Cookie#connection
+    - IronBank::Authentications::Token#connection
+    - IronBank::Configuration#schema_directory=
+    - IronBank::Resource#==
+    - IronBank::Object#camelize
+    - IronBank::Object#underscore
+    - IronBank::Actions::Subscribe#hash_args
+    - IronBank::Utils#camelize
+
+IrresponsibleModule:
+  exclude:
+    - Sample
+
+ManualDispatch:
+  exclude:
+    - IronBank::Resource#inspect
+
+NestedIterators:
+  exclude:
+    - IronBank::Schema#self.import
+    - IronBank::Local#where
+    - IronBank::Local#load_records
+    - IronBank::Resources::ProductRatePlanChargeTier#self.load_records
+
+NilCheck:
+  exclude:
+    - IronBank::Local#load_records
+    - IronBank::Resources::ProductRatePlanChargeTier#self.load_records
+
+TooManyInstanceVariables:
+  max_instance_variables: 6
+
+TooManyStatements:
+  exclude:
+    - IronBank::Associations::ClassMethods#with_many
+    - IronBank::Associations::ClassMethods#with_one
+    - IronBank::Authentications::Cookie#connection
+    - IronBank::Authentications::Token#connection
+    - IronBank::Client#connection
+    - IronBank::Configuration#schema_directory=
+    - IronBank::Configuration#initialize
+    - IronBank::Queryable#find_each
+    - IronBank::Queryable#where
+    - IronBank::Utils#camelize
+    - IronBank::Utils#underscore
+    - IronBank::Resources::ProductRatePlanChargeTier#self.load_records
+    - IronBank::Error#self.from_response
+
+UtilityFunction:
+  exclude:
+    - IronBank::Cacheable::ClassMethods#cache
+    - IronBank::Object#convert
+    - IronBank::Object#camelize_array
+    - IronBank::Object#underscore_array
+    - IronBank::OpenTracing#open_tracing_enabled?
+    - IronBank::QueryBuilder#range_query_builder
+    - IronBank::Utils#lower_camelize
+    - IronBank::Utils#upper_camelize
+    - IronBank::Instrumentation#instrumenter
+    - IronBank::Instrumentation#instrumenter_options

data/.rspec

@@ -1,3 +1,2 @@
---format documentation
+--format progress
 --color
---require spec_helper

data/.rubocop.yml

@@ -0,0 +1,55 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.3
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Lint/UselessAssignment:
+  Exclude:
+    - bin/console
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/iron_bank/associations.rb
+    - lib/iron_bank/client.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - iron_bank.gemspec
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - lib/iron_bank/error.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - lib/iron_bank/utils.rb
+    - lib/iron_bank/associations.rb
+    - lib/iron_bank/queryable.rb
+    - lib/iron_bank/resources/product_rate_plan_charge_tier.rb
+    - lib/iron_bank/error.rb
+    - lib/iron_bank/client.rb
+
+Metrics/LineLength:
+  Exclude:
+    - lib/iron_bank.rb
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Style/OptionalArguments:
+  Exclude:
+    - lib/iron_bank/local.rb
+    - lib/iron_bank/queryable.rb
+    - lib/iron_bank/resource.rb
+
+Style/RescueStandardError:
+  Exclude:
+    - lib/iron_bank/csv.rb
+
+Style/MixinUsage:
+  Exclude:
+    - lib/iron_bank/resource.rb

data/.travis.yml

@@ -1,5 +1,24 @@
-sudo: false
+cache: bundler
+
 language: ruby
+
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.16.0.pre.2
+  - 2.2.9
+  - 2.3.5
+  - 2.4.4
+  - 2.5.1
+
+sudo: false
+
+branches:
+  only: master
+
+before_install:
+  - gem update --system
+  - gem install bundler
+
+env:
+  global:
+    - ZUORA_CLIENT_ID=something
+    - ZUORA_CLIENT_SECRET=secret
+    - ZUORA_DOMAIN=rest.apisandbox.zuora.com

data/Gemfile

@@ -1,6 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in iron_bank.gemspec
+# Specify your gem's dependencies in zuora.gemspec
 gemspec

data/LICENSE

@@ -0,0 +1,176 @@
+                                 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

data/README.md

@@ -1,6 +1,139 @@
 # Iron Bank
 
+[![Build Status][travis-status]][travis-build]
+
+An opinionated Ruby interface to the [Zuora REST API][zuora-dev].
+
 > We who serve the Iron Bank face death full as often as you who serve the Iron
 > Throne.
 
 _(A Dance with Dragons, Chapter 44, Jon IX)_
+
+This gem provides opinionated resources to interact with the Zuora API through
+their REST interface. It defines **associations** between them, as well as a
+simple **declaration API** (`with_one`, `with_many`) to extend them.
+
+This gem is tested against Ruby `>= 2.2.9`.
+
+Please use [GitHub Issues][issues] to report bugs.
+
+## Getting Started
+
+You will need:
+
+- a **Zuora tenant** (apisandbox, services, performances or production)
+- an **administrator access** to this tenant (to gain API access)
+- and an **OAuth client** for this user
+  ([Zuora documentation][zuora-doc-oauth])
+
+IronBank is a pure Ruby client, but we do provide a generator (for the
+configuration) when using it within [Rails][rails-website].
+
+Add the gem to your `Gemfile` with:
+
+```ruby
+gem 'iron_bank'
+```
+
+And run the `bundle` command to install it. You then need to run the generator:
+
+```
+$ rails generate iron_bank:install
+```
+
+Use the `client_id` and `client_secret` from your Zuora OAuth client and add
+them to the generated `config/initializers/iron_bank.rb` file.
+
+## Usage
+
+```ruby
+# make a query to Zuora using ZOQL
+IronBank::Query.call "select Name from Account where Id='zuora-account-id'"
+
+# retrieve an account
+account = IronBank::Account.find 'zuora-account-id'
+# => #<IronBank::Resources::Account>
+
+# access this resource attributes
+account.name # => 'My Company Inc.'
+
+# or associated objects
+account.bill_to
+# => #<IronBank::Resources::Contact>
+
+account.active_subscriptions
+# => [#<IronBank::Resources::Subscription>]
+```
+
+## Local records
+
+If your product catalog does not change often, you may want to export
+it locally so that product catalog and related object queries look for
+**local records** first, then **fallback** to the API if no records are found.
+
+You can export your product catalog locally using the `LocalRecords` class:
+
+```ruby
+# Save CSV files in the directory specified by `config.export_directory`
+IronBank::LocalRecords.export
+```
+
+Then, making a query/looking for a record will first search through the local
+records, then default to the API if no records are found.
+
+```ruby
+product = IronBank::Product.find 'zuora-product-id'
+# => #<IronBank::Resources::Product>
+
+product.plans[0].charges[0].tiers[0]
+# => #<IronBank::Resources::ProductRatePlanChargeTier>
+```
+
+Without local records, the previous scenario will make **4 requests** to Zuora
+to access the charge tiers. By exporting local records, you can significantly
+reduce your execution time, e.g., when building a `SubscriptionRequest`.
+
+## Development
+
+1. After checking out the repo, run `bin/setup` to install dependencies
+2. Edit the copied `.env` file with your Zuora credentials
+3. Execute `bundle exec rake` to run the linters and tests
+4. You can also run `bin/console` for an interactive prompt that will allow you
+   to experiment with the Zuora APIs
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/zendesk/iron_bank.
+
+## Known issues
+
+- `AutoPay` field on the `Invoice` object is not queryable using ZOQL despite
+  the metadata showing `<selectable>true</selectable>`, hence it has been added
+  to the `exclude_fields` method.
+
+
+## Copyright and license
+
+Copyright 2018 Zendesk, Inc.
+
+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.
+
+
+[issues]:          https://github.com/zendesk/iron_bank/issues
+[travis-status]:   https://travis-ci.com/zendesk/iron_bank.svg?token=Qzkq5papoR7sdedznjeb&branch=master
+[travis-build]:    https://travis-ci.com/zendesk/iron_bank
+[zuora-describe]:  https://www.zuora.com/developer/api-reference/#tag/Describe
+[zuora-dev]:       https://developer.zuora.com
+[zuora-doc-oauth]: https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/Manage_Users#Create_an_OAuth_Client_for_a_User
+[zuora-website]:   https://www.zuora.com
+[rails-website]:   https://rubyonrails.org/

data/Rakefile

@@ -1,6 +1,42 @@
-require 'bundler/gem_tasks'
+# frozen_string_literal: true
+
+require 'reek/rake/task'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'private_gem/tasks'
+require 'bump/tasks'
+
+Reek::Rake::Task.new do |reek|
+  reek.fail_on_error = true
+end
+
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec) do |rspec|
+  rspec.verbose = false
+end
+
+task test: :spec
+
+task default: %i[rubocop reek spec]
+
+desc 'Delete the VCR cassettes folder'
+task :clean do
+  sh 'rm -rf spec/vcr'
+end
+
+desc 'Export the Zuora Schema using the Describe API'
+task :export_schema do
+  require 'dotenv/load'
+  require 'iron_bank'
 
-RSpec::Core::RakeTask.new(:spec)
+  # Set up the client
+  IronBank.client = IronBank::Client.new(
+    domain:        ENV['ZUORA_DOMAIN'],
+    client_id:     ENV['ZUORA_CLIENT_ID'],
+    client_secret: ENV['ZUORA_CLIENT_SECRET'],
+    auth_type:     ENV['ZUORA_AUTH_TYPE']
+  )
 
-task :default => :spec
+  IronBank::Schema.export
+end

data/bin/console

@@ -1,7 +1,19 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
+require 'dotenv/load'
 require 'bundler/setup'
 require 'iron_bank'
-require 'pry'
+require 'pry-byebug'
+
+credentials = {
+  domain:        ENV['ZUORA_DOMAIN'],
+  client_id:     ENV['ZUORA_CLIENT_ID'],
+  client_secret: ENV['ZUORA_CLIENT_SECRET'],
+  auth_type:     ENV['ZUORA_AUTH_TYPE']
+}
+
+# If credentials are present in environment variables
+IronBank.client = IronBank::Client.new(credentials) if credentials.values.all?
 
 Pry.start

data/bin/setup

@@ -6,3 +6,4 @@ set -vx
 bundle install
 
 # Do any other automated setup that you need to do here
+test -e .env || cp .env.example .env