ecoportal-api 0.7.5 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a3b6466476eefca80c4c105572ff4fc9789861951dfbc6c0390277a33c35a27
-  data.tar.gz: bee1361739b8a7bb6336aa4198a078a76f67479818d82a6bd1b1d3fd0ea77867
+  metadata.gz: ba5ffaf73f0c065f6aa6572b5ac82132af9ee19f61692f80605ee156b29d24ee
+  data.tar.gz: d82d89d09d4ae1edb88a3dc01f613478e7bd5ab38184dadb7c507e53e65bae54
 SHA512:
-  metadata.gz: e32a1b38746232a63d2939267345fc5d3ceb3a02d6a297bffdc2ccd7df82ea27fe1748e0836905eed8848fabfe25694e6332402d012537c529b224a0bad17367
-  data.tar.gz: 5c9d4e78ff2b63dc6a1ff31518976c88fdd955e3c36621a194e767bc0686ca6b2a16e11f3cc23a29a7a0e252050686170124d9761cbce5000ba97a4aca00c014
+  metadata.gz: f3b637bd2bc2970b7f46eb8d92edc6b83a38ef4489d6d185e4cea47d8a5e6cd774d9bf9e8712bd0d76aa9a52c770e89207f0c7af283fcb85bc1cb481d31fca10
+  data.tar.gz: 6a5dd4dd6fd2691971c526e79d2278a84351484a0d9ffdd93e3604392f4b59e21515255001c51016835a37506496d1d292f33c4dc69d4db7042e9c3d521721c3

data/CHANGELOG.md

@@ -1,7 +1,20 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.7.5] - 2021-02-xx
+## [0.8.2] - 2021-02-xx
+
+### Added
+
+### Fixed
+  - `Ecoportal::API::V1::Person#filter_tags=` should ignore `nil` values
+
+### Changed
+  - removed all the namespace under `Ecoportal::API::V2` as that is managed by `ecoportal-api-oozes` gem
+    - url: https://rubygems.org/gems/ecoportal-api-oozes
+  - `Ecoportal::API::V1::People.get` should return a `Person` object
+    - observe that it was returning the `WrappedResponse` (an `Enumerable` helper that works better when getting multiple people).
+
+## [0.7.5] - 2021-02-12
 
 ### Added
 
@@ -76,6 +89,10 @@ All notable changes to this project will be documented in this file.
 ## [0.7.0] - 2020-09-11
 
 ### Added
+  - added hook, **private** method `body_data` for child classes to define behaviour on `response.body` to
+    - `Ecoportal::API::V1::People`
+    - `Ecoportal::API::Common::BatchOperation`
+
 ### Changed
   - `Ecoportal::API::Internal::Permissions`: **update for new abilities of ecoPortal release `1.5.2`**
     - decoupled abilities: `person_core` into `person_core_create`, `person_core_edit`

data/ecoportal-api.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://www.ecoportal.com"
   spec.licenses      = %w[MIT]
 
+  spec.required_ruby_version = '>= 2.4.4'
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -20,13 +22,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",   "~> 2.1", ">= 2.1.3"
-  spec.add_development_dependency "rake",      "~> 12.0"
-  spec.add_development_dependency "rspec",     "~> 3",   ">= 3.9"
-  spec.add_development_dependency "yard",      "~> 0.9", ">= 0.9.18"
-  spec.add_development_dependency "redcarpet", "~> 3.5", ">= 3.5.0"
-  spec.add_development_dependency "pry"      , "~> 0.13"
+  spec.add_development_dependency "bundler",   ">= 2.2.11",  "< 2.3"
+  spec.add_development_dependency "rspec",     ">= 3.10.0", "< 3.11"
+  spec.add_development_dependency "rake",      ">= 13.0.3", "< 13.1"
+  spec.add_development_dependency "yard",      ">= 0.9.26", "< 0.10"
+  spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
+  spec.add_development_dependency "pry"      , "~> 0.14"
 
-  spec.add_dependency 'http',          '~> 4'
+  spec.add_dependency 'http',          '~> 4.4.1', "< 5"
   spec.add_dependency 'hash-polyfill', '~> 0'
 end

data/lib/ecoportal/api.rb

@@ -11,5 +11,4 @@ end
 require "ecoportal/api/logger"
 require "ecoportal/api/common"
 require "ecoportal/api/v1"
-require "ecoportal/api/v2"
 require "ecoportal/api/internal"

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

@@ -27,7 +27,7 @@ module Ecoportal
 
           log(:info) { "Processing batch responses" }
 
