eac_tools 0.65.0 → 0.65.1

data/sub/eac_envs-http/lib/eac_envs/http/response/body.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'json'
+
+module EacEnvs
+  module Http
+    class Response < ::StandardError
+      module Body
+        delegate :response_body_data_proc, to: :request
+
+        def body_data
+          r = body_data_method_name.if_present(body_str) do |v|
+            respond_to?(v, true) ? send(v) : body_str
+          end
+          r = response_body_data_proc.call(r) if response_body_data_proc.present?
+          r
+        end
+
+        def body_data_or_raise
+          raise_unless_200
+
+          body_data
+        end
+
+        # @return [String]
+        def body_str
+          performed.body
+        end
+
+        def body_str_or_raise
+          raise_unless_200
+
+          body_str
+        end
+
+        private
+
+        def body_data_from_application_json
+          ::JSON.parse(body_str)
+        end
+
+        def body_data_from_application_xml
+          Hash.from_xml(body_str)
+        end
+
+        # @return [String]
+        def body_data_method_name
+          content_type.if_present do |v|
+            'body_data_from_' +
+              v.split(';').first.force_encoding(::Encoding::UTF_8).variableize
+          end
+        end
+      end
+    end
+  end
+end

data/sub/eac_envs-http/lib/eac_envs/http/response/headers.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacEnvs
+  module Http
+    class Response < ::StandardError
+      module Headers
+        COMMON_HEADERS = %w[Content-Type].freeze
+        HEADER_LINE_PARSER = /\A([^:]+):(.*)\z/.to_parser do |m|
+          [m[1].strip, m[2].strip]
+        end
+
+        def header(name)
+          hash_search(headers, name)
+        end
+
+        # @return [Hash<String, String>]
+        def headers
+          performed.headers.to_hash
+        end
+
+        COMMON_HEADERS.each do |header_key|
+          define_method header_key.underscore do
+            header(header_key)
+          end
+        end
+
+        private
+
+        def hash_search(hash, key)
+          key = key.to_s.downcase
+          hash.each do |k, v|
+            return v if k.to_s.downcase == key
+          end
+          nil
+        end
+      end
+    end
+  end
+end

data/sub/eac_envs-http/lib/eac_envs/http/response/links.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+module EacEnvs
+  module Http
+    class Response < ::StandardError
+      module Links
+        # https://www.w3.org/wiki/LinkHeader
+        LINKS_HEADER_NAME = 'Link'
+
+        # https://www.w3.org/wiki/LinkHeader
+        LINK_PARSER = /\A\<(.+)\>\s*;\s*rel\s*=\s*\"(.*)\"\z/.to_parser do |m|
+          [m[2], m[1]]
+        end
+
+        def link(rel)
+          hash_search(links, rel)
+        end
+
+        def links
+          header(LINKS_HEADER_NAME).if_present({}) do |v|
+            v.split(',').map { |w| LINK_PARSER.parse!(w.strip) }.to_h
+          end
+        end
+      end
+    end
+  end
+end

data/sub/eac_envs-http/lib/eac_envs/http/response/statuses.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacEnvs
+  module Http
+    class Response < ::StandardError
+      module Statuses
+        def raise_unless_200
+          return nil if status == 200
+
+          raise self
+        end
+
+        def status
+          performed.status.to_i
+        end
+      end
+    end
+  end
+end

data/sub/eac_envs-http/lib/eac_envs/http/response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/conversions'
+require 'eac_envs/http/error'
+require 'eac_ruby_utils/core_ext'
+require 'faraday'
+require 'json'
+
+module EacEnvs
+  module Http
+    class Response < ::StandardError
+      common_constructor :request
+      delegate :url, to: :request
+
+      def to_s
+        "URL: #{url}\nStatus: #{status}\nBody:\n\n#{body_str}"
+      end
+
+      private
+
+      def performed
+        @performed ||= request.faraday_response
+      rescue ::Faraday::Error
+        raise ::EacEnvs::Http::Error
+      end
+
+      require_sub __FILE__, include_modules: true
+    end
+  end
+end

