kinetic_sdk 0.1.1 → 1.0.0

data/lib/kinetic_sdk/task/lib/runs.rb

@@ -0,0 +1,43 @@
+module KineticSdk
+  class Task
+
+    # Delete a Run.
+    #
+    # @param id the id of the run to delete
+    # @param headers [Hash] hash of headers to send, default is basic authentication
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    #
+    # Example
+    #
+    #     delete_run(24548)
+    #
+    def delete_run(id, headers=header_basic_auth)
+      @logger.info("Deleting run \"#{id}\"")
+      delete("#{@api_url}/runs/#{id}", headers)
+    end
+
+    # Find runs.
+    #
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    # @param headers [Hash] hash of headers to send, default is basic authentication
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    #
+    # Example
+    #
+    #     find_runs({ "source" => "Kinetic Request CE" })
+    #
+    # Example
+    # 
+    #     find_runs({ "include" => "details" })
+    #
+    # Example
+    #
+    #     find_runs({ "source" => "Kinetic Request CE", "include" => "details" })
+    #
+    def find_runs(params={}, headers=header_basic_auth)
+      @logger.info("Finding Runs")
+      get("#{@api_url}/runs", params, headers)
+    end
+
+  end
+end

data/lib/kinetic_sdk/task/lib/setup.rb

@@ -21,7 +21,7 @@ module KineticSdk
     #     }
     #
     def test_db_connection(db={}, headers=default_headers)
-      info("Testing database connection")
+      @logger.info("Testing database connection")
       response = post("#{@api_url}/setup/db/test", db, headers)
       response.content
     end
@@ -47,7 +47,7 @@ module KineticSdk
     #     }
     #
     def migrate_db(db={}, headers=default_headers)
-      info("Running database migrations")
+      @logger.info("Running database migrations")
       response = post("#{@api_url}/setup/db/migrate", db, headers)
       response.content
     end

data/lib/kinetic_sdk/task/lib/sources.rb

@@ -29,7 +29,7 @@ module KineticSdk
     #
     def add_source(source, headers=default_headers)
       name = source['name']
-      info("Adding the #{name} source")
+      @logger.info("Adding the #{name} source")
       post("#{@api_url}/sources", source, headers)
     end
 
@@ -39,7 +39,7 @@ module KineticSdk
     # @param headers [Hash] hash of headers to send, default is basic authentication
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def delete_source(name, headers=header_basic_auth)
-      info("Deleting Source \"#{name}\"")
+      @logger.info("Deleting Source \"#{name}\"")
       delete("#{@api_url}/sources/#{encode(name)}", headers)
     end
 
@@ -48,19 +48,50 @@ module KineticSdk
     # @param headers [Hash] hash of headers to send, default is basic authentication
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def delete_sources(headers=header_basic_auth)
-      info("Deleting all sources")
+      @logger.info("Deleting all sources")
       (find_sources(headers).content['sources'] || []).each do |source|
         delete("#{@api_url}/sources/#{encode(source['name'])}", headers)
       end
     end
 
+    # Export all sources to :source-slug.json file in export_directory/sources
+    #
+    # @param headers [Hash] hash of headers to send, default is basic authentication
+    # @return nil
+    def export_sources(headers=header_basic_auth)
+      raise StandardError.new "An export directory must be defined to export sources." if @options[:export_directory].nil?
+      response = find_sources({"include" => "policyRules"})
+      (response.content["sourceRoots"] || []).each do |source|
+        # determine which directory to write the file to
+        if source['name'] != "-"
+          # create the directory if it doesn't yet exist
+          sources_dir = FileUtils::mkdir_p(File.join(@options[:export_directory], "sources"))
+          source_file = File.join(sources_dir, "#{source['name'].slugify}.json")
+          write_object_to_file(source_file, source)
+        end
+      end
+    end
+
+    # Import all sources from :source-slug.json file in export_directory/sources
+    #
+    # @param headers [Hash] hash of headers to send, default is basic authentication
+    # @return nil
+    def import_sources(headers=default_headers)
+      raise StandardError.new "An export directory must be defined to import sources." if @options[:export_directory].nil?
+      @logger.info("Importing all Sources in Export Directory")
+      Dir["#{@options[:export_directory]}/sources/*.json"].sort.each do |file|
+        source = JSON.parse(File.read(file))
+        add_source(source, headers)
+      end
+    end
+
     # Find all sources
     #
     # @param params [Hash] Query parameters that are added to the URL, such as +include+
     # @param headers [Hash] hash of headers to send, default is basic authentication
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def find_sources(params={}, headers=header_basic_auth)
-      info("Finding all sources")
+      @logger.info("Finding all sources")
       get("#{@api_url}/sources", params, headers)
     end
 
