zuora_api_oauth_alpha 2

data/lib/zuora_api_oauth_alpha/logins/basic.rb

@@ -0,0 +1,139 @@
+module ZuoraAPI
+  class Basic < Login
+    attr_accessor :z_session_token
+
+    def initialize(**keyword_args)
+      super
+    end
+
+    def z_session_token=(val)
+      if !val.blank?
+        @z_session_token = val
+        self.current_session = @z_session_token
+        @stored_session_type = :basic
+      end
+    end
+
+    def authentication_prefix(auth_type = :basic)
+      return "ZSession "
+      raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Basic Login, does not support Authentication of Type: #{auth_type}")
+    end
+
+    def check_session(auth_type = :basic)
+      return @z_session_token.blank?
+    end
+
+    def new_session(auth_type = :basic)
+      raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Basic Login, does not support Authentication of Type: #{auth_type}") if auth_type != :basic
+      begin 
+        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
+            if (self.password.blank? && !@z_session_token.blank?)
+              Rails.logger.debug("Method [Session]")
+              xml['SOAP-ENV'].Header do
+                xml['api'].SessionHeader do
+                  xml['api'].session @z_session_token
+                end
+              end
+              xml['SOAP-ENV'].Body do
+                xml['api'].getUserInfo
+              end
+            else
+              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
+        end
+            
+        input_xml = Nokogiri::XML(request.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).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 => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip}"}# if debug
+        
+        @response_query = HTTParty.post(self.url,:body => request.to_xml, :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 => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip}"}# if debug
+
+        if !@response_query.success?
+          @z_session_token = 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.current_error = "Code = #{@response_query.code} Message = #{@response_query.body.to_s}"
+            self.status = 'No Service'
+          end
+        else
+          #If Session only is used for Gem TODO Depercate
+          if (self.password.blank? && @z_session_token.present?)
+            @z_session_token = @z_session_token
+            self.username        = @output_xml.xpath('//ns1:Username', 'ns1' =>'http://api.zuora.com/').text if self.username.blank?
+            
+          #Username & password combo
+          elsif (self.password.present? && self.username.present?)
+            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?
+            @z_session_token = retrieved_session
+          end
+          
+          self.current_error     = nil
+          self.status            = 'Active'
+          return @z_session_token
+        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
+    end
+  end
+end

data/lib/zuora_api_oauth_alpha/logins/oauth.rb

