eco-helpers 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a9a891a431684fe13200bdd2b55d92c418fdd09
-  data.tar.gz: badc9350ac7b4f8b1061a7f7ab25393af5bace7c
+  metadata.gz: aa7eb2714d4b0510dcc62b6b42b50835d4f5db4c
+  data.tar.gz: 0d241a6411f68297029028633051e818e08b1d2b
 SHA512:
-  metadata.gz: 0df330e81d17f875c120dcd0abc87f142a478e91b186cf4f70a4634ce513ad69a6d16fd4e5eea9da17ef7b366c84b129758d38a001627134f488ba35181bfdc2
-  data.tar.gz: 7154d3081842a3efc237bdbd80e8a5fc310a079eee2e71861456b5e47fc64c6fedaa15e880d5a97a10be2fc50059896fc328e630702976ee9672c87d5c2d266a
+  metadata.gz: 9d8d8b78d842472624a89de3c4a78095417f83f42b89c797a0fdd1124aaea9718dc614a448d2391c99bc2ca0a5a2b91f491d6b8656e3f5306a37a191d542b49b
+  data.tar.gz: 66eda21ef4862e5cf470312e4dbec32540287c8a3a5b8be34b56cd0b92301f0bfd22732d2f41f5714cc0d19cdd795f419d6d07e13b21d6432f93d26243119874

data/.yardopts

@@ -0,0 +1,10 @@
+--readme README.md
+--charset utf-8
+--markup-provider redcarpet
+--markup markdown
+--no-private
+--output-dir ./doc
+'lib/**/*.rb'
+-
+CHANGELOG.md
+LICENSE

data/eco-helpers.gemspec

@@ -22,8 +22,8 @@ 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 "rspec", "~> 3", ">= 3.8"
-  s.add_development_dependency "yard", "~> 0.9", ">= 0.9.18"
+  s.add_development_dependency "rspec",     "~> 3",   ">= 3.8"
+  s.add_development_dependency "yard",      "~> 0.9", ">= 0.9.18"
   s.add_development_dependency "redcarpet", "~> 3.4", ">= 3.4.0"
 
   s.add_dependency 'ecoportal-api', '~> 0.3', '>= 0.3.6'

data/lib/eco/api/organization/tag_tree.rb

@@ -13,7 +13,7 @@ module Eco
         #    [[Node], ...]
         # @example Input format example:
         #    tree = [{"tag" => "AUSTRALIA", "nodes" => [
-        #        {"tag" => "SYNDEY", "nodes" => []}
+        #        {"tag" => "SYDNEY", "nodes" => []}
         #    ]}]
         #    tree = TagTree.new(tree.to_json)
         # @param tagtree [String] representation of the tagtree in json.
@@ -69,8 +69,8 @@ module Eco
           list.select {|str| tag?(str)}
         end
 
-        # Finds the path from a node `key` to the its root node in the tree.
-        #  If `key` is not specified, returns the path from current node to root.
+        # Finds the path from a node `key` to its root node in the tree.
+        # If `key` is not specified, returns the path from current node to root.
         # @note the `path` is not relative to the subtree, but absolute to the entire tree.
         # @param key [String] tag to find the path to.
         # @return [Array<String>]
@@ -84,18 +84,18 @@ module Eco
         #
         # @example Usage example:
         #     tree = [{"tag" => "Australia", "nodes" => [
-        #          {"tag" => "SYNDEY", "nodes" => []},
-        #          {"tag" => "MELMOURNE", "nodes" => []}
+        #          {"tag" => "SYDNEY", "nodes" => []},
+        #          {"tag" => "MELBOURNE", "nodes" => []}
         #     ]}]
         #
         #     tree = TagTree.new(tree.to_json)
-        #     original = ["SYNDEY", "RISK"]
-        #     final    = ["MELMOURNE", "EVENT"]
+        #     original = ["SYDNEY", "RISK"]
+        #     final    = ["MELBOURNE", "EVENT"]
         #
