iron_bank 5.2.3 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e37b6edaf23f3f2c56ad899f5e22e5417080acf0f6af49b3e844f4b08403032
-  data.tar.gz: 41a4709d82e6e8d7a26dd6864a33f0872dfd41a28552276bb15a6f0ee2028dc1
+  metadata.gz: 318930655ab8662b1aff972445f64db04b8d4a728bdd99efca68d7959be3ec2e
+  data.tar.gz: b70938147156d35cb100143d31c671af3273fc3d4615ed304eea335c0431e7c2
 SHA512:
-  metadata.gz: 595e9e90dd0e01cad19051c3e4c1b283aec74a45e61c4629fc84f2628e4c508acc205761a717f77ca92b06ddc1df7b414e91cb1b440afba58c17b9a1e4dbe14b
-  data.tar.gz: 68ad911c800be46ddd923ad5d660c173439dba05d1e45234ebe325c997126ccc480b04c82c3e4bc0c1c7ff2c294873c7f1c1f5b94110ae3651ce01d91354673e
+  metadata.gz: 57048f30a2514b52da75fa8269d4c29dc80ae490153bd86999ece894eac442b583780adb5d66a0b0b39d9eeb9e0f3f9997b479a6729215f2f18847c8cea00b34
+  data.tar.gz: fe64468e0f79b085ccbde1fbd1f90d483fb23ec52fafdf8e1adface0f13b98b6af23fa3b262a49a34132f7da3ffcd233b9ff73c7d607cc61d1eb4cfd63670d49

data/.github/workflows/ci.yml

@@ -15,7 +15,6 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - 2.5
           - 2.6
           - 2.7
           - 3.0

data/.reek.yml

@@ -19,6 +19,7 @@ detectors:
       - IronBank::Configuration#middlewares
       - IronBank::Configuration#schema_directory
       - IronBank::Configuration#users_file
+      - IronBank::Configuration#api_minor_version
 
   BooleanParameter:
     exclude:

data/.ruby-version

@@ -1 +1 @@
-2.5.8
+2.6.7

data/Gemfile

@@ -11,10 +11,10 @@ gem "dotenv",              "~> 2.2"
 gem "factory_bot",         "~> 6.0"
 gem "pry-byebug",          "~> 3.4"
 gem "rake",                "~> 13.0"
-gem "reek",                "~> 6.0"
-gem "rspec",               "~> 3.0"
-gem "rubocop",             "~> 1.0"
-gem "rubocop-performance", "~> 1.0"
-gem "shoulda-matchers",    "~> 4.0"
-gem "simplecov",           "~> 0.15"
+gem "reek",                "~> 6"
+gem "rspec",               "~> 3"
+gem "rubocop",             "~> 1"
+gem "rubocop-performance", "~> 1"
+gem "shoulda-matchers",    "~> 4"
+gem "simplecov",           "~> 0.21"
 gem "timecop",             "~> 0.9"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    iron_bank (5.2.3)
+    iron_bank (5.3.0)
       faraday (~> 1)
       faraday_middleware (~> 1)
       nokogiri (~> 1)
@@ -15,7 +15,7 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    ast (2.4.1)
+    ast (2.4.2)
     bump (0.10.0)
     byebug (11.1.3)
     coderay (1.1.3)
@@ -25,33 +25,43 @@ GEM
     dotenv (2.7.6)
     factory_bot (6.1.0)
       activesupport (>= 5.0.0)
-    faraday (1.4.3)
+    faraday (1.10.0)
       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.1)
-      multipart-post (>= 1.2, < 3)
+      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.1.0)
-    faraday_middleware (1.0.0)
+    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)
     i18n (1.8.7)
       concurrent-ruby (~> 1.0)
     kwalify (0.7.2)
     method_source (1.0.0)
-    mini_portile2 (2.5.3)
+    mini_portile2 (2.8.0)
     minitest (5.14.3)
-    multipart-post (2.1.1)
-    nokogiri (1.11.7)
-      mini_portile2 (~> 2.5.0)
+    multipart-post (2.2.3)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    parallel (1.22.1)
+    parser (3.0.3.2)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -60,16 +70,16 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     psych (3.3.0)
-    racc (1.5.2)
-    rainbow (3.0.0)
+    racc (1.6.0)
+    rainbow (3.1.1)
     rake (13.0.3)
     reek (6.0.3)
       kwalify (~> 0.7.0)
       parser (~> 3.0.0)
       psych (~> 3.1)
       rainbow (>= 2.0, < 4.0)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -83,22 +93,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.1)
-    rubocop (1.8.1)
+    rubocop (1.24.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.0)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.15.2)
+      parser (>= 3.0.1.1)
     rubocop-performance (1.9.2)
       rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
+    ruby2_keywords (0.0.5)
     shoulda-matchers (4.5.0)
       activesupport (>= 4.2.0)
     simplecov (0.21.2)
@@ -107,10 +117,10 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.2)
-    timecop (0.9.2)
+    timecop (0.9.5)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
     zeitwerk (2.4.2)
 
 PLATFORMS
@@ -124,13 +134,13 @@ DEPENDENCIES
   iron_bank!
   pry-byebug (~> 3.4)
   rake (~> 13.0)
-  reek (~> 6.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.0)
-  rubocop-performance (~> 1.0)
-  shoulda-matchers (~> 4.0)
-  simplecov (~> 0.15)
+  reek (~> 6)
+  rspec (~> 3)
+  rubocop (~> 1)
+  rubocop-performance (~> 1)
+  shoulda-matchers (~> 4)
+  simplecov (~> 0.21)
   timecop (~> 0.9)
 
 BUNDLED WITH
-   2.2.21
+   2.3.16

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

data/Rakefile

@@ -33,7 +33,7 @@ task :excluded_fields, [:filename] do |_t, args|
   destination = args[:filename] || IronBank.configuration.excluded_fields_file
   fields      = IronBank::Schema.excluded_fields.sort.to_h
 
-  File.open(destination, "w") { |file| file.write(Psych.dump(fields)) }
+  File.write(destination, Psych.dump(fields))
 end
 
 # Helper function to set up an `IronBank::Client` instance

data/iron_bank.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
     "mturan@zendesk.com"
   ]
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.6"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday",            "~> 1"
   spec.add_dependency "faraday_middleware", "~> 1"
   spec.add_dependency "nokogiri",           "~> 1"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/iron_bank/action.rb

@@ -39,13 +39,11 @@ module IronBank
     end
 
     def response_object
-      @response_object ||= begin
-        if body.is_a?(Array)
-          ::IronBank::Object.new(body.first).deep_underscore
-        else
-          {}
-        end
-      end
+      @response_object ||= if body.is_a?(Array)
+                             ::IronBank::Object.new(body.first).deep_underscore
+                           else
+                             {}
+                           end
     end
 
     def errors

data/lib/iron_bank/actions/query_more.rb

@@ -9,7 +9,7 @@ module IronBank
       private
 
       def params
-        { 'queryLocator': args }
+        { queryLocator: args }
       end
 
       # NOTE: Zuora API endpoint is case-sensitive.

data/lib/iron_bank/client.rb

@@ -99,7 +99,11 @@ module IronBank
     end
 
     def headers
-      { "Content-Type" => "application/json" }.merge(auth.header)
+      config = IronBank.configuration
+      auth.header.reverse_merge(
+        "Content-Type"  => "application/json",
+        "zuora-version" => config.api_minor_version
+      )
     end
 
     def reset_connection

data/lib/iron_bank/collection.rb

@@ -12,7 +12,8 @@ module IronBank
                    :empty?,
                    :length,
                    :map,
-                   :size
+                   :size,
+                   :to_ary
 
     def initialize(klass, conditions, records)
       @klass = klass

data/lib/iron_bank/configuration.rb

@@ -37,12 +37,16 @@ module IronBank
     # File path for Zuora users export
     attr_accessor :users_file
 
+    # Specify a minor version
+    attr_accessor :api_minor_version
+
     def initialize
-      @schema_directory = "./config/schema"
-      @export_directory = "./config/export"
-      @logger           = IronBank::Logger.new
-      @auth_type        = "token"
-      @middlewares      = []
+      @schema_directory   = "./config/schema"
+      @export_directory   = "./config/export"
+      @logger             = IronBank::Logger.new
+      @auth_type          = "token"
+      @middlewares        = []
+      @api_minor_version  = "211.0"
     end
 
     def schema_directory=(value)
@@ -94,10 +98,8 @@ module IronBank
         return {}
       end
 
