iron_bank 2.2.0 → 3.0.0

data/lib/iron_bank/authentications/cookie.rb

@@ -5,8 +5,6 @@ module IronBank
     # Get a cookie to enable authenticated calls to Zuora through Session.
     #
     class Cookie
-      include IronBank::OpenTracing
-
       TEN_MINUTES = 600
       ONE_HOUR    = 3600
 
@@ -23,7 +21,7 @@ module IronBank
       end
 
       def header
-        { 'Cookie' => use }
+        { "Cookie" => use }
       end
 
       private
@@ -38,7 +36,7 @@ module IronBank
 
       def fetch_cookie
         response    = authenticate
-        @cookie     = response.headers['set-cookie']
+        @cookie     = response.headers["set-cookie"]
         @zsession   = fetch_zsession
         @expires_at = Time.now + ONE_HOUR
       end
@@ -49,14 +47,16 @@ module IronBank
       end
 
       def authenticate
-        connection.post('v1/connections', {})
+        connection.post("v1/connections", {})
       end
 
       def connection
         @connection ||= Faraday.new(faraday_config) do |conn|
-          conn.use      :ddtrace, open_tracing_options if open_tracing_enabled?
+          IronBank.configuration.middlewares.each do |klass, options|
+            conn.use klass, options
+          end
+
           conn.request  :url_encoded
-          conn.response :logger, IronBank.logger
           conn.response :json
           conn.adapter  Faraday.default_adapter
         end

data/lib/iron_bank/authentications/token.rb

@@ -5,8 +5,6 @@ module IronBank
     # Get a bearer token to enable authenticated calls to Zuora through OAuth.
     #
     class Token
-      include IronBank::OpenTracing
-
       # Generic token error.
       #
       class Error < StandardError; end
@@ -31,7 +29,7 @@ module IronBank
       end
 
       def header
-        { 'Authorization' => "Bearer #{use}" }
+        { "Authorization" => "Bearer #{use}" }
       end
 
       private
@@ -46,21 +44,23 @@ module IronBank
 
       def fetch_token
         response      = authenticate || {}
-        @access_token = response.fetch('access_token', nil)
-        @expires_at   = Time.now + response.fetch('expires_in', ONE_HOUR).to_i
+        @access_token = response.fetch("access_token", nil)
+        @expires_at   = Time.now + response.fetch("expires_in", ONE_HOUR).to_i
         validate_access_token
       end
       alias refetch_token fetch_token
 
       def authenticate
-        connection.post('/oauth/token', authentication_params).body
+        connection.post("/oauth/token", authentication_params).body
       end
 
       def connection
         @connection ||= Faraday.new(url: base_url) do |conn|
-          conn.use      :ddtrace, open_tracing_options if open_tracing_enabled?
+          IronBank.configuration.middlewares.each do |klass, options|
+            conn.use klass, options
+          end
+
           conn.request  :url_encoded
-          conn.response :logger, IronBank.logger
           conn.response :json
           conn.adapter  Faraday.default_adapter
         end
@@ -70,7 +70,7 @@ module IronBank
         {
           client_id:     client_id,
           client_secret: client_secret,
-          grant_type:    'client_credentials'
+          grant_type:    "client_credentials"
         }
       end
 

data/lib/iron_bank/cacheable.rb

@@ -7,6 +7,7 @@ module IronBank
     def reload
       remove_instance_vars
       @remote = self.class.find(id, force: true).remote
+      self
     end
 
     private

data/lib/iron_bank/client.rb

@@ -5,9 +5,6 @@ module IronBank
   # authenticated request, reusing the same session cookie for future requests.
   #
   class Client
-    include IronBank::Instrumentation
-    include IronBank::OpenTracing
-
     # Generic client error.
     #
     class Error < StandardError; end
@@ -26,7 +23,7 @@ module IronBank
       end
     end
 
-    def initialize(domain:, client_id:, client_secret:, auth_type: 'token')
+    def initialize(domain:, client_id:, client_secret:, auth_type: "token")
       @domain        = domain
       @client_id     = client_id
       @client_secret = client_secret
@@ -40,19 +37,18 @@ module IronBank
     def connection
       validate_domain
       reset_connection if auth.expired?
+      config = IronBank.configuration
 
       @connection ||= Faraday.new(faraday_config) do |conn|
