ecoportal-api 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a89994e76cf541159975756271aa254c709696347e1a5eb9b2181dbea8b54d25
-  data.tar.gz: 4ef1d5c9ad068faad4922fac5dae85f6fc6e629271b0680c1ee5010a4aadf424
+  metadata.gz: f58ff9e368c2607a55aed0c5e62d45e7c51f37baac25d5da83c4ce6dd4224733
+  data.tar.gz: c8bcd11749dfcd0a57650ba25a3d826e209b871c472c2cabbb9e61c01bbaa563
 SHA512:
-  metadata.gz: 21db065f98ef0aa1afe59b5b4766474691eaad98c78d0175f7d1161585f8f8bfa07426ee9edd4f056439e5dffc1d94bd608a2124411bd68fc051537b11048aa5
-  data.tar.gz: 32b98b96710d3147ab2fde5f32b982e2d8a3ea234cd8c2c1eb707bdb98cf46a62a9f905caae2cfeb2889b62793bb1285c5c8215598da917f7ff944f951328828
+  metadata.gz: 0e730eff886dd4f908e1bdd52b468b513c4e0309b7be47e3461bd7ef7f81c91d6d9dd4e61c8bdc681132bb310dd423bc62c3379510701d9c71e3f4847688fd3e
+  data.tar.gz: dba899cde0099074a44549cd05fedcd3a72e57ca81403a9399411f67c6575db40fe170f63fda7ded3e6d4fa626db2dd0dd33df1eaf3b7058d3cb9aec83e53792

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## [0.6.0] - 2020-07-xx
+
+### 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
+  - person model: `freemium` core property
+### Changed
+### Fixed

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,9 @@ 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_account, :person_details
+        passthrough :pages, :page_editor, :registers
       end
     end
   end

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

@@ -2,6 +2,10 @@ 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,
@@ -9,7 +13,7 @@ module Ecoportal
           :show_recently_visited_forms,
           :show_tasks,
           :show_task_bubbles
-        ].each do |field|
+        ].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"
@@ -22,7 +22,7 @@ module Ecoportal
 
         # Iterates all the people of the organization.
         # @note
-        #   - it ignores the key `results_from:` of `params:`.
+        #   - it ignores the key `cursor_id:` of `params:`.
         #   - `each` is called by `to_a`
         # @param params [Hash]
         # @option params [String] :per_page the number of people you get per request.
@@ -31,15 +31,15 @@ module Ecoportal
         # @yieldparam person [Person]
         def each(params: {}, &block)
           return to_enum(:each) unless block
-          results_from = nil
+          cursor_id = nil
           loop do
-            params.update(results_from: results_from) if results_from
+            params.update(cursor_id: cursor_id) if cursor_id
             response = client.get("/people", params: params)
             raise "Request failed." unless response.success?
             response.body["results"].each do |person|
               yield person_class.new(person)
             end
-            break unless (results_from = response.body["next_results_from"])
+            break unless (cursor_id = response.body["cursor_id"])
           end
           self
         end

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

@@ -8,7 +8,7 @@ module Ecoportal
       # @attr_reader subordinates [Integer] the number of people this person is supervisor of.
       # @attr details [PersonDetails, nil] the details of the person or `nil` if missing.
       class Person < Common::BaseModel
-        passthrough :id, :external_id, :name, :email, :supervisor_id, :subordinates, :filter_tags
+        passthrough :id, :external_id, :name, :email, :supervisor_id, :subordinates, :filter_tags, :freemium
 
         class_resolver :person_schema_class,  "Ecoportal::API::V1::PersonSchema"
         class_resolver :person_details_class, "Ecoportal::API::V1::PersonDetails"
@@ -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.3"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-16 00:00:00.000000000 Z
+date: 2020-07-14 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
@@ -149,8 +161,8 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -215,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A collection of helpers for interacting with the ecoPortal MS's various APIs