apollo_commons_ruby 0.7.0

data/lib/apollo_commons_ruby/NetworkUtils.rb

@@ -0,0 +1,67 @@
+require 'json'
+require 'net/http'
+require 'uri'
+require 'openssl'
+require 'base64'
+
+def make_PUT_request (url, body, authtoken)
+  if authtoken == nil
+    authtoken = ""
+  end
+  uri = URI.parse(url)
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = true
+  request = Net::HTTP::Put.new(uri.request_uri,
+                                initheader = {
+                                  'Content-Type' =>'application/json',
+                                  'X-Zeta-AuthToken' => authtoken
+                              })
+  request.body = body
+
+  puts "#{uri}\n\n"
+  puts "#{request.body}\n\n"
+  response = http.request(request)
+  puts "#{response.body}"
+  return response.body
+end
+
+def make_POST_request (url, body, authtoken)
+  if authtoken == nil
+    authtoken = ""
+  end
+  uri = URI.parse(url)
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = true
+  request = Net::HTTP::Post.new(uri.request_uri,
+                                initheader = {
+                                  'Content-Type' =>'application/json',
+                                  'X-Zeta-AuthToken' => authtoken
+                              })
+  request.body = body
+
+  puts "#{uri}\n\n"
+  puts "#{request.body}\n\n"
+  response = http.request(request)
+  puts "#{response.body}"
+  return response.body
+end
+
+def make_DELETE_request (url, authtoken)
+  if authtoken == nil
+    authtoken = ""
+  end
+  uri = URI.parse(url)
+
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = true
+  request = Net::HTTP::Delete.new(uri.request_uri,
+                                    initheader = {
+                                      'Content-Type' =>'application/json',
+                                      'X-Zeta-AuthToken' => authtoken
+                                  })
+
+  puts "#{uri}\n\n"
+  response = http.request(request)
+  puts "#{response.body}"
+  return response.body
+end

data/lib/apollo_commons_ruby/Operation.rb

@@ -0,0 +1,4 @@
+module Operation
+    PUT = 1
+    DELETE = 2
+end

data/lib/apollo_commons_ruby/ResolveTemplate.rb

@@ -0,0 +1,53 @@
+require 'v8'
+require 'rubygems'
+require_relative 'TemplatesHelper'
+
+class ResolveTemplate
+
+	def initialize
+		@context = V8::Context.new
+		@context.load("./scripts/underscore-min.js")
+		@context.eval("var generateTemplatedStringEnv = function(templateString, dataObject) { _.templateSettings = { interpolate: /\{\{(.+?)\}\}/g }; var compiledWithEnv = _.template(templateString); return compiledWithEnv(dataObject);}")
+		@context.eval("var generateTemplatedStringLang = function(templateString, dataObject) { _.templateSettings = { interpolate: /\<\<(.+?)\>\>/g }; var compiledWithLang = _.template(templateString); return compiledWithLang(dataObject);}")
+	end
+
+	def resolve(data_template, configuration)
+		envFilePath = configuration.env_data_file_path
+		envData = read_data_from_file_path(envFilePath)
+		envData = JSON.parse(envData)
+		function = @context[:generateTemplatedStringEnv];
+		begin
+			data_template = data_template.force_encoding("UTF-8")
+			function.call(data_template, envData)
+		rescue Exception => e
+			puts "\n", e.cause, e.javascript_backtrace;
+		end
+	end
+
+	def resolveEnv(data_template, configuration, tenant_id, project_id)
+		envFilePath = configuration.env_file_path(tenant_id, project_id)
+		envData = read_data_from_file_path(envFilePath)
+		envData = JSON.parse(envData)
+		function = @context[:generateTemplatedStringEnv];
+		begin
+			data_template = data_template.force_encoding("UTF-8")
+			function.call(data_template, envData)
+		rescue Exception => e
+			puts "\n", e.cause, e.javascript_backtrace;
+		end
+	end
+
+	def resolveLang(data_template, configuration, language)
+		langFilePath = configuration.language_file_path_for_template(language)
+		langData = read_res_data_from_file_path(langFilePath)
+		langData = JSON.parse(langData)
+		function = @context[:generateTemplatedStringLang];
+		begin
+			data_template = data_template.force_encoding("UTF-8")
+			function.call(data_template, langData)
+		rescue Exception => e
+			puts "\n", e.cause, e.javascript_backtrace;
+		end
+	end
+
+end

