eco-helpers 2.1.1 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b298bca88b1ee202218bf3e0ab5727db52d8893a4ea969deda1179198b02ddf
-  data.tar.gz: dd183eb58a6481851fde1fe257217541a175b4524f61ed1c61c9dff131d484b5
+  metadata.gz: bd18bdf6133a2fa0ccc023a3bdf11140b9af98364bfa6327f171e93373ee51f0
+  data.tar.gz: 4918192e55fe12081ba8db062b2bdcaf8afd1058732a93d23cd1180015af623a
 SHA512:
-  metadata.gz: 4d73a73a2dba773d09b83d0713e71f333f44e83acb51c5e6fbde83fbff60350c468ae5a79d60eaf4a9fd446b7416e5bd38ed181769e221df893b20b1a84afc50
-  data.tar.gz: 7a157045ebf97b9d0b10dadc5f1951a4eed311cd03335ac9f9b85288ef4fe3aa71bb7939e2266f124a9ee6687076bc5fc0afbaecff213ed2af45f11988b6543f
+  metadata.gz: 8bdd14bfa761ce494c920bd4242d49b9bfb37eb91b2021a7f1d4799b10e09a3d0af66491aca287c8d15874d436a77e9e94e4b1237e3925795b48b2df7876ec92
+  data.tar.gz: 06cc22d088ef35c755ed554578c58357782443a48ba0542fe21c13dc332b87123fb244bd8f98f805e9801b011cec309e33166c57876c7456cb101bf1bbd37867

data/CHANGELOG.md

@@ -1,13 +1,42 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.1.2] - 2022-09-xx
+## [2.1.4] - 2022-10-xx
 
 ### Added
 ### Changed
 ### Fixed
 
-## [2.1.1] - 2022-09-xx
+## [2.1.3] - 2022-10-11
+
+### Added
+  - `Eco::API::UseCases::OozeSamples::OozeBaseCase`
+    - `with_fields`, `with_sections` and `add_field` accept an `entry` parameter
+    - also did some internal refactor
+    
+### Changed
+  - Upgraded `ecoportal-api-v2` **gem**
+
+### Fixed
+  - `Eco::API::UseCases::OozeSamples::RegisterUpdateCase`
+    - account for stages with updates within same entry
+
+## [2.1.2] - 2022-09-29
+
+### Added
+  - `Ecoportal::API::Session::Config#live_tree` to retrieve the tagtree of the back-end
+    - Requires `graphql` connection parameters
+  - `Ecoportal::API::Session#live_tree` see above
+
+### Changed
+  - `Ecoportal::API::Session::Config#tagtree` to use `#live_tree` if there isn't a `tagtree.json` file
+  - upgraded **dependency** to `ecoportal-api-graphql` **gem**
+  - upgraded **dependency** to `ecoportal-api-v2` **gem**
+
+### Fixed
+  - `Ecoportal::API::Session::Config::API#version_available?` **typo**
+
+## [2.1.1] - 2022-09-26
 
 ### Added
   - `Eco::API::Session::Config::Api#version_available?` to know if a version is available for use

data/eco-helpers.gemspec

@@ -31,8 +31,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
 
   spec.add_dependency 'ecoportal-api', '>= 0.8.5', '< 0.9'
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.9.1', '< 0.10'
-  spec.add_dependency 'ecoportal-api-graphql', '>= 0.1.9', '< 0.2'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.9.3', '< 0.10'
+  spec.add_dependency 'ecoportal-api-graphql', '>= 0.1.10', '< 0.2'
   spec.add_dependency 'aws-sdk-s3',    '>= 1.83.0', '< 2'
   spec.add_dependency 'aws-sdk-ses',   '>= 1.36.0', '< 2'
   spec.add_dependency 'dotenv',        '>= 2.7.6', '< 2.8'

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

@@ -145,7 +145,7 @@ module Eco
 
           # @return [Boolean] whether or not `version` is available
           def version_available?(version)
-            api_paramms?(version)
+            api_params?(version)
           end
 
           def version(value = nil)

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

@@ -228,6 +228,7 @@ module Eco
           org["tagtree"] = file
         end
 
+        # It uses the `tagtree.json` file and in its absence, if `graphql` enabled, the `life_tagtree`
         # @return [Eco::API::Organization::TagTree]
         def tagtree(enviro: nil)
           return @tagtree if instance_variable_defined?(:@tagtree) && @tagtree.enviro == enviro
@@ -235,6 +236,23 @@ module Eco
             tree      = []
             tree      = file_manager.load_json(tree_file) unless !tree_file
             @tagtree  = Eco::API::Organization::TagTree.new(tree, enviro: enviro)
+          else
+            @tagtree = live_tree(enviro: enviro)
+          end
+        end
+
+        # It obtains the first of the live tagtree in the org
+        # @note it requires graphql connection configuration parameters
+        # @return [Eco::API::Organization::TagTree]
+        def live_tree(enviro: nil)
+          return @live_tree if instance_variable_defined?(:@live_tree) && @live_tree.enviro == enviro
+          if apis.active_api.version_available?(:graphql)
+            graphql = apis.api(version: :graphql)
+            if tree = graphql.currentOrganization.tagTrees.to_a.first.treeify
+              @live_tree  = Eco::API::Organization::TagTree.new(tree, enviro: enviro)
+            else
+              @live_tree = nil
+            end
           end
         end
 

