idnio 2.3.3b → 2.3.4b

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afc6ee33e894329b2b06bafc2c6faaecd7ecf4e3c02f57e93a28982472393d6d
-  data.tar.gz: f3f30b000a14b49340bb4cec18033ff806c70ef695e4c2c0c4cab06f5e11acff
+  metadata.gz: 234e7989d08547431973ed6b2eba00dadbf49a44a487acec83bd821e55c075cd
+  data.tar.gz: b4f45179bebc778d5336a3c5e961d03157def8760fd24eab659617505a497cf4
 SHA512:
-  metadata.gz: 2747b53f8ccb2839b001e8aaab3b39aba77673d5a08ca0855c92a1c152bc046da0ab2f0d9e1b0bcdc8722e1bde515f4021750cf18f2d346f25427d335b653e07
-  data.tar.gz: 9098412cc2d768cab5a855b10b78b972440c8f6ad4504dc7ac163c95ebb57ffe17a7c23ec5431faba469f89efffa36c1340d302ef27def9f8a07c1cf36ebeabc
+  metadata.gz: 4b18ac54cd44404626e4e8a3977ddef9e1fc0e47a922eae6af19f183e46aef469971595ccd5255b5b88b196238d8f1a57fbff67d19f1e2744cd878ee10a57ce9
+  data.tar.gz: 716c81d01d634d63744f170363298a5d93fe982a5328eeaaa51433e0a0a483c030168eba2e44a614e8694383a3982a87d25889cdd1cb2f19cbed600ed32a1a7c

data/lib/idnio/version.rb

@@ -1,4 +1,4 @@
 module Idnio
-  VERSION = "2.3.3b"
-  UPDATE_DATE = "2019-11-12"
+  VERSION = "2.3.4b"
+  UPDATE_DATE = "2019-11-13"
 end

data/lib/objects/access-profiles.rb

@@ -7,32 +7,39 @@ require "idnio/markdown"
 module AccessProfiles
 
   #
-  # Converts Entitlement IDs to Entitlement Names
+  # Gets Access Profile Name from ID
   #
-  def self.getEntitlements( entitlement_ids )
+  def self.get_name_from_id( id )
+    result = ReferenceResolver.search_for_single_object( "accessprofiles", "id:#{id}" )
+    unless result.nil?
+      return result['name']
+    end
+    return nil
+  end
 
-    entitlementNames = ""
+  #
+  # Gets Access Profile ID from Name
+  #
+  def self.get_id_from_name( name )
+    result = ReferenceResolver.search_for_single_object( "accessprofiles", "name:#{name}" )
+    unless result.nil?
+      return result['id']
+    end
+    return nil
+  end
 
+  #
+  # Converts Entitlement IDs to Entitlement Names
+  #
+  def self.get_entitlements( entitlement_ids )
+    entitlement_names = []
     entitlement_ids.each do |entitlement_id|
-
-      response = IDNAPI.get( "#{$url}/v2/search/entitlements?query='id=#{entitlement_id}''", $token )
-
-      case response
-      when Net::HTTPSuccess
-
-        entitlements = JSON.parse( response.body )
-
-        entitlements.each do |entitlement|
-          if (entitlementNames != "")
-            entitlementNames << ";"
-          end
-          entitlementNames << entitlement['name']
-        end
+      result = ReferenceResolver.search_for_single_object( "entitlements", "id:#{entitlement_id}" )
+      unless result.nil?
+        entitlement_names.push( result['name'] )
       end
-
     end
-
-    return entitlementNames
+    return entitlement_names
   end
 
   #
@@ -45,22 +52,22 @@ module AccessProfiles
     case response
     when Net::HTTPSuccess
 
-      accessProfiles = JSON.parse( response.body )
+      access_profiles = JSON.parse( response.body )
 
-      $log.info "\tDetected #{accessProfiles['count']} access profiles."
+      $log.info "\tRetrieved #{access_profiles['count']} access profiles."
 
