eco-helpers 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f87b772a3ca7272d32299e202d5f0a500f4e814b5281e00d2e49484a52fa42df
-  data.tar.gz: dde02113e49cc438157123b892b5ab2e747707f824ec0b228240a1f8aacebe29
+  metadata.gz: c1a2d4588e054806a3ccbebd04efd0b8bdb25b750e18e26ed69a29e6f219a552
+  data.tar.gz: 5828f9d271d41cd18f8f0b684d4711c18c7edfaa906910566145141d8dd3c869
 SHA512:
-  metadata.gz: 3cc9947ab00adc1881db3a69cbe0873b5a2ec1275c92d3127f5826b5acb96db5b9b72cdc4297a0658172cdd321cdd46c4f02fddb7b93f05296ad2d2be2509298
-  data.tar.gz: '0330899821bab587d827d9079638e9cef5528f8c01e68aab5379e7d358b9de7dffb18ed6b49f12268737b953c4bb95419cbf0c4816b96dcf819d03857880d451'
+  metadata.gz: 2c293216d07c3553ff786c9c46019de87b5ef142a19e4b9ae709527b257c279534d7e21f737c824586263cbbc79c6983630bea7a1986d105f7665aec933b8ce4
+  data.tar.gz: a283d0285a0b370af02eeb3f75e1482e94a2774f58cbad3898f159a5152d999253dc8873abe1a41b6ced16238f8205f3e0d86a6d0655cd2de0a187d311acc5a5

data/.rubocop.yml

@@ -30,6 +30,9 @@ Style/ConditionalAssignment:
 Style/BlockDelimiters:
   BracesRequiredMethods: ['log']
   AllowedPatterns: ['proc', 'new']
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either
+  EnforcedStyle: no_mixed_keys
 Style/ClassAndModuleChildren:
   Enabled: false
 Style/FrozenStringLiteralComment:

data/CHANGELOG.md

@@ -2,12 +2,35 @@
 
 All notable changes to this project will be documented in this file.
 
-## [3.0.0] - 2024-08-01
+## [3.0.3] - 2024-08-xx
 
 ### Added
 
 ### Changed
 
+## [3.0.2] - 2024-08-09
+
+### Changed
+
+- upgraded gem dependencies
+  - `ecoportal-api-graphql`
+
+## [3.0.1] - 2024-08-09
+
+### Added
+
+- `GraphQLSchema` case to extract the schema in a json file
+
+### Changed
+
+- `SplitCsv` case namespace
+
+### Fixed
+
+- have `Eco::VERSION` defined
+
+## [3.0.0] - 2024-08-01
+
 - require `ruby 3`
 
 ### Fixed

data/eco-helpers.gemspec

@@ -40,8 +40,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'docx',          '>= 0.8.0', '< 0.9'
   spec.add_dependency 'dotenv',        '~> 3'
   spec.add_dependency 'ecoportal-api',         '~> 0.10'
-  spec.add_dependency 'ecoportal-api-graphql', '~> 0.4'
-  spec.add_dependency 'ecoportal-api-v2',      '~> 2.0'
+  spec.add_dependency 'ecoportal-api-graphql', '~> 0.4', '>= 0.4.1'
+  spec.add_dependency 'ecoportal-api-v2',      '~> 2.0', '>= 2.0.8'
   spec.add_dependency 'ed25519',       '~> 1.2'
   spec.add_dependency 'fast_excel',    '>= 0.5.0',  '< 0.6'
   spec.add_dependency 'fuzzy_match',   '>= 2.1.0',  '< 2.2'

data/lib/eco/api/usecases/default/meta/cli/graphql_schema_cli.rb

@@ -0,0 +1,15 @@
+class Eco::API::UseCases::Default::Meta::GraphQLSchema
+  class Cli < Eco::API::UseCases::Cli
+    desc "Retrieves and stores the GraphQL Schema"
+
+    callback do |_sess, options, _case|
+      file = SCR.get_arg(cli_name, with_param: true)
+      options.deep_merge!(output: {file: {name: file}})
+    end
+
+    add_option("-format", "Kind of extract (definition | json | yaml )") do |options|
+      format = SCR.get_arg("-format", with_param: true)
+      options.deep_merge!(output: {format: format})
+    end
+  end
+end

data/lib/eco/api/usecases/default/meta/graphql_schema.rb

