Class: ZuoraAPI::Login

Inherits:
Object
  • Object
show all
Defined in:
lib/zuora_api/login.rb

Constant Summary collapse

ENVIRONMENTS = 
[SANDBOX = 'Sandbox', PRODUCTION = 'Production', PREFORMANCE = 'Preformance', SERVICES = 'Services', UNKNOWN = 'Unknown' ]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(username: nil, password: nil, url: nil, entity_id: nil, session: nil, **keyword_args) ⇒ Login

Returns a new instance of Login.



10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/zuora_api/login.rb', line 10

def initialize(username: nil, password: nil, url: nil, entity_id: nil, session: nil, **keyword_args)
  @username = username
  @password = password
  @url = url
  @entity_id = entity_id
  @current_session = session
  @errors = Hash.new
  @status = "Active"
  @user_info = Hash.new
  self.update_environment
end

Instance Attribute Details

#current_error ⇒ Object

Returns the value of attribute current_error.



8
9
10
 
# File 'lib/zuora_api/login.rb', line 8

def current_error
  @current_error
end

#current_session ⇒ Object

Returns the value of attribute current_session.



8
9
10
 
# File 'lib/zuora_api/login.rb', line 8

def current_session
  @current_session
end

#entity_id ⇒ Object

Returns the value of attribute entity_id.



8
9
10
 
# File 'lib/zuora_api/login.rb', line 8

def entity_id
  @entity_id
end

#environment ⇒ Object

Returns the value of attribute environment.



8
9
10
 
# File 'lib/zuora_api/login.rb', line 8

def environment
  @environment
end

#errors ⇒ Object

Returns the value of attribute errors.



8
9
10
 
# File 'lib/zuora_api/login.rb', line 8

def errors
  @errors
end

#password ⇒ Object

Returns the value of attribute password.



8
9
10
 
# File 'lib/zuora_api/login.rb', line 8

def password
  @password
end

#status ⇒ Object

Returns the value of attribute status.



8
9
10
 
# File 'lib/zuora_api/login.rb', line 8

def status
  @status
end

#tenant_id ⇒ Object

Returns the value of attribute tenant_id.



8
9
10
 
# File 'lib/zuora_api/login.rb', line 8

def tenant_id
  @tenant_id
end

#tenant_name ⇒ Object

Returns the value of attribute tenant_name.



8
9
10
 
# File 'lib/zuora_api/login.rb', line 8

def tenant_name
  @tenant_name
end

#url ⇒ Object

Returns the value of attribute url.



8
9
10
 
# File 'lib/zuora_api/login.rb', line 8

def url
  @url
end

#user_info ⇒ Object

Returns the value of attribute user_info.



8
9
10
 
# File 'lib/zuora_api/login.rb', line 8

def 
  @user_info
end

#username ⇒ Object

Returns the value of attribute username.



8
9
10
 
# File 'lib/zuora_api/login.rb', line 8

def username
  @username
end

#wsdl_number ⇒ Object

Returns the value of attribute wsdl_number.



8
9
10
 
# File 'lib/zuora_api/login.rb', line 8

def wsdl_number
  @wsdl_number
end

Class Method Details

.endpoints ⇒ Object 



27
28
29
30
31
32
33
 
# File 'lib/zuora_api/login.rb', line 27

def self.endpoints
  return {"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://app-0.stg.zuora.eu/apps/services/a/"}
end

.environments ⇒ Object 



23
24
25
 
# File 'lib/zuora_api/login.rb', line 23

def self.environments
  %w(Sandbox Production Services Performance)
end

Instance Method Details

#aqua_endpoint(url = "") ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'lib/zuora_api/login.rb', line 55

def aqua_endpoint(url="")
  if self.environment == 'Sandbox'
    return  "https://apisandbox.zuora.com/apps/api/".concat(url)
  elsif  self.environment == 'Production'
    return  "https://zuora.com/apps/api/".concat(url)
  else self.environment == 'Unknown'
    return url
  end
end

#aqua_query(queryName: '', query: '', version: '1.2', jobName: 'Aqua', partner: '', project: '') ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/zuora_api/login.rb', line 243

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 "Error in AQuA Process. #{response}"
  end
  return getFileById(id: response[0]["id"])
end

#checkJRStatus(jrNumber) ⇒ Object 



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/zuora_api/login.rb', line 579