+        config.middlewares.each { |klass, options| conn.use(klass, options) }
+
         conn.request  :json
-        conn.request  :retry, IronBank.configuration.retry_options
+        conn.request  :retry, config.retry_options
 
         conn.response :raise_error
         conn.response :renew_auth, auth
-        conn.response :logger, IronBank.logger
         conn.response :json, content_type: /\bjson$/
 
-        conn.use      :ddtrace, open_tracing_options if open_tracing_enabled?
-        conn.use      instrumenter, instrumenter_options if instrumenter
-
         conn.adapter  Faraday.default_adapter
       end
     end
@@ -103,7 +99,7 @@ module IronBank
     end
 
     def headers
-      { 'Content-Type' => 'application/json' }.merge(auth.header)
+      { "Content-Type" => "application/json" }.merge(auth.header)
     end
 
     def reset_connection

data/lib/iron_bank/collection.rb

@@ -10,6 +10,7 @@ module IronBank
                    :[],
                    :each,
                    :length,
+                   :map,
                    :size
 
     def initialize(klass, conditions, records)

data/lib/iron_bank/configuration.rb

@@ -4,9 +4,8 @@ module IronBank
   # The Zuora configuration class.
   #
   class Configuration
-    # Instrumentation
-    attr_accessor :instrumenter
-    attr_accessor :instrumenter_options
+    # middlewares
+    attr_accessor :middlewares
 
     # Logger
     attr_accessor :logger
@@ -26,15 +25,6 @@ module IronBank
     # Cache store instance, optionally used by certain resources.
     attr_accessor :cache
 
-    # Open Tracing
-    attr_accessor :open_tracing_enabled
-
-    # Open Tracing service name
-    attr_accessor :open_tracing_service_name
-
-    # Faraday retry options
-    attr_writer :retry_options
-
     # Directory where the XML describe files are located.
     attr_reader :schema_directory
 
@@ -42,12 +32,11 @@ module IronBank
     attr_reader :export_directory
 
     def initialize
-      @schema_directory          = './config/schema'
-      @export_directory          = './config/export'
-      @logger                    = IronBank::Logger.new
-      @auth_type                 = 'token'
-      @open_tracing_enabled      = false
-      @open_tracing_service_name = 'ironbank'
+      @schema_directory = "./config/schema"
+      @export_directory = "./config/export"
+      @logger           = IronBank::Logger.new
+      @auth_type        = "token"
+      @middlewares      = []
     end
 
     def schema_directory=(value)
@@ -68,7 +57,7 @@ module IronBank
       @export_directory = value
       return unless defined? IronBank::Product
 
-      IronBank::LocalRecords::RESOURCES.each do |resource|
+      IronBank::LocalRecords::RESOURCE_QUERY_FIELDS.keys.each do |resource|
         IronBank::Resources.const_get(resource).reset_store
       end
     end

data/lib/iron_bank/csv.rb

@@ -9,7 +9,7 @@ module IronBank
         encoding = field.encode(CSV::ConverterEncoding)
 
         # Match: [1, 10, 100], No match: [0.1, .1, 1., 0b10]
-        encoding =~ /^[+-]?\d+$/ ? encoding.to_i : field
+        /^[+-]?\d+$/.match?(encoding) ? encoding.to_i : field
       rescue # encoding or integer conversion
         field
       end
@@ -20,7 +20,7 @@ module IronBank
         encoding = field.encode(CSV::ConverterEncoding)
 
         # Match: [1.0, 1., 0.1, .1], No match: [1, 0b10]
-        encoding =~ /^[+-]?(?:\d*\.|\.\d*)\d*$/ ? encoding.to_f : field
+        /^[+-]?(?:\d*\.|\.\d*)\d*$/.match?(encoding) ? encoding.to_f : field
       rescue # encoding or float conversion
         field
       end

data/lib/iron_bank/describe/field.rb

@@ -33,7 +33,7 @@ module IronBank
 
       # Defined separately because the node name is not ruby-friendly
       def max_length
-        doc.at_xpath('.//maxlength').text.to_i
+        doc.at_xpath(".//maxlength").text.to_i
       end
 
       TEXT_VALUES.each do |val|
@@ -46,7 +46,7 @@ module IronBank
       end
 
       BOOLEAN_VALUES.each do |val|
