ecoportal-api-v2 0.8.4

data/lib/ecoportal/api/common/content/hash_diff_patch.rb

@@ -0,0 +1,183 @@
+module Ecoportal
+  module API
+    module Common
+      module Content
+        module HashDiffPatch
+          ID_KEYS    = %w[id]
+          META_KEYS  = %w[id patch_ver]
+          NO_CHANGES = "%not-changed!%"
+          extend Content::DocHelpers
+
+          class << self
+            # The `patch data` is built as follows:
+            # 1. detect changes that have occurred translate into one `operation` of `OP_TYPE`:
+            #   * `changed`: meaning that the object has changed (existed and has not been removed)
+            #   * `delete`:  the object has been removed
+            #   * `new`:     the object is new
+            # 2. at the level of the target object of the model, the object is opened for change
+            # with `id` and `operation` as follows:
+            #
+            #    ```json
+            #    {
+            #       "id": "objectID",
+            #       "operation": "OP_TYPE",
+            #       "data": {
+            #          "patch_ver": "prev_patch_ver_+1",
+            #          "property":  "value",
+            #          "...":       "..."
+            #       }
+            #    }
+            #    ```
+            # 3. the `data` property holds the specific changes of the object
+            #   - the `patch_ver` (compulsory) is **incremental** (for data integrity)
+            #   - the properties that have changed
+            # @note
+            #   * there should not be difference between `null` and `""` (empty string)
+            # @param a [Hash] current hash model
+            # @param b [Hash] previous hash model
+            # @return [Hash] a `patch data`
+            def patch_diff(a, b)
+              case
+              when b.is_a?(Hash) && !empty?(b) && empty?(a)
+                patch_delete(b)
+              when a.is_a?(Hash) && !empty?(a) && empty?(b)
+                patch_new(a)
+              when a.is_a?(Hash) && b.is_a?(Hash)
+                patch_update(a, b)
+              when any_array?(a, b)
+                patch_data_array(a, b)
+              else
+                a
+              end
+            end
+
+            private
+
+            def equal_values(a, b)
+              if a.is_a?(String) || b.is_a?(String)
+                return true if a.to_s.strip.empty? && b.to_s.strip.empty?
+              end
+              a == b
+            end
+
+            def patch_data(a, b = nil, delete: false)
+              {}.tap do |data_hash|
+                if delete
+                  patch_ver = (a && a["patch_ver"]) || 1
+                  data_hash["patch_ver"] = patch_ver
+                  next
+                end
+                a.each do |key, a_value|
+                  b_value = b[key] if b_has_key = b && b.key?(key)
+                  is_meta_key = META_KEYS.include?(key)
+                  skip_equals = b_has_key && equal_values(a_value, b_value)
+                  next if is_meta_key || skip_equals
+                  data_hash[key] = patch_diff(a_value, b_value)
+                  data_hash.delete(key) if data_hash[key] == NO_CHANGES
+                end
+                if (data_hash.keys - META_KEYS).empty?
+                  return NO_CHANGES
+                else
+                  patch_ver = (b && b["patch_ver"]) || 1
+                  data_hash["patch_ver"] = patch_ver
+                end
+              end
+            end
+
+            def patch_delete(b)
+              return NO_CHANGES unless b.is_a?(Hash) && id = get_id(b, exception: false)
+              {
+                "id"        => id,
+                "operation" => "deleted",
+                "data"      => patch_data(b, delete: true)
+              }
+            end
+
+            def patch_new(a)
+              return NO_CHANGES unless a.is_a?(Hash) && id = get_id(a, exception: false)
+              {
+                "id"        => id,
+                "operation" => "new",
+                "data"      => patch_data(a)
+              }
+            end
+
+            def patch_update(a, b)
+              return NO_CHANGES unless a.is_a?(Hash) && id = get_id(a, exception: false)
+              {
+                "id"        => id,
+                "operation" => "changed",
+                "data"      => patch_data(a, b)
+              }.tap do |update_hash|
+                return nil unless update_hash["data"] != NO_CHANGES
+              end
+            end
+
+            def patch_data_array(a, b)
+              original_b = b
+              a ||= []; b ||= []
+              if !nested_array?(a, b)
+                if a.length == b.length && (a & b).length == b.length
+                  if original_b
+                    NO_CHANGES
+                  else
+                    a
+                  end
+                else
+                  a
+                end
+              else # array with nested elements
+                a_ids = array_ids(a)
+                b_ids = array_ids(b)
+
+                del_ids = b_ids - a_ids
+                oth_ids = b_ids & a_ids
+                new_ids = a_ids - b_ids
+
+                arr_delete = del_ids.map do |id|
+                  patch_delete(array_id_item(b, id))
+                end.compact
+
+                arr_update = oth_ids.map do |id|
+                  patch_update(array_id_item(a, id), array_id_item(b, id))
+                end.compact
+
+                arr_new = new_ids.map do |id|
+                  patch_new(array_id_item(a, id))
+                end.compact
+
+                (arr_delete.concat(arr_update).concat(arr_new)).tap do |patch_array|
+                  # remove data with no `id`
+                  patch_array.reject! {|item| !item.is_a?(Hash)}
+                  return NO_CHANGES if patch_array.empty?
+                end
+              end
+            end
+
+            def nested_array?(*arr)
+              case
+              when arr.length > 1
+                arr.any? {|a| nested_array?(a)}
+              when arr.length == 1
+                arr = arr.first
+                arr.any? {|item| item.is_a?(Hash)}
+              else
+                false
+              end
+            end
+
+            def any_array?(a, b)
+              [a, b].any? {|item| item.is_a?(Array)}
+            end
+
+            def empty?(a)
+              bool   = !a
+              bool ||= a.respond_to?(:empty?) && a.empty?
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/common/content/string_digest.rb

