iron_bank 5.4.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 853859a45aaabdcfc831dca27a70882b28aa19f68b214a666cb0830ce4fa702f
-  data.tar.gz: 3c755dd00fad7455b402dd04ae7f649f554fce6127608e11f28c2e16f31c85d9
+  metadata.gz: 21e2b4cd128fca398bbb0f377e13da07b12c61e38f9c5e68ed3f56274350ee76
+  data.tar.gz: e81a0902b8fa8337d629b03322546270539f3f148ffc4a3dbebc89800bc40a09
 SHA512:
-  metadata.gz: 50f8865e78282701c705fd9e5b1b0f9978f152d54b7594784806153d9ffc3654d57871f6a9c4dbe1917611853915e27ff16e9b893e2bc2d848a27f963596aa32
-  data.tar.gz: 41e18fea0a4047734d49c8a495dfb28c2c13b7a40ef4a4737f6ccf909e4894bca44048124793cb9924ed375000e12245be67eefe559967f943b1391f7f2024f3
+  metadata.gz: 17aea2bf7a329de0cec9e42cb8d29416fca829ab0b7801624d32ff1367938bd44dc957b7759cfad41562080dd8793258acc30b036ae7c60452e6b54e0f5c3eff
+  data.tar.gz: '06290a763ad6c65851d162396a2ea79da3cd6a144a2f51173ab3af995d3c0a4c136f01a997af81751cc06b0634e20560e5c8f475ed1cc4bcacc2e42023f63d65'

data/.github/workflows/ci.yml

@@ -13,10 +13,9 @@ jobs:
     strategy:
       matrix:
         ruby-version:
-          - '2.7'
-          - '3.0'
           - '3.1'
           - '3.2'
+          - '3.3'
     steps:
       - uses: zendesk/checkout@v3
       - uses: zendesk/setup-ruby@v1
@@ -52,6 +51,6 @@ jobs:
       - name: Set up Ruby
         uses: zendesk/setup-ruby@v1
         with:
-          ruby-version: "3.0"
+          ruby-version: "3.1"
           bundler-cache: true
       - run: bundle exec rake rubocop

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
   DisplayStyleGuide: true
   NewCops: enable
   SuggestExtensions: false
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
 
 Layout/DotPosition:
   EnforcedStyle: trailing
@@ -68,3 +68,15 @@ Style/RegexpLiteral:
 Style/RescueStandardError:
   Exclude:
     - lib/iron_bank/csv.rb