data/lib/apollo_commons_ruby/SecretConfig.rb

@@ -0,0 +1,15 @@
+class SecretConfig
+
+  attr_reader :authToken
+
+  def initialize(environment)
+    conf_file = File.read(File.expand_path("/var/jenkins_home/template_config/config.json"));
+    conf = JSON.parse conf_file
+    conf = conf[environment.downcase]
+    if (conf["authToken"] == nil)
+      puts "Security configurations are missing"
+      return nil
+    end
+    @authToken = conf["authToken"]
+  end
+end

data/lib/apollo_commons_ruby/TemplateBuilder.rb

@@ -0,0 +1,26 @@
+require 'v8'
+
+class TemplateBuilder
+
+	def initialize
+		@context = V8::Context.new
+		@context.load("scripts/underscore-min.js")
+		@context.eval("var generateTemplatedString = function(templateString, dataObject) { var compiled = _.template(templateString); return compiled(dataObject);}")
+	end
+
+	def build(data_template, data, os)
+		function = @context[:generateTemplatedString];
+		begin
+			data_template = data_template.force_encoding("UTF-8")
+			if os == "android"
+				@context.eval( "var compiledTemplate = _.template(' " + data_template + "');" + "compiledTemplate(" + data.to_json + ");")
+			else
+				function.call(data_template, data)
+			end
+
+		rescue Exception => e
+			puts "\n", e.causes, e.javascript_backtrace;
+		end
+	end
+
+end

data/lib/apollo_commons_ruby/TemplatesHelper.rb