@@ -71,7 +102,7 @@ module KineticSdk
     # @param headers [Hash] hash of headers to send, default is basic authentication
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def find_source(name, params={}, headers=header_basic_auth)
-      info("Finding source named \"#{name}\"")
+      @logger.info("Finding source named \"#{name}\"")
       get("#{@api_url}/sources/#{encode(name)}", params, headers)
     end
 
@@ -101,7 +132,7 @@ module KineticSdk
     #     )
     #
     def update_source(source, body={}, headers=default_headers)
-      info("Updating the \"#{source['name']}\" Source")
+      @logger.info("Updating the \"#{source['name']}\" Source")
       put("#{@api_url}/sources/#{encode(source['name'])}", body, headers)
     end
 
@@ -114,7 +145,7 @@ module KineticSdk
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def add_policy_rule_to_source(policy_rule_type, policy_rule_name, source_name, headers=default_headers)
       body = { "type" => policy_rule_type, "name" => policy_rule_name }
-      info("Adding policy rule \"#{policy_rule_type} - #{policy_rule_name}\" to source \"#{source_name}\"")
+      @logger.info("Adding policy rule \"#{policy_rule_type} - #{policy_rule_name}\" to source \"#{source_name}\"")
       post("#{@api_url}/sources/#{encode(source_name)}/policyRules", body, headers)
     end
 
@@ -126,7 +157,7 @@ module KineticSdk
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def remove_policy_rule_from_source(policy_rule_type, policy_rule_name, source_name, headers=default_headers)
-      info("Removing policy rule \"#{policy_rule_type} - #{policy_rule_name}\" from source \"#{source_name}\"")
+      @logger.info("Removing policy rule \"#{policy_rule_type} - #{policy_rule_name}\" from source \"#{source_name}\"")
       delete("#{@api_url}/sources/#{encode(source_name)}/policyRules/#{encode(policy_rule_type)}/#{encode(policy_rule_name)}", headers)
     end
 

data/lib/kinetic_sdk/task/lib/tasks.rb

@@ -9,7 +9,7 @@ module KineticSdk
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def complete_deferred_task(source_name, body, headers=default_headers)
-      info("Completing deferred task for the \"#{source_name}\" Source.")
+      @logger.info("Completing deferred task for the \"#{source_name}\" Source.")
       post("#{@api_v1_url}/complete-deferred-task/#{encode(source_name)}", body, headers)
     end
 

data/lib/kinetic_sdk/task/lib/trees.rb

@@ -25,7 +25,7 @@ module KineticSdk
       else
         title = "#{tree.to_s}"
       end
-      info("Deleting Tree \"#{title}\"")
+      @logger.info("Deleting Tree \"#{title}\"")
       delete("#{@api_url}/trees/#{encode(title)}", headers)
     end
 
@@ -44,15 +44,15 @@ module KineticSdk
     #
     def delete_trees(source_name=nil, headers=header_basic_auth)
       if source_name.nil?
-        info("Deleting all trees")
+        @logger.info("Deleting all trees")
         params = {}
       else
