eco-helpers 2.0.66 → 2.0.68

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e18955e051a52bf3b075eda58c3e4542cbaa47fad47a2c8be75531fc6ff7d60
-  data.tar.gz: f73bc2e84b1502c0d07d0930822b84ed1850f24023ee579bf893abc9c9d5a1be
+  metadata.gz: 4252ad8eca24aa081cf86912ec2eb3e8a2417e9221d887700cb1f0572de62e62
+  data.tar.gz: ff3b1ebcaf7e3e234a3c0a787a10634050acdbf1af2366d1bd799ebf1eb3316b
 SHA512:
-  metadata.gz: 373f6a6a0895abd0894f2d394dbe2b9e25fa00fda3ad6a9d50fa638a7259e0326ee2e23619803807075f448a2c98984a7804e95c4c15fe9263e6acb510f0033b
-  data.tar.gz: 706933565f9eeafd437136ff9159bbe6feb201f07b5f3adf0775eb8c1dfe7069d6f3ca95d724b36fea75a9d355dd7679ded4e4693320455e177425c42b6c6154
+  metadata.gz: 2f8f9ef76245e0ee390b8f9118ace7cf46cb071699d94b8dd56591e0df11314a81ba0e83d688e64e6a53d3cfba510de8be5559a4ed948a13806baa14d69e9d80
+  data.tar.gz: e3ed91fb997fe84596ae2775b5841637eaf70173c2c1767290c10fceef0a9b3417c66c2f17ff46459558ca1f21ae81f248a60e0fd977642b9c8d30acb2dcec63

data/CHANGELOG.md

@@ -1,24 +1,51 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [2.0.66] - 2022-08-11
+## [2.0.69] - 2022-09-xx
 
 ### Added
 ### Changed
 ### Fixed
- - `Eco::API::UseCases::DefaultCases::Samples::Sftp` manage exception when trying to access remote folder
 
-## [2.0.65] - 2022-08-11
+## [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
-  - Typo of a fix
+  - `Eco::API::Session::Config::Api`, the `org_id` is **not** a required parameter for `APIv2`
 
-## [2.0.64] - 2022-08-11
+## [2.0.67] - 2022-09-15
+
+### Added
+  - **dependency** to `ecoportal-api-graphql` **gem**
+  - Added integration for `GraphQL`
+    - `session.api(version: :graphql)`
+  - New base case `Eco::API::UseCases::GraphQL::Base` to create `GraphQL` use cases
 
 ### Changed
-  - Nothing
+  - `Eco::CSV#read`  and `Eco::CSV#parse` delegating `nil` row removal to sublcass `Eco::CSV::Table`
+  - **upgraded** dependency on `ecoportal-api-v2`
+
+### Fixed
+  - `Eco::API::Session::Config::SFTP#remote_folder` to have path separator always as `/`
+  - `Eco::CSV::Table`
+    - to delete rows with all `nil` values
+    - to keep `header` when file comes only with `header` row (with `0` count)
+
+## [2.0.66] - 2022-08-11
+
+### Fixed
+ - `Eco::API::UseCases::DefaultCases::Samples::Sftp` manage exception when trying to access remote folder
+
+## [2.0.65] - 2022-08-11
+
+### Fixed
+  - Typo of a fix
 
 ## [2.0.63] - 2022-08-11
 
@@ -32,7 +59,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,7 +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.30', '< 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 '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

@@ -12,6 +12,8 @@ module Eco
                 :v1
               when :v2, :oozes
                 :v2
+              when :graphql
+                :graphql
               else # :internal, :v0
                 :v0
               end
@@ -25,13 +27,17 @@ module Eco
                 Ecoportal::API::V1
               when :v2
                 Ecoportal::API::V2
+              when :graphql
+                Ecoportal::API::GraphQL
               else
               end
             end
 
           end
 
