convenient_service 0.17.0 → 0.18.0

data/lib/convenient_service/examples/standard/request_params/utils/array.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "array/wrap"
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Utils
-          module Array
-            class << self
-              def wrap(object)
-                Wrap.call(object)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/utils/http/request/parse_body.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Utils
-          module HTTP
-            module Request
-              ##
-              # TODO: Specs.
-              #
-              class ParseBody < ConvenientService::Command
-                attr_reader :http_string
-
-                def initialize(http_string:)
-                  @http_string = http_string
-                end
-
-                ##
-                # IMPORTANT: Make sure length is set in `http_string`.
-                #
-                # - https://stackoverflow.com/a/17599778/12201472
-                # - https://github.com/ruby/webrick/blob/v1.7.0/lib/webrick/httprequest.rb
-                #
-                def call
-                  webrick_request = ::WEBrick::HTTPRequest.new(::WEBrick::Config::HTTP)
-
-                  webrick_request.parse(::StringIO.new(http_string))
-
-                  webrick_request.body
-                rescue ::WEBrick::HTTPStatus::BadRequest
-                  nil
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/utils/http/request/parse_path.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Utils
-          module HTTP
-            module Request
-              ##
-              # TODO: Specs.
-              #
-              class ParsePath < ConvenientService::Command
-                attr_reader :http_string
-
-                def initialize(http_string:)
-                  @http_string = http_string
-                end
-
-                ##
-                # - https://stackoverflow.com/a/17599778/12201472
-                # - https://github.com/ruby/webrick/blob/v1.7.0/lib/webrick/httprequest.rb
-                #
-                def call
-                  webrick_request = ::WEBrick::HTTPRequest.new(::WEBrick::Config::HTTP)
-
-                  webrick_request.parse(::StringIO.new(http_string))
-
-                  webrick_request.path
-                rescue ::WEBrick::HTTPStatus::BadRequest
-                  nil
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/utils/http/request.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "request/parse_body"
-require_relative "request/parse_path"
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Utils
-          module HTTP
-            module Request
-              class << self
-                def parse_body(http_string)
-                  ParseBody.call(http_string: http_string)
-                end
-
-                def parse_path(http_string)
-                  ParsePath.call(http_string: http_string)
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/utils/http.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "http/request"

data/lib/convenient_service/examples/standard/request_params/utils/integer/safe_parse.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-##
-#
-#
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Utils
-          module Integer
-            ##
-            # TODO: Specs.
-            #
-            class SafeParse < ConvenientService::Command
-              attr_reader :object
-
-              def initialize(object)
-                @object = object
-              end
-
-              def call
-                ::Kernel.Integer(object, exception: false)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/utils/integer.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-##
-# @internal
-#   NOTE: `require_relative "integer/safe_parse"` does NOT work. Why?
-#
-require_relative "integer/safe_parse"
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Utils
-          module Integer
-            class << self
-              def safe_parse(string)
-                SafeParse.call(string)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/utils/json/safe_parse.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Tries to parse a JSON string and return the corresponding JSON object (Ruby hash, array, etc).
-# Returns default value when fails to parse (default value is set to `nil` by default).
-#
-# IMPORTANT: `JSON::ParseError` is not the only exception that can be raised by `JSON.parse`.
-# Check this link (`Ctrl + f' for `error'):
-# https://github.com/ruby/ruby/blob/master/ext/json/lib/json.rb
-#
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Utils
-          module JSON
-            class SafeParse < ConvenientService::Command
-              attr_reader :json_string, :default_value
-
-              def initialize(json_string, default_value: nil)
-                @json_string = json_string
-                @default_value = default_value
-              end
-
-              def call
-                return default_value unless json_string.instance_of?(::String)
-
-                begin
-                  ::JSON.parse(json_string)
-                rescue
-                  default_value
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/utils/json.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "json/safe_parse"
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Utils
-          module JSON
-            class << self
-              def safe_parse(json_string, default_value: nil)
-                SafeParse.call(json_string, default_value: default_value)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/utils/object/blank.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-##
-#
-#
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Utils
-          module Object
-            ##
-            # TODO: Specs.
-            #
-            class Blank < ConvenientService::Command
-              attr_reader :object
-
-              def initialize(object)
-                @object = object
-              end
-
-              ##
-              # https://api.rubyonrails.org/classes/Object.html#method-i-blank-3F
-              #
-              def call
-                object.respond_to?(:empty?) ? !!object.empty? : !object
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/utils/object/present.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-##
-#
-#
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Utils
-          module Object
-            ##
-            # TODO: Specs.
-            #
-            class Present < ConvenientService::Command
-              attr_reader :object
-
-              def initialize(object)
-                @object = object
-              end
-
-              def call
-                Utils::Object.blank?(object)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/utils/object.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "object/blank"
-require_relative "object/present"
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Utils
-          module Object
-            class << self
-              def blank?(object)
-                Blank.call(object)
-              end
-
-              def present?(object)
-                Present.call(object)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/utils/url/valid.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-##
-#
-#
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Utils
-          module URL
-            ##
-            # TODO: Use to validate URLs.
-            #
-            class Valid < ConvenientService::Command
-              attr_reader :url
-
-              def initialize(url)
-                @url = url
-              end
-
-              ##
-              # NOTE: How to validate URLs?
-              # - https://storck.io/posts/better-http-url-validation-in-ruby-on-rails
-              # - https://github.com/sporkmonger/addressable/issues/1452
-              #
-              # NOTE: URL is NOT URI.
-              # - https://stackoverflow.com/a/16359999/12201472
-              # - https://stackoverflow.com/a/13041565/12201472
-              #
-              # NOTE: Why NOT to match `URI::regexp`?
-              # - https://bugs.ruby-lang.org/issues/6520
-              #
-              def call
-                uri = ::URI.parse(url.to_s)
-
-                uri.is_a?(::URI::HTTPS) || uri.is_a?(::URI::HTTP)
-              rescue ::URI::InvalidURIError
-                false
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/utils/url.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "url/valid"
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Utils
-          module URL
-            class << self
-              def valid?(url)
-                Valid.call(url)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/utils.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "utils/array"
-require_relative "utils/http"
-require_relative "utils/integer"
-require_relative "utils/json"
-require_relative "utils/object"
-require_relative "utils/url"

