convenient_service 0.12.0 → 0.14.0

data/lib/convenient_service/examples/standard/v1/request_params/services/validate_casted_params.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        class RequestParams
+          module Services
+            class ValidateCastedParams
+              include ConvenientService::Standard::V1::Config
+
+              attr_reader \
+                :original_id,
+                :original_format,
+                :original_title,
+                :original_description,
+                :original_tags,
+                :original_sources
+
+              attr_reader \
+                :casted_id,
+                :casted_format,
+                :casted_title,
+                :casted_description,
+                :casted_tags,
+                :casted_sources
+
+              step :validate_id, in: [:original_id, :casted_id]
+              step :validate_format, in: [:original_format, :casted_format]
+              step :validate_title, in: [:original_title, :casted_title]
+              step :validate_description, in: [:original_description, :casted_description]
+              step :validate_tags, in: [:original_tags, :casted_tags]
+              step :validate_sources, in: [:original_sources, :casted_sources]
+
+              def initialize(original_params:, casted_params:)
+                @original_id = original_params[:id]
+                @original_format = original_params[:format]
+                @original_title = original_params[:title]
+                @original_description = original_params[:description]
+                @original_tags = original_params[:tags]
+                @original_sources = original_params[:sources]
+
+                @casted_id = casted_params[:id]
+                @casted_format = casted_params[:format]
+                @casted_title = casted_params[:title]
+                @casted_description = casted_params[:description]
+                @casted_tags = casted_params[:tags]
+                @casted_sources = casted_params[:sources]
+              end
+
+              private
+
+              def validate_id
+                return error("Failed to cast `#{original_id.inspect}` into `ID`") unless casted_id
+
+                success
+              end
+
+              def validate_format
+                return error("Failed to cast `#{original_format.inspect}` into `Format`") unless casted_format
+
+                success
+              end
+
+              def validate_title
+                return error("Failed to cast `#{original_title.inspect}` into `Title`") unless casted_title
+
+                success
+              end
+
+              def validate_description
+                return error("Failed to cast `#{original_description.inspect}` into `Description`") unless casted_description
+
+                success
+              end
+
+              ##
+              # TODO:
+              #
+              def validate_tags
+                success
+              end
+
+              ##
+              # TODO:
+              #
+              def validate_sources
+                success
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/standard/v1/request_params/services/validate_uncasted_params.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        class RequestParams
+          module Services
+            class ValidateUncastedParams
+              include ConvenientService::Standard::V1::Config
+
+              attr_reader :id, :format, :title, :description, :tags, :sources
+
+              step :validate_id, in: :id
+              step :validate_format, in: :format
+              step :validate_title, in: :title
+              step :validate_description, in: :description
+
+              def initialize(params:)
+                @id = params[:id]
+                @format = params[:format]
+                @title = params[:title]
+                @description = params[:description]
+                @tags = params[:tags]
+                @sources = params[:sources]
+              end
+
+              private
+
+              def validate_id
+                return error("ID is NOT present") if Utils::Object.present?(id)
+                return error("ID `#{id}` is NOT a valid integer") unless Utils::Integer.safe_parse(id)
+
+                success
+              end
+
+              def validate_format
+                return error("Format `#{format}` is NOT supported, only JSON is allowed") if format != "json"
+
+                success
+              end
+
+              def validate_title
+                return error("Title is NOT present") if Utils::Object.present?(title)
+
+                success
+              end
+
+              def validate_description
+                return error("Description is NOT present") if Utils::Object.present?(description)
+
+                success
+              end
+
+              ##
+              # TODO:
+              #
+              def validate_tags
+                success
+              end
+
+              ##
+              # TODO:
+              #
+              def validate_sources
+                success
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "services/apply_default_param_values"
+require_relative "services/cast_params"
+require_relative "services/extract_params_from_body"
+require_relative "services/extract_params_from_path"
+require_relative "services/filter_out_unpermitted_params"
+require_relative "services/log_request_params"
+require_relative "services/merge_params"
+require_relative "services/validate_casted_params"
+require_relative "services/validate_uncasted_params"
+
+require_relative "services/prepare"

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        class RequestParams
+          module Utils
+            module Array
+              class Wrap < ConvenientService::Command
+                ##
+                # @!attribute [r] pad
+                #   @return [Object] Can be any type.
+                #
+                attr_reader :object
+
+                ##
+                # @param object [Object] Can be any type.
+                # @return [void]
+                #
+                def initialize(object)
+                  @object = object
+                end
+
+                ##
+                # @return [Array]
+                #
+                # @internal
+                #   Copied without any modifications from:
+                #   https://api.rubyonrails.org/classes/Array.html#method-c-wrap
+                #
+                def call
+                  if object.nil?
+                    []
+                  elsif object.respond_to?(:to_ary)
+                    object.to_ary || [object]
+                  else
+                    [object]
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        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
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        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
+end

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

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

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

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

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+##
+#
+#
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        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
+end

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

@@ -0,0 +1,27 @@
+# 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 V1
+        class RequestParams
+          module Utils
+            module Integer
+              class << self
+                def safe_parse(string)
+                  SafeParse.call(string)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# 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 V1
+        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
+end

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

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

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+##
+#
+#
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        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
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+##
+#
+#
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        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
+end

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

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

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+##
+#
+#
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        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
+end

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

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

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

@@ -0,0 +1,8 @@
+# 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"