-        info("Deleting trees for Source \"#{source_name}\"")
+        @logger.info("Deleting trees for Source \"#{source_name}\"")
         params = { "source" => source_name }
       end
 
       (find_trees(params, headers).content['trees'] || []).each do |tree|
-        info("Deleting tree \"#{tree['title']}\"")
+        @logger.info("Deleting tree \"#{tree['title']}\"")
         delete("#{@api_url}/trees/#{encode(tree['title'])}", headers)
       end
     end
@@ -69,7 +69,7 @@ module KineticSdk
     #     find_trees({ "source" => "Kinetic Request CE" })
     #
     # Example
-    # 
+    #
     #     find_trees({ "include" => "details" })
     #
     # Example
@@ -77,7 +77,7 @@ module KineticSdk
     #     find_trees({ "source" => "Kinetic Request CE", "include" => "details" })
     #
     def find_trees(params={}, headers=header_basic_auth)
-      info("Finding Trees")
+      @logger.info("Finding Trees")
       get("#{@api_url}/trees", params, headers)
     end
 
@@ -100,7 +100,7 @@ module KineticSdk
     #     find_routines({ "source" => "Kinetic Request CE", "include" => "details" })
     #
     def find_routines(params={}, headers=header_basic_auth)
-      info("Finding Routines")
+      @logger.info("Finding Routines")
       response = get("#{@api_url}/trees", params, headers)
 
       routines = []
@@ -127,10 +127,30 @@ module KineticSdk
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def import_tree(tree, force_overwrite=false, headers=header_basic_auth)
       body = { "content" => tree }
-      info("Importing Tree #{File.basename(tree)}")
+      @logger.info("Importing Tree #{File.basename(tree)}")
       post_multipart("#{@api_url}/trees?force=#{force_overwrite}", body, headers)
     end
 
+    # Import trees
+    #
+    # If the trees already exists on the server, this will fail unless forced
+    # to overwrite.
+    #
+    # The source named in the trees content must also exist on the server, or
+    # the import will fail.
+    #
+    # @param force_overwrite [Boolean] whether to overwrite a tree if it exists, default is false
+    # @param headers [Hash] hash of headers to send, default is basic authentication
+    # @return nil
+    def import_trees(force_overwrite=false, headers=header_basic_auth)
+      raise StandardError.new "An export directory must be defined to import trees from." if @options[:export_directory].nil?
+      @logger.info("Importing all Trees from Export Directory")
+      Dir["#{@options[:export_directory]}/sources/**/*.xml"].sort.each do |file|
+        tree_file = File.new(file, "rb")
+        import_tree(tree_file, force_overwrite, headers)
+      end
+    end
+
     # Import a routine
     #
     # If the routine already exists on the server, this will fail unless
@@ -142,10 +162,27 @@ module KineticSdk
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def import_routine(routine, force_overwrite=false, headers=header_basic_auth)
       body = { "content" => routine }
-      info("Importing Routine #{File.basename(routine)}")
+      @logger.info("Importing Routine #{File.basename(routine)}")
       post_multipart("#{@api_url}/trees?force=#{force_overwrite}", body, headers)
     end
 
+    # Import routines
+    #
+    # If the routines already exists on the server, this will fail unless forced
+    # to overwrite.
+    #
+    # @param force_overwrite [Boolean] whether to overwrite routines if they exist, default is false
+    # @param headers [Hash] hash of headers to send, default is basic authentication
+    # @return nil
+    def import_routines(force_overwrite=false, headers=header_basic_auth)
+      raise StandardError.new "An export directory must be defined to import trees from." if @options[:export_directory].nil?
+      @logger.info("Importing all Routines from Export Directory")
+      Dir["#{@options[:export_directory]}/routines/*.xml"].sort.each do |file|
+        routine_file = File.new(file, "rb")
+        import_routine(routine_file, force_overwrite, headers)
+      end
+    end
+
     # Find a single tree by title (Source Name :: Group Name :: Tree Name)
     #
     # @param title [String] The tree title
@@ -161,7 +198,7 @@ module KineticSdk
     #     )
     #
     def find_tree(title, params={}, headers=header_basic_auth)
-      info("Finding the \"#{title}\" Tree")
+      @logger.info("Finding the \"#{title}\" Tree")
       get("#{@api_url}/trees/#{encode(title)}", params, headers)
     end
 
@@ -169,11 +206,11 @@ module KineticSdk
     #
     # @param title [String] the title of the tree or routine
     # @param headers [Hash] hash of headers to send, default is basic authentication
-    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    # @return nil
     #
     def export_tree(title, headers=header_basic_auth)
       raise StandardError.new "An export directory must be defined to export a tree." if @options[:export_directory].nil?
-      info("Exporting tree \"#{title}\" to #{@options[:export_directory]}.")
+      @logger.info("Exporting tree \"#{title}\" to #{@options[:export_directory]}.")
       # Get the tree
       response = find_tree(title, { "include" => "export" })
       # Parse the response and export the tree
@@ -186,12 +223,21 @@ module KineticSdk
         tree_file = File.join(routine_dir, "#{tree['name'].slugify}.xml")
       else
         # Create the directory if it doesn't yet exist
-        tree_dir = FileUtils::mkdir_p(File.join(@options[:export_directory], "trees", tree['sourceName'].slugify))
-        tree_file = File.join(tree_dir, "#{tree['sourceName'].slugify}.#{tree['sourceGroup'].slugify}.#{tree['name'].slugify}.xml")
+        tree_dir = FileUtils::mkdir_p(File.join(@options[:export_directory],"sources", tree['sourceName'].slugify , "trees"))
+        tree_file = File.join(tree_dir, "#{tree['sourceGroup'].slugify}.#{tree['name'].slugify}.xml")
       end
+
       # write the file
-      File.write(tree_file, tree['export'])
-      info("Exported #{tree['type']}: #{tree['title']} to #{tree_file}")
+      server_version = server_info(headers).content["version"]
+      if server_version > "04.03.0z"
+        File.write(tree_file, tree['export'])
+      else
+        xml_doc = REXML::Document.new(tree["export"])
+        xml_doc.context[:attribute_quote] = :quote
+        xml_formatter = Prettier.new
+        xml_formatter.write(xml_doc, File.open(tree_file, "w"))
+      end
+      @logger.info("Exported #{tree['type']}: #{tree['title']} to #{tree_file}")
     end
 
     # Export all trees and local routines for a source, and global routines
@@ -200,19 +246,20 @@ module KineticSdk
     #   - Leave blank or pass nil to export all trees and global routines
     #   - Pass "-" to export only global routines
     # @param headers [Hash] hash of headers to send, default is basic authentication
-    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    # @return nil
     def export_trees(source_name=nil, headers=header_basic_auth)
       raise StandardError.new "An export directory must be defined to export trees." if @options[:export_directory].nil?
       if source_name.nil?
-        info("Exporting all trees and routines to #{@options[:export_directory]}.")
-        (find_sources.content["sourceRoots"] || []).each do |sourceRoot|
+        @logger.info("Exporting all trees and routines to #{@options[:export_directory]}.")
+        export_routines(headers)
+        (find_sources({}, headers).content["sourceRoots"] || []).each do |sourceRoot|
           export_trees(sourceRoot['name'])
         end
         return
       elsif source_name == "-"
-        info("Exporting global routines to #{@options[:export_directory]}.")
+        @logger.info("Exporting global routines to #{@options[:export_directory]}.")
       else
-        info("Exporting trees and routines for source \"#{source_name}\" to #{@options[:export_directory]}.")
+        @logger.info("Exporting trees and routines for source \"#{source_name}\" to #{@options[:export_directory]}.")
       end
 
       # Get all the trees and routines for the source
@@ -226,12 +273,21 @@ module KineticSdk
           tree_file = File.join(routine_dir, "#{tree['name'].slugify}.xml")
         else
           # create the directory if it doesn't yet exist
