zuora_rest_client 1.2.1.5 → 1.2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b558b8c13c32562a9b1a7d80a70506b16ed205f8d76db8a3ee8c047689aa570c
-  data.tar.gz: c7f32c6fd5e3ea6bc99c0e2de30d131b83f6c20596d067e6099cb8a753a8d430
+  metadata.gz: 3637cbe1e944055ad2b7303e6e92735b736224dfa77ad00153430c6da7674db4
+  data.tar.gz: de9dd2e15c1d52fec7533b6fa04ddeb4b8650f8b025a6b47d07c4d186710832d
 SHA512:
-  metadata.gz: 119115fc601a9e7ed405145fbfb35eaf18bf254d234f7b8fd69c4115cdd7e6f51fd4af2c57f401f17970617c0f17f98c4a28e4e559f0af1586baf3e45fbd32fd
-  data.tar.gz: e3099dd3f4d6f6db5559fca838bfe00e163feec2a31ff83796064ff8bc038ba945d708fa83ebe2b8303f7f662ffbb67d52123caad602337fdf494cb8d6a69c94
+  metadata.gz: 76df5debfb8ec385702e50537e2693f1879fe62832fe683947b46a4159626a1142f705b27c4f8d54c8e6e74de48f8a403a61bb29fb69c8c39a8ac6b2291f88d3
+  data.tar.gz: 1aa64f505dbddad21e621037d691f2c2120f4e1979c6df0637781685418624560f08dd607a9ff419246a520f88a0fb840874e3d9d486c7db71a90858179df2bf

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2020 Frontera Consulting, LLC
+Copyright 2021 Frontera Consulting, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the "Software"),

data/README.md

@@ -1,12 +1,11 @@
 # ZuoraRestClient
 
-This is a simple Zuora client for Ruby.  It mainly consists of methods that 
-wrap the operations described in the Zuora API Reference 
+This is a simple Zuora client for Ruby. It mainly consists of methods that wrap the operations described in the Zuora
+API Reference
 (https://www.zuora.com/developer/api-reference), as well as a few helper methods.
 
-Most of the methods take either the query parameters and/or a hash representing the JSON
-request body as arguments.  The methods return a `ZuoraRestClient::Result` object which
-represents ths JSON response.
+Most of the methods take either the query parameters and/or a hash representing the JSON request body as arguments. The
+methods return a `ZuoraRestClient::Result` object which represents ths JSON response.
 
 ## Installation
 
@@ -27,26 +26,35 @@ Or install it yourself as:
 ## Usage
 
 First, construct a client object:
+
 ```ruby
 username = 'zuora_username@example.com'
 password = 'mypassword'
-client = ZuoraRestClient::Client.new(username, password)  # Create a production client
+client = ZuoraRestClient::Client.new(username, password) # Create a production client
 ```
 
-For a sandbox tenant, you can specify the following:
+For an API Sandbox tenant, you can specify the following:
+
 ```ruby
-client = ZuoraRestClient::Client.new(username, password, :api_sandbox)  # Create an api sandbox client
+client = ZuoraRestClient::Client.new(username, password, :api_sandbox) # Create an api sandbox client
 ```
 
-For a "serivces*NNN*" tenant, where *NNN* is the number that follows "services", you may also need an 
-API proxy port number to invoke calls to `/action/*` and `/object/*`.  Assuming your services tenant is `services000`
+For a Zuora Central Sandbox tenant, you can specify the following:
+
+```ruby
+client = ZuoraRestClient::Client.new(username, password, :test) # Create an zuora central sandbox client
+```
+
+For a "serivces*NNN*" tenant, where *NNN* is the number that follows "services", you may also need an API proxy port
+number to invoke calls to `/action/*` and `/object/*`. Assuming your services tenant is `services000`
 and your API proxy port number is `1234`, you can specify the following:
 
 ```ruby
-client = ZuoraRestClient::Client.new(username, password, :services000, api_proxy_port: 1234)  # Create an api services000 client
+client = ZuoraRestClient::Client.new(username, password, :services000, api_proxy_port: 1234) # Create an api services000 client
 ```
 
-Call one of the client methods.  For example, to create an account:
+Call one of the client methods. For example, to create an account:
+
 ```ruby
 account_to_create = {
     Batch: 'Batch1',

data/lib/zuora_rest_client/client.rb

@@ -237,7 +237,7 @@ module ZuoraRestClient
 
     def aqua_query(request, options = {})
       aqua_query_options = {}.merge(DEFAULT_AQUA_QUERY_OPTIONS).merge(options)
-      result = @connection.app_post('/apps/api/batch-query/', request)
+      result = @connection.rest_post('/batch-query/', request)
       logger.debug "********* AQUA POST QUERY RESULT: #{result.inspect}"
 
       raise "Error: #{result.message}" if result.status.downcase == 'error'
@@ -260,11 +260,11 @@ module ZuoraRestClient
     end
 
     def get_aqua_job_result(job_id)
-      @connection.app_get("/apps/api/batch-query/jobs/#{job_id}")
+      @connection.rest_get("/batch-query/jobs/#{job_id}")
     end
 
     def get_last_aqua_job_result(partner, project)
-      @connection.app_get("/apps/api/batch-query/jobs/partner/#{partner}/project/#{project}")
+      @connection.rest_get("/batch-query/jobs/partner/#{partner}/project/#{project}")
     end
 
     ##############################################################################
@@ -797,12 +797,12 @@ module ZuoraRestClient
       # Check status and if complete, output file to destination IO
       logger.debug "********* FINAL EXPORT STATUS: #{export_record.Status}"
       case export_record.Status
-        when 'Completed'
-          get_file(export_zobject.FileId, destination_io)
-        when 'Canceled'
-          raise "Error downloading file: #{export_record.Status} - #{export_record.StatusReason}"
-        when 'Failed'
-          raise "Error downloading file: #{export_record.Status} - #{export_record.StatusReason}"
+      when 'Completed'
+        get_file(export_zobject.FileId, destination_io)
+      when 'Canceled'
+        raise "Error downloading file: #{export_record.Status} - #{export_record.StatusReason}"
+      when 'Failed'
+        raise "Error downloading file: #{export_record.Status} - #{export_record.StatusReason}"
       end
 
       # If requested, delete export from server
@@ -995,6 +995,12 @@ module ZuoraRestClient
     #                                                                            #
     ##############################################################################
 
+    def get_invoice_files(invoice_id, page_size = nil, zuora_version = nil)
+      uri = Addressable::URI.parse("/invoices/#{invoice_id}/files")
+      uri.query_values = { pageSize: page_size.to_s } if !page_size.nil?
+      @connection.rest_get(uri.to_s, zuora_version)
+    end
+
     def reverse_invoice(invoice_id, zuora_version = nil)
       @connection.rest_put("/invoices/#{invoice_id}/reverse", nil, zuora_version)
     end

data/lib/zuora_rest_client/connection.rb

@@ -32,7 +32,9 @@ module ZuoraRestClient
       @options = {}.merge(DEFAULT_OPTIONS).merge(options)
     end
 
+    # @deprecated Since the Client class no longer uses this, it will be removed.
     def app_get(path)
+      warn "[DEPRECATION] `app_get` is deprecated. Please use `rest_get` instead."
       response = app_connection.get do |request|
         request.url path
         request.headers = app_headers
@@ -40,7 +42,9 @@ module ZuoraRestClient
       process_response(response)
     end
 
+    # @deprecated Since the Client class no longer uses this, it will be removed.
     def app_post(path, post_data = nil, is_json = true)
+      warn "[DEPRECATION] `app_post` is deprecated. Please use `rest_post` instead."
       response = app_connection.post do |request|
         request.url path
         request.headers = app_headers
@@ -52,7 +56,7 @@ module ZuoraRestClient
 
     def rest_get(path, zuora_version = nil)
       response = rest_connection(use_api_proxy?(path)).get do |request|
-        request.url [ ZUORA_REST_MAJOR_VERSION, path ].join('')
+        request.url [ZUORA_REST_MAJOR_VERSION, path].join('')
         request.headers = rest_headers(zuora_version)
       end
       process_response(response)
@@ -66,7 +70,7 @@ module ZuoraRestClient
       endpoint_uri = Addressable::URI.parse(zuora_endpoint.rest)
       Net::HTTP.start(endpoint_uri.normalized_host, endpoint_uri.normalized_port,
           use_ssl: endpoint_uri.normalized_scheme == 'https') do |http|
-        request = Net::HTTP::Get.new [ endpoint_uri.normalized_path, '/', ZUORA_REST_MAJOR_VERSION, path ].join('')
+        request = Net::HTTP::Get.new [endpoint_uri.normalized_path, '/', ZUORA_REST_MAJOR_VERSION, path].join('')
         rest_headers(zuora_version).each_pair do |header_key, header_value|
           request[header_key] = header_value
         end
@@ -89,7 +93,7 @@ module ZuoraRestClient
 
     def rest_post(path, post_data = nil, zuora_version = nil, is_json = true)
       response = rest_connection(use_api_proxy?(path)).post do |request|
-        request.url [ ZUORA_REST_MAJOR_VERSION, path ].join('')
+        request.url [ZUORA_REST_MAJOR_VERSION, path].join('')
         request.headers = rest_headers(zuora_version)
         request.body = MultiJson.dump(post_data) if !post_data.nil? && is_json
         request.body = post_data if !post_data.nil? && !is_json
@@ -99,7 +103,7 @@ module ZuoraRestClient
 
     def rest_put(path, put_data = nil, zuora_version = nil, is_json = true)
       response = rest_connection(use_api_proxy?(path)).put do |request|
-        request.url [ ZUORA_REST_MAJOR_VERSION, path ].join('')
+        request.url [ZUORA_REST_MAJOR_VERSION, path].join('')
         request.headers = rest_headers(zuora_version)
         request.body = MultiJson.dump(put_data) if !put_data.nil? && is_json
         request.body = put_data if !put_data.nil? && !is_json
@@ -109,7 +113,7 @@ module ZuoraRestClient
 
     def rest_delete(path, zuora_version = nil)
       response = rest_connection(use_api_proxy?(path)).delete do |request|
-        request.url [ ZUORA_REST_MAJOR_VERSION, path ].join('')
+        request.url [ZUORA_REST_MAJOR_VERSION, path].join('')
         request.headers = rest_headers(zuora_version)
       end
       process_response(response)
@@ -125,8 +129,13 @@ module ZuoraRestClient
             app: 'https://www.zuora.com' },
         api_sandbox: {
             rest: 'https://rest.apisandbox.zuora.com',
-            app: 'https://apisandbox.zuora.com' } }
+            app: 'https://apisandbox.zuora.com' },
+        test: {
+            rest: 'https://rest.test.zuora.com',
+            app: 'https://test.zuora.com' }
+    }
 
+    # @deprecated Since the Client class no longer uses this, it will be removed.
     def app_connection
       Faraday.new(url: zuora_endpoint.app, request: {
           open_timeout: @options[:request_open_timeout] || 120,
@@ -139,6 +148,7 @@ module ZuoraRestClient
       end
     end
 
+    # @deprecated Since the Client class no longer uses this, it will be removed.
     def app_headers
       headers = { 'Content-Type' => 'application/json' }
       headers['entityId'] = @options[:entity_id] if !@options[:entity_id].nil?
@@ -216,7 +226,7 @@ module ZuoraRestClient
         rest_endpoint = "#{@environment[:rest]}"
         app_endpoint = "#{@environment[:app]}/apps/api"
       else
-        raise 'Possible values for environment are: :production, :api_sandbox, :servicesNNN or a hash with base URL values for :rest and :app.'
+        raise 'Possible values for environment are: :production, :api_sandbox, :test, :servicesNNN or a hash with base URL values for :rest and :app.'
       end
       OpenStruct.new({ rest: rest_endpoint, app: app_endpoint })
     end

data/lib/zuora_rest_client/version.rb

@@ -1,3 +1,3 @@
 module ZuoraRestClient
-  VERSION = '1.2.1.5'
+  VERSION = '1.2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_rest_client
 version: !ruby/object:Gem::Version
-  version: 1.2.1.5
+  version: 1.2.2.0
 platform: ruby
 authors:
 - David Massad
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
+date: 2021-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -318,7 +318,7 @@ homepage: https://github.com/FronteraConsulting/zuora_rest_client
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -333,8 +333,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Zuora REST Client
 test_files: []