eco-helpers 2.0.68 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4252ad8eca24aa081cf86912ec2eb3e8a2417e9221d887700cb1f0572de62e62
-  data.tar.gz: ff3b1ebcaf7e3e234a3c0a787a10634050acdbf1af2366d1bd799ebf1eb3316b
+  metadata.gz: 65d5ec6baab743f216afd4ca77a4d36f9a43a52e841f0c2ca9ef73f63e3423b1
+  data.tar.gz: 5906de7dd2f2765c6222ac707b42b6b270914b40c964e7ba579966652a418e72
 SHA512:
-  metadata.gz: 2f8f9ef76245e0ee390b8f9118ace7cf46cb071699d94b8dd56591e0df11314a81ba0e83d688e64e6a53d3cfba510de8be5559a4ed948a13806baa14d69e9d80
-  data.tar.gz: e3ed91fb997fe84596ae2775b5841637eaf70173c2c1767290c10fceef0a9b3417c66c2f17ff46459558ca1f21ae81f248a60e0fd977642b9c8d30acb2dcec63
+  metadata.gz: e0494e227d268046a78fb6bf2df120506056bf96bf09464816ebc3a2fb2e6907e89729ed9c9ab848d93bfb9b53bdcf7f3c220c60847ffb403e54f663eca4c3c6
+  data.tar.gz: 26b09ee8c9eb63b9cd91772d55f1c52bdc941bff59e83da809d80272978eb8f62d687caf4417404a32d494e2853644b2e3532a151b81f001bc6b9b87f3263067

data/CHANGELOG.md

@@ -1,12 +1,37 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.69] - 2022-09-xx
+## [2.1.3] - 2022-09-xx
 
 ### Added
 ### Changed
 ### Fixed
 
+## [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
+  - `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

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.32', '< 0.9'
-  spec.add_dependency 'ecoportal-api-graphql', '>= 0.1.6', '< 0.2'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.9.2', '< 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

@@ -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_params?(version)
+          end
+
           def version(value = nil)
             self.class.to_version(value || self["version"])
           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
@@ -227,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
@@ -234,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/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/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.68"
+  VERSION = "2.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.68
+  version: 2.1.2
 platform: ruby
 authors:
 - Oscar Segura
@@ -136,27 +136,27 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.32
+        version: 0.9.2
     - - "<"
       - !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.32
+        version: 0.9.2
     - - "<"
       - !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.6
+        version: 0.1.10
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.2'
@@ -166,7 +166,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 0.1.10
     - - "<"
       - !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