def checkJRStatus(jrNumber)
  Rails.logger.info('Journal Run') {"Check for completion"}
  url = rest_endpoint("/journal-runs/#{jrNumber}")
  uri = URI(url)
  req = Net::HTTP::Get.new(uri,initheader = {'Content-Type' =>'application/json'})
  req.basic_auth self.username, self.password
  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
    message = result["reasons"][0]["message"]
    Rails.logger.info('Journal Run') {"Checking status of journal run failed with message #{message}"}
  end
  return "failure"
end

#createJournalRun(call) ⇒ Object 



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/zuora_api/login.rb', line 556

def createJournalRun(call)
  url = rest_endpoint("/journal-runs")
  uri = URI(url)
  req = Net::HTTP::Post.new(uri,initheader = {'Content-Type' =>'application/json'})
  req.basic_auth self.username, self.password
  req.body = call
  response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
    http.request req
  end
  Rails.logger.info('Journal Run') {"Response #{response.code} #{response.message}:
    #{response.body}"}

  result = JSON.parse(response.body)
  if result["success"]
    jrNumber = result["journalRunNumber"]
    return jrNumber
  else
    message = result["reasons"][0]["message"]
    Rails.logger.info('Journal Run') {"Journal Run failed with message #{message}"}
    return result
  end
end

#dateFormat ⇒ Object 



83
84
85
 
# File 'lib/zuora_api/login.rb', line 83

def dateFormat
  return self.wsdl_number > 68 ? '%Y-%m-%d' : '%Y-%m-%dT%H:%M:%S'
end

#describe_call(object = nil) ⇒ Object 



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/zuora_api/login.rb', line 282

def describe_call(object = nil)
  self.get_session
  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.blank? ? {"entityId" => self.entity_id, 'Content-Type' => "text/xml; charset=utf-8"} : {'Content-Type' => "text/xml; charset=utf-8"}
  response = HTTParty.get(url, :headers => headers , basic_auth: {:username => self.username, :password => self.password}, :timeout => 120)
  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
    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
  return des_hash
end

#extract_zip(file, filename) ⇒ Object 



521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/zuora_api/login.rb', line 521

def extract_zip(file,filename)
  files = Array.new
  FileUtils.mkdir_p("#{Rails.root}/tmp/#{filename}")
  ::Zip::File.open(file) do |zip_file|
    zip_file.each do |f|
      files << "#{Rails.root}/tmp/#{filename}/#{f.name}"
      fpath = File.join("#{Rails.root}/tmp/#{filename}", f.name)
      zip_file.extract(f, fpath) unless File.exist?(fpath)
    end
  end
  return files
end

#fileURL ⇒ Object 



79
80
81
 
# File 'lib/zuora_api/login.rb', line 79

def fileURL
  return self.url.split(".com").first.concat(".com/apps/api/file/")
end

#get_catalog ⇒ Object 



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/zuora_api/login.rb', line 368

def get_catalog
  products, catalog_map, response = [{}, {}, {'nextPage' => self.rest_endpoint('catalog/products?pageSize=40') }]
  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)
    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_file(file_name: nil, url: nil, headers: {}, count: 3, file_type: "zip") ⇒ Object 



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
 
# File 'lib/zuora_api/login.rb', line 400

def get_file(file_name: nil, url: nil, headers: {}, count: 3, file_type: "zip")
  begin
    uri = URI.parse(url)
    filename = !file_name.blank? ? file_name : File.basename(uri.path).rpartition('.').first

    http = Net::HTTP.new(uri.host, uri.port)
    http.read_timeout = 120 #Seconds 
    http.use_ssl = true  if uri.scheme.downcase == 'https'
    headers = headers.merge({"Authorization" => "ZSession #{self.get_session}"})

    http.request_get(uri.path, headers) do |response|
      case response
      when Net::HTTPNotFound
        Rails.logger.fatal("404 - Not Found")
        raise response

      when Net::HTTPUnauthorized
        raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(zuora_client.current_error) if count <= 0
        Rails.logger.fatal("Unauthorized: Retry")
        zuora_client.new_session
        return get_file(:url => url, :count => count - 1, :headers => headers)

      when Net::HTTPClientError
        Rails.logger.debug("Login: #{self.username} Export")
        raise response

      when Net::HTTPOK
        temp_file = Tempfile.new([filename, ".#{file_type}"], "#{Rails.root}/tmp")
        temp_file.binmode

        size, export_progress = [0, 0]
        export_size = response.header["Content-Length"].to_i
        response.read_body do |chunk|
          temp_file << chunk.force_encoding("UTF-8")
          size += chunk.size
          new_progress = (size * 100) / export_size
          unless new_progress == export_progress
            Rails.logger.debug("Login: #{self.username} Export Downloading %s (%3d%%)" % [filename, new_progress])
          end
          export_progress = new_progress
        end

        temp_file.close
        return temp_file
      end
    end
  rescue Exception => e
    Rails.logger.fatal('GetFile') {"Download Failed: #{response}"}
    raise
  end
