cloudmunch_sdk_v3 3.0.0

data/lib/cloudmunch_Ruby_sdk_v2/ElasticBeanStalkServer.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/ruby
+###
+###  (c) CloudMunch Inc.
+### All Rights Reserved
+### Un-authorized copying of this file, via any medium is strictly prohibited
+###  Proprietary and confidential
+###
+###  ganesan@cloudmunch.com
+###
+
+$LOAD_PATH << '.'
+ 
+class ElasticBeanStalkServer < Server
+	attr_accessor :servername
+	attr_accessor :envname
+	attr_accessor :bucketname
+	attr_accessor :applicationName
+	attr_accessor :templateName
+	attr_accessor :description
+	attr_accessor :dns
+	attr_accessor :appName
+	attr_accessor :deployTempLoc
+	attr_accessor :assettype
+	attr_accessor :status
+	attr_accessor :starttime
+	attr_accessor :provider
+	attr_accessor :provider
+	attr_accessor :region
+	attr_accessor :cmserver
+	attr_accessor :assetname
+
+    def initialize(appContext)
+        @servername = ""
+        @envname = ""
+        @bucketname = ""
+        @applicationName = ""
+        @templateName = ""
+        @description = ""
+        @dns = ""
+        @appName = ""
+        @deployTempLoc = ""
+        @assettype = ""
+        @status = ""
+        @starttime = ""
+        @provider = ""
+        @region = ""
+        @cmserver = ""
+        @assetname = ""
+    end
+
+
+end

data/lib/cloudmunch_Ruby_sdk_v2/EnvironmentHelper.rb

