eco-helpers 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27ff9c6e496ac4cc7d08cb7f8fec22096ccd6aa915103de89048229e334cbc46
-  data.tar.gz: 0baecbe3aeb2ea75ce995395f15d2daba1b59a8e5587d2ce1537d99c92db9c61
+  metadata.gz: a6fbde8a22ee5efad00700ad096396a008f9a8f9ecaf8e2096f22b7730fa28d2
+  data.tar.gz: dc498ae2c6f853f92f3e2703d116a442c2814b2c0a230270e319fabf8678342c
 SHA512:
-  metadata.gz: 5c435f203bf8d3829829e8d00b74714a479544f48f0d0e081c83b1441a84a5bf6d9be678cab4aa60c09e9f5de3642388904ea52462477c83d259ba6960bab109
-  data.tar.gz: 7750b44622529f48bc58d577e4783affa8b1b5c7db58e780ff974634ee88dadcc4b0a93fe86879eec8cc4854959ce95ffa5cf7c256d5f458a2814715c7b9b6bc
+  metadata.gz: 9cb6d878d32370e81c512b01de2da8c6c32abcd79d636f1d70189228445c0094acef7236ffc4447c0cdd79e05576c22ceeb4798160da8752d655ff71e35440fb
+  data.tar.gz: 14283f84d4fbdc87a160dcdb842a3b154987d606333018acc0a636bd2ee2db9a25167c0106b8c8ba5fc56b4107324c9afa07caaeebe9e219bdaac1aac9d21687

data/CHANGELOG.md

@@ -1,6 +1,49 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [1.5.1] - 2020-10-xx
+
+### Added
+  - `presets_values.json`: added the new ability `tasks` (eP release `1.5.3`)
+  - `Ecoportal::API::Internal::Person` patch helper methods:
+    * `new?`: to know if this person is new in the people manager as a result of the current launch
+    * `account_added?`: to know if this person did not have account but they will have it after the current launch
+  - `Eco::API::Session#new_job`: to shorten code
+  - `Eco::API::Common::DefaultPasers::PolicyGroupsParser`: made native, as it is a very common parser
+  - `Eco::API::Common::DefaultPasers::FreemiumParser` to parse/serialise boolean
+  - `Eco::API::Common::People::PersonParser`: added `freemium` as core attribute
+  - `Eco::API::UserCases::DefaultCases::RecoverDBCase`: recovers also `freemium`
+  - scoping **microcases** : to be able to centralize common code between use cases
+    - at its early stage (currently not available for usage)
+  - dependency on `ecoportal-api-oozes` gem
+    - added basic support for **api** `v2`
+    - you can use `session.api(:oozes)` to obtain an api `v2`
+    - you can manage your keys directly on the apis configuration
+      - added `external_key:`, `user_key:` and `apis.default_user_key`
+
+  ```ruby
+  ASSETS.config do |config|
+    config.apis.default_user_key = 'your-user-key-here'
+
+    config.add_api("org-environment", {
+      host: 'pre.dev.ecoportal.com',
+      key:  'an-internal-org-api-key',
+      version: :internal,
+      external_key: 'an-external-org-api-key',
+      user_key: 'org-user-key-for-activity-stream',
+      mode:    :local
+    })
+  end
+  ```
+### Changed
+  - internally: load `Eco::API::Common::Session` before `Eco::API::Common::People`
+  - `Eco::API::Common::Person::EntryFactory`: made child of `Eco::API::Common::Session::BaseSession`
+  - refactored all the `api` connection creation for simplicity and to support multi api version
+  - delegated `Eco::API::Session::Batch#get` to `Ecoportal::API::V1::People#get_all`
+
+### Fixed
+  - correct `.gemspec` dependency version restrictions
+
 ## [1.5.0] - 2020-09-11
 
 ### Added
@@ -17,7 +60,7 @@ All notable changes to this project will be documented in this file.
 ### Added
 ### Changed
 ### Fixed
-- preserve backtrace on logging
+  - preserve backtrace on logging
 
 ## [1.4.0] - 2020-07-14
 
@@ -88,7 +131,7 @@ All notable changes to this project will be documented in this file.
   - `Eco::API::Organization::TagTree#tag?` to accept `nil` by returning `false`
   - `Eco::API::Common::People::DefaultParsers::DateParser` will parse to `Date` class
     * it was parsing to `Time` class, while the native gem `ecoportal-api` parses as `Date` ([reference](https://gitlab.com/ecoPortal/ecoportal-api/-/blob/master/lib/ecoportal/api/v1/schema_field.rb))
-## [1.3.11] - 2020-05-19
+## [1.3.12] - 2020-05-19
 
 ### Added
 ### Changed

data/eco-helpers.gemspec

@@ -22,16 +22,17 @@ 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.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_development_dependency "bundler",   ">= 2.1.3",  "< 2.2"
+  s.add_development_dependency "rspec",     ">= 3.9",    "< 4"
+  s.add_development_dependency "rake",      ">= 12.3.0", "< 13"
+  s.add_development_dependency "yard",      ">= 0.9.18", "< 0.10"
+  s.add_development_dependency "redcarpet", ">= 3.5.0",  "< 3.6"
 
-  s.add_dependency 'ecoportal-api', '~> 0.7',  '>= 0.7.0'
-  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'
+  s.add_dependency 'ecoportal-api', '>= 0.7.1', '< 0.8'
+  s.add_dependency 'ecoportal-api-oozes', '>= 0.7.2', '< 0.8'
+  s.add_dependency 'aws-sdk-s3',    '>= 1.64.0', '< 2'
+  s.add_dependency 'aws-sdk-ses',   '>= 1.29.0', '< 2'
+  s.add_dependency 'dotenv',        '>= 2.7.0', '< 2.8'
+  s.add_dependency 'net-sftp',      '>= 2.1.2', '< 2.2'
 
 end

data/lib/eco/api.rb

@@ -1,4 +1,5 @@
 require 'ecoportal/api'
+require 'ecoportal/api-oozes'
 
 module Eco
   module API

data/lib/eco/api/common.rb

@@ -8,5 +8,5 @@ end
 require_relative 'common/version_patches'
 require_relative 'common/class_helpers'
 require_relative 'common/class_hierarchy'
-require_relative 'common/people'
 require_relative 'common/session'
+require_relative 'common/people'

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

@@ -31,6 +31,8 @@ module Eco
 
             # ALWAYS PRESENT FIELDS
             SendInvitesParser.new(self).process
+            FreemiumParser.new(self).process
+            PolicyGroupsParser.new(self).process
 
             # FORMAT PARSER
             CSVParser.new(self).process
@@ -48,4 +50,6 @@ require_relative 'default_parsers/numeric_parser'
 require_relative 'default_parsers/date_parser'
 require_relative 'default_parsers/multi_parser'
 require_relative 'default_parsers/send_invites_parser'
+require_relative 'default_parsers/freemium_parser'
+require_relative 'default_parsers/policy_groups_parser'
 require_relative 'default_parsers/csv_parser'

data/lib/eco/api/common/people/default_parsers/freemium_parser.rb

@@ -0,0 +1,30 @@
+module Eco
+  module API
+    module Common
+      module People
+        class DefaultParsers
+          class FreemiumParser < People::BaseParser
+
+            def process
+              @parsers.define_attribute("freemium") do |parser|
+                parser.def_parser  do |hash|
+                  value = hash["freemium"]
+                  value = value.first if value.is_a?(Array)
+                  truthy(value)
+                end.def_serializer do |person|
+                  person.freemium&.to_s
+                end
+              end
+            end
+
+            private
+
+            def truthy (value)
+              %w[true y yes x].include?(value.to_s&.downcase)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/common/people/default_parsers/policy_groups_parser.rb

@@ -0,0 +1,42 @@
+module Eco
+  module API
+    module Common
+      module People
+        class DefaultParsers
+          class PolicyGroupsParser < People::BaseParser
+
+            def process
+              @parsers.define_attribute("policy_group_ids") do |parser|
+                parser.def_parser  do |columns_hash|
+                  policy_group_ids = []
+                  if policy_ids = columns_hash["policy_group_ids"]
+                    policy_group_ids = policy_ids.split("|").map do |name|
+                      policy_groups.to_id(name&.downcase.strip)
+                    end.compact
+                  end
+                  policy_group_ids.empty?? default_id : policy_group_ids.join("|")
+                end.def_serializer do |person|
+                  ids   = person&.account&.policy_group_ids || []
+                  ids.map do |id|
+                    policy_groups.to_name(id)
+                  end.compact.join("|")
+                end
+              end
+            end
+
+            private
+
+            def policy_groups
+              @policy_groups ||= ASSETS.config.policy_groups
+            end
+
+            def default_id
+              @default_id    ||= policy_groups.to_id(ASSETS.config.people.default_usergroup)
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eco/api/common/people/default_parsers/send_invites_parser.rb

@@ -9,7 +9,8 @@ module Eco
               @parsers.define_attribute("send_invites") do |parser|
                 parser.def_parser  do |hash|
                   value = hash["send_invites"]
-                  value.is_a?(Array) ? value.map { |v| truthy(v) } : truthy(value)
+                  value = value.first if value.is_a?(Array)
+                  truthy(value)
                 end.def_serializer do |person|
                   person.account && person.account.send_invites&.to_s
                 end

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

@@ -4,21 +4,21 @@ module Eco
       module People
         # Helper factory class to generate entries (input entries).
         # @attr_reader schema [Ecoportal::API::V1::PersonSchema] person schema to be used in this entry factory
-        # @attr_reader person_parser [Eco::API::Common::People::PersonParser] set of attribute, type and format parsers/serializers.
-        class EntryFactory
+        class EntryFactory < Eco::API::Common::Session::BaseSession
 
           attr_reader :schema, :person_parser
 
+          # @param e [Eco::API::Common::Session::Environment] requires a session environment, as any child of `Eco::API::Common::Session::BaseSession`
           # @param schema [Ecoportal::API::V1::PersonSchema] schema of person details that the parser will be based upon.
           # @param person_parser [nil, Eco::API::Common::People::PersonParser] set of attribute, type and format parsers/serializers.
           # @param attr_map [nil, Eco::Data::Mapper] attribute names mapper to translate external names into internal ones and _vice versa_.
           # @param logger [Common::Session::Logger, ::Logger] object to manage logs.
-          def initialize(schema:, person_parser: nil, attr_map: nil, logger: ::Logger.new(IO::NULL))
+          def initialize(e, schema:, person_parser: nil, attr_map: nil)
             fatal "Constructor needs a PersonSchema. Given: #{schema}" if !schema.is_a?(Ecoportal::API::V1::PersonSchema)
             fatal "Expecting PersonParser. Given: #{person_parser}"    if person_parser && !person_parser.is_a?(Eco::API::Common::People::PersonParser)
             fatal "Expecting Mapper object. Given: #{fields_mapper}"   if attr_map && !attr_map.is_a?(Eco::Data::Mapper)
+            super(e)
 
-            @logger = logger
             @schema = Ecoportal::API::V1::PersonSchema.new(JSON.parse(schema.doc.to_json))
 
             @source_person_parser = person_parser
@@ -34,6 +34,7 @@ module Eco
 
           # provides with a Eco::API::Common::People::PersonParser object (collection of attribute parsers)
           # @note if the custom person parser has changed, it updates the copy of this EntryFactory instance
+          # @return [Eco::API::Common::People::PersonParser] set of attribute, type and format parsers/serializers.
           def person_parser
             if @person_parser_patch_version < @source_person_parser.patch_version
               @person_parser.merge(@source_person_parser)
@@ -52,7 +53,7 @@ module Eco
               person_parser: person_parser,
               attr_map:      @attr_map,
               dependencies:  dependencies,
-              logger:        @logger
+              logger:        logger
             )
           end
 
@@ -81,7 +82,7 @@ module Eco
                 file_content = File.read(file, encoding: encoding)
                 arr_hash     = person_parser.parse(format, file_content)
               else
-                @logger.warn("File does not exist: #{file}")
+                logger.warn("File does not exist: #{file}")
               end
 
               entries(data: arr_hash)
@@ -131,7 +132,7 @@ module Eco
           private
 
           def fatal(msg)
-            @logger.fatal(msg)
+            logger.fatal(msg)
             raise msg
           end
 

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

@@ -72,6 +72,8 @@ module Eco
           # @param value [String, Array<String>] value(s) to be translated into internal names.
           # @return [String, nil, Array<String] the internal name(s) of `value`.
           def to_internal(value)
+            # TODO: check PersonEntry#to_internal and #to_external in init_attr_trackers
+            # => when attr_map is avoided, it doesn't work as it should
             return value if !@attr_map
             attr = value
             case value

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

@@ -9,7 +9,7 @@ module Eco
         # @attr_reader details_attrs [Array<String>] internal names of schema details attributes.
         # @attr_reader all_attrs [Array<String>] all the internal name attributes, including _core_, _account_ and _details_.
         class PersonParser
-          CORE_ATTRS    = ["id", "external_id", "email", "name", "supervisor_id", "filter_tags"]
+          CORE_ATTRS    = ["id", "external_id", "email", "name", "supervisor_id", "filter_tags", "freemium"]
           ACCOUNT_ATTRS = ["policy_group_ids", "default_tag", "send_invites", "landing_page_id", "login_provider_ids"]
           TYPE          = [:select, :text, :date, :number, :phone_number, :boolean, :multiple]
           FORMAT        = [:csv, :xml, :json]

data/lib/eco/api/common/session/base_session.rb

@@ -3,9 +3,6 @@ module Eco
     module Common
       module Session
         class BaseSession
-
-          include Common::People
-
           attr_accessor :session
           attr_accessor :environment, :config
           alias_method :enviro, :environment
@@ -32,8 +29,8 @@ module Eco
             enviro.config
           end
 
-          def api
-            enviro.api
+          def api(version: nil)
+            enviro.api(version: version)
           end
 
           def file_manager
@@ -47,7 +44,7 @@ module Eco
           def mailer?
             enviro.mailer?
           end
-          
+
           def sftp
             enviro.sftp
           end

data/lib/eco/api/common/session/environment.rb

@@ -3,11 +3,7 @@ module Eco
     module Common
       module Session
         class Environment
-
-          include Common::People
-
           attr_reader :config, :session
-          attr_reader :api #, :host, :version
           attr_reader :file_manager, :logger
           attr_reader :mailer, :sftp, :s3uploader
 
@@ -57,25 +53,8 @@ module Eco
             config.s3storage.configured?
           end
 
-          def api
-            @api || new_api
-          end
-
-          def new_api
-            return nil unless config.apis.active_api
-
-            log_connection = config.logger.log_connection?
-            logg = log_connection ? logger : ::Logger.new(IO::NULL)
-
-            api = config.api(logg)
-
-            unless log_connection
-              logger.info("Created connection pointing to '#{config.apis.active_api.host}' in '#{config.apis.active_api.mode}' mode")
-              api.logger.level = ::Logger::UNKNOWN
-            end
-
-            @api = api
-            api
+          def api(version: nil)
+            config.api(logger, version: version)
           end
 
         end

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

@@ -2,7 +2,7 @@ module Ecoportal
   module API
     class Internal
       class Person
-        
+
         def reset_account!
           doc["account"] = JSON.parse(original_doc["account"])
         end
@@ -11,6 +11,14 @@ module Ecoportal
           original_doc["account"] = JSON.parse(doc["account"])
         end
 
+        def new?
+          !initial_doc["details"] && !initial_doc["account"]
+        end
+
+        def account_added?
+          person.account && !initial_doc["account"]
+        end
+
       end
     end
   end

data/lib/eco/api/microcases.rb

@@ -0,0 +1,31 @@
+module Eco
+  module API
+    class MicroCases < Eco::API::Common::Session::BaseSession
+      class << self
+        def define(name, &block)
+          name = name.to_sym
+          @helpers[name] = block
+          define_method(name.to_sym, &block)
+        end
+      end
+
+      def define(*args)
+        self.class.define(*args)
+      end
+
+      def micro
+        self
+      end
+
+    end
+  end
+end
+
+require_relative 'microcases/core_excluded'
+require_relative 'microcases/fix_filter_tags'
+require_relative 'microcases/set_account'
+require_relative 'microcases/set_core'
+require_relative 'microcases/set_default_group'
+require_relative 'microcases/set_default_tag'
+require_relative 'microcases/set_supervisor'
+require_relative 'microcases/strict_search'

data/lib/eco/api/microcases/core_excluded.rb

@@ -0,0 +1,20 @@
+module Eco
+  module API
+    class MicroCases
+      #self.define(:core_excluded) do |options|
+
+      # @param person [Person] the person we want to update, carrying the changes to be done.
+      # @param options [Hash] the options
+      def core_excluded(person, options)
+        ["supervisor_id"].tap do |core_excluded|
+          unless person.new?
+            exclusions = ["name", "external_id", "email", "filter_tags"].select do |attr|
+              options.dig(:exclude, attr.to_sym)
+            end
+            core_excluded.concat(exclusions)
+          end
+        end
+      end
+    end
+  end
+end