-        #     tree.user_tags(initial: original, final: final) # out: ["MELMOURNE", "RISK"]
-        #     tree.user_tags(initial: original, final: final, preserve_custom: false) # out: ["MELMOURNE"]
-        #     tree.user_tags(initial: original, final: final, add_custom: true) # out: ["MELMOURNE", "RISK", "EVENT"]
-        #     tree.user_tags(initial: original, final: final, preserve_custom: false, add_custom: true) # out: ["MELMOURNE", "EVENT"]
+        #     tree.user_tags(initial: original, final: final) # out: ["MELBOURNE", "RISK"]
+        #     tree.user_tags(initial: original, final: final, preserve_custom: false) # out: ["MELBOURNE"]
+        #     tree.user_tags(initial: original, final: final, add_custom: true) # out: ["MELBOURNE", "RISK", "EVENT"]
+        #     tree.user_tags(initial: original, final: final, preserve_custom: false, add_custom: true) # out: ["MELBOURNE", "EVENT"]
         #
         # @param initial [Array<String>] original tags a person has in their account.
         # @param final [Array<String>] target tags the person should have in their account afterwards.

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

@@ -24,15 +24,10 @@ module Eco
           batch_from(people, method, api || self.api, params: params)
         end
 
-        def valid_methods
-          VALID_METHODS
-        end
-
         def valid_method?(value)
           VALID_METHODS.include?(value)
         end
 
-
         private
 
         def new_status(queue, method)
@@ -49,7 +44,7 @@ module Eco
           params = {per_page: DEFAULT_BATCH_BLOCK}.merge(params)
           client = people_api.client
           people = [];
-          if (page = params.fetch(:page, false))
+          if page = params[:page]
             res, response = get(client, params: params)
             people +=res
             logger.info("page number: #{page}, got num people #{people.length}")
@@ -79,7 +74,7 @@ module Eco
           end
           people = []
           response.body["results"].each do |person_hash|
-            person = INTERNAL::Person.new(person_hash)
+            person = Ecoportal::API::Internal::Person.new(person_hash)
             yield person if block_given?
             people.push(person)
           end
@@ -102,7 +97,7 @@ module Eco
           per_page = params.fetch(:per_page)
 
           iteration  = 1; done = 0
-          iterations = (people.length / per_page).ceil
+          iterations = (people.length.to_f / per_page).ceil
 
           people.each_slice(per_page) do |slice|
             msg = "starting batch '#{method}' iteration #{iteration}/#{iterations}, with #{slice.length} entries of #{people.length} -- #{done} done"

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

@@ -27,7 +27,9 @@ module Eco
           RefreshPresets.new(self).process
           ChangeEMailCase.new(self).process
           SetDefaultTagCase.new(self).process
-          UpsertAccountCase.new(self).process
+          CreateCase.new(self).process
+          UpdateCase.new(self).process
+          UpsertCase.new(self).process
           HrisCase.new(self).process
         end
       end
@@ -51,5 +53,7 @@ require_relative 'default_cases/remove_account_case'
 require_relative 'default_cases/refresh_presets'
 require_relative 'default_cases/change_email_case'
 require_relative 'default_cases/set_default_tag_case'
-require_relative 'default_cases/upsert_account_case'
+require_relative 'default_cases/create_case'
+require_relative 'default_cases/update_case'
+require_relative 'default_cases/upsert_case'
 require_relative 'default_cases/hris_case'

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

