eco-helpers 2.0.67 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f70487179ebb87c5d44b0050fda66b5e87ed8a79d8e75c16cc5e5d9be131ec53
-  data.tar.gz: be65600c6f6f2f713322bc3dc2588814643fb2815bc026d8a2d2f757c435736e
+  metadata.gz: 7b298bca88b1ee202218bf3e0ab5727db52d8893a4ea969deda1179198b02ddf
+  data.tar.gz: dd183eb58a6481851fde1fe257217541a175b4524f61ed1c61c9dff131d484b5
 SHA512:
-  metadata.gz: c13a4b7998ca745cf3e5d9c44da3fda08ea4109963179887b51b0d1fc1281e3c3213e14734748418a147aa32395a5b2abc0a6229c45d806a290ab06b1eea20da
-  data.tar.gz: 33b060518fea320eb17c0a2cd6fc8bd528b8a7cfdd1779af643300aac53adb77dcbd200a1f70dad4ea28c51801d6427bf19b9ce7d676fddd8187401a68f266bf
+  metadata.gz: 4d73a73a2dba773d09b83d0713e71f333f44e83acb51c5e6fbde83fbff60350c468ae5a79d60eaf4a9fd446b7416e5bd38ed181769e221df893b20b1a84afc50
+  data.tar.gz: 7a157045ebf97b9d0b10dadc5f1951a4eed311cd03335ac9f9b85288ef4fe3aa71bb7939e2266f124a9ee6687076bc5fc0afbaecff213ed2af45f11988b6543f

data/CHANGELOG.md

@@ -1,7 +1,35 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.67] - 2022-08-11
+## [2.1.2] - 2022-09-xx
+
+### Added
+### Changed
+### Fixed
+
+## [2.1.1] - 2022-09-xx
+
+### Added
+  - `Eco::API::Session::Config::Api#version_available?` to know if a version is available for use
+  - `Eco::API::Session::Config::Apis`, added `#default_pass` and `#default_email` to use the `GraphQL` api.
+
+### Changed
+  - upgraded **dependency** to `ecoportal-api-graphql` **gem**
+  - upgraded **dependency** to `ecoportal-api-v2` **gem**
+
+## [2.0.68] - 2022-09-19
+
+### Added
+  - `Eco::API::UseCases::OozeSamples::OozeBaseCase`: **added** a couple of functions to support **page creation**: `#new_page` and `#create_page`
+
+### Changed
+  - upgraded **dependency** to `ecoportal-api-graphql` **gem**
+  - upgraded **dependency** to `ecoportal-api-v2` **gem**
+
+### Fixed
+  - `Eco::API::Session::Config::Api`, the `org_id` is **not** a required parameter for `APIv2`
+
+## [2.0.67] - 2022-09-15
 
 ### Added
   - **dependency** to `ecoportal-api-graphql` **gem**
@@ -21,23 +49,14 @@ All notable changes to this project will be documented in this file.
 
 ## [2.0.66] - 2022-08-11
 
-### Added
-### Changed
 ### Fixed
  - `Eco::API::UseCases::DefaultCases::Samples::Sftp` manage exception when trying to access remote folder
 
 ## [2.0.65] - 2022-08-11
 
-### Added
-### Changed
 ### Fixed
   - Typo of a fix
 
-## [2.0.64] - 2022-08-11
-
-### Changed
-  - Nothing
-
 ## [2.0.63] - 2022-08-11
 
 ### Changed
@@ -50,7 +69,6 @@ All notable changes to this project will be documented in this file.
     - `Eco::API::Common::Session::Sftp` fetches from config
     - `Eco::API::Session::Config::Sftp#password`
 
-### Changed
 ### Fixed
   - `Eco::API::UseCases::DefaultCases::CreateCase` had a typo
 

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.8.31', '< 0.9'
-  spec.add_dependency 'ecoportal-api-graphql', '>= 0.1.3', '< 0.2'
+  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 '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

@@ -3,9 +3,7 @@ module Eco
     class Session
       class Config
         class Api < Hash
-
           class << self
-
             def to_version(str)
               case str.to_sym
               when :external, :v1
@@ -32,7 +30,6 @@ module Eco
               else
               end
             end
