zuora_rest_client 1.0.1

data/lib/zuora_rest_client/connection.rb

@@ -0,0 +1,189 @@
+require 'zuora_rest_client/result'
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/detailed_logger'
+require 'multi_json'
+require 'ostruct'
+require 'logger'
+require 'nori'
+require 'net/http'
+require 'addressable/uri'
+
+module ZuoraRestClient
+  class Connection
+
+    DEFAULT_OPTIONS = {
+        entity_id: nil,
+        entity_name: nil,
+        logger: Logger.new($stdout),
+        log_level: :error,
+        log: true }
+
+    def initialize(username, password, environment = :production, options = {})
+      @username = username
+      @password = password
+      @environment = environment
+      @options = {}.merge(DEFAULT_OPTIONS).merge(options)
+    end
+
+    def app_get(path)
+      response = app_connection.get do |request|
+        request.url path
+        request.headers = app_headers
+      end
+      process_response(response)
+    end
+
+    def app_post(path, post_data = nil, is_json = true)
+      response = app_connection.get do |request|
+        request.url path
+        request.headers = app_headers
+        request.body = MultiJson.dump(post_data) if !post_data.nil? && is_json
+        request.body = post_data if !post_data.nil? && !is_json
+      end
+      process_response(response)
+    end
+
+    def rest_get(path, zuora_version = nil)
+      response = rest_connection.get do |request|
+        request.url [ ZUORA_REST_MAJOR_VERSION, path ].join('/')
+        request.headers = rest_headers(zuora_version)
+      end
+      process_response(response)
+    end
+
+    def rest_streamed_get(path, destination_io, zuora_version = nil)
+
+      # Set IO to binary mode
+      destination_io.binmode
+
+      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 path
+        rest_headers(zuora_version).each_pair do |header_key, header_value|
+          request[header_key] = header_value
+        end
+        http.request request do |response|
+          response.read_body do |chunk|
+            destination_io.write chunk
+          end
+        end
+      end
+
+      # Set pointer to beginning of file
+      destination_io.rewind
+
+      nil
+    end
+
+    def rest_post(path, post_data = nil, zuora_version = nil, is_json = true)
+      response = rest_connection.post do |request|
+        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
+      end
+      process_response(response)
+    end
+
+    def rest_put(path, put_data = nil, zuora_version = nil, is_json = true)
+      response = rest_connection.put do |request|
+        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
+      end
+      process_response(response)
+    end
+
+    def rest_delete(path, zuora_version = nil)
+      response = rest_connection.delete do |request|
+        request.url [ ZUORA_REST_MAJOR_VERSION, path ].join('/')
+        request.headers = rest_headers(zuora_version)
+      end
+      process_response(response)
+    end
+
+    private
+
+    ZUORA_REST_MAJOR_VERSION = 'v1'
+
+    ZUORA_ENVIRONMENTS = {
+        production: {
+            rest: 'https://rest.zuora.com',
+            app: 'https://www.zuora.com' },
+        api_sandbox: {
+            rest: 'https://rest.apisandbox.zuora.com',
+            app: 'https://apisandbox.zuora.com' } }
+
+    def app_connection
+      Faraday.new(url: zuora_endpoint.app) do |faraday|
+        faraday.use FaradayMiddleware::FollowRedirects
+        faraday.use Faraday::Request::BasicAuthentication, @username, @password
+        faraday.request :multipart
+        faraday.response :detailed_logger, logger
+        faraday.adapter :httpclient
+      end
+    end
+
+    def app_headers
+      headers = { 'Content-Type' => 'application/json' }
+      headers['entityId'] = @options[:entity_id] if !@options[:entity_id].nil?
+      headers['entityName'] = @options[:entity_name] if !@options[:entity_name].nil?
+      headers
+    end
+
+    def logger
+      result = @options[:logger] || Logger.new($stdout)
+      log_level = (@options[:log_level] || :info).to_s.upcase
+      result.level = Logger::INFO
+      result.level = Logger.const_get(log_level) if Logger.const_defined?(log_level)
+      result
+    end
+
+    def process_response(response)
+      if response.headers['Content-Type'].to_s.start_with?('application/json')
+        hash = MultiJson.load(response.body)
+        Result.new(hash, recurse_over_arrays: true)
+      elsif response.headers['Content-Type'].to_s.start_with?('text/xml')
+        Result.new(Nori.new.parse(response.body), recurse_over_arrays: true)
+      else
+        response
+      end
+    end
+
+    def rest_connection
+      Faraday.new(url: zuora_endpoint.rest) do |faraday|
+        faraday.use FaradayMiddleware::FollowRedirects
+        faraday.request :multipart
+        faraday.response :detailed_logger, logger
+        faraday.adapter :httpclient
+      end
+    end
+
+    def rest_headers(zuora_version = nil)
+      headers = { 'Content-Type' => 'application/json',
+          'apiAccessKeyId' => @username,
+          'apiSecretAccessKey' => @password }
+      headers['entityId'] = @options[:entity_id] if !@options[:entity_id].nil?
+      headers['entityName'] = @options[:entity_name] if !@options[:entity_name].nil?
+      headers['zuora-version'] = zuora_version if !zuora_version.nil?
+      headers
+    end
+
+    def zuora_endpoint
+      if @environment.is_a? Symbol
+        rest_endpoint = "#{ZUORA_ENVIRONMENTS[@environment][:rest]}"
+        app_endpoint = "#{ZUORA_ENVIRONMENTS[@environment][:app]}/apps/api"
+      elsif @environment.is_a? Hash
+        rest_endpoint = "#{@environment[:rest]}"
+        app_endpoint = "#{@environment[:app]}/apps/api"
+      else
+        raise 'Possible values for environment are: :production, :sandbox, or a hash with base URL values for :rest and :app.'
+      end
+      OpenStruct.new({ rest: rest_endpoint, app: app_endpoint })
+    end
+
+  end
+end

