eco-helpers 1.3.14 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01ec2727fdeee5bc360e417faefdafdb8bf69078cecc17ead881047e8df17cd2
-  data.tar.gz: 67e46501f166224248d6d92e6607cddcbce3806dbd05f41e485d0ca2139f1105
+  metadata.gz: 28d9f5ad6037a8160ea1d39873a0b1c6769be63865267d159dd6fa71ae329d60
+  data.tar.gz: ba968ce7525e5fb289ff5b210f3c79692b05dfc74ae6af6cf8c729640bb1cf4a
 SHA512:
-  metadata.gz: cd26851249e2c8557f9da3399f72292cb46a2c12db530f12e3da2a88120dc08a6e0a6ee053527b91685cd60e532d2bbd76e156f1fc803dc6bf2c1246a21fac27
-  data.tar.gz: 4f199963c86259bb5a210dca09aa1af2b83c9489308afd200986d6d5c13f32d3479fb2eeaad19c397882359dd3ef16892dc7449860879e2a71fdbf8f73e34943
+  metadata.gz: 2a7bda8f0a427b7a93d42230c32226c578b4ae4aab9b2974bf1095d1f77d368faa8c409e41375cf5d378ed4a915b359ce12e74559c7f963a2a9d791a165f3232
+  data.tar.gz: ba9adb7220623345536d5080e658a524daebd914f3c64d94f83652e3d42fbdb240da9a08367ee42dde196adfc2152553b4133bd330d3a007052bba42b156aed5

data/CHANGELOG.md

@@ -1,6 +1,51 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.4.0] - 2020-07-xx
+
+### Added
+### Changed
+  - change abilities to align with ecoPortal release `1.5.0`
+  - remove some patches on `ecoportal-api`
+  - removed patch method `Ecoportal::API::V1::Person#sync`
+### Fixed
+  - `Eco::CSV#parse` and `Eco::CSV#read` should use the proper `:encoding` when it's `bom`
+
+## [1.3.18] - 2020-07-08
+
+### Added
+### Changed
+### Fixed
+  - the `update` case was missing the code to use the `default_usergroup`
+
+
+## [1.3.17] - 2020-07-06
+
+### Added
+### Changed
+  - the `hris` case should not only include as `leavers` those that have account, but anyone that leaves
+    * as we could have active people with no account
+### Fixed
+  - `Eco::API::Session::Batch::Errors#errors`: fix error for empty `body` on response
+
+## [1.3.16] - 2020-06-26
+
+### Added
+  - `Eco::API::Common::People::Entries`, `#entry` & `#find` should allow for `strict` search (added parameter)
+### Changed
+  - upgraded `ecoportal-api` gem dependency to minimum version `0.5.7`
+    - this includes the removal of some patches
+  - some gems update
+### Fixed
+  - patched preferences (`kiosk` preferences should default to `nil`)
+
+## [1.3.15] - 2020-06-11
+
+### Added
+  - default usecase to export to `csv` (`-detailed`) now includes `"Supervisor Name"` column
+### Changed
+### Fixed
+
 ## [1.3.14] - 2020-06-10
 
 ### Added

data/eco-helpers.gemspec

@@ -22,16 +22,16 @@ Gem::Specification.new do |s|
   #s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "bundler",   "~> 2.0.1"
-  s.add_development_dependency "rspec",     "~> 3",   ">= 3.8"
+  s.add_development_dependency "bundler",   "~> 2.1", ">= 2.1.3"
+  s.add_development_dependency "rspec",     "~> 3",   ">= 3.9"
   s.add_development_dependency "rake",      "~> 12.3.0"
   s.add_development_dependency "yard",      "~> 0.9", ">= 0.9.18"
   s.add_development_dependency "redcarpet", "~> 3.5", ">= 3.5.0"
 
