eac_tools 0.61.0 → 0.62.0

data/sub/eac_rest/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+local_gemfile = ::File.join(::File.dirname(__FILE__), 'Gemfile.local')
+eval_gemfile local_gemfile if ::File.exist?(local_gemfile)

data/sub/eac_rest/eac_rest.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'eac_rest/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'eac_rest'
+  s.version     = EacRest::VERSION
+  s.authors     = ['Eduardo H. Bogoni']
+  s.summary     = 'A REST helper for Ruby.'
+
+  s.files = Dir['{lib}/**/*']
+
+  s.add_dependency 'eac_envs-http', '~> 0.3', '>= 0.3.1'
+  s.add_dependency 'eac_fs', '~> 0.16'
+  s.add_dependency 'eac_ruby_utils', '~> 0.112'
+
+  s.add_development_dependency 'aranha-parsers', '~> 0.15'
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.5.1'
+end

data/sub/eac_rest/lib/eac_rest/api.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'eac_rest/request'
+require 'eac_ruby_utils/core_ext'
+
+module EacRest
+  # Abstract methods
+  #   * self.issue_get_url_suffix(provider_issue_id)
+  class Api
+    DEFAULT_ROOT_ENTITY_CLASS_NAME_SUFFIX = 'Root'
+
+    require_sub __FILE__, include_modules: true
+    attr_accessor :ssl_verify
+    common_constructor :root_url, :username, :password, default: [nil, nil] do
+      self.ssl_verify = true
+    end
+
+    # @param entity_class [Class]
+    # @param url_suffix [String]
+    # @return [EacRest::Entity]
+    def entity(entity_class, data_or_id, options = {})
+      entity_class.new(self, data_or_id, options)
+    end
+
+    def request(service_url_suffix, headers = {}, &body_data_proc)
+      r = ::EacRest::Request.new(build_service_url(service_url_suffix),
+                                 body_data_proc).ssl_verify(ssl_verify)
+      headers.each { |name, value| r = r.header(name, value) }
+      r = r.autenticate(username, password) if username.present?
+      r
+    end
+
+    def request_json(service_url_suffix, headers = {}, &body_data_proc)
+      request(service_url_suffix, headers.merge('Accept' => 'application/json')) do |body_data|
+        r = ::JSON.parse(body_data)
+        r = body_data_proc.call(r) if body_data_proc
+        r
+      end
+    end
+
+    # @return [Addressable::URI]
+    def build_service_url(suffix)
+      r = ::Addressable::URI.parse(suffix)
+      return r if r.scheme.present?
+
+      s = build_service_url_suffix(suffix)
+      r = ::Addressable::URI.parse(root_url)
+      r.path += s.path
+      r.query_values = r.query_values(::Array).if_present([]) +
+                       s.query_values(::Array).if_present([])
+      r
+    end
+
+    # @return [Addressable::URI]
+    def build_service_url_suffix(suffix)
+      ::Addressable::URI.parse(suffix)
+    end
+
+    # @return [EacRest::Entity]
+    def root_entity
+      @root_entity ||= root_entity_class.new(self, nil)
+    end
+
+    # @return [Class]
+    def root_entity_class
+      self.class.const_get(DEFAULT_ROOT_ENTITY_CLASS_NAME_SUFFIX)
+    end
+  end
+end

data/sub/eac_rest/lib/eac_rest/entity.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacRest
+  class Entity
+    enable_abstract_methods
+    enable_simple_cache
+    enable_listable
+    lists.add_symbol :option, :parent
+    common_constructor :api, :data_or_id, :options, default: [{}] do
+      self.options = ::EacRest::Entity.lists.option.hash_keys_validate!(options)
+    end
+
+    class << self
+      def from_array_data(api, array_data, *args)
+        array_data.map { |item_data| new(api, item_data, *args) }
+      end
+    end
+
+    # @param entity_class [Class]
+    # @param url_suffix [String]
+    # @return [EacRest::Entity]
+    def child_entity(entity_class, data_or_id, options = {})
+      api.entity(entity_class, data_or_id, options.merge(OPTION_PARENT => self))
+    end
+
+    # @return [Hash]
+    def data
+      if internal_data.blank?
+        self.internal_data = data_or_id_data? ? data_or_id : data_from_id
+      end
+
+      internal_data
+    end
+
+    # @return [Boolean]
+    def data_or_id_data?
+      data_or_id.is_a?(::Hash)
+    end
+
+    # @return [Hash]
+    def data_from_id
+      raise_abstract_method __method__
+    end
+
+    # @return [Object]
+    def id
+      data_or_id_data? ? id_from_data : data_or_id
+    end
+
+    # @return [Object]
+    def id_from_data
+      raise_abstract_method __method__
+    end
+
+    # @return [EacRest::Entity, nil]
+    def parent_entity
+      options[OPTION_PARENT]
+    end
+
+    private
+
+    attr_accessor :internal_data
+  end
+end

