iron_bank 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c43b87965a20a054d039009a4da852974532dc4b079b8ceb20d6ec9849a00eb3
-  data.tar.gz: a23c602da14f5bcfcf1ed9cc9dcece5a21dc083c7d941c63e444870c3384dfb4
+  metadata.gz: 00c270266ed85615c32706b617a644cfac0d954a3fc19117733d0a4d1a4a4687
+  data.tar.gz: aad4d425eabc0f6ecdcdec124d00913f471edd2ff431b3c18b8fbfce2ff9ee37
 SHA512:
-  metadata.gz: e026432778a617ffebe80df42f2fde537a85be17682d34c8f451b8e3548d0d149c74d35c386d7bc038da6bbde18515688e662d582e82ff9a1249853e3a7136d4
-  data.tar.gz: 8b7ec698f0e0ecf5a19db78d246980ce117abdaae68dbc67bf5572fd98d366fe48160be8ae35ad17e9db609cbe1798f58828104e4dfae4a7fda0e677abd87637
+  metadata.gz: 8c74322d9de788d46d9137e8d32435163d1543c5a2d71d7b90ce9b2328df22b4ccd452af557e0692b5af1c15537f00e4045a21b916d0cd76a6dbcf2d98249d8f
+  data.tar.gz: 80640919d22b8114f60edff018fb234757ecf4f971166d7beb3a077c1d17a610861994d6b1f4f7abf31ab268e1f4f77be47abf8387420132d5ea4cbae2e75bd0

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.3.0)
       faraday (~> 0)
       faraday_middleware (~> 0)
       nokogiri (~> 1)

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/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/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.3.0"
   API_VERSION = "v1"
 end

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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iron_bank
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 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: 2019-09-20 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