-
           end
 
           def initialize(name, root:, key:, host:, version:,
@@ -117,11 +114,11 @@ module Eco
           end
 
           def email
-            self["email"]
+            self["email"] || @root.default_email
           end
 
           def pass
-            self["pass"]
+            self["pass"] || @root.default_pass
           end
 
           def host
@@ -146,6 +143,11 @@ module Eco
             !local?
           end
 
+          # @return [Boolean] whether or not `version` is available
+          def version_available?(version)
+            api_paramms?(version)
+          end
+
           def version(value = nil)
             self.class.to_version(value || self["version"])
           end
@@ -186,9 +188,9 @@ module Eco
             when :v1
               external_key && host
             when :v2
-              org_id && external_key && user_key
+              external_key && user_key && host
             when :graphql
-              email && pass && org_id
+              email && pass && org_id && host
             end
           end
 

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

@@ -3,7 +3,6 @@ module Eco
     class Session
       class Config
         class Apis < BaseConfig
-
           def apis
             self["apis"] ||= {}
           end
@@ -87,6 +86,22 @@ module Eco
             self["user_key"]
           end
 
+          def default_email=(email)
+            self["default_email"] = email
+          end
+
+          def default_email
+            self["default_email"] || ENV['USER_EMAIL']
+          end
+
+          def default_pass=(pass)
+            self["default_pass"] = pass
+          end
+
+          def default_pass
+            self["default_pass"] || ENV['USER_PASS']
+          end
+
           # Method to support CLI one-off API requests
           def one_off
             if one_off?
@@ -165,8 +180,6 @@ module Eco
             end
             return true
           end
-
-
         end
       end
     end

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

@@ -114,6 +114,7 @@ module Eco
         end
 
         # @see Eco::API::Session::Config::Apis#api
+        # @return [Eco::API::Session::Config::Api] the currently active api
         def api(logger = ::Logger.new(IO::NULL), version: nil)
           apis.api(logger, version: version)
         end

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

@@ -0,0 +1,44 @@
+class Eco::API::UseCases::DefaultCases::TagTree < Eco::API::Common::Loaders::UseCase
+  name "tagtree"
+  type :other
+
+  attr_reader :session, :options
+  def main(session, options, usecase)
+    puts "Use case still in development"
+    exit
+    options[:end_get] = false
+    @session = session; @options = options
+    operations.keys.each do |key|
+      process(key)
+    end
+  end
+
+  def process(key)
+    case key
+    when :diff
+      require_graphql_auth!
+
+    when :show_backend
+      require_graphql_auth!
+
+    else
+      logger.warn("Operation #{key} not supported")
+    end
+  end
+
+  private
+
+  def require_graphql_auth!
+    unless session.config.api.version_available?(:graphql)
+      logger.error("Missing parameters for to configure a GraphQL connexion.")
+    end
+  end
+
+  def operations
+    (options.dig(:tagtree, :operations) || {})
+  end
+
+  def graphql
+   @graphql ||= session.api(version: :graphql)
+  end
+end

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

@@ -42,6 +42,7 @@ require_relative 'default_cases/set_supervisor_case'
 require_relative 'default_cases/supers_hierarchy_case'
 require_relative 'default_cases/supers_cyclic_identify_case'
 require_relative 'default_cases/switch_supervisor_case'
+require_relative 'default_cases/tagtree_case'
 require_relative 'default_cases/to_csv_case'
 require_relative 'default_cases/to_csv_detailed_case'
 require_relative 'default_cases/transfer_account_case'

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

@@ -29,6 +29,23 @@ class Eco::API::UseCases::OozeSamples::OozeBaseCase < Eco::API::Common::Loaders:
 
   protected
 
+  def new_page(template_id)
+    apiv2.pages.get_new(template_id)
+  end
+
+  def create_page(page = nil, template_id: nil, retrieve: false)
+    template_id = template_id.id if template_id.is_a?(Ecoportal::API::V2::Page)
+    template_id ||= page.template_id if page.respond_to?(:template_id)
+    template_id ||= page["template_id"] if page.is_a?(Hash)
+    page = new_page(template_id) unless page || !template_id
+    yield(page) if block_given?
+    reference = apiv2.pages.create(page, from: template_id)
+    ooze_id   = reference.page_id
+    stage_id  = reference.active_stage_id
+    return [ooze_id, stage_id] unless retrieve
+    ooze(ooze_id, stage_id: stage_id)
+  end
+
   def add_field_by_doc(doc, section, 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}"

data/lib/eco/cli/config/default/usecases.rb

@@ -87,6 +87,14 @@ ASSETS.cli.config do |cnf|
       options.deep_merge!(other: {file: {codes_column: col_codes}})
     end
 
+    desc = "Allows to perform some checks on tagtree structure (requires GraphQL)"
+    cases.add("-tagtree", :other, desc, case_name: "tagtree")
+    .add_option("-show-backend", "Displays the tagtree as per back-end") do |options|
+      options.deep_merge!(tagtree: {operation: {show_backend: true}})
+    end.add_option("-diff", "Compares the tagtree.json file with the back-end") do |options|
+      options.deep_merge!(tagtree: {operation: {diff: true}})
+    end
+
     desc = "Creates a CSV with the paths to each tag"
     cases.add("-create-tag-paths", :other, desc, case_name: "create-tag-paths")
 

data/lib/eco/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.67
+  version: 2.1.1
 platform: ruby
 authors:
 - Oscar Segura
@@ -136,27 +136,27 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.31
+        version: 0.9.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.31
+        version: 0.9.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: ecoportal-api-graphql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.9
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.2'
@@ -166,7 +166,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.9
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.2'
@@ -579,6 +579,7 @@ files:
 - lib/eco/api/usecases/default_cases/supers_cyclic_identify_case.rb
 - lib/eco/api/usecases/default_cases/supers_hierarchy_case.rb
 - lib/eco/api/usecases/default_cases/switch_supervisor_case.rb
+- lib/eco/api/usecases/default_cases/tagtree_case.rb
 - lib/eco/api/usecases/default_cases/to_csv_case.rb
 - lib/eco/api/usecases/default_cases/to_csv_detailed_case.rb
 - lib/eco/api/usecases/default_cases/transfer_account_case.rb