Class: ZuoraConnect::AppInstanceBase

Inherits:
ActiveRecord::Base
  • Object
show all
Defined in:
app/models/zuora_connect/app_instance_base.rb

Direct Known Subclasses

AppInstance

Constant Summary collapse

REFRESH_TIMEOUT =

Used to determine how long to wait on current refresh call before executing another

2.minute
INSTANCE_REFRESH_WINDOW =

Used to set how how long till app starts attempting to refresh cached task connect data

1.hours
INSTANCE_REDIS_CACHE_PERIOD =

Used to determine how long to cached task data will live for

24.hours
API_LIMIT_TIMEOUT =

Used to set the default for expiring timeout when api rate limiting is in effect

2.minutes
BLANK_OBJECT_ID_LOOKUP = 
'BlankValueSupplied'
HOLDING_PATTERN_SLEEP = 
5.seconds
CONNECT_APPLICATION_ID = 
0
CONNECT_COMMUNICATION_SLEEP = 
5.seconds
IGNORED_LOCALS = 
['fr', 'ja', 'es', 'zh', 'de']
INTERNAL_HOSTS = 
[]
LOGIN_TENANT_DESTINATION = 
'target_login'
AWS_AUTH_ERRORS = 
[
  Aws::Sigv4::Errors::MissingCredentialsError,
  Aws::Errors::MissingCredentialsError,
  Aws::S3::Errors::AccessDenied,
  Aws::SES::Errors::AccessDenied,
  Aws::KMS::Errors::AccessDeniedException 
].freeze
AWS_AUTH_ERRORS_MSG = 
"AWS Auth Errors".freeze
@@telegraf_host = 
nil

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_sym, *arguments, &block) ⇒ Object 



1184
1185
1186
1187
1188
1189
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1184

def method_missing(method_sym, *arguments, &block)
  if method_sym.to_s.include?("login")
    ZuoraConnect.logger.fatal("Method Missing #{method_sym}. Instance Data: #{self.task_data} Instance Logins: #{self.logins}", self.default_ougai_items)
  end
  super
end

Instance Attribute Details

#api_version ⇒ Object

Returns the value of attribute api_version.



14
15
16
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 14

def api_version
  @api_version
end

#connect_user ⇒ Object

Returns the value of attribute connect_user.



14
15
16
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 14

def connect_user
  @connect_user
end

#drop_message ⇒ Object

Returns the value of attribute drop_message.



14
15
16
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 14

def drop_message
  @drop_message
end

#last_refresh ⇒ Object

Returns the value of attribute last_refresh.



14
15
16
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 14

def last_refresh
  @last_refresh
end

#logins ⇒ Object

Returns the value of attribute logins.



14
15
16
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 14

def logins
  @logins
end

#logitems ⇒ Object

Returns the value of attribute logitems.



14
15
16
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 14

def logitems
  @logitems
end

#mode ⇒ Object

Returns the value of attribute mode.



14
15
16
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 14

def mode
  @mode
end

#new_session_message ⇒ Object

Returns the value of attribute new_session_message.



14
15
16
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 14

def new_session_message
  @new_session_message
end

#options ⇒ Object

Returns the value of attribute options.



14
15
16
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 14

def options
  @options
end

#password ⇒ Object

Returns the value of attribute password.



14
15
16
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 14

def password
  @password
end

#s3_client ⇒ Object

START S3 Helping Methods #####



1095
1096
1097
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1095

def s3_client
  @s3_client
end

#task_data ⇒ Object

Returns the value of attribute task_data.



14
15
16
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 14

def task_data
  @task_data
end

#username ⇒ Object

Returns the value of attribute username.



14
15
16
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 14

def username
  @username
end

Class Method Details

.decrypt_response(resp) ⇒ Object 



1175
1176
1177
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1175

def self.decrypt_response(resp)
  OpenSSL::PKey::RSA.new(ZuoraConnect.configuration.private_key).private_decrypt(resp)
end

.get_metrics(type) ⇒ Object 



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
466
467
468
469
470
471
472
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 440

def self.get_metrics(type)
  @data = {}

  if type == "versions"
    @data = {
      app_name: ZuoraConnect::Telegraf.app_name,
      url: "dummy",
      Version_Gem: ZuoraConnect::VERSION,
      Version_Zuora: ZuoraAPI::VERSION ,
      Version_Ruby: RUBY_VERSION,
      Version_Rails: Rails.version,
      hold: 1
    }
  elsif type == "stats"
    begin
      Resque.redis.ping
      @resque = Resque.info
      @data = {
        app_name: ZuoraConnect::Telegraf.app_name,
        url: "dummy",
        Resque:{
          Jobs_Finished: @resque[:processed] ,
          Jobs_Failed: @resque[:failed],
          Jobs_Pending: @resque[:pending],
          Workers_Active: @resque[:working],
          Workers_Total: @resque[:workers]
        }
      }
    rescue
    end
  end
  return @data
end

.refresh_aggregate_table(aggregate_name: 'all_tasks_processing', table_name: 'tasks', where_clause: "where status in ('Processing', 'Queued')", index_table: true, ignore_indexes: []) ⇒ Object

START Aggregate Grouping Helping Methods ####



1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1118

def self.refresh_aggregate_table(aggregate_name: 'all_tasks_processing', table_name: 'tasks', where_clause: "where status in ('Processing', 'Queued')", index_table: true, ignore_indexes: [])
  self.update_functions
  if index_table
    ActiveRecord::Base.connection.execute('SELECT "shared_extensions".refresh_aggregate_table(\'%s\', \'%s\', %s, \'Index\', \'{%s}\');' % [aggregate_name, table_name, ActiveRecord::Base.connection.quote(where_clause), ignore_indexes.map { |index| "\"#{index}\"" }.join(',')])
  else
    ActiveRecord::Base.connection.execute('SELECT "shared_extensions".refresh_aggregate_table(\'%s\', \'%s\', %s, \'NO\',\'{}\');' % [aggregate_name, table_name, ActiveRecord::Base.connection.quote(where_clause)])
  end
end

.unicorn_listener_stats ⇒ Object 



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
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 407

def self.unicorn_listener_stats ()
  stats_hash = {}
  stats_hash["total_active"] = 0
  stats_hash["total_queued"] = 0

  begin 
    tmp = Unicorn.listener_names
    unix = tmp.grep(%r{\A/})
    tcp = tmp.grep(/\A.+:\d+\z/)
    tcp = nil if tcp.empty?
    unix = nil if unix.empty?


    Raindrops::Linux.tcp_listener_stats(tcp).each do |addr,stats|
      stats_hash["active_#{addr}"] = stats.active
      stats_hash["queued_#{addr}"] = stats.queued
      stats_hash["total_active"] = stats.active + stats_hash["total_active"]
      stats_hash["total_queued"] = stats.queued + stats_hash["total_queued"]
    end if tcp

    Raindrops::Linux.unix_listener_stats(unix).each do |addr,stats|
      stats_hash["active_#{addr}"] = stats.active
      stats_hash["queued_#{addr}"] = stats.queued
      stats_hash["total_active"] = stats.active + stats_hash["total_active"]
      stats_hash["total_queued"] = stats.queued + stats_hash["total_queued"]
    end if unix
  rescue IOError => ex
  rescue => ex
    ZuoraConnect.logger.error(ex)
  end
  return stats_hash
end

.update_functions ⇒ Object 



1127
1128
1129
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1127

def self.update_functions
  ActiveRecord::Base.connection.execute(File.read("#{Gem.loaded_specs["zuora_connect"].gem_dir}/app/views/sql/refresh_aggregate_table.txt"))
end