@@ -0,0 +1,814 @@
+require 'json'
+require 'net/http'
+require 'uri'
+require 'openssl'
+require 'base64'
+require_relative 'SecretConfig'
+
+module HTTP
+  GET = 1
+  POST = 2
+end
+
+class String
+  def black;          "\e[30m#{self}\e[0m" end
+  def red;            "\e[31m#{self}\e[0m" end
+  def green;          "\e[32m#{self}\e[0m" end
+  def brown;          "\e[33m#{self}\e[0m" end
+  def blue;           "\e[34m#{self}\e[0m" end
+  def magenta;        "\e[35m#{self}\e[0m" end
+  def cyan;           "\e[36m#{self}\e[0m" end
+  def gray;           "\e[37m#{self}\e[0m" end
+
+  def bg_black;       "\e[40m#{self}\e[0m" end
+  def bg_red;         "\e[41m#{self}\e[0m" end
+  def bg_green;       "\e[42m#{self}\e[0m" end
+  def bg_brown;       "\e[43m#{self}\e[0m" end
+  def bg_blue;        "\e[44m#{self}\e[0m" end
+  def bg_magenta;     "\e[45m#{self}\e[0m" end
+  def bg_cyan;        "\e[46m#{self}\e[0m" end
+  def bg_gray;        "\e[47m#{self}\e[0m" end
+
+  def bold;           "\e[1m#{self}\e[22m" end
+  def italic;         "\e[3m#{self}\e[23m" end
+  def underline;      "\e[4m#{self}\e[24m" end
+  def blink;          "\e[5m#{self}\e[25m" end
+  def reverse_color;  "\e[7m#{self}\e[27m" end
+end
+
+class LineReplacementProperties
+
+      attr_reader :file_path
+      attr_reader :redundant_line_prefix
+      attr_reader :updated_line
+
+      def initialize(file_path, redundant_line_prefix, updated_line)
+          @file_path = file_path
+          @redundant_line_prefix = redundant_line_prefix
+          @updated_line = updated_line
+      end
+end
+
+class TemplateMapping
+
+  def initialize(template_name, template_path, template_mapping)
+    @template_name = template_name
+    @template_path = template_path
+    @template_mapping = template_mapping
+  end
+
+  def create_hash
+    {
+        "template_name"=> @template_name,
+        "template_path"=> @template_path,
+        "template_mapping"=> @template_mapping
+    }
+  end
+
+  def create_mapping
+    {
+      @template_mapping => @template_name
+    }
+  end
+end
+
+class Template
+
+  attr_reader :data_template
+
+  def initialize(template_name, default_content, data_template, presentation, attrs)
+    @default_content = default_content
+    @data_template = data_template
+    @presentation = presentation
+    @template_name = template_name
+    @attrs = attrs
+  end
+
+  def create_hash
+    {
+        @template_name => {
+            "defaultContent"=> @default_content,
+            "dataTemplateBase64"=> @data_template,
+            "presentationBase64"=> @presentation,
+            "attrs"=> @attrs
+        }
+    }
+  end
+
+end
+
+class CreateTemplatePayload
+  def initialize(template_group, language, view, templates, version)
+    @template_group = template_group
+    @language = language
+    @view = view
+    @templates = templates
+    @version = version
+  end
+
+  def to_json
+    body = {
+        "templateGroup"=> @template_group,
+        "language"=> @language,
+        "viewType"=> @view,
+        "templates"=> @templates,
+        "version" => @version
+    }
+    body.to_json
+  end
+
+end
+
+module JSON
+  def self.is_valid_json?(json)
+    begin
+      JSON.parse(json)
+      return true
+    rescue JSON::ParserError => e
+      return false
+    end
+  end
+end
+
+class TemplateConfig
+  BaseAppID = "1005"
+  SupportedLanguages = "supportedLanguages"
+  BaseLanguageResource = "VI"
+
+  def self.language_resource_path(language)
+    return "Resources/#{language}.json"
+  end
+
+  def self.base_language_resource_path()
+    return language_resource_path("#{TemplateConfig::BaseLanguageResource}")
+  end
+
+  def self.template_group_contents_path_for_base_app(template_group)
+    return template_group_contents_path_for_appID(template_group, BaseAppID)
+  end
+
+  def self.template_group_contents_path_for_appID(template_group, appID)
+    parent_dir_path = template_group_parent_directory_path_for_appID(template_group, appID)
+    return "#{parent_dir_path}/#{appID}"
+  end
+
+  def self.template_group_parent_directory_path_for_appID(template_group, appID)
+    template_group_parent_path = template_group_parent_directory_path(template_group)
+    return "#{template_group_parent_path}/common/UIVIEW/appID_#{appID}"
+  end
+
+  def self.template_group_parent_directory_path(template_group)
+    return "Templates/#{template_group}"
+  end
+
+  def self.template_group_details_path_for_template_group(template_group)
+    template_group_parent_path = template_group_parent_directory_path(template_group)
+    return "#{template_group_parent_path}/templateGroupDetails.json"
+  end
+
+  def self.template_group_details_for_template_group(template_group)
+    file_path = template_group_details_path_for_template_group(template_group)
+    return read_raw_json_data_from_file_path(file_path)
+  end
+
+  def self.supported_languages_for_template_group(template_group)
+    return template_group_details_for_template_group(template_group)["#{TemplateConfig::SupportedLanguages}"]
+  end
+
+  def self.update_template_group_details_for_template_group(template_group, key, value)
+    template_group_details = template_group_details_for_template_group(template_group)
+    template_group_details[key] = value
+    template_group_details_file_path = template_group_details_path_for_template_group(template_group)
+    puts "updated template group details: #{JSON.pretty_generate template_group_details}"
+    write_data_to_file(template_group_details_file_path, template_group_details)
+  end
+
+  def self.add_language_to_supported_languages_for_template_group(template_group, language)
+    if language == nil
+      log_error("Cannot add nil lanugage to supportedLanguages")
+      return
+    end
+    supported_languages = supported_languages_for_template_group(template_group)
+    if supported_languages.include?(language)
+      log_info("Language #{language} already exists in supported languages. Skipping adding language")
+    else
+      puts "Adding language #{language} to supported languages"
+      supported_languages.push(language)
+      update_template_group_details_for_template_group(template_group, "#{TemplateConfig::SupportedLanguages}", supported_languages)
+    end
+  end
+end
+
+class String
+  def newline
+    self.gsub(/\n/,"")
+  end
+  def tabs
+    self.gsub(/\t/," ")
+  end
+  def esc
+    self.gsub(/\"/,"\\\"")
+  end
+  def escnewline
+    self.gsub(/\n/,"\\n")
+  end
+end
+
+class CreateCollectionItem
+  def initialize(item_id, data)
+    @itemID = item_id
+    @data = data
+  end
+
+  def to_json
+    body = {
+      "itemID"=> @itemID,
+      "data"=> @data,
+      "isBase64Encoded"=> "true"
+    }
+    body.to_json
+  end
+end
+
+class Configuration
+
+  attr_reader :environment
+  attr_reader :base_url
+  attr_reader :get_template_url
+  attr_reader :create_template_url
+  attr_reader :base_folder_path
+  attr_reader :collections_base_folder_path
+  attr_reader :common_data_file_path
+  attr_reader :templated_data_file_path
+  attr_reader :zebugger_templated_data_file_path
+  attr_reader :additional_data_file_path
+  attr_reader :sample_ios_uainfo_data_file_path
+  attr_reader :sample_android_uainfo_data_file_path
+  attr_reader :sample_remote_config_data_file_path
+  attr_reader :env_data_file_path
+  attr_reader :get_latest_collection_items_url
+  attr_reader :set_collection_item_url
+  attr_reader :get_collection_item_url
+  attr_reader :delete_collection_item_url
+  attr_reader :count
+  attr_reader :post_insert_templates_url
+  attr_reader :post_insert_template_group_url
+  attr_reader :post_upsert_template_mappings_url
+  attr_reader :get_template_group_details_url
+  attr_reader :get_templates_for_view_url
+  attr_reader :post_update_template_group_url
+  attr_reader :post_delete_template_group_url
+  attr_reader :post_update_templates_url
+  attr_reader :post_delete_templates_url
+  attr_reader :post_delete_template_mappings_url
+  attr_reader :resources_file_path
+  attr_reader :apollo_config_base_url
+  attr_reader :collection_id_for_default
+  attr_reader :collection_id_for_iOS_v2
+  attr_reader :collection_id_for_iOS_v3
+
+
+  def initialize(environment)
+    conf_file = File.read(File.expand_path("/var/jenkins_home/template_config/config.json"));
+    conf = JSON.parse conf_file
+    conf = conf[environment.downcase]
+    if (conf["base_url"] == nil or conf["get_template_url"] == nil or conf["create_template_url"] == nil or conf["base_folder_path"] == nil or conf["collections_base_folder_path"] == nil)
+      puts "Required configurations are missing"
+      raise "Required configurations are missing"
+      return nil
+    end
+    @environment = environment
+    @base_url = conf["base_url"]
+    @get_template_url = conf["base_url"] + "/" + conf["get_template_url"]
+    @create_template_url = conf["base_url"] + "/" + conf["create_template_url"]
+    @base_folder_path = conf["base_folder_path"]
+    @collections_base_folder_path = conf["collections_base_folder_path"]
+    @common_data_file_path = conf["common_data_file_path"]
+    @common_data_path = conf["collections_base_folder_path"]
+    @templated_data_file_path = conf["templated_data_file_path"]
+    @zebugger_templated_data_file_path = conf["zebugger_templated_data_file_path"]
+    @additional_data_file_path = conf["additional_data_file_path"]
+    @sample_ios_uainfo_data_file_path = conf["sample_ios_uainfo_data_file_path"]
+    @sample_android_uainfo_data_file_path = conf["sample_android_uainfo_data_file_path"]
+    @sample_remote_config_data_file_path = conf["sample_remote_config_data_file_path"]
+    @env_data_file_path = conf["env_data_file_path"]
+    @get_latest_collection_items_url = conf["base_url"] + "/" + conf["get_latest_collection_items_url"]
+    @set_collection_item_url = conf["base_url"] + "/" + conf["set_collection_item_url"]
+    @get_collection_item_url = conf["base_url"] + "/" + conf["get_collection_item_url"]
+    @delete_collection_item_url = conf["base_url"] + "/" + conf["delete_collection_item_url"]
+    @count = conf["count"]
+    @post_insert_templates_url = conf["base_url"] + "/" + conf["post_insert_templates_url"]
+    @post_insert_template_group_url = conf["base_url"] + "/" + conf["post_insert_template_group_url"]
+    @post_upsert_template_mappings_url = conf["base_url"] + "/" + conf["post_upsert_template_mappings_url"]
+    @get_template_group_details_url = conf["base_url"] + "/" + conf["get_template_group_details_url"]
+    @get_templates_for_view_url = conf["base_url"] + "/" + conf["get_templates_for_view_url"]
+    @post_update_template_group_url = conf["base_url"] + "/" + conf["post_update_template_group_url"]
+    @post_delete_template_group_url = conf["base_url"] + "/" + conf["post_delete_template_group_url"]
+    @post_update_templates_url = conf["base_url"] + "/" + conf["post_update_templates_url"]
+    @post_delete_templates_url = conf["base_url"] + "/" + conf["post_delete_templates_url"]
+    @post_delete_template_mappings_url = conf["base_url"] + "/" + conf["post_delete_template_mappings_url"]
+    @apollo_config_base_url = conf["apollo_config_base_url"]
+    @resources_file_path = conf["resources_file_path"]
+    @collection_id_for_default = conf["collection_id_for_default"]
+    @collection_id_for_iOS_v2 = conf["collection_id_for_iOS_v2"]
+    @collection_id_for_iOS_v3 = conf["collection_id_for_iOS_v3"]
+  end
+
+  def data_template_file_path_for_template(template_group, lang, view_type, template_name)
+    "#{@base_folder_path}/#{template_group}/#{lang}/#{view_type}/#{template_name}/dataTemplate.json"
+  end
+
+  def presentation_file_path_for_template(template_group, lang, view_type, template_name)
+    "#{@base_folder_path}/#{template_group}/#{lang}/#{view_type}/#{template_name}/presentation.json"
+  end
+
+  def default_content_file_path_for_template(template_group, lang, view_type, template_name)
+    "#{@base_folder_path}/#{template_group}/#{lang}/#{view_type}/#{template_name}/defaultContent.json"
+  end
+
+  def template_name_dir_path_for_template(template_group, language, view_type, template_name)
+    "#{@base_folder_path}/#{template_group}/#{language}/#{view_type}/#{template_name}"
+  end
+
+  def view_type_dir_path_for_template(template_group, language, view_type)
+    "#{@base_folder_path}/#{template_group}/#{language}/#{view_type}"
+  end
+
+  def view_type_dir_path_for_template_with_version(template_group, language, view_type, version)
+    "#{@base_folder_path}/#{template_group}/#{language}/#{view_type}/#{version}"
+  end
+
+  def language_dir_path_for_template(template_group, language)
+    "#{@base_folder_path}/#{template_group}/#{language}"
+  end
+
+  def transfomer_file_path_for_template(template_group)
+    "#{@base_folder_path}/#{template_group}/transformer.js"
+  end
+
+  def client_transfomer_file_path_for_template(template_group)
+    "#{@base_folder_path}/#{template_group}/clientTransformer.js"
+  end
+
+  def template_group_details_file_path_for_template(template_group)
+    "#{@base_folder_path}/#{template_group}/templateGroupDetails.json"
+  end
+
+  def template_group_dir_path_for_template(template_group)
+    "#{@base_folder_path}/#{template_group}"
+  end
+
+  def collection_dir_path_for_collection_id(collection_id)
+    "#{@collections_base_folder_path}/#{collection_id}/#{ENV['environment']}"
+  end
+
+  def collection_item_file_path_for_collection_id_and_item_id(collection_id, item_id)
+    "#{@collections_base_folder_path}/#{collection_id}/#{ENV['environment']}/#{item_id}.json"
+  end
+
+  def language_file_path_for_template(language)
+    "#{@resources_file_path}/#{language}.json"
+  end
+
+  def env_file_path(tenant_id, project_id)
+    if file_exists?("./environments/#{@environment}/env_#{tenant_id}_#{project_id}.json")
+      "./environments/#{@environment}/env_#{tenant_id}_#{project_id}.json"
+    else
+      "#{@env_data_file_path}"
+    end
+  end
+
+end
+
+def directory_exists?(directory)
+  File.directory?(directory)
+end
+
+def file_exists?(file_name)
+  File.file?(file_name)
+end
+
+def invoke_API(environment, url, type, query_params = nil, body = nil)
+  secretConfig = SecretConfig.new(environment);
+  puts "Invoking API: #{url}"
+  query_params = query_params == nil ? {} : query_params
+  if type == HTTP::GET
+    response = make_GET_request(url, secretConfig.authToken, query_params, true)
+  elsif type == HTTP::POST
+    response = make_POST_request(url, body, secretConfig.authToken, query_params, true)
+  elsif type == HTTP::DELETE
+    response = make_DELETE_request(url, body, secretConfig.authToken, query_params, true)
+  end
+  if response
+    JSON.parse response
+  end
+end
+
+def make_POST_request (url, body, authToken, query_params = nil, should_log = true)
+  uri = URI.parse(url)
+  uri.query = URI.encode_www_form(query_params) if query_params != nil
+
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = true
+  request = Net::HTTP::Post.new(uri.request_uri,
+                                initheader = {'Content-Type' =>'application/json', 'X-Zeta-AuthToken' => authToken})
+  request.body = body
+
+  puts "#{uri}\n\n" if should_log
+  puts "#{request.body}\n\n" if should_log
+  response = http.request(request)
+  puts "#{response.body}" if should_log
+  return response.body
+end
+
+def make_GET_request (url, authToken, query_params = nil, should_log = true)
+  uri = URI.parse(url)
+  uri.query = URI.encode_www_form(query_params) if query_params != nil
+
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = true
+  request = Net::HTTP::Get.new(uri.request_uri,
+                                initheader = {'Content-Type' =>'application/json', 'X-Zeta-AuthToken' => authToken})
+
+  puts "#{uri}\n\n" if should_log
+  puts "#{request.body}\n\n" if should_log
+  response = http.request(request)
+  puts "#{response.body}" if should_log
+  return response.body
+end
+
+def make_DELETE_request (url, body, authToken, query_params = nil, should_log = true)
+  uri = URI.parse(url)
+  uri.query = URI.encode_www_form(query_params) if query_params != nil
+
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = true
+  request = Net::HTTP::Delete.new(uri.request_uri,
+                                  initheader = {'Content-Type' =>'application/json', 'X-Zeta-AuthToken' => authToken})
+  request.body = body
+
+  puts "#{uri}\n\n" if should_log
+  puts "#{request.body}\n\n" if should_log
+  response = http.request(request)
+  puts "#{response.body}" if should_log
+  return response.body
+end
+
+def make_collection_POST_request (url, body, authToken, query_params = nil)
+  uri = URI.parse(url)
+  uri.query = URI.encode_www_form(query_params) if query_params != nil
+
+  http = Net::HTTP.new(uri.host, uri.port)
+  http.use_ssl = true
+  request = Net::HTTP::Post.new(uri.request_uri,
+    initheader = {'Content-Type' =>'application/json', 'X-Zeta-AuthToken' => authToken})
+  request.body = body
+
+  puts "#{uri}\n\n"
+  puts "#{request.body}\n\n"
+  http.request(request).body
+end
+
+def make_collection_GET_request (url, query_params = nil)
+  uri = URI(url)
+  uri.query = URI.encode_www_form(query_params) if query_params != nil
+
+  response = Net::HTTP.get_response(uri)
+  if response.is_a?(Net::HTTPSuccess)
+    utf8_encoded = response.body.force_encoding("UTF-8")
+    JSON.parse utf8_encoded
+  else
+    puts "Error occured while loading #{url}\nquery_params: #{query_params}
+    Error: #{response.inspect}, #{response.body}"
+  end
+end
+
+def write_data_to_file(file_path, data)
+  out_file = File.new(file_path, "w")
+  out_file.puts JSON.pretty_generate data
+  out_file.close
+end
+
+def write_plain_text_to_file(file_path, data)
+  out_file = File.new(file_path, "w")
+  out_file.puts data
+  out_file.close
+end
+
+def write_common_data_to_file(configuration, collection_data)
+  out_file = File.new(configuration.common_data_file_path, "w")
+  out_file.puts JSON.pretty_generate collection_data
+  out_file.close
+end
+
+def write_collection_data_to_file(collection_data, file_path)
+  out_file = File.new(file_path, "w")
+  out_file.puts JSON.pretty_generate collection_data
+  out_file.close
+end
+
+def write_templated_data_to_file(configuration, collection_data)
+  out_file = File.new(configuration.templated_data_file_path, "w")
+  out_file.puts JSON.pretty_generate collection_data
+  out_file.close
+end
+
+def write_templated_data_to_file_for_zebugger(configuration, collection_data)
+  out_file = File.new(configuration.zebugger_templated_data_file_path, "w")
+  out_file.puts JSON.pretty_generate collection_data
+  out_file.close
+end
+
+def additional_template_data(configuration)
+  collection_data = {}
+  begin
+    file_path = configuration.additional_data_file_path
+    if (file_exists?(file_path))
+      in_file = File.read(file_path)
+      return if in_file == nil
+      data = JSON.parse(in_file)
+      data = data.to_json
+      collection_data = data
+    else
+      collection_data = {}
+    end
+  rescue Exception => e
+    puts "Additional Data loading from #{file_path} failed with error: #{e}"
+    collection_data = {}
+  end
+  return collection_data
+end
+
+def cached_template_data(configuration)
+  collection_data = {}
+  begin
+    file_path = configuration.common_data_file_path
+    if (file_exists?(file_path))
+      in_file = File.read(file_path)
+      return if in_file == nil
+      data = JSON.parse(in_file)
+      data = data.to_json
+      collection_data = data
+    else
+      collection_data = {}
+    end
+  rescue Exception => e
+    puts "Cached Data loading from #{file_path} failed with error: #{e}"
+    collection_data = {}
+  end
+  return collection_data
+end
+
+def file_of_name_in_dir_path(dir_path, file_name)
+  file_path = ""
+  begin
+    file_path = Dir.entries(dir_path).select {
+      |entry| entry.include? file_name
+    }.first
+    if !(file_path == nil)
+      file_path = File.join(dir_path,file_path)
+    end
+  rescue Exception => e
+    puts "ERROR: file_of_name_in_dir_path #{dir_path} #{file_name} #{e}"
+  end
+  return file_path
+end
+
+def read_data_from_file_of_name_in_dir_path(dir_path, file_name)
+  file_data = {}
+  begin
+    file_path = Dir.entries(dir_path).select {
+      |entry| entry.include? file_name
+    }.first
+    file_path = File.join(dir_path,file_path)
+    file_data = File.read(file_path)
+  rescue Exception => e
+    puts "Reading from #{file_path} failed with error: #{e}"
+  end
+  return file_data
+end
+
+def read_data_from_file_path(file_path)
+  file_data = {}
+  begin
+    if (file_exists?(file_path))
+      in_file = File.read(file_path)
+      return if in_file == nil
+      file_data = in_file
+    else
+      file_data = {}
+    end
+  rescue Exception => e
+    puts "Reading from #{file_path} failed with error: #{e}"
+    file_data = {}
+  end
+  return file_data
+end
+
+def read_plain_text_data_from_file_path(file_path)
+  file_data = ""
+  begin
+    if (file_exists?(file_path))
+      in_file = File.read(file_path)
+      return if in_file == nil
+      file_data = in_file
+    end
+  rescue Exception => e
+    puts "Reading from #{file_path} failed with error: #{e}"
+  end
+  return file_data
+end
+
+def read_res_data_from_file_path(file_path)
+  file_data = {}
+  if (!file_exists?(file_path))
+    file_path = "./Resources/EN.json"
+  end
+  file_data = read_data_from_file_path(file_path)
+  return file_data
+end
+
+def setup_appID_uiview_template_group_directory(template_group, appID)
+  base_path = TemplateConfig.template_group_parent_directory_path_for_appID(template_group, appID)
+  contents_path = TemplateConfig.template_group_contents_path_for_appID(template_group, appID)
+  if (directory_exists?(base_path))
+    puts "Template parent directory for appID: #{appID} already exists at path: #{base_path}"
+  else
+    Dir.mkdir base_path
+  end
+
+  if (directory_exists?(contents_path))
+    puts "Template contents directory for appID: #{appID} already exists at path: #{contents_path}"
+  else
+    Dir.mkdir contents_path
+  end
+end
+
+def print_separator()
+  puts "------------------------------------------------------------------------------------------------".green
+end
+
+def print_header(message)
+  print_separator()
+  puts message.bold.magenta
+  print_separator()
+end
+
+def log_error(message)
+  puts "ERROR: #{message}".bold.red
+end
+
+def log_info(message)
+  puts "INFO: #{message}".bold
+end
+
+def read_new_app_template_groups_from_config()
+  new_app_template_groups = Array.new
+  file_path = "new_app_template_groups.json"
+
+  begin
+    new_app_templates_config = read_raw_json_data_from_file_path(file_path)
+    if new_app_templates_config["templateGroups"].is_a?(Array)
+      new_app_template_groups = new_app_templates_config["templateGroups"]
+    else
+      throw "templateGroups inside config is not an array"
+    end
+  rescue Exception => e
+    log_error("Failed to read new_app_template_groups_config with error: #{e}")
+  end
+  return new_app_template_groups
+end
+
+def read_raw_json_data_from_file_path(file_path)
+  data = Hash.new
+  begin
+    if(file_exists?(file_path))
+      in_file = File.read(file_path)
+      if in_file != nil
+        data = JSON.parse(in_file)
+      else
+        throw "Contents are nil"
+      end
+    end
+  rescue Exception => e
+    log_error("Failed to read contents of file at path [#{file_path}]with error: #{e}")
+  end
+  return data
+end
+
+def read_json_data_from_file_path(file_path)
+  file_data = {}
+  begin
+    if (file_exists?(file_path))
+      in_file = File.read(file_path)
+      return if in_file == nil
+      data = JSON.parse(in_file)
+      data = data.to_json
+      file_data = data
+    else
+      file_data = {}
+    end
+  rescue Exception => e
+    puts "Reading from #{file_path} failed with error: #{e}"
+    file_data = {}
+  end
+  return file_data
+end
+
+def print_separator_line()
+  puts "--------------------------------------------------------------------------------------------------------------------------------------"
+end
+
+def does_templated_data_has_payment_instrument_as_states(templated_data, activePaymentInstrumentID, os)
+  if os == "android"
+    outer_states = templated_data["states"]
+    if outer_states
+      if !outer_states.empty?
+        inner_states = outer_states["states"]
+        if !inner_states.empty?
+          keys = inner_states.keys
+          return keys.include? activePaymentInstrumentID
+        end
+      end
+    end
+  end
+  if os == "ios"
+    outer_states = templated_data["states"]
+    keys = outer_states.keys
+    return keys.include? activePaymentInstrumentID
+  end
+end
+
+def directory_list(dir_path)
+  dirNames = []
+  Dir.entries(dir_path).select {
+    |entry| File.directory? File.join(dir_path,entry) and !(entry =='.' || entry == '..')
+  }.each do |item|
+    dirNames.push(item)
+  end
+  return dirNames
+end
+
+def all_directory_and_sub_directory_with_character_not_in_dir_path(dir_path, character)
+  dirNames = Hash.new
+  Dir.entries(dir_path).select {
+    |entry| File.directory? File.join(dir_path,entry) and !(entry =='.' || entry == '..')
+  }.each do |item|
+    indexOfCharacter = item.index(character)
+    indexOfTemplater = item.index("{{")
+    if indexOfCharacter and indexOfCharacter >= 0 and (!indexOfTemplater || indexOfCharacter < indexOfTemplater)
+      dirNames = dirNames.merge(all_directory_and_sub_directory_with_character_not_in_dir_path(File.join(dir_path,item), character))
+    else
+      dirNames[item] = File.join(dir_path,item)
+    end
+  end
+  return dirNames
+end
+
+def all_directory_and_sub_directory_in_dir_path(dir_path)
+  dirNames = Hash.new
+  Dir.entries(dir_path).select {
+    |entry| File.directory? File.join(dir_path,entry) and !(entry =='.' || entry == '..')
+  }.each do |item|
+    dir_path_of_item = File.join(dir_path,item)
+    dir_names_of_item = directory_list(dir_path_of_item)
+    if dir_names_of_item.count > 0
+      dirNames[item] = File.join(dir_path,item)
+      dirNames = dirNames.merge(all_directory_and_sub_directory_in_dir_path(dir_path_of_item))
+    else
+      dirNames[item] = File.join(dir_path,item)
+    end
+  end
+  return dirNames
+end
+
+def template_mapping_in_dir_path_file_path_with_character(dir_path, file_path, character)
+  dir_path += "/"
+  file_path.slice! dir_path
+  mapping_components = file_path.split('/')
+  template_mapping = "";
+  mapping_components.each do |item|
+    if item == "default"
+      template_mapping = "*"
+    else
+      length = item.length
+      indexOfCharacter = item.index(character)
+      indexOfTemplater = item.index("{{")
+      if indexOfCharacter and indexOfCharacter >= 0 and (!indexOfTemplater || indexOfCharacter < indexOfTemplater)
+        item_component = item.slice!(indexOfCharacter+1..length-1)
+        if template_mapping.empty?
+          mapping = item_component
+        else
+          mapping = "_" + item_component
+        end
+        template_mapping += mapping
+      end
+    end
+  end
+  return template_mapping
+end
+
+module ApolloCommonsRuby
+  class Error < StandardError; end
+  # Your code goes here...
+end