-          def initialize(name, key:, host:, version:, mode: :local, root:, user_key: nil, external_key: nil)
+          def initialize(name, root:, key:, host:, version:,
+            mode: :local, user_key: nil, external_key: nil,
+            email: nil, pass: nil, org_id: nil)
             super(nil)
             @root = root
             @apis = {}
@@ -42,6 +48,9 @@ module Eco
             self["mode"]         = mode
             self["user_key"]     = user_key
             self["external_key"] = external_key
+            self["email"]        = email
+            self["pass"]         = pass
+            self["org_id"]       = org_id
           end
 
           # @return [Eco::API::Session::Config] the `root` config
@@ -103,6 +112,18 @@ module Eco
             (version == :v0) && self["key"]
           end
 
+          def org_id
+            self["org_id"]
+          end
+
+          def email
+            self["email"]
+          end
+
+          def pass
+            self["pass"]
+          end
+
           def host
             self["host"]
           end
@@ -147,10 +168,12 @@ module Eco
               klass.new(external_key, host: host, logger: logger)
             when :v2
               klass.new(user_key: user_key, org_key: external_key, host: host, logger: logger)
+            when :graphql
+              klass.new(org_id: org_id, email: email, pass: pass)
             end.tap do |api|
               unless !api || log_connection?
                 @logger.info("Created api#{self.version(version)} connection on '#{name}' enviro, pointing to '#{host}' in '#{mode}' mode")
-                api.logger.level = ::Logger::UNKNOWN
+                api.logger.level = ::Logger::UNKNOWN if api.respond_to?(:logger)
               end
             end
           end
@@ -163,14 +186,15 @@ module Eco
             when :v1
               external_key && host
             when :v2
-              external_key && user_key
+              external_key && user_key && host
+            when :graphql
+              email && pass && org_id && host
             end
           end
 
           def log_connection?
             config.logger.log_connection?
           end
-
         end
       end
     end

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

@@ -26,7 +26,9 @@ module Eco
             end
           end
 
-          def add(name, key:, host:, version: :internal, mode: :local, user_key: nil, external_key: nil)
+          def add(name, key:, host:, version: :internal,
+            mode: :local, user_key: nil, external_key: nil,
+            email: nil, pass: nil, org_id: nil)
             apis[name] = Session::Config::Api.new(
               name,
               key:      key,
@@ -35,7 +37,10 @@ module Eco
               mode:     mode,
               root:     self,
               user_key: user_key,
-              external_key: external_key
+              external_key: external_key,
+              email:    email,
+              pass:     pass,
+              org_id:   org_id
             )
             self
           end

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

@@ -62,7 +62,7 @@ module Eco
           end
 
           def remote_folder
-            File.join(*[base_path, enviro_subpath].compact)
+            [base_path, enviro_subpath].compact.join("/")
           end
         end
       end

data/lib/eco/api/usecases/graphql/base.rb

@@ -0,0 +1,26 @@
+class Eco::API::UseCases::GraphQL::Base < Eco::API::Common::Loaders::UseCase
+  name "graphql-base"
+  type :other
+
+  attr_reader :session, :options, :usecase
+
+  def main(session, options, usecase)
+    options[:end_get] = false
+    @session = session; @options = options; @usecase = usecase
+    process
+  end
+
+  # Write here your script
+  def process
+    raise "You need to inherit from this class ('#{self.class}') and call super with a block"
+  end
+
+  def graphql
+   @graphql ||= session.api(version: :graphql)
+  end
+
+  def exit_error(msg)
+    logger.error(msg)
+    exit(1)
+  end
+end

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

@@ -0,0 +1,10 @@
+module Eco
+  module API
+    class UseCases
+      module GraphQL
+      end
+    end
+  end
+end
+
+require_relative 'graphql/base'

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/api/usecases.rb

@@ -164,3 +164,4 @@ require_relative 'usecases/use_case_io'
 require_relative 'usecases/default_cases'
 require_relative 'usecases/ooze_samples'
 require_relative 'usecases/ooze_cases'
