ecoportal-api-oozes 0.7.0 → 0.7.5

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

@@ -3,7 +3,12 @@ module Ecoportal
     class V2
       class Pages
         class PageStage < V2::Page
-          
+          passthrough :mould_counter, :archive
+          passthrough :task_priority, :state
+          passthrough :votes_enabled, :upvotes, :downvotes
+
+          passarray   :force_errors, :subtags, :permits, order_matters: false
+          passthrough :evolution
         end
       end
     end

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

@@ -22,7 +22,8 @@ module Ecoportal
 
           # Gets a stage via api.
           # @note if the request has `success?` the returned `object.result` gives an object with that `Stage`.
-          # @param doc [String, Hash, Stage] data containing an `id` of the target page.
+          # @param pid [String, Hash, Stage] the `id` of the target **page**.
+          # @param sid [String] the `id` of the target **stage**.
           # @return [Ecoportal::API::V2::Stage, Ecoportal::API::V2::Pages::PageStage] the target stage.
           def get(pid:, sid:)
             pid      = get_id(pid)
@@ -35,6 +36,8 @@ module Ecoportal
 
           # Requests to update an existing stage via api.
           # @param doc [Hash, Stage] data that at least contains an `id` (internal or external) of the target stage.
+          # @param pid [String, nil] the `id` of the target **page**.
+          # @param sid [String] the `id` of the target **stage**.
           # @return [Response] an object with the api response.
           def update(doc, pid: nil, sid:)
             body = get_body(doc)

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

@@ -0,0 +1,31 @@
+module Ecoportal
+  module API
+    class V2
+      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
+      class People < Internal::People
+
+        def batch
+          unavailable_method!(__method__)
+        end
+
+        def job
+          unavailable_method!(__method__)
+        end
+
+        private
+
+        # Re-using hook to obtain the raw data response
+        def body_data(body)
+          return body unless body.is_a?(Hash)
+          return body unless body.key?("data")
+          body["data"]
+        end
+
+        def unavailable_method!(str)
+          raise "Unavailable method '#{str}' for api '#{VERSION}'"
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,20 +1,28 @@
 module Ecoportal
   module API
     class V2
+      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
       class Registers
         extend Common::BaseClass
         include Enumerable
+        include Common::Content::DocHelpers
 
-        class_resolver :register_class,  "Ecoportal::API::V2::Register"
+        class_resolver :register_class,  "Ecoportal::API::V2::Registers::Register"
+        class_resolver :register_search_result_class, "Ecoportal::API::V2::Registers::PageResult"
 
         attr_reader :client
 
         # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
-        # @return [Schemas] an instance object ready to make schema api requests.
+        # @return [Registers] an instance object ready to make registers api requests.
         def initialize(client)
           @client = client
         end
 
+        def each(params: {}, &block)
+          return to_enum(:each) unless block
+          get.each(&block)
+        end
+
         # Gets all the registers via api request.
         # @return [Enumerable<Register>] an `Enumerable` with all schemas already wrapped as `Register` objects.
         def get
@@ -22,14 +30,60 @@ module Ecoportal
           Common::Content::WrappedResponse.new(response, register_class, key: "registers")
         end
 
-        def each(params: {}, &block)
-          return to_enum(:each) unless block
-          get.each(&block)
+        # Gets all the oozes/pages of `register_id` matching the `options`
+        # @param register_id [String] the `id` of the target register to search on.
+        # @param options [Hash] the search options
+        # @option options [Hash<Symbol, String>] :query plain search (like the search box in register).
+        # @option options [Hash<Symbol, Array<Object>>] :filters the set of filters.
+        def search(register_id, options = {})
+          # supply a query string
+          # or a filter array (copy/paste from dev tools in the browser)
+          options = {query: nil, filters: []}.update(options)
+          options = {}.tap do |ret|
+            options.each do |key, value|
+              if key == :filters && value.any?
+                ret[key] = {filters: value}.to_json
+              else
+                ret[key] = value if key
+              end
+            end
+          end
+
+          cursor_id = nil
+          results = 0
+          loop do
+            options.update(cursor_id: cursor_id) if cursor_id
+            response = client.get("/registers/#{register_id}/search", params: options)
+            raise "Request failed - Status #{response.status}: #{response.body}" unless response.success?
+
+            data = response.body["data"]
+            unless (total = data["total"]) == 0
+              results += data["results"].length
+              percent  = results * 100 / total
+              msg      = "Registers SEARCH"
+              print "#{msg}: #{percent.round}% (of #{total})\r"
+              $stdout.flush
+            end
+
+            data["results"].each do |result|
+              object = register_search_result_class.new(result)
+              yield object
+            end
+
+            # break unless (cursor_id = data["cursor_id"])
+            break if total == results
+          end
+          self
         end
 
+
       end
     end
   end
 end
 
-require 'ecoportal/api/v2/register'
+require 'ecoportal/api/v2/registers/template'
+require 'ecoportal/api/v2/registers/register'
+require 'ecoportal/api/v2/registers/stage_result'
+require 'ecoportal/api/v2/registers/stages_result'
+require 'ecoportal/api/v2/registers/page_result'

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

@@ -0,0 +1,21 @@
+module Ecoportal
+  module API
+    class V2
+      class Registers
+        class PageResult < Common::Content::DoubleModel
+          passkey     :id
+          passthrough :template_id
+          passthrough :name, :state
+          passdate    :updated_at, :created_at
+          passthrough :archive
+          passarray   :tags, order_matters: false
+          passthrough :mould_counter
+
+          class_resolver :stages_class, "Ecoportal::API::V2::Registers::StagesResult"
+          embeds_many    :stages, enum_class: :stages_class
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Ecoportal
+  module API
+    class V2
+      class Registers
+        class Register < Common::Content::DoubleModel
+          passkey     :id
+          passthrough :name
+
+          class_resolver :template_class, "Ecoportal::API::V2::Registers::Template"
+
+          def templates_by_id
+            @templates_by_id or index_templates
+            @templates_by_id
+          end
+
+          def [](id)
+            templates_by_id[id]
+          end
+
+          def templates
+            templates_by_id.values
+          end
+
+          def index_templates
+            @templates_by_id   = {}
+            doc["templates"].each do |template_doc|
+              template = template_class.new(template_doc)
+              @templates_by_id[template.id] = template
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class V2
+      class Registers
+        class StageResult < Common::Content::DoubleModel
+          passkey     :id
+          passthrough :name, :state, :complete, :ordering
+          passarray   :tags, order_matters: false
+          passarray   :permits
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class V2
+      class Registers
+        class StagesResult < V2::Page::Stages
+          class_resolver :stage_class, "Ecoportal::API::V2::Registers::StageResult"
+
+          self.klass = :stage_class
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -1,7 +1,7 @@
 module Ecoportal
   module API
     class V2
-      GEM_VERSION = "0.7.0"
+      GEM_VERSION = "0.7.5"
     end
   end
 end

metadata

@@ -1,77 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-oozes
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.5
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2021-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: 2.1.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '3.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.18
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.18
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -79,9 +97,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -89,9 +107,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -112,20 +130,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
-    - - "~>"
+        version: 0.7.4
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
-    - - "~>"
+        version: 0.7.4
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 description: 
 email:
 - rien@ecoportal.co.nz
@@ -165,12 +183,22 @@ files:
 - lib/ecoportal/api/v2/page/component.rb
 - lib/ecoportal/api/v2/page/component/action.rb
 - lib/ecoportal/api/v2/page/component/action_field.rb
+- lib/ecoportal/api/v2/page/component/chart_field.rb
+- lib/ecoportal/api/v2/page/component/chart_field/frequency.rb
+- lib/ecoportal/api/v2/page/component/chart_field/heatmap.rb
+- lib/ecoportal/api/v2/page/component/chart_field/indicator.rb
+- lib/ecoportal/api/v2/page/component/chart_field/multiseries.rb
+- lib/ecoportal/api/v2/page/component/chart_field/sankey.rb
+- lib/ecoportal/api/v2/page/component/chart_field/serie.rb
+- lib/ecoportal/api/v2/page/component/chart_field/series_config.rb
+- lib/ecoportal/api/v2/page/component/chart_fr_field.rb
 - lib/ecoportal/api/v2/page/component/checklist_field.rb
 - lib/ecoportal/api/v2/page/component/checklist_item.rb
 - lib/ecoportal/api/v2/page/component/date_field.rb
 - lib/ecoportal/api/v2/page/component/file.rb
 - lib/ecoportal/api/v2/page/component/files_field.rb
 - lib/ecoportal/api/v2/page/component/gauge_field.rb
+- lib/ecoportal/api/v2/page/component/gauge_stop.rb
 - lib/ecoportal/api/v2/page/component/geo_field.rb
 - lib/ecoportal/api/v2/page/component/image.rb
 - lib/ecoportal/api/v2/page/component/images_field.rb
@@ -192,15 +220,21 @@ files:
 - lib/ecoportal/api/v2/pages.rb
 - lib/ecoportal/api/v2/pages/page_stage.rb
 - lib/ecoportal/api/v2/pages/stages.rb
-- lib/ecoportal/api/v2/register.rb
+- lib/ecoportal/api/v2/people.rb
 - lib/ecoportal/api/v2/registers.rb
-- lib/ecoportal/api/v2/template.rb
+- lib/ecoportal/api/v2/registers/page_result.rb
+- lib/ecoportal/api/v2/registers/register.rb
+- lib/ecoportal/api/v2/registers/stage_result.rb
+- lib/ecoportal/api/v2/registers/stages_result.rb
+- lib/ecoportal/api/v2/registers/template.rb
 - lib/ecoportal/api/v2/version.rb
 homepage: https://www.ecoportal.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "\n    The 'ecoportal-api-oozes' gem has been deprecated and
+  has been replaced by 'ecoportal-api-v2'.\n    See: https://rubygems.org/gems/ecoportal-api-v2\n
+  \ "
 rdoc_options: []
 require_paths:
 - lib
@@ -208,7 +242,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="