eco-helpers 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb418abf2d0a0a3bcf9d4f95c9696b9d6347f006
+  data.tar.gz: 978e4c69e536b192722df51e8eb361d835a708ae
+SHA512:
+  metadata.gz: 72efbdbf8703f5be28ef9fb223c3886d83ed8a3d72d5ff58efe7bb59ce6cc5f82916cef8cdac685c01c7f1d70d70a6cf43fe7ddc35bfffe3754b98ded18e976e
+  data.tar.gz: b40e206e5e3d633e8dec159342e1df20b2424e378e4418cdd4820c675335d34f94925a3865ff12c2c10f1b0836178f6adab4cbd036e931a2eb6ffd5e9f082e25

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/README.md

@@ -0,0 +1,20 @@
+# Script API Helpers (script_api_helpers)
+
+Some helpers to simplify things:
+
+* managing **files**: keep your updates with a timestamp, find the last version, encrypt/decrypt the data, shortcuts to avoid messing around with language specificities,...
+generate fake data: different topics, use different distributions,...
+* API:
+    * custom multiple *presets* profiles,
+    * get the highest of each flag among different custom presets
+
+To do:
+
+* more **fake data** features: link api details field, randomize your policy groups or apply a fixed distribution based on location
+* API:
+    * **map** different **account properties**, such as policy groups to presets or preferences
+    * use an assistant to map **CSV** columns to the correct account or details properties
+    * use batch helpers that store and manage your update files and provide log errors, or use them as an example
+    * validate tagtree tags
+    * create configuration files for orgs you manage the **HRIS** (a weekly feed will become a one time execution script)
+    * create **unit tests** to check if the API behaviour meets the specifications and launch them periodically

data/eco-helpers.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "./lib/eco/version"
+
+Gem::Specification.new do |s|
+  s.name          = "eco-helpers"
+  s.version       = Eco::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ["Oscar Segura"]
+  s.email         = ["oscar@ecoportal.co.nz"]
+  s.date          = %q{2018-09-05}
+  s.summary       = %q{eco-helpers to manage people api cases}
+  s.homepage      = "https://www.ecoportal.com"
+  s.licenses      = %w[MIT]
+
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  #s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  #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_dependency 'ecoportal-api', '~> 0.3', '>= 0.3.6'
+  s.add_dependency 'faker',         '~> 1',   '>= 1.9'
+  s.add_dependency 'distribution',  '~> 0.7', '>= 0.7.3'
+  s.add_dependency 'thor',          '~> 0',   '>= 0.20'
+  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'
+end

data/lib/eco-helpers.rb

@@ -0,0 +1,15 @@
+require 'csv'
+require 'json' # native
+require 'pp'
+
+
+module Eco
+end
+
+require_relative 'eco/language'
+require_relative 'eco/common'
+require_relative 'eco/scripting'
+require_relative 'eco/data'
+require_relative 'eco/api'
+require_relative 'eco/tester'
+require_relative 'eco/cli'

data/lib/eco/api.rb

@@ -0,0 +1,13 @@
+require 'ecoportal/api'
+
+module Eco
+  module API
+  end
+end
+
+require_relative 'api/common'
+require_relative 'api/organization'
+require_relative 'api/session'
+require_relative 'api/usecases'
+require_relative 'api/session_config'
+require_relative 'api/eco_faker'

data/lib/eco/api/common.rb

@@ -0,0 +1,10 @@
+module Eco
+  module API
+    module Common
+    end
+  end
+end
+
+require_relative 'common/version_patches'
+require_relative 'common/people'
+require_relative 'common/session'

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

@@ -0,0 +1,17 @@
+module Eco
+  module API
+    module Common
+      module People
+      end
+    end
+  end
+end
+
+require_relative 'people/types'
+require_relative 'people/person_modifier'
+require_relative 'people/person_factory'
+require_relative 'people/base_parser'
+require_relative 'people/person_parser'
+require_relative 'people/default_parsers'
+require_relative 'people/person_entry'
+require_relative 'people/entries'

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

@@ -0,0 +1,16 @@
+module Eco
+  module API
+    module Common
+      module People
+        class BaseParser
+          def initialize(parsers, **options)
+            @parsers = parsers
+            @options = options
+          end
+
+          def process; end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Eco
+  module API
+    module Common
+      module People
+        class DefaultParsers < PersonParser
+
+          def initialize(*args)
+            super(*args)
+            define_defaults
+          end
+
+          private
+
+          def define_defaults
+            # Select Options
+            select_hashes = @schema.fields.map do |fld|
+              if fld.type == "select"
+                options_hash = fld.options.map { |v| [v.downcase.strip, v] }.to_h
+                [fld.alt_id, options_hash]
+              end
+            end.compact.to_h
+
+            SelectParser.new(self, select_hashes: select_hashes).process
+            BooleanParser.new(self).process
+            NumericParser.new(self, schema: @schema).process
+            DateParser.new(self).process
+            MultiParser.new(self).process
+          end
+
+        end
+      end
+    end
+  end
+end
+
+require_relative 'default_parsers/select_parser'
+require_relative 'default_parsers/boolean_parser'
+require_relative 'default_parsers/numeric_parser'
+require_relative 'default_parsers/date_parser'
+require_relative 'default_parsers/multi_parser'

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

@@ -0,0 +1,28 @@
+module Eco
+  module API
+    module Common
+      module People
+        class DefaultParsers
+          class BooleanParser < People::BaseParser
+
+            def process
+              @parsers.define_attribute(:boolean) do |parser|
+                parser.def_parser  do |value|
+                  value.is_a?(Array) ? value.map { |v| truthy(v) } : truthy(value)
+                end.def_serializer do |value|
+                  value.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/date_parser.rb

@@ -0,0 +1,33 @@
+module Eco
+  module API
+    module Common
+      module People
+        class DefaultParsers
+          class DateParser < People::BaseParser
+
+            def process
+              @parsers.define_attribute(:date) do |parser|
+                parser.def_parser  do |value|
+                  value.is_a?(Array) ? value.map { |v| parse_date(v) } :  parse_date(value)
+                end.def_serializer do |value|
+                  value.is_a?(Array) ? value.map { |d| d && d.strftime('%Y-%m-%d') } : value && value.strftime('%Y-%m-%d')
+                end
+              end
+            end
+
+            private
+
+            def parse_date(value)
+              begin
+                (value.to_s.empty?) ? nil : Time.parse(value)
+              rescue
+                nil
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Eco
+  module API
+    module Common
+      module People
+        class DefaultParsers
+          class MultiParser < People::BaseParser
+
+            def process
+              @parsers.define_attribute(:multiple) do |parser|
+                parser.def_parser  do |value|
+                  return value if value.is_a?(Array)
+                  value = value.split("|") if value&.include?("|")
+                  into_a(value)
+                end.def_serializer do |value|
+                  into_a(value).join("|")
+                end
+              end
+            end
+
+            private
+            
+            def into_a(value)
+              value = [] if value == nil
+              value = [].push(value) unless value.is_a?(Array)
+              value
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Eco
+  module API
+    module Common
+      module People
+        class DefaultParsers
+          class NumericParser < People::BaseParser
+
+            def process
+              @parsers.define_attribute(:number, dependencies: @options) do |parser|
+                parser.def_parser  do |value, deps|
+                  deps[:schema]&.fields[deps["attr"]].parse_text(value)
+                end.def_serializer do |value|
+                  value.is_a?(Array) ? value.map { |v| v.to_s } : value.to_s
+                end
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Eco
+  module API
+    module Common
+      module People
+        class DefaultParsers
+          class SelectParser < People::BaseParser
+
+            def process
+              @parsers.define_attribute(:select, dependencies: @options) do |parser|
+                parser.def_parser  do |value, deps|
+                  options_hash = deps[:select_hashes][deps["attr"]]
+                  next value if !options_hash
+                  if value.is_a?(Array)
+                    value.map { |v| options_hash[v&.downcase.strip] || v }
+                  elsif value
+                    options_hash[value&.downcase.strip] || value
+                  end
+                end.def_serializer do |value|
+                  value
+                end
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,120 @@
+module Eco
+  module API
+    module Common
+      module People
+        class EntryFactory
+
+          attr_reader :person_parser
+
+          def initialize(schema:, person_parser: nil, fields_mapper: nil, logger: ::Logger.new(IO::NULL))
+            raise "Constructor needs a PersonSchema. Given: #{schema}" if !schema.is_a?(Ecoportal::API::V1::PersonSchema)
+            raise "Expecting PersonParser. Given: #{person_parser}" if person_parser && !person_parser.is_a?(Eco::API::Common::People::PersonParser)
+            raise "Expecting Mapper object. Given: #{fields_mapper}" if fields_mapper && !fields_mapper.is_a?(Eco::Data::Mapper)
+
+            @logger = logger
+            @schema = Ecoportal::API::V1::PersonSchema.new(JSON.parse(schema.doc.to_json))
+
+            default_parser = Eco::API::Common::People::DefaultParsers.new(schema: @schema)
+            @parser = default_parser.merge(person_parser)
+
+            @fields_mapper = fields_mapper
+          end
+
+          def new(data, dependencies: {})
+            PersonEntry.new(data, parser: @parser, mapper: @fields_mapper, dependencies: dependencies, logger: @logger)
+          end
+
+          def entries(data)
+            Entries.new(data, klass: PersonEntry, factory: self)
+          end
+        end
+
+        class Entries <  Eco::Language::Models::Collection
+
+          # build the shortcuts of Collection
+          attr_collection :id, :external_id, :email, :name, :supervisor_id
+
+          alias_method :entries, :to_a
+
+          include Common::People
+
+          def initialize(data = [], klass:, factory:)
+            super(data, klass: klass, factory: factory)
+            @caches_init = false
+          end
+
+          def [](id_or_ext)
+            self.id(id_or_ext) || self.external_id(id_or_ext)
+          end
+          #def []=(id, value)
+          #  if self.id?(id)
+          #end
+
+          def id(*args)
+            attr('id', *args).first
+          end
+
+          def external_id(*args)
+            attr('external_id', *args).first
+          end
+
+          def entry(id: nil, external_id: nil, email: nil)
+            init_caches
+            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?
+            pers
+          end
+
+          def find(object)
+            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)
+          end
+
+          def exclude(object)
+            exclude_people(into_a(object))
+          end
+
+          def exclude_people(list)
+            discarded = list.map do |person|
+              find(person)
+            end.compact
+            newFrom self.to_a - discarded
+          end
+
+          def email_id_maps
+            self.email_present.group_by(:email).transform_values { |person| person.id }
+          end
+
+          def group_by_supervisor
+            self.to_h(:supervisor_id)
+          end
+
+          def to_h(attr)
+            super(attr || "id")
+          end
+
+          protected
+
+          def on_change
+            @caches_init = false
+          end
+
+          private
+
+          def init_caches
+            return if @caches_init
+            @by_id = self.to_h('id')
+            @by_external_id = self.to_h('external_id')
+            @by_email = self.to_h('email')
+            @caches_init = true
+          end
+
+        end
+      end
+    end
+  end
+end