@@ -0,0 +1,60 @@
+module Eco
+  module API
+    module UseCases
+      class DefaultCases
+        class CreateCase < UseCases::BaseCase
+
+          def process
+            @cases.define("create", type: :sync) do |entries, people, session, options|
+              creation = session.job_group("main").new("create", type: :create, sets: [:core, :details, :account])
+
+              pgs = session.policy_groups
+
+              entries.each.with_index do |entry, i|
+                if person = people.find(entry)
+                  session.logger.error("Entry(#{i}) - this person (id: '#{person.id}') already exists: #{entry.to_s(:identify)}")
+                else
+                  person = session.new_person
+                  core_excluded = ["supervisor_id"]
+                  entry.set_core(person, exclude: core_excluded)
+                  entry.set_details(person) unless options.dig(:exclude, :details)
+
+                  unless options.dig(:exclude, :account)
+                    ini_pg_ids = person.account&.policy_group_ids || []
+                    ini_tags   = person.account&.filter_tags || []
+                    entry.set_account(person)
+
+                    person.account.send_invites = false if options.key?(:send_invites) && !options(:send_invites)
+
+                    person.account.policy_group_ids   = pgs.user_pg_ids(
+                      initial:         ini_pg_ids,
+                      final:           person.account.policy_group_ids
+                    )
+
+                    person.account.permissions_custom = session.new_preset(person) unless options.dig(:exclude, :abilities)
+
+                    if session.tagtree
+                      person.account.filter_tags = session.tagtree.user_tags(
+                        initial:          ini_tags,
+                        final:            person.account.filter_tags,
+                        preserve_custom:  true,
+                        add_custom:       true
+                      )
+                      person.account.default_tag = session.tagtree.default_tag(*person.account.filter_tags)
+                    else
+                      tags = person.account.filter_tags
+                      person.account.default_tag = tags.first unless tags.length > 1
+                    end
+                  end
+
+                  creation.add(person)
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -18,16 +18,15 @@ module Eco
                 exit
               end
 
-              pp old_id
-              pp new_id =  options.dig(:super, :new)
+              new_id =  options.dig(:super, :new)
 
               unless old_sup = people.person(id: old_id, external_id: old_id, email: old_id)
-                session.logger.error("Couldn't find any user with that id: '#{old_id}'. Aborting...")
+                session.logger.error("Couldn't find any user with that id (old-super): '#{old_id}'. Aborting...")
                 exit
               end
 
               unless new_sup = people.person(id: new_id, external_id: new_id, email: new_id)
-                session.logger.error("Couldn't find any user with that id: '#{new_id}'. Aborting...")
+                session.logger.error("Couldn't find any user with that id (new-super): '#{new_id}'. Aborting...")
                 exit
               end
 

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

