iron_bank 0.1.0 → 0.7.1

data/lib/iron_bank/resources/invoice_payment.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Resources
+    # Many-to-many relationship between invoices and payments.
+    #
+    class InvoicePayment < Resource
+      with_schema
+      with_one :invoice
+      with_one :payment
+    end
+  end
+end

data/lib/iron_bank/resources/payment.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Resources
+    # A payment belongs to an account and is applied against one or many
+    # invoices and/or the account credit balance.
+    #
+    class Payment < Resource
+      with_schema
+
+      with_one :account
+      with_one :payment_method
+
+      with_many :invoice_payments
+    end
+  end
+end

data/lib/iron_bank/resources/payment_method.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Resources
+    # An electronic payment method, belongs to an account, can be set as the
+    # default payment method on an account to enable auto-pay through payment
+    # runs.
+    #
+    class PaymentMethod < Resource
+      with_schema
+      with_one :account
+    end
+  end
+end

data/lib/iron_bank/resources/product.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Resources
+    # A Zuora product holds many product rate plans.
+    #
+    class Product < Resource
+      with_schema
+      with_local_records
+      with_cache
+      with_many :product_rate_plans, aka: :plans
+    end
+  end
+end

data/lib/iron_bank/resources/product_rate_plan.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Resources
+    # A product rate plan belongs to a product and holds many product rate plan
+    # charges. It represents what a customer is subscribing to.
+    #
+    class ProductRatePlan < Resource
+      # Zuora limitation: we cannot query for `ActiveCurrencies` with any other
+      # fields, so instead we define a separate `#active_currencies` method.
+      def self.exclude_fields
+        %w[ActiveCurrencies]
+      end
+      with_schema
+      with_local_records
+      with_cache
+
+      with_one  :product
+      with_many :product_rate_plan_charges, aka: :charges
+
+      def active_currencies
+        query_string = IronBank::QueryBuilder.zoql(
+          self.class.object_name,
+          ['ActiveCurrencies'],
+          id: id
+        )
+
+        IronBank.client.query(query_string)
+      end
+    end
+  end
+end

data/lib/iron_bank/resources/product_rate_plan_charge.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Resources
+    # A product rate plan charge can be a one-time, recurring or usage-based
+    # charge. It belongs to a product rate plan and can have many tiers when
+    # using a Volume or Tiered pricing model.
+    #
+    # NOTE: if multiple currencies are enabled for your Zuora tenant, then there
+    # is *at least* one tier per active currency.
+    #
+    class ProductRatePlanCharge < Resource
+      # `DiscountClass` seems to not be a queryable field, despite the result
+      # from the describe call for product rate plan charge.
+      def self.exclude_fields
+        %w[DiscountClass]
+      end
+      with_schema
+      with_local_records
+      with_cache
+
+      with_one :product_rate_plan, aka: :plan
+
+      with_many :product_rate_plan_charge_tiers, aka: :tiers
+    end
+  end
+end

data/lib/iron_bank/resources/product_rate_plan_charge_tier.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Resources
+    # A tier holds an amount (cost) and a currency for a given product rate plan
+    # charge.
+    #
+    class ProductRatePlanChargeTier < Resource
+      with_schema
+      with_local_records
+      with_cache
+
+      with_one :product_rate_plan_charge, aka: :charge
+
+      def self.where(conditions)
+        # If we are coming from a subclass, defer to Queryable#all
+        return super unless name.end_with?('ProductRatePlanChargeTier')
+
+        CatalogTiers.constants.map do |tier_klass|
+          CatalogTiers.const_get(tier_klass).where(conditions)
+        end.flatten
+      end
+
+      def self.find_each
+        return enum_for(:find_each) unless block_given?
+        return super unless name.end_with?('ProductRatePlanChargeTier')
+
+        CatalogTiers.constants.each do |tier_klass|
+          # Pass the block to each subclasses
+          CatalogTiers.const_get(tier_klass).find_each(&Proc.new)
+        end
+      end
+
+      # We want to store all fields to the CSV, not just the ones that can be
+      # queried through Zuora, for all the different tiers (discount-percentage,
+      # discount-fixed amount and regular pricing).
+      def to_csv_row
+        ProductRatePlanChargeTier.fields.each.with_object([]) do |field, row|
+          row << remote[field]
+        end
+      end
+
+      def self.load_records
+        CSV.foreach(file_path, csv_options).with_object({}) do |row, store|
+          remote = row.to_h.reject { |_, value| value.nil? }
+
+          record = if remote['DiscountAmount']
+                     CatalogTiers::DiscountAmount.new(remote)
+                   elsif remote['DiscountPercentage']
+                     CatalogTiers::DiscountPercentage.new(remote)
+                   else
+                     CatalogTiers::Price.new(remote)
+                   end
+
+          store[row['Id']] = record
+        end
+      end
+    end
+  end
+end

