ecoportal-api-v2 2.0.5 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97b022ff724f1d1d3f80b357d482e54ebba3750751de3771097840c1a9a1e697
-  data.tar.gz: f587813ad0917441c55c1a5dde359ca5e12070ee22d899f5a41646fa63af40dc
+  metadata.gz: 5640c86f2f87990f7d4c3906f4732ee196b757966c3c3cc08f0a87e458ccb4a5
+  data.tar.gz: c90366a05f7c35fc77a0d8374384258277092e9d7b3ee25f458ab815a41162ce
 SHA512:
-  metadata.gz: 8d4e4f6c25ab85c7c8c0a119fdab33b107b519022c66ce57c2159e1de89cb73e200243e59105adc7c50d0dd3a718367ecbc9d47e8fda5766d6ab33c3a09ed3cd
-  data.tar.gz: d8230c7c42ff3f358d9b33a8a81d194f8aba30149089c5201f5bf21a905028195503e8a0530a6a99e4c1ce4f828f4ea5e4b691b4528a569e20fb362c6884f84e
+  metadata.gz: 2aa98c2d721ff735425e9c21aee036698e5467a3c010e35d84921d9352ae12400f627c8a2a16359177ac22e583a417b05302c852b513b3d6d6bc4743b8cac170
+  data.tar.gz: f356407dfd38797be43f29ad02d7a1772c7136cf1d686eb2554dc226316184aa70e27c89b9de39d52725ab6b95505149a1d7b38a39897915862d8a0dfa33e3ca

data/.rubocop.yml

@@ -29,6 +29,11 @@ Style/ConditionalAssignment:
   Enabled: false
 Style/BlockDelimiters:
   BracesRequiredMethods: ['log']
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either
+  EnforcedStyle: no_mixed_keys
+Style/ArgumentsForwarding:
+  UseAnonymousForwarding: false
 Style/ClassAndModuleChildren:
   Enabled: false
 Style/FrozenStringLiteralComment:
@@ -92,3 +97,5 @@ Naming/MethodParameterName:
   AllowedNames: ['x', 'y', 'i', 'j', 'id', 'io']
 Naming/RescuedExceptionsVariableName:
   Enabled: false
+Naming/BlockForwarding:
+  Enabled: false

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [2.0.6] - 2024-08-xx
+## [2.0.10] - 2024-08-xx
 
 ### Added
 
@@ -10,6 +10,30 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [2.0.9] - 2024-08-22
+
+### Added
+
+- `force_complete` stage tasks
+
+## [2.0.8] - 2024-08-08
+
+### Fixed
+
+- Force to load via `ecoportal/api-v2`
+
+## [2.0.7] - 2024-08-08
+
+### Fixed
+
+- Get `Common` namespaced all over the code
+
+## [2.0.6] - 2024-08-08
+
+### Fixed
+
+- use full path and `require` only
+
 ## [2.0.5] - 2024-08-07
 
 ### Fixed

data/ecoportal-api-v2.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "pry"      , '>= 0.14'
+  spec.add_development_dependency "pry"      , '~> 0.14'
   spec.add_development_dependency "rake",      '>= 13.0.3', "< 14"
   spec.add_development_dependency "redcarpet", '>= 3.6.0',  "< 4"
   spec.add_development_dependency "rspec",     '>= 3.12.0', "< 4"

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

@@ -4,7 +4,7 @@ module Ecoportal
     module Common
       module Content
         module ClassHelpers
-          include Common::BaseClass
+          include Ecoportal::API::Common::BaseClass
           NOT_USED = "no_used!".freeze
 
           # Class resolver

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

@@ -3,7 +3,7 @@ module Ecoportal
     module Common
       module Content
         # @see Ecoportal::API::Common::Client
-        class Client < Common::Client
+        class Client < Ecoportal::API::Common::Client
           attr_accessor :logger
 
           # @note the `api_key` will be automatically added as parameter `X-ECOPORTAL-API-KEY` in the header of the http requests.

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

