cts-mpx-aci 2.0.0

data/lib/cts/mpx/aci/extensions/cts/mpx/entries.rb

@@ -0,0 +1,29 @@
+module Cts
+  module Mpx
+    # extensions to the Cts::Mpx::Collection
+    class Entries
+      # All entries in the collections.
+      #
+      # @return [hash] of entries with filepath as key and md5 hash as value
+      def files
+        hash = {}
+        entries.map { |e| hash.store "#{e.directory}/#{e.filename}", e.hash }
+        hash
+      end
+
+      # transform every entry
+      def transform(user)
+        each { |entry| entry.transform user }
+        nil
+      end
+
+      # untransform every entry
+      #
+      # @param [String] target_account to transform to
+      def untransform(user, target_account)
+        each { |entry| entry.untransform(user, target_account) }
+        nil
+      end
+    end
+  end
+end

data/lib/cts/mpx/aci/extensions/cts/mpx/entry.rb

@@ -0,0 +1,130 @@
+module Cts
+  module Mpx
+    # extensions to the Cts::Mpx::Entry
+    class Entry
+      # Collection of dependencies required to deploy this entry
+      #
+      # @return [Array] unordered list of dependencies
+      def dependencies
+        dependencies = []
+        Cts::Mpx::Aci::Transformations.traverse_for(to_h[:entry], :transform) do |_k, v|
+          next if v.start_with? "http://access.auth.theplatform.com/data/Account"
+          next if v == "urn:cts:aci:target-account"
+
+          dependencies.push v
+        end
+        dependencies.uniq
+      end
+
+      # return the difference between two entries
+      def diff(other_entry)
+        raise ArgumentError, 'an entry must be supplied' unless other_entry.class == self.class
+        raise ArgumentError, 'both entries must have the same service' unless service == other_entry.service
+        raise ArgumentError, 'both entries must have the same endpoint' unless endpoint == other_entry.endpoint
+
+        Diffy::Diff.new(to_s, other_entry.to_s).to_s
+      end
+
+      # @return [String] computed filename of the entry.
+      def filename
+        raise 'Entry must include a guid field' unless fields.collection.map(&:name).include? 'guid'
+
+        "#{fields['guid']}.json"
+      end
+
+      # @return [String] computed path of the entry.
+      def directory
+        "#{service}/#{endpoint}"
+      end
+
+      def exists_by?(user, query)
+        raise ArgumentError, "user must be signed in" unless user&.token
+        raise ArgumentError, "query must be a type of Query" unless query.is_a? Query
+
+        query.run(user: user)
+        return true if query.page.entries&.count&.positive?
+
+        false
+      end
+
+      # @return [String] complete filepath for an entry
+      def filepath
+        "#{directory}/#{filename}"
+      end
+
+      # @return [String] MD5 hash, based on formatted JSON
+      def hash
+        Digest::MD5.hexdigest to_s
+      end
+
+      # true if any reference is found in the entry, false otherwise.
+      #
+      # @return [Boolean]
+      def includes_reference?
+        included = false
+        Cts::Mpx::Aci::Transformations.traverse_for(to_h[:entry], :transform) do |_k, v|
+          included = true
+          v
+        end
+        included
+      end
+
+      # true if any transformed reference is found in the entry, false otherwise.
+      #
+      # @return [Boolean]
+      def includes_transformed_reference?
+        ref = false
+
+        Cts::Mpx::Aci::Transformations.traverse_for(to_h[:entry], :untransform) do |_k, v|
+          ref = true
+          v
+        end
+        ref
+      end
+
+      # transform all references in this entry
+      # @raise [RuntimeError] if guid field is not included
+      # @raise [RuntimeError] if ownerId field is not included
+      # @raise [RuntimeError] if user is not set
+      def transform(user)
+        raise_entry_exceptions!(user)
+        hash = to_h[:entry]
+        output = Cts::Mpx::Aci::Transformations.traverse_for(hash, :transform) do |_k, v|
+          if Cts::Mpx::Aci::Validators.field_reference? v
+            Cts::Mpx::Aci::Transformations.transform_field_reference field_reference: v, user: user
+          else
+            Cts::Mpx::Aci::Transformations.transform_reference reference: v, user: user, original_account: fields['ownerId']
+          end
+        end
+        @fields = Fields.create_from_data(data: output, xmlns: to_h[:namespace])
+        self
+      end
+
+      # untransform all transformed references in this entry
+      # @raise [RuntimeError] if guid field is not included
+      # @raise [RuntimeError] if ownerId field is not included
+      # @raise [RuntimeError] if user is not set
+      def untransform(user, target_account)
+        raise_entry_exceptions!(user)
+        hash = to_h[:entry]
+        output = Cts::Mpx::Aci::Transformations.traverse_for(hash, :untransform) do |_k, v|
+          if Cts::Mpx::Aci::Validators.transformed_field_reference? v
+            Cts::Mpx::Aci::Transformations.untransform_field_reference transformed_reference: v, user: user
+          else
+            Cts::Mpx::Aci::Transformations.untransform_reference transformed_reference: v, user: user, target_account: target_account
+          end
+        end
+        @fields = Fields.create_from_data(data: output, xmlns: to_h[:namespace])
+        self
+      end
+
+      private
+
+      def raise_entry_exceptions!(user)
+        raise 'Entry must include an guid field' unless fields.to_h.key?('guid')
+        raise 'Entry must include an ownerId field' unless fields.to_h.key?('ownerId')
+        raise 'Entry must have user set' unless user
+      end
+    end
+  end
+end

