Class: ZuoraAPI::Login
- Inherits:
-
Object
- Object
- ZuoraAPI::Login
- Defined in:
- lib/zuora_api/login.rb
Constant Summary collapse
- 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
- CONNECTION_EXCEPTIONS =
[Net::OpenTimeout, OpenSSL::SSL::SSLError, Errno::ECONNREFUSED, SocketError]
- CONNECTION_READ_EXCEPTIONS =
[Net::ReadTimeout, Errno::ECONNRESET, Errno::EPIPE]
Instance Attribute Summary collapse
-
#current_error ⇒ Object
Returns the value of attribute current_error.
-
#current_session ⇒ Object
Returns the value of attribute current_session.
-
#entity_id ⇒ Object
Returns the value of attribute entity_id.
-
#environment ⇒ Object
Returns the value of attribute environment.
-
#errors ⇒ Object
Returns the value of attribute errors.
-
#hostname ⇒ Object
Returns the value of attribute hostname.
-
#region ⇒ Object
Returns the value of attribute region.
-
#status ⇒ Object
Returns the value of attribute status.
-
#tenant_id ⇒ Object
Returns the value of attribute tenant_id.
-
#tenant_name ⇒ Object
Returns the value of attribute tenant_name.
-
#timeout_sleep ⇒ Object
Returns the value of attribute timeout_sleep.
-
#url ⇒ Object
Returns the value of attribute url.
-
#user_info ⇒ Object
Returns the value of attribute user_info.
-
#wsdl_number ⇒ Object
Returns the value of attribute wsdl_number.
-
#zconnect_provider ⇒ Object
Returns the value of attribute zconnect_provider.
Class Method Summary collapse
Instance Method Summary collapse
- #aqua_endpoint(url = "") ⇒ Object
- #aqua_query(queryName: '', query: '', version: '1.2', jobName: 'Aqua', partner: '', project: '') ⇒ Object
- #checkJRStatus(jrNumber) ⇒ Object
- #createJournalRun(call) ⇒ Object
- #dateFormat ⇒ Object
- #describe_call(object = nil) ⇒ Object
- #fileURL(url = "") ⇒ Object
- #get_catalog(page_size: 40) ⇒ Object
- #get_entity_id(entity_id: nil) ⇒ Object
- #get_file(url: nil, headers: {}, count: 3, z_session: true, tempfile: true, output_file_name: nil, add_timestamp: true, file_path: defined?(Rails.root.join('tmp')) ? Rails.root.join('tmp') : Pathname.new(Dir.pwd), timeout_retries: 2, timeout: 120, session_type: :basic, **execute_params) ⇒ Object
- #get_full_nav(cookies) ⇒ Object
- #get_identity(cookies) ⇒ Object
-
#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) ⇒ Object
There are two ways to call this method.
- #get_session(prefix: false, auth_type: :basic) ⇒ Object
- #get_zconnect_accesstoken(cookies) ⇒ Object
- #getDataSourceExport(query, extract: true, encrypted: false, zip: true) ⇒ Object
- #getFileById(id: "2c92c0f85e7f88ff015e86b8f8f4517f") ⇒ Object
-
#initialize(url: nil, entity_id: nil, session: nil, status: nil, **keyword_args) ⇒ Login
constructor
A new instance of Login.
- #is_prod_env ⇒ Object
- #new_session(auth_type: :basic, debug: false) ⇒ Object
- #query(query, parse = false) ⇒ Object
- #raise_errors(type: :SOAP, body: nil, response: nil) ⇒ Object
- #refresh_nav(cookies) ⇒ Object
- #reporting_url(path) ⇒ Object
- #rest_call(method: :get, body: nil, headers: {}, url: rest_endpoint("catalog/products?pageSize=4"), debug: false, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError, ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition], z_session: true, session_type: :basic, timeout_retry: false, timeout: 120, **keyword_args) ⇒ Object
- #rest_endpoint(url = "") ⇒ Object
- #set_nav(state, cookies) ⇒ Object
- #soap_call(ns1: 'ns1', ns2: 'ns2', batch_size: nil, single_transaction: false, debug: false, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError, ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition], z_session: true, timeout_retry: false, timeout: 120, **keyword_args) ⇒ Object
- #update_create_tenant ⇒ Object
- #update_environment ⇒ Object
- #update_region ⇒ Object
- #update_zconnect_provider ⇒ Object
Constructor Details
#initialize(url: nil, entity_id: nil, session: nil, status: nil, **keyword_args) ⇒ Login
Returns a new instance of Login.
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
# File 'lib/zuora_api/login.rb', line 16 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 |
Instance Attribute Details
#current_error ⇒ Object
Returns the value of attribute current_error.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def current_error @current_error end |
#current_session ⇒ Object
Returns the value of attribute current_session.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def current_session @current_session end |
#entity_id ⇒ Object
Returns the value of attribute entity_id.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def entity_id @entity_id end |
#environment ⇒ Object
Returns the value of attribute environment.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def environment @environment end |
#errors ⇒ Object
Returns the value of attribute errors.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def errors @errors end |
#hostname ⇒ Object
Returns the value of attribute hostname.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def hostname @hostname end |
#region ⇒ Object
Returns the value of attribute region.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def region @region end |
#status ⇒ Object
Returns the value of attribute status.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def status @status end |
#tenant_id ⇒ Object
Returns the value of attribute tenant_id.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def tenant_id @tenant_id end |
#tenant_name ⇒ Object
Returns the value of attribute tenant_name.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def tenant_name @tenant_name end |
#timeout_sleep ⇒ Object
Returns the value of attribute timeout_sleep.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def timeout_sleep @timeout_sleep end |
#url ⇒ Object
Returns the value of attribute url.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def url @url end |
#user_info ⇒ Object
Returns the value of attribute user_info.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def user_info @user_info end |
#wsdl_number ⇒ Object
Returns the value of attribute wsdl_number.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def wsdl_number @wsdl_number end |
#zconnect_provider ⇒ Object
Returns the value of attribute zconnect_provider.
14 15 16 |
# File 'lib/zuora_api/login.rb', line 14 def zconnect_provider @zconnect_provider end |
Class Method Details
.endpoints ⇒ Object
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/zuora_api/login.rb', line 212 def self.endpoints return {"US" => {"Sandbox" => "https://apisandbox.zuora.com/apps/services/a/", "Production" => "https://www.zuora.com/apps/services/a/", "Performance" => "https://pt1.zuora.com/apps/services/a/", "Services" => "https://services347.zuora.com/apps/services/a/", "Staging" => "https://staging2.zuora.com/apps/services/a/"}, "EU" => {"Sandbox" => "https://sandbox.eu.zuora.com/apps/services/a/", "Production" => "https://eu.zuora.com/apps/services/a/", "Performance" => "https://pt1.eu.zuora.com/apps/services/a/", "Services" => "https://services347.eu.zuora.com/apps/services/a/"}, "NA" => {"Sandbox" => "https://sandbox.na.zuora.com/apps/services/a/", "Production" => "https://na.zuora.com/apps/services/a/", "Performance" => "https://pt1.na.zuora.com/apps/services/a/", "Services" => "https://services347.na.zuora.com/apps/services/a/"} } end |
.environments ⇒ Object
204 205 206 |
# File 'lib/zuora_api/login.rb', line 204 def self.environments %w(Sandbox Production Services Performance Staging) end |
.regions ⇒ Object
208 209 210 |
# File 'lib/zuora_api/login.rb', line 208 def self.regions %w(US EU NA) end |
Instance Method Details
#aqua_endpoint(url = "") ⇒ Object
297 298 299 300 301 302 303 304 305 |
# File 'lib/zuora_api/login.rb', line 297 def aqua_endpoint(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 |
#aqua_query(queryName: '', query: '', version: '1.2', jobName: 'Aqua', partner: '', project: '') ⇒ Object
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 |
# File 'lib/zuora_api/login.rb', line 631 def aqua_query(queryName: '', query: '', version: '1.2', jobName: 'Aqua',partner: '', project: '') params = { "format" => 'csv', "version" => version, "name" => jobName, "encrypted" => 'none', "useQueryLabels" => 'true', "partner" => partner, "project" => project, "queries" => [{ "name" => queryName, "query" => query, "type" => 'zoqlexport' }] } response = self.rest_call(method: :post, body: params.to_json, url: self.aqua_endpoint("batch-query/")) if(response[0]["id"].nil?) raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Error in AQuA Process. #{response}") end return getFileById(id: response[0]["id"]) end |
#checkJRStatus(jrNumber) ⇒ Object
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 |
# File 'lib/zuora_api/login.rb', line 1102 def checkJRStatus(jrNumber) Rails.logger.info("Check for completion") url = rest_endpoint("/journal-runs/#{jrNumber}") uri = URI(url) req = Net::HTTP::Get.new(uri,initheader = {'Content-Type' =>'application/json'}) req["Authorization"] = self.get_session(prefix: true) response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http| http.request req end result = JSON.parse(response.body) if result["success"] if !(result["status"].eql? "Completed") sleep(20.seconds) end return result["status"] else = result["reasons"][0]["message"] Rails.logger.info("Checking status of journal run failed with message #{}") end return "failure" end |
#createJournalRun(call) ⇒ Object
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 |
# File 'lib/zuora_api/login.rb', line 1077 def createJournalRun(call) url = rest_endpoint("/journal-runs") uri = URI(url) req = Net::HTTP::Post.new(uri,initheader = {'Content-Type' =>'application/json'}) req["Authorization"] = self.get_session(prefix: true) req.body = call response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http| http.request req end Rails.logger.debug("Response #{response.code} #{response.}: #{response.body}") result = JSON.parse(response.body) if result["success"] jrNumber = result["journalRunNumber"] return jrNumber else = result["reasons"][0]["message"] Rails.logger.error("Journal Run failed with message #{}") return result end end |
#dateFormat ⇒ Object
348 349 350 |
# File 'lib/zuora_api/login.rb', line 348 def dateFormat return self.wsdl_number > 68 ? '%Y-%m-%d' : '%Y-%m-%dT%H:%M:%S' end |
#describe_call(object = nil) ⇒ Object
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 |
# File 'lib/zuora_api/login.rb', line 669 def describe_call(object = nil) tries ||= 2 base = self.url.include?(".com") ? self.url.split(".com")[0].concat(".com") : self.url.split(".eu")[0].concat(".eu") url = object ? "#{base}/apps/api/describe/#{object}" : "#{base}/apps/api/describe/" headers = self.entity_id.present? ? {"Zuora-Entity-Ids" => self.entity_id, 'Content-Type' => "text/xml; charset=utf-8"} : {'Content-Type' => "text/xml; charset=utf-8"} response = HTTParty.get(url, headers: {"Authorization" => self.get_session(prefix: true, auth_type: :basic)}.merge(headers), :timeout => 120) raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error.present? ? self.current_error : 'Describe call 401' ) if response.code == 401 output_xml = Nokogiri::XML(response.body) des_hash = Hash.new if object == nil output_xml.xpath("//object").each do |object| temp = {:label => object.xpath(".//label").text, :url => object.attributes["href"].value } des_hash[object.xpath(".//name").text] = temp end else output_xml.xpath("//field").each do |object| temp = {:label => object.xpath(".//label").text,:selectable => object.xpath(".//selectable").text, :createable => object.xpath(".//label").text == "ID" ? "false" : object.xpath(".//createable").text, :filterable => object.xpath(".//filterable").text, :updateable => object.xpath(".//label").text == "ID" ? "false" : object.xpath(".//updateable").text, :custom => object.xpath(".//custom").text,:maxlength => object.xpath(".//maxlength").text, :required => object.xpath(".//required").text, :type => object.xpath(".//type").text, :context => object.xpath(".//context").collect{ |x| x.text } } temp[:options] = object.xpath(".//option").collect{ |x| x.text } if object.xpath(".//option").size > 0 des_hash[object.xpath(".//name").text.to_sym] = temp des_hash[:fieldsToNull] = {:label => "FieldsToNull",:selectable => "false", :createable => "false",:filterable => "false", :updateable => "true",:custom => "false", :required => "false",:type => "picklist", :maxlength => "" ,:context => ["soap"], :options => des_hash.map {|k,v| k if v[:updateable] == "true" && v[:required] == "false"}.compact.uniq } end des_hash[:related_objects] = output_xml.xpath(".//related-objects").xpath(".//object").map{ |x| [x.xpath(".//name").text.to_sym, [ [:url, x.attributes["href"].value], [:label, x.xpath(".//name").text ] ].to_h] }.to_h end rescue *(CONNECTION_EXCEPTIONS).concat(CONNECTION_READ_EXCEPTIONS) => ex if !(tries -= 1).zero? Rails.logger.info("Describe - #{ex.class} Timed out will retry after 5 seconds") sleep(self.timeout_sleep) retry else raise ex end rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex if !(tries -= 1).zero? Rails.logger.info("Session expired. Starting new session.") self.new_session retry else raise ex end rescue => ex raise ex else return des_hash end |
#fileURL(url = "") ⇒ Object
344 345 346 |
# File 'lib/zuora_api/login.rb', line 344 def fileURL(url="") return self.url.split(".com").first.concat(".com/apps/api/file/").concat(url) end |
#get_catalog(page_size: 40) ⇒ Object
816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 |
# File 'lib/zuora_api/login.rb', line 816 def get_catalog(page_size: 40) products, catalog_map, response = [{}, {}, {'nextPage' => self.rest_endpoint("catalog/products?pageSize=#{page_size}") }] while !response["nextPage"].blank? url = self.rest_endpoint(response["nextPage"].split('/v1/').last) Rails.logger.debug("Fetch Catalog URL #{url}") output_json, response = self.rest_call(:debug => false, :url => url, :errors => [ZuoraAPI::Exceptions::ZuoraAPISessionError], :timeout_retry => true ) if !output_json['success'] =~ (/(true|t|yes|y|1)$/i) || output_json['success'].class != TrueClass raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Error Getting Catalog: #{output_json}") end output_json["products"].each do |product| catalog_map[product["id"]] = {"productId" => product["id"]} rateplans = {} product["productRatePlans"].each do |rateplan| catalog_map[rateplan["id"]] = {"productId" => product["id"], "productRatePlanId" => rateplan["id"]} charges = {} rateplan["productRatePlanCharges"].each do |charge| catalog_map[charge["id"]] = {"productId" => product["id"], "productRatePlanId" => rateplan["id"], "productRatePlanChargeId" => charge["id"]} charges[charge["id"]] = charge.merge({"productId" => product["id"], "productName" => product["name"], "productRatePlanId" => rateplan["id"], "productRatePlanName" => rateplan["name"] }) end rateplan["productRatePlanCharges"] = charges rateplans[rateplan["id"]] = rateplan.merge({"productId" => product["id"], "productName" => product["name"]}) end product["productRatePlans"] = rateplans products[product['id']] = product end end return products, catalog_map end |
#get_entity_id(entity_id: nil) ⇒ Object
229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/zuora_api/login.rb', line 229 def get_entity_id(entity_id: nil) if entity_id.present? entity_match = /[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$/.match(entity_id) if entity_match.blank? raise "Entity length is wrong." if entity_id.length != 32 part_one, part_two, part_three, part_four, part_five = [entity_id[0..7], entity_id[8..11], entity_id[12..15], entity_id[16..19], entity_id[20..31]] entity_id = "#{part_one}-#{part_two}-#{part_three}-#{part_four}-#{part_five}" end end return entity_id end |
#get_file(url: nil, headers: {}, count: 3, z_session: true, tempfile: true, output_file_name: nil, add_timestamp: true, file_path: defined?(Rails.root.join('tmp')) ? Rails.root.join('tmp') : Pathname.new(Dir.pwd), timeout_retries: 2, timeout: 120, session_type: :basic, **execute_params) ⇒ Object
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 |
# File 'lib/zuora_api/login.rb', line 848 def get_file(url: nil, headers: {}, count: 3, z_session: true, tempfile: true, output_file_name: nil, add_timestamp: true, file_path: defined?(Rails.root.join('tmp')) ? Rails.root.join('tmp') : Pathname.new(Dir.pwd), timeout_retries: 2, timeout: 120, session_type: :basic, **execute_params) raise "file_path must be of class Pathname" if file_path.class != Pathname #Make sure directory exists require 'fileutils' FileUtils.mkdir_p(file_path) unless File.exists?(file_path) begin status_code = nil uri = URI.parse(url) http = Net::HTTP.new(uri.host, uri.port) http.read_timeout = timeout #Seconds http.use_ssl = true if uri.scheme.downcase == 'https' if z_session headers = headers.merge({"Authorization" => self.get_session(prefix: true)}) headers = headers.merge({"Zuora-Entity-Ids" => self.entity_id}) if !self.entity_id.blank? end response_save = nil begin http.request_get(uri.request_uri, headers) do |response| response_save = response status_code = response.code if response case response when Net::HTTPNotFound Rails.logger.fatal("404 - Not Found") raise when Net::HTTPUnauthorized if count <= 0 if z_session raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error) else raise end end Rails.logger.fatal("Unauthorized: Retry") self.new_session if z_session return get_file(:url => url, :headers => headers, :count => count - 1, :z_session => z_session, :tempfile => tempfile, :file_path => file_path, :timeout_retries => timeout_retries, :timeout => timeout) when Net::HTTPClientError raise when Net::HTTPOK headers = {} response.each_header do |k,v| headers[k] = v end Rails.logger.debug("Headers: #{headers.to_s}") if output_file_name.present? file_ending ||= output_file_name.end_with?(".csv.zip") ? ".csv.zip" : File.extname(output_file_name) filename ||= File.basename(output_file_name, file_ending) end size, export_progress = [0, 0] encoding, type, full_filename = [nil, nil, nil] if response.header["Content-Disposition"].present? case response.header["Content-Disposition"] when /.*; filename\*=.*/ full_filename ||= /.*; filename\*=(.*)''(.*)/.match(response.header["Content-Disposition"])[2].strip encoding = /.*; filename\*=(.*)''(.*)/.match(response.header["Content-Disposition"])[1].strip when /.*; filename=/ full_filename ||= /.*; filename=(.*)/.match(response.header["Content-Disposition"])[1].strip else raise "Can't parse Content-Disposition header: #{response.header["Content-Disposition"]}" end file_ending ||= full_filename.end_with?(".csv.zip") ? ".csv.zip" : File.extname(full_filename) filename ||= File.basename(full_filename, file_ending) end #If user supplied a filename use it, else default to content header filename, else default to uri pattern file_ending ||= uri.path.end_with?(".csv.zip") ? ".csv.zip" : File.extname(uri.path) filename ||= File.basename(uri.path, file_ending) if response.header["Content-Type"].present? case response.header["Content-Type"] when /.*;charset=.*/ type = /(.*);charset=(.*)/.match(response.header["Content-Type"])[1] encoding = /(.*);charset=(.*)/.match(response.header["Content-Type"])[2] else type = response.header["Content-Type"] encoding ||= 'UTF-8' end end Rails.logger.info("File: #{filename}#{file_ending} #{encoding} #{type}") if response.header["Content-Length"].present? export_size = response.header["Content-Length"].to_i elsif response.header["ContentLength"].present? export_size = response.header["ContentLength"].to_i end file_prefix = ? "#{filename}_#{Time.now.to_i}" : filename if tempfile require 'tempfile' file_handle = ::Tempfile.new([file_prefix, "#{file_ending}"], file_path) else file_handle = File.new(file_path.join("#{file_prefix}#{file_ending}"), "w+") end file_handle.binmode response.read_body do |chunk| file_handle << chunk.force_encoding(encoding) if defined?(export_size) && export_size != 0 && export_size.class == Integer size += chunk.size new_progress = (size * 100) / export_size unless new_progress == export_progress Rails.logger.debug("Login: Export Downloading %s (%3d%%)" % [filename, new_progress]) end export_progress = new_progress end end file_handle.close Rails.logger.debug("Filepath: #{file_handle.path} Size: #{File.size(file_handle.path).to_f/1000000} mb") return file_handle end end rescue *(CONNECTION_EXCEPTIONS).concat(CONNECTION_READ_EXCEPTIONS) => e sleep(5) if (timeout_retries -= 1) >= 0 Rails.logger.warn("Download Failed: #{e.class} : #{e.}") retry else raise end end rescue Exception => e Rails.logger.fatal("Download Failed: #{response_save} - #{e.class} : #{e.}") Rails.logger.fatal("Download Failed: #{e.backtrace.join("\n")}") raise end end |
#get_full_nav(cookies) ⇒ Object
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/zuora_api/login.rb', line 63 def get_full_nav() zsession = ["ZSession"] zconnect_accesstoken = get_zconnect_accesstoken() 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? && .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 |
#get_identity(cookies) ⇒ Object
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/zuora_api/login.rb', line 32 def get_identity() zsession = ["ZSession"] zconnect_accesstoken = get_zconnect_accesstoken() begin if !zsession.blank? response = HTTParty.get("https://#{self.hostname}/apps/v1/identity", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'}) output_json = JSON.parse(response.body) 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? && .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 |
#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) ⇒ Object
There are two ways to call this method. The first way is best.
-
Pass in cookies and optionally custom_authorities, name, and description
-
Pass in user_id, entity_ids, client_id, client_secret, and optionally custom_authorities, name, and description
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/zuora_api/login.rb', line 162 def get_oauth_client ( = [], 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) = "" new_client_id = SecureRandom.uuid if new_client_id.blank? new_client_secret = SecureRandom.hex(10) if new_client_secret.blank? if !.nil? = ["ZSession"] = "ZSession-a3N2w #{}" if entity_ids.blank? && ["ZuoraCurrentEntity"].present? entity_ids = Array(["ZuoraCurrentEntity"].unpack("a8a4a4a4a12").join('-')) else raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Zuora Entity ID not provided", {}, 400) end if user_id.blank? && ["Zuora-User-Id"].present? user_id = ["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"] = "Bearer #{bearer_token}" end if !.blank? && !user_id.blank? && !entity_ids.blank? endpoint = self.rest_endpoint("genesis/clients") oauth_response = HTTParty.post(endpoint, :headers => {'authorization' => , 'Content-Type' => 'application/json'}, :body => {'clientId' => new_client_id, 'clientSecret' => new_client_secret, 'userId' => user_id, 'entityIds' => entity_ids, 'customAuthorities' => , '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..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 |
#get_session(prefix: false, auth_type: :basic) ⇒ Object
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 |
# File 'lib/zuora_api/login.rb', line 355 def get_session(prefix: false, auth_type: :basic) Rails.logger.debug("Get session for #{auth_type} - #{self.class.to_s}") case auth_type when :basic if self.current_session.blank? Rails.logger.debug("Create new session") case self.class.to_s when 'ZuoraAPI::Oauth' if self.bearer_token.blank? || self.oauth_expired? self.new_session(auth_type: :bearer) end self.get_z_session when 'ZuoraAPI::Basic' self.new_session(auth_type: :basic) else raise "No Zuora Login Specified" end end raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error) if self.status != 'Active' return prefix ? "ZSession #{self.current_session}" : self.current_session.to_s when :bearer case self.class.to_s when 'ZuoraAPI::Oauth' if self.bearer_token.blank? || self.oauth_expired? self.new_session(auth_type: :bearer) end when 'ZuoraAPI::Basic' raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Basic Login, does not support Authentication of Type: #{auth_type}") end raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error) if self.status != 'Active' return prefix ? "Bearer #{self.bearer_token}" : self.bearer_token.to_s end end |
#get_zconnect_accesstoken(cookies) ⇒ Object
135 136 137 138 139 140 141 142 |
# File 'lib/zuora_api/login.rb', line 135 def get_zconnect_accesstoken() accesstoken = nil self.update_zconnect_provider if ![self.zconnect_provider].nil? && ![self.zconnect_provider].empty? accesstoken = [self.zconnect_provider] end return accesstoken end |
#getDataSourceExport(query, extract: true, encrypted: false, zip: true) ⇒ Object
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 |
# File 'lib/zuora_api/login.rb', line 986 def getDataSourceExport(query, extract: true, encrypted: false, zip: true) Rails.logger.debug("Build export") Rails.logger.debug("#{query}") request = Nokogiri::XML::Builder.new do |xml| xml['SOAP-ENV'].Envelope('xmlns:SOAP-ENV' => "http://schemas.xmlsoap.org/soap/envelope/", 'xmlns:ns2' => "http://object.api.zuora.com/", 'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance", 'xmlns:ns1' => "http://api.zuora.com/") do xml['SOAP-ENV'].Header do xml['ns1'].SessionHeader do xml['ns1'].session self.get_session(prefix: false, auth_type: :basic) end end xml['SOAP-ENV'].Body do xml['ns1'].create do xml['ns1'].zObjects('xsi:type' => "ns2:Export") do xml['ns2'].Format 'csv' xml['ns2'].Zip zip xml['ns2'].Name 'googman' xml['ns2'].Query query xml['ns2'].Encrypted encrypted end end end end end response_query = HTTParty.post(self.url, body: request.to_xml(:save_with => XML_SAVE_OPTIONS).strip, headers: {'Content-Type' => "application/json; charset=utf-8"}, :timeout => 120) output_xml = Nokogiri::XML(response_query.body) raise 'Export Creation Unsuccessful : ' + output_xml.xpath('//ns1:Message', 'ns1' =>'http://api.zuora.com/').text if output_xml.xpath('//ns1:Success', 'ns1' =>'http://api.zuora.com/').text != "true" id = output_xml.xpath('//ns1:Id', 'ns1' =>'http://api.zuora.com/').text confirmRequest = Nokogiri::XML::Builder.new do |xml| xml['SOAP-ENV'].Envelope('xmlns:SOAP-ENV' => "http://schemas.xmlsoap.org/soap/envelope/", 'xmlns:ns2' => "http://object.api.zuora.com/", 'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance", 'xmlns:ns1' => "http://api.zuora.com/") do xml['SOAP-ENV'].Header do xml['ns1'].SessionHeader do xml['ns1'].session self.get_session(prefix: false, auth_type: :basic) end end xml['SOAP-ENV'].Body do xml['ns1'].query do xml['ns1'].queryString "SELECT Id, CreatedById, CreatedDate, Encrypted, FileId, Format, Name, Query, Size, Status, StatusReason, UpdatedById, UpdatedDate, Zip From Export where Id = '#{id}'" end end end end result = 'Waiting' while result != "Completed" sleep 3 response_query = HTTParty.post(self.url, body: confirmRequest.to_xml(:save_with => XML_SAVE_OPTIONS).strip, headers: {'Content-Type' => "application/json; charset=utf-8"}, :timeout => 120) output_xml = Nokogiri::XML(response_query.body) result = output_xml.xpath('//ns2:Status', 'ns2' =>'http://object.api.zuora.com/').text status_code = response_query.code if response_query raise "Export Creation Unsuccessful : #{output_xml.xpath('//ns1:Message', 'ns1' =>'http://api.zuora.com/').text}" if result.blank? || result == "Failed" end file_id = output_xml.xpath('//ns2:FileId', 'ns2' =>'http://object.api.zuora.com/').text Rails.logger.debug('=====> Export finished') export_file = get_file(:url => self.fileURL(file_id)) export_file_path = export_file.path Rails.logger.debug("=====> Export path #{export_file.path}") if extract && zip require "zip" new_path = export_file_path.partition('.zip').first zipped = Zip::File.open(export_file_path) file_handle = zipped.entries.first file_handle.extract(new_path) File.delete(export_file_path) return new_path else return export_file_path end end |
#getFileById(id: "2c92c0f85e7f88ff015e86b8f8f4517f") ⇒ Object
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 |
# File 'lib/zuora_api/login.rb', line 653 def getFileById(id: "2c92c0f85e7f88ff015e86b8f8f4517f") response = nil result = "new" while result != "completed" do sleep(2)#sleep 2 seconds response, fullResponse = self.rest_call(method: :get, body: {}, url: self.aqua_endpoint("batch-query/jobs/#{id}")) result = response["batches"][0]["status"] if result == "error" raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Aqua Error: #{response}") break end end fileId = response["batches"][0]["fileId"] return self.get_file(url: self.aqua_endpoint("file/#{fileId}")) end |
#is_prod_env ⇒ Object
276 277 278 279 280 281 282 283 284 |
# File 'lib/zuora_api/login.rb', line 276 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 |
#new_session(auth_type: :basic, debug: false) ⇒ Object
352 353 |
# File 'lib/zuora_api/login.rb', line 352 def new_session(auth_type: :basic, debug: false) end |
#query(query, parse = false) ⇒ Object
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 |
# File 'lib/zuora_api/login.rb', line 1061 def query(query, parse = false) Rails.logger.debug("Querying Zuora for #{query}") output_xml, input_xml = self.soap_call({:debug => false, :timeout_retry => true}) do |xml| xml['ns1'].query do xml['ns1'].queryString query end end if parse return [] if output_xml.xpath('//ns1:size', 'ns1' =>'http://api.zuora.com/').text == '0' data = output_xml.xpath('//ns1:records', 'ns1' =>'http://api.zuora.com/').map {|record| record.children.map {|element| [element.name, element.text]}.to_h} return data else return output_xml end end |
#raise_errors(type: :SOAP, body: nil, response: nil) ⇒ Object
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 |
# File 'lib/zuora_api/login.rb', line 467 def raise_errors(type: :SOAP, body: nil, response: nil) case type when :SOAP error = body.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text = body.xpath('//fns:FaultMessage', 'fns' =>'http://fault.api.zuora.com/').text if error.blank? || .blank? error = body.xpath('//faultcode').text = body.xpath('//faultstring').text end if error.blank? || .blank? error = body.xpath('//ns1:Code', 'ns1' =>'http://api.zuora.com/').text = body.xpath('//ns1:Message', 'ns1' =>'http://api.zuora.com/').text end #Update/Create/Delete Calls with multiple requests and responses if body.xpath('//ns1:result', 'ns1' =>'http://api.zuora.com/').size > 0 && body.xpath('//ns1:Errors', 'ns1' =>'http://api.zuora.com/').size > 0 error = [] success = [] body.xpath('//ns1:result', 'ns1' =>'http://api.zuora.com/').each_with_index do |call, object_index| if call.xpath('./ns1:Success', 'ns1' =>'http://api.zuora.com/').text == 'false' && call.xpath('./ns1:Errors', 'ns1' =>'http://api.zuora.com/').size > 0 = "#{call.xpath('./*/ns1:Code', 'ns1' =>'http://api.zuora.com/').text}::#{call.xpath('./*/ns1:Message', 'ns1' =>'http://api.zuora.com/').text}" error.push() else success.push(call.xpath('./ns1:Id', 'ns1' =>'http://api.zuora.com/').text) end end end #By default response if not passed in for SOAP as all SOAP is 200 if error.present? if error.class == String case error when "INVALID_SESSION" raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{error}::#{}", body, response.code ) when "REQUEST_EXCEEDED_LIMIT" raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{error}::#{}", body, response.code) when "LOCK_COMPETITION" raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{error}::#{}", body, response.code) when "BATCH_FAIL_ERROR" if .include?("optimistic locking failed") raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{error}::#{}", body, response.code) else raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{error}::#{}", body, response.code) end when "TEMPORARY_ERROR" raise ZuoraAPI::Exceptions::ZuoraAPITemporaryError.new("#{error}::#{}", body, response.code) else raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{error}::#{}", body, response.code) if error.present? end elsif error.class == Array if error[0].include?("LOCK_COMPETITION") && error.count == 1 raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new(error.group_by {|v| v}.map {|k,v| "(#{v.size}x) - #{k == "::" ? 'UNKNOWN::No error provided' : k}"}.join(', '), body, response.code) else raise ZuoraAPI::Exceptions::ZuoraAPIError.new(error.group_by {|v| v}.map {|k,v| "(#{v.size}x) - #{k == "::" ? 'UNKNOWN::No error provided' : k}"}.join(', '), body, response.code, error, success) end end end if response.code == 429 raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later.", body, response.code) end when :JSON body = body.dig("results").present? ? body["results"] : body if body.class == Hash if body.class == Hash && (!body["success"] || !body["Success"] || response.code != 200) = (body["reasons"] || []).map {|error| error['message']}.compact codes_array = (body["reasons"] || []).map {|error| error['code']}.compact if body['message'] == "No bearer token" && response.code == 400 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("#{.join(', ')}", body, response.code) end if body['error'] == 'Unauthorized' && body['status'] = 401 raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{.join(', ')}", body, response.code) end #Authentication failed if codes_array.map{|code| code.to_s.slice(6,7).to_i}.include?(11) || response.code == 401 raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{.join(', ')}", body, response.code) end #Zuora REST Create Amendment error #Authentication failed if body["faultcode"].present? && body["faultcode"] == "fns:INVALID_SESSION" raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{body['faultstring']}", body, response.code) end #Request exceeded limit if codes_array.map{|code| code.to_s.slice(6,7).to_i}.include?(70) raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{.join(', ')}", body, response.code) end #Locking contention if codes_array.map{|code| code.to_s.slice(6,7).to_i}.include?(50) raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{.join(', ')}", body, response.code) end #All Errors catch if codes_array.size > 0 raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{.join(', ')}", body, response.code) end #Zuora REST Query Errors if body["faultcode"].present? case body["faultcode"] when "fns:MALFORMED_QUERY" raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{body["faultcode"]}::#{body["faultstring"]}", body, response.code) when "fns:REQUEST_EXCEEDED_LIMIT" raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{body["faultcode"]}::#{body["faultstring"]}", body, response.code) when "fns:LOCK_COMPETITION" raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{body["faultcode"]}::#{body["faultstring"]}", body, response.code) when "INVALID_SESSION" raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{body["faultcode"]}::#{body["faultstring"]}", body, response.code) else raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{body["faultcode"]}::#{body["faultstring"]}", body, response.code) end end if body["Errors"].present? || body["errors"].present? errors = [] (body["Errors"] || []).select { |obj| errors.push(obj["Message"]) }.compact (body["errors"] || []).select { |obj| errors.push(obj["Message"]) }.compact if errors.size > 0 raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{errors.join(", ")}", body, response.code, errors) end end end #Zuora REST Actions error (Create, Update, Delete, Amend) if body.class == Array all_errors = body.select {|obj| !obj['Success'] || !obj['success'] }.map {|obj| obj['Errors'] || obj['errors'] }.compact all_success = body.select {|obj| obj['Success'] || obj['success']}.compact if all_success.blank? && all_errors.present? error_codes = all_errors.flatten.group_by {|error| error['Code']}.keys.uniq if error_codes.size == 1 && error_codes[0] == "LOCK_COMPETITION" raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("Retry Lock Competition", body, response.code) end end if all_errors.size > 0 raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{all_errors.flatten.group_by {|error| error['Message']}.keys.uniq.join(' ')}", body, response.code, all_errors, all_success ) end end #All other errors if response.code != 200 if response.code == 429 raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later.", body, response.code) else raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{response.}", body, response.code) end end end end |
#refresh_nav(cookies) ⇒ Object
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/zuora_api/login.rb', line 111 def refresh_nav() zsession = ["ZSession"] zconnect_accesstoken = get_zconnect_accesstoken() 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? && .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 |
#reporting_url(path) ⇒ Object
144 145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/zuora_api/login.rb', line 144 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 |
#rest_call(method: :get, body: nil, headers: {}, url: rest_endpoint("catalog/products?pageSize=4"), debug: false, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError, ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition], z_session: true, session_type: :basic, timeout_retry: false, timeout: 120, **keyword_args) ⇒ Object
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 |
# File 'lib/zuora_api/login.rb', line 730 def rest_call(method: :get, body: nil, headers: {}, url: rest_endpoint("catalog/products?pageSize=4"), debug: false, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError, ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition], z_session: true, session_type: :basic, timeout_retry: false, timeout: 120, **keyword_args) tries ||= 2 if self.entity_id.present? headers["Zuora-Entity-Ids"] = self.entity_id if headers.dig("Zuora-Entity-Ids").nil? headers.delete_if { |key, value| ["entityId", "entityName"].include?(key.to_s) } end raise "Method not supported, supported methods include: :get, :post, :put, :delete, :patch, :head, :options" if ![:get, :post, :put, :delete, :patch, :head, :options].include?(method) authentication_headers = z_session ? {"Authorization" => self.get_session(prefix: true, auth_type: session_type) } : {} headers = {'Content-Type' => "application/json; charset=utf-8"}.merge(headers).merge(authentication_headers) response = HTTParty::Request.new("Net::HTTP::#{method.to_s.capitalize}".constantize, url, body: body, headers: headers, timeout: timeout).perform Rails.logger.debug("Response Code: #{response.code}") if debug begin output_json = JSON.parse(response.body) rescue JSON::ParserError => ex output_json = {} end Rails.logger.debug("Response JSON: #{output_json}") if debug && output_json.present? raise_errors(type: :JSON, body: output_json, response: response) rescue ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError => ex if self.class.to_s == 'ZuoraAPI::Oauth' self.rest_call(method: method.to_sym, url: url, debug: debug, errors: errors, z_session: z_session, session_type: :bearer, timeout_retry: timeout_retry, timeout: timeout) else Rails.logger.debug("Rest Call - Session Bad Auth type") raise ex end rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex if !(tries -= 1).zero? && z_session Rails.logger.debug("Rest Call - Session Invalid #{session_type}") self.new_session(auth_type: session_type) 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 ZuoraAPI::Exceptions::BadEntityError => ex raise ex rescue *CONNECTION_EXCEPTIONS => ex if !(tries -= 1).zero? Rails.logger.info("Rest Call - #{ex.class} Timed out will retry after 5 seconds") sleep(self.timeout_sleep) retry else raise ex end rescue *CONNECTION_READ_EXCEPTIONS => ex if !(tries -= 1).zero? && timeout_retry Rails.logger.info("Rest Call - #{ex.class} Timed out will retry after 5 seconds") sleep(self.timeout_sleep) retry else raise ex end rescue => ex raise ex else return [output_json, response] end |
#rest_endpoint(url = "") ⇒ Object
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/zuora_api/login.rb', line 307 def rest_endpoint(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 'Performance' endpoint = "https://rest.pt1.zuora.com/v1/".concat(url) when 'Services' 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 |
#set_nav(state, cookies) ⇒ Object
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/zuora_api/login.rb', line 87 def set_nav(state, ) zsession = ["ZSession"] zconnect_accesstoken = get_zconnect_accesstoken() 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? && .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 |
#soap_call(ns1: 'ns1', ns2: 'ns2', batch_size: nil, single_transaction: false, debug: false, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError, ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition], z_session: true, timeout_retry: false, timeout: 120, **keyword_args) ⇒ Object
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 |
# File 'lib/zuora_api/login.rb', line 389 def soap_call(ns1: 'ns1', ns2: 'ns2', batch_size: nil, single_transaction: false, debug: false, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError, ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition], z_session: true, timeout_retry: false, timeout: 120,**keyword_args) tries ||= 2 xml = Nokogiri::XML::Builder.new do |xml| xml['SOAP-ENV'].Envelope('xmlns:SOAP-ENV' => "http://schemas.xmlsoap.org/soap/envelope/", "xmlns:#{ns2}" => "http://object.api.zuora.com/", 'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance", 'xmlns:api' => "http://api.zuora.com/", "xmlns:#{ns1}" => "http://api.zuora.com/") do xml['SOAP-ENV'].Header do xml["#{ns1}"].SessionHeader do xml["#{ns1}"].session self.get_session(prefix: false, auth_type: :basic) end if single_transaction xml["#{ns1}"].CallOptions do xml.useSingleTransaction single_transaction end end if batch_size xml["#{ns1}"].QueryOptions do xml.batchSize batch_size end end end xml['SOAP-ENV'].Body do yield xml, keyword_args end end end input_xml = Nokogiri::XML(xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip) input_xml.xpath('//ns1:session', 'ns1' =>'http://api.zuora.com/').children.remove Rails.logger.debug("Request SOAP XML: #{input_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}") if debug response = HTTParty.post(self.url,:body => xml.doc.to_xml(:save_with => XML_SAVE_OPTIONS).strip, :headers => {'Content-Type' => "text/xml; charset=utf-8"}, :timeout => timeout) output_xml = Nokogiri::XML(response.body) Rails.logger.debug("Response SOAP XML: #{output_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}") if debug raise_errors(type: :SOAP, body: output_xml, response: response) rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex if !(tries -= 1).zero? && z_session Rails.logger.debug("SOAP Call - Session Invalid") self.new_session(auth_type: :basic) retry else if errors.include?(ex.class) raise ex else return output_xml, input_xml, response end end rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition => ex if errors.include?(ex.class) raise ex else return output_xml, input_xml, response end rescue *CONNECTION_EXCEPTIONS => ex if !(tries -= 1).zero? Rails.logger.info("SOAP Call - #{ex.class} Timed out will retry after 5 seconds") sleep(self.timeout_sleep) retry else raise ex end rescue *CONNECTION_READ_EXCEPTIONS => ex if !(tries -= 1).zero? && timeout_retry Rails.logger.info("SOAP Call - #{ex.class} Timed out will retry after 5 seconds") sleep(self.timeout_sleep) retry else raise ex end rescue => ex raise ex else return output_xml, input_xml, response end |
#update_create_tenant ⇒ Object
802 803 804 805 806 807 808 809 810 811 812 813 814 |
# File 'lib/zuora_api/login.rb', line 802 def update_create_tenant Rails.logger.debug("Update and/or Create Tenant") output_xml, input_xml = soap_call() do |xml| xml['api'].getUserInfo end user_info = output_xml.xpath('//ns1:getUserInfoResponse', 'ns1' =>'http://api.zuora.com/') output_hash = Hash[user_info.children.map {|x| [x.name.to_sym, x.text] }] self.user_info = output_hash self.user_info['entities'] = self.rest_call(:url => self.rest_endpoint("user-access/user-profile/#{self.user_info['UserId']}/accessible-entities"))['entities'] self.tenant_name = output_hash[:TenantName] self.tenant_id = output_hash[:TenantId] return self end |
#update_environment ⇒ Object
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/zuora_api/login.rb', line 256 def update_environment if !self.url.blank? if /(?<=\.|\/|-|^)(apisandbox|sandbox)(?=\.|\/|-|$)/ === self.hostname self.environment = 'Sandbox' elsif /(?<=\.|\/|^)(service|services[\d]*|ep-edge)(?=\.|\/|$)/ === self.hostname self.environment = 'Services' elsif /(?<=\.|\/|-|^)(pt[\d]*)(?=\.|\/|-|$)/ === self.hostname self.environment = 'Performance' 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 |
#update_region ⇒ Object
241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/zuora_api/login.rb', line 241 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 |
#update_zconnect_provider ⇒ Object
286 287 288 289 290 291 292 293 294 295 |
# File 'lib/zuora_api/login.rb', line 286 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 |