+
+Style/HashSyntax:
+  Exclude:
+    - spec/shared_examples/**
+    - spec/iron_bank/**/*.rb
+    - lib/iron_bank/*.
+    - lib/iron_bank/**/*.rb
+
+Style/RedundantFreeze:
+  Exclude:
+    - lib/iron_bank/*.rb
+

data/.ruby-version

@@ -1 +1 @@
-2.7.7
+3.1.4

data/Gemfile.lock

@@ -1,62 +1,58 @@
 PATH
   remote: .
   specs:
-    iron_bank (5.4.0)
-      faraday (~> 1)
-      faraday_middleware (~> 1)
+    iron_bank (6.0.0)
+      faraday (~> 2)
+      faraday-retry (~> 2)
       nokogiri (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.4)
     bump (0.10.0)
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
     dotenv (2.8.1)
+    drb (2.2.0)
+      ruby2_keywords
     factory_bot (6.2.1)
       activesupport (>= 5.0.0)
-    faraday (1.10.3)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.4)
-      multipart-post (~> 2)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
+    faraday (2.12.2)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    faraday-retry (2.2.0)
+      faraday (~> 2.0)
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     kwalify (0.7.2)
+    logger (1.6.6)
     method_source (1.0.0)
     mini_portile2 (2.8.2)
     minitest (5.18.0)
-    multipart-post (2.3.0)
+    mutex_m (0.2.0)
+    net-http (0.6.0)
+      uri
     nokogiri (1.14.3)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
@@ -120,6 +116,7 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
+    uri (1.0.3)
 
 PLATFORMS
   ruby
@@ -141,4 +138,4 @@ DEPENDENCIES
   timecop (~> 0.9)
 
 BUNDLED WITH
-   2.3.16
+   2.4.19

data/README.md

@@ -13,7 +13,7 @@ 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.6`.
+This gem is tested against Ruby `>= 3.1`.
 
 Please use [GitHub Issues][issues] to report bugs.
 

data/Rakefile

@@ -31,6 +31,14 @@ task :excluded_fields, [:filename] do |_t, args|
   setup_iron_bank
 
   destination = args[:filename] || IronBank.configuration.excluded_fields_file
+  # NOTE: In some instances the error message from Zuora will not include the
+  # unqueryable fields that need to be excluded. When that happens IronBank's
+  # strategy will be to perform a binary search through the fields listed in the
+  # query -- at the cost of performance due to repeated requests sent to Zuora
+  # as it tries to identify the offending field.
+  #
+  # See:
+  # - https://github.com/zendesk/iron_bank/pull/107
   fields      = IronBank::Schema.excluded_fields.sort.to_h
 
   File.write(destination, Psych.dump(fields))

data/iron_bank.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
     "mturan@zendesk.com"
   ]
 
-  spec.required_ruby_version = ">= 2.7"
+  spec.required_ruby_version = ">= 3.1"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -29,8 +29,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday",            "~> 1"
-  spec.add_dependency "faraday_middleware", "~> 1"
+  spec.add_dependency "faraday",            "~> 2"
+  spec.add_dependency "faraday-retry",      "~> 2"
   spec.add_dependency "nokogiri",           "~> 1"
   spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/iron_bank/describe/excluded_fields/deduce_from_query.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Describe
+    # NOTE: Beware there could be a performance hit as the search repeatedly
+    # executes queries to perform the search for invalid fields in the query
+    # included in the query statement.
+
+    # rubocop:disable Style/ClassAndModuleChildren
+    class ExcludedFields::DeduceFromQuery
+      INVALID_OBJECT_ID = "InvalidObjectId"
+
+      private_class_method :new
+
+      def self.call(object)
+        new(object).call
+      end
+
+      def call
+        query_fields = object.query_fields.clone
+        divide_and_execute(query_fields)
+        object.query_fields.concat(query_fields)
+        invalid_fields
+      end
+
+      private
+
+      attr_reader :object, :valid_fields, :invalid_fields
+
+      def initialize(object)
+        @object         = object
+        @valid_fields   = []
+        @invalid_fields = []
+      end
+
+      def divide_and_execute(query_fields)
+        # clear state before queries
+        object.query_fields.clear
+
+        # we repeat dividing until only a single field remains
+        invalid_fields.push(query_fields.pop) if query_fields.one?
+        return if query_fields.empty?
+
+        left, right = divide_fields(query_fields)
+        execute_or_divide_again(left)
+        execute_or_divide_again(right)
+      end
+
+      def divide_fields(query_fields)
+        mid = query_fields.size / 2
+        [query_fields[0..mid - 1], query_fields[mid..]]
+      end
+
+      def execute_or_divide_again(fields)
+        if execute_query(fields)
+          valid_fields.concat(fields)
+        else
+          divide_and_execute(fields)
+        end
+      end
+
+      def execute_query(fields)
+        object.query_fields.concat(valid_fields + fields)
+        object.where({ id: INVALID_OBJECT_ID })
+        true
+      rescue IronBank::InternalServerError
+        false
+      end
+    end
+    # rubocop:enable Style/ClassAndModuleChildren
+  end
+end

data/lib/iron_bank/describe/excluded_fields/extract_from_message.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module IronBank
+  module Describe
+    # Extracts invalid fields from an exception message.
+    # Returns from a call if an exception message does not contain invalid field
+
+    # rubocop:disable Style/ClassAndModuleChildren
+    class ExcludedFields::ExtractFromMessage
+      FAULT_FIELD_MESSAGES = Regexp.union(
+        # Generic fault field
+        /invalid field for query: \w+\.(\w+)/,
+        # Invoice Bill Run is not selectable in ZOQL
+        /Cannot use the (BillRunId) field in the select clause/,
+        # Invoice Body, implemented as a separate call
+        /Can only query one invoice (body) at a time/,
+        # Catalog tier should only query the price field
+        /use Price or (DiscountAmount) or (DiscountPercentage)/,
+        # Catalog plan currencies, implemented as a separate call
+        /When querying for (active currencies)/,
+        # Catalog charge rollover balance
+        /You can only query (RolloverBalance) in particular/,
+        # (Subscription) charge should only query the price field
+        /
+          (OveragePrice),
+          \ Price,
+          \ (IncludedUnits),
+          \ (DiscountAmount)
+          \ or\ (DiscountPercentage)
+        /x
+      ).freeze
+
+      private_class_method :new
+
+      def self.call(message)
+        new(message).call
+      end
+
+      def call
+        return unless FAULT_FIELD_MESSAGES.match(message)
+
+        Regexp.last_match.captures.compact.
+          map { |capture| capture.delete(" ") }
+      end
+
+      private
+
+      attr_reader :message
+
+      def initialize(message)
+        @message = message
+      end
+    end
+    # rubocop:enable Style/ClassAndModuleChildren
+  end
+end

data/lib/iron_bank/describe/excluded_fields.rb

@@ -5,32 +5,10 @@ module IronBank
     # Returns an array of non-queryable fields for the given object in the
     # current Zuora tenant, despites Zuora clearly marking these fields as
     # `<selectable>true</true>` in their Describe API... /rant
-    #
     class ExcludedFields
       extend Forwardable
 
-      FAULT_FIELD_MESSAGES = Regexp.union(
-        # Generic fault field
-        /invalid field for query: \w+\.(\w+)/,
-        # Invoice Bill Run is not selectable in ZOQL
-        /Cannot use the (BillRunId) field in the select clause/,
-        # Invoice Body, implemented as a separate call
-        /Can only query one invoice (body) at a time/,
-        # Catalog tier should only query the price field
-        /use Price or (DiscountAmount) or (DiscountPercentage)/,
-        # Catalog plan currencies, implemented as a separate call
-        /When querying for (active currencies)/,
-        # Catalog charge rollover balance
-        /You can only query (RolloverBalance) in particular/,
-        # (Subscription) charge should only query the price field
-        %r{
-          (OveragePrice),
-          \ Price,
-          \ (IncludedUnits),
-          \ (DiscountAmount)
-          \ or\ (DiscountPercentage)
-        }x
-      ).freeze
+      INVALID_OBJECT_ID = "InvalidObjectId"
 
       private_class_method :new
 
@@ -39,43 +17,36 @@ module IronBank
       end
 
       def call
-        remove_last_failure_fields until valid_query?
-
+        remove_invalid_fields until valid_query?
         (excluded_fields - single_resource_query_fields).sort
       end
 
       private
 
-      INVALID_OBJECT_ID = "InvalidObjectId"
-
-      attr_reader :object_name, :last_failed_fields
+      attr_reader :object_name, :invalid_fields
 
       def_delegators "IronBank.logger", :info
       def_delegators :object, :single_resource_query_fields
 
       def initialize(object_name)
-        @object_name        = object_name
-        @last_failed_fields = nil
+        @object_name    = object_name
+        @invalid_fields = []
       end
 
       def object
-        IronBank::Resources.const_get(object_name)
+        @object ||= IronBank::Resources.const_get(object_name)
       end
 
       def excluded_fields
         @excluded_fields ||= object.excluded_fields.dup
       end
 
-      def remove_last_failure_fields
-        query_fields = object.query_fields
-
+      def remove_invalid_fields
+        query_fields  = object.query_fields
         failed_fields = query_fields.select do |field|
-          last_failed_fields.any? { |failed| field.casecmp?(failed) }
+          invalid_fields.any? { |failed| field.casecmp?(failed) }
         end
-
         excluded_fields.push(*failed_fields)
-
-        # Remove the field for the next query
         query_fields.delete_if { |field| failed_fields.include?(field) }
       end
 
@@ -83,30 +54,16 @@ module IronBank
         # Querying using the ID (which is an indexed field) should return an
         # empty collection very quickly when successful
         object.where({ id: INVALID_OBJECT_ID })
-
         info "Successful query for #{object_name}"
-
         true
-      rescue IronBank::InternalServerError, IronBank::BadRequestError => e
-        @last_failed_fields = extract_fields_from_exception(e)
-
+      rescue IronBank::BadRequestError, InternalServerError => e
+        @invalid_fields = Array(
+          ExtractFromMessage.call(e.message) ||
+          DeduceFromQuery.call(object)
+        )
+        info "Invalid fields '#{@invalid_fields}' for #{object_name} query"
         false
       end
-
-      def extract_fields_from_exception(exception)
-        message = exception.message
-
-        raise "Could not parse error message: #{message}" unless FAULT_FIELD_MESSAGES.match(message)
-
-        failed_fields = Regexp.last_match.
-                        captures.
-                        compact.
-                        map { |capture| capture.delete(" ") }
-
-        info "Invalid fields '#{failed_fields}' for #{object_name} query"
-
-        failed_fields
-      end
     end
   end
 end

data/lib/iron_bank/faraday_middleware/response/raise_error.rb

@@ -8,7 +8,7 @@ module IronBank
     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
+      class RaiseError < Faraday::Middleware
         def on_complete(env)
           (error = IronBank::Error.from_response(env.response)) && raise(error)
         end

data/lib/iron_bank/faraday_middleware/response/renew_auth.rb

@@ -7,7 +7,7 @@ module IronBank
     # IronBank Faraday response middleware module
     module Response
       # This middleware reauthorize the request on unauthorized request
-      class RenewAuth < Faraday::Response::Middleware
+      class RenewAuth < Faraday::Middleware
         def initialize(app, auth)
           @auth = auth
 

data/lib/iron_bank/schema.rb

@@ -39,6 +39,14 @@ module IronBank
     end
 
     def self.excluded_fields
+      # NOTE: In some instances the error message from Zuora will not include the
+      # unqueryable fields that need to be excluded. When that happens IronBank's
+      # strategy will be to perform a binary search through the fields listed in the
+      # query -- at the cost of performance due to repeated requests sent to Zuora
+      # as it tries to identify the offending field.
+      #
+      # See:
+      # - https://github.com/zendesk/iron_bank/pull/107
       @excluded_fields ||= IronBank::Resources.constants.each.with_object({}) do |resource, fields|
         fields[resource.to_s] =
           IronBank::Describe::ExcludedFields.call(object_name: resource)

data/lib/iron_bank/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module IronBank
-  VERSION     = "5.4.0"
+  VERSION     = "6.0.0"
   API_VERSION = "v1"
 end

data/lib/iron_bank.rb

@@ -3,10 +3,10 @@
 # External librairies
 require "csv"
 require "faraday"
-require "faraday_middleware"
 require "fileutils"
 require "json"
 require "nokogiri"
+require "faraday/retry"
 
 # An opinionated Ruby interface to the Zuora REST API
 module IronBank
@@ -83,6 +83,8 @@ require "iron_bank/authentications/token"
 require "iron_bank/client"
 require "iron_bank/describe/field"
 require "iron_bank/describe/excluded_fields"
+require "iron_bank/describe/excluded_fields/deduce_from_query"
+require "iron_bank/describe/excluded_fields/extract_from_message"
 require "iron_bank/describe/object"
 require "iron_bank/describe/related"
 require "iron_bank/describe/tenant"

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: iron_bank
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Mickael Pham
 - Cheng Cui
 - Ryan Ringler
 - Mustafa Turan
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2025-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -19,28 +19,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -55,7 +55,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
-description: 
+description:
 email:
 - mickael@zendesk.com
 - ccui@zendesk.com
@@ -107,6 +107,8 @@ files:
 - lib/iron_bank/configuration.rb
 - lib/iron_bank/csv.rb
 - lib/iron_bank/describe/excluded_fields.rb
+- lib/iron_bank/describe/excluded_fields/deduce_from_query.rb
+- lib/iron_bank/describe/excluded_fields/extract_from_message.rb
 - lib/iron_bank/describe/field.rb
 - lib/iron_bank/describe/object.rb
 - lib/iron_bank/describe/related.rb
@@ -157,7 +159,7 @@ licenses:
 - Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,15 +167,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: An opinionated Ruby interface to the Zuora API.
 test_files: []