zuora_api 1.6.15 → 1.6.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9c9111752188cb90238bb392e0aae06b418b8ed
-  data.tar.gz: 7ef09b01663e686f0ca345df80d811dbb6985f51
+  metadata.gz: cf22e129425646f0333a0fbfba46454caed076d8
+  data.tar.gz: 8bef1bdcdc8d148b6450846f8d8fc014f6964543
 SHA512:
-  metadata.gz: 98acc03915f4858ea36879443524d29787cbc3b3cf910fad20c512c3dbbdbc65c77de6e53e6bb131738af2e43f20d1411fb693f41bc4e586cf76ca1f801eca93
-  data.tar.gz: 1e750f3eb7156be665471ccac1a374f8fbc3b399388aa61670a590d837c2b6984202d37bc1bdfacc9527cdce58ec46b4d02acb56df80b1e36046ceac147b3078
+  metadata.gz: b7f61fe146b9593d91315f95e91dbc073229b80e71274630c76b5c30d099b12ed4b282c54cdac7106bb02141f490cfd2d2df8d881623af200be415435d77070f
+  data.tar.gz: 7a4e6c34d8c7019c1d1d474b7c946db1d85b075ea173bc4571fb29ae15d28113857002e5ec03f809b8c681e4dc8345f80840adede4f5ff899e931eddaac2b636

data/lib/zuora_api/login.rb

@@ -4,23 +4,200 @@ require "uri"
 
 module ZuoraAPI
   class Login
-    ENVIRONMENTS = [SANDBOX = 'Sandbox', PRODUCTION = 'Production', PREFORMANCE = 'Preformance', SERVICES = 'Services', UNKNOWN = 'Unknown' ]
+    ENVIRONMENTS = [SANDBOX = 'Sandbox', PRODUCTION = 'Production', PREFORMANCE = 'Preformance', SERVICES = 'Services', UNKNOWN = 'Unknown', STAGING = 'Staging' ]
     REGIONS = [EU = 'EU', US = 'US', NA = 'NA' ]
     MIN_Endpoint = '91.0'
     XML_SAVE_OPTIONS = Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION 
-    attr_accessor :region, :url, :wsdl_number, :current_session, :environment, :status, :errors, :current_error, :user_info, :tenant_id, :tenant_name, :entity_id, :timeout_sleep
+    attr_accessor :region, :url, :wsdl_number, :current_session, :environment, :status, :errors, :current_error, :user_info, :tenant_id, :tenant_name, :entity_id, :timeout_sleep, :hostname, :zconnect_provider
 
     def initialize(url: nil, entity_id: nil, session: nil, status: nil, **keyword_args)
+      raise "URL is nil or empty, but URL is required" if url.nil? | url.empty?
+      # raise "URL is improper. URL must contain zuora.com, zuora.eu, or zuora.na" if /zuora.com|zuora.eu|zuora.na/ === url
       @url = url.gsub(/(\d{2}\.\d)$/, MIN_Endpoint)
+      @hostname = /(?<=https:\/\/|http:\/\/)(.*?)(?=\/|$)/.match(url)[0] if !/(?<=https:\/\/|http:\/\/)(.*?)(?=\/|$)/.match(url).nil?
       @entity_id = get_entity_id(entity_id: entity_id)
       @errors = Hash.new
       @current_session = session
       @status = status.blank? ? "Active" : status
       @user_info = Hash.new
+      self.update_region
       self.update_environment
+      self.update_zconnect_provider
       @timeout_sleep = 5
     end
 