-        define_method(:"#{val}?") { doc.at_xpath(".//#{val}").text == 'true' }
+        define_method(:"#{val}?") { doc.at_xpath(".//#{val}").text == "true" }
       end
 
       def inspect

data/lib/iron_bank/describe/object.rb

@@ -31,22 +31,22 @@ module IronBank
       end
 
       def export
-        File.open(file_path, 'w') { |file| file << doc.to_xml }
+        File.open(file_path, "w") { |file| file << doc.to_xml }
       end
 
       def name
-        node = doc.at_xpath('.//object/name')
+        node = doc.at_xpath(".//object/name")
         raise InvalidXML unless node
 
         node.text
       end
 
       def label
-        doc.at_xpath('.//object/label').text
+        doc.at_xpath(".//object/label").text
       end
 
       def fields
-        @fields ||= doc.xpath('.//fields/field').map do |node|
+        @fields ||= doc.xpath(".//fields/field").map do |node|
           IronBank::Describe::Field.from_xml(node)
         end
       end
@@ -56,7 +56,7 @@ module IronBank
       end
 
       def related
-        @related ||= doc.xpath('.//related-objects/object').map do |node|
+        @related ||= doc.xpath(".//related-objects/object").map do |node|
           IronBank::Describe::Related.from_xml(node)
         end
       end

data/lib/iron_bank/describe/related.rb

@@ -13,15 +13,15 @@ module IronBank
       end
 
       def type
-        @type ||= doc.attributes['href'].value.split('/').last
+        @type ||= doc.attributes["href"].value.split("/").last
       end
 
       def name
-        doc.at_xpath('.//name').text
+        doc.at_xpath(".//name").text
       end
 
       def label
-        doc.at_xpath('.//label').text
+        doc.at_xpath(".//label").text
       end
 
       def inspect

data/lib/iron_bank/describe/tenant.rb

@@ -12,7 +12,7 @@ module IronBank
       end
 
       def self.from_connection(connection)
-        xml = connection.get('v1/describe').body
+        xml = connection.get("v1/describe").body
         new(Nokogiri::XML(xml), connection)
       rescue TypeError
         # NOTE: Zuora returns HTTP 401 (unauthorized) roughly 1 out of 3 times
@@ -43,7 +43,7 @@ module IronBank
       end
 
       def object_names
-        @object_names ||= doc.xpath('.//object/name').map(&:text)
+        @object_names ||= doc.xpath(".//object/name").map(&:text)
       end
     end
   end

data/lib/iron_bank/endpoint.rb

@@ -10,18 +10,18 @@ module IronBank
     SERVICES    = /\Aservices(\d+)\.zuora\.com(:\d+)?\z/i.freeze
     APISANDBOX  = /\Arest.apisandbox.zuora\.com\z/i.freeze
 
-    def self.base_url(domain = '')
+    def self.base_url(domain = "")
       new(domain).base_url
     end
 
     def base_url
       case domain
       when PRODUCTION
-        'https://rest.zuora.com/'
+        "https://rest.zuora.com/"
       when SERVICES
         "https://#{domain}/".downcase
       when APISANDBOX
-        'https://rest.apisandbox.zuora.com/'
+        "https://rest.apisandbox.zuora.com/"
       end
     end
 

data/lib/iron_bank/error.rb