.write_to_telegraf(*args) ⇒ Object 



398
399
400
401
402
403
404
405
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 398

def self.write_to_telegraf(*args)
  if ZuoraConnect.configuration.enable_metrics
    @@telegraf_host = ZuoraConnect::Telegraf.new() if @@telegraf_host == nil
    unicorn_stats = self.unicorn_listener_stats() if defined?(Unicorn) && Unicorn.respond_to?(:listener_names)
    @@telegraf_host.write(direction: 'Raindrops', tags: {}, values: unicorn_stats)  unless unicorn_stats.blank?
    return @@telegraf_host.write(*args)
  end
end

Instance Method Details

#apartment_switch(method = nil, migrate = false) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 99

def apartment_switch(method = nil, migrate = false)
  switch_count ||= 0
  if self.persisted?
    begin
      Apartment::Tenant.switch!(self.id)
    rescue Apartment::TenantNotFound => ex
      sleep(2)
      begin
        Apartment::Tenant.create(self.id.to_s)
      rescue Apartment::TenantExists => ex
      end
      if (switch_count += 1) < 2
        retry
      else
        raise
      end
    end
    if migrate && ActiveRecord::Migrator.needs_migration?
      Apartment::Migrator.migrate(self.id)
    end
  end
  Thread.current[:appinstance] = self
end

#api_limit(start: true, time: API_LIMIT_TIMEOUT.to_i) ⇒ Object

START Resque Helping Methods ####



842
843
844
845
846
847
848
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 842

def api_limit(start: true, time: API_LIMIT_TIMEOUT.to_i)
  if start
    Redis.current.zadd("APILimits", Time.now.to_i + time, self.id)
  else
    Redis.current.zrem("APILimits", self.id)
  end
end

#api_limit? ⇒ Boolean

Returns:

  • (Boolean) 


850
851
852
853
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 850

def api_limit?
  Redis.current.zremrangebyscore("APILimits", "0", "(#{Time.now.to_i}")
  return Redis.current.zscore("APILimits", self.id).present?
end

#attr_builder(field, val) ⇒ Object 



1179
1180
1181
1182
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1179

def attr_builder(field,val)
  singleton_class.class_eval { attr_accessor "#{field}" }
  send("#{field}=", val)
end

#aws_auth_client ⇒ Object 



380
381
382
383
384
385
386
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 380

def aws_auth_client
  if Rails.env.to_s == 'development'
    return Aws::Credentials.new(Rails.application.secrets.aws['AWS_ACCESS_KEY_ID'], Rails.application.secrets.aws['AWS_SECRET_ACCESS_KEY'])
  else
    return nil
  end
end

#build_task(task_data: {}, session: {}) ⇒ Object

START Task Methods ####



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
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 476

def build_task(task_data: {}, session: {})
  session = {} if session.blank?
  self.task_data = task_data
  self.mode = self.task_data["mode"]

  if task_data['id'].to_s != self.id.to_s
    raise ZuoraConnect::Exceptions::MissMatch.new("Wrong Instance Identifier/Lookup")
  end

  self.task_data.each do |k,v|
    if k.match(/^(.*)_login$/)
      tmp = ZuoraConnect::Login.new(v)
      if v["tenant_type"] == "Zuora"
        if tmp.entities.size > 0
          tmp.entities.each do |value|
            entity_id = value["id"]
            tmp.client(entity_id).current_session          = session["#{self.id}::#{k}::#{entity_id}:current_session"]               if session["#{self.id}::#{k}::#{entity_id}:current_session"]
            tmp.client(entity_id).bearer_token             = session["#{self.id}::#{k}::#{entity_id}:bearer_token"]                  if session["#{self.id}::#{k}::#{entity_id}:bearer_token"]
            tmp.client(entity_id).oauth_session_expires_at = session["#{self.id}::#{k}::#{entity_id}:oauth_session_expires_at"]      if session["#{self.id}::#{k}::#{entity_id}:oauth_session_expires_at"]
          end
        else
          tmp.client.current_session                       = session["#{self.id}::#{k}:current_session"]                             if session["#{self.id}::#{k}:current_session"]
          tmp.client.bearer_token                          = session["#{self.id}::#{k}:bearer_token"]                                if session["#{self.id}::#{k}:bearer_token"] && tmp.client.respond_to?(:bearer_token) ## need incase session id goes from basic to aouth in same redis store
          tmp.client.oauth_session_expires_at              = session["#{self.id}::#{k}:oauth_session_expires_at"]                    if session["#{self.id}::#{k}:oauth_session_expires_at"]  && tmp.client.respond_to?(:oauth_session_expires_at)
        end
      end
      self.logins[k] = tmp
      self.attr_builder(k, @logins[k])
    elsif k == "options"
      v.each do |opt|
        self.options[opt["config_name"]] = opt
      end
    elsif k == "user_settings"
      self.timezone =  v["timezone"]
      self.locale = v["local"]
    end
  end
rescue ZuoraConnect::Exceptions::MissMatch => ex
  raise
rescue ZuoraConnect::Exceptions::InvalidCredentialSet => ex 
  raise
rescue => ex
  ZuoraConnect.logger.error("Build Task Error", ex)
  ZuoraConnect.logger.error("Task Data: #{task_data}") if task_data.present?
  if session.present?
    ZuoraConnect.logger.error("Task Session: #{session.to_h}")  if session.methods.include?(:to_h)
    ZuoraConnect.logger.error("Task Session: #{session.to_hash}") if session.methods.include?(:to_hash)
  end
  raise
end

#cache_app_instance ⇒ Object 



754
755
756
757
758
759
760
761
762
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 754

def cache_app_instance
  if defined?(Redis.current)
    #Task data must be present and the last refresh cannot be old. We dont want to overwite new cache data with old
    if self.task_data.present? &&  (self.last_refresh.to_i > INSTANCE_REFRESH_WINDOW.ago.to_i)
      ZuoraConnect.logger.debug("Caching AppInstance", self.default_ougai_items)
      Redis.current.setex("AppInstance:#{self.id}", INSTANCE_REDIS_CACHE_PERIOD.to_i, self.encrypt_data(data: self.save_data))
    end
  end
end

#catalog_loaded? ⇒ Boolean

Returns:

  • (Boolean) 


944
945
946
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 944

def catalog_loaded?
  return ActiveRecord::Base.connection.execute('SELECT id FROM "public"."zuora_connect_app_instances" WHERE "id" = %s AND catalog = \'{}\' LIMIT 1' % [self.id]).first.nil?
end

#catalog_lookup(entity_id: nil, object: :product, object_id: nil, child_objects: false, cache: false) ⇒ Object

Catalog lookup provides method to lookup zuora catalog efficiently. entity_id: If the using catalog json be field to store multiple entity product catalogs. object: The Object class desired to be returned. Available [:product, :rateplan, :charge] object_id: The id or id’s of the object/objects to be returned. child_objects: Whether to include child objects of the object in question. cache: Store individual “1” object lookup in redis for caching.



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
985
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
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 954