@@ -0,0 +1,27 @@
+require 'digest'
+
+module Ecoportal
+  module API
+    module Common
+      module Content
+        module StringDigest
+          MAX_HASH_LABEL = 64
+
+          def indexable_label(str)
+            return nil unless str
+            lbl = str.downcase.gsub(/[^A-Za-z]+/,"-").slice(0, MAX_HASH_LABEL)
+            return nil unless lbl.length >= 3
+            lbl
+          end
+
+          # Calculates the Hash of the field based on label
+          def hash_label(str)
+            return nil unless lbl = indexable_label(str)
+            "z" +  Digest::MD5.hexdigest(lbl).slice(0, 8);
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/common/content/wrapped_response.rb

@@ -0,0 +1,42 @@
+module Ecoportal
+  module API
+    module Common
+      module Content
+        class WrappedResponse < Common::WrappedResponse
+          include Enumerable
+
+          attr_reader :response, :result
+
+          def initialize(response, klass, key: nil)
+            @response = response
+            @klass    = klass
+            @key      = key
+
+            if @response.success?
+              @result =
+                if data.is_a?(Array)
+                  data.map do |doc|
+                    @klass.new(doc)
+                  end
+                else
+                  @klass.new(data)
+                end
+            end
+          end
+
+          def data
+            return @data if instance_variable_defined?(:@data)
+            @data = (response.body || {})["data"]
+            @data = @data[@key] if @key && @data
+            @data
+          end
+
+          def body
+            data.to_s
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/v2.rb

