convenient_service 0.5.0 → 0.7.0

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "array/wrap"
+
+module ConvenientService
+  module Examples
+    module Standard
+      module 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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Utils
+          module HTTP
+            module Request
+              ##
+              # TODO: Specs.
+              #
+              class ParseBody < Support::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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Utils
+          module HTTP
+            module Request
+              ##
+              # TODO: Specs.
+              #
+              class ParsePath < Support::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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "request/parse_body"
+require_relative "request/parse_path"
+
+module ConvenientService
+  module Examples
+    module Standard
+      module 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

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

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+##
+#
+#
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Utils
+          module Integer
+            ##
+            # TODO: Specs.
+            #
+            class SafeParse < Support::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

@@ -0,0 +1,25 @@
+# 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
+      module 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

@@ -0,0 +1,40 @@
+# 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
+      module RequestParams
+        module Utils
+          module JSON
+            class SafeParse < Support::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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "json/safe_parse"
+
+module ConvenientService
+  module Examples
+    module Standard
+      module 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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+##
+#
+#
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Utils
+          module Object
+            ##
+            # TODO: Specs.
+            #
+            class Blank < Support::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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+##
+#
+#
+module ConvenientService
+  module Examples
+    module Standard
+      module RequestParams
+        module Utils
+          module Object
+            ##
+            # TODO: Specs.
+            #
+            class Present < Support::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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "object/blank"
+require_relative "object/present"
+
+module ConvenientService
+  module Examples
+    module Standard
+      module 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.rb

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

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "request_params/constants"
+require_relative "request_params/entities"
+require_relative "request_params/services"
+require_relative "request_params/utils"
+
+##
+# @since 0.3.0
+#
+# @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
+      module RequestParams
+        class << self
+          def prepare(request)
+            Services::Prepare[request: request]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/factories/arguments.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+##
+# WIP: Factory API is NOT well-thought yet. It will be revisited and completely refactored at any time.
+#
+module ConvenientService
+  module Factories
+    module Arguments
+      ##
+      # @return [Array]
+      #
+      # @example Default.
+      #
+      #   hello(*args)
+      #
+      def create_args
+        [:foo, :bar]
+      end
+
+      ##
+      # @return [Hash]
+      #
+      # @example Default.
+      #
+      #   hello(**kwargs)
+      #
+      def create_kwargs
+        {foo: :bar, baz: :qux}
+      end
+
+      ##
+      # @return [Hash]
+      #
+      # @example Default.
+      #
+      #   hello(&block)
+      #
+      def create_block
+        proc { :foo }
+      end
+    end
+  end
+end

data/lib/convenient_service/factories/results.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+##
+# WIP: Factory API is NOT well-thought yet. It will be revisited and completely refactored at any time.
+#
+module ConvenientService
+  module Factories
+    module Results
+      ##
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     def result
+      #       success # `result` is return value
+      #     end
+      #   end
+      #
+      def create_result
+        service_class = create_service_class
+
+        service_class.result
+      end
+
+      ##
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     def result
+      #       success # `result` is return value
+      #     end
+      #   end
+      #
+      def create_result_without_step
+        service_class = create_service_class
+
+        service_class.result
+      end
+
+      ##
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     step Step # `result` is return value
+      #   end
+      #
+      def create_result_with_step(...)
+        create_result_with_service_step(...)
+      end
+
+      ##
+      # @param service_step [Class]
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     step Step # `result` is return value
+      #   end
+      #
+      # @example When `service_step` is passed.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     step service_step # `result` is return value
+      #   end
+      #
+      def create_result_with_service_step(service_step: Support::NOT_PASSED)
+        service_step_class = (service_step == Support::NOT_PASSED) ? create_service_step_class : service_step
+
+        service_class = create_service_class(steps: [service_step_class])
+
+        service_class.result
+      end
+
+      ##
+      # @param method_step [Symbol]
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     step :validate # `result` is return value
+      #   end
+      #
+      # @example When `method_step` is passed.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     step method_step # `result` is return value
+      #   end
+      #
+      def create_result_with_method_step(method_step: Support::NOT_PASSED)
+        method_step = (method_step == Support::NOT_PASSED) ? create_method_step : method_step
+
+        service_class = create_service_class(steps: [method_step])
+
+        service_class.result
+      end
+
+      ##
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     step :result # `result` is return value
+      #   end
+      #
+      def create_result_with_result_method_step
+        service_class = create_service_class(steps: [:result])
+
+        service_class.result
+      end
+
+      ##
+      # @return [Hash]
+      #
+      # @example Default.
+      #
+      #   {
+      #     service: result.service,
+      #     status: :success,
+      #     data: {foo: :bar},
+      #     message: "",
+      #     code: :default_success
+      #   }
+      #
+      def create_result_attributes
+        create_result.jsend_attributes.to_h
+      end
+
+      ##
+      # @return [Hash]
+      #
+      # @example Default.
+      #
+      #   {
+      #     service: result.service,
+      #     status: :success,
+      #     data: {foo: :bar},
+      #     message: "",
+      #     code: :default_success,
+      #     parent: result.parent
+      #   }
+      #
+      def create_result_attributes_with_parent(parent: Support::NOT_PASSED)
+        parent = (parent == Support::NOT_PASSED) ? create_result_parent : parent
+
+        result_attributes = create_result_attributes
+
+        result_attributes.merge(parent: parent)
+      end
+
+      ##
+      # @return [Hash]
+      #
+      # @example Default.
+      #
+      #   {
+      #     service: result.service,
+      #     status: :success,
+      #     data: {foo: :bar},
+      #     message: "",
+      #     code: :default_success,
+      #     step: result.step
+      #   }
+      #
+      def create_result_attributes_with_step(step: Support::NOT_PASSED)
+        step = (step == Support::NOT_PASSED) ? create_result_step : step
+
+        result_attributes = create_result_attributes
+
+        result_attributes.merge(step: step)
+      end
+
+      ##
+      # @return [ConvenientService::Service::Plugins::HasResult::Entities::Result]
+      #
+      # @example Default.
+      #
+      #   class Service
+      #     include ConvenientService::Standard::Config
+      #
+      #     def result
+      #       success # `result_parent` is return value
+      #     end
+      #   end
+      #
+      def create_result_parent
+        create_result
+      end
+    end
+  end
+end