+    def get_identity(cookies)
+      zsession = cookies["ZSession"]
+      zconnect_accesstoken = get_zconnect_accesstoken(cookies)
+      begin
+        if false && !zsession.blank?
+          # Does not currently exist / function properly
+          # use the zsession API when/if it exists
+        elsif !zconnect_accesstoken.blank?
+          code = zconnect_accesstoken.split("#!").last
+          encrypted_token, tenant_id = Base64.decode64(code).split(":")
+          begin
+            body = {'token' => encrypted_token}.to_json
+          rescue => ex
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Invalid ZConnect Cookie", {}, 400)
+          end
+          response = HTTParty.post("https://#{self.hostname}/apps/zconnectsession/identity", :body => body, :headers => { 'Content-Type' => 'application/json' })
+          output_json = JSON.parse(response.body)
+        else
+          if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}", {}, 400)
+          else
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present", {}, 400)
+          end
+        end
+      rescue JSON::ParserError => ex
+        output_json = {}
+      end
+      raise_errors(type: :JSON, body: output_json, response: response)
+      return output_json
+    end
+
+    def get_full_nav(cookies)
+      zsession = cookies["ZSession"]
+      zconnect_accesstoken = get_zconnect_accesstoken(cookies)
+      begin
+        if !zsession.blank?
+          response = HTTParty.get("https://#{self.hostname}/apps/v1/navigation", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
+          output_json = JSON.parse(response.body)
+        elsif !zconnect_accesstoken.blank?
+          response = HTTParty.get("https://#{self.hostname}/apps/zconnectsession/navigation", :headers => {'Cookie' => "#{self.zconnect_provider}=#{zconnect_accesstoken}",'Content-Type' => 'application/json'})
+          output_json = JSON.parse(response.body)
+        else
+          if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}", {}, 400)
+          else
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present", {}, 400)
+          end
+        end
+      rescue JSON::ParserError => ex
+        output_json = {}
+      end
+      raise_errors(type: :JSON, body: output_json, response: response)
+      return output_json
+    end
+
+    def set_nav(state, cookies)
+      zsession = cookies["ZSession"]
+      zconnect_accesstoken = get_zconnect_accesstoken(cookies)
+      begin
+        if !zsession.blank?
+          response = HTTParty.put("https://#{self.hostname}/apps/v1/preference/navigation", :body => state.to_json, :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
+          output_json = JSON.parse(response.body)
+        elsif !zconnect_accesstoken.blank?
+          response = HTTParty.post("https://#{self.hostname}/apps/zconnectsession/navigationstate", :body => state.to_json, :headers => {'Cookie' => "#{self.zconnect_provider}=#{zconnect_accesstoken}", 'Content-Type' => 'application/json'})
+          output_json = JSON.parse(response.body)
+        else
+          if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}", {}, 400)
+          else
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present", {}, 400)
+          end
+        end
+      rescue JSON::ParserError => ex
+        output_json = {}
+      end
+      raise_errors(type: :JSON, body: output_json, response: response)
+      return output_json
+    end
+
+    def refresh_nav(cookies)
+      zsession = cookies["ZSession"]
+      zconnect_accesstoken = get_zconnect_accesstoken(cookies)
+      begin
+        if !zsession.blank?
+          response = HTTParty.post("https://#{self.hostname}/apps/v1/navigation/fetch", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
+          output_json = JSON.parse(response.body)
+        elsif !zconnect_accesstoken.blank?
+          response = HTTParty.post("https://#{self.hostname}/apps/zconnectsession/refresh-navbarcache", :headers => {'Cookie' => "#{self.zconnect_provider}=#{zconnect_accesstoken}", 'Content-Type' => 'application/json'})
+          output_json = JSON.parse(response.body)
+        else
+          if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}", {}, 400)
+          else
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present", {}, 400)
+          end
+        end
+      rescue JSON::ParserError => ex
+        output_json = {}
+      end
+      raise_errors(type: :JSON, body: output_json, response: response)
+      return output_json
+    end
+
+    def get_zconnect_accesstoken(cookies)
+      accesstoken = nil
+      self.update_zconnect_provider
+      if !cookies[self.zconnect_provider].nil? && !cookies[self.zconnect_provider].empty?
+        accesstoken = cookies[self.zconnect_provider]
+      end
+      return accesstoken
+    end
+
+    def reporting_url(path)
+      map = {"US" => {"Sandbox" => "https://zconnectsandbox.zuora.com/api/rest/v1/",
+                      "Production" => "https://zconnect.zuora.com/api/rest/v1/",
+                      "Services"=> ""},
+             "EU" => {"Sandbox" => "https://zconnect.sandbox.eu.zuora.com/api/rest/v1/",
+                      "Production" => "https://zconnect.eu.zuora.com/api/rest/v1/",
+                      "Services"=> ""},
+             "NA" => {"Sandbox" => "https://zconnect.sandbox.na.zuora.com/api/rest/v1/",
+                      "Production" => "https://zconnect.na.zuora.com/api/rest/v1/",
+                      "Services"=> ""}
+      }
+      return map[zuora_client.region][zuora_client.environment].insert(-1, path)
+    end
+
+    # There are two ways to call this method. The first way is best.
+    # 1. Pass in cookies and optionally custom_authorities, name, and description
+    # 2. Pass in user_id, entity_ids, client_id, client_secret, and optionally custom_authorities, name, and description
+    # https://intranet.zuora.com/confluence/display/Sunburst/Create+an+OAuth+Client+through+API+Gateway#CreateanOAuthClientthroughAPIGateway-ZSession
+    def get_oauth_client (custom_authorities = [], info_name: "No Name", info_desc: "This client was created without a description.", user_id: nil, entity_ids: nil, client_id: nil, client_secret: nil, new_client_id: nil, new_client_secret: nil, cookies: nil)
+      authorization = ""
+      new_client_id = SecureRandom.uuid if new_client_id.blank?
+      new_client_secret = SecureRandom.hex(10) if new_client_secret.blank?
+
+      if !cookies.nil?
+        authorization = cookies["ZSession"]
+        authorization = "ZSession-a3N2w #{authorization}"
+        if entity_ids.blank? && cookies["ZuoraCurrentEntity"].present?
+          entity_ids = Array(cookies["ZuoraCurrentEntity"].unpack("a8a4a4a4a12").join('-'))
+        else
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Zuora Entity ID not provided", {}, 400)
+        end
+        if user_id.blank? && cookies["Zuora-User-Id"].present?
+          user_id = cookies["Zuora-User-Id"]
+        else
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Zuora User ID not provided", {}, 400)
+        end
+      elsif !client_id.nil? && !client_secret.nil?
+        bearer_response = HTTParty.post("https://#{self.hostname}/oauth/token", :headers => {'Content-Type' => 'application/x-www-form-urlencoded', 'Accept' => 'application/json'}, :body => {'client_id' => client_id, 'client_secret' => URI::encode(client_secret), 'grant_type' => 'client_credentials'})
+        bearer_hash = JSON.parse(bearer_response.body)
+        bearer_token = bearer_hash["access_token"]
+        authorization = "Bearer #{bearer_token}"
+      end
+
+      if !authorization.blank? && !user_id.blank? && !entity_ids.blank?
+        endpoint = self.rest_endpoint("genesis/clients")
+        oauth_response = HTTParty.post(endpoint, :headers => {'authorization' => authorization, 'Content-Type' => 'application/json'}, :body => {'clientId' => new_client_id, 'clientSecret' => new_client_secret, 'userId' => user_id, 'entityIds' => entity_ids, 'customAuthorities' => custom_authorities, 'additionalInformation' => {'description' => info_desc, 'name' => info_name}}.to_json)
+        output_json = JSON.parse(oauth_response.body)
+        if oauth_response.code == 201
+          output_json["clientSecret"] = new_client_secret
+          return output_json
+        elsif oauth_response.code == 401 && !oauth_response.message.blank?
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(output_json["message"], {}, oauth_response.code)
+        else
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(output_json["error"], {}, oauth_response.code)
+        end
+      else
+        raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Insufficient credentials provided", {}, 400)
+      end
+    end
+
     def self.environments
       %w(Sandbox Production Services Performance Staging)
     end