data/sub/eac_rest/lib/eac_rest/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module EacRest
+  class Error < ::RuntimeError
+  end
+end

data/sub/eac_rest/lib/eac_rest/request.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'eac_envs/http/request'
+require 'eac_rest/response'
+require 'eac_ruby_utils/core_ext'
+
+module EacRest
+  class Request
+    attr_reader :internal_request
+
+    # @param url [EacEnvs::Http::Request, String]
+    # @param response_body_data_proc [Proc, nil]
+    def initialize(url, response_body_data_proc = nil)
+      if url.is_a?(::EacEnvs::Http::Request)
+        @internal_request = url
+      else
+        @internal_request = ::EacEnvs::Http::Request.new.url(url)
+        response_body_data_proc.if_present do |v|
+          @internal_request = @internal_request.response_body_data_proc(v)
+        end
+      end
+    end
+
+    delegate :sanitized_verb, :url, to: :internal_request
+
+    {
+      auth: 0, body_data: 0, header: 1, headers: 0, ssl_verify: 0, verb: 0
+    }.each do |method_name, read_args_count|
+      define_method method_name do |*args|
+        if args.count <= read_args_count
+          internal_request.send(method_name, *args)
+        else
+          self.class.new(internal_request.send(method_name, *args))
+        end
+      end
+    end
+
+    # @return [EacRest::Request]
+    def autenticate(username, password)
+      self.class.new(internal_request.basic_auth(username, password))
+    end
+
+    # @return [EacRest::Response]
+    def response
+      ::EacRest::Response.new(self)
+    end
+  end
+end

data/sub/eac_rest/lib/eac_rest/response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_rest/error'
+require 'eac_envs/http/error'
+require 'eac_ruby_utils/core_ext'
+
+module EacRest
+  class Response < ::StandardError
+    common_constructor :request
+    delegate :body_data_proc, to: :request
+
+    def internal_response
+      @internal_response ||= request.internal_request.response
+    end
+
+    %i[body_data body_data_or_raise body_str body_str_or_raise header headers
+       link links raise_unless_200 status to_s url].each do |method_name|
+      define_method method_name do |*args, &block|
+        internal_response.send(method_name, *args, &block)
+      rescue ::EacEnvs::Http::Error
+        raise ::EacRest::Error
+      end
+    end
+  end
+end

data/sub/eac_rest/lib/eac_rest/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EacRest
+  VERSION = '0.9.0'
+end

data/sub/eac_rest/lib/eac_rest.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacRest
+  require_sub __FILE__
+end

data/sub/eac_rest/spec/lib/eac_rest/api_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'eac_rest/api'
+require 'eac_envs/http/rspec/echo_server'
+
+::RSpec.describe ::EacRest::Api do
+  let(:instance) { described_class.new(http_server.root_url) }
+  let(:http_server) { ::EacEnvs::Http::Rspec::EchoServer.http }
+
+  around do |example|
+    http_server.on_active(&example)
+  end
+
+  before do
+    allow_any_instance_of(::Faraday::Multipart::Middleware).to( # rubocop:disable RSpec/AnyInstance
+      receive(:unique_boundary)
+      .and_return('-----------RubyMultipartPost-0123456789abcdef0123456789abcdef')
+    )
+  end
+
+  include_examples 'source_target_fixtures', __FILE__
+
+  def source_data(source_file)
+    remove_variable_values(
+      ::JSON.parse(
+        ::RequestBuilder.from_file(instance, source_file).result.response.body_str
+      )
+    )
+  end
+
+  def remove_variable_values(obj)
+    if obj.is_a?(::Hash)
+      remove_variable_values_from_hash(obj)
+    elsif obj.is_a?(::Enumerable)
+      remove_variable_values_from_enumerable(obj)
+    end
+    obj
+  end
+
+  def remove_variable_values_from_hash(hash)
+    %w[host hostname ip].each { |key| hash.delete(key) }
+    hash.each_value { |value| remove_variable_values(value) }
+  end
+
+  def remove_variable_values_from_enumerable(enumerable)
+    enumerable.each { |value| remove_variable_values(value) }
+  end
+
+  context 'with self signed https server' do
+    let(:http_server) { ::EacEnvs::Http::Rspec::EchoServer.https }
+    let(:instance) { described_class.new(http_server.root_url) }
+    let(:request_base) { instance.request('/any/path') }
+    let(:response_body) { request.response.body_str }
+
+    context 'when no additional flag' do
+      let(:request) { request_base }
+
+      it do
+        expect { response_body }.to(raise_error(::EacRest::Error))
+      end
+    end
+
+    context 'when ssl_verify disabled' do
+      let(:request) { request_base.ssl_verify(false) }
+
+      it do
+        expect { response_body }.not_to raise_error
+      end
+    end
+  end
+end

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/get.source.yaml

@@ -0,0 +1,5 @@
+---
+url_suffix: '/path/to/service?field1=value1&field2=value2'
+verb: :get
+headers:
+  Accept: application/json

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/get.target.yaml

@@ -0,0 +1,9 @@
+---
+ssl: false
+method: GET
+uri: "/path/to/service?field1=value1&field2=value2"
+body:
+headers:
+  user-agent: Faraday v2.7.4
+  accept: application/json
+  accept-encoding: gzip,deflate

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/get_with_auth.source.yaml

@@ -0,0 +1,8 @@
+---
+url_suffix: '/path/to/service?field1=value1&field2=value2'
+auth:
+  username: the_user
+  password: the_secret
+verb: :get
+headers:
+  Accept: application/json

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/get_with_auth.target.yaml

@@ -0,0 +1,10 @@
+---
+ssl: false
+method: GET
+uri: "/path/to/service?field1=value1&field2=value2"
+body:
+headers:
+  user-agent: Faraday v2.7.4
+  accept: application/json
+  authorization: Basic dGhlX3VzZXI6dGhlX3NlY3JldA==
+  accept-encoding: gzip,deflate

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/post_array_body.source.yaml

@@ -0,0 +1,10 @@
+---
+url_suffix: '/path/to/service'
+verb: :post
+body_data:
+- - field1
+  - value1
+- - field2
+  - value2
+- - field1
+  - value3

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/post_array_body.target.yaml

@@ -0,0 +1,11 @@
+---
+ssl: false
+method: POST
+uri: "/path/to/service"
+body: field1=value1&field1=value3&field2=value2
+headers:
+  user-agent: Faraday v2.7.4
+  content-type: application/x-www-form-urlencoded
+  accept-encoding: gzip,deflate
+  accept: "*/*"
+  content-length: '41'

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/post_string_body.source.yaml

@@ -0,0 +1,4 @@
+---
+url_suffix: '/path/to/service'
+verb: :post
+body_data: field1=value1&field2=value2

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/post_string_body.target.yaml

@@ -0,0 +1,11 @@
+---
+ssl: false
+method: POST
+uri: "/path/to/service"
+body: field1=value1&field2=value2
+headers:
+  user-agent: Faraday v2.7.4
+  content-type: application/x-www-form-urlencoded
+  accept-encoding: gzip,deflate
+  accept: "*/*"
+  content-length: '27'

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/put_hash_body.source.yaml

@@ -0,0 +1,6 @@
+---
+url_suffix: '/path/to/service'
+verb: :put
+body_data:
+  field1: value1
+  field2: value2

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/put_hash_body.target.yaml

@@ -0,0 +1,11 @@
+---
+ssl: false
+method: PUT
+uri: "/path/to/service"
+body: field1=value1&field2=value2
+headers:
+  user-agent: Faraday v2.7.4
+  content-type: application/x-www-form-urlencoded
+  accept-encoding: gzip,deflate
+  accept: "*/*"
+  content-length: '27'

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/put_with_file.source.yaml

@@ -0,0 +1,5 @@
+---
+url_suffix: '/path/to/service'
+verb: :put
+body_data:
+  '@field1': value1

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/put_with_file.target.yaml

@@ -0,0 +1,13 @@
+---
+ssl: false
+method: PUT
+uri: "/path/to/service"
+body: "-------------RubyMultipartPost-0123456789abcdef0123456789abcdef\r\nContent-Disposition:
+  form-data; name=\"field1\"; filename=\"basename\"\r\nContent-Length: 6\r\nContent-Type:
+  text/plain\r\nContent-Transfer-Encoding: binary\r\n\r\nvalue1\r\n-------------RubyMultipartPost-0123456789abcdef0123456789abcdef--\r\n"
+headers:
+  user-agent: Faraday v2.7.4
+  content-type: multipart/form-data; boundary=-----------RubyMultipartPost-0123456789abcdef0123456789abcdef
+  content-length: '290'
+  accept-encoding: gzip,deflate
+  accept: "*/*"

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/root.source.yaml

@@ -0,0 +1,2 @@
+---
+url_suffix: ''

data/sub/eac_rest/spec/lib/eac_rest/api_spec_files/root.target.yaml

@@ -0,0 +1,9 @@
+---
+ssl: false
+method: GET
+uri: "/"
+body:
+headers:
+  user-agent: Faraday v2.7.4
+  accept-encoding: gzip,deflate
+  accept: "*/*"

data/sub/eac_rest/spec/rubocop_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+::EacRubyUtils::Rspec.default_setup.describe_rubocop

data/sub/eac_rest/spec/spec_helper/request_builder.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/fs/temp'
+require 'eac_ruby_utils/yaml'
+
+class RequestBuilder
+  class << self
+    def from_file(api, path)
+      new(api, ::EacRubyUtils::Yaml.load_file(path))
+    end
+  end
+
+  FILE_FIELD_PARSER = /\A@(.+)\z/.to_parser { |m| m[1] }
+
+  common_constructor :api, :data do
+    self.data = data.with_indifferent_access
+  end
+
+  def result
+    r = %i[verb headers].inject(selected_api.request(data.fetch(:url_suffix))) do |a, e|
+      data[e].if_present(a) { |v| a.send(e, v) }
+    end
+    data[:body_data].if_present(r) { |v| r.body_data(build_body_data(v)) }
+  end
+
+  def build_body_data(source)
+    return source unless source.is_a?(::Hash)
+
+    source.map { |k, v| build_body_field(k, v) }
+  end
+
+  def build_body_field(name, value)
+    FILE_FIELD_PARSER.parse(name).if_present([name, value]) do |v|
+      [v, file_with_value(value)]
+    end
+  end
+
+  def file_with_value(value)
+    r = ::EacRubyUtils::Fs::Temp.directory.join('basename')
+    r.write(value)
+    ::File.new(r.to_path)
+  end
+
+  def selected_api
+    data[:auth].if_present(api) do |v|
+      api.class.new(api.root_url, v.fetch(:username), v.fetch(:password))
+    end
+  end
+end

data/sub/eac_rest/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/rspec/default_setup'
+::EacRubyUtils::Rspec.default_setup_create(::File.expand_path('..', __dir__))
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub __FILE__

data/sub/eac_ruby_base0/eac_ruby_base0.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
 
   s.files = Dir['{lib}/**/*']
 
-  s.add_dependency 'avm-eac_ruby_base1', '~> 0.29'
-  s.add_dependency 'eac_cli', '~> 0.30', '>= 0.30.1'
+  s.add_dependency 'avm-eac_ruby_base1', '~> 0.30', '>= 0.30.2'
+  s.add_dependency 'eac_cli', '~> 0.31'
   s.add_dependency 'eac_fs', '~> 0.16'
   s.add_dependency 'eac_ruby_utils', '~> 0.112'
 

data/sub/eac_ruby_base0/lib/eac_ruby_base0/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EacRubyBase0
-  VERSION = '0.17.3'
+  VERSION = '0.18.0'
 end

data/sub/eac_templates/lib/eac_templates/abstract/directory.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/interface_methods'
+require 'eac_templates/abstract/fs_object'
+require 'eac_templates/variables/directory'
+
+module EacTemplates
+  module Abstract
+    class Directory < ::EacTemplates::Abstract::FsObject
+      enable_abstract_methods
+      delegate(*::EacTemplates::InterfaceMethods::DIRECTORY - %i[child chidren], to: :applier)
+
+      # @param basename [Pathname]
+      # @return [EacTemplates::Abstract::FsObject
+      def build_child(child_basename, child_type)
+        child_basename = child_basename.to_pathname
+        child_type = type_list.value_validate!(child_type)
+        category_module.const_get(child_type.to_s.camelize)
+          .new(owner, self, child_basename, options)
+      end
+
+      # @param basename [Pathname]
+      # @return [EacTemplates::Abstract::FsObject]
+      def child(basename)
+        basename = basename.to_pathname
+        children.find { |c| c.basename == basename } ||
+          raise_not_found("No child found with basename \"#{basename}\"")
+      end
+
+      # @return [Enumerable<EacTemplates::Abstract::FsObject>]
+      def children
+        children_basenames.map { |c_basename, c_type| build_child(c_basename, c_type) }
+      end
+
+      # @return [Hash<Pathname, Symbol>]
+      def children_basenames
+        raise_abstract_method __method__
+      end
+    end
+  end
+end

data/sub/eac_templates/lib/eac_templates/abstract/file.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/interface_methods'
+require 'eac_templates/abstract/fs_object'
+require 'eac_templates/variables/file'
+
+module EacTemplates
+  module Abstract
+    class File < ::EacTemplates::Abstract::FsObject
+      enable_abstract_methods
+      delegate(*::EacTemplates::InterfaceMethods::FILE - %i[content path], to: :applier)
+
+      # @return [String]
+      def content
+        path.read
+      end
+
+      # @return [Pathname]
+      def path
+        raise_abstract_method __method__
+      end
+    end
+  end
+end