ecoportal-api-v2 1.1.7 → 2.0.0

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

@@ -14,7 +14,7 @@ module Ecoportal
           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 :contractor_entities_field_class, "Ecoportal::API::V2::Page::Component::ContractorEntitiesField"
+          class_resolver :contractor_entities_field_class, "Ecoportal::API::V2::Page::Component::ContractorEntitiesField" # rubocop:disable Layout/LineLength
           class_resolver :checklist_field_class,  "Ecoportal::API::V2::Page::Component::ChecklistField"
           class_resolver :action_field_class,     "Ecoportal::API::V2::Page::Component::ActionField"
           class_resolver :actions_field_class,    "Ecoportal::API::V2::Page::Component::ActionsField"
@@ -30,65 +30,64 @@ module Ecoportal
           class << self
             def new_doc(type: nil)
               {
-                "id"         => new_uuid
+                "id" => new_uuid
               }.tap do |base_doc|
                 if type
                   base_doc.merge!({"type" => type})
-                  if klass = get_class(base_doc)
+                  if (klass = get_class(base_doc))
                     base_doc.merge!(klass.new_doc || {})
                   end
                 end
               end
             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 "contractor_entities"
-                  contractor_entities_field_class
-                when "checklist"
-                  checklist_field_class
-                when "page_action","checklist_task"
-                  action_field_class
-                when "actions_list"
-                  actions_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 "mailbox"
-                  mailbox_field_class
-                when "chart"
-                  chart_field_class
-                when "frequency_rate_chart"
-                  chart_fr_field_class
-                else
-                  self
-                end
+            def get_class(doc) # rubocop:disable Metrics/AbcSize
+              return nil unless 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 "contractor_entities"
+                contractor_entities_field_class
+              when "checklist"
+                checklist_field_class
+              when "page_action", "checklist_task"
+                action_field_class
+              when "actions_list"
+                actions_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 "mailbox"
+                mailbox_field_class
+              when "chart"
+                chart_field_class
+              when "frequency_rate_chart"
+                chart_fr_field_class
+              else
+                self
               end
             end
           end
@@ -103,7 +102,7 @@ module Ecoportal
           passarray   :refs
 
           def ooze
-            self._parent.ooze
+            _parent.ooze
           end
 
           def ref_backend
@@ -111,9 +110,10 @@ module Ecoportal
           end
 
           def ref(any_length: false)
-            if digest = self.class.hash_label(label, any_length: any_length)
-              [type, digest].join(".")
-            end
+            digest = self.class.hash_label(label, any_length: any_length)
+            return unless digest
+
+            [type, digest].join(".")
           end
 
           # Looks up the section that this component belongs to.
@@ -159,19 +159,19 @@ module Ecoportal
 
           # @return [Boolean] `true` if the component is bound to any force, `false` otherwise
           def bindings?
-            forces.count > 0
+            forces.count&.positive?
           end
 
           # If the field has bindings they are replaced by this new field
           # @note careful with this, depending what's done in the force, this may brake the force.
           def replace(fld)
             if fld.section
-              fld.move(section: self.section, before: self)
+              fld.move(section: section, before: self)
             else
-              self.section.add(fld, before: self)
+              section.add(fld, before: self)
             end
             replace_bindings(fld)
-            self.delete!
+            delete!
           end
 
           def replace_bindings(fld)
@@ -179,13 +179,13 @@ module Ecoportal
           end
 
           def delete!
-            bindings.each {|b| b.delete!}
-            self.unattach!
-            self._parent.delete!(self)
+            bindings.each(&:delete!)
+            unattach!
+            _parent.delete!(self)
           end
 
           def move(section:, before: nil, after: nil, side: nil)
-            self.unattach!
+            unattach!
             section.add_component(self, before: before, after: after, side: side)
           end
 
@@ -212,17 +212,16 @@ module Ecoportal
               when :hide_reports
                 self.hidden_on_reports = true
               when Hash
-                if cnf.key?(:global)
-                  self.global_binding = cnf[:global]
-                end
+                self.global_binding = cnf[:global] if cnf.key?(:global)
               else
                 unused.push(cnf)
               end
             end.tap do |unused|
-              raise "Unsupported configuration options '#{unused}' for #{self.class}" unless unused.empty?
+              next if unused.empty?
+
+              raise "Unsupported configuration options '#{unused}' for #{self.class}"
             end
           end
-
         end
       end
     end

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

