convenient_service 0.12.0 → 0.14.0

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Entities
           class Description
             def initialize(value:)

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Entities
           class Format
             def initialize(value:)

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Entities
           ##
           # TODO: https://ruby-doc.org/3.1.3/stdlibs/yaml/YAML/DBM.html

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Entities
           class Logger
             class << self

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Entities
           class Request
             attr_reader :http_string

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Entities
           class Source
             def initialize(value:)

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Entities
           class Tag
             def initialize(value:)

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Entities
           class Title
             def initialize(value:)

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Services
           class ApplyDefaultParamValues
             include ConvenientService::Standard::Config

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Services
           class CastParams
             include ConvenientService::Standard::Config

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Services
           class ExtractParamsFromBody
             include ConvenientService::Standard::Config

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Services
           class ExtractParamsFromPath
             include ConvenientService::Standard::Config

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Services
           class FilterOutUnpermittedParams
             include ConvenientService::Standard::Config

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Services
           class LogRequestParams
             include ConvenientService::Standard::Config

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Services
           class MergeParams
             include ConvenientService::Standard::Config

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Services
           class Prepare
             include ConvenientService::Standard::Config

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Services
           class ValidateCastedParams
             include ConvenientService::Standard::Config

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

@@ -3,7 +3,7 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Services
           class ValidateUncastedParams
             include ConvenientService::Standard::Config

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

@@ -3,10 +3,10 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Utils
           module Array
-            class Wrap < Support::Command
+            class Wrap < ConvenientService::Command
               ##
               # @!attribute [r] pad
               #   @return [Object] Can be any type.

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

@@ -5,7 +5,7 @@ require_relative "array/wrap"
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Utils
           module Array
             class << self

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

@@ -3,14 +3,14 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Utils
           module HTTP
             module Request
               ##
               # TODO: Specs.
               #
-              class ParseBody < Support::Command
+              class ParseBody < ConvenientService::Command
                 attr_reader :http_string
 
                 def initialize(http_string:)

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

@@ -3,14 +3,14 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Utils
           module HTTP
             module Request
               ##
               # TODO: Specs.
               #
-              class ParsePath < Support::Command
+              class ParsePath < ConvenientService::Command
                 attr_reader :http_string
 
                 def initialize(http_string:)

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

@@ -6,7 +6,7 @@ require_relative "request/parse_path"
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Utils
           module HTTP
             module Request

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

@@ -6,13 +6,13 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Utils
           module Integer
             ##
             # TODO: Specs.
             #
-            class SafeParse < Support::Command
+            class SafeParse < ConvenientService::Command
               attr_reader :object
 
               def initialize(object)

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

@@ -9,7 +9,7 @@ require_relative "integer/safe_parse"
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Utils
           module Integer
             class << self

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

@@ -11,10 +11,10 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Utils
           module JSON
-            class SafeParse < Support::Command
+            class SafeParse < ConvenientService::Command
               attr_reader :json_string, :default_value
 
               def initialize(json_string, default_value: nil)

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

@@ -5,7 +5,7 @@ require_relative "json/safe_parse"
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Utils
           module JSON
             class << self

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

@@ -6,13 +6,13 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Utils
           module Object
             ##
             # TODO: Specs.
             #
-            class Blank < Support::Command
+            class Blank < ConvenientService::Command
               attr_reader :object
 
               def initialize(object)

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

@@ -6,13 +6,13 @@
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Utils
           module Object
             ##
             # TODO: Specs.
             #
-            class Present < Support::Command
+            class Present < ConvenientService::Command
               attr_reader :object
 
               def initialize(object)

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

@@ -6,7 +6,7 @@ require_relative "object/present"
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         module Utils
           module Object
             class << self

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

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

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

@@ -5,3 +5,4 @@ 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

@@ -36,7 +36,7 @@ require_relative "request_params/utils"
 module ConvenientService
   module Examples
     module Standard
-      module RequestParams
+      class RequestParams
         include ConvenientService::Feature
 
         entry :prepare do |request|

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "date_time/services"
+
+##
+# @internal
+#   Usage examples:
+#
+#   result = ConvenientService::Examples::Standard::V1::DateTime.safe_parse("24-02-2024", "%d-%m-%Y")
+#
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        class DateTime
+          include ConvenientService::Feature
+
+          entry :safe_parse do |string, format|
+            Services::SafeParse[string: string, format: format]
+          end
+        end
+      end
+    end
+  end
+end