ecoportal-api 0.5.7 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23c2c89eeaf9c3885adf494fb7cd2daa6bea5173dc106c5eda9093c2639fc3a0
-  data.tar.gz: 1eff582092bc9ea71dfc0f1841630fc703fc8dc82cb590faf95f95c971d24643
+  metadata.gz: e1976e2e6000be3719f3cd7d9d0524ecdd4d005691f4c214e9ad77bbe9b33d09
+  data.tar.gz: 577313f39edd82846a9050ae8acbadf9f3b79ca2f1ebbedec9ee598973ff1fed
 SHA512:
-  metadata.gz: 94c62031538298401941fc52f3b9dafd0b2661a6c5bbc60e39c730894fb086221bc9613aa55eeb81920fd55c0ef8a0d825360a83c1dc2fa90b2ef3b00562addd
-  data.tar.gz: 3e76c19b8b987a55f112cb15551f5e76e6d453083c66213622af5b9e363ebec0a08b51a8b5122f26466b96f22806b191b75cc63e83c624f5107de497b3f6a7d8
+  metadata.gz: 6706dcf4968d94c9e1daedff8e2325699b4da5403d758c79474a7dff618e9dd36d31d566003be66bb685fc633e0100a2c08a80ba5edd9c4d8433b2e5c56ac00f
+  data.tar.gz: 20004f26d098f579cc5b7269bb06eb8bf41284506b291882ff81ff7794db2612162df8f010e24a41240a82d30f6b48a48ae8e54c60375c3d5f79228f95ef76b8

data/CHANGELOG.md

@@ -1,7 +1,74 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.5.7] - 2020-06-xx
+## [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
+  - `Ecoportal::API::Internal::Permissions`: **update for new ability `tasks` of ecoPortal release `1.5.3`**
+  - `Ecoportal::API::V1::People#each`: added keyword argument `silent:` to display download progress
+### Fixed
+  - `Ecoportal::API::V1::People#each`: when no block provided, it was creating an `Enumarator` without preserving the parameters (i.e. `:q` or `per_page` were lost)
+
+## [0.7.0] - 2020-09-11
+
+### Added
+### 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`
+### Fixed
+
+
+## [0.6.0] - 2020-07-14
+
+### Added
+  - `Ecoportal::API::Common::BaseModel#initial_doc`: `#consolidate!` modifies `original_doc`
+    - this helper allows to know what was the initial document the object was created with
+  - `Ecoportal::API::Common::BaseModel#as_update`: added parameter (default: `:last` => compare with `original_doc`)
+    - calling it with `:total` will compare the current `doc` with the `initial_doc`
+### Changed
+  - `Ecoportal::API::Internal::Permissions`: **update for new abilities of ecoPortal release `1.5.0`**
+    - added abilities: `person_core`, `person_account`, `person_details`
+    - removed ability: `people`
+  - renamed `print` to `pretty_print` to avoid overriding `$stdout.print`, on:
+    - `Ecoportal::API::Common::BaseModel`
+    - `Ecoportal::API::Common::BatchReponse`
+    - `Ecoportal::API::Common::Response`
+    - `Ecoportal::API::Common::WrappedResponse`
+### Fixed
+  - `Ecoportal::API::Internal::Preferences`: **kiosk** settings should default to `false` (`nil`)
+
+## [0.5.8] - 2020-06-23
+
+### Added
+### Changed
+### Fixed
+  - `Ecoportal::API::V1::Person#filter_tags=`: `original_doc["filter_tags"]` is `nil` when creating a person
+  - `Ecoportal::API::Internal::Account#policy_group_ids=`: `original_doc["account"]` is `nil` when creating a person
+
+
+## [0.5.7] - 2020-06-22
 
 ### Added
   - `Ecoportal::API::V1::PersonSchema`: added `enable_tags` & `tags` properties

data/ecoportal-api.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "pry"      , "~> 0.13"
 
   spec.add_dependency 'http',          '~> 3'
   spec.add_dependency 'hash-polyfill', '~> 0'

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

@@ -48,6 +48,7 @@ module Ecoportal
           if !_parent || !_key
             @doc          = doc
             @original_doc = JSON.parse(@doc.to_json)
+            @initial_doc  = JSON.parse(@doc.to_json)
           end
         end
 
@@ -63,6 +64,12 @@ module Ecoportal
           _parent.original_doc.dig(*[_key].flatten)
         end
 
+        def initial_doc
+          raise UnlinkedModel.new  unless linked?
+          return @initial_doc if is_root?
+          _parent.initial_doc.dig(*[_key].flatten)
+        end
+
         def as_json
           doc
         end
@@ -71,9 +78,10 @@ module Ecoportal
           doc.to_json(*args)
         end
 
-        def as_update
+        def as_update(ref = :last)
           new_doc = as_json
-          Common::HashDiff.diff(new_doc, original_doc)
+          ref_doc = ref == :total ? initial_doc : original_doc
+          Common::HashDiff.diff(new_doc, ref_doc)
         end
 
         def dirty?