@@ -0,0 +1,58 @@
+module Eco
+  module API
+    module UseCases
+      class DefaultCases
+        class UpdateCase < BaseCase
+
+          def process
+            @cases.define("update", type: :sync) do |entries, people, session, options|
+              update   = session.job_group("main").new("update", type: :update, sets: [:core, :details, :account])
+
+              pgs = session.policy_groups
+
+              entries.each.with_index do |entry, i|
+                if person = people.find(entry)
+                  core_excluded = ["supervisor_id"]
+                  core_excluded.push("email") if options.dig(:exclude, :email)
+                  entry.set_core(person, exclude: core_excluded) unless options.dig(:exclude, :core)
+                  entry.set_details(person) unless options.dig(:exclude, :details)
+
+                  unless options.dig(:exclude, :account)
+                    ini_pg_ids = person.account&.policy_group_ids || []
+                    ini_tags   = person.account&.filter_tags || []
+                    entry.set_account(person)
+
+                    person.account.policy_group_ids   = pgs.user_pg_ids(
+                      initial:         ini_pg_ids,
+                      final:           person.account.policy_group_ids
+                    )
+
+                    person.account.permissions_custom = session.new_preset(person) unless options.dig(:exclude, :abilities)
+
+                    if session.tagtree
+                      person.account.filter_tags = session.tagtree.user_tags(
+                        initial:          ini_tags,
+                        final:            person.account.filter_tags,
+                        preserve_custom:  true,
+                        add_custom:       true
+                      )
+                      person.account.default_tag = session.tagtree.default_tag(*person.account.filter_tags)
+                    else
+                      tags = person.account.filter_tags
+                      person.account.default_tag = tags.first unless tags.length > 1
+                    end
+                  end
+                  update.add(person)
+                else
+                  session.logger.error("Entry(#{i}) - this person does not exist: #{entry.to_s(:identify)}")
+                end
+              end
+            end
+
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module Eco
+  module API
+    module UseCases
+      class DefaultCases
+        class UpsertCase < BaseCase
+
+          def process
+            @cases.define("upsert", type: :sync) do |entries, people, session, options|
+              creation = session.job_group("main").new("create", type: :create, sets: [:core, :details, :account])
+              update   = session.job_group("main").new("update", type: :update, sets: [:core, :details, :account])
+
+              pgs = session.policy_groups
+
+              entries.each.with_index do |entry, i|
+                create = ! (person = people.find(entry))
+                person = session.new_person if create
+
+                core_excluded = ["supervisor_id"]
+                core_excluded.push("email") if options.dig(:exclude, :email) && !create
+                entry.set_core(person, exclude: core_excluded) unless options.dig(:exclude, :core) && !create
+                entry.set_details(person) unless options.dig(:exclude, :details)
+
+                unless options.dig(:exclude, :account)
+                  ini_pg_ids = person.account&.policy_group_ids || []
+                  ini_tags   = person.account&.filter_tags || []
+                  entry.set_account(person)
+
+                  person.account.send_invites = false if options.key?(:send_invites) && !options(:send_invites)
+
+                  person.account.policy_group_ids   = pgs.user_pg_ids(
+                    initial:         ini_pg_ids,
+                    final:           person.account.policy_group_ids
+                  )
+
+                  person.account.permissions_custom = session.new_preset(person) unless options.dig(:exclude, :abilities)
+
+                  if session.tagtree
+                    person.account.filter_tags = session.tagtree.user_tags(
+                      initial:          ini_tags,
+                      final:            person.account.filter_tags,
+                      preserve_custom:  true,
+                      add_custom:       true
+                    )
+                    person.account.default_tag = session.tagtree.default_tag(*person.account.filter_tags)
+                  else
+                    tags = person.account.filter_tags
+                    person.account.default_tag = tags.first unless tags.length > 1
+                  end
+                end
+
+                creation.add(person) if create
+                update.add(person) unless create
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/eco/cli.rb

@@ -3,7 +3,6 @@ module Eco
   end
 end
 
+require_relative 'cli/api'
 require_relative 'cli/root'
-require_relative 'cli/input'
-require_relative 'cli/input_multi'
 require_relative 'cli/session'

data/lib/eco/cli/api.rb

@@ -0,0 +1,14 @@
+module Eco
+  module CLI
+    class API < Eco::Common::BaseCLI
+      class_option :csv_in, :type  => :string, :banner => "FILE", :desc => "CSV input file"
+      class_option :csv_out, :type => :string, :banner => "FILE", :desc => "CSV output file"
+      class_option :json_in, :type  => :string, :banner => "FILE", :desc => "CSV input file"
+      class_option :json_out, :type  => :string, :banner => "FILE", :desc => "CSV input file"
+      
+      class_option :config_file, :aliases => "o", :type => :string,
+        :banner => "FILE", :desc => "specifes the session configuration file"
+      #class_option :csv_in, :alisaes =>
+    end
+  end
+end

data/lib/eco/cli/root.rb

@@ -3,6 +3,7 @@ module Eco
     class Root < Eco::Common::BaseCLI
       class_option :config_file, :aliases => "o", :type => :string,
         :banner => "FILE", :desc => "specifes the session configuration file"
+      #class_option :csv_in, :alisaes =>
     end
   end
 end

data/lib/eco/common.rb

@@ -3,5 +3,6 @@ module Eco
   end
 end
 