-      @excluded_fields ||= begin
-        Psych.load_file(excluded_fields_file).tap do |fields|
-          raise "Excluded fields must be a hash" unless fields.is_a?(Hash)
-        end
+      @excluded_fields ||= Psych.load_file(excluded_fields_file).tap do |fields|
+        raise "Excluded fields must be a hash" unless fields.is_a?(Hash)
       end
     end
   end

data/lib/iron_bank/describe/object.rb

@@ -56,6 +56,16 @@ module IronBank
         @query_fields ||= fields.select(&:selectable?).map(&:name)
       end
 
+      def query_custom_fields
+        @query_custom_fields ||= begin
+          custom_fields = fields.select do |field|
+            field.selectable? && field.custom?
+          end
+
+          custom_fields.map(&:name)
+        end
+      end
+
       def related
         @related ||= doc.xpath(".//related-objects/object").map do |node|
           IronBank::Describe::Related.from_xml(node)

data/lib/iron_bank/error.rb

@@ -6,20 +6,18 @@ module IronBank
     # Returns the appropriate IronBank::Error subclass based on status and
     # response message
     def self.from_response(response)
-      klass = begin
-        case response.status
-        when 200      then from_body(response)
-        when 400      then IronBank::BadRequestError
-        when 401      then IronBank::UnauthorizedError
-        when 404      then IronBank::NotFoundError
-        when 422      then IronBank::UnprocessableEntityError
-        when 429      then IronBank::TooManyRequestsError
-        when 500      then IronBank::InternalServerError
-        when 400..499 then IronBank::ClientError
-        when 500..599 then IronBank::ServerError
-        else               IronBank::Error
-        end
-      end
+      klass = case response.status
+              when 200      then from_body(response)
+              when 400      then IronBank::BadRequestError
+              when 401      then IronBank::UnauthorizedError
+              when 404      then IronBank::NotFoundError
+              when 422      then IronBank::UnprocessableEntityError
+              when 429      then IronBank::TooManyRequestsError
+              when 500      then IronBank::InternalServerError
+              when 400..499 then IronBank::ClientError
+              when 500..599 then IronBank::ServerError
+              else IronBank::Error
+              end
 
       klass&.new(response)
     end

data/lib/iron_bank/local_records.rb

@@ -28,9 +28,11 @@ module IronBank
         sleep backoff_time
       end
 
+      # rubocop:disable Style/FileWrite
       File.open(file_path, "w") do |file|
         file.write(export.content.force_encoding("UTF-8"))
       end
+      # rubocop:enable Style/FileWrite
     end
 
     private

data/lib/iron_bank/metadata.rb

@@ -31,6 +31,12 @@ module IronBank
       @query_fields ||= schema.query_fields - excluded_fields
     end
 
+    def query_custom_fields
+      return [] unless schema
+
+      @query_custom_fields ||= schema.query_custom_fields - excluded_fields
+    end
+
     def schema
       @schema ||= IronBank::Schema.for(object_name)
     end

data/lib/iron_bank/schema.rb

@@ -39,11 +39,9 @@ module IronBank
     end
 
     def self.excluded_fields
-      @excluded_fields ||= begin
-        IronBank::Resources.constants.each.with_object({}) do |resource, fields|
-          fields[resource.to_s] =
-            IronBank::Describe::ExcludedFields.call(object_name: resource)
-        end
+      @excluded_fields ||= IronBank::Resources.constants.each.with_object({}) do |resource, fields|
+        fields[resource.to_s] =
+          IronBank::Describe::ExcludedFields.call(object_name: resource)
       end
     end
 

data/lib/iron_bank/user.rb

@@ -16,14 +16,12 @@ module IronBank
       def store
         return {} unless users_file
 
-        @store ||= begin
-          if File.exist?(users_file)
-            load_records
-          else
-            IronBank.logger.warn "File does not exist: #{users_file}"
-            {}
-          end
-        end
+        @store ||= if File.exist?(users_file)
+                     load_records
+                   else
+                     IronBank.logger.warn "File does not exist: #{users_file}"
+                     {}
+                   end
       end
 
       def load_records

data/lib/iron_bank/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iron_bank
 version: !ruby/object:Gem::Version
-  version: 5.2.3
+  version: 5.3.0
 platform: ruby
 authors:
 - Mickael Pham
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -154,7 +154,8 @@ files:
 homepage: https://github.com/zendesk/iron_bank
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -163,15 +164,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3.1
 signing_key:
 specification_version: 4
 summary: An opinionated Ruby interface to the Zuora API.