data/lib/eco/api/session.rb

@@ -44,6 +44,11 @@ module Eco
         config.tagtree(enviro: enviro)
       end
 
+      # @see Eco::API::Session::Config#live_tree
+      def live_tree
+        config.live_tree
+      end
+
       # @see Eco::API::Session::Config#schemas
       def schemas
         config.schemas

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

@@ -46,30 +46,30 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
     ooze(ooze_id, stage_id: stage_id)
   end
 
-  def add_field_by_doc(doc, section, after: nil, before: nil, side: :left)
+  def add_field_by_doc(doc, section, entry: target, after: nil, before: nil, side: :left)
     unless section.is_a?(Ecoportal::API::V2::Page::Section)
       raise "You need to specify a section for a new field. Given: #{section.class}"
     end
-    target.components.add(doc: doc) do |field|
+    entry.components.add(doc: doc) do |field|
       section.add_component(field, after: after, before: before, side: side)
     end.tap do |field|
       yield(field) if block_given?
     end
   end
 
-  def add_field(name, type, section, after: nil, before: nil, side: :left)
+  def add_field(name, type, section, entry: target, after: nil, before: nil, side: :left)
     unless section.is_a?(Ecoportal::API::V2::Page::Section)
       raise "You need to specify a section for a new field. Given: #{section.class}"
     end
-    target.components.add(label: name, type: type) do |field|
+    entry.components.add(label: name, type: type) do |field|
       section.add_component(field, after: after, before: before, side: side)
     end.tap do |field|
       yield(field) if block_given?
     end
   end
 
-  def with_fields(type: nil, label: nil)
-    flds = target.components
+  def with_fields(entry = target, type: nil, label: nil)
+    flds = entry.components
     flds = flds.get_by_type(type) if type
     flds = flds.select do |fld|
       value = (label == :unnamed) ? nil : label
@@ -79,8 +79,8 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
     end
   end
 
-  def with_sections(type: nil, heading: nil)
-    secs = target.sections
+  def with_sections(entry = target, type: nil, heading: nil)
+    secs = entry.sections
     secs = secs.get_by_type(type) if type
     secs = secs.select do |sec|
       value = (heading == :unnamed) ? nil : heading
@@ -141,7 +141,10 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
   # It fill update the ooze only if it's dirty (it carries changes)
   # @return [Boolean, Response] `false` if there was not request against the server, `Response` otherwise
   def update_ooze(ooze = target)
-    if !options[:simulate]
+    if options[:simulate]
+      dry_run_feedback(ooze)
+      false
+    else
       return false unless dirty?(ooze)
 
       ooze.validate.tap do |validation|
@@ -156,19 +159,6 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
           logger.error("Could not update #{object_reference(ooze)} (created_at: #{ooze.created_at}: #{response.body}")
         end
       end
-    else
-      ooze.validate.tap do |validation|
-        logger.error(validation) if validation.is_a?(String)
-      end
-      unless options.dig(:feedback, :only_stats)
-        if patch = (patch_doc(ooze) || {})["page"]
-          pp patch
-        end
-      end
-
-      backup_patch!(ooze)
-      exit(0) if dirty?(ooze) && dry_count > DRY_COUNT
-      false
     end
   end
 
@@ -204,6 +194,14 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
     puts "Saved patch at: #{File.expand_path(SAVE_PATCH)}"
   end
 
+  def display_patch(entry = target)
+    unless options.dig(:feedback, :only_stats)
+      if patch = (patch_doc(entry) || {})["page"]
+        pp patch
+      end
+    end
+  end
+
   def patch_doc(ooze = target)
     apiv2.pages.get_body(ooze)
   end
@@ -213,6 +211,19 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
     @dry_count += 1
   end
 
+  def dry_run_feedback(entry = target)
+    entry.validate.tap do |validation|
+      logger.error(validation) if validation.is_a?(String)
+    end
+    display_patch(entry)
+    backup_patch!(entry)
+    if dirty?(entry) && dry_count > self.class::DRY_COUNT
+      logger.info("Reached #{self.class::DRY_COUNT} dry-run samples.")
+      exit(0)
+    end
+    false
+  end
+
   def apiv2
    @apiv2 ||= session.api(version: :oozes)
   end

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

@@ -52,7 +52,15 @@ class Eco::API::UseCases::OozeSamples::RegisterUpdateCase < Eco::API::UseCases::
 
   def before_loading_new_target(ooze_id)
     if pending = queue_shift(ooze_id)
-      update_ooze(pending)
+      update_ooze(pending).tap do |result|
+        if result.is_a?(Ecoportal::API::Common::Response)
+          if result.success?
+            @updated_oozes += 1
+          else
+            @failed_update_oozes +=1
+          end
+        end
+      end
     end
   end
 

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.1.1"
+  VERSION = "2.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.3
 platform: ruby
 authors:
 - Oscar Segura
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.10'
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.10'
@@ -156,7 +156,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.9
+        version: 0.1.10
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.2'
@@ -166,7 +166,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.9
+        version: 0.1.10
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.2'