-      accessProfiles['items'].each do |accessProfile|
+      access_profiles['items'].each do |access_profile|
 
-        $log.info "\tAccess Profile: #{accessProfile["name"]}"
+        $log.info "\tAccess Profile: #{access_profile["name"]}"
 
-        accessProfile['entitlementNames'] = AccessProfiles.getEntitlements( accessProfile['entitlements'] )
+        access_profile['entitlementNames'] = AccessProfiles.get_entitlements( access_profile['entitlements'] )
 
-        Program.write_file( "#{directory}/access-profiles/", "Access Profile - #{accessProfile["name"]}.json", JSON.pretty_generate( accessProfile ) )
+        Program.write_file( "#{directory}/access-profiles/", "Access Profile - #{access_profile["name"]}.json", JSON.pretty_generate( access_profile ) )
 
       end # transforms["items"].each do |transform|
 
     else
-      $log.error "\tError: Unable to fetch access profiles."
+      $log.error "\tError: Unable to retrieve access profiles."
     end # case response
 
   end # def self.export( directory )
@@ -82,23 +89,26 @@ module AccessProfiles
     case response
     when Net::HTTPSuccess
 
-      accessProfiles = JSON.parse( response.body )
+      access_profiles = JSON.parse( response.body )
 
-      $log.info "\tDetected #{accessProfiles['count']} access profiles."
+      $log.info "\tRetrieved #{access_profiles['count']} access profiles."
 
-      Markdown.h2( "Access Profiles" )
-      Markdown.text( "| Name | Description | Entitlements | Requestable |\n")
-      Markdown.text( "|------|-------------|--------------|-------------|\n")
+      Markdown.h2 "Access Profiles"
+      Markdown.text "| Name | Description | Requestable | Entitlements |\n"
+      Markdown.text "|------|-------------|-------------|--------------|\n"
 
-      accessProfiles['items'].each do |accessProfile|
+      access_profiles['items'].each do |access_profile|
 
-        $log.info "\tAccess Profile: #{accessProfile["name"]}"
-        Markdown.text( "|#{accessProfile["name"]}|#{accessProfile["description"]}|#{accessProfile["sourceName"]}: #{AccessProfiles.getEntitlements(accessProfile["entitlements"])}|#{accessProfile["requestable"]}|\n")
+        $log.info "\tAccess Profile: #{access_profile["name"]}"
 
-      end # transforms["items"].each do |transform|
+        entitlement_names = AccessProfiles.get_entitlements( access_profile['entitlements'] )
+
+        Markdown.text( "|#{access_profile["name"]}|#{access_profile["description"]}|#{access_profile["sourceName"]}: #{Program.humanize( access_profile["requestable"] )}|#{entitlement_names.join(", ")}|\n")
+
+      end # access_profiles['items'].each do |access_profile|
 
     else
-      $log.error "\tError: Unable to fetch access profiles."
+      $log.error "\tError: Unable to retrieve access profiles."
     end # case response
 
     Markdown.write

data/lib/objects/account-profiles.rb

@@ -18,7 +18,7 @@ module AccountProfiles
 
       sources = JSON.parse( response.body )
 
-      $log.info "\tDetected #{sources.count} account profiles, across #{sources.count} sources."
+      $log.info "\tRetrieved account profiles, across #{sources.count} sources."
 
       sources.each do |source|
 
@@ -37,13 +37,13 @@ module AccountProfiles
           end # accountProfiles.each do |accountProfile|
 
         else
-          $log.error "\tError: Unable to fetch account profile for source #{source["name"]}."
+          $log.error "\tError: Unable to retrieve account profile for source #{source["name"]}."
         end # case response
 
       end # sources.each do |source|
 
     else
-      $log.error "\tError: Unable to fetch sources, for account profiles."
+      $log.error "\tError: Unable to retrieve sources, for account profiles."
     end # case response
 
   end # def self.export( directory )