@@ -100,7 +108,7 @@ module Ecoportal
           end
         end
 
-        def print
+        def pretty_print
           puts JSON.pretty_generate(as_json)
           self
         end

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

@@ -20,10 +20,10 @@ module Ecoportal
             yield doc
           end
         end
-        
-        def print
+
+        def pretty_print
           if success?
-            each(&:print)
+            each(&:pretty_print)
           else
             puts "Request failed."
           end

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

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

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

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

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
 
-          ini_ids = original_doc["policy_group_ids"] || []
+          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/internal/permissions.rb

@@ -2,7 +2,10 @@ module Ecoportal
   module API
     class Internal
       class Permissions < Common::BaseModel
-        passthrough :files, :data, :reports, :organization, :people, :pages, :page_editor, :registers
+        passthrough :files, :data, :reports
+        passthrough :organization, :person_core, :person_core_create, :person_core_edit
+        passthrough :person_account, :person_details
+        passthrough :pages, :page_editor, :registers, :tasks
       end
     end
   end

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

@@ -2,21 +2,17 @@ module Ecoportal
   module API
     class Internal
       class Preferences < Common::BaseModel
+        passthrough  :kiosk_enabled, :kiosk_workflow_message, :kiosk_create_button_label,
+            :kiosk_create_button_help, :kiosk_return_button_label, :kiosk_return_button_help,
+            :kiosk_dashboard_button_label, :kiosk_dashboard_button_help
+
         [
           :show_sidebar,
           :show_shortcuts,
           :show_coming_soon,
           :show_recently_visited_forms,
           :show_tasks,
-          :show_task_bubbles,
-          :kiosk_enabled,
-          :kiosk_workflow_message,
-          :kiosk_create_button_label,
-          :kiosk_create_button_help,
-          :kiosk_return_button_label,
-          :kiosk_return_button_help,
-          :kiosk_dashboard_button_label,
-          :kiosk_dashboard_button_help
+          :show_task_bubbles
         ].map(&:to_s).each do |field|
           define_method(field) do
             if doc.key?(field)

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

@@ -27,15 +27,27 @@ module Ecoportal
         # @param params [Hash]
         # @option params [String] :per_page the number of people you get per request.
         # @option params [String] :q some text to search. Omit this parameter to target all the people.
+        # @param silent [Boolean] `false` to show percentage of progress.
         # @yield [person] does some stuff with the person.
         # @yieldparam person [Person]
-        def each(params: {}, &block)
-          return to_enum(:each) unless block
-          cursor_id = nil
+        def each(params: {}, silent: false, &block)
+          return to_enum(:each, params: params, silent: silent) unless block
+          cursor_id = nil; results = 0
+          puts "\n" unless silent
           loop do
             params.update(cursor_id: cursor_id) if cursor_id
             response = client.get("/people", params: params)
-            raise "Request failed." unless response.success?
+            raise "Request failed - Status #{response.status}: #{response.body}" unless response.success?
+
+            unless silent || (total = response.body["total_results"]) == 0
+              results += response.body["results"].length
+              percent  = results * 100 / total
+              msg      = "People GET"
+              msg     += " (search=#{params[:q]})" if params.key?(:q)
+              print "#{msg}: #{percent.round}% (of #{total})\r"
+              $stdout.flush
+            end
+
             response.body["results"].each do |person|
               yield person_class.new(person)
             end
@@ -45,13 +57,14 @@ module Ecoportal
         end
 
         # Gets all the people via api requests.
-        # @note it ignores the key `:page` in `params:`.
+        # @note it ignores the key `:cursor_id` in `params:`.
         # @param params [Hash]
         # @option params [Integer] :per_page the number of people you get per request.
         # @option params [String] :q some text to search.
+        # @param silent [Boolean] `false` to show percentage of progress.
         # @return [Array<Person>] the array of people got via api.
-        def get_all(params: {})
-          each(params: params).to_a
+        def get_all(params: {}, silent: false)
+          each(params: params, silent: silent).to_a
         end
 
         # Gets a person via api.

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["filter_tags"] || []
+          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.5.7"
+    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.5.7
+  version: 0.7.2
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2020-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,16 +108,16 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -163,7 +163,6 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -183,7 +182,6 @@ files:
 - lib/ecoportal/api/common/response.rb
 - lib/ecoportal/api/common/wrapped_response.rb
 - lib/ecoportal/api/internal.rb
-- lib/ecoportal/api/internal/.git-keep
 - lib/ecoportal/api/internal/account.rb
 - lib/ecoportal/api/internal/login_provider.rb
 - lib/ecoportal/api/internal/login_providers.rb
@@ -200,7 +198,6 @@ files:
 - lib/ecoportal/api/internal/schema_field_value.rb
 - lib/ecoportal/api/logger.rb
 - lib/ecoportal/api/v1.rb
-- lib/ecoportal/api/v1/.git-keep
 - lib/ecoportal/api/v1/people.rb
 - lib/ecoportal/api/v1/person.rb
 - lib/ecoportal/api/v1/person_details.rb