@@ -82,23 +82,23 @@ module IronBank
   class LockCompetitionError < TemporaryError; end
 
   CODE_CLASSES = {
-    'API_DISABLED'           => ServerError,
-    'CANNOT_DELETE'          => UnprocessableEntityError,
-    'DUPLICATE_VALUE'        => ConflictError,
-    'INVALID_FIELD'          => BadRequestError,
-    'INVALID_ID'             => BadRequestError,
-    'INVALID_TYPE'           => BadRequestError,
-    'INVALID_VALUE'          => BadRequestError,
-    'LOCK_COMPETITION'       => LockCompetitionError,
-    'MALFORMED_QUERY'        => ClientError,
-    'MISSING_REQUIRED_VALUE' => ClientError,
-    'REQUEST_EXCEEDED_LIMIT' => TooManyRequestsError,
-    'REQUEST_EXCEEDED_RATE'  => TooManyRequestsError,
-    'TEMPORARY_ERROR'        => TemporaryError,
-    'TRANSACTION_FAILED'     => InternalServerError,
-    'TRANSACTION_TERMINATED' => InternalServerError,
-    'TRANSACTION_TIMEOUT'    => BadGatewayError,
-    'UNKNOWN_ERROR'          => InternalServerError
+    "API_DISABLED"           => ServerError,
+    "CANNOT_DELETE"          => UnprocessableEntityError,
+    "DUPLICATE_VALUE"        => ConflictError,
+    "INVALID_FIELD"          => BadRequestError,
+    "INVALID_ID"             => BadRequestError,
+    "INVALID_TYPE"           => BadRequestError,
+    "INVALID_VALUE"          => BadRequestError,
+    "LOCK_COMPETITION"       => LockCompetitionError,
+    "MALFORMED_QUERY"        => ClientError,
+    "MISSING_REQUIRED_VALUE" => ClientError,
+    "REQUEST_EXCEEDED_LIMIT" => TooManyRequestsError,
+    "REQUEST_EXCEEDED_RATE"  => TooManyRequestsError,
+    "TEMPORARY_ERROR"        => TemporaryError,
+    "TRANSACTION_FAILED"     => InternalServerError,
+    "TRANSACTION_TERMINATED" => InternalServerError,
+    "TRANSACTION_TIMEOUT"    => BadGatewayError,
+    "UNKNOWN_ERROR"          => InternalServerError
   }.freeze
 
   CODE_MATCHER = /(#{CODE_CLASSES.keys.join('|')})/.freeze

data/lib/iron_bank/local.rb

@@ -33,25 +33,33 @@ module IronBank
 
     private
 
+    # NOTE: Handle associations within the CSV export. E.g., when reading the
+    #       `ProductRatePlan.csv` file, we have `ProductRatePlan.Id` and
+    #       `Product.Id` fields. We want to end up with `id` and `product_id`
+    #       respectively.
+    def underscore_header
+      lambda do |header|
+        parts  = header.split(".")
+        header = parts.first.casecmp?(object_name) ? parts.last : parts.join
+
+        IronBank::Utils.underscore(header).to_sym
+      end
+    end
+
     def store
       @store ||= File.exist?(file_path) ? load_records : {}
     end
 
     def load_records
       CSV.foreach(file_path, csv_options).with_object({}) do |row, store|
-        # NOTE: when we move away from Ruby 2.2.x and 2.3.x we can uncomment
-        # this line, delete the other one, since `Hash#compact` is available in
-        # 2.4.x and we can remove two smells from `.reek` while we are at it
-        #
-        # store[row[:id]] = new(row.to_h.compact)
-        store[row[:id]] = new(row.to_h.reject { |_, value| value.nil? })
+        store[row[:id]] = new(row.to_h.compact)
       end
     end
 
     def csv_options
       {
         headers:           true,
-        header_converters: [->(h) { IronBank::Utils.underscore(h).to_sym }],
+        header_converters: [underscore_header],
         converters:        csv_converters
       }
     end

data/lib/iron_bank/local_records.rb

@@ -6,12 +6,12 @@ module IronBank
   class LocalRecords
     private_class_method :new
 
-    RESOURCES = %w[
-      Product
-      ProductRatePlan
-      ProductRatePlanCharge
-      ProductRatePlanChargeTier
-    ].freeze
+    RESOURCE_QUERY_FIELDS = {
+      "Product"                   => ["*"],
+      "ProductRatePlan"           => ["*", "Product.Id"],
+      "ProductRatePlanCharge"     => ["*", "ProductRatePlan.Id"],
+      "ProductRatePlanChargeTier" => ["*", "ProductRatePlanCharge.Id"]
+    }.freeze
 
     def self.directory
       IronBank.configuration.export_directory
@@ -19,39 +19,77 @@ module IronBank
 
     def self.export
       FileUtils.mkdir_p(directory) unless Dir.exist?(directory)
-      RESOURCES.each { |resource| new(resource).export }
+      RESOURCE_QUERY_FIELDS.keys.each { |resource| new(resource).save_file }
     end
 
-    def export
-      CSV.open(file_path, 'w') do |csv|
-        # first row = CSV headers
-        write_headers(csv)
-        write_records(csv)
+    def save_file
+      until completed? || max_query?
+        IronBank.logger.info(export_query_info)
+        sleep backoff_time
       end
+
+      File.open(file_path, "w") { |file| file.write(export.content) }
     end
 
     private
 
-    attr_reader :resource
+    BACKOFF = {
+      max:        3,
+      interval:   0.5,
+      randomness: 0.5,
+      factor:     4
+    }.freeze
+    private_constant :BACKOFF
+
+    attr_reader :resource, :query_attempts
 
     def initialize(resource)
-      @resource = resource
+      @resource       = resource
+      @query_attempts = 0
     end
 
-    def klass
-      IronBank::Resources.const_get(resource)
+    def export
+      @export ||= IronBank::Export.create(
+        "select #{RESOURCE_QUERY_FIELDS[resource].join(', ')} from #{resource}"
+      )
     end
 
     def file_path
       File.expand_path("#{resource}.csv", self.class.directory)
     end
 
-    def write_headers(csv)
-      csv << klass.fields
+    def export_query_info
+      "Waiting for export #{export.id} to complete " \
+        "(attempt #{query_attempts} of #{BACKOFF[:max]})"
+    end
+
+    def completed?
+      return false unless (status = export.reload.status)
+
+      case status
+      when "Pending", "Processing" then false
+      when "Completed"             then true
+      else                         raise_export_error
+      end
+    end
+
+    def raise_export_error
+      raise IronBank::Error, "Export #{export.id} has status #{export.status}"
     end
 
-    def write_records(csv)
-      klass.find_each { |record| csv << record.to_csv_row }
+    def max_query?
+      @query_attempts += 1
+      return false unless @query_attempts > BACKOFF[:max]
+
+      raise IronBank::Error, "Export query attempts exceeded"
+    end
+
+    def backoff_time
+      interval         = BACKOFF[:interval]
+      current_interval = interval * (BACKOFF[:factor]**query_attempts)
+      random_interval  = rand * BACKOFF[:randomness].to_f * interval
+
+      current_interval + random_interval
     end
   end
 end

data/lib/iron_bank/logger.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'singleton'
-require 'logger'
+require "singleton"
+require "logger"
 
 module IronBank
   # Default logger for IronBank events
@@ -9,7 +9,7 @@ module IronBank
   class Logger
     extend Forwardable
 
-    PROGNAME = 'iron_bank'
+    PROGNAME = "iron_bank"
     LEVEL    = ::Logger::DEBUG
 
     def_delegators :@logger, :debug, :info, :warn, :error, :fatal

data/lib/iron_bank/operation.rb

@@ -27,7 +27,7 @@ module IronBank
     end
 
     def name
-      self.class.name.split('::').last
+      self.class.name.split("::").last
     end
   end
 end

data/lib/iron_bank/query_builder.rb

@@ -26,7 +26,7 @@ module IronBank
     end
 
     def query_fields
-      fields.join(',')
+      fields.join(",")
     end
 
     def query_conditions
@@ -41,7 +41,7 @@ module IronBank
     def range_query_builder(field, value)
       value.each.with_object([]) do |option, range_query|
         range_query << "#{field}='#{option}'"
-      end.join(' OR ')
+      end.join(" OR ")
     end
 
     def hash_query_conditions
@@ -49,7 +49,7 @@ module IronBank
         # TODO: sanitize the value
         field = IronBank::Utils.camelize(field)
         filters << current_filter(field, value)
-      end.join(' AND ')
+      end.join(" AND ")
     end
 
     def current_filter(field, value)
@@ -66,7 +66,7 @@ module IronBank
       return if conditions.count <= 1
       return unless conditions.values.any? { |value| value.is_a?(Array) }
 
-      raise 'Filter ranges must be used in isolation.'
+      raise "Filter ranges must be used in isolation."
     end
   end
 end

data/lib/iron_bank/resource.rb

@@ -10,7 +10,7 @@ module IronBank
     extend IronBank::Queryable
 
     def self.object_name
-      name.split('::').last
+      name.split("::").last
     end
 
     def self.with_local_records
@@ -52,12 +52,7 @@ module IronBank
     def reload
       remove_instance_vars
       @remote = self.class.find(id).remote
-    end
-
-    def to_csv_row
-      self.class.fields.each.with_object([]) do |field, row|
-        row << remote[IronBank::Utils.underscore(field).to_sym]
-      end
+      self
     end
 
     def remove_instance_vars