@@ -58,45 +235,105 @@ module ZuoraAPI
       return entity_id
     end
 
+    def update_region
+      if !self.hostname.blank?
+        if /(?<=\.|\/|^)(eu)(?=\.|\/|$)/ === self.hostname
+          self.region = "EU"
+        elsif /(?<=\.|\/|^)(na)(?=\.|\/|$)/ === self.hostname
+          self.region = "NA"
+        else
+          self.region = "US"
+        end
+      else # This will never happen
+        # raise "Can't update region because URL is blank"
+        self.region = "Unknown"
+      end
+    end
+
     def update_environment
       if !self.url.blank?
-        env_path = self.url.split('https://').last.split('.zuora.com').first
-        self.region = self.url.include?("eu.") ? "EU" : self.url.include?("na.") ? "NA" : "US"
-        if  env_path == 'apisandbox' || self.url.include?('sandbox')
+        if /(?<=\.|\/|-|^)(apisandbox|sandbox)(?=\.|\/|-|$)/ === self.hostname
           self.environment = 'Sandbox'
-        elsif env_path == 'www' || env_path == 'api' || self.url.include?('tls10.zuora.com') || self.url.include?('origin-www.zuora.com') || self.url.include?('zforsf.zuora.com') || self.url.include?('https://zuora.com') || self.url.include?('eu.zuora.com') || self.url.include?('https://na.zuora.com')
-          self.environment = 'Production'
-        elsif env_path.include?('service') || env_path.include?('ep-edge')
+        elsif /(?<=\.|\/|^)(service|services[\d]*|ep-edge)(?=\.|\/|$)/ === self.hostname
           self.environment = 'Services'
-        elsif env_path.include?('pt')
+        elsif /(?<=\.|\/|-|^)(pt[\d]*)(?=\.|\/|-|$)/ === self.hostname
           self.environment = 'Performance'
-        elsif env_path.include?('staging2') || env_path.include?('staging1')
-          self.region = 'US'
+        elsif /(?<=\.|\/|^)(staging1|staging2|stg)(?=\.|\/|$)/ === self.hostname
           self.environment = 'Staging'
+        elsif is_prod_env
+          self.environment = 'Production'
         else
           self.environment = 'Unknown'
         end