+require_relative 'common/meta_thor'
 require_relative 'common/base_cli'
 require_relative 'common/language'

data/lib/eco/common/base_cli.rb

@@ -1,114 +1,21 @@
-require 'thor'
-
 module Eco
   module Common
-    class BaseCLI < Thor
-      PIPE = "!"
+    class BaseCLI < MetaThor
       CUSTOM_HELP_MAPPINGS = ["?", "help"]
       ALL_HELP_MAPPINGS = Thor::HELP_MAPPINGS + CUSTOM_HELP_MAPPINGS
 
       class_option :simulate, type: :boolean, aliases: :s, desc: "do not launch updates or rewrite files"
-      class_option :verbosity, type: :numeric, default: 0, desc: "defines the level of verbosity to show feedback"
-
-      class_option :input, type: :hash, default: {}, required: false, desc: "--input=json:STRING"
-
-      def self.start(given_args = ARGV, config = {})
-        #given_args = splat_namespaces(given_args)
-        given_args = BaseCLI.parse_help(given_args)
-        super(given_args, config)
-      end
-
-      # incompatible with options / arguments of Hash type
-      # see: parse_hash here: https://github.com/erikhuda/thor/blob/master/lib/thor/parser/arguments.rb
-      def self.splat_namespaces(args)
-        args.reduce([]) do |done, arg|
-          done.concat(arg.split(":"))
-        end
-      end
+      #class_option :verbosity, type: :numeric, default: 0, desc: "defines the level of verbosity to show feedback"
 
-      def self.parse_help(args)
-        # Help enhancement. Adapted from: https://stackoverflow.com/a/49044225/4352306
-        last = args.last
-        if args.length > 1 && help?(last)
-          # switch last and second last position
-          last = "help" if custom_help?(last)
-          args.insert(args.length - 2, last).pop
-          puts "> #{args.join(" ")}"
+      class << self
+        def start(given_args = ARGV, config = {})
+          super(given_args, config)
         end
-        args
       end
-
-      def self.help?(value)
-        case value
-        when String
-          ALL_HELP_MAPPINGS.include?(value)
-        when Symbol
-          help?(value.to_s)
-        when Array
-          value.any? { |v| help?(v) }
-        when Hash
-          value.keys.any { |k| help?(v) }
-        end
-      end
-
-      def self.custom_help?(value)
-        CUSTOM_HELP_MAPPINGS.include?(value)
-      end
-
+      
       protected
 
       no_commands do
-        def input?(options)
-          options&.key?("input") || options&.key?(:input)
-        end
-
-        def input_object(input)
-          Eco::CLI::Input.new(input)
-        end
-
-        def input(value)
-          case
-          when value.is_a?(Eco::CLI::Input)
-            value.value
-          when value.is_a?(Eco::CLI::MultiInput)
-            value.to_h
-          when value.is_a?(String)
-            input(JSON.parse(value))
-          when value&.key?("input")
-            input(value["input"])
-          when value&.key?(:input)
-            input(value[:input])
-          when value&.key?("json")
-            JSON.parse(value["json"])
-          when value&.key?(:json)
-            JSON.parse(value[:json])
-          end
-        end
-
-        def pipe(input, args)
-          command, args, pipe = parse_pipe(args)
-          invoke command, args, {input: input_object(input)} if pipe
-          pipe
-        end
-
-        def parse_pipe(args)
-          args.shift if pipe = (args.first == PIPE)
-          subcommand = ""
-          if pipe
-            raise "Error: bad usage of pipe ('|'). Expected: '| command' " unless subcommand = args.slice!(0)
-            if help?(subcommand)
-              # Idea adapted from: https://stackoverflow.com/a/46167300/4352306
-              self.class.command_help(Thor::Base.shell.new, args.first)
-              exit
-            end
-          end
-          [subcommand, args, pipe]
-        end
-
-        def help?(value)
-          BaseCLI.help?(value)
-        end
-
       end
 
     end