data/lib/convenient_service/examples/standard/request_params.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "request_params/constants"
-require_relative "request_params/entities"
-require_relative "request_params/services"
-require_relative "request_params/utils"
-
-##
-#
-# @internal
-#   Usage example:
-#
-#     http_string =
-#       <<~TEXT
-#         POST /rules/1000000.json HTTP/1.1
-#         User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36
-#         Host: code-review.com
-#         Content-Type: application/json; charset=utf-8
-#         Content-Length: 134
-#         Accept-Language: en-us
-#         Accept-Encoding: gzip, deflate
-#         Connection: Keep-Alive
-#
-#         {"title":"Avoid error shadowing","description":"Check the official User Docs","tags":["error-shadowing"]}
-#       TEXT
-#
-#     request = ConvenientService::Examples::Standard::RequestParams::Entities::Request.new(http_string:)
-#
-#     ConvenientService::Examples::Standard::RequestParams.prepare(request)
-#
-#   - https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types
-#   - https://www.whatismybrowser.com/guides/the-latest-user-agent/chrome
-#   - https://www.tutorialspoint.com/http/http_requests.htm
-#
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        include ConvenientService::Feature::Standard::Config
-
-        entry :prepare
-
-        def prepare(request)
-          Services::Prepare[request: request]
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/v1/cowsay/services/build_cloud.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      module V1
-        class Cowsay
-          module Services
-            class BuildCloud
-              include ConvenientService::Standard::V1::Config
-
-              attr_reader :text
-
-              def initialize(text: "Hello World!")
-                @text = text
-              end
-
-              def result
-                success(cloud: cloud)
-              end
-
-              private
-
-              ##
-              # Copied with ❤️ from https://github.com/gaborbata/rosetta-cow
-              #
-              def cloud
-                <<~HEREDOC
-                   #{border(text, "_")}
-                  < #{text} >
-                   #{border(text, "-")}
-                HEREDOC
-              end
-
-              def border(text, char)
-                char * (text.length + 2)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/v1/cowsay/services/build_cow.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      module V1
-        class Cowsay
-          module Services
-            class BuildCow
-              include ConvenientService::Standard::V1::Config
-
-              def result
-                success(cow: cow)
-              end
-
-              private
-
-              ##
-              # Copied with ❤️ from https://github.com/gaborbata/rosetta-cow
-              #
-              def cow
-                <<~'HEREDOC'.split("\n").map { |line| offset(line) }.join("\n")
-                  \   ^__^
-                   \  (oo)\_______
-                      (__)\       )\/\
-                          ||----w |
-                          ||     ||
-                HEREDOC
-              end
-
-              def offset(line)
-                " " * 10 + line
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/v1/cowsay/services/print.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      module V1
-        class Cowsay
-          module Services
-            class Print
-              include ConvenientService::Standard::V1::Config
-
-              attr_reader :text, :out
-
-              step Services::BuildCloud, in: :text, out: :cloud
-              step Services::BuildCow, out: :cow
-              step :result
-
-              def initialize(text: "Hello World!", out: $stdout)
-                @text = text
-                @out = out
-              end
-
-              def result
-                out.puts cloud + cow
-
-                success
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/v1/cowsay/services.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "services/build_cloud"
-require_relative "services/build_cow"
-require_relative "services/print"

data/lib/convenient_service/examples/standard/v1/cowsay.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "cowsay/services"
-
-##
-# @internal
-#   Usage examples:
-#
-#   result = ConvenientService::Examples::Standard::V1::Cowsay.print("Hello")
-#   result = ConvenientService::Examples::Standard::V1::Cowsay.print("Hi")
-#
-module ConvenientService
-  module Examples
-    module Standard
-      module V1
-        class Cowsay
-          include ConvenientService::Feature::Standard::Config
-
-          entry :print do |text = "Hello World!", out: $stdout|
-            Services::Print[text: text, out: out]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/v1/date_time/services/safe_parse.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      module V1
-        class DateTime
-          module Services
-            class SafeParse
-              include ConvenientService::Standard::V1::Config
-
-              attr_reader :string, :format
-
-              def initialize(string:, format:)
-                @string = string
-                @format = format
-              end
-
-              def result
-                success(date_time: ::DateTime.strptime(string, format))
-              rescue ::Date::Error => exception
-                failure(
-                  data: {exception: exception},
-                  message: "Failed to parse `DateTime` object from `#{string}` with `#{format}`"
-                )
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/v1/date_time/services.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "services/safe_parse"