-          tree_dir = FileUtils::mkdir_p(File.join(@options[:export_directory], "trees", source_name.slugify))
-          tree_file = File.join(tree_dir, "#{source_name.slugify}.#{tree['sourceGroup'].slugify}.#{tree['name'].slugify}.xml")
+          tree_dir = FileUtils::mkdir_p(File.join(@options[:export_directory], "sources", source_name.slugify ,"trees"))
+          tree_file = File.join(tree_dir, "#{tree['sourceGroup'].slugify}.#{tree['name'].slugify}.xml")
         end
+
         # write the file
-        File.write(tree_file, tree['export'])
-        info("Exported #{tree['type']}: #{tree['title']} to #{tree_file}")
+        server_version = server_info(headers).content["version"]
+        if server_version > "04.03.0z"
+          File.write(tree_file, tree['export'])
+        else
+          xml_doc = REXML::Document.new(tree["export"])
+          xml_doc.context[:attribute_quote] = :quote
+          xml_formatter = Prettier.new
+          xml_formatter.write(xml_doc, File.open(tree_file, "w"))
+        end
+        @logger.info("Exported #{tree['type']}: #{tree['title']} to #{tree_file}")
       end
     end
 
@@ -239,7 +295,7 @@ module KineticSdk
     # Export all global routines
     #
     # @param headers [Hash] hash of headers to send, default is basic authentication
-    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    # @return nil
     def export_routines(headers=header_basic_auth)
       export_trees("-", headers)
     end
@@ -252,7 +308,7 @@ module KineticSdk
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def run_tree(title, body={}, headers=default_headers)
-      info("Running tree #{title}")
+      @logger.info("Running tree #{title}")
       parts = title.split(" :: ")
       raise StandardError.new "Title is invalid: #{title}" if parts.size != 3
       url = "#{@api_v1_url}/run-tree/#{encode(parts[0])}/#{encode(parts[1])}/#{encode(parts[2])}"
@@ -266,7 +322,7 @@ module KineticSdk
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def update_tree(title, body={}, headers=default_headers)
-      info("Updating the \"#{title}\" Tree")
+      @logger.info("Updating the \"#{title}\" Tree")
       put("#{@api_url}/trees/#{encode(title)}", body, headers)
     end
 

data/lib/kinetic_sdk/task/lib/users.rb

@@ -16,7 +16,7 @@ module KineticSdk
     #     })
     #
     def add_user(user, headers=default_headers)
-      info("Add user \"#{user['loginId']}\"")
+      @logger.info("Add user \"#{user['loginId']}\"")
       post("#{@api_url}/users", user, headers)
     end
 
@@ -26,7 +26,7 @@ module KineticSdk
     # @param headers [Hash] hash of headers to send, default is basic authentication
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def delete_user(login_id, headers=header_basic_auth)
-      info("Deleting User \"#{login_id}\"")
+      @logger.info("Deleting User \"#{login_id}\"")
       delete("#{@api_url}/users/#{encode(login_id)}", headers)
     end
 
@@ -35,9 +35,9 @@ module KineticSdk
     # @param headers [Hash] hash of headers to send, default is basic authentication
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def delete_users(headers=header_basic_auth)
-      info("Deleting all users")
+      @logger.info("Deleting all users")
       (find_users(headers).content["users"] || []).each do |user|
-        delete("#{@api_url}/users/#{encode(user['login_id'])}", headers)
+        delete_user(user['loginId'], headers)
       end
     end
 
@@ -47,7 +47,7 @@ module KineticSdk
     # @param headers [Hash] hash of headers to send, default is basic authentication
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def find_users(params={}, headers=header_basic_auth)
-      info("Finding all users")
+      @logger.info("Finding all users")
       get("#{@api_url}/users", params, headers)
     end
 
@@ -67,7 +67,7 @@ module KineticSdk
     #     })
     #
     def update_user(login_id, user, headers=default_headers)
