ecoportal-api 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f796fceb53db69721014b596e1ffae27838e14cebb57e203603db97d04434996
-  data.tar.gz: 508db6f77b5a30e9ca9c67b5e938535b1fdc0dfcb0a2f65ad4a05e789560ab2b
+  metadata.gz: 8071a9704b5accb61bd9db43b0bd6c8c6d6f88aee00ef80d16fd4b5522aedf3c
+  data.tar.gz: fc42e6ea6570565a22cb52d9941ace6bcb081b42553321d552c1d1794ec0f8f9
 SHA512:
-  metadata.gz: 65ebf6dca8615e88ac80b4b363e279aaa01ea7c96114d22eaa4faa12a227a5ac5299a581d09ff632d7a02472eeada2b6047c483511366a5cf6eddda1db16fa65
-  data.tar.gz: cd31897593cadd5b729d42ae5f339d052d0f1198847c38ffddba293e00aa4cdca583e83693d35f25d71caea7b8cf93c649140497f1a0f6ab923aaccd0b4523f8
+  metadata.gz: 52a24b2a8f5326e92b42af2781c6a498580dfda7a16458c288b77e7ac5dea01cfa0ed619f27ea7a86d4ce27e4b004c156205a14076ac51cc06203c6abbc28820
+  data.tar.gz: 7146daf930693399e4935f0b00645768b64e0c44a7772f0c128042ab151bf29f0598e2e357e0462af77dd423561646c98cdd350e59830bd733e9c51bc120684a

data/CHANGELOG.md

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

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

@@ -5,7 +5,7 @@ module Ecoportal
         passthrough :files, :data, :reports
         passthrough :organization, :person_core, :person_core_create, :person_core_edit
         passthrough :person_account, :person_details
-        passthrough :pages, :page_editor, :registers
+        passthrough :pages, :page_editor, :registers, :tasks
       end
     end
   end

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"
           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/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.7.0"
+    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.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-20 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -182,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
@@ -199,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