ecoportal-api-v2 0.8.4

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

@@ -0,0 +1,89 @@
+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::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 [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
+          response = client.get("/templates")
+          Common::Content::WrappedResponse.new(response, register_class, key: "registers")
+        end
+
+        # 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/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

@@ -0,0 +1,7 @@
+module Ecoportal
+  module API
+    class V2
+      GEM_VERSION = "0.8.4"
+    end
+  end
+end

metadata

@@ -0,0 +1,254 @@
+--- !ruby/object:Gem::Specification
+name: ecoportal-api-v2
+version: !ruby/object:Gem::Version
+  version: 0.8.4
+platform: ruby
+authors:
+- Oscar Segura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.11
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.11
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+    - - "<"
+      - !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.26
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !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
+  name: ecoportal-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- rien@ecoportal.co.nz
+- oscar@ecoportal.co.nz
+- bozydar@ecoportal.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ecoportal-api-v2.gemspec
+- lib/ecoportal/api-v2.rb
+- lib/ecoportal/api/common.rb
+- lib/ecoportal/api/common/content.rb
+- lib/ecoportal/api/common/content/array_model.rb
+- lib/ecoportal/api/common/content/class_helpers.rb
+- lib/ecoportal/api/common/content/client.rb
+- lib/ecoportal/api/common/content/collection_model.rb
+- lib/ecoportal/api/common/content/doc_helpers.rb
+- lib/ecoportal/api/common/content/double_model.rb
+- lib/ecoportal/api/common/content/hash_diff_patch.rb
+- lib/ecoportal/api/common/content/string_digest.rb
+- lib/ecoportal/api/common/content/wrapped_response.rb
+- lib/ecoportal/api/v2.rb
+- lib/ecoportal/api/v2/page.rb
+- 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
+- lib/ecoportal/api/v2/page/component/law_field.rb
+- lib/ecoportal/api/v2/page/component/number_field.rb
+- lib/ecoportal/api/v2/page/component/people_field.rb
+- lib/ecoportal/api/v2/page/component/plain_text_field.rb
+- lib/ecoportal/api/v2/page/component/reference_field.rb
+- lib/ecoportal/api/v2/page/component/rich_text_field.rb
+- lib/ecoportal/api/v2/page/component/selection_field.rb
+- lib/ecoportal/api/v2/page/component/selection_option.rb
+- lib/ecoportal/api/v2/page/component/signature_field.rb
+- lib/ecoportal/api/v2/page/component/tag_field.rb
+- lib/ecoportal/api/v2/page/components.rb
+- lib/ecoportal/api/v2/page/section.rb
+- lib/ecoportal/api/v2/page/sections.rb
+- lib/ecoportal/api/v2/page/stage.rb
+- lib/ecoportal/api/v2/page/stages.rb
+- 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/people.rb
+- lib/ecoportal/api/v2/registers.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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A collection of helpers for interacting with the ecoPortal MS's V2 API
+test_files: []