@@ -0,0 +1,78 @@
+class Eco::API::UseCases::Default::Meta::GraphQLSchema < Eco::API::Common::Loaders::UseCase
+  include Eco::API::UseCases::GraphQL::Helpers::Base
+
+  require_relative 'cli/graphql_schema_cli'
+
+  OUT_FOLDER      = "sftp".freeze
+  OUT_TIME_FORMAT = '%Y%m%dT%H%M%S'.freeze
+  OUT_FILENAME    = "graphql_schema".freeze
+
+  name "graphql-schema"
+  type :other
+
+  def main(*_args)
+    return unless graphql_schema
+
+    File.open(output_filename, 'wb') { |fd| fd << schema_content }
+    log(:info) {
+      "Generated file: '#{output_filename}'"
+    }
+  end
+
+  private
+
+  def schema_content
+    case output_format
+    when :definition
+      graphql_schema.to_definition
+    when :json
+      graphql_schema.to_json
+    when :yaml
+      graphql_schema.to_yaml
+    else
+      raise ArgumentError, "Unknown '-format' #{output_format}"
+    end
+  end
+
+  def graphql_schema
+    @graphql_schema ||= graphql.client.schema
+  end
+
+  def output_filename(name = output_basename)
+    File.join(output_folder, "#{timestamp}_#{enviro_name}_#{name}.#{output_extension}")
+  end
+
+  def enviro_name
+    @enviro_name ||= ''.then do
+      host = graphql.client.host
+      uri  = URI.parse("https://#{host}")
+      uri.host.split('.')[0].gsub('-', '_')
+    end
+  end
+
+  def output_extension
+    case output_format
+    when :definition then 'graphql'
+    when :json       then 'json'
+    when :yaml       then 'yml'
+    else
+      'txt'
+    end
+  end
+
+  def output_folder
+    "#{config.active_enviro}/#{self.class::OUT_FOLDER}"
+  end
+
+  def timestamp(date = Time.now)
+    date.strftime(self.class::OUT_TIME_FORMAT)
+  end
+
+  def output_basename
+    options.dig(:output, :file, :name) || self.class::OUT_FILENAME
+  end
+
+  def output_format
+    @output_format ||= (options.dig(:output, :format) || :definition).to_sym
+  end
+end

data/lib/eco/api/usecases/default/meta.rb

@@ -0,0 +1,12 @@
+module Eco
+  module API
+    class UseCases
+      class Default
+        module Meta
+        end
+      end
+    end
+  end
+end
+
+require_relative 'meta/graphql_schema'

data/lib/eco/api/usecases/default/utils/cli/split_csv_cli.rb

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::Utils::SplitCsv
+class Eco::API::UseCases::Default::Utils::SplitCsv
   class Cli < Eco::API::UseCases::Cli
     desc "Splits an input file into multiple ones"
 

data/lib/eco/api/usecases/default/utils/split_csv_case.rb

@@ -1,4 +1,4 @@
-class Eco::API::UseCases::Default::People::Utils::SplitCsv < Eco::API::Common::Loaders::UseCase
+class Eco::API::UseCases::Default::Utils::SplitCsv < Eco::API::Common::Loaders::UseCase
   require_relative 'cli/split_csv_cli'
 
   MAX_ROWS = 15_000

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

@@ -12,6 +12,7 @@ module Eco
   end
 end
 
+require_relative 'default/meta'
+require_relative 'default/utils'
 require_relative 'default/people'
 require_relative 'default/locations'
-require_relative 'default/utils'

data/lib/eco/version.rb

@@ -1,3 +1,3 @@
 module Eco
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-helpers
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.2
 platform: ruby
 authors:
 - Oscar Segura
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 2024-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -247,6 +247,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -254,6 +257,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: ecoportal-api-v2
   requirement: !ruby/object:Gem::Requirement
@@ -261,6 +267,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -268,6 +277,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.8
 - !ruby/object:Gem::Dependency
   name: ed25519
   requirement: !ruby/object:Gem::Requirement
@@ -658,6 +670,9 @@ files:
 - lib/eco/api/usecases/default/locations/csv_to_tree_case.rb
 - lib/eco/api/usecases/default/locations/tagtree_extract_case.rb
 - lib/eco/api/usecases/default/locations/tagtree_upload_case.rb
+- lib/eco/api/usecases/default/meta.rb
+- lib/eco/api/usecases/default/meta/cli/graphql_schema_cli.rb
+- lib/eco/api/usecases/default/meta/graphql_schema.rb
 - lib/eco/api/usecases/default/people.rb
 - lib/eco/api/usecases/default/people/amend.rb
 - lib/eco/api/usecases/default/people/amend/clean_unknown_tags_case.rb