ecoportal-api 0.7.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8071a9704b5accb61bd9db43b0bd6c8c6d6f88aee00ef80d16fd4b5522aedf3c
-  data.tar.gz: fc42e6ea6570565a22cb52d9941ace6bcb081b42553321d552c1d1794ec0f8f9
+  metadata.gz: ba5ffaf73f0c065f6aa6572b5ac82132af9ee19f61692f80605ee156b29d24ee
+  data.tar.gz: d82d89d09d4ae1edb88a3dc01f613478e7bd5ab38184dadb7c507e53e65bae54
 SHA512:
-  metadata.gz: 52a24b2a8f5326e92b42af2781c6a498580dfda7a16458c288b77e7ac5dea01cfa0ed619f27ea7a86d4ce27e4b004c156205a14076ac51cc06203c6abbc28820
-  data.tar.gz: 7146daf930693399e4935f0b00645768b64e0c44a7772f0c128042ab151bf29f0598e2e357e0462af77dd423561646c98cdd350e59830bd733e9c51bc120684a
+  metadata.gz: f3b637bd2bc2970b7f46eb8d92edc6b83a38ef4489d6d185e4cea47d8a5e6cd774d9bf9e8712bd0d76aa9a52c770e89207f0c7af283fcb85bc1cb481d31fca10
+  data.tar.gz: 6a5dd4dd6fd2691971c526e79d2278a84351484a0d9ffdd93e3604392f4b59e21515255001c51016835a37506496d1d292f33c4dc69d4db7042e9c3d521721c3

data/CHANGELOG.md

