eco-helpers 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c80ae3aadfdbce22868e7a60c6c6a979bfcad0169fffccb47a6a412bbd7c5788
-  data.tar.gz: ec19d4b61fe40b33e4fc1b7ac1deba98110c901e573c4c3c421c6f28409e0b46
+  metadata.gz: 8824e93753de01f752b0b655339fcc09ddf4da24dfdad76b25cadb25bed11225
+  data.tar.gz: 9db399712ea74e57ea62c696802f2dcf80e8fe01dd476f18edc4a938a66ca4ab
 SHA512:
-  metadata.gz: 2732b578b4f14b62442d525ca028d11fbba6c888614a85975b3a01f4fc988e7c967b187fe7289e1a3506e56c6067d28ad40a97ecf8c5d52641d2232e504a88db
-  data.tar.gz: 55a0ef82cfa791f4fb7c88588a9dc90b082cc162aeb208bb22c835e2d2d4c1171ce576378e7c13bdb4e9d64632f97dd00ba1346667b3ae91198f40da6f35c7c8
+  metadata.gz: d655f7beb82c00655a86d3e75e0444d4e0eb9f233a8e8b265413384d41e50c5e985ecd0588f37fb3e45209a296f9a4a8f6d02a90bb2cea8e7d09b6da2385a509
+  data.tar.gz: 325555d794297d40c3bfaffb8e3f500d622b3f16c274ad71001c0b56235a2560168cd6e18ce1fdfe5284bf0c91e75c5f0127b179e425f54195191629973d5349

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

@@ -54,21 +54,37 @@ module Eco
             @internal_entry["id"]
           end
 
+          def id?
+            @internal_entry.key?("id")
+          end
+
           # @return [String, nil] the _external id_ of this person if defined.
           def external_id
             @internal_entry["external_id"]
           end
 
+          def external_id?
+            @internal_entry.key?("external_id")
+          end
+
           # @return [String, nil] the _name_ of this person if defined.
           def name
             @internal_entry["name"]
           end
 
+          def name?
+            @internal_entry.key?("name")
+          end
+
           # @return [String, nil] the _email_ of this person if defined.
           def email
             @internal_entry["email"]
           end
 
+          def email?
+            @internal_entry.key?("email")
+          end
+
           # @return [String, nil] the _supervisor id_ of this person if defined.
           def supervisor_id
             @internal_entry["supervisor_id"]
@@ -78,6 +94,19 @@ module Eco
             @internal_entry["supervisor_id"] = value
           end
 
+          def supervisor_id?
+            @internal_entry.key?("supervisor_id")
+          end
+
+          def filter_tags
+            @internal_entry["filter_tags"]
+          end
+
+          def filter_tags?
+            @internal_entry.key?("filter_tags")
+          end
+
+
           # Provides a reference of this person.
           # @return [String] string summary of this person identity.
           def to_s(options)
@@ -229,7 +258,8 @@ module Eco
             return nil if !person.account
             multiple = ["policy_group_ids", "filter_tags"].include?(attr)
             value = person.account.send(attr)
-            @person_parser.serialize(:multiple, value) if multiple
+            value = @person_parser.serialize(:multiple, value) if multiple
+            value
           end
 
           def _get_from_details(person, attr)
@@ -296,7 +326,7 @@ module Eco
           # @param aliased_entry [Hash] the entry with the _internal attribute_ names but the _external values_.
           # @return [Hash] the `internal entry` with the **internal** attributes names and values.
           def _parsed_entry(aliased_entry)
-            parsed = @person_parser.defined_attrs.map do |attr|
+            parsed = @person_parser.active_attrs(aliased_entry).map do |attr|
               value = @person_parser.parse(attr, aliased_entry)
               [attr, value]
             end.to_h

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

@@ -85,6 +85,7 @@ module Eco
           end
 
           # Returns a list of all the internal attributes of the model that have a parser defined & that should be active.
+          # @param [Hash, Array<String>]
           # @return [Array<String>] list of all attribute defined parsers that should be active.
           def active_attrs(source_data)
             defined_attrs.select {|attr| @parsers[attr].parser_active?(source_data)}

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

@@ -18,7 +18,7 @@ module Ecoportal
           when Internal::Account
             doc["account"] = JSON.parse(value.to_json)
           when Hash
-            doc["account"] = value.slice(*%w[policy_group_ids landing_page_id permissions_preset permissions_custom preferences prefilter filter_tags login_provider_ids starred_ids])
+            doc["account"] = value.slice(*%w[policy_group_ids landing_page_id permissions_preset permissions_custom preferences prefilter filter_tags default_tag login_provider_ids starred_ids])
           else
             # TODO
             raise "Invalid set on account: Need nil, Account or Hash; got #{value.class}"

data/lib/eco/api/session.rb

@@ -2,9 +2,13 @@ module Eco
   module API
     class Session < Common::Session::BaseSession
       attr_reader   :batch
-      attr_reader   :usecases
       attr_accessor :schema
 
+      # Class to manage the current session.
+      # Central helper of resources.
+      #
+      # @attr_reader batch [Eco::API::Session::Batch] provides helper to launch batch operations.
+      # @attr_reader schema [Ecoportal::API::V1::PersonSchema] currently active schema.
       def initialize(init = {})
         e = init
         msg = "Expected object Eco::API::Session::Config or Eco::API::Common::Session::Environment. Given: #{init}"
@@ -29,7 +33,8 @@ module Eco
         })
       end
 
-      # TASKS & JOBS
+      # Helper to perform multiple operations in one go.
+      # @return [Eco::API::Session::Task] provides shortcuts to manage certain kind of operations.
       def do
         @task
       end
@@ -52,18 +57,24 @@ module Eco
         end
       end
 
+      # @see Eco::API::Session::Config#policy_groups
       def policy_groups
         config.policy_groups
       end
 
+      # @see Eco::API::Session::Config#tagtree
       def tagtree
         config.tagtree(enviro: enviro)
       end
 
+      # @see Eco::API::Session::Config#schemas
       def schemas
         config.schemas
       end
 
+      # Sets the current target `PersonSchema` of this session.
+      # @note observe that it is essential for the parsers/serialisers to identify target/present attributes.
+      # @param schema [String, Ecoportal::API::V1::PersonSchema] where `String` can be the _name_ or the _id_ of the schema.
       def schema=(value)
         case value
         when String
@@ -97,6 +108,10 @@ module Eco
         self
       end
 
+      # Builds the presets using the usergroup ids of the input.
+      # @note for each flag/ability it will take the highest among those mapped for the present usergroups.
+      # @param [Ecoportal::API::Internal::Person, Array<String>] the array should be of usegroup names or ids.
+      # @return [Hash] with custom presets.
       def new_preset(input)
         case input
         when Ecoportal::API::Internal::Person
@@ -112,24 +127,38 @@ module Eco
         @entry_factory.export(*args)
       end
 
+      # @see Eco::API::Common::People::EntryFactory#new
+      # @return [Ecoportal::API::Internal::Person]
       def new_person(**keyed_args)
         @person_factory.new(**keyed_args)
       end
 
+      # Builds the entry for the given data.
+      # @see Eco::API::Common::People::EntryFactory#new
+      # @return [Eco::API::Common::People::PersonEntry] parsed entry.
       def new_entry(data, dependencies: {})
         @entry_factory.new(data, dependencies: dependencies)
       end
 
+      # @see Eco::API::Common::People::EntryFactory#entries
+      # @return [Eco::API::Common::People::Entries] collection of entries.
       def entries(*args)
         @entry_factory.entries(*args).tap do |collection|
           logger.info("Loaded #{collection.length} input entries.")
         end
       end
 
+      # Generates an entries collection from a csv input file.
+      # @see Eco::API::Common::People::EntryFactory#entries
+      # @param file [String] file to generate the entries from.
+      # @return [Eco::API::Common::People::Entries] collection of entries.
       def csv_entries(file)
         return entries(file: file, format: :csv)
       end
 
+      # Generates the collection of entries that should be discarded from an update.
+      # @note requires `session.config.people.discarded_file` to be defined.
+      # @return [Eco::API::Common::People::Entries] collection of entries.
       def discarded_entries
         return @discarded_entries if instance_variable_defined?(:@discarded_entries)
         file = config.people.discarded_file

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "0.9.4"
+  VERSION = "0.9.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Oscar Segura
@@ -396,7 +396,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: eco-helpers to manage people api cases