zuora_api_D 1.6.06

data/lib/zuora_api/logins/basic.rb

@@ -0,0 +1,103 @@
+module ZuoraAPI
+  class Basic < Login
+    attr_accessor :username, :password
+    def initialize(username: nil, password: nil, **keyword_args)
+      @username = username
+      @password = password
+      super
+    end
+
+    def new_session( auth_type: :basic, debug: false)
+      raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Basic Login, does not support Authentication of Type: #{auth_type}") if auth_type != :basic
+      raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Basic Login requires username and password to be set.") if auth_type == :basic && (self.password.blank? && self.username.blank?)
+
+      tries ||= 2
+      request = Nokogiri::XML::Builder.new do |xml|
+        xml['SOAP-ENV'].Envelope('xmlns:SOAP-ENV' =>"http://schemas.xmlsoap.org/soap/envelope/", 'xmlns:api' => "http://api.zuora.com/" ) do
+          xml['SOAP-ENV'].Header
+          xml['SOAP-ENV'].Body do
+            xml['api'].login do
+              xml['api'].username self.username
+              xml['api'].password self.password
+              xml['api'].entityId self.entity_id if !self.entity_id.blank?
+            end
+          end
+        end
+      end
+      
+      input_xml = Nokogiri::XML(request.to_xml(:save_with => XML_SAVE_OPTIONS).strip)
+      input_xml.xpath('//ns1:session', 'ns1' =>'http://api.zuora.com/').children.remove
+      Rails.logger.debug('Connect') {"Request SOAP XML: #{input_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}"} if debug
+      
+      @response_query = HTTParty.post(self.url,:body => request.to_xml(:save_with => XML_SAVE_OPTIONS).strip, :headers => {'Content-Type' => "text/xml; charset=utf-8"}, :timeout => 10)
+      @output_xml = Nokogiri::XML(@response_query.body)
+      Rails.logger.debug('Connect') {"Response SOAP XML: #{@output_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}"} if debug   
+
+      if !@response_query.success?
+        self.current_session = nil
+        if @output_xml.namespaces.size > 0  && @output_xml.xpath('//soapenv:Fault').size > 0
+          self.current_error = @output_xml.xpath('//fns:FaultMessage', 'fns' =>'http://fault.api.zuora.com/').text
+          if self.current_error.include?('deactivated')
+            self.status = 'Deactivated'
+            self.current_error = 'Deactivated user login, please check with Zuora tenant administrator'
+            self.errors[:username] = self.current_error
+          elsif self.current_error.include?('inactive')
+            self.status = 'Inactive'
+            self.current_error = 'Inactive user login, please check with Zuora tenant administrator'
+            self.errors[:username] = self.current_error
+          elsif self.current_error.include?("invalid username or password") || self.current_error.include?("Invalid login. User name and password do not match.")
+            self.status = 'Invalid Login'
+            self.current_error = 'Invalid login, please check username and password or URL endpoint'
+            self.errors[:username] = self.current_error
+            self.errors[:password] = self.current_error
+          elsif self.current_error.include?('unsupported version')
+            self.status = 'Unsupported API Version'
+            self.current_error = 'Unsupported API version, please verify URL endpoint'
+            self.errors[:url] = self.current_error
+          elsif self.current_error.include?('invalid api version')
+            self.status = 'Invalid API Version'
+            self.current_error = 'Invalid API version, please verify URL endpoint'
+            self.errors[:url] = self.current_error
+          elsif self.current_error.include?('invalid session')
+            self.status = 'Invalid Session'
+            self.current_error = 'Session invalid, please update session and verify URL endpoint'
+            self.errors[:session] = self.current_error
+          elsif self.current_error.include?('Your IP address')
+            self.status = 'Restricted IP'
+            self.current_error = 'IP restricted, contact Zuora tenant administrator and remove IP restriction'
+            self.errors[:base] = self.current_error
+          elsif self.current_error.include?('This account has been locked')
+            self.status = 'Locked'
+            self.current_error = 'Locked user login, please wait or navigate to Zuora to unlock user'
+            self.errors[:username] = self.current_error
+          else
+            self.status = 'Unknown'
+            self.current_error =  @output_xml.xpath('//faultstring').text if self.current_error.blank?
+            self.errors[:base] = self.current_error
+          end
+
+        else
+          self.status = 'Unknown'
+          self.current_error =  @output_xml.xpath('//faultstring').text if self.current_error.blank?
+          self.errors[:base] = self.current_error
+        end
+      else             
+        #Username & password combo
+        retrieved_session = @output_xml.xpath('//ns1:Session', 'ns1' =>'http://api.zuora.com/').text
+        raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("No session found for api call.") if retrieved_session.blank?
+        self.current_session = retrieved_session
+      end
+      return self.status
+    rescue Net::ReadTimeout, Net::OpenTimeout, Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNREFUSED, SocketError => ex
+      if !(tries -= 1).zero?
+        Rails.logger.info {"#{ex.class} Timed out will retry after 5 seconds"}
+        sleep(self.timeout_sleep)
+        retry
+      else
+        self.current_error = "Request timed out. Try again"
+        self.status = 'Timeout'
+        return self.status
+      end
+    end
+  end
+end

data/lib/zuora_api/logins/oauth.rb