@@ -13,9 +13,9 @@ module Ecoportal
                 when doc.respond_to?(:as_update)
                   doc.as_update
                 when doc.respond_to?(:as_json)
-                  Common::Content::HashDiffPatch.patch_diff(doc.as_json, nil)
+                  HashDiffPatch.patch_diff(doc.as_json, nil)
                 when doc.is_a?(Hash)
-                  Common::Content::HashDiffPatch.patch_diff(doc, nil)
+                  HashDiffPatch.patch_diff(doc, nil)
                 else
                   raise "Could not get body for doc: #{doc}"
                 end

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

@@ -5,7 +5,7 @@ module Ecoportal
         # Basic model class, to **build _get_ / _set_ `methods`** for a given property
         # which differs of `attr_*` ruby native class methods because `pass*`
         # completelly **links** the methods **to a subjacent `Hash` model**
-        class DoubleModel < Common::BaseModel
+        class DoubleModel < Ecoportal::API::Common::BaseModel
           class UnlinkedModel < StandardError
             def initialize(msg = "Something went wrong when linking the document.", from: nil, key: nil)
               msg += " From: #{from}." if from
@@ -17,9 +17,9 @@ module Ecoportal
           class NoKeyMethod < StandardError
           end
 
-          NOT_USED = Common::Content::ClassHelpers::NOT_USED
-          extend Common::Content::ClassHelpers
-          include Common::Content::ModelHelpers
+          NOT_USED = ClassHelpers::NOT_USED
+          extend ClassHelpers
+          include ModelHelpers
 
           class << self
             attr_reader :key
@@ -176,7 +176,7 @@ module Ecoportal
                 method = method.to_s.freeze
                 var    = instance_variable_name(method)
 
-                dim_class = new_class(method, inherits: Common::Content::ArrayModel) do |klass|
+                dim_class = new_class(method, inherits: ArrayModel) do |klass|
                   klass.order_matters = order_matters
                   klass.uniq          = uniq
                 end
@@ -213,7 +213,7 @@ module Ecoportal
               if enum_class
                 eclass = enum_class
               elsif klass
-                eclass = new_class("#{method}::#{klass}", inherits: Common::Content::CollectionModel) do |dim_class|
+                eclass = new_class("#{method}::#{klass}", inherits: CollectionModel) do |dim_class|
                   # NOTE: new_class may resolve the namespace of the class to an already existing class
                   dim_class.klass       ||= klass
                   dim_class.order_matters = order_matters
@@ -378,7 +378,7 @@ module Ecoportal
           #   `original_doc` and `doc`
           def as_update
             new_doc = as_json
-            Common::Content::HashDiffPatch.patch_diff(new_doc, original_doc)
+            HashDiffPatch.patch_diff(new_doc, original_doc)
           end
 
           # @return [Boolean] stating if there are changes
@@ -509,7 +509,7 @@ module Ecoportal
           # It allows to work-around missing item_key
           def setup_items_key(embedded_class, obj_doc)
             # only if is going to be a collection
-            return unless obj_doc.is_a?(Array) && embedded_class < Common::Content::CollectionModel
+            return unless obj_doc.is_a?(Array) && embedded_class < CollectionModel
             return unless (item_class = embedded_class.klass)
             # if already has key don't need to work around
             return if     item_class&.key

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

@@ -3,10 +3,11 @@ module Ecoportal
     module Common
       module Content
         module HashDiffPatch
+          extend DocHelpers
+
           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:

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     module Common
       module Content
-        class WrappedResponse < Common::WrappedResponse
+        class WrappedResponse < Ecoportal::API::Common::WrappedResponse
           include Enumerable
 
           attr_reader :response, :result

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

@@ -1,6 +1,10 @@
 module Ecoportal
   module API
     module Common
+      unless Ecoportal::API.const_defined?(:GEM2_VERSION)
+        msg = "Correct way to require this gem is `require 'ecoportal/api-v2`"
+        raise LoadError, msg
+      end
     end
   end
 end

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Page
         class Component