-  s.add_dependency 'ecoportal-api', '~> 0.5',  '>= 0.5.6'
-  s.add_dependency 'aws-sdk-s3',    '~> 1.30', '>= 1.30.1'
-  s.add_dependency 'aws-sdk-ses',   '~> 1.14', '>= 1.14.0'
-  s.add_dependency 'dotenv',        '~> 2.6',  '>= 2.6.0'
+  s.add_dependency 'ecoportal-api', '~> 0.5',  '>= 0.5.9'
+  s.add_dependency 'aws-sdk-s3',    '~> 1',    '>= 1.64.0'
+  s.add_dependency 'aws-sdk-ses',   '~> 1',    '>= 1.29.0'
+  s.add_dependency 'dotenv',        '~> 2.7',  '>= 2.7.0'
   s.add_dependency 'net-sftp',      '~> 2.1',  '>= 2.1.2'
 
 end

data/lib/eco/api/common/people/entries.rb

@@ -50,23 +50,28 @@ module Eco
           end
 
           # Search function to find an `entry` based on one of different options
-          def entry(id: nil, external_id: nil, email: nil)
+          def entry(id: nil, external_id: nil, email: nil, strict: false)
             init_caches
             pers = nil
             pers = @by_id[id]&.first if id
             pers = @by_external_id[external_id&.strip]&.first    if !pers && !external_id.to_s.strip.empty?
-            pers = @by_email[email&.downcase.strip]&.first       if !pers && !email.to_s.strip.empty?
-            pers = @by_external_id[email&.downcase.strip]&.first if !pers && !email.to_s.strip.empty?
+
+            # strict prevents taking existing user for searched person with same email
+            # specially useful if the organisation ensures all have external id (no need for email search)
+            if !pers && (!strict || external_id.to_s.strip.empty?)
+              pers = @by_email[email&.downcase.strip]&.first       if !pers && !email.to_s.strip.empty?
+              pers = @by_external_id[email&.downcase.strip]&.first if !pers && !email.to_s.strip.empty?
+            end
             pers
           end
 
           # Search function to find an `entry` based on one of different options
           # see Eco::API::Common::People::Entries#entry
-          def find(object)
+          def find(object, strict: false)
             id          = object.respond_to?("id")?          object.send("id") : nil
             external_id = object.respond_to?("external_id")? object.send("external_id") : nil
             email       = object.respond_to?("email")?       object.send("email") : nil
-            entry(id: id, external_id: external_id, email: email)
+            entry(id: id, external_id: external_id, email: email, strict: strict)
           end
 
           def exclude(object)

data/lib/eco/api/common/version_patches/ecoportal_api.rb

@@ -1,6 +1,2 @@
-require 'ecoportal/api'
-require_relative 'ecoportal_api/base_model'
-require_relative 'ecoportal_api/external_people'
 require_relative 'ecoportal_api/external_person'
 require_relative 'ecoportal_api/internal_person'
-require_relative 'ecoportal_api/account_preferences'

data/lib/eco/api/common/version_patches/ecoportal_api/external_person.rb

@@ -3,10 +3,6 @@ module Ecoportal
     class V1
       class Person
 
-        def sync
-          consolidate!
-        end
-
         def reset_details!
           doc["details"] = JSON.parse(original_doc["details"])
         end

data/lib/eco/api/organization/presets_reference.json

@@ -5,6 +5,9 @@
     "reports": "view",
     "organization": null,
     "people": null,
+    "person_core": null,
+    "person_account": null,
+    "person_details": null,
     "pages": "view",
     "page_editor": null,
     "registers": "view"
@@ -14,7 +17,9 @@
     "data": "view",
     "reports": "view",
     "organization": null,
-    "people": "attach",
+    "person_core": "attach",
+    "person_account": null,
+    "person_details": "view",
     "pages": "create",
     "page_editor": "basic",
     "registers": "view"
@@ -24,7 +29,9 @@
     "data": "update",
     "reports": "edit",
     "organization": "view",
-    "people": "view",
+    "person_core": "view_people_manager",
+    "person_account": "view",
+    "person_details": "view",
     "pages": "create",
     "page_editor": "intermediate",
     "registers": "view"