@@ -5,28 +5,28 @@ module Ecoportal
         class Components < Common::Content::CollectionModel
           class_resolver :component_class, "Ecoportal::API::V2::Page::Component"
 
-          self.klass do |doc|
+          klass do |doc|
             component_class.get_class(doc).tap do |klass|
               klass.key = :id
             end
           end
 
-          order_matters = true
+          #self.order_matters = true
 
           def ooze
-            self._parent.ooze
+            _parent.ooze
           end
 
           # @return [Ecoportal::API::V2::Page::Component] the field with `id`
           def get_by_id(id)
-            self.find do |comp|
+            find do |comp|
               comp.id == id
             end
           end
 
           # @return [Array<Ecoportal::API::V2::Page::Component>] the fields of that `type`
           def get_by_type(type)
-            self.select do |comp|
+            select do |comp|
               comp.type.downcase == type.to_s.strip.downcase
             end
           end
@@ -53,19 +53,19 @@ module Ecoportal
           def add(doc: nil, label: doc && doc["label"], type: doc && doc["type"])
             fld_doc = doc ? JSON.parse(doc.to_json) : component_class.new_doc(type: type)
             upsert!(fld_doc) do |fld|
-              fld.label  = label if !doc
-              yield(fld) if block_given?
+              fld.label = label unless doc
+              yield(fld)        if block_given?
             end
           end
 
           # @return [Array<Ecoportal::API::V2::Page::Component>] **orphaned** fields (with no section).
           def unattached
-            select {|comp| !comp.attached?}
+            reject(&:attached?)
           end
 
           # @return [Array<Ecoportal::API::V2::Page::Component>] fields belonging to more than one section.
           def multi_section
-            select {|comp| comp.multi_section?}
+            select(&:multi_section?)
           end
         end
       end

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

@@ -8,8 +8,8 @@ module Ecoportal
           class << self
             def new_doc
               {
-                "id"      => new_uuid,
-                "weight"  => INITIAL_WEIGHT
+                "id"     => new_uuid,
+                "weight" => INITIAL_WEIGHT
               }
             end
           end
@@ -23,11 +23,11 @@ module Ecoportal
           passdate    :last_synced_at
           passthrough :custom_script
           passthrough :script, read_only: true
-          embeds_many :bindings,  enum_class: :bindings_class
-          embeds_many :helpers,  klass: :helper_class
+          embeds_many :bindings, enum_class: :bindings_class
+          embeds_many :helpers, klass: :helper_class
 
           def ooze
-            self._parent.ooze
+            _parent.ooze
           end
 
           # @see Ecoportal::API::V2::Page::Force::Bindings#add
@@ -39,12 +39,11 @@ module Ecoportal
           def custom_script=(value)
             doc["custom_script"] = value
             update_script
-            value
           end
 
           # It sets the `script` value by using `custom_script` and `helpers[N..1].script`
           def update_script
-            doc["script"] = helpers.to_a.reverse.map(&:script).push(self.custom_script).join("\n")
+            doc["script"] = helpers.to_a.reverse.map(&:script).push(custom_script).join("\n")
           end
         end
       end

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

@@ -5,27 +5,26 @@ module Ecoportal
         class Stages < Common::Content::CollectionModel
           class_resolver :stage_class, "Ecoportal::API::V2::Page::Stage"
 
-          self.klass = :stage_class
+          self.klass     = :stage_class
           self.order_key = :ordering
-          
+
           def ooze
-            self._parent.ooze
+            _parent.ooze
           end
 
           # @param name [String, Regexp] the `name` of the stage to find.
           # @return [Ecoportal::API::V2::Page::Stage, nil]
           def get_by_name(name)
-            self.find do |stage|
+            find do |stage|
               same_string?(stage.name, name)
             end
           end
 
           def ordered
-            self.sort_by.with_index do |stage, index|
+            sort_by.with_index do |stage, index|
               [stage.ordering, index]
             end
           end
-
         end
       end
     end

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

@@ -2,18 +2,19 @@ module Ecoportal
   module API
     class V2
       class Page < Common::Content::DoubleModel
-        ALLOWED_KEYS  = [
-          "id", "patch_ver", "name", "template_id",
-          "base_tags", "tags",
-          "time_zone", "created_at", "updated_at",
-          "components", "sections", "stages",
-          "permits", "mould_counter", "mould",
-          "state", "task_priority",
-          "votes_enabled", "upvotes", "downvotes",
-          "forces", "force_errors", "subtags"
-        ]
+        ALLOWED_KEYS = %w[
+          id external_id patch_ver name template_id
+          base_tags tags
+          time_zone created_at updated_at
+          components sections stages
+          permits mould_counter mould
+          state task_priority
+          votes_enabled upvotes downvotes
+          forces force_errors subtags
+        ].freeze
 
         passkey     :id
