ecoportal-api 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc651f2474f74b8f767c9df5b4611bd8adefdff75f8e25365135c89561229738
-  data.tar.gz: cb7a8ff5c0c03ba7e371f987d6b277c001b33e57716ab6cf03628d28bac53b61
+  metadata.gz: 4364abf59cd6460788d315eb5012df5e8ad254a208e8af7314a766463eb35ed0
+  data.tar.gz: d71fe7e38402e827aea0f95c6a0c379e191e525d597ab8b225990f48c6879764
 SHA512:
-  metadata.gz: f89285565edeaa9cbe4a98970bae8602a943c7c865121a89782f512353a8be74529578eecb4f48e893f546f172425dd38af0759412f53b8fc3a91989d6dbe52a
-  data.tar.gz: 4f51e3e6d080745261c033acf511fdd341ebf9f97003f4dda5067c49c9ef51adf966c51cf268e4991e741b45c803fc6c1e821051832c090ba2c685f03c4eaa7d
+  metadata.gz: e055587b4aafbfabf25996cf4e67d85b0a0d9be936d4b0bdae194b431e4f2bb12b09fc99562d594cf355767aae3081a1fbea70d10a48dc204ce839284bbf0256
+  data.tar.gz: 5cd7284e455af271f1642775844636fd0ea11b590c0036d3b4a43868a9ffd6ece97ceebb9a3d6dfcdae7891dd65dedd0df9dac5944578cb18484b07342640c3e

data/CHANGELOG.md

@@ -1,7 +1,24 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.8.4] - 2021-10-xx
+## [0.8.5] - 2022-02-28
+
+### Added
+  - `Ecoportal::API::V1::PersonDetails#[]` to raise a specific error type to allow handling
+  - `Ecoportal::API::V1::PersonDetails.key?` to allow to check if a field exists
+  - `Ecoportal::API::Internal::Account#force_send_invites` support for back-end new method
+
+### Fixed
+  - `Ecoportal::API::V1::People#get` fixed typo
+  - `Ecoportal::API::Common::BaseModel` `#original_doc` and `#initial_doc` maybe empty for the parent object
+
+### Changed
+  - `Ecoportal::API::V1::People#each` limited the `GET` retries to `5`
+  - `Ecoportal::API::Internal::Account#default_tag=`
+    - Controls input type to be `String` or `nil`
+    - Inherent `upcase`
+
+## [0.8.4] - 2021-11-05
 
 ### Added
   - `Ecoportal::API::Internal::Permissions` added abilities

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

@@ -68,13 +68,13 @@ module Ecoportal
         def original_doc
           raise UnlinkedModel.new(from: "#{self.class}#original_doc", key: _key)  unless linked?
           return @original_doc if is_root?
-          _parent.original_doc.dig(*[_key].flatten)
+          _parent.original_doc&.dig(*[_key].flatten)
         end
 
         def initial_doc
           raise UnlinkedModel.new(from: "#{self.class}#initial_doc", key: _key)  unless linked?
           return @initial_doc if is_root?
-          _parent.initial_doc.dig(*[_key].flatten)
+          _parent.initial_doc&.dig(*[_key].flatten)
         end
 
         def as_json

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

@@ -6,7 +6,7 @@ module Ecoportal
           "user_id", "policy_group_ids", "default_tag", "prefilter",
           "permissions_custom", "permissions_merged", "preferences",
           "login_provider_ids", "starred_ids", "landing_page_id",
-          "accept_eula", "send_invites"
+          "accept_eula", "send_invites", "force_send_invites"
         ]
         passthrough *PROPERTIES.map(&:to_sym)
 
@@ -17,6 +17,23 @@ module Ecoportal
         embeds_one  :perms_merged, key: "permissions_merged", klass: :permissions_class
         embeds_one  :preferences, klass: :preferences_class
 
+        # Sets the `default_tag` of the user
+        # @note it upcases the value
+        # @param value [String, nil] the tag
+        # @return [String, nil] the value set in `default_tag`
+        def default_tag=(value)
+          unless !value || value.is_a?(String)
+            raise ArgumentError.new("default_tag= needs to be passed a String or nil, got #{value.class}")
+          end
+          if value
+            unless value.match(Ecoportal::API::V1::Person::VALID_TAG_REGEX)
+              raise ArgumentError.new("Invalid default tag #{value.inspect}")
+            end
+            value = value.upcase
+          end
+          doc["default_tag"] = value
+        end
+
         # Sets the `policy_group_ids`
         # @note it preserves the original order
         # @param value [Array<String>] the policy group ids to be set.

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

@@ -36,16 +36,16 @@ module Ecoportal
           puts "\n" unless silent
           loop do
             params.update(cursor_id: cursor_id) if cursor_id
-            body = nil; response = nil
+            body = nil; response = nil; count = 5
             loop do
               response = client.get("/people", params: params)
               body     = response && body_data(response.body)
-              break if response.success?
+              break if response.success? || count <= 0
               puts "Request failed - Status #{response.status}: #{body}"
+              count -= 1
+              sleep(0.5)
             end
-            response = client.get("/people", params: params)
-            #body     = response && body_data(response.body)
-            #raise "Request failed - Status #{response.status}: #{body}" unless response.success?
+            raise "Request failed - Status #{response.status}: #{body}" unless response.success?
 
             unless silent || (total = body["total_results"]) == 0
               results += body["results"].length
@@ -84,7 +84,7 @@ module Ecoportal
           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}"
+          raise "Could not get person #{id} - Error #{response.status}: #{body}"
         end
 
         # Requests an update of a person via api.

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

@@ -2,6 +2,9 @@ module Ecoportal
   module API
     class V1
       class PersonDetails < Common::BaseModel
+        class MissingId < StandardError
+        end
+
         passthrough :schema_id
 
         class_resolver :schema_field_value_class, "Ecoportal::API::V1::SchemaFieldValue"
@@ -43,16 +46,24 @@ module Ecoportal
         end
 
         # Sets the value to one specific field of the PersonDetails.
+        # @raise MisssingId if the `id` or `alt_id` is missing.
         # @param id [String] the `id` or the `alt_id` of the target field.
         # @return [void]
         def []=(id, value)
           if field = get_field(id)
             field.value = value
           else
-            raise "details[#{id.inspect}] is missing. Did you forget to load the schema?"
+            raise MissingId.new("details[#{id.inspect}] is missing. Did you forget to load the schema?")
           end
         end
 
+        # Checks if an `id` or `alt_id` exists
+        # @param id [String] the `id` or the `alt_id` of the target field.
+        # @return [Boolean] `true` if it exists, `false` otherwise
+        def key?(id)
+          @fields_by_id.key?(id) || @fields_by_alt_id.key?(id)
+        end
+
         protected
 
         # Rebuilds the internal `id` and `alt_id` references to the fields.

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.8.4"
+    VERSION = "0.8.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2022-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -281,7 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: A collection of helpers for interacting with the ecoPortal MS's various APIs