ecoportal-api 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8071a9704b5accb61bd9db43b0bd6c8c6d6f88aee00ef80d16fd4b5522aedf3c
-  data.tar.gz: fc42e6ea6570565a22cb52d9941ace6bcb081b42553321d552c1d1794ec0f8f9
+  metadata.gz: e1976e2e6000be3719f3cd7d9d0524ecdd4d005691f4c214e9ad77bbe9b33d09
+  data.tar.gz: 577313f39edd82846a9050ae8acbadf9f3b79ca2f1ebbedec9ee598973ff1fed
 SHA512:
-  metadata.gz: 52a24b2a8f5326e92b42af2781c6a498580dfda7a16458c288b77e7ac5dea01cfa0ed619f27ea7a86d4ce27e4b004c156205a14076ac51cc06203c6abbc28820
-  data.tar.gz: 7146daf930693399e4935f0b00645768b64e0c44a7772f0c128042ab151bf29f0598e2e357e0462af77dd423561646c98cdd350e59830bd733e9c51bc120684a
+  metadata.gz: 6706dcf4968d94c9e1daedff8e2325699b4da5403d758c79474a7dff618e9dd36d31d566003be66bb685fc633e0100a2c08a80ba5edd9c4d8433b2e5c56ac00f
+  data.tar.gz: 20004f26d098f579cc5b7269bb06eb8bf41284506b291882ff81ff7794db2612162df8f010e24a41240a82d30f6b48a48ae8e54c60375c3d5f79228f95ef76b8

data/CHANGELOG.md

@@ -1,6 +1,28 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.7.2] - 2020-10-30
+
+### 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

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

@@ -13,16 +13,34 @@ 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)
         end
 
+        # @return [Array<String>] the policy group ids of this user.
+        def policy_group_ids
+          doc["policy_group_ids"] ||= []
+        end
+
+        # @return [Array<String>] the login provider ids of this user.
+        def login_provider_ids
+          doc["login_provider_ids"] ||= []
+        end
+
+        # @return [Array<String>] the starred page ids of this user.
+        def starred_ids
+          doc["starred_ids"] ||= []
+        end
+
         # Sets the `permissions_preset`.
         # @note basically the same as `permissions_preset=` but when `"custom"`, it's changed to `nil`
         # @param value [nil, String] preset name.
@@ -37,6 +55,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,7 +33,7 @@ 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)

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,8 +42,17 @@ module Ecoportal
           self.supervisor_id = person&.id || person&.external_id
         end
 
+        # Sets the email of a person.
+        # @param email [String, nil] the email of this person.
+        def email=(value)
+          unless !value || value.match(VALID_EMAIL_REGEX)
+            raise "Invalid email #{email.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)
@@ -54,13 +64,18 @@ module Ecoportal
               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)
         end
 
+        # @return [Array<String>] the filter tags of this person.
+        def filter_tags
+          doc["filter_tags"] ||= []
+        end
+
         def as_json
           super.merge "details" => details&.as_json
         end

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.7.1"
+    VERSION = "0.7.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2020-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler