iron_bank 4.2.0 → 4.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c43b87965a20a054d039009a4da852974532dc4b079b8ceb20d6ec9849a00eb3
-  data.tar.gz: a23c602da14f5bcfcf1ed9cc9dcece5a21dc083c7d941c63e444870c3384dfb4
+SHA1:
+  metadata.gz: 83c23241ccd3c9228badb707b4f12c031f3d338d
+  data.tar.gz: 142aa1b442282003b63012e58d418c8d6dce6ca0
 SHA512:
-  metadata.gz: e026432778a617ffebe80df42f2fde537a85be17682d34c8f451b8e3548d0d149c74d35c386d7bc038da6bbde18515688e662d582e82ff9a1249853e3a7136d4
-  data.tar.gz: 8b7ec698f0e0ecf5a19db78d246980ce117abdaae68dbc67bf5572fd98d366fe48160be8ae35ad17e9db609cbe1798f58828104e4dfae4a7fda0e677abd87637
+  metadata.gz: 010ba8a30e6918ea5d13c6df9bba5860811c4fd14d940a2a1eee89a3c2028029aa1af33771b9eec14b969deef3b68019ec725b95f902af7f27054de510111053
+  data.tar.gz: d3ba4a439cbf0b307d6cd178f1f0c7a82de78545c47c65212f61759f690c135cd2ef62a150b501c0f7efa6b70f9c99567da4dfc5ba4797db774aef45d35bd35b

data/.env.example

@@ -4,3 +4,4 @@ ZUORA_AUTH_TYPE=token
 ZUORA_DOMAIN=rest.apisandbox.zuora.com
 ZUORA_TENANT_ID=00000
 ZUORA_EXCLUDED_FIELDS_FILE=excluded_fields.yml
+ZUORA_USERS_FILE=users.csv

data/.gitignore

@@ -18,3 +18,6 @@
 
 # do not version specific excluded fields
 excluded_fields.yml
+
+# do not version exported users
+users.csv

data/.reek.yml

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    iron_bank (4.2.0)
+    iron_bank (4.4.3)
       faraday (~> 0)
       faraday_middleware (~> 0)
       nokogiri (~> 1)
@@ -35,9 +35,9 @@ GEM
     equalizer (0.0.11)
     factory_bot (5.0.2)
       activesupport (>= 4.2.0)