data/lib/cts/mpx/aci/extensions/services/data/entry.rb

@@ -0,0 +1,136 @@
+module Theplatform
+  module Services
+    module Data
+      # extensions to the Theplatform::Services::Data::Entry
+      class Entry
+        # Collection of dependencies required to deploy this entry
+        #
+        # @return [Array] unordered list of dependencies
+        def dependencies
+          dependencies = []
+          Cts::Mpx::Aci::Transformations.traverse_for(to_hash['entry'], :transform) do |_k, v|
+            next if v.start_with? "http://access.auth.theplatform.com/data/Account"
+            next if v == "urn:cts:aci:target-account"
+            dependencies.push v
+            v
+          end
+          dependencies.uniq
+        end
+
+        # return the difference between two entri
+
+        # true if any reference is found in the entry, false otherwise.
+        #
+        # @return [Boolean]
+        def includes_reference?
+          output = false
+          Cts::Mpx::Aci::Transformations.traverse_for(to_hash['entry'], :transform) do |_k, v|
+            output = true
+            v
+          end
+          output
+        end
+
+        # true if any transformed reference is found in the entry, false otherwise.
+        #
+        # @return [Boolean]
+        def includes_transformed_reference?
+          ref = false
+          Cts::Mpx::Aci::Transformations.traverse_for(to_hash['entry'], :untransform) do |_k, v|
+            ref = true
+            v
+          end
+          ref
+        end
+
+        # @return [String] computed filename of the entry.
+        def filename
+          raise 'Entry must include an guid field' unless fields.include? 'guid'
+          "#{entry['guid']}.json"
+        end
+
+        # @return [String] computed path of the entry.
+        def directory
+          "#{service}/#{endpoint}"
+        end
+
+        # @return [String] complete filepath for an entry
+        def filepath
+          "#{directory}/#{filename}"
+        end
+
+        # @return [String] MD5 hash, based on formatted JSON
+        def hash
+          Digest::MD5.hexdigest to_s
+        end
+
+        # return the difference between two entries
+        def diff(other_entry)
+          raise ArgumentError, 'an entry must be supplied' unless other_entry.class == self.class
+          raise ArgumentError, 'both entries must have the same service' unless service == other_entry.service
+          raise ArgumentError, 'both entries must have the same endpoint' unless endpoint == other_entry.endpoint
+          Diffy::Diff.new(to_s, other_entry.to_s).to_s
+        end
+
+        # transform all references in this entry
+        # @raise [RuntimeError] if guid field is not included
+        # @raise [RuntimeError] if ownerId field is not included
+        # @raise [RuntimeError] if user is not set
+        def transform
+          raise_entry_exceptions!
+          hash = to_hash['entry']
+          output = Cts::Mpx::Aci::Transformations.traverse_for(hash, :transform) do |_k, v|
+            if Cts::Mpx::Aci::Validators.field_reference? v
+              Cts::Mpx::Aci::Transformations.transform_field_reference field_reference: v, user: user
+            else
+              Cts::Mpx::Aci::Transformations.transform_reference reference: v, user: user, original_account: ownerId
+            end
+          end
+          load_from_hash "$xmlns" => namespace, 'entry' => { "id" => id }.merge(output)
+        end
+
+        # untransform all transformed references in this entry
+        # @raise [RuntimeError] if guid field is not included
+        # @raise [RuntimeError] if ownerId field is not included
+        # @raise [RuntimeError] if user is not set
+        def untransform(target_account)
+          raise_entry_exceptions!
+          hash = to_hash['entry']
+          output = Cts::Mpx::Aci::Transformations.traverse_for(hash, :untransform) do |_k, v|
+            if Cts::Mpx::Aci::Validators.transformed_field_reference? v
+              Cts::Mpx::Aci::Transformations.untransform_field_reference transformed_reference: v, user: user
+            else
+              Cts::Mpx::Aci::Transformations.untransform_reference transformed_reference: v, user: user, target_account: target_account
+            end
+          end
+          load_from_hash "$xmlns" => namespace, 'entry' => { "id" => id }.merge(output)
+        end
+
+        def endpoint
+          @endpoint.tr '/', ''
+        end
+
+        # :nocov:
+        # addresses a bug in the SDK.    in the load from hash, the result['entries'].    Adding '.first' is the fix so only an entry is returned, not an array.
+        def save_to_service
+          if existing_entry?
+            service_module.send "put_#{endpoint.split(/(?=[A-Z])/).join('_').downcase}", user, [to_hash(include_read_only: false)["entry"]], namespace: namespace
+          else
+            result = service_module.send "post_#{endpoint.split(/(?=[A-Z])/).join('_').downcase}", user, [to_hash(include_read_only: false)["entry"]], namespace: namespace
+            load_from_hash("entry" => result['entries'].first) if result
+          end
+          true
+        end
+        # :nocov:
+
+        private
+
+        def raise_entry_exceptions!
+          raise 'Entry must include an guid field' unless fields.include? 'guid'
+          raise 'Entry must include an ownerId field' unless fields.include? 'ownerId'
+          raise 'Entry must have user set' unless user
+        end
+      end
+    end
+  end
+end