data/sub/eac_envs-http/lib/eac_envs/http/rspec/echo_server/request_processor.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'eac_envs/http/request'
+require 'eac_ruby_utils/core_ext'
+require 'webrick'
+
+module EacEnvs
+  module Http
+    module Rspec
+      class EchoServer
+        class RequestProcessor
+          REQUEST_TO_DATA = {
+            ssl: :ssl?,
+            method: :request_method,
+            uri: :unparsed_uri,
+            body: :body
+          }.freeze
+
+          common_constructor :request, :response
+
+          def perform
+            response.body = response_body
+            response.header['Content-type'] = 'application/json'
+            response.status = 200
+          end
+
+          def request_data
+            REQUEST_TO_DATA.map { |k, v| [k, request.send(v)] }.to_h.merge(headers: request_headers)
+          end
+
+          def request_headers
+            request.header.map { |k, v| [k, v.first] }.to_h
+          end
+
+          def response_body
+            ::JSON.generate(request_data)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/eac_envs-http/lib/eac_envs/http/rspec/echo_server/webrick_servlet.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'eac_envs/http/request'
+require 'eac_envs/http/rspec/echo_server/request_processor'
+require 'eac_ruby_utils/core_ext'
+require 'webrick'
+
+module EacEnvs
+  module Http
+    module Rspec
+      class EchoServer
+        class WebrickServlet < WEBrick::HTTPServlet::AbstractServlet
+          ::EacEnvs::Http::Request.lists.verb.each_value do |verb|
+            define_method "do_#{verb.to_s.upcase}" do |request, response|
+              ::EacEnvs::Http::Rspec::EchoServer::RequestProcessor.new(request, response).perform
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/eac_envs-http/lib/eac_envs/http/rspec/echo_server.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'addressable'
+require 'eac_ruby_utils/core_ext'
+require 'webrick'
+require 'webrick/https'
+
+module EacEnvs
+  module Http
+    module Rspec
+      class EchoServer
+        HOSTNAME = 'localhost'
+        SCHEMES = {
+          http: { Port: 8080 },
+          https: { Port: 8443, SSLEnable: true, SSLCertName: [['CN', HOSTNAME]] }
+        }.freeze
+
+        class << self
+          SCHEMES.each do |scheme, webrick_options|
+            # @return [::EacEnvs::Http::Rspec::EchoServer]
+            define_method scheme do
+              new(scheme, webrick_options)
+            end
+          end
+        end
+
+        common_constructor :scheme, :webrick_options
+
+        def on_active(&block)
+          servlet = webrick_servlet
+          ::Thread.abort_on_exception = true
+          servlet_thread = ::Thread.new { servlet.start }
+          begin
+            sleep 0.001 while servlet.status != :Running
+            block.call
+          ensure
+            servlet.shutdown
+            servlet_thread.join
+          end
+        end
+
+        def root_url
+          ::Addressable::URI.new(
+            scheme: scheme.to_s,
+            host: ::EacEnvs::Http::Rspec::EchoServer::HOSTNAME,
+            port: webrick_options.fetch(:Port)
+          )
+        end
+
+        private
+
+        # @return [EacEnvs::Http::Rspec::EchoServer::WebrickServlet]
+        def webrick_servlet
+          r = ::WEBrick::HTTPServer.new(webrick_options)
+          r.mount '/', ::EacEnvs::Http::Rspec::EchoServer::WebrickServlet
+          r
+        end
+
+        require_sub __FILE__
+      end
+    end
+  end
+end

data/sub/eac_envs-http/lib/eac_envs/http/rspec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacEnvs
+  module Http
+    module Rspec
+      require_sub __FILE__
+    end
+  end
+end

data/sub/eac_envs-http/lib/eac_envs/http/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EacEnvs
+  module Http
+    VERSION = '0.3.2'
+  end
+end

data/sub/eac_envs-http/lib/eac_envs/http.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacEnvs
+  module Http
+    require_sub __FILE__
+  end
+end