+require_relative 'usecases/graphql'

data/lib/eco/api.rb

@@ -1,5 +1,6 @@
 require 'ecoportal/api'
 require 'ecoportal/api-v2'
+require 'ecoportal/api-graphql'
 
 module Eco
   module API

data/lib/eco/csv/table.rb

@@ -1,11 +1,14 @@
 module Eco
   class CSV
     class Table < ::CSV::Table
-
       # @param input [Array<Row>, Array<Array>, Eco::CSV::Table, ::CSV::Table]
       #   - when `Array<Array>` => all `rows` as arrays where first array is the **header**
       def initialize(input)
         super(to_rows_array(input))
+        self.delete_if do |row|
+          values = row.fields
+          values.all?(&:nil?) || values.map(&:to_s).all?(&:empty?)
+        end
       end
 
       # @return [Hash] where keys are the groups and the values a `Eco::CSV::Table`
@@ -178,8 +181,9 @@ module Eco
       private
 
       def columns_to_table(columns_array)
-        data = to_rows_array(columns_array.transpose)
-        self.class.new(data)
+        rows_data = columns_array.transpose
+        return self.class.new(rows_data) if rows_data.length > 0
+        raise ArgumentError.new("Expecting 'columns_array' to at least have header. Given: #{columns_array}")
       end
 
       def to_rows_array(data)
@@ -200,6 +204,7 @@ module Eco
             data
           when Array
             headers  = data.shift
+            data.push(Array.new(headers.length)) if data.count == 0
             data.map do |arr_row|
               ::CSV::Row.new(headers, arr_row)
             end.compact

data/lib/eco/csv.rb

@@ -8,34 +8,19 @@ module Eco
       # @return [Eco::CSV::Table]
       def parse(data, **kargs, &block)
         kargs = {headers: true, skip_blanks: true}.merge(kargs)
-        out = super(data, **kargs, &block).reject do |row|
-          values = row.to_hash.values
-          values.all?(&:nil?) || values.map(&:to_s).all?(&:empty?)
-        end
-        Eco::CSV::Table.new(out)
+        Eco::CSV::Table.new(super(data, **kargs, &block))
       end
 
       # @return [Eco::CSV::Table]
       def read(file, **kargs)
         kargs = {headers: true,  skip_blanks: true}.merge(kargs)
-
         args = [file].tap do |arg|
           encoding = Eco::API::Common::Session::FileManager.encoding(file)
-          #encoding = (encoding != "utf-8")? "#{encoding}|utf-8": encoding
-          #arg.push(encoding)
           arg.push("rb:bom|utf-8") if encoding == "bom"
         end
-
-        out = super(*args, **kargs).reject do |row|
-          values = row.to_hash.values
-          values.all?(&:nil?) || values.map(&:to_s).all?(&:empty?)
-        end
-        Eco::CSV::Table.new(out)
+        Eco::CSV::Table.new(super(*args, **kargs))
       end
-
     end
-
-
   end
 end
 

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = "2.0.66"
+  VERSION = "2.0.68"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.66
+  version: 2.0.68
 platform: ruby
 authors:
 - Oscar Segura
@@ -136,7 +136,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.30
+        version: 0.8.32
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -146,10 +146,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.30
+        version: 0.8.32
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: ecoportal-api-graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
@@ -565,6 +585,8 @@ files:
 - lib/eco/api/usecases/default_cases/update_case.rb
 - lib/eco/api/usecases/default_cases/update_details_case.rb
 - lib/eco/api/usecases/default_cases/upsert_case.rb
+- lib/eco/api/usecases/graphql.rb
+- lib/eco/api/usecases/graphql/base.rb
 - lib/eco/api/usecases/ooze_cases.rb
 - lib/eco/api/usecases/ooze_cases/export_register_case.rb
 - lib/eco/api/usecases/ooze_samples.rb