data/lib/cts/mpx/aci/stencil.rb

@@ -0,0 +1,148 @@
+module Cts
+  module Mpx
+    module Aci
+      # Container for a selection of queries to run on an account.
+      # @!attribute [rw] name
+      #   @return [String] Name of the stencil
+      # @!attribute [rw] original_url
+      #   @return [String] If applicable, the original location of the asset.
+      # @!attribute [rw] schema
+      #   @return [String] Schema of this stencil
+      # @!attribute [rw] queries
+      #   @return [String] Queries to perform in the collect object
+      class Stencil
+        include Creatable
+
+        attribute name: 'name', kind_of: String
+        attribute name: 'original_url', kind_of: String
+        attribute name: 'schema', kind_of: String
+        attribute name: 'queries', kind_of: Array
+
+        # find a stencil in the loaded stencils by name.   when used with no parameter will show all available stencils.
+        #
+        # @param  key [String] name of the stencil
+        # @return [Stencil] referenced stencil
+        def self.[](key = nil)
+          Stencil.class_variable_set(:@@available_stencils, {}) unless Stencil.class_variable_defined? :@@available_stencils
+          return @@available_stencils[key] if key
+
+          @@available_stencils
+        end
+
+        # Smart load a stencil.  This will attemp to parse it as json, then load it as a url, and finally try to load a file.
+        #
+        # @param  string [String] string to attempt to smart load.
+        # @return [Stencil] loaded stencil
+        def self.load(string)
+          begin
+            data = load_string Stencil.parse_json(string)
+          rescue ArgumentError
+            return load_url(string) if string.start_with? 'http'
+
+            return load_file string
+          end
+
+          load_string(string) if data
+        end
+
+        # Attempt to open a local file for reading, loading in the JSON if it is able.
+        #
+        # @param  file [String] file of the file to load.
+        # @raise  [RuntimeError] If file could not be found
+        # @raise  [RuntimeError] If file is empty.
+        # @return [Stencil] loaded stencil
+        def self.load_file(file)
+          raise "Could not find file #{file}." unless File.exist? file
+
+          content = File.read(file)
+          raise RuntimeError if content.empty?
+
+          stencil = load_string(content)
+          stencil.original_url = file
+          stencil
+        end
+
+        # Attempt to open a local file for reading, loading in the JSON if it is able.
+        #
+        # @param  string [String] string to be parsed and loaded.
+        # @raise  [ArgumentError] if the parsed queries is not an array
+        # @return [Stencil] loaded stencil
+        def self.load_string(string)
+          data = Stencil.parse_json(string)
+
+          stencil = Stencil.new
+          stencil.name = data['name']
+          raise ArgumentError, "queries is not a kind of Array" unless data['queries'].is_a? Array
+
+          stencil.queries = data['queries']
+
+          @@available_stencils[stencil.name] = stencil
+          stencil
+        end
+
+        # Attempt to open a local file for reading, loading in the JSON if it is able.
+        #
+        # @param  url [String] url to be fetched and passed to load_string
+        # @raise  [ArgumentError] if the url is not valid
+        # @return [Stencil] loaded stencil
+        def self.load_url(url)
+          begin
+            URI.parse url
+          rescue URI::InvalidURIError
+            raise ArgumentError, "#{url} is not a url"
+          end
+
+          load_string(Excon.get(url).body)
+        end
+
+        # Attempt to open a local file for reading, loading in the JSON if it is able.
+        #
+        # @param  string [String] string is parsed and returned as a hash
+        # @raise  [ArgumentError] if the arugment is not a type of a string
+        # @raise  [ArgumentError] if the string could not be parsed
+        # @return [Hash] hash of the data from the json
+        def self.parse_json(string)
+          raise ArgumentError, "#{string.class} is not a kind of String" unless string&.is_a?(String)
+
+          begin
+            data = Oj.load(string)
+          rescue Oj::ParseError
+            raise ArgumentError, "could not be parsed"
+          end
+
+          data
+        end
+
+        def initialize
+          Stencil.class_variable_set(:@@available_stencils, {}) unless Stencil.class_variable_defined? :@@available_stencils
+          @name = ""
+          @original_url = ""
+          @queries = []
+          @schema = 1
+        end
+
+        # Attempt to open a local file for reading, loading in the JSON if it is able.
+        #
+        # @param  account_id [String] account_id account_id to collect from
+        # @param  user [String] user to use to make the collection.
+        # @raise  [ArgumentError] if the arugment is not a type of a string
+        # @raise  [ArgumentError] if no queries are provided
+        # @return [Collect] a collect object created from the json and parameters passed in.
+        def to_collect(account_id: nil, user: nil)
+          raise ArgumentError, 'queries must contain entries' unless queries.any?
+
+          collect = Tasks::Collect.new
+          collect.account_id = account_id if account_id
+          collect.user = user if user
+
+          queries.each do |q|
+            query = Query.create service: q[:service], endpoint: q[:endpoint]
+            collect.queries.push query
+          end
+
+          collect
+        end
+      end
+    end
+  end
+end