@@ -114,7 +114,7 @@ module AccountProfiles
 
       sources = JSON.parse( response.body )
 
-      $log.info "\tDetected #{sources.count} account profiles, across #{sources.count} sources."
+      $log.info "\tRetrieved account profiles, across #{sources.count} sources."
 
       Markdown.h2( "Account Profiles" )
 
@@ -152,13 +152,13 @@ module AccountProfiles
           end # accountProfiles.each do |accountProfile|
 
         else
-          $log.error "\tError: Unable to fetch account profile for source #{source["name"]}."
+          $log.error "\tError: Unable to retrieve account profile for source #{source["name"]}."
         end # case response
 
       end # sources.each do |source|
 
     else
-      $log.error "\tError: Unable to fetch sources, for account profiles."
+      $log.error "\tError: Unable to retrieve sources, for account profiles."
     end # case response
 
     Markdown.write

data/lib/objects/account-schemas.rb

@@ -212,7 +212,7 @@ s
 
       unless sources.nil?
 
-        $log.info "\tDetected #{sources.count} account schemas, across #{sources.count} sources."
+        $log.info "\tRetrieved account schemas, across #{sources.count} sources."
 
         sources.each do |source|
 
@@ -224,11 +224,18 @@ s
           when Net::HTTPSuccess
 
             account_schema = JSON.parse( response.body )
-
             Program.write_file("#{directory}/account-schemas/", "Account Schema - #{source['name']} - #{account_schema['objectType']}.json", JSON.pretty_generate( account_schema ) )
 
+          # When an account schema is null, we get a HTTP 400 Bad Request instead of null, empty or 204 No Content.  We've raised a bug (IDNARSENAL-6274) on this.
+          # Until this returns something better, we'll protect our code and only output this only in debug mode.  We don't want to error unnecessarily.
+          when Net::HTTPBadRequest
+
+            $log.debug "\tError: Unable to fetch account schema for source '#{source['name']}'. Received 400 Bad Request, likely due to empty or null schema."
+
           else
+
             $log.error "\tError: Unable to fetch account schema for source '#{source['name']}'."
+
           end # case response
 
         end # sources.each do |source|
@@ -236,7 +243,7 @@ s
       end # unless sources.nil?
 
     else
-      $log.error "\tError: Unable to fetch sources."
+      $log.error "\tError: Unable to retrieve sources."
     end # case response
 
   end
@@ -305,36 +312,65 @@ s
   # Documents Account Schema configurations.
   #
   def self.doc
-    Markdown.h2( "Account Schemas" )
 
-    response = IDNAPI.get( "#{$url}/cc/api/source/list", $token )
-    unless response.nil?
+    response = IDNAPI.get("#{$url}/cc/api/source/list", $token)
+
+    case response
+    when Net::HTTPSuccess
+
       sources = JSON.parse( response.body )
 