@@ -0,0 +1,292 @@
+#!/usr/bin/ruby
+###
+###  (c) CloudMunch Inc.
+### All Rights Reserved
+### Un-authorized copying of this file, via any medium is strictly prohibited
+###  Proprietary and confidential
+###
+###  ganesan@cloudmunch.com
+###
+
+$LOAD_PATH << '.'
+require 'json'
+require_relative "CloudmunchConstants"
+ 
+class AssetHelper
+    include CloudmunchService
+    include Util
+
+    @appContext = nil
+    @cmDataManager = nil
+    @logHelper = nil
+    @defaultRole   = "Area_51"
+    
+    def initialize(appContext)
+        @appContext = appContext
+        @cloudmunchDataService = CloudmunchService.new 
+        @roleHelper = RoleHelper.new
+    end
+
+   # ##
+   # ## 
+   # ## @param  Json Object filterData In the format {"filterfield":"=value"}
+   # ## @return json object environmentdetails
+   # ##
+   # ##   
+   def getExistingEnvironments(filterData)
+        paramHash = {}
+        if !filterData.nil?
+            paramHash["filter"] = filterData.to_json
+        end
+
+        serverUrl = @appContext.getMasterURL() + "/applications/"  + @appContext.getProject() + "/environments"
+        envResult = @cloudmunchDataService.getDataForContext(serverUrl, @appContext.getAPIJey(), paramHash)
+
+        if envResult == nil then 
+            log("ERROR", "Unable to get data from cloudmunch") 
+            return nil
+        else
+            envResult = JSON.parse(envResult)
+            envData = envResult["data"]
+            if envData.nil? then
+                log("ERROR", "environments do not exist") 
+                return nil
+            else
+                return envData
+            end
+        end
+   end
+
+   # ###
+   # ### 
+   # ### @param  String  environmentID
+   # ### @param  Json Object filterData In the format {"filterfield":"=value"}
+   # ### @return json object environmentdetails
+   # ### 
+   # ###    
+    def getEnvironment(environmentID, filterData)
+        paramHash = {}
+        if !filterData.nil?
+            paramHash["filter"] = filterData.to_json
+        end
+        serverUrl = @appContext.getMasterURL() + "/applications/" + @appContext.getProject() + "/environments/" + environmentID
+        envResult = @cloudmunchDataService.getDataForContext(serverUrl, @appContext.getAPIJey(), paramHash)
+
+        if envResult == nil then 
+            log("ERROR", "Unable to get data from cloudmunch") 
+            return nil
+        else
+            envResult = JSON.parse(envResult)
+            envData = envResult["data"]
+            if envData.nil? then
+                log("DEBUG", "Environment does not exist") 
+                return nil
+            else
+                return envData
+            end
+        end
+    end
+
+    # ###
+    # ###
+    # ### @param string environmentName Name of the environment
+    # ### @param string environmentStatus Environment status ,valid values are success,failed,in-progress
+    # ### @param array  environmentData Array of environment properties
+    # ###
+    def addEnvironment(environmentName, environmentStatus, environmentData)
+        if environmentName.empty? || environmentStatus.empty? then
+            log("ERROR", "Environment name ,status and type need to be provided") 
+            return false
+        end
+
+        statusArray = [STATUS_CREATION_IN_PROGRESS, STATUS_RUNNING, STATUS_STOPPED, STATUS_STOPPED_WITH_ERRORS, STATUS_RUNNING_WITH_WARNINGS, STATUS_ACTION_IN_PROGRESS]
+        if !statusArray.include?(assetStatus) then
+            log("ERROR", "Invalid status sent. Allowed values " + STATUS_CREATION_IN_PROGRESS + "," + STATUS_RUNNING + "," + STATUS_STOPPED + "," + STATUS_STOPPED_WITH_ERRORS + "," STATUS_RUNNING_WITH_WARNINGS + "," + STATUS_ACTION_IN_PROGRESS) 
+            return false
+        end
+
+        environmentData["name"] = environmentName
+        environmentData["status"] = environmentStatus
+
+        serverUrl = @appContext.getMasterURL() + "/applications/" + @appContext.getProject() + "/environments/"
+        retResult = @cloudmunchDataService.updateDataForContext(serverUrl, @appContext.getAPIKey(), environmentData)
+
+        if retResult == nil then 
+            return nil
+        else
+            retResult = JSON.parse(retResult)
+            retData = retResult["data"]
+            if retData.nil? then 
+                return nil
+            else
+                return retData
+            end
+        end
+    end
+
+    # ###
+    # ###
+    # ### @param String Environment ID
+    # ### @param JsonObject Environment Data
+    # ###
+    def updateEnvironment(environmentID, environmentData, comment)
+        serverUrl = @appContext.getMasterURL() + "/applications/" + @appContext.getProject() + "/environments/" + environmentID
+        retResult = @cloudmunchDataService.updateDataForContext(serverUrl, @appContext.getAPIKey(), environmentData)
+    end
+
+    # ###
+    # ###
+    # ### @param String Environment ID
+    # ### @param URL    Environment Data
+    # ###
+    def updateEnvironmentURL(environmentID, environmentURL)
+        if environmentURL.nil? || environmentURL.empty then
+            log("ERROR", "Environment URL is not provided to update environment details") 
+            return false
+        else
+            comment = "Setting application URL";
+            paramHash = {}
+            paramHash["application_url"] = environmentURL
+            updateEnvironment(environmentID, paramHash, comment);
+        end
+    end
+
+    # ###
+    # ### 
+    # ### @param String Environment ID
+    # ### @param URL    Environment Data
+    # ###
+    def updateEnvironmentBuildVersion(environmentID, buildNumber)
+        if buildNumber.nil? || buildNumber.empty then
+            log("ERROR", "Build Number is not provided to update environment details") 
+            return false
+        else
+            comment = "Setting application build version";
+            paramHash = {}
+            paramInnerHash = {}
+            paramInnerHash["version"] = ""
+            paramInnerHash["build"] = buildNumber
+            paramHash["application"] = paramInnerHash
+            updateEnvironment(environmentID, paramHash, comment);
+        end
+    end
+
+    # ###
+    # ### 
+    # ### @param String Environment ID
+    # ### @param Array  AssetArray
+    # ### @param String Role Id
+    # ###
+    def updateAsset(environmentID, assetHash, roleID)
+        if assetHash.nil? || assetHash.empty? then
+            log("DEBUG","An array of asset ids are excpected for updating asset details to an environment")
+            return false
+        end
+
+        if !assetHash.is_h? then
+            log("INFO", "Role is not provided, creating a default role with name " + @defaultRole )
+            return false
+        end
+
+        if roleID.nil? || roleID.empty? then
+            filter = '{"name":"' + @defaultRole + '"}'
+            defaultRoleDetails = @roleHelper.getExistingRoles(filter)
+
+            if defaultRoleDetails.empty? then
+                log("INFO", "Role is not provided, creating a default role with name " + @defaultRole )
+                newRoleDetails = @roleHelper.addRole(@defaultRole)
+                roleID = newRoleDetails.id
+                paramHash = {}
+                paramInnerHash = {}
+                paramDataHash = {}
+                paramDataHash["id"] = roleID
+                paramDataHash["name"] = @defaultRole
+                paramDataHash["assets"] = assetHash
+                paramInnerHash[roleID] = paramDataHash
+                paramHash["tiers"] = paramInnerHash
+            else
+                log("INFO", "Role is not provided, linking with default role : " + @defaultRole)
+                roleID = defaultRoleDetails[0]["id"]
+                paramHash = {}
+                paramInnerHash = {}
+                paramDataHash = {}
+                paramDataHash["id"] = roleID
+                paramDataHash["name"] = '{$tiers/'  + roleID + '.name}'
+                paramDataHash["assets"] = assetHash
+                paramInnerHash[roleID] = paramDataHash
+                paramHash["tiers"] = paramInnerHash
+            end
+        else
+            paramHash = {}
+            paramInnerHash = {}
+            paramDataHash = {}
+            paramDataHash["id"] = roleID
+            paramDataHash["name"] = @defaultRole
+            paramDataHash["assets"] = assetHash
+            paramInnerHash[roleID] = paramDataHash
+            paramHash["tiers"] = paramInnerHash
+        end
+
+        comment = "Updating role asset mapping"
+        updateEnvironment(environmentID, paramHash, comment)
+    end
+
+    # ###
+    # ### 
+    # ### @param String environmentID
+    # ### @param array  key value pairs to be updated to environment details
+    # ###
+    def updateVariables(environmentID, envVariables)
+        if environmentID.nil? then
+            log("DEBUG", "Environment id value is needed for variables update on an environment")
+        else
+            variablesHash = {}
+            variablesHash["variables"] = envVariables
+            comment = "Updating variables"
+            updateEnvironment(environmentID, variablesHash, comment)
+        end
+    end
+
+    # ###
+    # ###
+    # ### @param String Environment ID
+    # ### @param String Environment status
+    # ###
+    def updateStatus(environmentID, status)
+        statusArray = [::STATUS_CREATION_IN_PROGRESS, ::STATUS_RUNNING, ::STATUS_STOPPED, ::STATUS_STOPPED_WITH_ERRORS, ::STATUS_RUNNING_WITH_WARNINGS, ::STATUS_ACTION_IN_PROGRESS]
+        if !statusArray.include?(status) then
+            log("ERROR", "Invalid status, valid values are " + ::STATUS_CREATION_IN_PROGRESS + "," + ::STATUS_RUNNING + "," + ::STATUS_STOPPED + "," + ::STATUS_STOPPED_WITH_ERRORS + "," + ::STATUS_RUNNING_WITH_WARNINGS + "," + ::STATUS_ACTION_IN_PROGRESS) 
+            return false
+        end
+
+        statusHash = {}
+        statusHash["status"] = status
+        updateEnvironment(environmentID, statusHash)
+    end
+
+    # ###
+    # ### Checks if Environment exists in cloudmunch.
+    # ### @param string $environmentID
+    # ### @return boolean
+    # ###
+    def checkIfEnvironmentExists(environmentID)
+        serverUrl = @appContext.getMasterURL() + "/applications/" + @appContext.getProject() + "/environments/" + environmentID
+
+        envResult = @cloudmunchDataService.getDataForContext(serverUrl, @appContext.getAPIKey(), "")
+        if envResult == nil then  
+            log("DEBUG", "Could not retreive data from cloudmunch")
+            return nil
+        else
+            envResult = JSON.parse(envResult)
+            envData = envResult["data"]
+            if envData.nil? then
+                log("ERROR", "Environment does not exist") 
+                return false
+            else
+                return true
+            end
+        end
+    end
+
+
+end