-          response.body.each.with_index do |subresponse, idx|
+          body_data(response.body).each.with_index do |subresponse, idx|
             callback = @operations[idx][:callback]
             status   = subresponse["status"]
             body     = subresponse["response"]
@@ -97,6 +97,12 @@ module Ecoportal
 
         private
 
+        # Hook for other api versions to obtain the raw data of a response
+        # @note this was introduced to allow `v2` to reuse this class
+        def body_data(body)
+          body
+        end
+
         def log_batch_response(operation, response)
           level = response.success?? :debug : :warn
           log(:info) { "BATCH #{operation[:method]} #{operation[:path]}" }

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

@@ -37,10 +37,11 @@ module Ecoportal
           loop do
             params.update(cursor_id: cursor_id) if cursor_id
             response = client.get("/people", params: params)
-            raise "Request failed - Status #{response.status}: #{response.body}" unless response.success?
+            body     = body_data(response.body)
+            raise "Request failed - Status #{response.status}: #{body}" unless response.success?
 
-            unless silent || (total = response.body["total_results"]) == 0
-              results += response.body["results"].length
+            unless silent || (total = body["total_results"]) == 0
+              results += body["results"].length
               percent  = results * 100 / total
               msg      = "People GET"
               msg     += " (search=#{params[:q]})" if params.key?(:q)
@@ -48,10 +49,10 @@ module Ecoportal
               $stdout.flush
             end
 
-            response.body["results"].each do |person|
+            body["results"].each do |person|
               yield person_class.new(person)
             end
-            break unless (cursor_id = response.body["cursor_id"])
+            break unless (cursor_id = body["cursor_id"])
           end
           self
         end
@@ -70,10 +71,13 @@ module Ecoportal
         # Gets a person via api.
         # @note if the request has `success?` the returned `object.result` gives an object with that `Person`.
         # @param doc [String, Hash, Person] data containing an `id` (internal or external) of the target person.
-        # @return [WrappedResponse] an object with the api response.
+        # @return [Person] the person with `id` (internal or external) contained in `doc`.
         def get(doc)
-          response = client.get("/people/"+CGI.escape(get_id(doc)))
-          Common::WrappedResponse.new(response, person_class)
+          id       = get_id(doc)
+          response = client.get("/people/"+CGI.escape(id))
+          body     = body_data(response.body)
+          return person_class.new(body) if response.success?
+          raise "Could not get person #{id} - Error #{reponse.status}: #{body}"
         end
 
         # Requests an update of a person via api.
@@ -107,7 +111,7 @@ module Ecoportal
         # @return [Response] an object with the api response.
         def delete(doc)
           id = get_id(doc)
-            client.delete("/people/"+CGI.escape(id))
+          client.delete("/people/"+CGI.escape(id))
         end
 
         # Creates a `BatchOperation` and yields it to the given bock.
@@ -150,13 +154,13 @@ module Ecoportal
         JobStatus = Struct.new(:id, :complete?, :errored?, :progress)
         def job_status(job_id)
           response = client.get("/people/job/#{CGI.escape(job_id)}/status")
-
+          body     = body_data(response.body)
           raise "Status error" unless response.success?
           JobStatus.new(
-            response.body["id"],
-            response.body["complete"],
-            response.body["errored"],
-            response.body["progress"]
+            body["id"],
+            body["complete"],
+            body["errored"],
+            body["progress"]
           )
         end
 
@@ -186,11 +190,18 @@ module Ecoportal
           job_id = nil
           client.without_response_logging do
             client.post("/people/job", data: operation.as_json).tap do |response|
-              job_id = response.body["id"]
+              job_id = body_data(response.body)["id"]
             end
           end
           job_id
         end
+
+        # Hook for other api versions to obtain the raw data of a response
+        # @note this was introduced to allow `v2` to reuse this class
+        def body_data(body)
+          body
+        end
+
       end
     end
   end

data/lib/ecoportal/api/v1/person.rb

@@ -59,7 +59,7 @@ module Ecoportal
           unless value.is_a?(Array)
             raise "filter_tags= needs to be passed an Array, got #{value.class}"
           end
-          end_tags = value.map do |tag|
+          end_tags = value.compact.map do |tag|
             unless tag.match(VALID_TAG_REGEX)
               raise "Invalid filter tag #{tag.inspect}"
             end

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.7.5"
+    VERSION = "0.8.2"
   end
 end

metadata

@@ -1,137 +1,149 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.2
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2021-02-23 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.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.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.3
+        version: 2.2.11
+    - - "<"
+      - !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: 3.10.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 3.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        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: hash-polyfill
   requirement: !ruby/object:Gem::Requirement
@@ -205,13 +217,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 +230,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.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'

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