def catalog_lookup(entity_id: nil, object: :product, object_id: nil, child_objects: false, cache: false)
  entity_reference = entity_id.blank? ? 'Default' : entity_id

  if object_id.present? && ![Array, String].include?(object_id.class)
    raise "Object Id can only be a string or an array of strings"
  end

  if defined?(Redis.current) && object_id.present? && object_id.class == String && object_id.present?
    stub_catalog = cache ? decrypt_data(data: Redis.current.get("Catalog:#{self.id}:#{object_id}:Children:#{child_objects}")) : nil
    object_hierarchy = decrypt_data(data: Redis.current.get("Catalog:#{self.id}:#{object_id}:Hierarchy"))
  end

  if defined?(object_hierarchy)
    object_hierarchy ||= (JSON.parse(ActiveRecord::Base.connection.execute('SELECT catalog_mapping #> \'{%s}\' AS item FROM "public"."zuora_connect_app_instances" WHERE "id" = %s LIMIT 1' % [entity_reference, self.id]).first["item"] || "{}") [object_id] || {"productId" => "SAFTEY", "productRatePlanId" => "SAFTEY", "productRatePlanChargeId" => "SAFTEY"})
  end

  case object
  when :product
    if object_id.nil?
      string =
        "SELECT "\
          "json_object_agg(product_id, product #{child_objects ? '' : '- \'productRatePlans\''}) AS item "\
        "FROM "\
          "\"public\".\"zuora_connect_app_instances\", "\
          "jsonb_each((\"public\".\"zuora_connect_app_instances\".\"catalog\" #> '{%s}' )) AS e(product_id, product) "\
        "WHERE "\
          "\"id\" = %s" % [entity_reference, self.id]
    else
      if object_id.class == String
        string =
          "SELECT "\
            "(catalog #> '{%s, %s}') #{child_objects ? '' : '- \'productRatePlans\''} AS item "\
          "FROM "\
            "\"public\".\"zuora_connect_app_instances\" "\
          "WHERE "\
            "\"id\" = %s" % [entity_reference, object_id.blank? ? BLANK_OBJECT_ID_LOOKUP : object_id, self.id]
      elsif object_id.class == Array
        string =
          "SELECT "\
            "json_object_agg(product_id, product #{child_objects ? '' : '- \'productRatePlans\''}) AS item "\
          "FROM "\
            "\"public\".\"zuora_connect_app_instances\", "\
            "jsonb_each((\"public\".\"zuora_connect_app_instances\".\"catalog\" #> '{%s}' )) AS e(product_id, product) "\
          "WHERE "\
            "\"product_id\" IN (\'%s\') AND "\
            "\"id\" = %s" % [entity_reference, object_id.join("\',\'"), self.id]
      end
    end

  when :rateplan
    if object_id.nil?
      string =
        "SELECT "\
          "json_object_agg(rateplan_id, rateplan #{child_objects ? '' : '- \'productRatePlanCharges\''}) AS item "\
        "FROM "\
          "\"public\".\"zuora_connect_app_instances\", "\
          "jsonb_each((\"public\".\"zuora_connect_app_instances\".\"catalog\" #> '{%s}' )) AS e(product_id, product), "\
          "jsonb_each(product #> '{productRatePlans}') AS ee(rateplan_id, rateplan) "\
        "WHERE "\
          "\"id\" = %s" % [entity_reference, self.id]
    else
      if object_id.class == String
        string =
          "SELECT "\
            "(catalog #> '{%s, %s, productRatePlans, %s}') #{child_objects ? '' : '- \'productRatePlanCharges\''} AS item "\
          "FROM "\
            "\"public\".\"zuora_connect_app_instances\" "\
          "WHERE "\
            "\"id\" = %s" % [entity_reference, object_hierarchy['productId'], object_id.blank? ? BLANK_OBJECT_ID_LOOKUP : object_id,  self.id]
      elsif object_id.class == Array
        string =
          "SELECT "\
            "json_object_agg(rateplan_id, rateplan #{child_objects ? '' : '- \'productRatePlanCharges\''}) AS item "\
          "FROM "\
            "\"public\".\"zuora_connect_app_instances\", "\
            "jsonb_each((\"public\".\"zuora_connect_app_instances\".\"catalog\" #> '{%s}' )) AS e(product_id, product), "\
            "jsonb_each(product #> '{productRatePlans}') AS ee(rateplan_id, rateplan) "\
          "WHERE "\
            "\"rateplan_id\" IN (\'%s\') AND "\
            "\"id\" = %s" % [entity_reference, object_id.join("\',\'"), self.id]
      end
    end

  when :charge
    if object_id.nil?
      string =
        "SELECT "\
          "json_object_agg(charge_id, charge) as item "\
        "FROM "\
          "\"public\".\"zuora_connect_app_instances\", "\
          "jsonb_each((\"public\".\"zuora_connect_app_instances\".\"catalog\" #> '{%s}' )) AS e(product_id, product), "\
          "jsonb_each(product #> '{productRatePlans}') AS ee(rateplan_id, rateplan), "\
          "jsonb_each(rateplan #> '{productRatePlanCharges}') AS eee(charge_id, charge) "\
        "WHERE "\
          "\"id\" = %s" % [entity_reference, self.id]
    else
      if object_id.class == String
        string =
          "SELECT "\
            "catalog #> '{%s, %s, productRatePlans, %s, productRatePlanCharges, %s}' AS item "\
          "FROM "\
            "\"public\".\"zuora_connect_app_instances\" "\
          "WHERE "\
            "\"id\" = %s" % [entity_reference, object_hierarchy['productId'], object_hierarchy['productRatePlanId'], object_id.blank? ? BLANK_OBJECT_ID_LOOKUP : object_id , self.id]

      elsif object_id.class == Array
        string =
          "SELECT "\
            "json_object_agg(charge_id, charge) AS item "\
          "FROM "\
            "\"public\".\"zuora_connect_app_instances\", "\
            "jsonb_each((\"public\".\"zuora_connect_app_instances\".\"catalog\" #> '{%s}' )) AS e(product_id, product), "\
            "jsonb_each(product #> '{productRatePlans}') AS ee(rateplan_id, rateplan), "\
            "jsonb_each(rateplan #> '{productRatePlanCharges}') AS eee(charge_id, charge) "\
          "WHERE "\
            "\"charge_id\" IN (\'%s\') AND "\
            "\"id\" = %s" % [entity_reference, object_id.join("\',\'"), self.id]
      end
    end
  else
    raise "Available objects include [:product, :rateplan, :charge]"
  end

  stub_catalog ||= JSON.parse(ActiveRecord::Base.connection.execute(string).first["item"] || "{}")

  if defined?(Redis.current) && object_id.present? && object_id.class == String && object_id.present?
    if cache
      Redis.current.sadd("Catalog:#{self.id}:Keys", ["Catalog:#{self.id}:#{object_id}:Hierarchy", "Catalog:#{self.id}:#{object_id}:Children:#{child_objects}"])
      Redis.current.set("Catalog:#{self.id}:#{object_id}:Hierarchy", encrypt_data(data: object_hierarchy))
      Redis.current.set("Catalog:#{self.id}:#{object_id}:Children:#{child_objects}", encrypt_data(data: stub_catalog))
    else
      Redis.current.sadd("Catalog:#{self.id}:Keys", ["Catalog:#{self.id}:#{object_id}:Hierarchy"])
      Redis.current.set("Catalog:#{self.id}:#{object_id}:Hierarchy", encrypt_data(data: object_hierarchy))
    end
  end

  return stub_catalog
end

#catalog_outdated?(time: Time.now - 12.hours) ⇒ Boolean

Returns:

  • (Boolean) 


940
941
942
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 940

def catalog_outdated?(time: Time.now - 12.hours)
  return self.catalog_updated_at.blank? || (self.catalog_updated_at < time)
end

#check_oauth_state(method = nil) ⇒ Object

START Connect OAUTH Methods ####



635
636
637
638
639
640
641
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 635

def check_oauth_state(method=nil)
  #Refresh token if already expired
  if self.oauth_expired?
    ZuoraConnect.logger.debug("Before '#{method}' method, Oauth expired", self.default_ougai_items)
    self.refresh_oauth
  end
end

#data_lookup(session: {}) ⇒ Object 



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 726