data/lib/cloudmunch_Ruby_sdk_v2/InsightHelper.rb

@@ -0,0 +1,770 @@
+#!/usr/bin/ruby
+require 'logger'
+require 'json'
+require_relative 'Util'
+
+module InsightHelper
+    include Util
+
+  ##################################################################################
+  ###
+  ###
+  ### createInsight(insightName)
+  ### createInsightDataStore(insightID, dataStoreName)
+  ### createInsightDataStoreExtract(insightID, dataStoreID, extractName)
+  ### createInsightReport(insightID, reportName)
+  ### createInsightReportCard(insightID, reportID, cardName)
+  ### createInsightReportKeyMetric(insightID, reportID, keyMetricName)
+  ###
+  ###
+  ### getDataStoreID(insightID, dataStoreName)
+  ### getExtractID(insightID, dataStoreID, extractName)
+  ### getReportID(insightID, reportName) 
+  ### getReportCardID(insightID, reportID, cardName)
+  ### getKeyMetricID(insightID, reportID, keyMetricName)
+  ###
+  ###
+  ### getInsights(paramHash)
+  ### getInsightDataStores(paramHash)
+  ### getInsightDataStoreExtracts(paramHash)
+  ### getInsightReports(paramHash)
+  ### getInsightReportCards(paramHash)
+  ### getInsightReportKeyMetrics(paramHash)
+  ###
+  ###
+  ### updateInsight(insightID, data)
+  ### updateInsightDataStore(insightID, dataStoreID, data)
+  ### updateInsightDataStoreExtract(insightID, dataStoreID, extractID, data)
+  ### updateInsightReport(insightID, reportID, data)
+  ### updateInsightReportCard(insightID, reportID, cardID, data)
+  ### updateInsightReportKeyMetric(insightID, reportID, keyMetricID, data)
+  ###
+  ### getListOfDatesForADuration(durationUnitNameStr, durationUnitNumber)
+  ### getInsightReportDataTemplateHash(reportTypeStr)
+  ### getInsightReportMetaTemplateHash(reportTypeStr)
+  ### getInsightReportVisualizationMapTemplateHash(reportTypeStr)
+  ################################################################################## 
+
+
+ 
+
+  ###################################################################################
+  #### createInsight(insightName)
+  #### Creates An Insight space in Server Workspace
+  #### Needed in Loader plugins
+  ###################################################################################
+  def createInsight(insightName)
+    if !insightName.nil?
+      insightID = nil
+      insightID = getInsightID(insightName)
+      
+      if !insightID.nil?
+        log("DEBUG", "Insight with name "+insightName+" already exists!")
+        return insightID
+      else
+        paramHash = {}
+        paramHash["context"]    = "insights"
+        paramHash["data"]       = {"name" => insightName}
+        insight = updateCloudmunchData(paramHash)
+        
+        if insight["id"].nil?
+          log("DEBUG", "Unable to create insight : "+insightName+"! refer log for more details")
+          return nil
+        else
+          return insight["id"]
+        end
+      end
+    else
+        log("DEBUG", "Insights name is needed for creating an insight")
+        return nil
+    end
+  end
+
+  ###################################################################################
+  #### createInsightDataStore(insightID, dataStoreName)
+  #### Creates An Insight DataStore in Server Workspace
+  #### Needed in Loader plugins
+  ###################################################################################
+  def createInsightDataStore(insightID, dataStoreName)
+    if !dataStoreName.nil? && !dataStoreName.empty? && !insightID.nil?
+      dataStoreID = nil
+      dataStoreID = getDataStoreID(insightID, dataStoreName)
+      
+      if !dataStoreID.nil?
+        log("DEBUG", "Data store with name "+dataStoreName+" already exists!")
+        return dataStoreID
+      else
+        paramHash = {}
+        paramHash["context"]    = "insights"
+        paramHash["contextID"]  = insightID
+        paramHash["subContext"] = "datastores"
+        paramHash["data"]       = {"name" => dataStoreName}
+        dataStore = updateCloudmunchData(paramHash)
+        
+        if dataStore.nil?
+          return nil
+        else
+          return dataStore["id"]
+        end
+      end
+    else
+        log("DEBUG", "Datastore name and insights id is needed for creating a data store")
+        return nil
+    end
+  end
+
+  ###################################################################################
+  #### createInsightDataStoreExtract(insightID, dataStoreID, extractName)
+  #### Creates An Insight DataStore Extract in Server Workspace
+  #### Needed In Loader Plugins
+  ###################################################################################
+  def createInsightDataStoreExtract(insightID, dataStoreID, extractName)
+    if !extractName.nil? && !extractName.empty? && !insightID.nil?  && !dataStoreID.nil?
+
+      extractID = nil
+      extractID = getExtractID(insightID, dataStoreID, extractName)
+      
+      if !extractID.nil?
+        return extractID
+      else
+        paramHash = Hash.new
+        paramHash["context"]      = "insights"
+        paramHash["contextID"]    = insightID
+        paramHash["subContext"]   = "datastores"
+        paramHash["subContextID"] = dataStoreID
+        paramHash["leafContext"]  = "extracts"
+        paramHash["data"]         = {"name" => extractName}
+
+        log("DEBUG", "Attempting creation of extract with name " + extractName + "...")
+        extract = updateCloudmunchData(paramHash)
+
+        if extract["id"].nil? then return nil else extract["id"] end
+      end
+    else
+        log("DEBUG", "Extract name, insights id and datastore id is needed for creating an extract")
+        return nil
+    end
+  end
+
+
+  ###################################################################################
+  #### createInsightReport(insightID, reportName)
+  #### Creates An Insight Report in Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def createInsightReport(insightID, reportName)
+    if !reportName.nil? && !reportName.empty? && !insightID.nil?
+
+      reportID = nil
+      reportID = getReportID(insightID, reportName)
+      
+      if !reportID.nil?
+        return reportID
+      else
+        paramHash = Hash.new
+        paramHash["context"]     = "insights"
+        paramHash["contextID"]   = insightID
+        paramHash["subContext"]  = "insight_reports"
+        paramHash["data"]        = {"name" => reportName}
+
+        log("DEBUG", "Attempting creation of report with name " + reportName + "...")
+        report = updateCloudmunchData(paramHash)
+
+        if report["id"].nil? then return nil else report["id"] end
+      end
+    else
+        log("DEBUG", "Report name and insight id is needed for creating a report")
+        return nil
+    end
+  end
+
+  ###################################################################################
+  #### createInsightReportCard(insightID, reportID, cardName)
+  #### Creates An Insight Report Card in Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def createInsightReportCard(insightID, reportID, cardName)
+    if !cardName.nil? && !cardName.empty? && !insightID.nil?  && !reportID.nil?
+
+      cardID = nil
+      cardID = getReportCardID(insightID, reportID, cardName)
+      
+      if !cardID.nil?
+        return cardID
+      else
+        paramHash = Hash.new
+        paramHash["context"]      = "insights"
+        paramHash["contextID"]    = insightID
+        paramHash["subContext"]   = "insight_reports"
+        paramHash["subContextID"] = reportID
+        paramHash["leafContext"]  = "insight_cards"
+        paramHash["data"]         = {"name" => cardName}
+
+        log("DEBUG", "Attempting creation of report card with name " + cardName + "...")
+        card = updateCloudmunchData(paramHash)
+
+        if card["id"].nil? then return nil else card["id"] end
+      end
+    else
+        log("DEBUG", "Extract name, insight id and report id is needed for creating a report card")
+        return nil
+    end
+  end
+
+  
+
+  ###################################################################################
+  #### createInsightReportKeyMetric(insightID, reportID, keyMetricName)
+  #### Creates An Insight Report Key Metric in Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def createInsightReportKeyMetric(insightID, reportID, keyMetricName)
+    if !keyMetricName.nil? && !keyMetricName.empty? && !insightID.nil?  && !reportID.nil?
+
+      keyMetricID = nil
+      keyMetricID = getReportKeyMetricID(insightID, reportID, keyMetricName)
+      
+      if !keyMetricID.nil?
+        return keyMetricID
+      else
+        paramHash = Hash.new
+        paramHash["context"]      = "insights"
+        paramHash["contextID"]    = insightID
+        paramHash["subContext"]   = "insight_reports"
+        paramHash["subContextID"] = reportID
+        paramHash["leafContext"]  = "insight_cards"
+        paramHash["data"]         = {"name" => keyMetricName}
+
+        log("DEBUG", "Attempting creation of report key metric with name " + keyMetricName + "...")
+        keyMetric = updateCloudmunchData(paramHash)
+
+        if keyMetric["id"].nil? then return nil else keyMetric["id"] end
+      end
+    else
+        log("DEBUG", "Key metric name, insight id and report id is needed for creating a report key metric")
+        return nil
+    end
+  end
+
+
+   ###################################################################################
+  #### getDataStoreID(insightID, dataStoreName)
+  #### Gets DataStore ID for a given DataStore
+  #### <NOTE>
+  ###################################################################################
+  def getDataStoreID(insightID, dataStoreName)
+      if insightID.nil? || dataStoreName.nil?
+        log("DEBUG", "insight id and datastore name is needed to get datastore id")
+        return nil
+      end
+
+      paramHash = Hash.new
+      paramHash["insightID"] = insightID
+      paramHash["filter"] = {"name" => dataStoreName} 
+      paramHash["count"]  = 1
+      paramHash["fields"] = "id" 
+
+      dataStore = getInsightDataStores(paramHash)
+      
+      if dataStore.nil? 
+        log("DEBUG", "Data store with name "+dataStoreName+" does not exist")
+        return nil
+      elsif (dataStore.kind_of?(Array)) && (dataStore.length.to_i > 0)
+        return dataStore[0]["id"]
+      else
+        log("DEBUG", "Data store with name "+dataStoreName+" does not exist")
+        return nil
+      end
+  end
+
+  ###################################################################################
+  #### getExtractID(insightID, dataStoreID, extractName)
+  #### Gets Extract ID for a given extract in a DataStore
+  #### <NOTE>
+  ###################################################################################
+  def getExtractID(insightID, dataStoreID, extractName)
+      if insightID.nil? || dataStoreID.nil? || extractName.nil?
+        log("DEBUG", "insight id, datastore id and extract name is needed to get extract id")
+        return nil
+      end
+
+      extract = nil
+      paramHash = Hash.new
+      paramHash["insightID"]   = insightID
+      paramHash["dataStoreID"] = dataStoreID
+      paramHash["filter"] = {"name" => extractName}
+      paramHash["count"]  = 1
+      paramHash["fields"] = "id" 
+
+      extract = getInsightDataStoreExtracts(paramHash)
+
+      if extract.nil? 
+        log("DEBUG", "Extract with name "+extractName+" does not exist")
+        return nil
+      elsif (extract.kind_of?(Array)) && (extract.length.to_i > 0)
+        return extract[0]["id"]
+      else
+        log("DEBUG", "Extract with name "+extractName+" does not exist")
+        return nil
+      end
+  end
+
+  ###################################################################################
+  #### getReportID(insightID, reportName)
+  #### Gets Report ID for a given report
+  #### <NOTE>
+  ###################################################################################
+  def getReportID(insightID, reportName)
+    if insightID.nil? || reportName.nil?
+      log("DEBUG", "insight id and report name is needed to get report id")
+      return nil
+    end
+
+    paramHash = Hash.new
+    paramHash["insightID"] = insightID
+    paramHash["filter"] = {"name" => reportName} 
+    paramHash["count"]  = 1
+    paramHash["fields"] = "id" 
+
+    report = getInsightReports(paramHash)
+
+    if report.nil? 
+      log("DEBUG", "Report with name "+reportName+" does not exist")
+      return nil
+    elsif (report.kind_of?(Array)) && (report.length.to_i > 0)
+      return report[0]["id"]
+    else
+      log("DEBUG", "Report with name "+reportName+" does not exist")
+      return nil
+    end
+end
+
+
+  
+  ###################################################################################
+  #### getReportCardID(insightID, reportID, cardName)
+  #### Gets Report Card ID for a given report card
+  #### <NOTE>
+  ###################################################################################
+  def getReportCardID(insightID, reportID, cardName)
+      if insightID.nil? || reportID.nil? || cardName.nil?
+        log("DEBUG", "insight id, report id and card name is needed to get report card id")
+        return nil
+      end
+
+      card = nil
+      paramHash = Hash.new
+      paramHash["insightID"] = insightID
+      paramHash["reportID"] = reportID
+      paramHash["filter"] = {"name" => cardName}
+      paramHash["count"]  = 1
+      paramHash["fields"] = "id" 
+
+      card = getInsightReportCards(paramHash)
+
+      if card.nil? 
+        log("DEBUG", "Report with name "+cardName+" does not exist")
+        return nil
+      elsif (card.kind_of?(Array)) && (card.length.to_i > 0)
+        return card[0]["id"]
+      else
+        log("DEBUG", "Report with name "+cardName+" does not exist")
+        return nil
+      end
+  end
+
+  ###################################################################################
+  #### getKeyMetricID(insightID, reportID, keyMetricName)
+  #### Gets Key Metric ID for a given report card
+  #### <NOTE>
+  ###################################################################################
+  def getKeyMetricID(insightID, reportID, keyMetricName)
+      paramHash = Hash.new
+      paramHash["insightID"] = insightID
+      paramHash["reportID"] = reportID
+      paramHash["filter"] = {"name" => keyMetricName}
+      paramHash["count"]  = 1
+      paramHash["fields"] = "id" 
+
+      keyMetric = getInsightReportCards(paramHash)
+      if keyMetric.nil? || !keyMetric.any?
+        log("DEBUG", "Report key metric with name "+keyMetricName+" does not exist")
+        return nil
+      else
+        return keyMetric[0]["id"]
+      end
+  end
+
+  ###################################################################################
+  #### getInsights(paramHash)
+  #### Get Insights from Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def getInsights(paramHash)
+    # /insights/{insight_id}
+    paraminsightID = paramHash["insightID"].nil? ? nil : paramHash["insightID"]
+
+    paramFormatted = Hash.new
+    paramFormatted = paramHash
+    paramFormatted["context"] = "insights"
+    
+    if !paraminsightID.nil? && !paraminsightID.empty?
+        paramFormatted["contextID"]  = paramInsightID
+    end    
+
+    return getCloudmunchData(paramFormatted)          
+  end
+
+
+  ###################################################################################
+  #### getInsightDataStores(paramHash)
+  #### Get Insight DataStores from Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def getInsightDataStores(paramHash)
+    # /insights/{insight_id}/datastores/{datastore_id}
+    paramInsightID  = paramHash["insightID"].nil? ? nil : paramHash["insightID"]
+
+    if paramInsightID.nil? || paramInsightID.empty?
+      log("DEBUG", "Insight id is not provided")
+      return nil
+    end
+
+    paramFormatted = Hash.new
+    paramFormatted = paramHash
+    paramFormatted["context"]    = "insights"
+    paramFormatted["subContext"] = "datastores"
+    paramFormatted["contextID"]  = paramInsightID
+    
+    if !paramHash["dataStoreID"].nil?
+      paramFormatted["subContextID"] = paramHash["dataStoreID"]
+    end
+    return getCloudmunchData(paramFormatted)          
+  end
+
+  ###################################################################################
+  #### getInsightDataStoreExtracts(paramHash)
+  #### Get Insight DataStore Extracts from Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def getInsightDataStoreExtracts(paramHash)
+    # /insights/{insight_id}/datastores/{datastore_id}/extracts/{extract_id}
+    paramDataStoreId = paramHash["dataStoreID"].nil? ? nil : paramHash["dataStoreID"]
+    paramInsightID   = paramHash["insightID"].nil? ? nil : paramHash["insightID"]
+
+    serverurl   = nil
+
+    if paramInsightID.nil? || paramInsightID.empty? || paramDataStoreId.nil? || paramDataStoreId.empty?
+      log("DEBUG", "Insight id and datastore id is needed to gets its extract details")
+      return nil
+    end
+
+    paramFormatted = Hash.new
+    paramFormatted = paramHash
+    paramFormatted["context"]      = "insights"
+    paramFormatted["subContext"]   = "datastores"
+    paramFormatted["leafContext"]  = "extracts"
+    paramFormatted["contextID"]    = paramInsightID
+    paramFormatted["subContextID"] = paramDataStoreId
+    
+    if !paramHash["extractID"].nil?
+      paramFormatted["leafContextID"] = paramHash["extractID"]
+    end
+
+    return getCloudmunchData(paramFormatted)
+  end
+
+  ###################################################################################
+  #### getInsightReports(paramHash)
+  #### Get Insight Reports from Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def getInsightReports(paramHash)
+    # /applications/{application_id}/insights/{insight_id}/insight_reports/{insight_report_id}
+    paramInsightID = paramHash["insightID"].nil? ? nil : paramHash["insightID"]
+
+    if paramInsightID.nil? || paramInsightID.empty?
+      log("DEBUG", "Insight id is needed to gets its report details")
+      return nil
+    end
+
+    paramFormatted = Hash.new
+    paramFormatted = paramHash
+    paramFormatted["context"]    = "insights"
+    paramFormatted["subContext"] = "insight_reports"
+    paramFormatted["contextID"]  = paramInsightID
+    
+    if !paramHash["reportID"].nil?
+      paramFormatted["subContextID"] = paramHash["reportID"]
+    end
+
+    return getCloudmunchData(paramFormatted)
+  end
+
+  ###################################################################################
+  #### getInsightReportCards(paramHash)
+  #### Get Insight Report Cards from Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def getInsightReportCards(paramHash)
+    # /applications/{application_id}/insights/{insight_id}/insight_reports/{insight_report_id}/insight_cards/{insight_card_id}
+    paramReportId  = paramHash["reportID"].nil? ? nil : paramHash["reportID"]
+    paramInsightID = paramHash["insightID"].nil? ? nil : paramHash["insightID"]
+
+    if paramInsightID.nil? || paramInsightID.empty? || paramReportId.nil? || paramReportId.empty?
+      log("DEBUG", "Insight id and report id is needed to gets its report card details")
+      return nil
+    end
+
+    paramFormatted = Hash.new
+    paramFormatted = paramHash
+    paramFormatted["context"]      = "insights"
+    paramFormatted["subContext"]   = "insight_reports"
+    paramFormatted["leafContext"]  = "insight_cards"
+    paramFormatted["contextID"]    = paramInsightID
+    paramFormatted["subContextID"] = paramReportId
+    
+    if !paramHash["cardID"].nil?
+      paramFormatted["leafContextID"] = paramHash["cardID"]
+    end
+
+    return getCloudmunchData(paramFormatted)
+  end
+
+  ###################################################################################
+  #### getInsightReportKeyMetrics(paramHash)
+  #### Get Insight Report Key Metrics from Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def getInsightReportKeyMetrics(paramHash)
+    # /applications/{application_id}/insights/{insight_id}/insight_reports/{insight_report_id}/key_metrics/{key_metric_id}
+    paramReportId  = paramHash["reportID"].nil? ? nil : paramHash["reportID"]
+    paramInsightID = paramHash["insightID"].nil? ? nil : paramHash["insightID"]
+
+    if paramInsightID.nil? || paramInsightID.empty? || paramReportId.nil? || paramReportId.empty?
+      log("DEBUG", "Insight id and report id is needed to gets its report key metric details")
+      return nil
+    end
+
+    paramFormatted = Hash.new
+    paramFormatted = paramHash
+    paramFormatted["context"]      = "insights"
+    paramFormatted["subContext"]   = "insight_reports"
+    paramFormatted["leafContext"]  = "key_metrics"
+    paramFormatted["contextID"]    = paramInsightID
+    paramFormatted["subContextID"] = paramReportId
+    
+    if !paramHash["keyMetricID"].nil?
+      paramFormatted["leafContextID"] = paramHash["keyMetricID"]
+    end
+
+    return getCloudmunchData(paramFormatted)
+  end
+
+  ###################################################################################
+  #### updateInsight(insightID, data)
+  #### Updates Insight Into Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def updateInsight(insightID, data)
+    # /applications/{application_id}/insights/{insight_id}
+
+    if (insightID.nil? || insightID.empty?) && data.nil?
+      log("DEBUG", "Insight id and data is needed to be update an existing data store")
+      return nil
+    end
+
+    paramHash = {}
+    paramHash["context"]   = "insights"
+    paramHash["contextID"] = insightID
+    paramHash["data"]      = data
+    return updateCloudmunchData(paramHash)
+  end
+
+
+  ###################################################################################
+  #### updateInsightDataStore(insightID, dataStoreID, data)
+  #### Updates Insight DataStore Into Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def updateInsightDataStore(insightID, dataStoreID, data)
+    # /applications/{application_id}/insights/{insight_id}/datastores/{datastore_id}
+
+    if (insightID.nil? || insightID.empty?) && (dataStoreID.nil? || dataStoreID.empty?) && data.nil?
+      log("DEBUG", "Insight id, datastore id and data is needed to be update an existing data store")
+      return nil
+    end
+        paramHash = {}
+        paramHash["context"]      = "insights"
+        paramHash["contextID"]    = insightID
+        paramHash["subContext"]   = "datastores"
+        paramHash["subContextID"] = dataStoreID
+        paramHash["data"]         = data
+        return updateCloudmunchData(paramHash)
+  end
+
+  ###################################################################################
+  #### updateInsightDataStoreExtract(insightID, dataStoreID, extractID, data)
+  #### Updates Insight DataStore Extract In Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def updateInsightDataStoreExtract(insightID, dataStoreID, extractID, data)
+    # /insights/{insight_id}/datastores/{datastore_id}/extracts/{extract_id}
+
+    if (insightID.nil? || insightID.empty?) && (dataStoreID.nil? || dataStoreID.empty?) && (extractID.nil? || extractID.empty?) && data.nil?
+      log("DEBUG", "Insight id, datastore id, extract id and data is needed to be update an existing extract")
+      return nil
+    end
+        paramHash = {}
+        paramHash["context"]       = "insights"
+        paramHash["contextID"]     = insightID
+        paramHash["subContext"]    = "datastores"
+        paramHash["subContextID"]  = dataStoreID
+        paramHash["leafContext"]   = "extracts"
+        paramHash["leafContextID"] = extractID
+        paramHash["data"]          = data
+        return updateCloudmunchData(paramHash)
+  end
+
+  ###################################################################################
+  #### updateInsightReport(insightID, reportID, data)
+  #### Updates Insight Report In Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def updateInsightReport(insightID, reportID, data)
+    # /applications/{application_id}/insights/{insight_id}/insight_reports/{insight_report_id}
+
+    if (insightID.nil? || insightID.empty?) && (reportID.nil? || reportID.empty?) && data.nil?
+      log("DEBUG", "Insight id, report id and data is needed to be update an existing report")
+      return nil
+    end
+        paramHash = {}
+        paramHash["context"]      = "insights"
+        paramHash["contextID"]    = insightID
+        paramHash["subContext"]   = "insight_reports"
+        paramHash["subContextID"] = reportID
+        paramHash["data"]         = data
+        return updateCloudmunchData(paramHash)
+  end
+
+
+  ###################################################################################
+  #### updateInsightReportCard(insightID, reportID, cardID, data)
+  #### Updates Insight Report Card In Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def updateInsightReportCard(insightID, reportID, cardID, data)
+    # /applications/{application_id}/insights/{insight_id}/insight_reports/{insight_report_id}/insight_cards/{insight_card_id}
+
+    if (insightID.nil? || insightID.empty?) && (reportID.nil? || reportID.empty?) && (cardID.nil? || cardID.empty?) && data.nil?
+      log("DEBUG", "Insight id, report id, cardID and data is needed to be update an existing report card")
+      return nil
+    end
+
+    paramHash = {}
+    paramHash["context"]       = "insights"
+    paramHash["contextID"]     = insightID
+    paramHash["subContext"]    = "insight_reports"
+    paramHash["subContextID"]  = reportID
+    paramHash["leafContext"]   = "insight_cards"
+    paramHash["leafContextID"] = cardID
+    paramHash["data"]          = data
+    return updateCloudmunchData(paramHash)
+  end
+
+  ###################################################################################
+  #### updateInsightReportKeyMetric(insightID, reportID, keyMetricID, data)
+  #### Updates Insight Report KeyMetric In Server Workspace
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def updateInsightReportKeyMetric(insightID, reportID, keyMetricID, data)
+    # /applications/{application_id}/insights/{insight_id}/insight_reports/{insight_report_id}/key_metrics/{key_metric_id}
+
+    if (insightID.nil? || insightID.empty?) && (reportID.nil? || reportID.empty?) && (keyMetricID.nil? || keyMetricID.empty?) && data.nil?
+      log("DEBUG", "Insight id, report id, keyMetricID and data is needed to be update an existing report key metric")
+      return nil
+    end
+
+    paramHash = {}
+    paramHash["context"]       = "insights"
+    paramHash["contextID"]     = insightID
+    paramHash["subContext"]    = "insight_reports"
+    paramHash["subContextID"]  = reportID
+    paramHash["leafContext"]   = "key_metrics"
+    paramHash["leafContextID"] = keyMetricID
+    paramHash["data"]          = data
+    return updateCloudmunchData(paramHash)
+  end
+
+  ###################################################################################
+  #### getListOfDatesForADuration(durationUnitNameStr, durationUnitNumber)
+  #### durationUnitNameStr : days | weeks | months
+  #### durationUnitNumber : Eg. 1 to N
+  #### Get List(Array) of Dates (history) for a given duration from current day
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def getListOfDatesForADuration(durationUnitNameStr, durationUnitNumber)
+        log("info", __method__.to_s + " method is invoked from InsightsGitHubOrgsReposWithSize")
+        $i = 0
+        duration_arr = []
+        $curr_date = Date.today
+        $tmp_unit = nil
+        $tmp_days_in_month = nil
+
+        case durationUnitNameStr.downcase
+        when "days"
+            while $i < durationUnitNumber
+                $tmp_unit = $curr_date.strftime("%Y-%m-%d")
+                duration_arr[$i] = $tmp_unit
+                $curr_date -= 1
+                $i += 1
+            end
+        when "weeks"
+            while $i < durationUnitNumber
+                $tmp_unit = $curr_date.strftime("%Y-%m-%d")
+                duration_arr[$i] = $tmp_unit
+                $curr_date -= 7
+                $i += 1
+            end
+        when "months"
+            while $i < durationUnitNumber
+                $tmp_unit = $curr_date.strftime("%Y-%m-%d")
+                $tmp_days_in_month = $curr_date.day
+                duration_arr[$i] = $tmp_unit
+                $curr_date -= $tmp_days_in_month
+                $i += 1
+            end
+        end
+
+        return duration_arr
+  end
+
+  ###################################################################################
+  #### getInsightReportDataTemplateHash(reportTypeStr)
+  #### Gets the data template Hash that needs to be filled in for a given report type
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def getInsightReportDataTemplateHash(reportTypeStr)
+
+  end
+
+  ###################################################################################
+  #### getInsightReportMetaTemplateHash(reportTypeStr)
+  #### Gets the meta template Hash that needs to be filled in for a given report type
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def getInsightReportMetaTemplateHash(reportTypeStr)
+
+  end
+
+  ###################################################################################
+  #### getInsightReportVisualizationMapTemplateHash(reportTypeStr)
+  #### Gets the visualization map template Hash that needs to be filled in for a given report type
+  #### Needed In Reporter Plugins
+  ###################################################################################
+  def getInsightReportVisualizationMapTemplateHash(reportTypeStr)
+
+  end
+
+end
+