+        passthrough :external_id
         passforced  :patch_ver, default: 1
         passthrough :name, :template_id
         passarray   :base_tags, :tags, order_matters: false
@@ -41,48 +42,50 @@ module Ecoportal
 
         def as_update
           super.tap do |hash|
-            unless !hash
-              hash["data"].select! do |key, value|
-                ALLOWED_KEYS.include?(key)
-              end
-              return nil if (hash["data"].keys - ["patch_ver"]).empty?
+            next unless hash
+
+            hash["data"].select! do |key, _value|
+              ALLOWED_KEYS.include?(key)
             end
+
+            return nil if (hash["data"].keys - ["patch_ver"]).empty?
           end
         end
 
         def stages?
-          self.doc["stages"] && (self.stages.count > 0)
+          doc["stages"] && stages.count.positive?
         end
 
         # @return [String] with feedback, if for this page instance, there are any of:
         #   1. components multi-section (fields belonging to more than one section)
         def validate
-          msg = ""
-          if (multi = components.multi_section).length > 0
-            msg += "There are fields attached to more than one section:\n  • "
-            msg += multi.map do |fld|
-              fld.label
-            end.join("\n  • ") + "\n"
-          end
+          multi = components.multi_section
+          return true unless multi.length.positive?
 
-          msg.empty?? true : msg
+          msg = ""
+          msg << "There are fields attached to more than one section:"
+          msg << "\n  • "
+          msg << multi.map(&:label).join("\n  • ")
+          msg << "\n"
+          msg
         end
 
         private
 
         def _doc_bug_fix(hash)
-          hash.tap do |hash|
+          hash.tap do
             _fix_doc(hash["stages"], "flow_node_ids", "section_ids") if hash.key?("stages")
-            if hash.key?("sections")
-              _fix_doc(hash["sections"], "membrane_ids", "component_ids")
-              _fix_doc(hash["sections"], "left_membrane_ids", "left_component_ids")
-              _fix_doc(hash["sections"], "right_membrane_ids", "right_component_ids")
-            end
+
+            next unless hash.key?("sections")
+
+            _fix_doc(hash["sections"], "membrane_ids", "component_ids")
+            _fix_doc(hash["sections"], "left_membrane_ids", "left_component_ids")
+            _fix_doc(hash["sections"], "right_membrane_ids", "right_component_ids")
           end
         end
 
         def _fix_doc(value, source, dest)
-          value.tap do |value|
+          value.tap do
             case value
             when Array
               value.each {|v| _fix_doc(v, source, dest)}
@@ -91,12 +94,11 @@ module Ecoportal
                 value[dest] = value[source]
                 value.delete(source)
               end
-            else
+            else # rubocop:disable Style/EmptyElse
               # Do nothing!
             end
           end
         end
-
       end
     end
   end

data/lib/ecoportal/api/v2/pages/page_stage.rb

@@ -18,11 +18,10 @@ module Ecoportal
 
           # @return [String] unique id
           def uid
-            if mould_counter? && counter = mould_counter
-              counter.render
-            else
-              id
-            end
+            return id unless mould_counter?
+            return id unless (counter = mould_counter)
+
+            counter.render
           end
 
           # @return [String] `id` of the stage we got the data of.
@@ -32,43 +31,46 @@ module Ecoportal
 
           # @return [Ecoportal::API::V2::Page::Stage]
           def current_stage
-            if stage_id = current_stage_id
-              stages[stage_id]
-            end
+            return false unless (stage_id = current_stage_id)
+
+            stages[stage_id]
           end
 
           # @return [String] with feedback, if for this page instance, there are any of:
           #   1. orphaned components (fields not belonging to any section)
           #   2. orphaned sections (sections not belonging to any stage)
-          def validate
+          def validate # rubocop:disable Metrics/AbcSize
             msg  = super
             msg  = "" unless msg.is_a?(String)
 
             orphans = components.unattached.select {|comp| comp.global_binding.to_s.strip.empty?}
-            if orphans.length > 0
-              msg += "There are fields not attached to any sections:\n  • "
-              msg += orphans.map do |fld|
-                fld.label
-              end.join("\n  • ") + "\n"
+            if orphans.length.positive?
+              msg << "There are fields not attached to any sections:"
+              msg << "\n  • "
+              msg << orphans.map(&:label).join("\n  • ")
+              msg << "\n"
             end
 
