ecoportal-api 0.7.4 → 0.8.4

metadata

@@ -1,137 +1,189 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.4
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-11-05 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'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: 2.2.17
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: 2.2.17
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        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: '12.0'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.9'
+        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: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.9'
+        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'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        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'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        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.0
-    - - "~>"
+        version: 3.5.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
-    - - "~>"
+        version: 3.5.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 4.4.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 4.4.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: elastic-apm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: hash-polyfill
   requirement: !ruby/object:Gem::Requirement
@@ -177,10 +229,14 @@ files:
 - lib/ecoportal/api/common/batch_response.rb
 - lib/ecoportal/api/common/client.rb
 - lib/ecoportal/api/common/doc_helpers.rb
+- lib/ecoportal/api/common/elastic_apm_integration.rb
 - lib/ecoportal/api/common/hash_diff.rb
 - lib/ecoportal/api/common/logging.rb
 - lib/ecoportal/api/common/response.rb
 - lib/ecoportal/api/common/wrapped_response.rb
+- lib/ecoportal/api/errors.rb
+- lib/ecoportal/api/errors/base.rb
+- lib/ecoportal/api/errors/time_out.rb
 - lib/ecoportal/api/internal.rb
 - lib/ecoportal/api/internal/account.rb
 - lib/ecoportal/api/internal/login_provider.rb
@@ -205,13 +261,6 @@ files:
 - lib/ecoportal/api/v1/person_schemas.rb
 - lib/ecoportal/api/v1/schema_field.rb
 - lib/ecoportal/api/v1/schema_field_value.rb
-- lib/ecoportal/api/v2.rb
-- lib/ecoportal/api/v2/field.rb
-- lib/ecoportal/api/v2/page.rb
-- lib/ecoportal/api/v2/pages.rb
-- lib/ecoportal/api/v2/register_search_result.rb
-- lib/ecoportal/api/v2/registers.rb
-- lib/ecoportal/api/v2/stage.rb
 - lib/ecoportal/api/version.rb
 homepage: https://www.ecoportal.com
 licenses:
@@ -225,7 +274,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:
   - - ">="

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

@@ -1,9 +0,0 @@
-module Ecoportal
-  module API
-    class V2
-      class Field < Common::BaseModel
-        passthrough :id, :label, :value, :type
-      end
-    end
-  end
-end

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

@@ -1,30 +0,0 @@
-module Ecoportal
-  module API
-    class V2
-      class Page < Common::BaseModel
-        passthrough :id, :name, :state
-
-        class_resolver :stage_class, "Ecoportal::API::V2::Stage"
-        class_resolver :field_class, "Ecoportal::API::V2::Field"
-
-        def stages
-          return nil unless doc["evolution"]
-          return @stages if defined?(@stages)
-          @stages = (doc["evolution"]["stages"] || []).each_with_index.map do |stage, i|
-            stage_class.new(stage, parent: self, key: ["stages", i])
-          end
-        end
-
-        def fields
-          return @fields if defined?(@fields)
-          @fields = (doc["components"] || []).each_with_index.map do |component, i|
-            field_class.new(component, parent: self, key: ["components", i])
-          end
-        end
-      end
-    end
-  end
-end
-
-require 'ecoportal/api/v2/stage'
-require 'ecoportal/api/v2/field'

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

@@ -1,46 +0,0 @@
-module Ecoportal
-  module API
-    class V2
-      # @attr_reader client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
-      class Pages
-        extend Common::BaseClass
-        include Enumerable
-        include Common::DocHelpers
-
-        attr_reader :client
-
-        class_resolver :page_class, "Ecoportal::API::V2::Page"
-
-        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
-        # @return [People] an instance object ready to make people api requests.
-        def initialize(client)
-          @client = client
-        end
-
-        def get(id, stage_id: nil)
-          if stage_id
-            response = get_with_stage_id(id, stage_id)
-            return page_class.new(response.body["data"])
-          end
-
-          response = client.get("/pages/#{id}")
-          # we get a 302 back when there's stages for the page
-          # let's follow it
-          if response.status == 302
-            stage_id = response.body["data"].match(/stages\/(.*)/)[1]
-            response = get_with_stage_id(id, stage_id)
-          end
-          page_class.new(response.body["data"])
-        end
-
-        private
-
-        def get_with_stage_id(id, stage_id)
-          client.get("/pages/#{id}/stages/#{stage_id}")
-        end
-      end
-    end
-  end
-end
-
-require 'ecoportal/api/v2/page'

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

@@ -1,20 +0,0 @@
-module Ecoportal
-  module API
-    class V2
-      class RegisterSearchResult < Common::BaseModel
-        passthrough :id, :name, :state
-
-        class_resolver :stage_class, "Ecoportal::API::V2::Stage"
-
-        def stages
-          return @stages if defined?(@stages)
-          @stages = (doc["stages"] || []).each_with_index.map do |stage, i|
-            stage_class.new(stage, parent: self, key: ["stages", i])
-          end
-        end
-      end
-    end
-  end
-end
-
-require 'ecoportal/api/v2/stage'

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

@@ -1,65 +0,0 @@
-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::DocHelpers
-
-        class_resolver :register_search_result_class, "Ecoportal::API::V2::RegisterSearchResult"
-
-        attr_reader :client
-
-        # @param client [Common::Client] a `Common::Client` object that holds the configuration of the api connection.
-        # @return [People] an instance object ready to make people api requests.
-        def initialize(client)
-          @client = client
-        end
-
-        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_search_result'

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

@@ -1,9 +0,0 @@
-module Ecoportal
-  module API
-    class V2
-      class Stage < Common::BaseModel
-        passthrough :id, :name, :state
-      end
-    end
-  end
-end

data/lib/ecoportal/api/v2.rb

@@ -1,47 +0,0 @@
-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_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
-      #   - 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 host [String] api server domain.
-      # @param logger [Logger] an object with `Logger` interface to generate logs.
-      # @return [V2] an object with the api version suit.
-      def initialize(api_key, version: VERSION, host: "live.ecoportal.com", logger: default_logger)
-        @logger = logger
-        @client = Common::Client.new(
-          api_key: api_key,
-          host:    host,
-          version: self.class::VERSION,
-          logger:  @logger
-        )
-      end
-
-      # Obtain specific object for register api requests.
-      # @return [Register] an instance object ready to make register api requests.
-      def registers
-        registers_class.new(client)
-      end
-
-      def pages
-        pages_class.new(client)
-      end
-    end
-  end
-end
-
-require 'ecoportal/api/v2/registers'
-require 'ecoportal/api/v2/pages'