def data_lookup(session: {})
  if defined?(Redis.current)
    begin
      redis_get_command ||= 0
      cached_instance = Redis.current.get("AppInstance:#{self.id}")
    rescue *(ZuoraAPI::Login::CONNECTION_EXCEPTIONS + ZuoraAPI::Login::CONNECTION_READ_EXCEPTIONS) => ex
      if (redis_get_command += 1) < 3
        retry
      else
        raise
      end
    end
    if cached_instance.blank?
      ZuoraConnect.logger.debug("Cached AppInstance Missing", self.default_ougai_items)
      return session
    else
      ZuoraConnect.logger.debug("Cached AppInstance Found", self.default_ougai_items)
      return decrypt_data(data: cached_instance, rescue_return: session).merge(session)
    end
  else
    return session
  end
end

#decrypt_data(data: nil, rescue_return: nil, log_fatal: true) ⇒ Object 



810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 810

def decrypt_data(data: nil, rescue_return: nil, log_fatal: true)
  return data if data.blank?
  if Rails.env == 'development'
    begin
      return JSON.parse(data)
    rescue JSON::ParserError => ex
      return data
    end
  else
    begin
      return JSON.parse(encryptor.decrypt_and_verify(CGI::unescape(data)))
    rescue ActiveSupport::MessageVerifier::InvalidSignature => ex
      ZuoraConnect.logger.error("Error Decrypting", ex, self.default_ougai_items) if log_fatal
      return rescue_return
    rescue JSON::ParserError => ex
      ZuoraConnect.logger.error("JSON Parse Error", ex, self.default_ougai_items) if log_fatal
      return encryptor.decrypt_and_verify(CGI::unescape(data))
    end
  end
end

#default_ougai_items ⇒ Object 



123
124
125
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 123

def default_ougai_items
  return {app_instance_id: self.id}
end

#delete_app_instance ⇒ Object 



750
751
752
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 750

def delete_app_instance
  Redis.current.del("AppInstance:#{self.id}")
end

#drop_instance ⇒ Object

Method for overiding droping of an app instance



1145
1146
1147
1148
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1145

def drop_instance
  self.drop_message = 'Ok to drop'
  return true
end

#encrypt_data(data: nil) ⇒ Object 



831
832
833
834
835
836
837
838
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 831

def encrypt_data(data: nil)
  return data if data.blank?
  if Rails.env == 'development'
    return data.to_json
  else
    return encryptor.encrypt_and_sign(data.to_json)
  end
end

#encryptor ⇒ Object

Raises:



801
802
803
804
805
806
807
808
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 801

def encryptor
  # Default values for Rails 4 apps
  key_iter_num, key_size, salt, signed_salt = [1000, 64, "encrypted cookie", "signed encrypted cookie"]
  raise ZuoraConnect::Exceptions::Error.new("'secret_key_base' is not set for rails environment '#{Rails.env}'. Please set in secrets file.") if Rails.application.secrets.secret_key_base.blank?
  key_generator = ActiveSupport::KeyGenerator.new(Rails.application.secrets.secret_key_base, iterations: key_iter_num)
  secret, sign_secret = [key_generator.generate_key(salt, 32), key_generator.generate_key(signed_salt)]
  return ActiveSupport::MessageEncryptor.new(secret, sign_secret)
end

#fetch_org_details(debug: false) ⇒ Object 



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
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 566

def fetch_org_details(debug: false)
  details_count ||= 0
  self.new_session if !defined?(self.)

  response = HTTParty.get("#{ZuoraConnect.configuration.url}/api/#{self.api_version}/tenants/search?hostname=#{self..client.hostname}&node_id=#{self.zuora_entity_ids.first}")
 
  if response.success?
    parsed_json =  JSON.parse(response.body)
    
    #Set Org
    if self.id >= 25000000 && parsed_json['organization'].blank?
      self.zuora_logins = self.zuora_logins.merge({'organization' => [parsed_json['organization']]})
    end
    if defined?(ZuoraConnect::AppInstance::CONNECT_APPLICATION_ID)
      downloads = parsed_json.fetch('downloads',[]).select{|a| a['applicationId'] == ZuoraConnect::AppInstance::CONNECT_APPLICATION_ID }.map { |h| h.slice('Name', 'provisionState') }
      Rails.logger.info("Instance Downloads: #{downloads.to_s}") if debug
      if downloads.size > 1
        self.provision_status = 'MultipleProvisioningRecords'
        self.provisioned_app = downloads.map {|d| d['Name']}.to_s
      elsif downloads.size == 1
        self.provision_status = downloads.first['provisionState']
        self.provisioned_app = downloads.first['Name']
      else
        self.provision_status = 'NoProvisioningRecords'
        self.provisioned_app = nil
      end
    end
    self.save(:validate => false)
   
    return parsed_json
  end
rescue *(ZuoraAPI::Login::CONNECTION_EXCEPTIONS + ZuoraAPI::Login::CONNECTION_READ_EXCEPTIONS) => ex
  if (details_count += 1) < 3
    retry
  else
    raise
  end
end

#get_catalog(page_size: 5, zuora_login: self.login_lookup(type: "Zuora").first, entity_id: nil) ⇒ Object

START Catalog Helping Methods #####



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
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 881