-      $log.info "\tDetected #{sources.count} account schemas, across #{sources.count} sources."
-
-      sources.each do |source|
-
-        accountSchema = IDNAPI.get( "#{$url}/cc/api/source/getAccountSchema/#{source["id"]}", $token )
-        unless accountSchema.nil?
-          accountSchema = JSON.parse( accountSchema.body )
-          $log.info "\tAccount Schema: #{source["name"]} - #{accountSchema["objectType"]}"
-
-          unless ( accountSchema["attributes"].nil? || accountSchema["attributes"].empty? )
-            Markdown.h3( "#{source["name"]}" )
-            Markdown.text( " - Object Type: #{accountSchema["objectType"]}\n" )
-            Markdown.text( " - Account ID: #{accountSchema["identityAttribute"]}\n" )
-            Markdown.text( " - Account Name: #{accountSchema["displayAttribute"]}\n" )
-            Markdown.text( " - Group Attribute: #{accountSchema["groupAttribute"]}\n\n" )
-            Markdown.text( "| Name | Description | Type | Multi-valued | Entitlement |\n" )
-            Markdown.text( "|------|-------------|------|--------------|-------------|\n" )
-            accountSchema["attributes"].each do |attribute|
-              Markdown.text( "|#{attribute["name"]}|#{attribute["description"]}|#{attribute["type"]}|#{Program.humanize( attribute["entitlement"] )}|#{Program.humanize( attribute["multi"] )}|\n" )
+      unless sources.nil?
+
+        $log.info "\tRetrieved account schemas, across #{sources.count} sources."
+
+        Markdown.h2 "Account Schemas"
+
+        sources.each do |source|
+
+          $log.info "\tAccount Schema: #{source['name']}"
+
+          response = IDNAPI.get( "#{$url}/cc/api/source/getAccountSchema/#{source['id']}", $token )
+
+          case response
+          when Net::HTTPSuccess
+
+            account_schema = JSON.parse( response.body )
+
+            $log.info "\tAccount Schema: #{source["name"]} - #{account_schema["objectType"]}"
+
+            unless ( account_schema["attributes"].nil? || account_schema["attributes"].empty? )
+              Markdown.h3( "#{source["name"]}" )
+              Markdown.text( " - Object Type: #{account_schema["objectType"]}\n" )
+              Markdown.text( " - Account ID: #{account_schema["identityAttribute"]}\n" )
+              Markdown.text( " - Account Name: #{account_schema["displayAttribute"]}\n" )
+              Markdown.text( " - Group Attribute: #{account_schema["groupAttribute"]}\n\n" )
+              Markdown.text( "| Name | Description | Type | Multi-valued | Entitlement |\n" )
+              Markdown.text( "|------|-------------|------|--------------|-------------|\n" )
+              account_schema["attributes"].each do |attribute|
+                Markdown.text( "|#{attribute["name"]}|#{attribute["description"]}|#{attribute["type"]}|#{Program.humanize( attribute["entitlement"] )}|#{Program.humanize( attribute["multi"] )}|\n" )
+              end
             end
-          end
-        end
-      end
-    end
+
+          # When an account schema is null, we get a HTTP 400 Bad Request instead of null, empty or 204 No Content.  We've raised a bug (IDNARSENAL-6274) on this.
+          # Until this returns something better, we'll protect our code and only output this only in debug mode.  We don't want to error unnecessarily.
+          when Net::HTTPBadRequest
+
+            $log.debug "\tError: Unable to fetch account schema for source '#{source['name']}'. Received 400 Bad Request, likely due to empty or null schema."
+
+          else
+
+            $log.error "\tError: Unable to fetch account schema for source '#{source['name']}'."
+
+          end # case response
+
+        end # sources.each do |source|
+
+      end # unless sources.nil?
+
+    else
+      $log.error "\tError: Unable to retrieve sources."
+    end # case response
 
     Markdown.write
   end

data/lib/objects/attribute-sync-config.rb

@@ -33,21 +33,36 @@ module AttributeSyncConfig
   def self.export( directory )
 
     response = IDNAPI.get( "#{$url}/cc/api/source/list", $token )
-    unless response.nil?
+
+    case response
+    when Net::HTTPSuccess
+
       sources = JSON.parse( response.body )
 
-      $log.info "\tDetected #{sources.count} attribute sync config, across #{sources.count} sources."
+      $log.info "\tRetrieved attribute sync config, across #{sources.count} sources."
 
       sources.each do |source|
+
         response = IDNAPI.get( "#{$url}/cc/api/source/getAttributeSyncConfig/#{source["id"]}", $token )
 
-        unless response.nil?
-          config = JSON.parse( response.body )
+        case response
+        when Net::HTTPSuccess
+
+          attribute_sync_config = JSON.parse( response.body )
+
           $log.info "\tAttribute Sync Config: #{source["name"]}"