+      else # this will never happen
+        raise "Can't determine environment from blank URL"
+      end
+    end
+
+    def is_prod_env
+      is_prod = false
+      www_or_api = /(?<=\.|\/|^)(www|api)(?=\.|\/|$)/ === self.hostname
+      host_prefix_match = /(^|tls10\.|origin-www\.|zforsf\.|eu\.|na\.)(zuora\.com)/ === self.hostname
+      if www_or_api || host_prefix_match
+        is_prod = true
       end
+      return is_prod
+    end
+
+    def update_zconnect_provider
+      region = update_region
+      environment = update_environment
+      mappings = {"US" => {"Sandbox" => "ZConnectSbx", "KubeSTG" => "ZConnectDev", "KubeDEV" => "ZConnectDev", "KubePROD" => "ZConnectDev", "Services" => "ZConnectQA", "Production" => "ZConnectProd", "Performance" => "ZConnectPT1", "Staging" => "ZConnectQA"},
+                  "NA" => {"Sandbox" => "ZConnectSbxNA", "Services" => "ZConnectQANA", "Production" => "ZConnectProdNA", "Performance" => "ZConnectPT1NA"},
+                  "EU" => {"Sandbox" => "ZConnectSbxEU", "Services" => "ZConnectQAEU", "Production" => "ZConnectProdEU", "Performance" => "ZConnectPT1EU"},
+                  "Unknown" => {"Unknown" => "Unknown"}}
+      self.zconnect_provider = mappings[region][environment]
+      # raise "Can't find ZConnect Provider for #{region} region and #{environment} environment" if self.zconnect_provider.nil?
     end
 
     def aqua_endpoint(url="")
-      return  "#{self.url.split("/apps").first}/apps/api/".concat(url)
+      match = /.*(\/apps\/)/.match(self.url)
+      if !match.nil?
+        url_slash_apps_slash = match[0]
+      else
+        raise "self.url has no /apps in it"
+      end
+      return "#{url_slash_apps_slash}api/#{url}"
     end
 
     def rest_endpoint(url="")
-      if self.environment == 'Sandbox'
-        return self.region == "US" ? "https://rest.apisandbox.zuora.com/v1/".concat(url) : self.region == "EU" ? "https://rest.sandbox.eu.zuora.com/v1/".concat(url) : "https://rest.sandbox.na.zuora.com/v1/".concat(url)
-      elsif  self.environment == 'Production'
-        return  self.region == "US" ? "https://rest.zuora.com/v1/".concat(url) : self.region == "EU" ? "https://rest.eu.zuora.com/v1/".concat(url) : "https://rest.na.zuora.com/v1/".concat(url)
-      elsif self.environment == 'Services'
-        return  self.url.split('/')[0..2].join('/').concat('/apps/v1/').concat(url)
-      elsif self.environment == 'Performance'
-        return  self.url.split('/')[0..2].join('/').concat('/apps/v1/').concat(url)
-      elsif self.environment == 'Staging'
-        return  "https://rest-staging2.zuora.com/v1/".concat(url)
-      else self.environment == 'Unknown'
-        return url
+      update_environment
+      endpoint = url
+
+      case self.environment
+      when 'Sandbox'
+        case self.region
+        when 'US'
+          endpoint = "https://rest.apisandbox.zuora.com/v1/".concat(url)
+        when 'EU'
+          endpoint = "https://rest.sandbox.eu.zuora.com/v1/".concat(url)
+        when 'NA'
+          endpoint = "https://rest.sandbox.na.zuora.com/v1/".concat(url)
+        end
+      when 'Production'
+        case self.region
+        when 'US'
+          endpoint = "https://rest.zuora.com/v1/".concat(url)
+        when 'EU'
+          endpoint = "https://rest.eu.zuora.com/v1/".concat(url)
+        when 'NA'
+          endpoint = "https://rest.na.zuora.com/v1/".concat(url)
+        end
+      when 'Services', 'Performance'
+        https = /https:\/\/|http:\/\//.match(self.url)[0]
+        host = self.hostname
+        endpoint = "#{https}#{host}/apps/v1/#{url}"
+      when 'Staging'
+        endpoint = "https://rest-staging2.zuora.com/".concat(url)
+      when 'Unknown'
+        raise "Environment unknown, returning passed in parameter unaltered"
       end
+      return endpoint
     end
 
     def fileURL(url="")
@@ -282,6 +519,10 @@ module ZuoraAPI
             raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new()
           end
 
+          if body['errorMessage']
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body['errorMessage'],body,response.code)
+          end
+
           if body.dig("reasons").nil? ? false : body.dig("reasons")[0].dig("code") == 90000020
             raise ZuoraAPI::Exceptions::BadEntityError.new("#{messages_array.join(', ')}", body, response.code)
           end

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.6.15"
+  VERSION = "1.6.16"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.6.15
+  version: 1.6.16
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-04 00:00:00.000000000 Z
+date: 2018-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler