eco-helpers 1.5.14 → 1.5.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2627cbc4d42e91e131e891cc4248895660a62bab2c331b43ac8ad3cd28b9cdee
-  data.tar.gz: fb2c29b13a67114ce8bbfbd16b271519896c201ec58cb9fd37b48db238abb014
+  metadata.gz: 71bf87e88b7a707a7684879b5462db11da003360d353d513005d169e77eaa033
+  data.tar.gz: 53fe5d42e0be580d0903ddd72e02b014ca113daafe8b37d073481a769deceb7f
 SHA512:
-  metadata.gz: 6da008ea99e2e6e323afcfbc0be117dd56402b95be100a68d808d3b4e81537def757fb66418fc0028492ea2e12ac74def8d4c6c47a7d05589bac3814ce9e10d9
-  data.tar.gz: 78af32b3b9f4725211baf6e458db91c064f49f25814bbda7177fe61af1b453597d658f1d734e155c8ebeb863aabdd36a0b6b81a9fcd972c6d92f2911f05ac11f
+  metadata.gz: 36db363c1aef9dac9f5fe0ca874c5d6e8dd39c89fbc7326fc66975ac12b5282288d6ba6c1449aea457c9831aacfbfe0529a53490389fc72f1f0ede956e35b9eb
+  data.tar.gz: 17ca4ae2ce8acde161e94f203eb643d405d33210972eec1bbbc3598f50f7b7015a94f9a81c50d64bafb0a42c9066464d421f6eb491e15a17c531753aa64ff59c

data/CHANGELOG.md

@@ -1,7 +1,24 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [1.5.14] - 2021-02-xx
+## [1.5.15] - 2021-02-xx
+
+### Added
+  - `Eco::API::Common::ClassHelpers` added support for class methods inheritance
+    - this is key to be able to define usecase models to inherit from
+  - `Eco::API::UseCases::OozeSamples::OozeUpdateCase`: added this sample to inherit from (simplifying use cases code)
+  - `Eco::API::Common::ClassHelpers` added inheritable attribute values
+  - added benchmarking to people loaders:
+    - `Eco::API::MicroCases#people_load`
+    - `Eco::API::MicroCases#people_cache`
+    - `Eco::API::MicroCases#people_search`
+    - `Eco::API::MicroCases#refresh`
+
+### Changed
+### Fixed
+  - `Eco::API::Policies::DefaultPolicies::UserAccess` typos in default api policy
+
+## [1.5.14] - 2021-02-05
 
 ### Added
   - `Eco::API::Policies::DefaultPolicies` policies that are run always (after the custom policies)

data/lib/eco/api/common/class_helpers.rb

@@ -3,7 +3,7 @@ module Eco
     module Common
       module ClassHelpers
 
-        # Creates an class and instance object methods with name `name` to resolve `klass` name
+        # Creates a class and instance object methods with name `name` to resolve `klass` name
         def class_resolver(name, klass)
           define_singleton_method(name) { resolve_class(klass) }
           define_method(name) { self.class.resolve_class(klass) }
@@ -39,6 +39,15 @@ module Eco
           end.join("")
         end
 
+        # Helper to create an instance variable `name`
+        # @param [String, Symbol] the name of the variable
+        # @reutrn [String] the name of the created instance variable
+        def instance_variable_name(name)
+          str = name.to_s
+          str = "@#{str}" unless str.start_with?("@")
+          str
+        end
+
         # If the class for `name` exists, it returns it. Otherwise it generates it.
         # @param name [String, Symbol] the name of the new class
         # @param inherits [Class] the parent class to _inherit_ from
@@ -92,6 +101,41 @@ module Eco
           descendants(parent_class: parent_class, direct: direct).length > 0
         end
 
+        # Keeps track on class instance variables that should be inherited by child classes.
+        # @note
+        #   - subclasses will inherit the value as is at that moment
+        #   - any change afterwards will be only on the specific class (in line with class instance variables)
+        #   - adapted from https://stackoverflow.com/a/10729812/4352306
+        # TODO: this separates the logic of the method to the instance var. Think if would be possible to join them somehow.
+        def inheritable_class_vars(*vars)
+          @inheritable_class_vars ||= [:inheritable_class_vars]
+          @inheritable_class_vars += vars
+        end
+
+        # Builds the attr_reader and attr_writer of `attrs` and registers the associated instance variable as inheritable.
+        def inheritable_attrs(*attrs)
+          attrs.each do |attr|
+            class_eval %(
+              class << self; attr_accessor :#{attr} end
+            )
+          end
+          inheritable_class_vars(*attrs)
+        end
+
+        # This callback method is called whenever a subclass of the current class is created.
+        # @note
+        #   - values of the instance variables are copied as they are (no dups or clones)
+        #   - the above means: avoid methods that change the state of the mutable object on it
+        #   - mutating methods would reflect the changes on other classes as well
+        #   - therefore, `freeze` will be called on the values that are inherited.
+        def inherited(subclass)
+          inheritable_class_vars.each do |var|
+            instance_var = instance_variable_name(var)
+            value        = instance_variable_get(instance_var)
+            subclass.instance_variable_set(instance_var, value.freeze)
+          end
+        end
+
       end
     end
   end

data/lib/eco/api/common/loaders/error_handler.rb

@@ -16,6 +16,8 @@ module Eco
             end
           end
 
+          inheritable_class_vars :error
+          
           def initialize(handlers)
             raise "Expected Eco::API::Policies. Given #{handlers.class}" unless handlers.is_a?(Eco::API::Error::Handlers)
             handlers.on(self.error, &self.method(:main))

data/lib/eco/api/common/loaders/parser.rb

@@ -60,6 +60,8 @@ module Eco
               end
             end
 
+            private
+
             # Helper to obtain the current internal named attributes of the data
             # @param source_data [Array<String>, Hash] if `Array` those are already the `keys`, if `Hash` it gets the `keys`
             # @return [Array<String>] `keys` of `source_data`
@@ -76,6 +78,8 @@ module Eco
 
           end
 
+          inheritable_class_vars :attribute
+
           def initialize(person_parser)
             raise "Expected Eco::API::Common::People::PersonParser. Given #{policies.class}" unless person_parser.is_a?(Eco::API::Common::People::PersonParser)
             person_parser.define_attribute(self.attribute, dependencies: self.class.dependencies) do |attr_parser|

data/lib/eco/api/common/loaders/use_case.rb

@@ -14,6 +14,8 @@ module Eco
             end
           end
 
+          inheritable_class_vars :type
+
           def initialize(usecases)
             raise "Expected Eco::API::UseCases. Given #{usecases.class}" unless usecases.is_a?(Eco::API::UseCases)
             usecases.define(self.name, type: self.type, &self.method(:main))

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

@@ -13,6 +13,15 @@ module Ecoportal
           original_doc["details"] = JSON.parse(doc["details"])
         end
 
+        def identify
+          if entry
+            entry.to_s(:identify)
+          else
+            str_id = id ? "id: '#{id}'; " : ""
+            "#{name}' (#{str_id}ext_id: '#{external_id}'; email: '#{email}')"
+          end
+        end
+
       end
     end
   end

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

@@ -6,7 +6,14 @@ module Eco
       # @return [Eco::API::Organization::People] the `People` object with the data.
       def people_cache(filename = enviro.config.people.cache)
         logger.info("Going to get all the people via API")
+
+        start = Time.now
         people = session.batch.get_people
+        secs    = Time.now - start
+        cnt     = people.count
+        per_sec = (cnt.to_f / secs).floor
+        logger.info("Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)")
+
         file   = file_manager.save_json(people, filename, :timestamp)
         logger.info("#{people.length} people loaded and saved locally to #{file}.")
         Eco::API::Organization::People.new(people)

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

@@ -18,27 +18,35 @@ module Eco
       def people_load(filename = enviro.config.people.cache, modifier: [:newest, :api])
         modifier  = [modifier].flatten
         load_file = [:file, :newest].any? {|flag| modifier.include?(flag)}
-        people    = case
-                    when filename && load_file
-                      if file = people_load_filename(filename, newest: modifier.include?(:newest))
-                        file_manager.load_json(file).tap do |people|
-                          logger.info("#{people&.length} people loaded from file #{file}") if people.is_a?(Array)
-                        end
-                      else
-                        logger.error("could not find the file #{file_manager.dir.file(filename)}")
-                        exit unless modifier.include?(:api)
-                        people_load(modifier: modifier - [:newest, :file])
-                      end
-                    when modifier.include?(:api)
-                      logger.info("Going to get all the people via API")
-                      session.batch.get_people.tap do |people|
-                        if modifier.include?(:save) && people && people.length > 0
-                          file = file_manager.save_json(people, filename, :timestamp)
-                          logger.info("#{people.length } people saved to file #{file}.")
-                        end
-                      end
-                    end
-        Eco::API::Organization::People.new(people)
+        case
+        when filename && load_file
+          if file = people_load_filename(filename, newest: modifier.include?(:newest))
+            file_manager.load_json(file).tap do |people|
+              logger.info("#{people&.length} people loaded from file #{file}") if people.is_a?(Array)
+            end
+          else
+            logger.error("could not find the file #{file_manager.dir.file(filename)}")
+            exit unless modifier.include?(:api)
+            people_load(modifier: modifier - [:newest, :file])
+          end
+        when modifier.include?(:api)
+          logger.info("Going to get all the people via API")
+
+          start = Time.now
+          session.batch.get_people.tap do |people|
+            secs    = Time.now - start
+            cnt     = people.count
+            per_sec = (cnt.to_f / secs).floor
+            logger.info("Loaded #{cnt} people in #{secs} seconds (#{per_sec} people/sec)")
+
+            if modifier.include?(:save) && people && people.length > 0
+              file = file_manager.save_json(people, filename, :timestamp)
+              logger.info("#{people.length } people saved to file #{file}.")
+            end
+          end
+        end.yield_self do |people|
+          Eco::API::Organization::People.new(people)
+        end
       end
 
       private

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

@@ -18,7 +18,13 @@ module Eco
         msg  = "Going to refresh #{people.length} people with server data"
         msg += " (including #{created} that were created)" if created > 0
         logger.info(msg)
+
+        start = Time.now
         entries = session.batch.get_people(people, silent: true)
+        secs    = Time.now - start
+        cnt     = entries.count
+        per_sec = (cnt.to_f / secs).floor
+        logger.info("Re-loaded #{cnt} people (out of #{people.length}) in #{secs} seconds (#{per_sec} people/sec)")
 
         missing = people.length - entries.length
         logger.error("Missed to obtain #{missing} people during the refresh") if missing > 0

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

@@ -11,24 +11,49 @@ module Eco
       # @return [Eco::API::Organization::People] the `People` object with the found persons.
       def people_search(data, options: {}, silent: true)
         session.logger.info("Going to api get #{data.length} entries...")
-        status = session.batch.search(data, silent: silent)
-        people = Eco::API::Organization::People.new(status.people)
-        session.logger.info("... could get #{people.length} people (out of #{data.length} entries)")
+
+        start = Time.now
+        people = session.batch.search(data, silent: silent).yield_self do |status|
+          secs    = Time.now - start
+          Eco::API::Organization::People.new(status.people).tap do |people|
+            cnt     = people.count
+            per_sec = (cnt.to_f / secs).floor
+            msg     = "... could get #{cnt} people (out of #{data.length} entries) in #{secs} seconds (#{per_sec} people/sec)"
+            session.logger.info(msg)
+          end
+        end
 
         # get the supervisors of found people (current supervisors)
         supers = people_search_prepare_supers_request(people)
         if supers.length > 0
           session.logger.info("  Going to api get #{supers.length} current supervisors...")
-          status = session.batch.search(supers, silent: silent)
-          people = people.merge(status.people, strict: micro.strict_search?(options))
+          start = Time.now
+          people = session.batch.search(supers, silent: silent).yield_self do |status|
+            secs    = Time.now - start
+            found   = status.people
+            cnt     = found.count
+            per_sec = (cnt.to_f / secs).floor
+            msg     = "... could find #{cnt} current supers (out of #{supers.length}) in #{secs} seconds (#{per_sec} people/sec)"
+            session.logger.info(msg)
+            people.merge(found, strict: micro.strict_search?(options))
+          end
         end
 
         # get the supervisors referred in the input data (future supervisors)
         supers = people_search_prepare_supers_request(data, people)
         if supers.length > 0
-          session.logger.info("  Going to api get #{supers.length} supervisors as per entries...")
-          status = session.batch.search(supers, silent: silent)
-          people = people.merge(status.people, strict: micro.strict_search?(options))
+          session.logger.info("  Going to api get #{supers.length} supervisors as per input entries...")
+          start = Time.now
+
+          people = session.batch.search(supers, silent: silent).yield_self do |status|
+            secs    = Time.now - start
+            found   = status.people
+            cnt     = found.count
+            per_sec = (cnt.to_f / secs).floor
+            msg     = "... could find #{cnt} input supers (out of #{supers.length}) in #{secs} seconds (#{per_sec} people/sec)"
+            session.logger.info(msg)
+            people.merge(found, strict: micro.strict_search?(options))
+          end
         end
 
         session.logger.info("Finally got #{people.length} people (out of #{data.length} entries)")

data/lib/eco/api/policies/default_policies/99_user_access_policy.rb

@@ -10,8 +10,8 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
     self.account_removed_count = 0
 
     people.each do |person|
-      remove_account_when_no_email!(person) if person.email.to_s.empty?
-      account.policy_group_ids = [defid]    if no_policy_group_ids?(person)
+      remove_account_when_no_email!(person)      if person.email.to_s.empty?
+      person.account.policy_group_ids = [defid]  if no_policy_group_ids?(person)
       refresh_abilities!(person.account)
     end
 
@@ -93,7 +93,7 @@ class Eco::API::Policies::DefaultPolicies::UserAccess < Eco::API::Common::Loader
     session.config.people.default_usergroup
   end
 
-  def pgs
+  def policy_groups
     session.policy_groups
   end
 

data/lib/eco/api/usecases.rb

@@ -160,3 +160,4 @@ require_relative 'usecases/use_case_chain'
 require_relative 'usecases/base_io'
 require_relative 'usecases/use_case_io'
 require_relative 'usecases/default_cases'
+require_relative 'usecases/ooze_samples'

data/lib/eco/api/usecases/ooze_samples.rb

@@ -0,0 +1,11 @@
+module Eco
+  module API
+    class UseCases
+      class OozeSamples
+
+      end
+    end
+  end
+end
+
+require_relative 'ooze_samples/ooze_update_case'

data/lib/eco/api/usecases/ooze_samples/ooze_update_case.rb

@@ -0,0 +1,85 @@
+class Eco::API::UseCases::OozeSamples::OozeUpdateCase < Eco::API::Common::Loaders::UseCase
+  name "single-ooze-case"
+  type :other
+
+  attr_reader :session, :options, :usecase
+
+  SAVE_PATCH = "ooze_patch_update.json"
+
+  def main(session, options, usecase)
+    @session = session; @options = options; @usecase = usecase
+    yield
+    end_script!
+  end
+
+  private
+
+  def end_script!
+    exit_if_no_changes!
+    backup_patch!
+    launch_request unless options[:simulate]
+    exit(0)
+  end
+
+  def ooze_id
+    options.dig(:source, :ooze_id)
+  end
+
+  def ooze
+    @ooze ||= apiv2.pages.get(ooze_id).tap do |ooze|
+      if ooze
+        logger.info("Got ooze '#{ooze_id}': '#{ooze.name}'")
+      else
+        logger.error("Could not get ooze '#{ooze_id}'")
+        exit(1)
+      end
+    end
+  end
+
+  def launch_request
+    prompt_to_confirm!
+
+    apiv2.pages.update(ooze).tap do |response|
+      if response.success?
+        logger.info("All went OK")
+      else
+        logger.error(response.body)
+      end
+    end
+  end
+
+  def exit_if_no_changes!
+    unless changes = !!patch_doc["page"]
+      logger.warn "No Changes!!"
+      exit(0)
+    end
+  end
+
+  def apiv2
+   @apiv2 ||= session.api(version: :oozes)
+  end
+
+  def patch_doc(renew: false)
+    return @patch_doc if @patch_doc && !renew
+    @patch_doc = apiv2.pages.get_body(ooze)
+  end
+
+  def backup_patch!
+    # store the request
+    File.open(SAVE_PATCH, "w") do |file|
+      #file << (patch_doc || {}).to_json
+      file << JSON.pretty_generate(patch_doc || {})
+    end
+    puts "Saved patch at: #{File.expand_path(SAVE_PATCH)}"
+  end
+
+  def logger
+    session.logger
+  end
+
+  def prompt_to_confirm!
+    print "\nDo you want to proceed (y/N)?  "
+    exit(1) unless $stdin.gets.chomp.to_s.downcase == "y"
+  end
+
+end

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "1.5.14"
+  VERSION = "1.5.15"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 1.5.14
+  version: 1.5.15
 platform: ruby
 authors:
 - Oscar Segura
@@ -405,6 +405,8 @@ files:
 - lib/eco/api/usecases/default_cases/update_case.rb
 - lib/eco/api/usecases/default_cases/update_details_case.rb
 - lib/eco/api/usecases/default_cases/upsert_case.rb
+- lib/eco/api/usecases/ooze_samples.rb
+- lib/eco/api/usecases/ooze_samples/ooze_update_case.rb
 - lib/eco/api/usecases/use_case.rb
 - lib/eco/api/usecases/use_case_chain.rb
 - lib/eco/api/usecases/use_case_io.rb