-          Program.write_file( "#{directory}/attribute-sync-config/", "Attribute Sync Config - #{source["name"]}.json", JSON.pretty_generate( config ) )
-        end
-      end
-    end
+          Program.write_file( "#{directory}/attribute-sync-config/", "Attribute Sync Config - #{source["name"]}.json", JSON.pretty_generate( attribute_sync_config ) )
+
+        else
+          $log.error "\tError: Unable to retrieve attribute sync config."
+        end # case response
+
+      end # sources.each do |source|s
+
+    else
+      $log.error "\tError: Unable to retrieve sources."
+    end # case response
+
   end
 
   #
@@ -89,33 +104,46 @@ module AttributeSyncConfig
   #
   def self.doc
 
-    Markdown.h2( "Attribute Sync Config" )
-
     response = IDNAPI.get( "#{$url}/cc/api/source/list", $token )
 
-    unless response.nil?
+    case response
+    when Net::HTTPSuccess
 
       sources = JSON.parse( response.body )
 
-      $log.info "\tDetected #{sources.count} attribute sync config, across #{sources.count} sources."
+      $log.info "\tRetrieved attribute sync config, across #{sources.count} sources."
+
+      Markdown.h2 "Attribute Sync Config"
 
       sources.each do |source|
 
         response = IDNAPI.get( "#{$url}/cc/api/source/getAttributeSyncConfig/#{source["id"]}", $token )
-        syncAttributes = JSON.parse( response.body )
 
-        $log.info "\tAttribute Sync Config: #{source["name"]}"
+        case response
+        when Net::HTTPSuccess
+
+          attribute_sync_config = JSON.parse( response.body )
 
-        unless ( syncAttributes.nil? || syncAttributes["syncAttributes"].nil? || syncAttributes["syncAttributes"].empty? )
-          Markdown.h3( "#{source["name"]}" )
-          Markdown.text( "| Account Attribute | Identity Attribute | Enabled? |\n" )
-          Markdown.text( "|-------------------|--------------------|----------|\n" )
-          syncAttributes["syncAttributes"].each do |syncAttribute|
-            Markdown.text( "|#{syncAttribute["targetAttribute"]}|#{syncAttribute["identityAttributeName"]}|#{Program.humanize( syncAttribute["enabled"] )}|\n" )
+          $log.info "\tAttribute Sync Config: #{source["name"]}"
+
+          unless ( attribute_sync_config.nil? || attribute_sync_config["syncAttributes"].nil? || attribute_sync_config["syncAttributes"].empty? )
+            Markdown.h3( "#{source["name"]}" )
+            Markdown.text( "| Account Attribute | Identity Attribute | Enabled? |\n" )
+            Markdown.text( "|-------------------|--------------------|----------|\n" )
+            attribute_sync_config["syncAttributes"].each do |sync_attribute|
+              Markdown.text( "|#{sync_attribute["targetAttribute"]}|#{sync_attribute["identityAttributeName"]}|#{Program.humanize( sync_attribute["enabled"] )}|\n" )
+            end
           end
-        end
-      end
-    end
+
+        else
+          $log.error "\tError: Unable to retrieve attribute sync config."
+        end # case response
+
+      end # sources.each do |source|s
+
+    else
+      $log.error "\tError: Unable to retrieve sources."
+    end # case response
 
     Markdown.write
   end

data/lib/objects/branding.rb

@@ -18,7 +18,7 @@ module Branding
 
       brands = JSON.parse( response.body )
 
-      $log.info "\tDetected #{brands.count} branding configs."
+      $log.info "\tRetrieved branding configurations."
 
       brands['items'].each do |brand|
 
@@ -28,7 +28,7 @@ module Branding
       end # brands['items'].each do |brand|
 
     else
-      $log.error "\tError: Unable to fetch branding."
+      $log.error "\tError: Unable to retrieve branding."
     end # case response
 
   end