-            if (orphans = sections.unattached).length > 0
-              msg += "There are sections not attached to any stage:\n  • "
-              msg += orphans.map do |sec|
+            if (orphans = sections.unattached).length.positive?
+              msg << "There are sections not attached to any stage:"
+              msg << "\n  • "
+              msg << orphans.map do |sec|
                 "'#{sec.heading}' (#{sec.id})"
-              end.join("\n  • ") + "\n"
+              end.join("\n  • ")
+              msg << "\n"
             end
+
             msg.empty?? true : msg
           end
 
           def mark_as_submit
             doc["submitted"] = true
-            doc["type"] = "complete_page"
+            doc["type"]      = "complete_page"
           end
 
           def mark_as_sign_off
             doc["sign_off"] = true
-            doc["type"] = "review_page"
+            doc["type"]     = "review_page"
           end
         end
       end

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

@@ -1,16 +1,17 @@
 module Ecoportal
   module API
     class V2
-      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+      # @attr_reader client [Common::Client] a `Common::Client` object that
+      #   holds the configuration of the api connection.
       class Pages
-        STAGE_REX = /stages\/(?<sid>.*)/
+        STAGE_REX = /stages\/(?<sid>.*)/.freeze
         extend Common::BaseClass
         include Common::Content::DocHelpers
 
         class_resolver :stages_class, "Ecoportal::API::V2::Pages::Stages"
-        class_resolver :page_class,  "Ecoportal::API::V2::Page"
-        class_resolver :page_stage_class,  "Ecoportal::API::V2::Pages::PageStage"
-        class_resolver :create_page_response_class,  "Ecoportal::API::V2::Pages::PageCreateResponse"
+        class_resolver :page_class, "Ecoportal::API::V2::Page"
+        class_resolver :page_stage_class, "Ecoportal::API::V2::Pages::PageStage"
+        class_resolver :create_page_response_class, "Ecoportal::API::V2::Pages::PageCreateResponse"
 
         attr_reader :client
 
@@ -35,16 +36,19 @@ module Ecoportal
         # @return [Ecoportal::API::V2::Page, Ecoportal::API::V2::Pages::PageStage] the target page.
         def get(id, stage_id: nil)
           return stages.get(id: id, stage_id: stage_id) if stage_id
+
           id       = get_id(id)
           response = client.get("/pages/#{CGI.escape(id)}")
           wrapped  = Common::Content::WrappedResponse.new(response, page_class)
 
           return wrapped.result if wrapped.success?
-          if (response.status == 302) && (url = response.body["data"])
-            if stage_id = url_to_stage_id(url)
-              return stages.get(id: id, stage_id: stage_id)
-            end
-          end
+
+          url = nil
+          url = response.body["data"]     if response.status == 302
+          stage_id = url_to_stage_id(url) unless url.nil?
+
+          return stages.get(id: id, stage_id: stage_id) if stage_id
+
           raise "Could not get page #{id} - Error #{response.status}: #{response.body}"
         end
 
@@ -56,7 +60,8 @@ module Ecoportal
           body = get_body(doc) # , level: "page"
           # Launch only if there are changes
           raise "Missing page object" unless body && body["page"]
-          id   = get_id(doc)
+
+          id = get_id(doc)
           client.patch("/pages/#{CGI.escape(id)}", data: body)
         end
 
@@ -81,9 +86,9 @@ module Ecoportal
           body   = get_body(doc).tap do |hash|
             unless hash["page"]
               hash["page"] = {
-                "id" => "111111111111111111111111",
+                "id"        => "111111111111111111111111",
                 "operation" => "changed",
-                "data" => {"patch_ver" => 0}
+                "data"      => {"patch_ver" => 0}
               }
             end
           end
@@ -98,7 +103,6 @@ module Ecoportal
         def url_to_stage_id(url)
           (matches = url.match(STAGE_REX)) && matches[:sid]
         end
-
       end
     end
   end

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

@@ -1,9 +1,9 @@
 module Ecoportal
   module API
     class V2
-      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+      # @attr_reader client [Common::Client] a `Common::Client` object that
+      #   holds the configuration of the api connection.
       class People < API::Internal::People
-
         def batch
           unavailable_method!(__method__)
         end
@@ -24,7 +24,6 @@ module Ecoportal
         def unavailable_method!(str)
           raise "Unavailable method '#{str}' for api '#{VERSION}'"
         end
-
       end
     end
   end