@@ -34,7 +41,9 @@
     "data": "administrate",
     "reports": "administrate",
     "organization": "administrate",
-    "people": "edit",
+    "person_core": "edit",
+    "person_account": "edit",
+    "person_details": "edit_private",
     "pages": "administrate",
     "page_editor": "advanced",
     "registers": "dashboard"

data/lib/eco/api/organization/presets_values.json

@@ -3,7 +3,9 @@
   "data": [null, "view", "update", "administrate", "implement"],
   "reports": [null, "view", "edit", "administrate"],
   "organization": [null, "view", "administrate", "implement"],
-  "people": [null, "attach", "view", "view_private", "edit", "dashboard"],
+  "person_core": [null, "attach", "view_people_manager", "create", "edit", "dashboard"],
+  "person_account": [null, "view", "create", "edit"],
+  "person_details": [null, "view", "edit_public", "view_private", "edit_private"],
   "pages": [null, "view", "update", "create", "administrate"],
   "page_editor": [null, "basic", "intermediate", "advanced", "implement"],
   "registers": [null, "view", "dashboard", "administrate", "implement"]

data/lib/eco/api/session/batch/errors.rb

@@ -69,13 +69,15 @@ module Eco
 
           def errors
             entries.each_with_object([]) do |entry, arr|
-              if errs = status[entry].body["errors"]
-                errs.each do |msg|
-                  arr.push({
-                    type:  klass = Eco::API::Error.get_type(msg),
-                    err:   klass.new(err_msg: msg, entry: entry, session: session),
-                    entry: entry
-                  })
+              if body = status[entry].body
+                if errs = body["errors"]
+                  errs.each do |msg|
+                    arr.push({
+                      type:  klass = Eco::API::Error.get_type(msg),
+                      err:   klass.new(err_msg: msg, entry: entry, session: session),
+                      entry: entry
+                    })
+                  end
                 end
               end
             end

data/lib/eco/api/usecases/default_cases/create_case.rb

@@ -69,7 +69,7 @@ module Eco
                     if session.tagtree
                       person.account.default_tag = session.tagtree.default_tag(*person.filter_tags)
                     else
-                      tags = person.filter_tags
+                      tags = person.filter_tags || []
                       person.account.default_tag = tags.first unless tags.length > 1
                     end
                   end

data/lib/eco/api/usecases/default_cases/hris_case.rb

@@ -11,17 +11,18 @@ module Eco
               supers   = session.job_group("post").new("supers", usecase: usecase, type: :update, sets: :core)
               leavers  = session.job_group("post").new("leavers", usecase: usecase, type: :update, sets: :account)
 
-              people.users.each_with_index  do |person, i|
-                if !entries.find(person)
+              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
+              pgs           = session.policy_groups
+
+              people.each_with_index  do |person, i|
+                if !entries.find(person, strict: strict_search)
                   leavers.add(person) do |person|
                     person.supervisor_id = nil
-                    person.account       = nil
+                    person.account       = nil if person.account
                   end
                 end
               end
 
-              strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
-              pgs           = session.policy_groups
 
               if session.config.people.default_usergroup?
                 def_id  = pgs.to_id(session.config.people.default_usergroup)
@@ -84,7 +85,7 @@ module Eco
                     if session.tagtree
                       person.account.default_tag = session.tagtree.default_tag(*person.filter_tags)
                     else
-                      tags = person.filter_tags
+                      tags = person.filter_tags || []
                       person.account.default_tag = tags.first unless tags.length > 1
                     end
                   end

data/lib/eco/api/usecases/default_cases/set_default_tag_case.rb

@@ -30,8 +30,12 @@ module Eco
               update   = session.job_group("main").new("update", usecase: usecase, type: :update, sets: :account)
 
               people.each_with_index  do |person, i|
-                #next unless person.id == "5c527ba63f7690001243f5b2"
-                person.account.default_tag = session.tagtree.default_tag(*person.filter_tags)
+                if session.tagtree
+                  person.account.default_tag = session.tagtree.default_tag(*person.filter_tags)
+                else
+                  tags = person.filter_tags || []
+                  person.account.default_tag = tags.first unless tags.length > 1
+                end
                 update.add(person)
               end
 