data/lib/cts/mpx/aci/tasks/collect.rb

@@ -0,0 +1,91 @@
+module Cts
+  module Mpx
+    module Aci
+      module Tasks
+        # Collect class for gathering data from MPX.
+        class Collect
+          include Creatable
+
+          attribute name: 'account_id', kind_of: String
+          attribute name: 'user',       kind_of: User
+          attribute name: 'queries',    kind_of: Array
+          attribute name: 'entries',    kind_of: Entries
+
+          # Executes the array of queries one by one.   Collecting the result into the collections attribute.
+          # @raise [RuntimeError] when queries is not set correctly
+          # @raise [ArgumentError] when the user attribute is not set
+          # @raise [ArgumentError] when the account_id attribute is not set
+          # @raise [ArgumentError] when a query does not have service set
+          # @raise [ArgumentError] when a query does not have endpoint set
+          def collect
+            raise "empty queries array" if @queries&.empty?
+            raise 'must set the queries attribute.' unless queries
+
+            @entries = Entries.new
+
+            queries.each do |config|
+              query = run_query(config)
+
+              if query&.entries.count.positive?
+                log_collected_zero_entries config
+                next
+              end
+
+              @entries += query.page.to_mpx_entries
+              @entries.each do |entry|
+                # if we collect the read only fields, it just messes everything up.
+                # best to just not collect them.
+                service_read_only_fields.each { |field| entry.fields.remove field }
+
+                log_collected entry
+              end
+            end
+          end
+
+          def initialize
+            @account_id = ""
+            @user = nil
+            @entries = Entries.new
+            @queries = []
+          end
+
+          def queries=(new_queries)
+            raise ArgumentError unless new_queries.is_a? Array
+            raise ArgumentError if new_queries.map { |e| e.is_a? Hash }.include? false
+
+            @queries = new_queries
+          end
+
+          private
+
+          def service_read_only_fields
+            ["updated", "added", "addedByUserId", "updatedByUserId", "version"]
+          end
+
+          def logger
+            Aci.logger
+          end
+
+          def log_collected(entry)
+            logger.info "collected: id: #{entry.fields['id']} guid: #{entry.fields['guid']}"
+          end
+
+          def log_collected_zero_entries(config)
+            logger.info "collected zero results for #{config['service']}/#{config['endpoint']}"
+          end
+
+          def run_query(config)
+            raise ArgumentError, 'must set the user attribute.' unless user
+            raise ArgumentError, 'must set the account_id attribute.' unless account_id
+
+            raise ArgumentError, "#{config} does not have service set" if config["service"].empty?
+            raise ArgumentError, "#{config} does not have endpoint set" if config["endpoint"].empty?
+
+            query = Query.create config
+            query.run user: user
+          end
+        end
+      end
+    end
+  end
+end