data/sub/eac_envs-http/spec/lib/eac_envs/http/request/body_fields_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'eac_envs/http/request/body_fields'
+
+::RSpec.describe ::EacEnvs::Http::Request::BodyFields do
+  describe '#to_h' do
+    [
+      [
+        { field1: 'value1', field2: %w[value2 value3] },
+        { 'field1' => ['value1'], 'field2' => %w[value2 value3] }
+      ], [
+        'field1=value1&field2=value2',
+        nil
+      ], [
+        [%w[field1 value1], %w[field2 value2], %w[field2 value3]],
+        { 'field1' => ['value1'], 'field2' => %w[value2 value3] }
+      ]
+    ].each do |d|
+      source_body = d[0]
+      expected_result = d[1]
+      context "when source_body is #{source_body}" do
+        let(:instance) { described_class.new(source_body) }
+
+        it do
+          expect(instance.to_h).to eq(expected_result)
+        end
+      end
+    end
+
+    context 'when source_body has a file' do
+      let(:file) do
+        temp = ::EacRubyUtils::Fs::Temp.file
+        temp.write('TEMPORARY')
+        ::File.new(temp.to_path)
+      end
+      let(:source_body) { { file1: file } }
+      let(:instance) { described_class.new(source_body) }
+      let(:expected_file) { ::Faraday::Multipart::FilePart.new(file.path, 'text/plain') }
+
+      %w[class original_filename local_path content_type].each do |attr|
+        it do
+          expect(instance.to_h.fetch('file1').first.send(attr)).to eq(expected_file.send(attr))
+        end
+      end
+    end
+  end
+end

data/sub/eac_envs-http/spec/lib/eac_envs/http/request_spec.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'eac_envs/http/error'
+require 'eac_envs/http/request'
+require 'eac_envs/http/rspec/echo_server'
+
+::RSpec.describe ::EacEnvs::Http::Request do
+  let(:http_server) { ::EacEnvs::Http::Rspec::EchoServer.http }
+
+  around { |example| http_server.on_active(&example) }
+
+  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(http_server.root_url, 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.url(http_server.root_url + '/any/path') }
+    let(:response_body) { request.response.body_str }
+
+    context 'when no additional flag' do
+      let(:request) { instance }
+
+      it do
+        expect { response_body }.to(raise_error(::EacEnvs::Http::Error))
+      end
+    end
+
+    context 'when ssl_verify disabled' do
+      let(:request) { instance.ssl_verify(false) }
+
+      it do
+        expect { response_body }.not_to raise_error
+      end
+    end
+  end
+end

data/sub/eac_envs-http/spec/lib/eac_envs/http/request_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_envs-http/spec/lib/eac_envs/http/request_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_envs-http/spec/lib/eac_envs/http/request_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_envs-http/spec/lib/eac_envs/http/request_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_envs-http/spec/lib/eac_envs/http/request_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_envs-http/spec/lib/eac_envs/http/request_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_envs-http/spec/lib/eac_envs/http/request_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_envs-http/spec/lib/eac_envs/http/request_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_envs-http/spec/lib/eac_envs/http/request_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_envs-http/spec/lib/eac_envs/http/request_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_envs-http/spec/lib/eac_envs/http/request_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_envs-http/spec/lib/eac_envs/http/request_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_envs-http/spec/lib/eac_envs/http/request_spec_files/root.source.yaml

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

data/sub/eac_envs-http/spec/lib/eac_envs/http/request_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_envs-http/spec/rubocop_spec.rb

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

data/sub/eac_envs-http/spec/spec_helper/request_builder.rb

@@ -0,0 +1,61 @@
+# 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(root_url, path)
+      new(root_url, ::EacRubyUtils::Yaml.load_file(path))
+    end
+  end
+
+  FILE_FIELD_PARSER = /\A@(.+)\z/.to_parser { |m| m[1] }
+
+  common_constructor :root_url, :data do
+    self.root_url = root_url.to_uri
+    self.data = data.with_indifferent_access
+  end
+
+  def new_request
+    ::EacEnvs::Http::Request.new.url(root_url + data.fetch(:url_suffix))
+  end
+
+  def result
+    r = %i[verb headers].inject(new_request) do |a, e|
+      data[e].if_present(a) { |v| a.send(e, v) }
+    end
+    result_body_data(result_auth(r))
+  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
+
+  private
+
+  def result_auth(request)
+    request = data[:auth].if_present(request) do |v|
+      request.basic_auth(v.fetch(:username), v.fetch(:password))
+    end
+  end
+
+  def result_body_data(request)
+    data[:body_data].if_present(request) { |v| request.body_data(build_body_data(v)) }
+  end
+end

data/sub/eac_envs-http/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__