data/lib/eco/api/usecases/default_cases/to_csv_case.rb

@@ -42,7 +42,7 @@ module Eco
                   csv << session.new_entry(person, dependencies: deps).to_hash.values
                 end
               end
-              true
+              exit(0)
             end
           end
 

data/lib/eco/api/usecases/default_cases/to_csv_detailed_case.rb

@@ -24,21 +24,31 @@ module Eco
               CSV.open(file, "w") do |csv|
                 deps    = {"supervisor_id" => {people: people}}
                 header  = session.new_entry(people.first, dependencies: deps).to_hash.keys
+                header += ["Subordinates"]
+                header += ["Supervisor Name"]
                 header += abilities
                 header += ["Login Methods"] if login_providers.any_optional?
-                header += ["Subordinates"]
                 header += ["Landing Page"]
 
                 csv << header
                 people.each do |person|
                   data = session.new_entry(person, dependencies: deps).to_hash.values
+
+                  data.push(person.subordinates)
+                  super_id = person.supervisor_id
+                  if supervisor = people.person(id: super_id, external_id: super_id)
+                    data.push(supervisor.name)
+                  else
+                    data.push("")
+                  end
+
                   person_abilities = (person.account && person.account.permissions_custom) || {}
                   data += abilities.map {|key| person_abilities[key] || "no access"}
+
                   if login_providers.any_optional?
                     logins = (person.account && person.account.login_provider_ids) || []
                     data.push(login_providers.to_name(logins).join("|"))
                   end
-                  data.push(person.subordinates)
 
                   if person.account && landing_id = person.account.landing_page_id
                     data.push(landing_id)
@@ -47,7 +57,7 @@ module Eco
                   csv << data
                 end
               end
-              true
+              exit(0)
             end
           end
 

data/lib/eco/api/usecases/default_cases/update_case.rb

@@ -12,6 +12,10 @@ module Eco
               strict_search = session.config.people.strict_search? && (!options[:search]&.key?(:strict) || options.dig(:search, :strict))
               pgs           = session.policy_groups
 
+              if session.config.people.default_usergroup?
+                def_id  = pgs.to_id(session.config.people.default_usergroup)
+              end
+
               entries.each.with_index do |entry, i|
                 if person = people.find(entry, strict: strict_search)
 
@@ -37,6 +41,7 @@ module Eco
                   entry.set_details(person) unless options.dig(:exclude, :details)
 
                   unless options.dig(:exclude, :account)
+                    add_account = !person.account
                     ini_pg_ids = person.account&.policy_group_ids || []
 
                     account_excluded = []
@@ -68,7 +73,7 @@ module Eco
                       if session.tagtree
                         person.account.default_tag = session.tagtree.default_tag(*person.filter_tags)
                       else
-                        tags = person.filter_tags
+                        tags = person.filter_tags || []
                         person.account.default_tag = tags.first unless tags.length > 1
                       end
                     end

data/lib/eco/api/usecases/default_cases/upsert_case.rb

@@ -77,7 +77,7 @@ module Eco
                     if session.tagtree
                       person.account.default_tag = session.tagtree.default_tag(*person.filter_tags)
                     else
-                      tags = person.filter_tags
+                      tags = person.filter_tags || []
                       person.account.default_tag = tags.first unless tags.length > 1
                     end
                   end

data/lib/eco/data/files/helpers.rb

@@ -71,7 +71,7 @@ module Eco
         end
 
         def encoding(path)
-          has_bom?(path) ? "bom|utf-8" : "utf-8"
+          has_bom?(path) ? "bom" : "utf-8"
         end
 
         def script_subfolder

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "1.3.14"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 1.3.14
+  version: 1.4.0
 platform: ruby
 authors:
 - Oscar Segura
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        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: 2.0.1
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -33,7 +39,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +49,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -107,7 +113,7 @@ dependencies:
         version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.6