end

#get_session ⇒ Object

Raises:



174
175
176
177
178
179
 
# File 'lib/zuora_api/login.rb', line 174

def get_session
  Rails.logger.debug("Create new session") if self.current_session.blank?
  self.new_session if self.current_session.blank?
  raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error) if self.status != 'Active'
  return self.current_session
end

#getDataSourceExport(query, extract: true, encrypted: false, zip: true) ⇒ Object 



454
455
456
457
458
459
460
461
462
463
464
465
466
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
 
# File 'lib/zuora_api/login.rb', line 454

def getDataSourceExport(query, extract: true, encrypted: false, zip: true)
  Rails.logger.info('Export') {"Build export"}
  Rails.logger.info('Export query') {"#{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.current_session
        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, headers: {'Content-Type' => "application/json; charset=utf-8"}, :timeout => 120)
  output_xml = Nokogiri::XML(response_query.body)

  return '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.current_session
        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, 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
    return 'Export Creation Unsuccessful : ' + output_xml.xpath('//ns1:Message', 'ns1' =>'http://api.zuora.com/').text if result == "Failed"
  end
  file_id = output_xml.xpath('//ns2:FileId',  'ns2' =>'http://object.api.zuora.com/').text
  Rails.logger.info('Export') {'=====> Export finished'}
  zip_file = get_file(:file_name => "#{file_id}.zip" ,:url => "#{self.fileURL}#{file_id}?file-id=#{file_id}")
  if extract && zip
    location = extract_zip(zip_file.path, "#{file_id}")
    File.delete(zip_file.path)
    return location
  elsif !zip
    file = get_file(:file_name => "#{file_id}.gpg" ,:url => "#{self.fileURL}#{file_id}?file-id=#{file_id}", headers: {"Authorization" => "ZSession " + self.current_session})
    puts file.path
    return file.path
  else
    return zip_file.path
  end
end

#getFileById(id: "") ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/zuora_api/login.rb', line 265

def getFileById(id: "")
  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 "Aqua Error: #{response}"
      break
    end
  end
  fileId = response["batches"][0]["fileId"]
  return self.get_file(file_name: "#{fileId}.csv", url: self.aqua_endpoint("file/#{fileId}"), headers: {"Authorization" => "ZSession " + self.current_session, 'Content-Type' => "application/json; charset=utf-8"},file_type: "csv")
end

#new_session ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/zuora_api/login.rb', line 87