data/lib/iron_bank/resources/rate_plan.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Resources
+    # A rate plan belongs to a subscription and is a copy of the associated
+    # product rate plan from the catalog at the time of the subscription.
+    #
+    class RatePlan < Resource
+      with_schema
+      with_cache
+
+      with_one :amendment
+      with_one :product_rate_plan, aka: :catalog_plan
+      with_one :subscription
+
+      with_many :rate_plan_charges,
+                aka: :charges,
+                conditions: { is_last_segment: true }
+    end
+  end
+end

data/lib/iron_bank/resources/rate_plan_charge.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Resources
+    # A rate plan charge belongs to a subscription rate plan.
+    #
+    class RatePlanCharge < Resource
+      def self.exclude_fields
+        %w[
+          DiscountAmount
+          DiscountClass
+          DiscountPercentage
+          IncludedUnits
+          OveragePrice
+          Price
+          RevenueRecognitionRuleName
+          RolloverBalance
+        ]
+      end
+      with_schema
+      with_cache
+
+      with_one :original, resource_name: 'RatePlanCharge'
+      with_one :product_rate_plan_charge, aka: :catalog_charge
+      with_one :rate_plan, aka: :plan
+
+      with_many :rate_plan_charge_tiers, aka: :tiers
+    end
+  end
+end

data/lib/iron_bank/resources/rate_plan_charge_tier.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Resources
+    # A rate plan charge tier hold the price per unit the customer will be
+    # billed for, in his/her currency.
+    #
+    class RatePlanChargeTier < Resource
+      # Excluding 'DiscountAmount' & 'DiscountPercentage', as Zuora stores these
+      # values in the 'Price' field.
+      def self.exclude_fields
+        %w[
+          Currency
+          DiscountAmount
+          DiscountPercentage
+          IncludedUnits
+          OveragePrice
+        ]
+      end
+      with_schema
+      with_cache
+
+      with_one :rate_plan_charge, aka: :charge
+    end
+  end
+end

data/lib/iron_bank/resources/subscription.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Resources
+    # A Zuora subscription, belongs to an account, holds rate plans and is
+    # versioned through each amendment.
+    #
+    class Subscription < Resource
+      with_schema
+      with_cache
+
+      with_one :account
+      with_one :invoice_owner, resource_name: 'Account'
+
+      with_one :original, resource_name: 'Subscription'
+      with_one :previous,
+               resource_name: 'Subscription',
+               foreign_key: 'previous_subscription_id'
+
+      with_many :rate_plans, aka: :plans
+      with_many :usages
+
+      # FIXME: a subscription can only have at most one amendment (no amendment
+      # for the last version) but there are no `AmendmentId` on a subscription.
+      with_many :amendments
+    end
+  end
+end

data/lib/iron_bank/resources/usage.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Resources
+    # Usage is consumed by usage-based charges during the bill run.
+    #
+    class Usage < Resource
+      with_schema
+
+      with_one :account
+      with_one :charge, resource_name: 'RatePlanCharge'
+      with_one :import
+      with_one :subscription
+    end
+  end
+end

data/lib/iron_bank/response/raise_error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module IronBank
+  # Faraday response middleware
+  module Response
+    # This class raises an exception based on the HTTP status code and the
+    # `success` flag (if present in the response) from Zuora.
+    class RaiseError < Faraday::Response::Middleware
+      private
+
+      def on_complete(response)
+        (error = IronBank::Error.from_response(response)) && raise(error)
+      end
+    end
+  end
+end

data/lib/iron_bank/schema.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module IronBank
+  # Representation of all Zuora objects and their fields for a Zuora tenant,
+  # with import/export capabilities.
+  #
+  class Schema
+    private_class_method :new
+
+    def self.directory
+      IronBank.configuration.schema_directory
+    end
+
+    def self.export
+      FileUtils.mkdir_p(directory) unless Dir.exist?(directory)
+      new(IronBank.client).export
+      reset
+      import
+    end
+
+    def self.for(object_name)
+      import[object_name]
+    end
+
+    def self.import
+      @import ||= Dir["#{directory}/*.xml"].each.with_object({}) do |name, data|
+        doc    = File.open(name) { |file| Nokogiri::XML(file) }
+        object = IronBank::Describe::Object.from_xml(doc)
+        data[object.name] = object
+      end
+    end
+
+    def self.reset
+      @import = nil
+    end
+
+    def export
+      tenant.objects.compact.each do |object|
+        begin
+          object.export
+        rescue IronBank::Describe::Object::InvalidXML
+          # TODO: log the object error
+          next
+        end
+      end
+    end
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def tenant
+      @tenant ||= IronBank::Describe::Tenant.from_connection(client.connection)
+    end
+  end
+end

data/lib/iron_bank/utils.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module IronBank
+  # A few helper methods for interacting with Zuora
+  #
+  module Utils
+    module_function
+
+    # Inspired from ActiveSupport
+    def underscore(camel_cased_word)
+      return camel_cased_word unless camel_cased_word =~ /[A-Z-]|::/
+
+      word = camel_cased_word.to_s.gsub(/::/, '/')
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      word.tr!('-', '_')
+      word.downcase
+    end
+
+    def camelize(term, type: :upper)
+      # Preserve custom field term postfix, in the '__c' or the '__NS' format
+      custom_field   = (term.to_s =~ /__c$/i)
+      netsuite_field = (term.to_s =~ /__NS$/i)
+      lower_camelize = type == :lower
+
+      output = term.to_s.dup.tap do |copy|
+        copy.gsub!(/^_*/, '')
+        copy.gsub!(/__(NS|c)$/i, '') if custom_field || netsuite_field
+
+        lower_camelize ? lower_camelize(copy) : upper_camelize(copy)
+      end
+
+      if custom_field
+        "#{output}__c"
+      elsif netsuite_field
+        "#{output}__NS"
+      else
+        output
+      end
+    end
+
+    def kebab(term)
+      underscore(term).tr!('_', '-')
+    end
+
+    def lower_camelize(term)
+      term.gsub!(/(^|_)(.)/) do
+        match = Regexp.last_match
+        char  = match[2]
+
+        match.begin(2).zero? ? char : char.upcase
+      end
+    end
+
+    def upper_camelize(term)
+      term.gsub!(/(^|_)(.)/) { Regexp.last_match(2).upcase }
+    end
+  end
+end

data/lib/iron_bank/version.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
 module IronBank
-  VERSION = '0.1.0'
+  VERSION     = '0.7.1'
+  API_VERSION = 'v1'
 end

data/lib/iron_bank.rb

@@ -1,5 +1,155 @@
-require 'iron_bank/version'
+# frozen_string_literal: true
+
+# External librairies
+require 'csv'
+require 'faraday'
+require 'faraday_middleware'
+require 'fileutils'
+require 'json'
+require 'nokogiri'
+require 'ddtrace'
 
+# An opinionated Ruby interface to the Zuora REST API
 module IronBank
-  # Your code goes here...
+  class << self
+    # Holds an instance of IronBank::Client which becomes the default for many
+    # query and other actions requiring a connection to Zuora.
+    attr_accessor :client
+
+    # Configurable options such as schema directory.
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+
+    return unless configuration.credentials?
+
+    self.client ||= IronBank::Client.new(configuration.credentials)
+  end
+
+  def self.logger
+    self.configuration.logger
+  end
+
+  # Zuora actions, e.g., subscribe, amend, etc.
+  module Actions; end
+
+  # Metadata describe
+  module Describe; end
+
+  # Zuora resources
+  module Resources; end
+
+  # Zuora operations, e.g., billing-preview
+  module Operations; end
+end
+
+# Utilities
+require 'iron_bank/logger'
+require 'iron_bank/cacheable'
+require 'iron_bank/configuration'
+require 'iron_bank/endpoint'
+require 'iron_bank/local_records'
+require 'iron_bank/local'
+require 'iron_bank/utils'
+require 'iron_bank/version'
+require 'iron_bank/csv'
+require 'iron_bank/error'
+require 'iron_bank/response/raise_error'
+
+# Helpers
+require 'iron_bank/open_tracing'
+require 'iron_bank/instrumentation'
+
+# Use default configuration
+IronBank.configure {}
+
+# Actions
+require 'iron_bank/action'
+require 'iron_bank/actions/amend'
+require 'iron_bank/actions/create'
+require 'iron_bank/actions/delete'
+require 'iron_bank/actions/execute'
+require 'iron_bank/actions/generate'
+require 'iron_bank/actions/subscribe'
+require 'iron_bank/actions/update'
+require 'iron_bank/actions/query'
+require 'iron_bank/actions/query_more'
+
+# Client and schema (describe)
+require 'iron_bank/authentication'
+require 'iron_bank/authentications/cookie'
+require 'iron_bank/authentications/token'
+require 'iron_bank/client'
+require 'iron_bank/describe/field'
+require 'iron_bank/describe/object'
+require 'iron_bank/describe/related'
+require 'iron_bank/describe/tenant'
+require 'iron_bank/object'
+require 'iron_bank/schema'
+require 'iron_bank/query_builder'
+
+# Operations
+require 'iron_bank/operation'
+require 'iron_bank/operations/billing_preview'
+
+# Resources
+require 'iron_bank/associations'
+require 'iron_bank/metadata'
+require 'iron_bank/queryable'
+require 'iron_bank/resource'
+require 'iron_bank/collection'
+require 'iron_bank/resources/account'
+require 'iron_bank/resources/amendment'
+require 'iron_bank/resources/contact'
+require 'iron_bank/resources/export'
+require 'iron_bank/resources/import'
+require 'iron_bank/resources/invoice_adjustment'
+require 'iron_bank/resources/invoice_item'
+require 'iron_bank/resources/invoice_payment'
+require 'iron_bank/resources/invoice'
+require 'iron_bank/resources/payment_method'
+require 'iron_bank/resources/payment'
+require 'iron_bank/resources/product_rate_plan_charge_tier'
+require 'iron_bank/resources/product_rate_plan_charge'
+require 'iron_bank/resources/product_rate_plan'
+require 'iron_bank/resources/product'
+require 'iron_bank/resources/rate_plan_charge_tier'
+require 'iron_bank/resources/rate_plan_charge'
+require 'iron_bank/resources/rate_plan'
+require 'iron_bank/resources/subscription'
+require 'iron_bank/resources/usage'
+require 'iron_bank/resources/catalog_tiers/discount_amount'
+require 'iron_bank/resources/catalog_tiers/discount_percentage'
+require 'iron_bank/resources/catalog_tiers/price'
+
+# Aliasing IronBank::Actions::* to IronBank::*
+IronBank::Actions.constants.each do |action|
+  IronBank.const_set(action, IronBank::Actions.const_get(action))
+end
+
+# Aliasing IronBank::Resources::* to IronBank::*
+IronBank::Resources.constants.each do |resource|
+  IronBank.const_set(resource, IronBank::Resources.const_get(resource))
+end
+
+# Aliasing catalog-related objects
+IronBank::CatalogPlan   = IronBank::Resources::ProductRatePlan
+IronBank::CatalogCharge = IronBank::Resources::ProductRatePlanCharge
+IronBank::CatalogTier   = IronBank::Resources::ProductRatePlanChargeTier
+
+# Aliasing subscription-related objects
+IronBank::Plan   = IronBank::Resources::RatePlan
+IronBank::Charge = IronBank::Resources::RatePlanCharge
+IronBank::Tier   = IronBank::Resources::RatePlanChargeTier
+
+Datadog.configure do |config|
+  config.tracer(
+    enabled: IronBank.configuration.open_tracing_enabled
+  )
+  # registers the tracing middleware.
+  config.use :faraday,
+             service_name: IronBank.configuration.open_tracing_service_name
 end