+        version: 0.5.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -117,67 +123,67 @@ dependencies:
         version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.6
+        version: 0.5.9
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.30'
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.30.1
+        version: 1.64.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.30'
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.30.1
+        version: 1.64.0
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ses
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.14.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.29.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.14.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.29.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.7.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.7.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
@@ -247,9 +253,6 @@ files:
 - lib/eco/api/common/session/sftp.rb
 - lib/eco/api/common/version_patches.rb
 - lib/eco/api/common/version_patches/ecoportal_api.rb
-- lib/eco/api/common/version_patches/ecoportal_api/account_preferences.rb
-- lib/eco/api/common/version_patches/ecoportal_api/base_model.rb
-- lib/eco/api/common/version_patches/ecoportal_api/external_people.rb
 - lib/eco/api/common/version_patches/ecoportal_api/external_person.rb
 - lib/eco/api/common/version_patches/ecoportal_api/internal_person.rb
 - lib/eco/api/common/version_patches/exception.rb

data/lib/eco/api/common/version_patches/ecoportal_api/account_preferences.rb

@@ -1,51 +0,0 @@
-module Ecoportal
-  module API
-    class Internal
-      class Preferences
-        [
-          :show_sidebar,
-          :show_shortcuts,
-          :show_coming_soon,
-          :show_recently_visited_forms,
-          :show_tasks,
-        ].each do |field|
-          key = field.to_s
-          define_method(field) do
-            if doc.key?(key)
-              doc[key]
-            else
-              true
-            end
-          end
-          define_method("#{field}=") do |value|
-            doc[key] = !!value
-          end
-        end
-
-        [
-          :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|
-          key = field.to_s
-          define_method(field) do
-            if doc.key?(key)
-              doc[key]
-            else
-              nil
-            end
-          end
-          define_method("#{field}=") do |value|
-            doc[key] = !!value
-          end
-        end
-
-      end
-    end
-  end
-end

data/lib/eco/api/common/version_patches/ecoportal_api/base_model.rb

@@ -1,27 +0,0 @@
-module Ecoportal
-  module API
-    module Common
-      class BaseModel
-
-        attr_reader :initial_doc
-
-        def initialize(doc = {}, parent: self, key: nil)
-          @_parent = parent
-          @_key    = key
-          if !_parent || !_key
-            @doc          = doc
-            @original_doc = JSON.parse(@doc.to_json)
-            @initial_doc  = JSON.parse(@doc.to_json)
-          end
-        end
-
-        def initial_doc
-          raise UnlinkedModel.new  unless linked?
-          return @initial_doc if is_root?
-          _parent.initial_doc.dig(*[_key].flatten)
-        end
-
-      end
-    end
-  end
-end

data/lib/eco/api/common/version_patches/ecoportal_api/external_people.rb

@@ -1,38 +0,0 @@
-module Ecoportal
-  module API
-    class V1
-      class People
-
-        def job
-          operation = Common::BatchOperation.new("/people", person_class, logger: client.logger)
-          yield operation
-          # The batch operation is responsible for logging the output
-          job_id = create_job(operation)
-          status = wait_for_job_completion(job_id)
-
-          if status&.complete?
-            operation.process_response job_result(job_id, operation)
-          else
-            raise "Job `#{job_id}` not complete. Probably timeout after #{JOB_TIMEOUT + 120} seconds. Current status: #{status}"
-          end
-        end
-
-        private
-
-        def wait_for_job_completion(job_id)
-          # timeout library is evil. So we make poor-man timeout.
-          # https://jvns.ca/blog/2015/11/27/why-rubys-timeout-is-dangerous-and-thread-dot-raise-is-terrifying/
-          before = Time.now
-          while true
-            status = job_status(job_id)
-            break status if status.complete?
-            break status if Time.now >= before + (JOB_TIMEOUT + 120)
-            sleep(DELAY_STATUS_CHECK)
-            status
-          end
-        end
-
-      end
-    end
-  end
-end