@@ -0,0 +1,171 @@
+module ZuoraAPI
+  class Oauth < Login
+    attr_accessor :z_session_token, :oauth_session_expires_at, :oauth_client_id, :oauth_secret, :bearer_token, :stored_session_type, :authentication_order_preference
+    
+    def initialize(oauth_client_id: nil, oauth_secret: nil, z_session_token: nil, bearer_token: nil, oauth_session_expires_at: nil,  **keyword_args)
+      @supported_authentication_types = [:basic, :bearer]
+      self.z_session_token = z_session_token if z_session_token.present?
+      self.bearer_token = bearer_token if z_session_token.present?
+      self.oauth_session_expires_at = oauth_session_expires_at if z_session_token.present?
+      @oauth_client_id = oauth_client_id
+      @oauth_secret = oauth_secret
+      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 z_session_token=(val)
+      if !val.blank?
+        @z_session_token = val
+        self.current_session = @z_session_token
+        @stored_session_type = :basic
+      end
+    end
+
+    def oauth_session_expires_at=(val)
+      @oauth_session_expires_at = val if !val.blank?
+    end
+
+    def bearer_token=(val)
+      if !val.blank?
+        @bearer_token = val
+        self.current_session = @bearer_token
+        @stored_session_type = :bearer
+      end
+    end
+
+    def authentication_prefix(auth_type)
+      if auth_type == :bearer
+        return "Bearer " 
+      elsif auth_type == :basic
+        return "ZSession "
+      else 
+        raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Oauth Login, does not support Authentication of Type: #{auth_type}") if !@supported_authentication_types.include?(auth_type)
+      end
+    end
+
+    def check_session(auth_type = :basic)
+      raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Oauth Login, does not support Authentication of Type: #{auth_type}") if !@supported_authentication_types.include?(auth_type)
+      return true if (auth_type != @stored_session_type || @stored_session_type.nil?)
+      return false
+    end
+
+    def new_session(auth_type = :basic)
+      if auth_type == :basic
+         return get_z_session()
+      elsif auth_type == :bearer
+        return get_bearer_token()
+      else 
+        raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Oauth Login, does not support Authentication of Type: #{auth_type}") if !@supported_authentication_types.include?(auth_type)
+      end
+    end
+
+    def get_z_session(debug = false)
+      begin
+        tries ||= 2
+        get_bearer_token()
+        if !@entity_id.nil?
+          response = HTTParty.get(self.rest_endpoint("connections"),  headers: {:Authorization => "Bearer " + @bearer_token , :entityId => @entity_id })
+        else 
+          response = HTTParty.get(self.rest_endpoint("connections"),  headers: {:Authorization => "Bearer " + @bearer_token}) 
+        end
+        if JSON.parse(response.body)["success"] ##.to_bool
+          @z_session_token = response.headers.to_h['set-cookie'][0].split(';')[0].split('=',2)[1]
+          @stored_session_type = :basic
+          self.current_error     = nil
+          self.status            = 'Active'
+        else 
+          self.current_error = JSON.parse(response.body)["reasons"][0]["message"]
+          self.status = "Invalid"
+        end
+
+        return @z_session_token
+      rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
+        if !(tries -= 1).zero? && z_session
+          Rails.logger.debug {"Session Invalid"}
+          self.new_session
+          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
+    end
+
+    def get_bearer_token
+      begin
+        tries ||= 2
+        if !oauth_expired?
+          self.current_error = nil
+          self.status = 'Active'
+        else
+          encoded_url = URI.encode(self.rest_endpoint.chomp('v1/').concat('oauth/token'))
+          url = URI.parse(encoded_url)
+          response = HTTParty.post(url,:headers => {:content_type => "application/x-www-form-urlencoded"}, :body => {:client_id=>@oauth_client_id, :client_secret=>@oauth_secret, :grant_type=>"client_credentials"})
+          if JSON.parse(response.body)["error"].nil?
+            @bearer_token = JSON.parse(response.body)["access_token"]
+            @oauth_session_expires_at = Time.now.to_i + JSON.parse(response.body)["expires_in"].to_i
+            @stored_session_type = :bearer
+            self.current_error = nil
+            self.status = 'Active'
+          else 
+            self.current_error = "Problem with the Credentials"
+            self.status = 'Invalid'
+          end
+        end
+
+        return @bearer_token
+      rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
+        if !(tries -= 1).zero? && z_session
+          Rails.logger.debug {"Session Invalid"}
+          self.new_session
+          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
+    end
+
+    def oauth_expired?
+      return @oauth_session_expires_at.nil? ? true : (@oauth_session_expires_at < Time.now.to_i)
+    end
+  end
+end

data/lib/zuora_api_oauth_alpha/version.rb

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

data/lib/zuora_api_oauth_alpha.rb

@@ -0,0 +1,10 @@
+require 'rails'
+require "zuora_api_oauth_alpha/login"
+require "zuora_api_oauth_alpha/logins/basic"
+require "zuora_api_oauth_alpha/logins/oauth"
+require 'zuora_api_oauth_alpha/exceptions'
+require "insights_api/login"
+
+module ZuoraAPI
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: zuora_api_oauth_alpha
+version: !ruby/object:Gem::Version
+  version: '2'
+platform: ruby
+authors:
+- Zuora Strategic Solutions Group
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-03 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: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+- !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.1'
+  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.1'
+description: Gem that provides easy integration to Zuora
+email:
+- connect@zuora.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/insights_api/login.rb
+- lib/zuora_api_oauth_alpha.rb
+- lib/zuora_api_oauth_alpha/exceptions.rb
+- lib/zuora_api_oauth_alpha/login.rb
+- lib/zuora_api_oauth_alpha/logins/basic.rb
+- lib/zuora_api_oauth_alpha/logins/oauth.rb
+- lib/zuora_api_oauth_alpha/version.rb
+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 | this is an unstable alpha release
+  and the connect team will not provide an commitment to the functionalilty until
+  a formal release of the gem
+test_files: []