@@ -0,0 +1,82 @@
+require 'base64'
+
+module Ecoportal
+  module API
+    # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+    # @attr_reader logger [Logger] the logger.
+    class V2
+      extend Common::BaseClass
+      include Common::Logging
+
+      VERSION = "v2"
+
+      class << self
+        def v2key (ukey, gkey)
+          Base64.urlsafe_encode64({
+            organization: gkey,
+            user:         ukey
+          }.to_json)
+        end
+      end
+
+      class_resolver :people_class,    "Ecoportal::API::V2::People"
+      class_resolver :registers_class, "Ecoportal::API::V2::Registers"
+      class_resolver :pages_class,     "Ecoportal::API::V2::Pages"
+
+      attr_reader :client, :logger
+
+      # Creates an `V2` object to scope version specific api requests.
+      # @note
+      #   - You should use either `api_key` or `user_key` and `org_key`
+      #   - The const `VERSION` determineds the api version that client will query against.
+      #   - This means that each subclass of `V2` should define their own `VERSION` constant.
+      # @param api_key [String] the key version to stablish the api connection.
+      # @param user_key [String] the user key used for the api connection (requires `org_key`).
+      # @param org_key [String] the org key used for the api connection (requires `user_key`).
+      # @param host [String] api server domain.
+      # @param logger [Logger] an object with `Logger` interface to generate logs.
+      def initialize(api_key = nil, user_key: nil, org_key: nil, host: "live.ecoportal.com", logger: default_logger)
+        v2key   = get_key(api_key: api_key, user_key: user_key, org_key: org_key)
+        @logger = logger
+        @client = Common::Content::Client.new(
+          api_key: v2key,
+          host:    host,
+          version: self.class::VERSION,
+          logger:  @logger
+        )
+      end
+
+      # Obtain specific object for people api requests.
+      # @return [People] an instance object ready to make people api requests.
+      def people
+        people_class.new(client)
+      end
+
+      # Obtain specific object for schema api requests.
+      # @return [Registers] an instance object ready to make registers api requests.
+      def registers
+        registers_class.new(client)
+      end
+
+      # Obtain specific object for pages api requests.
+      # @return [Pages] an instance object ready to make pages api requests.
+      def pages
+        pages_class.new(client)
+      end
+
+      private
+
+      def get_key(api_key: nil, user_key: nil, org_key: nil)
+        return self.class.v2key(user_key, org_key) if user_key && org_key
+        return api_key if api_key #|| ENV['X_ECOPORTAL_API_KEY']
+        raise "You need to provide either an api_key or user_key" unless user_key
+        raise "You need to provide an org_key as well (not just a user_key)" unless org_key
+      end
+
+    end
+  end
+end
+
+require 'ecoportal/api/v2/people'
+require 'ecoportal/api/v2/pages'
+require 'ecoportal/api/v2/registers'

data/lib/ecoportal/api/v2/page.rb

@@ -0,0 +1,42 @@
+module Ecoportal
+  module API
+    class V2
+      class Page < Common::Content::DoubleModel
+        ALLOWED_KEYS  = %w[id patch_ver name template_id base_tags tags time_zone created_at updated_at can components sections stages]
+        passkey     :id
+        passthrough :patch_ver
+        passthrough :name, :template_id
+        passarray   :base_tags, :tags, order_matters: false
+        passthrough :time_zone
+        passdate    :created_at, :updated_at, read_only: true
+        passthrough :can
+
+        class_resolver :components_class, "Ecoportal::API::V2::Page::Components"
+        class_resolver :sections_class,   "Ecoportal::API::V2::Page::Sections"
+        class_resolver :stages_class,     "Ecoportal::API::V2::Page::Stages"
+
+        embeds_many :components, enum_class: :components_class
+        embeds_many :sections,   enum_class: :sections_class
+        embeds_many :stages,     enum_class: :stages_class
+
+        def as_update
+          super.tap do |hash|
+            unless !hash
+              hash["data"].select! do |key, value|
+                ALLOWED_KEYS.include?(key)
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/page/component'
+require 'ecoportal/api/v2/page/components'
+require 'ecoportal/api/v2/page/section'
+require 'ecoportal/api/v2/page/sections'
+require 'ecoportal/api/v2/page/stage'
+require 'ecoportal/api/v2/page/stages'

data/lib/ecoportal/api/v2/page/component.rb