@@ -1,6 +1,83 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [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
+
+### Fixed
+  - `pretty_print` method was colliding with `pp` module:
+    - renamed to `Ecoportal::API::Common::BaseModel#print_pretty`
+    - renamed to `Ecoportal::API::Common::BatchReponse#print_pretty`
+    - renamed to `Ecoportal::API::Common::Reponse#print_pretty`
+    - renamed to `Ecoportal::API::Common::WrappedResponse#print_pretty`
+
+### Changed
+  - forgot to change `Ecoportal::API::VERSION` during last release
+
+## [0.7.4] - 2021-01-2
+
+### Added
+
+### Fixed
+  - changed `compact` to `compact!`:
+    - `Ecoportal::API::V1::Person#filter_tags=`
+    - `Ecoportal::API::Internal::Account#policy_group_ids=`
+    - `Ecoportal::API::Internal::Account#login_provider_ids=`
+    - `Ecoportal::API::Internal::Account#starred_ids=`
+
+### Changed
+
+## [0.7.3] - 2020-11-30
+
+### Added
+
+### Fixed
+  - `Ecoportal::API::V1::Person#email=`: was not showing the incorrect value in the error message
+  - added `compact` to remove `null` values on:
+    - `Ecoportal::API::V1::Person#filter_tags=`
+    - `Ecoportal::API::Internal::Account#policy_group_ids=`
+    - `Ecoportal::API::Internal::Account#login_provider_ids=`
+    - `Ecoportal::API::Internal::Account#starred_ids=`
+
+### Changed
+
+
+## [0.7.2] - 2020-10-19
+
+### Added
+  - `Ecoportal::API::V1::Person#email=`:
+    - do a minimum validation (no blanks in the email)
+    - set in lower case (as this is how it's in the server)
+### Fixed
+  - `Ecoportal::API::V1::People#each`: when `silent` it shouldn't print a blank line
+  - fixed so they return empty array `[]` when `nil`:
+    - `Ecoportal::API::V1::Person#filter_tags`
+    - `Ecoportal::API::Internal::Account#policy_group_ids`
+    - `Ecoportal::API::Internal::Account#login_provider_ids`
+    - `Ecoportal::API::Internal::Account#starred_ids`
+### Changed
+  - made it so some methods the `Array` with `uniq` values:
+    - `Ecoportal::API::V1::Person#filter_tags=`
+    - `Ecoportal::API::Internal::Account#policy_group_ids=`
+  - made it so it only updates the keys defined in the `Hash` passed to the setter:
+    - `Ecoportal::API::Internal::Account#permissions_custom=`
+    - `Ecoportal::API::Internal::Account#preferences=`
+
+
 ## [0.7.1] - 2020-09-30
 
 ### Added
@@ -12,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',          '~> 3'
+  spec.add_dependency 'http',          '~> 4.4.1', "< 5"
   spec.add_dependency 'hash-polyfill', '~> 0'
 end

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

@@ -108,7 +108,7 @@ module Ecoportal
           end
         end
 
-        def pretty_print
+        def print_pretty
           puts JSON.pretty_generate(as_json)
           self
         end

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/common/batch_response.rb

@@ -21,9 +21,9 @@ module Ecoportal
           end
         end
 
-        def pretty_print
+        def print_pretty
           if success?
-            each(&:pretty_print)
+            each(&:print_pretty)
           else
             puts "Request failed."
           end

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

@@ -119,11 +119,18 @@ module Ecoportal
           Ecoportal::API::Common::Response.new(response)
         end
 
-        # Creates a HTTP object adding the `X-ApiKey` param to the header.
+        # Creates a HTTP object adding the `X-ApiKey` or `X-ECOPORTAL-API-KEY` param to the header, depending on the API version.
         # @note It configures HTTP so it only allows body data in json format.
         # @return [HTTP] HTTP object.
         def base_request
-          @base_request ||= HTTP.headers("X-ApiKey" => @api_key).accept(:json)
+          @base_request ||= begin
+            case @version
+            when "v2"
+              HTTP.headers("X-ECOPORTAL-API-KEY" => @api_key).accept(:json)
+            else
+              HTTP.headers("X-ApiKey" => @api_key).accept(:json)
+            end
+          end
         end
 
         # Full URl builder of the request

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

@@ -20,7 +20,7 @@ module Ecoportal
           @status.success?
         end
 
-        def pretty_print
+        def print_pretty
           puts "Status: #{@status.code}"
           puts "Body:"
           puts JSON.pretty_generate(@body)

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

@@ -40,9 +40,9 @@ module Ecoportal
           response.success?
         end
 
-        def pretty_print
+        def print_pretty
           if success?
-            each(&:pretty_print)
+            each(&:print_pretty)
           else
             puts "Request failed."
           end

data/lib/ecoportal/api/internal/account.rb

@@ -13,14 +13,49 @@ module Ecoportal
         embeds_one  :preferences, klass: :preferences_class
 
         # Sets the `policy_group_ids`
+        # @note it preserves the original order
+        # @param value [Array<String>] the policy group ids to be set.
         def policy_group_ids=(value)
           unless value.is_a?(Array)
             raise "policy_group_ids= needs to be passed an Array, got #{value.class}"
           end
 
+          value.uniq!
           ini_ids = (original_doc && original_doc["policy_group_ids"]) || []
           # preserve original order to avoid false updates
           doc["policy_group_ids"] = (ini_ids & value) + (value - ini_ids)
+          doc["policy_group_ids"].compact
+        end
+
+        # @return [Array<String>] the policy group ids of this user.
+        def policy_group_ids
+          doc["policy_group_ids"] ||= []
+        end
+
+        # Sets the `login_provider_ids`
+        def login_provider_ids=(value)
+          unless value.is_a?(Array)
+            raise "login_provider_ids= needs to be passed an Array, got #{value.class}"
+          end
+          doc["login_provider_ids"] = value.compact
+        end
+
+        # @return [Array<String>] the login provider ids of this user.
+        def login_provider_ids
+          doc["login_provider_ids"] ||= []
+        end
+
+        # Sets the `starred_ids`
+        def starred_ids=(value)
+          unless value.is_a?(Array)
+            raise "starred_ids= needs to be passed an Array, got #{value.class}"
+          end
+          doc["starred_ids"] = value.compact
+        end
+
+        # @return [Array<String>] the starred page ids of this user.
+        def starred_ids
+          doc["starred_ids"] ||= []
         end
 
         # Sets the `permissions_preset`.
@@ -37,6 +72,20 @@ module Ecoportal
           self.permissions_preset.nil? ? "custom" : self.permissions_preset
         end
 
+        # It preserves the values of keys that are not defined in `value`.
+        # @param value [Hash] the abilities that you want to update.
+        def permissions_custom=(value)
+          doc["permissions_custom"] ||= {}
+          doc["permissions_custom"].merge!(value)
+        end
+
+        # It preserves the values of keys that are not defined in `value`.
+        # @param value [Hash] the preferences that you want to update.
+        def preferences=(value)
+          doc["preferences"] ||= {}
+          doc["preferences"].merge!(value)
+        end
+
         def as_json
           super.tap do |hash|
             if preset == "custom"

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

@@ -33,14 +33,15 @@ module Ecoportal
         def each(params: {}, silent: false, &block)
           return to_enum(:each, params: params, silent: silent) unless block
           cursor_id = nil; results = 0
-          puts "\n"
+          puts "\n" unless silent
           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

@@ -15,6 +15,7 @@ module Ecoportal
         embeds_one :details, nullable: true, klass: :person_details_class
 
         VALID_TAG_REGEX = /^[A-Za-z0-9 &_'\/-]+$/
+        VALID_EMAIL_REGEX = /^[^@\s]+@[^@\s]+\.[^@\s]+$/
 
         # Gets the supervisor (`Person`) of this person, with given his `supervisor_id`.
         #
@@ -41,24 +42,39 @@ module Ecoportal
           self.supervisor_id = person&.id || person&.external_id
         end
 
+        # Sets the email of a person.
+        # @param value [String, nil] the email of this person.
+        def email=(value)
+          unless !value || value.match(VALID_EMAIL_REGEX)
+            raise "Invalid email #{value.inspect}"
+          end
+          doc["email"] = value&.downcase
+        end
+
         # Validates the string tags of the array, and sets the `filter_tags` property of the account.
-        # @note all is set in upper case.
+        # @note all is set in upper case and preserves the original order.
         # @raise [Exception] if there was any invalid string tag.
         # @param value [Array<String>] array of tags.
         def filter_tags=(value)
           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
             tag.upcase
-          end
+          end.uniq
 
           ini_tags = (original_doc && original_doc["filter_tags"]) || []
           # preserve original order to avoid false updates
           doc["filter_tags"] = (ini_tags & end_tags) + (end_tags - ini_tags)
+          doc["filter_tags"].compact
+        end
+
+        # @return [Array<String>] the filter tags of this person.
+        def filter_tags
+          doc["filter_tags"] ||= []
         end
 
         def as_json

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.7.1"
+    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.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-30 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: '3'
+        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: '3'
+        version: 4.4.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: hash-polyfill
   requirement: !ruby/object:Gem::Requirement
@@ -218,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:
   - - ">="