@@ -0,0 +1,106 @@
+module ZuoraAPI
+  class Oauth < Login
+    attr_accessor :oauth_client_id, :oauth_secret, :bearer_token, :oauth_session_expires_at
+    
+    def initialize(oauth_client_id: nil, oauth_secret: nil, bearer_token: nil, oauth_session_expires_at: nil, **keyword_args)
+      self.oauth_client_id = oauth_client_id
+      self.oauth_secret = oauth_secret
+      self.bearer_token = bearer_token if !bearer_token.blank?
+      self.oauth_session_expires_at = oauth_session_expires_at if !oauth_session_expires_at.blank?
+      raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Request Oauth Login but either 'Oauth Client Id' or 'Oauth Secret' were not passed") if @oauth_client_id.blank? || @oauth_secret.blank?
+      super
+    end
+
+    def new_session(raise_errors: false, auth_type: nil)
+      if auth_type ==  :bearer
+        get_bearer_token()
+      elsif auth_type == :basic
+        get_bearer_token() if self.oauth_expired?
+        get_z_session()
+      else
+        get_bearer_token()
+        get_z_session()
+      end
+      return self.status
+    end
+
+    def get_z_session(debug: false)
+      tries ||= 2
+      headers = self.entity_id.present? ? {:entityId => self.entity_id } : {}    
+      output_json, response = self.rest_call(:url => self.rest_endpoint("connections"), :session_type => :bearer, :headers => headers)
+      self.current_session = response.headers.to_h['set-cookie'][0].split(';')[0].split('=',2)[1].gsub('%3D', '=')
+    rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
+      if !(tries -= 1).zero?
+        Rails.logger.debug {"Session Invalid"}
+        self.new_session(auth_type: :bearer)
+        retry
+      else
+        if errors.include?(ex.class)
+          raise ex
+        else
+          return [output_json, response]
+        end
+      end
+    rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition  => ex
+      if errors.include?(ex.class)
+        raise ex
+      else
+        return [output_json, response]
+      end
+    rescue Net::ReadTimeout, Net::OpenTimeout, Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNREFUSED, SocketError => ex
+      if !(tries -= 1).zero?
+        Rails.logger.info {"#{ex.class} Timed out will retry after 5 seconds"}
+        sleep(self.timeout_sleep)
+        retry
+      else
+        self.current_error = "Request timed out. Try again"
+        self.status = 'Timeout'
+        return self.status
+      end
+    end
+
+    def get_bearer_token
+      tries ||= 2
+      output_json, response = self.rest_call(:method => :post, 
+        :url => self.rest_endpoint.chomp('v1/').concat("oauth/token"), 
+        :z_session => false,
+        :session_type => :bearer,
+        :headers => {"content-type" => "application/x-www-form-urlencoded"},
+        :body => {"client_id"=> self.oauth_client_id, "client_secret"=>self.oauth_secret, "grant_type" =>"client_credentials"}
+      )
+
+      self.bearer_token = output_json["access_token"]
+      self.oauth_session_expires_at = Time.now.to_i + output_json["expires_in"].to_i
+      self.current_error = nil
+      self.status = 'Active'
+
+      return self.status
+    rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
+      self.bearer_token = nil
+      self.oauth_session_expires_at = nil
+      self.current_error = "Invalid login, please check client ID and Client Secret or URL endpoint"
+      self.status = 'Invalid Login'
+      return self.status
+    rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition  => ex
+      if errors.include?(ex.class)
+        raise ex
+      else
+        return [output_json, response]
+      end
+    rescue Net::ReadTimeout, Net::OpenTimeout, Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNREFUSED, SocketError => ex
+      if !(tries -= 1).zero?
+        Rails.logger.info {"#{ex.class} Timed out will retry after 5 seconds"}
+        sleep(self.timeout_sleep)
+        retry
+      else
+        self.current_error = "Invalid login, please check client ID and Client Secret or URL endpoint"
+        self.status = 'Timeout'
+        return self.status
+      end
+    end
+
+    def oauth_expired?
+      return (self.oauth_session_expires_at.blank? || self.bearer_token.blank?) ? true : (self.oauth_session_expires_at.to_i < Time.now.to_i)
+    end
+  end
+end

data/lib/zuora_api/version.rb

@@ -0,0 +1,3 @@
+module ZuoraAPI
+  VERSION = "1.6.06"
+end

data/zuora_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zuora_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zuora_api_D"
+  spec.version       = ZuoraAPI::VERSION
+  spec.authors       = ["Zuora Strategic Solutions Group"]
+  spec.email         = ["connect@zuora.com"]
+
+  spec.summary       = %q{Gem that provides easy integration to Zuora}
+  spec.description   = %q{Gem that provides easy integration to Zuora}
+  spec.homepage      = "https://connect.zuora.com"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency("webmock")
+  spec.add_development_dependency("simplecov")
+  spec.add_dependency("nokogiri")
+  spec.add_dependency("httparty")
+  spec.add_dependency("rubyzip")
+  spec.add_dependency("railties", ">= 4.1.0", "< 5.2")
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: zuora_api_D
+version: !ruby/object:Gem::Version
+  version: 1.6.06
+platform: ruby
+authors:
+- Zuora Strategic Solutions Group
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: httparty
+  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: rubyzip
+  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: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: Gem that provides easy integration to Zuora
+email:
+- connect@zuora.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/insights_api/login.rb
+- lib/zuora_api.rb
+- lib/zuora_api/exceptions.rb
+- lib/zuora_api/login.rb
+- lib/zuora_api/logins/basic.rb
+- lib/zuora_api/logins/oauth.rb
+- lib/zuora_api/version.rb
+- zuora_api.gemspec
+homepage: https://connect.zuora.com
+licenses: []
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Gem that provides easy integration to Zuora
+test_files: []