-    faraday (0.15.4)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.13.1)
+    faraday_middleware (0.14.0)
       faraday (>= 0.7.4, < 1.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
@@ -49,7 +49,7 @@ GEM
     mini_portile2 (2.4.0)
     minitest (5.11.3)
     multipart-post (2.1.1)
-    nokogiri (1.10.4)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
     parser (2.6.3.0)
@@ -130,4 +130,4 @@ DEPENDENCIES
   timecop (~> 0.9)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/bin/console

@@ -12,6 +12,7 @@ IronBank.configure do |config|
   config.auth_type            = ENV.fetch("ZUORA_AUTH_TYPE", "token")
   config.domain               = ENV["ZUORA_DOMAIN"]
   config.excluded_fields_file = ENV["ZUORA_EXCLUDED_FIELDS_FILE"]
+  config.users_file           = ENV["ZUORA_USERS_FILE"]
 end
 
 Pry.start

data/lib/iron_bank.rb

@@ -88,6 +88,7 @@ require "iron_bank/object"
 require "iron_bank/schema"
 require "iron_bank/query_builder"
 require "iron_bank/payment_run"
+require "iron_bank/user"
 
 # Operations
 require "iron_bank/operation"

data/lib/iron_bank/collection.rb

@@ -9,6 +9,7 @@ module IronBank
     def_delegators :@records,
                    :[],
                    :each,
+                   :empty?,
                    :length,
                    :map,
                    :size

data/lib/iron_bank/configuration.rb

@@ -34,6 +34,9 @@ module IronBank
     # Directory where the local records are exported.
     attr_reader :export_directory
 
+    # File path for Zuora users export
+    attr_accessor :users_file
+
     def initialize
       @schema_directory = "./config/schema"
       @export_directory = "./config/export"

data/lib/iron_bank/endpoint.rb

@@ -7,7 +7,7 @@ module IronBank
     private_class_method :new
 
     PRODUCTION  = /\Arest\.zuora\.com\z/i.freeze
-    SERVICES    = /\Aservices(\d+)\.zuora\.com(:\d+)?\z/i.freeze
+    SERVICES    = /\A(rest)?services(\d+)\.zuora\.com(:\d+)?\z/i.freeze
     APISANDBOX  = /\Arest.apisandbox.zuora\.com\z/i.freeze
 
     def self.base_url(domain = "")

data/lib/iron_bank/resources/rate_plan_charge.rb

@@ -5,12 +5,14 @@ module IronBank
     # A rate plan charge belongs to a subscription rate plan.
     #
     class RatePlanCharge < Resource
+      extend Gem::Deprecate
+
       def self.excluded_fields
         super + single_resource_query_fields
       end
 
       def self.single_resource_query_fields
-        %w[RolloverBalance]
+        %w[RolloverBalance Price]
       end
 
       with_schema
@@ -25,6 +27,21 @@ module IronBank
       def rollover_balance
         remote[:rollover_balance] || reload.remote[:rollover_balance]
       end
+
+      # NOTE: #price was only available when (1) the pricing model for the
+      #       charge is either "Flat Fee" or "Per Unit" AND (2) the charge was
+      #       queried through ZOQL, i.e, using `IronBank::Charge#where` method.
+      #
+      #       Testing Zuora REST API (using the `IronBank::Charge#find` method)
+      #       shows that Zuora does not return a `price` attribute in their
+      #       response. This means we consider #price to be a remain from the
+      #       SOAP ZOQL query operation. We are deprecating this method without
+      #       replacement. Instead, users should be fetching the `#tiers` for
+      #       the current charge and get the price information from there.
+      def price
+        nil
+      end
+      deprecate :price, :none, 2020, 1
     end
   end
 end

data/lib/iron_bank/user.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module IronBank
+  # A Zuora user, only available if the user data has been exported and provided
+  # to IronBank through the `users_file` configuration option.
+  #
+  # Cf. https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/Manage_Users#Export_User_Data_to_a_CSV_File
+  #
+  class User
+    extend IronBank::Local
+    extend SingleForwardable
+
+    def_delegators "IronBank.configuration", :users_file
+
+    class << self
+      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
+      end
+
+      def load_records
+        CSV.foreach(users_file, headers: true).with_object({}) do |row, store|
+          store[row["User ID"]] = new(row.to_h.compact)
+        end
+      end
+
+      def all
+        store.values
+      end
+
+      def find(user_id)
+        store[user_id] || raise(IronBank::NotFoundError, "user id: #{user_id}")
+      end
+    end
+
+    US_DATE_FORMAT = "%m/%d/%Y"
+
+    FIELDS = [
+      "User ID",
+      "User Name",
+      "First Name",
+      "Last Name",
+      "Status",
+      "Work Email",
+      "Created On",
+      "Zuora Billing Role",
+      "Zuora Payment Role",
+      "Zuora Commerce Role",
+      "Zuora Platform Role",
+      "Zuora Finance Role",
+      "Zuora Reporting Role",
+      "Zuora Insights Role",
+      "Last Login"
+    ].freeze
+
+    FIELDS.each do |field|
+      method_name = IronBank::Utils.underscore(field.tr(" ", ""))
+
+      define_method(method_name) do
+        attributes[field]
+      end
+    end
+
+    attr_reader :attributes
+
+    alias id user_id
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def inspect
+      ruby_id = "#{self.class.name}:0x#{(object_id << 1).to_s(16)} id=\"#{id}\""
+
+      "#<#{ruby_id} user_name=\"#{user_name}\">"
+    end
+
+    def last_login
+      @last_login ||= Date.strptime(attributes["Last Login"], US_DATE_FORMAT)
+    end
+
+    def created_on
+      @created_on ||= Date.strptime(attributes["Created On"], US_DATE_FORMAT)
+    end
+  end
+end

data/lib/iron_bank/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iron_bank
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.4.3
 platform: ruby
 authors:
 - Mickael Pham
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -330,6 +330,7 @@ files:
 - lib/iron_bank/resources/taxation_item.rb
 - lib/iron_bank/resources/usage.rb
 - lib/iron_bank/schema.rb
+- lib/iron_bank/user.rb
 - lib/iron_bank/utils.rb
 - lib/iron_bank/version.rb
 homepage: https://github.com/zendesk/iron_bank
@@ -351,7 +352,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubyforge_project: 
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: An opinionated Ruby interface to the Zuora API.