ecoportal-api 0.5.6 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31190d7d5719d21b732605d97eccaad0c042f9fc3212fc5f181e6e18e6f12771
-  data.tar.gz: e7bb04368723c7da36ca8408b05088ed09753c9f9fa53722b32c3ef0df3f6e0e
+  metadata.gz: 8071a9704b5accb61bd9db43b0bd6c8c6d6f88aee00ef80d16fd4b5522aedf3c
+  data.tar.gz: fc42e6ea6570565a22cb52d9941ace6bcb081b42553321d552c1d1794ec0f8f9
 SHA512:
-  metadata.gz: f10ac460fa44b8750825f46648f54d394b36b9a4bec95b138724dd79f278db4014540bb268fecf9e4a3e719b8eb03da1d398a15203776706643eaa9437ba9fe8
-  data.tar.gz: 67185025081f552f608ba0512fce293ef5a731d31fee2b2132e276eda04f85bd135b0f268936209af1e948ff066f537d7834c005a302ca251f75359d7cfeb758
+  metadata.gz: 52a24b2a8f5326e92b42af2781c6a498580dfda7a16458c288b77e7ac5dea01cfa0ed619f27ea7a86d4ce27e4b004c156205a14076ac51cc06203c6abbc28820
+  data.tar.gz: 7146daf930693399e4935f0b00645768b64e0c44a7772f0c128042ab151bf29f0598e2e357e0462af77dd423561646c98cdd350e59830bd733e9c51bc120684a

data/CHANGELOG.md

@@ -1,7 +1,67 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.5.6] - 2020-06-xx
+## [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
+  - `Ecoportal::API::Internal::Preferences`: added missing fields for **kiosk**
+### Changed
+  - `Ecoportal::API::V1::People::JOB_TIMEOUT`: from 1 minute to 3 minutes
+  - `Ecoportal::API::V1::Person#filter_tags=`: will preserve the original order of the matching tags
+    * this change is to prevent `as_update` to generate false update positives
+  - `Ecoportal::API::Internal::Account#policy_group_ids=`: will preserve the original order of the matching ids
+    * this change is to prevent `as_update` to generate false update positives
+### Fixed
+  - `Ecoportal::API::Internal::Preferences`: access `doc` using string keys (not with `symbol` keys)
+
+
+## [0.5.6] - 2020-06-08
 
 ### Added
   - this `CHANGELOG.md` file

data/ecoportal-api.gemspec

@@ -20,12 +20,12 @@ 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",   "~> 1.16"
-  spec.add_development_dependency "rake",      "~> 10.0"
-  spec.add_development_dependency "rspec",     "~> 3.0"
+  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.4", ">= 3.4.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "redcarpet", "~> 3.5", ">= 3.5.0"
+  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

@@ -12,6 +12,17 @@ module Ecoportal
         embeds_one  :permissions, key: "permissions_custom", klass: :permissions_class
         embeds_one  :preferences, klass: :preferences_class
 
+        # Sets the `policy_group_ids`
+        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 && original_doc["policy_group_ids"]) || []
+          # preserve original order to avoid false updates
+          doc["policy_group_ids"] = (ini_ids & value) + (value - ini_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.

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,22 +2,18 @@ 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
-        ].each do |field|
+          :show_task_bubbles
+        ].map(&:to_s).each do |field|
           define_method(field) do
             if doc.key?(field)
               doc[field]

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

@@ -7,7 +7,7 @@ module Ecoportal
         include Enumerable
         include Common::DocHelpers
 
-        JOB_TIMEOUT = 60
+        JOB_TIMEOUT = 240
         DELAY_STATUS_CHECK = 5
 
         class_resolver :person_class, "Ecoportal::API::V1::Person"
@@ -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"
           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

@@ -49,12 +49,16 @@ module Ecoportal
           unless value.is_a?(Array)
             raise "filter_tags= needs to be passed an Array, got #{value.class}"
           end
-          doc["filter_tags"] = value.map do |tag|
+          end_tags = value.map do |tag|
             unless tag.match(VALID_TAG_REGEX)
               raise "Invalid filter tag #{tag.inspect}"
             end
             tag.upcase
           end
+
+          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
 
         def as_json

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

@@ -3,6 +3,7 @@ module Ecoportal
     class V1
       class PersonSchema < Common::BaseModel
         passthrough :id, :name
+        passthrough :enable_tags, :tags
 
         class_resolver :schema_field_class, "Ecoportal::API::V1::SchemaField"
 

data/lib/ecoportal/api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.7.1
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -78,34 +90,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   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
@@ -151,7 +163,6 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -171,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
@@ -188,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