data/lib/zuora_rest_client/result.rb

@@ -0,0 +1,8 @@
+require 'recursive-open-struct'
+
+module ZuoraRestClient
+
+  class Result < RecursiveOpenStruct
+  end
+
+end

data/lib/zuora_rest_client/version.rb

@@ -0,0 +1,3 @@
+module ZuoraRestClient
+  VERSION = '1.0.1'
+end

data/lib/zuora_rest_client.rb

@@ -0,0 +1,7 @@
+require 'zuora_rest_client/version'
+require 'zuora_rest_client/client'
+require 'zuora_rest_client/connection'
+require 'zuora_rest_client/result'
+
+module ZuoraRestClient
+end

data/zuora_rest_client.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zuora_rest_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'zuora_rest_client'
+  spec.version       = ZuoraRestClient::VERSION
+  spec.authors       = ['David Massad']
+  spec.email         = ['david.massad@fronteraconsulting.net']
+
+  spec.summary       = 'Zuora REST Client'
+  spec.description   = 'An easy-to-use client for Zuora.'
+  spec.homepage      = 'https://github.com/FronteraConsulting/zuora_rest_client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'dotenv', '~> 2.2', '>= 2.2.1'
+  spec.add_development_dependency 'simplecov', '~> 0.14.1'
+  spec.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.3'
+  spec.add_development_dependency 'webmock', '~> 3.0', '>= 3.0.1'
+  spec.add_development_dependency 'http-cookie', '~> 1.0', '>= 1.0.3'
+
+  spec.add_runtime_dependency 'httpclient', '~> 2.8'
+  spec.add_runtime_dependency 'faraday', '~> 0'
+  spec.add_runtime_dependency 'faraday-detailed_logger', '~> 2'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0'
+  spec.add_runtime_dependency 'multipart-post', '~> 2'
+  spec.add_runtime_dependency 'addressable', '~> 2', '>= 2.5.1'
+  spec.add_runtime_dependency 'fire_poll', '~> 1.2'
+  spec.add_runtime_dependency 'multi_json', '~> 1.12', '>= 1.12.1'
+  spec.add_runtime_dependency 'nori', '~> 2.6'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.8'
+  spec.add_runtime_dependency 'recursive-open-struct', '~> 1.0', '>= 1.0.4'
+
+end

metadata

@@ -0,0 +1,383 @@
+--- !ruby/object:Gem::Specification
+name: zuora_rest_client
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- David Massad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: http-cookie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-detailed_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+- !ruby/object:Gem::Dependency
+  name: fire_poll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+description: An easy-to-use client for Zuora.
+email:
+- david.massad@fronteraconsulting.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixtures/vcr_cassettes/zuora/create_account_object_success.yml
+- fixtures/vcr_cassettes/zuora/create_account_success.yml
+- fixtures/vcr_cassettes/zuora/delete_account_object_success.yml
+- fixtures/vcr_cassettes/zuora/describe_account.yml
+- fixtures/vcr_cassettes/zuora/describe_account_related_objects.yml
+- fixtures/vcr_cassettes/zuora/describe_all_account_fields.yml
+- fixtures/vcr_cassettes/zuora/describe_all_zobjects.yml
+- fixtures/vcr_cassettes/zuora/describe_exportable_account_fields.yml
+- fixtures/vcr_cassettes/zuora/describe_non_exportable_account_fields.yml
+- fixtures/vcr_cassettes/zuora/describe_non_updateable_account_fields.yml
+- fixtures/vcr_cassettes/zuora/describe_updateable_account_fields.yml
+- fixtures/vcr_cassettes/zuora/get_account_object_success.yml
+- fixtures/vcr_cassettes/zuora/get_account_success.yml
+- fixtures/vcr_cassettes/zuora/get_account_summary_success.yml
+- fixtures/vcr_cassettes/zuora/update_account_object_success.yml
+- fixtures/vcr_cassettes/zuora/update_account_success.yml
+- lib/zuora_rest_client.rb
+- lib/zuora_rest_client/client.rb
+- lib/zuora_rest_client/connection.rb
+- lib/zuora_rest_client/result.rb
+- lib/zuora_rest_client/version.rb
+- zuora_rest_client.gemspec
+homepage: https://github.com/FronteraConsulting/zuora_rest_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Zuora REST Client
+test_files: []