@@ -0,0 +1,133 @@
+module Ecoportal
+  module API
+    class V2
+      class Page
+        class Component < Common::Content::DoubleModel
+          extend Ecoportal::API::Common::Content::StringDigest
+
+          class_resolver :tag_field_class,        "Ecoportal::API::V2::Page::Component::TagField"
+          class_resolver :geo_field_class,        "Ecoportal::API::V2::Page::Component::GeoField"
+          class_resolver :selection_field_class,  "Ecoportal::API::V2::Page::Component::SelectionField"
+          class_resolver :date_field_class,       "Ecoportal::API::V2::Page::Component::DateField"
+          class_resolver :number_field_class,     "Ecoportal::API::V2::Page::Component::NumberField"
+          class_resolver :gauge_field_class,      "Ecoportal::API::V2::Page::Component::GaugeField"
+          class_resolver :plain_text_field_class, "Ecoportal::API::V2::Page::Component::PlainTextField"
+          class_resolver :rich_text_field_class,  "Ecoportal::API::V2::Page::Component::RichTextField"
+          class_resolver :people_field_class,     "Ecoportal::API::V2::Page::Component::PeopleField"
+          class_resolver :checklist_field_class,  "Ecoportal::API::V2::Page::Component::ChecklistField"
+          class_resolver :action_field_class,     "Ecoportal::API::V2::Page::Component::ActionField"
+          class_resolver :files_field_class,      "Ecoportal::API::V2::Page::Component::FilesField"
+          class_resolver :images_field_class,     "Ecoportal::API::V2::Page::Component::ImagesField"
+          class_resolver :signature_field_class,  "Ecoportal::API::V2::Page::Component::SignatureField"
+          class_resolver :reference_field_class,  "Ecoportal::API::V2::Page::Component::ReferenceField"
+          class_resolver :law_field_class,        "Ecoportal::API::V2::Page::Component::LawField"
+          class_resolver :chart_field_class,      "Ecoportal::API::V2::Page::Component::ChartField"
+          class_resolver :chart_fr_field_class,   "Ecoportal::API::V2::Page::Component::ChartFrField"
+
+          class << self
+            def new_doc(type: nil)
+              if type
+                type_doc = {"type" => type}
+                base_doc = get_class(type_doc)&.new_doc || {}
+                base_doc.merge!(type_doc)
+              end
+              return base_doc if base_doc&.key?("id")
+              (base_doc || {}).merge("id" => new_uuid)
+            end
+
+            def get_class(doc)
+              if doc.is_a?(Hash)
+                case doc["type"]
+                when "tag_field"
+                  tag_field_class
+                when "geo"
+                  geo_field_class
+                when "select"
+                  selection_field_class
+                when "date"
+                  date_field_class
+                when "number"
+                  number_field_class
+                when "gauge"
+                  gauge_field_class
+                when "plain_text"
+                  plain_text_field_class
+                when "rich_text"
+                  rich_text_field_class
+                when "people"
+                  people_field_class
+                when "checklist"
+                  checklist_field_class
+                when "page_action","checklist_task"
+                  #doc["type"] = "checklist_task"
+                  action_field_class
+                when "file"
+                  files_field_class
+                when "image_gallery"
+                  images_field_class
+                when "signature"
+                  signature_field_class
+                when "cross_reference"
+                  reference_field_class
+                when "law"
+                  law_field_class
+                when "chart"
+                  chart_field_class
+                when "frequency_rate_chart"
+                  chart_fr_field_class
+                else
+                  self
+                end
+              end
+            end
+          end
+
+          passkey     :id
+          passthrough :patch_ver, :undeletable
+          passthrough :type, :label, :tooltip, :global_binding
+          passthrough :hidden, :accent, :deindex, :required
+          passthrough :hide_view, :hidden_on_reports, :hidden_on_mobile
+          passarray   :refs
+
+          def ref_backend
+            refs.first
+          end
+
+          def ref
+            if digest = self.class.hash_label(label)
+              [type, digest].join(".")
+            end
+          end
+
+          def section
+            root.sections.find {|sec| sec.component?(id)}
+          end
+
+          def indexable_label
+            self.class.indexable_label(label)
+          end
+
+        end
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/v2/page/component/tag_field'
+require 'ecoportal/api/v2/page/component/geo_field'
+require 'ecoportal/api/v2/page/component/selection_field'
+require 'ecoportal/api/v2/page/component/date_field'
+require 'ecoportal/api/v2/page/component/number_field'
+require 'ecoportal/api/v2/page/component/gauge_field'
+require 'ecoportal/api/v2/page/component/plain_text_field'
+require 'ecoportal/api/v2/page/component/rich_text_field'
+require 'ecoportal/api/v2/page/component/people_field'
+require 'ecoportal/api/v2/page/component/checklist_field'
+require 'ecoportal/api/v2/page/component/action_field'
+require 'ecoportal/api/v2/page/component/files_field'
+require 'ecoportal/api/v2/page/component/images_field'
+require 'ecoportal/api/v2/page/component/signature_field'
+require 'ecoportal/api/v2/page/component/reference_field'
+require 'ecoportal/api/v2/page/component/law_field'
+require 'ecoportal/api/v2/page/component/chart_field'
+require 'ecoportal/api/v2/page/component/chart_fr_field'