-      info("Updating user \"#{login_id}\"")
+      @logger.info("Updating user \"#{login_id}\"")
       put("#{@api_url}/users/#{encode(login_id)}", user, headers)
     end
 

data/lib/kinetic_sdk/task/task-sdk.rb

@@ -10,7 +10,11 @@ module KineticSdk
     # Include the KineticHttpUtils module
     include KineticSdk::Utils::KineticHttpUtils
 
-    attr_reader :api_url, :api_v1_url, :config_user, :options, :server, :version, :username, :password
+    # Include the KineticExportUtils module
+    include KineticSdk::Utils::KineticExportUtils
+
+    attr_reader :api_url, :api_v1_url, :config_user, :options, :server,
+                :version, :username, :password, :logger
 
     # Initalize the Task SDK with the web server URL and user credentials,
     # along with any custom option values.
@@ -28,9 +32,12 @@ module KineticSdk
     # @option opts [String] :password the password for the user
     # @option opts [Hash<Symbol, Object>] :options ({}) optional settings
     #
-    #   * :export_directory (String) (_example: /opt/exports/kinetic-task) directory to write files when exporting,
-    #   * :log_level (String) (_defaults to: off_) level of logging - off | info | debug | trace
-    #   * :max_redirects (Fixnum) (_defaults to: 10_) maximum number of redirects to follow
+    #   * :export_directory (String) (_example: /opt/exports/kinetic-task_) directory to write files when exporting,
+    #   * :gateway_retry_limit (FixNum) (_defaults to: 5_) max number of times to retry a bad gateway
+    #   * :gateway_retry_delay (Float) (_defaults to: 1.0_) number of seconds to delay before retrying a bad gateway
+    #   * :log_level (String) (_defaults to: off_) level of logging - off | error | warn | info | debug
+    #   * :log_output (String) (_defaults to: STDOUT_) where to send output - STDOUT | STDERR
+    #   * :max_redirects (Fixnum) (_defaults to: 5_) maximum number of redirects to follow
     #   * :ssl_ca_file (String) full path to PEM certificate used to verify the server
     #   * :ssl_verify_mode (String) (_defaults to: none_) - none | peer
     #
@@ -73,6 +80,11 @@ module KineticSdk
 
       # process any individual options
       @options = options.delete(:options) || {}
+      # setup logging
+      log_level = @options[:log_level] || @options["log_level"]
+      log_output = @options[:log_output] || @options["log_output"]
+      @logger = KineticSdk::Utils::KLogger.new(log_level, log_output)
+
       @config_user[:username] = options[:username]
       @config_user[:password] = options[:password]
       @server = options[:app_server_url].chomp('/')

data/lib/kinetic_sdk/utils/kinetic-export-utils.rb