def get_catalog(page_size: 5, zuora_login: self.(type: "Zuora").first, entity_id: nil)
  self.update_column(:catalog_update_attempt_at, Time.now.utc)

  entity_reference = entity_id.blank? ? 'Default' : entity_id
  ZuoraConnect.logger.debug("Fetch Catalog")
  ZuoraConnect.logger.debug("Zuora Entity: #{entity_id.blank? ? 'default' : entity_id}")

   = .client(entity_id)

  old_logger = ActiveRecord::Base.logger
  ActiveRecord::Base.logger = nil
  ActiveRecord::Base.connection.execute('UPDATE "public"."zuora_connect_app_instances" SET "catalog" = jsonb_set("catalog", \'{tmp}\', \'{}\'), "catalog_mapping" = jsonb_set("catalog_mapping", \'{tmp}\', \'{}\') where "id" = %{id}' % {:id => self.id})

  response = {'nextPage' => .rest_endpoint("catalog/products?pageSize=#{page_size}")}
  while !response["nextPage"].blank?
    url = .rest_endpoint(response["nextPage"].split('/v1/').last)
    ZuoraConnect.logger.debug("Fetch Catalog URL #{url}")
    output_json, response = .rest_call(:debug => false, :url => url, :timeout_retry => true)

    output_json["products"].each do |product|
      ActiveRecord::Base.connection.execute('UPDATE "public"."zuora_connect_app_instances" SET "catalog_mapping" = jsonb_set("catalog_mapping", \'{tmp, %s}\', \'%s\') where "id" = %s' % [product["id"], {"productId" => product["id"]}.to_json.gsub("'", "''"), self.id])
      rateplans = {}

      product["productRatePlans"].each do |rateplan|
        ActiveRecord::Base.connection.execute('UPDATE "public"."zuora_connect_app_instances" SET "catalog_mapping" = jsonb_set("catalog_mapping", \'{tmp, %s}\', \'%s\') where "id" = %s' % [rateplan["id"],  {"productId" => product["id"], "productRatePlanId" => rateplan["id"]}.to_json.gsub("'", "''"), self.id])
        charges = {}

        rateplan["productRatePlanCharges"].each do |charge|
          ActiveRecord::Base.connection.execute('UPDATE "public"."zuora_connect_app_instances" SET "catalog_mapping" = jsonb_set("catalog_mapping", \'{tmp, %s}\', \'%s\') where "id" = %s' % [charge["id"],  {"productId" => product["id"], "productRatePlanId" => rateplan["id"], "productRatePlanChargeId" => charge["id"]}.to_json.gsub("'", "''"), self.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

      ActiveRecord::Base.connection.execute('UPDATE "public"."zuora_connect_app_instances" SET "catalog" = jsonb_set("catalog", \'{tmp, %s}\', \'%s\') where "id" = %s' % [product["id"], product.to_json.gsub("'", "''"), self.id])
    end
  end

  # Move from tmp to actual
  ActiveRecord::Base.connection.execute('UPDATE "public"."zuora_connect_app_instances" SET "catalog" = jsonb_set("catalog", \'{%{entity}}\', "catalog" #> \'{tmp}\'), "catalog_mapping" = jsonb_set("catalog_mapping", \'{%{entity}}\',  "catalog_mapping" #> \'{tmp}\') where "id" = %{id}' % {:entity => entity_reference, :id => self.id})
  if defined?(Redis.current)
    catalog_keys = Redis.current.smembers("Catalog:#{self.id}:Keys")
    Redis.current.del(catalog_keys.push("Catalog:#{self.id}:Keys"))
  end
  # Clear tmp holder
  ActiveRecord::Base.connection.execute('UPDATE "public"."zuora_connect_app_instances" SET "catalog" = jsonb_set("catalog", \'{tmp}\', \'{}\'), "catalog_mapping" = jsonb_set("catalog_mapping", \'{tmp}\', \'{}\') where "id" = %{id}' % {:id => self.id})

  ActiveRecord::Base.logger = old_logger
  self.update_column(:catalog_updated_at, Time.now.utc)
  self.touch

  # DO NOT RETURN CATALOG. THIS IS NOT SCALABLE WITH LARGE CATALOGS. USE THE  CATALOG_LOOKUP method provided
  return true
end

#get_s3_file_url(key) ⇒ Object 



1110
1111
1112
1113
1114
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1110

def get_s3_file_url(key)
  require 'aws-sdk-s3'
  signer = Aws::S3::Presigner.new(client: self.s3_client)
  url = signer.presigned_url(:get_object, bucket: ZuoraConnect.configuration.s3_bucket_name, key: "#{ZuoraConnect.configuration.s3_folder_name}/#{self.id.to_s}/#{key}")
end

#init ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 36

def init
  self.connect_user = 'Nobody'
  self.logitems = {}
  self.task_data = {}
  self.options = Hash.new
  self.logins = Hash.new
  self.api_version = "v2"
  self.attr_builder("timezone", ZuoraConnect.configuration.default_time_zone)
  self.attr_builder("locale", ZuoraConnect.configuration.default_locale)
  PaperTrail.whodunnit = "Backend" if defined?(PaperTrail)
  if defined?(ElasticAPM) && ElasticAPM.running?
    ElasticAPM.set_user("Backend")
    if ElasticAPM.respond_to?(:set_label)
      ElasticAPM.set_label(:app_instance, self.id)
    else
      ElasticAPM.set_label(:app_instance, self.id)
    end
  end

  if INSTANCE_REFRESH_WINDOW > INSTANCE_REDIS_CACHE_PERIOD
    raise "The instance refresh window cannot be greater than the instance cache period"
  end
  self.apartment_switch(nil, false)
end

#initialize_redis_placeholders ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 61

def initialize_redis_placeholders
  if defined?(Redis.current)
    unless Redis.current.zscore("AppInstance:Deleted", "placeholder").present? # O(1)
      Redis.current.zadd("AppInstance:Deleted", 9_999_999_999, "placeholder") # O(log(N))
    end
    if self.id.present?
      if Redis.current.zscore("AppInstance:Deleted", self.id).present? # O(1)
        Redis.current.zrem("AppInstance:Deleted", self.id) # O(log(N))
      end
    end
    unless Redis.current.zscore("APILimits", "placeholder").present? # O(1)
      Redis.current.zadd("APILimits", 9_999_999_999, "placeholder") # O(log(N))
    end
    unless Redis.current.zscore("InstanceRefreshing", "placeholder").present? # O(1)
      Redis.current.zadd("InstanceRefreshing", 9_999_999_999, "placeholder") # O(log(N))
    end
  end
  if defined?(Resque.redis)
    unless Resque.redis.zscore("PauseQueue", "placeholder").present? # O(1)
      Resque.redis.zadd("PauseQueue", 9_999_999_999, "placeholder") # O(log(N))
    end
  end
  true
end

#instance_failure(failure) ⇒ Object 



1160
1161
1162
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1160

def instance_failure(failure)
  raise failure
end

#kms_decrypt(value) ⇒ Object 



345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 345

def kms_decrypt(value)
  kms_tries ||= 0
  kms_client = Aws::KMS::Client.new({region: Rails.application.secrets.aws['AWS_REGION'], credentials: self.aws_auth_client}.delete_if { |k, v| v.blank? })
  resp = kms_client.decrypt({ciphertext_blob: [value].pack("H*") })
  return resp.plaintext
rescue *AWS_AUTH_ERRORS => ex
  if (kms_tries += 1) < 3
    Rails.logger.warn(AWS_AUTH_ERRORS_MSG, ex)
    retry
  else
    Rails.logger.error(AWS_AUTH_ERRORS_MSG, ex)
    raise
  end
end

#kms_encrypt(value) ⇒ Object 



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 360

def kms_encrypt(value)
  kms_tries ||= 0
  kms_client = Aws::KMS::Client.new({region: Rails.application.secrets.aws['AWS_REGION'], credentials: self.aws_auth_client}.delete_if {|k,v| v.blank? })

  resp = kms_client.encrypt({key_id: kms_key, plaintext: value})
  return resp.ciphertext_blob.unpack('H*').first
rescue *AWS_AUTH_ERRORS => ex
  if (kms_tries += 1) < 3
    Rails.logger.warn(AWS_AUTH_ERRORS_MSG, ex)
    retry
  else
    Rails.logger.error(AWS_AUTH_ERRORS_MSG, ex)
    raise
  end
end

#kms_key ⇒ Object 



376
377
378
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 376

def kms_key
  return ENV['AWS_KMS_ARN'] || Rails.application.secrets.dig(:aws,'AWS_KMS_ARN')
end

#login_lookup(type: "Zuora") ⇒ Object 



1167
1168
1169
1170
1171
1172
1173
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1167

def (type: "Zuora")
  results = []
  self.logins.each do |name, |
    results <<  if .tenant_type == type
  end
  return results
end

#logitem(item: {}, reset: false) ⇒ Object

START Metrics Methods ####



390
391
392
393
394
395
396
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 390

def logitem(item: {}, reset: false)
  self.logitems = {} if self.logitems.class != Hash
  if item.class == Hash
    self.logitems = reset ? item : self.logitems.merge(item)
  end
  Thread.current[:appinstance] = self
end

#mark_for_refresh ⇒ Object 



722
723
724
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 722

def mark_for_refresh
  return defined?(Redis.current) ? Redis.current.zadd("InstanceRefreshing", Time.now.to_i + REFRESH_TIMEOUT.to_i, self.id, {:nx => true}) : true
end

#marked_for_refresh? ⇒ Boolean

START AppInstance Temporary Persistance Methods ####

Returns:

  • (Boolean) 


696
697
698
699
700
701
702
703
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 696

def marked_for_refresh?
  if defined?(Redis.current)
    Redis.current.zremrangebyscore("InstanceRefreshing", "0", "(#{Time.now.to_i}")
    return Redis.current.zscore("InstanceRefreshing", self.id).present?
  else
    return false
  end
end

#new_session(session: self.data_lookup, username: self.access_token, password: self.refresh_token, holding_pattern: false, **args) ⇒ Object 



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
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
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 127

def new_session(session: self.data_lookup, username: self.access_token, password: self.refresh_token, holding_pattern: false, **args)
  self.api_version = "v2"
  self.username = username
  self.password = password
  self.last_refresh = session["#{self.id}::last_refresh"]
  self.connect_user = session["#{self.id}::user::email"] if session["#{self.id}::user::email"].present?
  PaperTrail.whodunnit = self.connect_user if defined?(PaperTrail)
  ElasticAPM.set_user(self.connect_user)   if defined?(ElasticAPM) && ElasticAPM.running?
  recoverable_session = false

  ## DEV MODE TASK DATA MOCKUP
  if ZuoraConnect.configuration.mode != "Production"
    mock_task_data = {
      "id" => ZuoraConnect.configuration.dev_mode_appinstance,
      "mode" => ZuoraConnect.configuration.dev_mode_mode
    }

    case ZuoraConnect.configuration.dev_mode_options.class
    when Hash
      self.options = ZuoraConnect.configuration.dev_mode_options
    when Array
      mock_task_data["options"] = ZuoraConnect.configuration.dev_mode_options
    end

    ZuoraConnect.configuration.dev_mode_logins.each do |k,v|
      v = v.merge({"entities": [] }) if !v.keys.include?("entities")
      mock_task_data[k] = v
    end

    self.build_task(task_data: mock_task_data, session: session)
  else
    time_expire = (session["#{self.id}::last_refresh"] || Time.now).to_i - INSTANCE_REFRESH_WINDOW.ago.to_i

    if session.empty?
      self.new_session_message = "REFRESHING - Session Empty"
      ZuoraConnect.logger.debug(self.new_session_message, self.default_ougai_items)
      raise ZuoraConnect::Exceptions::HoldingPattern if holding_pattern && !self.mark_for_refresh
      self.refresh(session: session)

    elsif (self.id != session["appInstance"].to_i)
      self.new_session_message = "REFRESHING - AppInstance ID(#{self.id}) does not match session id(#{session["appInstance"].to_i})"
      ZuoraConnect.logger.debug(self.new_session_message, self.default_ougai_items)
      raise ZuoraConnect::Exceptions::HoldingPattern if holding_pattern && !self.mark_for_refresh
      self.refresh(session: session)

    elsif session["#{self.id}::task_data"].blank?
      self.new_session_message = "REFRESHING - Task Data Blank"
      ZuoraConnect.logger.debug(self.new_session_message, self.default_ougai_items)
      raise ZuoraConnect::Exceptions::HoldingPattern if holding_pattern && !self.mark_for_refresh
      self.refresh(session: session)

    elsif session["#{self.id}::last_refresh"].blank?
      self.new_session_message = "REFRESHING - No Time on Cookie"
      recoverable_session = true
      ZuoraConnect.logger.debug(self.new_session_message, self.default_ougai_items)
      raise ZuoraConnect::Exceptions::HoldingPattern if holding_pattern && !self.mark_for_refresh
      self.refresh(session: session)

    # If the cache is expired and we can aquire a refresh lock
    elsif (session["#{self.id}::last_refresh"].to_i < INSTANCE_REFRESH_WINDOW.ago.to_i) && self.mark_for_refresh
      self.new_session_message = "REFRESHING - Session Old by #{time_expire.abs} second"
      recoverable_session = true
      ZuoraConnect.logger.debug(self.new_session_message, self.default_ougai_items)
      self.refresh(session: session)

    else
      if time_expire < 0
        self.new_session_message = ["REBUILDING - Expired by #{time_expire} seconds", self.marked_for_refresh? ? " cache updating as of #{self.reset_mark_refreshed_at} seconds ago" : nil].compact.join(',')
      else
        self.new_session_message = "REBUILDING - Expires in #{time_expire} seconds"
      end
      ZuoraConnect.logger.debug(self.new_session_message, self.default_ougai_items)
      self.build_task(task_data: session["#{self.id}::task_data"], session: session)
    end
  end
  return self
rescue ZuoraConnect::Exceptions::HoldingPattern => ex
  while self.marked_for_refresh?
    ZuoraConnect.logger.info("Holding - Expires in #{self.reset_mark_expires_at}. '#{self.new_session_message}'", self.default_ougai_items)
    sleep(HOLDING_PATTERN_SLEEP)
  end
  self.reload_attributes([:refresh_token, :oauth_expires_at, :access_token])
  session = self.data_lookup(session: session)
  retry
rescue ZuoraConnect::Exceptions::MissMatch => ex
  self.delete_app_instance
  session = {}
  ZuoraConnect.logger.error(ex, self.default_ougai_items.merge({app_instance_id_new: self.task_data['id']}))
  retry
rescue ZuoraConnect::Exceptions::InvalidCredentialSet => ex
  raise
rescue => ex
  if recoverable_session
    ZuoraConnect.logger.warn("REBUILDING - Using backup expired cache", ex, self.default_ougai_items)
    self.build_task(task_data: session["#{self.id}::task_data"], session: session)
    return self
  else
    ZuoraConnect.logger.error("Failed new session", ex, self.default_ougai_items)
    raise
  end
ensure
  begin
    I18n.locale = self.locale
  rescue I18n::InvalidLocale => ex
    ZuoraConnect.logger.error(ex) if !IGNORED_LOCALS.include?(ex.locale.to_s.downcase)
  end
  Time.zone = self.timezone
  if self.task_data.present?
    tenants = self.task_data.fetch('tenant_ids', [])
    organizations = self.task_data.fetch('organizations', [])
    if defined?(ElasticAPM) && ElasticAPM.running?
      if ElasticAPM.respond_to?(:set_label)
        ElasticAPM.set_label(:tenant_id, tenants.first)
        ElasticAPM.set_label(:organization, organizations.first)
      else
        ElasticAPM.set_label(:tenant_id, tenants.first)
        ElasticAPM.set_label(:organization, organizations.first)
      end
    end
    self.logitem(item: {tenant_ids: tenants, organization: organizations})

    params = {
      :name => self.task_data.dig('name'), 
      :zuora_entity_ids => (self.task_data.dig(LOGIN_TENANT_DESTINATION,'entities') || []).map{|e| e['id']}.uniq,
      :zuora_tenant_ids => tenants.map(&:to_s).uniq,
    }
    if self.methods.include?(LOGIN_TENANT_DESTINATION.to_sym)
      client = self.send(LOGIN_TENANT_DESTINATION).client
      if defined?(client.rest_domain)
        zuora_domain = client.rest_domain 
        ZuoraConnect::RequestIdMiddleware.zuora_rest_domain = zuora_domain
        params.merge!({:zuora_domain => zuora_domain }) 
      end
    end
    params = params.reject{|k,v| !self.attributes.keys.member?(k.to_s) || self[k] == v}
    self.update_columns(params) if params.present?
  end
end

#new_session_for_api_requests(params: {}) ⇒ Object

Overide this method to avoid the new session call for api requests that use the before filter authenticate_app_api_request. This can be usefull for apps that dont need connect metadata call, or credentials, to operate for api requests



1134
1135
1136
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1134

def new_session_for_api_requests(params: {})
  return true
end

#new_session_for_ui_requests(params: {}) ⇒ Object

Overide this method to avoid the new session call for ui requests that use the before filter authenticate_connect_app_request. This can be usefull for apps that dont need connect metadata call, or credentials, to operate for ui requests



1140
1141
1142
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1140

def new_session_for_ui_requests(params: {})
  return true
end

#oauth_expired? ⇒ Boolean

Returns:

  • (Boolean) 


643
644
645
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 643

def oauth_expired?
  return self.oauth_expires_at.present? ? (self.oauth_expires_at < Time.now.utc) : true
end

#prune_data ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 86

def prune_data
  if defined?(Redis.current)
    Redis.current.zadd("AppInstance:Deleted", Time.now.to_i, self.id)
    Redis.current.del("AppInstance:#{self.id}")
    Redis.current.zrem("APILimits", self.id)
    Redis.current.zrem("InstanceRefreshing", self.id)
  end
  if defined?(Resque.redis)
    Resque.redis.zrem("PauseQueue", self.id)
  end
  return true
end

#queue_pause(time: nil, current_user: 'Default') ⇒ Object 



860
861
862
863
864
865
866
867
868
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 860

def queue_pause(time: nil, current_user: 'Default')
  key = "#{self.id}__#{current_user}"
  if time.present?
    raise "Time must be integer of seconds instead of #{time.class}." if !['Integer', 'Fixnum'].include?(time.class.to_s)
    Resque.redis.zadd("PauseQueue", Time.now.to_i + time, key)
  else
    Resque.redis.zadd("PauseQueue", 9999999999, key)
  end
end

#queue_paused? ⇒ Boolean

Returns:

  • (Boolean) 


855
856
857
858
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 855

def queue_paused?
  Resque.redis.zremrangebyscore("PauseQueue", "0", "(#{Time.now.to_i}")
  return Resque.redis.zrange("PauseQueue", 0, -1).map {|key| key.split("__")[0]}.include?(self.id.to_s)
end

#queue_start(current_user: 'Default') ⇒ Object 



870
871
872
873
874
875
876
877
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 870

def queue_start(current_user: 'Default')
  paused_user = Resque.redis.zrange("PauseQueue", 0, -1).map {|key| key.split("__")[0] == "#{self.id}" ? key.split("__")[1] : nil}.compact.first
  if paused_user == current_user || paused_user.blank?
    Resque.redis.zrem("PauseQueue", "#{self.id}__#{paused_user}")
  else
    raise "Can only unpause for user #{paused_user}."
  end
end

#refresh(session: {}) ⇒ Object 



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 266

def refresh(session: {}) 
  refresh_count ||= 0
  skip_connect ||= false
  begin
    #Check how app was deployed
    if self.id < 25000000 && !skip_connect 
      self.check_oauth_state
      start = Time.now
      response = HTTParty.get(ZuoraConnect.configuration.url + "/api/#{self.api_version}/tools/tasks/#{self.id}.json",:body => {:access_token => self.access_token})
      response_time = Time.now - start

      ZuoraConnect.logger.debug("REFRESH TASK - Connect Task Info Request Time #{response_time.round(2).to_s}", self.default_ougai_items)
      if response.code == 200
        begin
          parsed_json = JSON.parse(response.body)
        rescue JSON::ParserError => ex
          raise ZuoraConnect::Exceptions::ConnectCommunicationError.new("JSON parse error", response.body, response.code)
        end

        self.build_task(task_data: parsed_json, session: session)  
        if self.kms_key.present? && self.kms_key.match(/^arn:aws:.*/)
          begin
            self.zuora_logins = self.strip_cache_data(object: parsed_json.dup, keys: ['applications', 'tokens', 'user_settings'])
            self.save(:validate => false)
          rescue Aws::KMS::Errors::ValidationException, *AWS_AUTH_ERRORS => ex
            Rails.logger.warn(AWS_AUTH_ERRORS_MSG, ex)
          rescue => ex
            Rails.logger.error(AWS_AUTH_ERRORS_MSG, ex)
          end
        end        
      else
        raise ZuoraConnect::Exceptions::ConnectCommunicationError.new("Error Communicating with Connect", response.body, response.code)
      end
    else
      self.build_task(task_data: self.zuora_logins, session: session)
    end
    self.last_refresh = Time.now.to_i
    self.cache_app_instance
    self.reset_mark_for_refresh
  rescue *(ZuoraAPI::Login::CONNECTION_EXCEPTIONS + ZuoraAPI::Login::CONNECTION_READ_EXCEPTIONS) => ex
    refresh_count += 1
    if refresh_count < 3
      sleep(10)
      ZuoraConnect.logger.debug("REFRESH TASK - Connection Failure Retrying(#{refresh_count})", ex, self.default_ougai_items)
      retry
    else
      ZuoraConnect.logger.fatal("REFRESH TASK - Connection Failed", ex, self.default_ougai_items)
      raise
    end
  rescue ZuoraConnect::Exceptions::ConnectCommunicationError => ex
    refresh_count += 1
    if refresh_count < 3
      ZuoraConnect.logger.debug("REFRESH TASK - Communication Failure Retrying(#{refresh_count})", ex, self.default_ougai_items)
      self.refresh_oauth if ex.code == 401
      retry
    else
      ZuoraConnect.logger.fatal("REFRESH TASK - Communication Failed #{ex.code}", ex, self.default_ougai_items)
      raise
    end
  end
rescue => ex
  if self['zuora_logins'].present?
    ZuoraConnect.logger.warn("REFRESH TASK - Fallback to local encrypted store", ex, self.default_ougai_items)
    skip_connect = true
    retry
  end
  raise
end

#refresh_oauth ⇒ Object 



647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 647

def refresh_oauth
  refresh_oauth_count ||= 0
  start = Time.now
  params = {
            :grant_type => "refresh_token",
            :redirect_uri => ZuoraConnect.configuration.oauth_client_redirect_uri,
            :refresh_token => self.refresh_token
          }
  response = HTTParty.post("#{ZuoraConnect.configuration.url}/oauth/token",:body => params)
  response_time = Time.now - start
  ZuoraConnect.logger.debug("REFRESH OAUTH - In #{response_time.round(2).to_s}", self.default_ougai_items)

  if response.code == 200
    response_body = JSON.parse(response.body)

    self.refresh_token = response_body["refresh_token"]
    self.access_token = response_body["access_token"]
    self.oauth_expires_at = Time.at(response_body["created_at"].to_i) + response_body["expires_in"].seconds
    self.save(:validate => false)
  else
    raise ZuoraConnect::Exceptions::ConnectCommunicationError.new("Error Refreshing Access Token", response.body, response.code)
  end
rescue *(ZuoraAPI::Login::CONNECTION_EXCEPTIONS + ZuoraAPI::Login::CONNECTION_READ_EXCEPTIONS) => ex
  if (refresh_oauth_count += 1) < 3
    sleep(5)
    ZuoraConnect.logger.debug("REFRESH OAUTH - Connection Failure Retrying(#{refresh_oauth_count})", ex, self.default_ougai_items)
    retry
  else
    ZuoraConnect.logger.fatal("REFRESH OAUTH - Connection Failed", ex, self.default_ougai_items)
    raise
  end
rescue ZuoraConnect::Exceptions::ConnectCommunicationError => ex
  sleep(CONNECT_COMMUNICATION_SLEEP)
  self.reload_attributes([:refresh_token, :oauth_expires_at, :access_token]) #Reload only the refresh token for retry

  #After reload, if nolonger expired return
  return if !self.oauth_expired?

  if (refresh_oauth_count += 1) < 3
    ZuoraConnect.logger.debug("REFRESH OAUTH - Communication Failure Retrying(#{refresh_oauth_count})", ex, self.default_ougai_items)
    retry
  else
    ZuoraConnect.logger.fatal("REFRESH OAUTH - Communication Failed #{ex.code}", ex, self.default_ougai_items)
    raise
  end
end

#reload_attributes(selected_attributes) ⇒ Object 



1150
1151
1152
1153
1154
1155
1156
1157
1158
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1150

def reload_attributes(selected_attributes)
  raise "Attibutes must be array" if selected_attributes.class != Array
  value_attributes = self.class.unscoped.where(:id=>id).select(selected_attributes).first.attributes
  value_attributes.each do |key, value|
    next if key == "id" && value.blank?
    self.send(:write_attribute, key, value)
  end
  return self
end

#reset_mark_expires_at ⇒ Object 



713
714
715
716
717
718
719
720
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 713

def reset_mark_expires_at
  if defined?(Redis.current)
    refresh_time = Redis.current.zscore("InstanceRefreshing", self.id)
    return refresh_time.present? ? (refresh_time - Time.now.to_i).round(0) : 0
  else
    return 0
  end
end

#reset_mark_for_refresh ⇒ Object 



705
706
707
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 705

def reset_mark_for_refresh
  Redis.current.zrem("InstanceRefreshing", self.id) if defined?(Redis.current)
end

#reset_mark_refreshed_at ⇒ Object 



709
710
711
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 709

def reset_mark_refreshed_at
  return defined?(Redis.current) ? REFRESH_TIMEOUT.to_i - reset_mark_expires_at : 0
end

#save_data(session = Hash.new) ⇒ Object 



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
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 764

def save_data(session = Hash.new)
  self.logins.each do |key, |
    if .tenant_type == "Zuora"
      if .available_entities.size > 1 && Rails.application.config.session_store != ActionDispatch::Session::CookieStore
        .available_entities.each do |entity_key|
          session["#{self.id}::#{key}::#{entity_key}:current_session"]            = .client(entity_key).current_session            if .client.respond_to?(:current_session)
          session["#{self.id}::#{key}::#{entity_key}:bearer_token"]               = .client(entity_key).bearer_token               if .client.respond_to?(:bearer_token)
          session["#{self.id}::#{key}::#{entity_key}:oauth_session_expires_at"]   = .client(entity_key).oauth_session_expires_at   if .client.respond_to?(:oauth_session_expires_at)
        end
      else
        session["#{self.id}::#{key}:current_session"]             = .client.current_session            if .client.respond_to?(:current_session)
        session["#{self.id}::#{key}:bearer_token"]                = .client.bearer_token               if .client.respond_to?(:bearer_token)
        session["#{self.id}::#{key}:oauth_session_expires_at"]    = .client.oauth_session_expires_at   if .client.respond_to?(:oauth_session_expires_at)
      end
    end
  end

  session["#{self.id}::task_data"] = self.task_data

  #Redis is not defined strip out old data
  if !defined?(Redis.current)
    strip_cache_data(object: session["#{self.id}::task_data"])
  end

  session["#{self.id}::last_refresh"] = self.last_refresh
  session["appInstance"] = self.id
  return session
end

#send_email ⇒ Object 



1164
1165
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1164

def send_email
end

#strip_cache_data(object: {}, keys: ['applications', 'tokens','tenant_ids', 'organizations','user_settings']) ⇒ Object 



793
794
795
796
797
798
799
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 793

def strip_cache_data(object: {}, keys: ['applications', 'tokens','tenant_ids', 'organizations','user_settings'] )
  keys.each {|key| object.delete(key) }
  object.select {|k,v| k.include?('login') && v['tenant_type'] == 'Zuora'}.each do |, |
    object[]['entities'] = .fetch('entities',[]).map {|entity| entity.slice('id', 'tenantId', 'entityId')}
  end
  return object
end

#update_logins(options) ⇒ Object

This can update an existing login, add a new login, change to another existing login EXAMPLE: “ftp_login_14”,“username”: “ftplogin7”,“tenant_type”: “Custom”,“password”: “test2”,“url”: “www.ftp.com”,“custom_data”: { “path”: “/var/usr/test”}



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
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 533

def update_logins(options)
   ||= 0
  response = HTTParty.post(ZuoraConnect.configuration.url + "/api/#{self.api_version}/tools/tasks/#{self.id}/logins",:body => {:access_token => self.username}.merge(options))
  parsed_json =  JSON.parse(response.body)
  if response.code == 200
    if defined?(Redis.current)
      self.build_task(task_data: parsed_json, session: self.data_lookup)
      self.last_refresh = Time.now.to_i
      self.cache_app_instance
    end
    return parsed_json
  elsif response.code == 400
    raise ZuoraConnect::Exceptions::APIError.new(message: parsed_json['errors'].join(' '), response: response)
  else
    raise ZuoraConnect::Exceptions::ConnectCommunicationError.new("Error Communicating with Connect", response.body, response.code)
  end
rescue *(ZuoraAPI::Login::CONNECTION_EXCEPTIONS + ZuoraAPI::Login::CONNECTION_READ_EXCEPTIONS) => ex
  if ( += 1) < 3
    retry
  else
    raise
  end
rescue ZuoraConnect::Exceptions::ConnectCommunicationError => ex
  if ( += 1) < 3
    if ex.code == 401
      self.refresh_oauth
    end
    retry
  else
    raise
  end
end

#update_task(options) ⇒ Object 



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
630
631
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 605

def update_task(options)
  update_task_count ||= 0
  response = HTTParty.post(ZuoraConnect.configuration.url + "/api/#{self.api_version}/tools/tasks/#{self.id}/update_task",:body => {:access_token => self.username}.merge(options))
  parsed_json =  JSON.parse(response.body)
  if response.code == 200
    return parsed_json
  elsif response.code == 400
    raise ZuoraConnect::Exceptions::APIError.new(message: parsed_json['errors'].join(' '), response: response)
  else
    raise ZuoraConnect::Exceptions::ConnectCommunicationError.new("Error Communicating with Connect", response.body, response.code)
  end
rescue *(ZuoraAPI::Login::CONNECTION_EXCEPTIONS + ZuoraAPI::Login::CONNECTION_READ_EXCEPTIONS) => ex
  if (update_task_count += 1) < 3
    retry
  else
    raise
  end
rescue ZuoraConnect::Exceptions::ConnectCommunicationError => ex
  if (update_task_count += 1) < 3
    if ex.code == 401
      self.refresh_oauth
    end
    retry
  else
    raise
  end
end

#updateOption(optionId, value) ⇒ Object 



527
528
529
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 527

def updateOption(optionId, value)
  response = HTTParty.get(ZuoraConnect.configuration.url + "/api/#{self.api_version}/tools/application_options/#{optionId}/edit?value=#{value}",:body => {:access_token => self.username})
end

#upload_to_s3(local_file, s3_path = nil) ⇒ Object 



1104
1105
1106
1107
1108
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 1104

def upload_to_s3(local_file,s3_path = nil)
  s3_path = local_file.split("/").last if s3_path.nil?
  obj = self.s3_client.bucket(ZuoraConnect.configuration.s3_bucket_name).object("#{ZuoraConnect.configuration.s3_folder_name}/#{self.id.to_s}/#{s3_path}}")
  obj.upload_file(local_file, :server_side_encryption => 'AES256')
end

#zuora_logins ⇒ Object

Raises:



340
341
342
343
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 340

def zuora_logins
  raise  ZuoraConnect::Exceptions::ConnectCommunicationError.new("Zuora Logins is blank, cannot decrypt.") if super.blank?
  return JSON.parse(kms_decrypt(super))
end

#zuora_logins=(val) ⇒ Object

START KMS ENCRYPTION Methods ####



336
337
338
 
# File 'app/models/zuora_connect/app_instance_base.rb', line 336

def zuora_logins=(val)
  write_attribute(:zuora_logins, kms_encrypt(val.to_json))
end