-          class Action < Common::Content::DoubleModel
+          class Action < Ecoportal::API::Common::Content::DoubleModel
             class << self
               def new_doc
                 {

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

@@ -4,7 +4,7 @@ module Ecoportal
       class Page
         class Component
           class ChartField
-            class Config < Common::Content::DoubleModel
+            class Config < Ecoportal::API::Common::Content::DoubleModel
 
               class << self
                 def new_doc

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Page
         class Component
-          class ChecklistItem < Common::Content::DoubleModel
+          class ChecklistItem < Ecoportal::API::Common::Content::DoubleModel
 
             class << self
               def new_doc

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Page
         class Component
-          class File < Common::Content::DoubleModel
+          class File < Ecoportal::API::Common::Content::DoubleModel
             class << self
               def new_doc
                 {

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Page
         class Component
-          class GaugeStop < Common::Content::DoubleModel
+          class GaugeStop < Ecoportal::API::Common::Content::DoubleModel
 
             class << self
               def new_doc

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

@@ -3,13 +3,13 @@ module Ecoportal
     class V2
       class Page
         class Component
-          class GeoCoordinates < Common::Content::DoubleModel
+          class GeoCoordinates < Ecoportal::API::Common::Content::DoubleModel
             passthrough :lat, :lon
 
             def empty?
               !lat || !lon
             end
-            
+
             def to_s
               "#{lat},#{lon}" if lat & lon
             end

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Page
         class Component
-          class Image < Common::Content::DoubleModel
+          class Image < Ecoportal::API::Common::Content::DoubleModel
             class << self
               def new_doc
                 {
@@ -12,7 +12,7 @@ module Ecoportal
                 }
               end
             end
-            
+
             passkey     :id
             passforced  :patch_ver, default: 1
             passthrough :weight

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Page
         class Component
-          class Law < Common::Content::DoubleModel
+          class Law < Ecoportal::API::Common::Content::DoubleModel
 
             class << self
               def new_doc

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Page
         class Component
-          class PeopleViewableField < Common::Content::DoubleModel
+          class PeopleViewableField < Ecoportal::API::Common::Content::DoubleModel
             passkey     :id
             passthrough :type, read_only: true
           end

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Page
         class Component
-          class SelectionOption < Common::Content::DoubleModel
+          class SelectionOption < Ecoportal::API::Common::Content::DoubleModel
             class << self
               def new_doc
                 {

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Page
         class Component
-          class SelectionOptions < Common::Content::CollectionModel
+          class SelectionOptions < Ecoportal::API::Common::Content::CollectionModel
             class_resolver :option_class, "Ecoportal::API::V2::Page::Component::SelectionOption"
 
             self.klass = :option_class

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Page
-        class Component < Common::Content::DoubleModel
+        class Component < Ecoportal::API::Common::Content::DoubleModel
           extend Ecoportal::API::Common::Content::StringDigest
 
           class_resolver :tag_field_class,        "Ecoportal::API::V2::Page::Component::TagField"

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Page
-        class Components < Common::Content::CollectionModel
+        class Components < Ecoportal::API::Common::Content::CollectionModel
           class_resolver :component_class, "Ecoportal::API::V2::Page::Component"
 
           klass do |doc|

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Page
         class Force
-          class Binding < Common::Content::DoubleModel
+          class Binding < Ecoportal::API::Common::Content::DoubleModel
             class << self
               def new_doc
                 {

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

@@ -3,11 +3,11 @@ module Ecoportal
     class V2
       class Page
         class Force
-          class Bindings < Common::Content::CollectionModel
+          class Bindings < Ecoportal::API::Common::Content::CollectionModel
             class_resolver :binding_class, "Ecoportal::API::V2::Page::Force::Binding"
 
-            self.klass    = :binding_class
-            order_matters = true
+            self.klass         = :binding_class
+            self.order_matters = true
 
             def ooze
               self._parent.ooze

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

@@ -4,7 +4,7 @@ module Ecoportal
     class V2
       class Page
         class Force
-          class Helper < Common::Content::DoubleModel
+          class Helper < Ecoportal::API::Common::Content::DoubleModel
             class << self
               def new_doc
                 {

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Page
-        class Force < Common::Content::DoubleModel
+        class Force < Ecoportal::API::Common::Content::DoubleModel
           INITIAL_WEIGHT = 9999
 
           class << self

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

@@ -2,12 +2,12 @@ module Ecoportal
   module API
     class V2
       class Page
-        class Forces < Common::Content::CollectionModel
+        class Forces < Ecoportal::API::Common::Content::CollectionModel
           class_resolver :force_class, "Ecoportal::API::V2::Page::Force"
 
-          self.klass    = :force_class
-          order_matters = true
-          self.order_key = :weight
+          self.klass         = :force_class
+          self.order_matters = true
+          self.order_key     = :weight
 
           def ooze
             self._parent.ooze

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Page
-        class MouldCounter < Common::Content::DoubleModel
+        class MouldCounter < Ecoportal::API::Common::Content::DoubleModel
           UID_REGEX    = /^(?<prefix>.*?)(?<counter>\d+)(?<postfix>.*)$/i
           STR_LEN      = 5
           BASE_NUM_STR = "0" * STR_LEN

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Page
-        class PermissionFlags < Common::Content::DoubleModel
+        class PermissionFlags < Ecoportal::API::Common::Content::DoubleModel
           class << self
             def new_doc
               {

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Page
-        class Permit < Common::Content::DoubleModel
+        class Permit < Ecoportal::API::Common::Content::DoubleModel
           class << self
             def new_doc
               {

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Page
-        class Section < Common::Content::DoubleModel
+        class Section < Ecoportal::API::Common::Content::DoubleModel
           INITIAL_WEIGHT = 9999
 
           class << self

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

@@ -2,12 +2,12 @@ module Ecoportal
   module API
     class V2
       class Page
-        class Sections < Common::Content::CollectionModel
+        class Sections < Ecoportal::API::Common::Content::CollectionModel
           class_resolver :section_class, "Ecoportal::API::V2::Page::Section"
 
           self.klass = :section_class
           self.order_key = :weight
-          
+
           def ooze
             self._parent.ooze
           end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Page
-        class Stage < Common::Content::DoubleModel
+        class Stage < Ecoportal::API::Common::Content::DoubleModel
           passkey     :id
           passforced  :patch_ver, default: 1
           passthrough :name, :ordering

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Page
-        class Stages < Common::Content::CollectionModel
+        class Stages < Ecoportal::API::Common::Content::CollectionModel
           class_resolver :stage_class, "Ecoportal::API::V2::Page::Stage"
 
           self.klass     = :stage_class

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

@@ -1,7 +1,7 @@
 module Ecoportal
   module API
     class V2
-      class Page < Common::Content::DoubleModel
+      class Page < Ecoportal::API::Common::Content::DoubleModel
         ALLOWED_KEYS = %w[
           id external_id patch_ver name template_id
           base_tags tags

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

@@ -4,7 +4,7 @@ module Ecoportal
       class Pages
         # @attr_reader page_id [String] the `id` of the new ooze.
         # @attr_reader active_stage_id [String] the active stage `id` of the new ooze.
-        class PageCreateResponse < Common::Content::DoubleModel
+        class PageCreateResponse < Ecoportal::API::Common::Content::DoubleModel
           passthrough :page_id, :active_stage_id
         end
       end

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Pages
         class PageStage
-          class Task < Common::Content::DoubleModel
+          class Task < Ecoportal::API::Common::Content::DoubleModel
             passkey     :id
             passforced  :patch_ver, default: 0
 
@@ -41,19 +41,23 @@ module Ecoportal
               type == 'review_page'
             end
 
-            def complete!
-              return mark_as_submit   if fill_in?
-              return mark_as_sign_off if review?
+            def complete!(force: false)
+              return mark_as_submit(force: force)   if fill_in?
+              return mark_as_sign_off(force: force) if review?
             end
 
             private
 
-            def mark_as_submit
-              doc['submitted'] = true
+            def mark_as_submit(force: false)
+              return doc['submitted'] = true unless force
+
+              doc['forced_complete'] = true
             end
 
-            def mark_as_sign_off
-              doc['sign_off'] = true
+            def mark_as_sign_off(force: false)
+              return doc['sign_off'] = true unless force
+
+              doc['forced_complete'] = true
             end
           end
         end

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

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Pages
         class PageStage
-          class Tasks < Common::Content::CollectionModel
+          class Tasks < Ecoportal::API::Common::Content::CollectionModel
             class_resolver :task_class, "Ecoportal::API::V2::Pages::PageStage::Task"
 
             self.klass = :task_class

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

@@ -66,13 +66,17 @@ module Ecoportal
             msg.empty?? true : msg
           end
 
-          def mark_as_submit
-            tasks.fill_in(active: true).each(&:complete!)
+          def mark_as_submit(force: false)
+            tasks.fill_in(active: true).each do |task|
+              task.complete!(force: force)
+            end
           end
           alias_method :submit!, :mark_as_submit
 
-          def mark_as_sign_off
-            tasks.review(active: true).each(&:complete!)
+          def mark_as_sign_off(force: false)
+            tasks.review(active: true).each do |task|
+              task.complete!(force: force)
+            end
           end
           alias_method :sign_off!, :mark_as_sign_off
         end

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

@@ -7,8 +7,8 @@ module Ecoportal
         #
         # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
         class Stages
-          extend Common::BaseClass
-          include Common::Content::DocHelpers
+          extend Ecoportal::API::Common::BaseClass
+          include Ecoportal::API::Common::Content::DocHelpers
 
           class_resolver :page_stage_class,  "Ecoportal::API::V2::Pages::PageStage"
 

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

@@ -1,12 +1,12 @@
 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 [Ecoportal::API::Common::Client] a `Ecoportal::API::Common::Client`
+      #   object that holds the configuration of the api connection.
       class Pages
         STAGE_REX = /stages\/(?<sid>.*)/.freeze
-        extend Common::BaseClass
-        include Common::Content::DocHelpers
+        extend Ecoportal::API::Common::BaseClass
+        include Ecoportal::API::Common::Content::DocHelpers
 
         class_resolver :stages_class, "Ecoportal::API::V2::Pages::Stages"
         class_resolver :page_class, "Ecoportal::API::V2::Page"
@@ -15,7 +15,8 @@ module Ecoportal
 
         attr_reader :client
 
-        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+        # @param client [Ecoportal::API::Common::Client] a `Ecoportal::API::Common::Client` object that holds
+        #   the configuration of the api connection.
         # @return [Schemas] an instance object ready to make schema api requests.
         def initialize(client)
           @client = client
@@ -39,7 +40,7 @@ module Ecoportal
 
           id       = get_id(id)
           response = client.get("/pages/#{CGI.escape(id)}")
-          wrapped  = Common::Content::WrappedResponse.new(response, page_class)
+          wrapped  = Ecoportal::API::Common::Content::WrappedResponse.new(response, page_class)
 
           return wrapped.result if wrapped.success?
 
@@ -77,7 +78,10 @@ module Ecoportal
         def get_new(from)
           id       = get_id(from)
           response = client.get("/pages/new", params: {template_id: id})
-          wrapped  = Common::Content::WrappedResponse.new(response, page_stage_class)
+          wrapped  = Ecoportal::API::Common::Content::WrappedResponse.new(
+            response,
+            page_stage_class
+          )
 
           return wrapped.result if wrapped.success?
           raise "Could not get new page from template #{id} - Error #{response.status}: #{response.body}"
@@ -99,9 +103,15 @@ module Ecoportal
             end
           end
           response = client.post("/pages", data: body, params: {template_id: id})
-          wrapped  = Common::Content::WrappedResponse.new(response, create_page_response_class)
+          wrapped  = Ecoportal::API::Common::Content::WrappedResponse.new(
+            response,
+            create_page_response_class
+          )
           return wrapped.result if wrapped.success?
-          raise "Could not create page from template #{id} - Error #{response.status}: #{response.body}"
+
+          msg  = "Could not create page from template #{id} "
+          msg << "- Error #{response.status}: #{response.body}"
+          raise msg
         end
 
         private

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

@@ -1,7 +1,7 @@
 module Ecoportal
   module API
     class V2
-      # @attr_reader client [Common::Client] a `Common::Client` object that
+      # @attr_reader client [Ecoportal::API::Common::Client] a `Ecoportal::API::Common::Client` object that
       #   holds the configuration of the api connection.
       class People < API::Internal::People
         def batch

data/lib/ecoportal/api/v2/registers/page_result/membrane_droplet.rb

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class Registers
         class PageResult
-          class MembraneDroplet < Common::Content::DoubleModel
+          class MembraneDroplet < Ecoportal::API::Common::Content::DoubleModel
             passkey     :ref
             passthrough :label, :type, :value
             passthrough :field_configuration_id

data/lib/ecoportal/api/v2/registers/page_result.rb

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Registers
-        class PageResult < Common::Content::DoubleModel
+        class PageResult < Ecoportal::API::Common::Content::DoubleModel
           passkey     :id
           passthrough :template_id
           passthrough :name, :state
@@ -22,4 +22,4 @@ module Ecoportal
   end
 end
 
-require_relative 'page_result/membrane_droplet'
+require 'ecoportal/api/v2/registers/page_result/membrane_droplet'

data/lib/ecoportal/api/v2/registers/register.rb

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Registers
-        class Register < Common::Content::DoubleModel
+        class Register < Ecoportal::API::Common::Content::DoubleModel
           passkey     :id
           passthrough :name
 

data/lib/ecoportal/api/v2/registers/search_results.rb

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Registers
-        class SearchResults < Common::Content::DoubleModel
+        class SearchResults < Ecoportal::API::Common::Content::DoubleModel
           passthrough :total, :total_before_filtering
           passarray   :tags, order_matters: false
           embeds_many :results, klass: "Ecoportal::API::V2::Registers::PageResult"

data/lib/ecoportal/api/v2/registers/stage_result.rb

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Registers
-        class StageResult < Common::Content::DoubleModel
+        class StageResult < Ecoportal::API::Common::Content::DoubleModel
           passkey     :id
           passthrough :name, :state, :complete, :ordering
           passarray   :tags, order_matters: false

data/lib/ecoportal/api/v2/registers/template.rb

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class V2
       class Registers
-        class Template < Common::Content::DoubleModel
+        class Template < Ecoportal::API::Common::Content::DoubleModel
           passkey     :id
           passthrough :name
         end

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

@@ -2,12 +2,12 @@ require 'base64'
 module Ecoportal
   module API
     class V2
-      # @attr_reader client [Common::Client] a `Common::Client` object that
+      # @attr_reader client [Ecoportal::API::Common::Client] a `Ecoportal::API::Common::Client` object that
       #   holds the configuration of the api connection.
       class Registers
-        extend Common::BaseClass
+        extend Ecoportal::API::Common::BaseClass
+        include Ecoportal::API::Common::Content::DocHelpers
         include Enumerable
-        include Common::Content::DocHelpers
 
         class_resolver :register_class, "Ecoportal::API::V2::Registers::Register"
         class_resolver :register_search_result_class, "Ecoportal::API::V2::Registers::PageResult"
@@ -15,7 +15,7 @@ module Ecoportal
 
         attr_reader :client
 
-        # @param client [Common::Client] a `Common::Client` object that
+        # @param client [Ecoportal::API::Common::Client] a `Ecoportal::API::Common::Client` object that
         #   holds the configuration of the api connection.
         # @return [Registers] an instance object ready to make registers api requests.
         def initialize(client)
@@ -32,7 +32,7 @@ module Ecoportal
         # @return [Enumerable<Register>] an `Enumerable` with all schemas already wrapped as `Register` objects.
         def get
           response = client.get("/templates")
-          Common::Content::WrappedResponse.new(
+          Ecoportal::API::Common::Content::WrappedResponse.new(
             response,
             register_class,
             key: "registers"

data/lib/ecoportal/api/v2/s3/files/poll.rb

@@ -3,7 +3,7 @@ module Ecoportal
     class V2
       class S3
         class Files
-          class Poll < Common::Content::DoubleModel
+          class Poll < Ecoportal::API::Common::Content::DoubleModel
             passthrough :poll_url
             embeds_one :status, nullable: true, klass: "Ecoportal::API::V2::S3::Files::PollStatus"
 

data/lib/ecoportal/api/v2/s3/files/poll_status.rb

@@ -3,8 +3,8 @@ module Ecoportal
     class V2
       class S3
         class Files
-          class PollStatus < Common::Content::DoubleModel
-            class FileContainer < Common::Content::DoubleModel
+          class PollStatus < Ecoportal::API::Common::Content::DoubleModel
+            class FileContainer < Ecoportal::API::Common::Content::DoubleModel
               passkey :id
               passthrough :file_container_id # same as :id :)
               passthrough :name, :label

data/lib/ecoportal/api/v2/s3/files.rb

@@ -1,14 +1,14 @@
 module Ecoportal
   module API
     class V2
-      # @attr_reader client [Common::Client] a `Common::Client` object that
+      # @attr_reader client [Ecoportal::API::Common::Client] a `Ecoportal::API::Common::Client` object that
       #   holds the configuration of the api connection.
       class S3
         class Files
           class FailedPollRequest < StandardError; end
           class CantCheckStatus < StandardError; end
 
-          extend Common::BaseClass
+          extend Ecoportal::API::Common::BaseClass
 
           POLL_TIMEOUT       = 240
           DELAY_STATUS_CHECK = 5
@@ -18,7 +18,8 @@ module Ecoportal
 
           attr_reader :client, :s3_api
 
-          # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+          # @param client [Ecoportal::API::Common::Client] a `Ecoportal::API::Common::Client`
+          #   object that holds the configuration of the api connection.
           # @param s3_api [V2::S3] the parent S3 api object.
           # @return [Schemas] an instance object ready to make schema api requests.
           def initialize(client, s3_api:)

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

@@ -1,19 +1,20 @@
 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 [Ecoportal::API::Common::Client] a `Ecoportal::API::Common::Client` object that holds the configuration of the api connection.
       class S3
         class MissingLocalFile < ArgumentError; end
         class CredentialsGetFailed < StandardError; end
 
-        extend Common::BaseClass
+        extend Ecoportal::API::Common::BaseClass
 
         class_resolver :data_class, "Ecoportal::API::V2::S3::Data"
         class_resolver :files_class, "Ecoportal::API::V2::S3::Files"
 
         attr_reader :client
 
-        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+        # @param client [Ecoportal::API::Common::Client] a `Ecoportal::API::Common::Client`
+        #   object that holds the configuration of the api connection.
         # @return [Schemas] an instance object ready to make schema api requests.
         def initialize(client)
           @client = client

data/lib/ecoportal/api/v2.rb

@@ -5,8 +5,13 @@ module Ecoportal
     # @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
+      unless Ecoportal::API.const_defined?(:GEM2_VERSION)
+        msg = "Correct way to require this gem is `require 'ecoportal/api-v2`"
+        raise LoadError, msg
+      end
+
+      extend Ecoportal::API::Common::BaseClass
+      include Ecoportal::API::Common::Logging
 
       VERSION = "v2".freeze
 

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = '2.0.5'.freeze
+    GEM2_VERSION = '2.0.9'.freeze
   end
 end

data/lib/ecoportal/api-v2.rb

@@ -6,5 +6,6 @@ module Ecoportal
   end
 end
 
-require_relative "api/common.v2"
-require_relative "api/v2"
+require 'ecoportal/api/v2_version'
+require 'ecoportal/api/common.v2'
+require 'ecoportal/api/v2'

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.9
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-07 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
 - !ruby/object:Gem::Dependency