@@ -0,0 +1,157 @@
+module KineticSdk
+  module Utils
+
+    # The KineticExportUtils module provides methods to simplify exporting
+    # objects and writing to the local file system.
+    module KineticExportUtils
+
+      # Builds the tree structure of the export including the arguments
+      #
+      # @param args [Array] list of property names to include in the export:
+      #   (i.e. slug, name, etc)
+      # @return [Hash] struture of the shape to be exported
+      def prepare_shape(*args)
+        shape = {}
+        args.each do |arg|
+          segments = arg.split('.')
+          pointer = shape
+          segments.each do |segment|
+            if segment =~ /\{(.*)\}/
+              pointer[:variable] ||= $1
+              pointer[$1] ||= {}
+              pointer = pointer[$1]
+            else
+              pointer[segment] ||= {}
+              pointer = pointer[segment]
+            end
+          end
+        end
+        shape
+      end
+
+      # Determines if the current path should be extracted further
+      #
+      # @param export_path [String] the path in which to determine if further extraction should occur
+      # @param export_shape [Hash] the directory and file structure of how the data should be written
+      # @return [Boolean] true if the path should be extracted further, otherwise false
+      def should_extract(export_path, export_shape)
+        # Prepare the metadata
+        export_path_segments = export_path.split('.')
+        pointer = export_shape
+        result = true
+        # Walk the export path
+        export_path_segments.each do |export_path_segment|
+          # If the object path corresponds to a "variable"
+          if pointer.has_key?(:variable)
+            pointer = pointer[pointer[:variable]]
+          # If the object path corresponds to a static property
+          else
+            pointer = pointer[export_path_segment]
+          end
+          # If the pointer is null (indicating that the property should not be extracted)
+          if pointer.nil?
+            # Break out of the loop
+            result = false
+            break
+          end
+        end
+        # Return the result
+        result
+      end
+
+      # Fetches the variable property of a given path (ie slug, name, etc)
+      #
+      # @param export_shape [Hash] the directory and file structure of how the data should be written
+      # @param object_path [String] the path in which to get the variable property from
+      # @return [String] the value of the variable property, or nil if it doesn't exist
+      def get_variable_property(export_shape, object_path)
+        # Prepare the metadata
+        object_path_segments = object_path.split('.')
+        pointer = export_shape
+        # Walk the object path
+        object_path_segments.each do |object_path_segment|
+          # If the object path corresponds to a "variable"
+          if pointer.has_key?(:variable)
+            pointer = pointer[pointer[:variable]]
+          # If the object path corresponds to a static property
+          else
+            pointer = pointer[object_path_segment]
+          end
+          # If the pointer is null (indicating that the property should not be extracted)
+          break if pointer.nil?
+        end
+        # Return the result
+        pointer.nil? ? nil : pointer[:variable]
+      end
+
+      # Creates directory structure and writes file
+      #
+      # @param filename [String] the full path and name of the file to be written
+      # @param file_contents [String] the content of the file to be written
+      # @return nil
+      def write_object_to_file(filename, file_contents)
+        # Create Folder if not exists
+        dir_path = File.dirname(filename)
+        FileUtils.mkdir_p(dir_path, :mode => 0700)
+        # Write File
+        File.open(filename, 'w') { |file| file.write(JSON.pretty_generate(file_contents)) }
+      end
+
+      # Processes and writes data exported from the core service
+      #
+      # @param core_path [String] the root folder path to write the data to
+      # @param export_shape [Hash] the directory and file structure of how the data should be written
+      # @param object [Hash] the object being processed
+      # @param object_path [String] the path of the object being processed (used recursively)
+      # @return nil
+      def process_export(core_path, export_shape, object, object_path='')
+        # Prepare metadata
+        child_objects = {}
+        file_contents = {}
+        if object.kind_of?(Array)
+          file_contents = object
+        else
+          # For each of the object properties
+          object.each do |key, value|
+            # Build child object path
+            child_object_path = object_path.empty? ? key : "#{object_path}.#{key}"
+
+            # If the property should be extracted into its own folder/file
+            if should_extract(child_object_path, export_shape)
+              if value.kind_of?(Array)
+                variable = get_variable_property(export_shape, child_object_path)
+                if variable.nil?
+                  child_objects[child_object_path] = value
+                else
+                  value.each do |item|
+                    child_objects["#{child_object_path}.#{item[variable]}"] = item
+                  end
+                end
+              else
+                child_objects[child_object_path] = value
+              end
+            # If the property does not need to be extracted
+            else
+              # Add the property to the file contents
+              file_contents[key] = value
+            end
+          end
+        end
+
+        # If this is not the "root" object
+        if object_path != '' && !file_contents.empty?
+          # Write the file_contents based upon the
+          filename = "#{core_path}/#{object_path.gsub('.', '/')}.json"
+          write_object_to_file(filename, file_contents)
+        end
+
+        # For each of the child objects
+        child_objects.each do |key, child_object|
+          # Process the export for that object (recursively)
+          process_export(core_path, export_shape, child_object, key)
+        end
+      end
+
+    end
+  end
+end