def new_session
  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? && !self.current_session.blank?)
        Rails.logger.debug("Method [Session]")
        xml['SOAP-ENV'].Header do
          xml['api'].SessionHeader do
            xml['api'].session self.current_session
          end
        end
        xml['SOAP-ENV'].Body do
          xml['api'].getUserInfo
        end
      else
        xml['SOAP-ENV'].Header
        xml['SOAP-ENV'].Body do
          xml['api']. 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
  @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)
  if !@response_query.success?
    self.current_session = nil
    if @output_xml.namespaces.size > 0  && @output_xml.xpath('//soapenv:Fault').size > 0
      self.current_error = @output_xml.xpath('//fns:FaultMessage', 'fns' =>'http://fault.api.zuora.com/').text
      if self.current_error.include?('deactivated')
        self.status = 'Deactivated'
        self.current_error = 'Deactivated user login, please check with Zuora tenant administrator'
        self.errors[:username] = self.current_error
      elsif self.current_error.include?('inactive')
        self.status = 'Inactive'
        self.current_error = 'Inactive user login, please check with Zuora tenant administrator'
        self.errors[:username] = self.current_error
      elsif self.current_error.include?("invalid username or password") || self.current_error.include?("Invalid login. User name and password do not match.")
        self.status = 'Invalid Login'
        self.current_error = 'Invalid login, please check username and password or URL endpoint'
        self.errors[:username] = self.current_error
        self.errors[:password] = self.current_error
      elsif self.current_error.include?('unsupported version')
        self.status = 'Unsupported API Version'
        self.current_error = 'Unsupported API version, please verify URL endpoint'
        self.errors[:url] = self.current_error
      elsif self.current_error.include?('invalid api version')
        self.status = 'Invalid API Version'
        self.current_error = 'Invalid API version, please verify URL endpoint'
        self.errors[:url] = self.current_error
      elsif self.current_error.include?('invalid session')
        self.status = 'Invalid Session'
        self.current_error = 'Session invalid, please update session and verify URL endpoint'
        self.errors[:session] = self.current_error
      elsif self.current_error.include?('Your IP address')
        self.status = 'Restricted IP'
        self.current_error = 'IP restricted, contact Zuora tenant administrator and remove IP restriction'
        self.errors[:base] = self.current_error
      elsif self.current_error.include?('This account has been locked')
        self.status = 'Locked'
        self.current_error = 'Locked user login, please wait or navigate to Zuora to unlock user'
        self.errors[:username] = self.current_error
      else
        self.status = 'Unknown'
        self.current_error =  @output_xml.xpath('//faultstring').text if self.current_error.blank?
        self.errors[:base] = self.current_error
      end
    else
      if @response_query.timed_out?
        self.current_error = "Request timed out. Try again"
        self.status = 'Timeout'
      else
        self.current_error = " Code = #{@response_query.code} Message = #{@response_query.return_code}"
        self.status = 'No Service'
      end
    end
  else
    self.current_session   = (self.password.blank? && !self.current_session.blank?) ?  self.current_session :  @output_xml.xpath('//ns1:Session', 'ns1' =>'http://api.zuora.com/').text
    self.username          = @output_xml.xpath('//ns1:Username', 'ns1' =>'http://api.zuora.com/').text if self.username.blank?
    self.current_error     = nil
    self.status            = 'Active'
  end
  return self.status
end

#query(query) ⇒ Object 



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/zuora_api/login.rb', line 534

def query(query)
  Rails.logger.info('query') {"Querying Zuora for #{query}"}
  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.current_session
        end
      end
      xml['SOAP-ENV'].Body do
        xml['ns1'].query do
          xml['ns1'].queryString query
        end
      end
    end
  end
  response_query = HTTParty.post(self.url, body: confirmRequest.to_xml, :headers => {'Content-Type' => "text/xml; charset=utf-8"}, :timeout => 120)
  output_xml = Nokogiri::XML(response_query.body)
  Rails.logger.info('query') {"#{output_xml}"}
  return output_xml
end

#rest_call(method: :get, body: {}, headers: {}, url: rest_endpoint("catalog/products?pageSize=4"), debug: true, **keyword_args) ⇒ Object 



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
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/zuora_api/login.rb', line 313

def rest_call(method: :get, body: {},headers: {}, url: rest_endpoint("catalog/products?pageSize=4") , debug: true, **keyword_args)
  tries ||= 2
  headers["entityId"] = self.entity_id if !self.entity_id.blank?
  raise "Method not supported, supported methods include: :get, :post, :put, :delete, :patch, :head, :options" if ![:get, :post, :put, :delete, :patch, :head, :options].include?(method)
  response = HTTParty::Request.new("Net::HTTP::#{method.to_s.capitalize}".constantize, url, body: body, headers: {'Content-Type' => "application/json; charset=utf-8", "Authorization" => "ZSession #{self.get_session}"}.merge(headers), timeout: 120).perform
  Rails.logger.debug('Connect') { response.code} if debug
  output_json = JSON.parse(response.body)
  Rails.logger.debug('Connect') {"Response JSON: #{output_json}"} if debug

  #Zuora Regular REST API Unauthorized
  raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{output_json["reasons"][0]["message"]}") if output_json.class != Array &&  (!output_json["success"] && !output_json["reasons"].blank? && output_json["reasons"] == Array &&  output_json["reasons"][0]["code"] == 90000011 && response.code == 401)
  #Zuora AQuA Unauthorized
  raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("Unauthorized") if response.code == 401
  #Zuora REST API Limit Errors
  raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{output_json["reasons"][0]["message"]}") if output_json.class != Array && (!output_json["success"] && !output_json["reasons"].blank? && output_json["reasons"] == Array &&  output_json["reasons"][0]["code"] == 50000070 && response.code == 429)
  #Zuora REST Query Errors
  raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{output_json["faultcode"]}::#{output_json["faultstring"]}") if output_json.class != Array &&  !output_json["faultcode"].blank?
  #Zuora REST actions error
  raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{output_json["Errors"][0]["Code"]}::#{output_json["Errors"][0]["Message"]}") if output_json.class != Array && !output_json["Success"] && output_json["Errors"]
  #Zuora All Other API Errors
  raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{response.message}") if response.code != 200
rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
  if !(tries -= 1).zero?
    Rails.logger.debug {"Session Invalid"}
    self.new_session
    retry
  else
    raise ex
  end
rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit => ex
  if debug
    raise ex
  else
    return [output_json, response]
  end
rescue => ex
  raise ex
else
  return [output_json, response]
end

#rest_endpoint(url = "") ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/zuora_api/login.rb', line 65

def rest_endpoint(url="")
  if self.environment == 'Sandbox'
    return  "https://rest.apisandbox.zuora.com/v1/".concat(url)
  elsif  self.environment == 'Production'
    return  "https://rest.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' || self.environment == "Staging"
    return  self.url.split('/')[0..2].join('/').concat('/apps/v1/').concat(url)
  else self.environment == 'Unknown'
    return url
  end
end

#soap_call(ns1: 'ns1', ns2: 'ns2', batch_size: nil, single_transaction: false, debug: true, **keyword_args) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/zuora_api/login.rb', line 181

def soap_call(ns1: 'ns1', ns2: 'ns2', batch_size: nil, single_transaction: false,debug: true, **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
        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 => 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 = HTTParty.post(self.url,:body => xml.doc.to_xml, :headers => {'Content-Type' => "text/xml; charset=utf-8"}, :timeout => 120)
  output_xml = Nokogiri::XML(response.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

  raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{output_xml.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text}::#{output_xml.xpath('//fns:FaultMessage', 'fns' =>'http://fault.api.zuora.com/').text}")  if (!output_xml.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text.blank? && output_xml.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text == "INVALID_SESSION")
  raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{output_xml.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text}::#{output_xml.xpath('//fns:FaultMessage', 'fns' =>'http://fault.api.zuora.com/').text}")  if (!output_xml.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text.blank? && output_xml.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text == "REQUEST_EXCEEDED_LIMIT")
  raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{output_xml.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text}::#{output_xml.xpath('//fns:FaultMessage', 'fns' =>'http://fault.api.zuora.com/').text}")  if (!output_xml.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text.blank? && output_xml.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text == "LOCK_COMPETITION")

  raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{output_xml.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text}::#{output_xml.xpath('//fns:FaultMessage', 'fns' =>'http://fault.api.zuora.com/').text}") if !output_xml.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text.blank?
  raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{output_xml.xpath('//faultcode').text}::#{output_xml.xpath('//faultstring').text}")  if !output_xml.xpath('//faultcode').text.blank?
rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
  if !(tries -= 1).zero?
    Rails.logger.debug {"Session Invalid"}
    self.new_session
    retry
  else
    raise ex
  end
rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition => ex
  if debug
    raise ex
  else
    return [output_xml, input_xml]
  end
rescue => ex
  raise ex
else
  return [output_xml, input_xml]
end

#update_create_tenant ⇒ Object 



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/zuora_api/login.rb', line 354

def update_create_tenant
  Rails.logger.debug("Update and/or Create Tenant")
  output_xml, input_xml = soap_call() do |xml|
    xml['api'].getUserInfo
  end
   = output_xml.xpath('//ns1:getUserInfoResponse', 'ns1' =>'http://api.zuora.com/')
  output_hash = Hash[.children.map {|x| [x.name.to_sym, x.text] }]
  self. = output_hash
  self.['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 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/zuora_api/login.rb', line 35

def update_environment
  if !self.url.blank?
    env_path = self.url.split('https://').last.split('.zuora.com').first if self.url.include?(".zuora.com")
    env_path = self.url.split('https://').last.split('.zuora.eu').first if self.url.include?(".zuora.eu")
    if  env_path == 'apisandbox' || self.url.include?('tls10.apisandbox.zuora.com')
      self.environment = 'Sandbox'
    elsif env_path == 'www' || env_path == 'api' || self.url.include?('tls10.zuora.com')
      self.environment = 'Production'
    elsif env_path.include?('service')
      self.environment = 'Services'
    elsif env_path.include?('pt')
      self.environment = 'Performance'
    elsif env_path.include?('app-0')
      self.environment = 'Staging'
    else
      self.environment = 'Unknown'
    end
  end
end