salestation 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fab51d38331535ba91704962caed90aafe63239b
-  data.tar.gz: f9a1cab5d37fb3af72a9db99f42d8021ed10211a
+  metadata.gz: f1b525e1ec3e904fe1121233b9c9334348df43d0
+  data.tar.gz: 8b74d25e23e0c52c214591b55ad8a347765e2b32
 SHA512:
-  metadata.gz: d3a2ded9db7798961555d9cac8c478e09d701c60bd4a7ed66a56771c88a4989b7c16a7091a1c162f2ee117ac29408561be2552f6424e450c0f4f0dc1bbaa8562
-  data.tar.gz: c48aa6527625c1635c9746e9a7c5201d3b31d46cdeeb323e3c88fa6bccb0258f25e2bb1c7e8a0028203d37ff3c23e1b185a26376d73127124e58df9b9768463a
+  metadata.gz: 4c90e2e8ca7df677c87888b70788c0ac1337e78beb4f777a4825d2a57d6cd5167a19e9e80b383732ba8a390400bc2127050c67a8429adf9d1c2d2dd90d5b84f3
+  data.tar.gz: 5a50bc06f24eda87d84955e84eeffc253c87b33729b5c3cdb797f0ac521037278ccb949e976f06bd2e5134adae4b9e99af52fee26e5afc9a10614d2f5adf0e70

data/README.md

@@ -75,6 +75,50 @@ Salestation allows and recommends you to define your own custom errors. This is
   })
 ```
 
+### Using Extractors
+
+Salestation provides extractors to fetch parameters from the request and pass them to the chain.
+Available extractors are `BodyParamExtractor`, `QueryParamExtractor`, `ConstantInput`, `HeadersExtractor`.
+Multiple extractors can be merged together. If two or more extractors use the same key, the value will be from the last extractor in the merge chain.
+
+`coercions` can optionally be provided to `BodyParamExtractor` and `QueryParamExtractor`. These can be used to transform the values of the extracted parameters.
+
+Define a route
+
+```ruby
+include Salestation::Web::Extractors
+
+post '/hello/:name' do |name|
+  coercions = {age: ->(age) { age.to_s }}
+
+  extractor = BodyParamExtractor[:age, coercions: coercions]
+    .merge(ConstantInput[name: name])
+    .merge(HeadersExtractor[{'authorization' => :auth}])
+
+  process extractor do |request|
+    HelloUser.call(request)
+      .map(Responses.to_ok)
+  end
+end
+
+ERROR_MAPPER = Salestation::Web::ErrorMapper.new
+
+def process(extract_input, &process_request)
+  response = extract_input.call(request).match do
+    Success() do |value|
+      create_request(value)
+        .map(process_request)
+        .map_err(&ERROR_MAPPER.map)
+    end
+    Failure() do |value|
+      Result::Success(value)
+    end
+  end
+rescue Salestation::Web::ErrorMapper::UndefinedErrorClass => exception
+  raise exception
+end
+```
+
 ### Using a logger
 
 Salestation provides a rack logging middleware which can be used to log structured objects.

data/lib/salestation/web.rb

@@ -30,6 +30,7 @@ module Salestation
   end
 end
 
+require_relative './web/extractors'
 require_relative './web/responses'
 require_relative './web/error_mapper'
 require_relative './result_helper'

data/lib/salestation/web/extractors.rb

@@ -0,0 +1,103 @@
+module Salestation
+  class Web < Module
+    module Extractors
+      class InputExtractor
+        include Deterministic
+
+        def initialize(&block)
+          @block = block
+        end
+
+        def call(rack_request)
+          @block.call(rack_request)
+        end
+
+        def merge(other)
+          CombinedInputExtractor.new([self, other])
+        end
+      end
+
+      class CombinedInputExtractor
+        def initialize(extractors)
+          @extractors = extractors
+        end
+
+        def compose_seq(fns, input)
+          fns.reduce(Deterministic::Result::Success({})) do |result, fn|
+            result.map do |previous_value|
+              fn.call(input).map do |new_value|
+                Deterministic::Result::Success(yield(previous_value, new_value))
+              end
+            end
+          end
+        end
+
+        def call(rack_request)
+          compose_seq(@extractors, rack_request) do |previous_input, new_input|
+            previous_input.merge(new_input)
+          end
+        end
+
+        def merge(other_extractor)
+          CombinedInputExtractor.new(@extractors + [other_extractor])
+        end
+      end
+
+      class HeadersExtractor
+        include Deterministic
+
+        def self.[](headers)
+          InputExtractor.new do |rack_request|
+            input = headers.map do |header, key|
+              value = rack_request.env["HTTP_#{header.upcase.tr('-', '_')}"]
+              next if value.nil?
+              [key, value]
+            end.compact.to_h
+
+            Result::Success(input)
+          end
+        end
+      end
+
+      class ParamExtractor
+        include Deterministic
+
+        def self.[](*keys, coercions: {}, rack_key:)
+          InputExtractor.new do |rack_request|
+            request_hash = rack_request.env[rack_key] || {}
+
+            input = keys
+              .select { |key| request_hash.key?(key.to_s) }
+              .map { |key| [key, request_hash[key.to_s]] }
+              .map { |key, value| coercions.key?(key) ? [key, coercions[key].call(value)] : [key, value] }
+              .to_h
+
+            Result::Success(input)
+          end
+        end
+      end
+
+      class QueryParamExtractor
+        def self.[](*keys, coercions: {})
+          ParamExtractor[*keys, coercions: coercions, rack_key: 'rack.request.query_hash']
+        end
+      end
+
+      class BodyParamExtractor
+        def self.[](*keys, coercions: {})
+          ParamExtractor[*keys, coercions: coercions, rack_key: 'rack.request.form_hash']
+        end
+      end
+
+      class ConstantInput
+        include Deterministic
+
+        def self.[](input)
+          InputExtractor.new do |**|
+            Result::Success(input)
+          end
+        end
+      end
+    end
+  end
+end

data/salestation.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "salestation"
-  spec.version       = "0.2.1"
+  spec.version       = "0.3.0"
   spec.authors       = ["SaleMove TechMovers"]
   spec.email         = ["techmovers@salemove.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salestation
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - SaleMove TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-26 00:00:00.000000000 Z
+date: 2017-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ files:
 - lib/salestation/web.rb
 - lib/salestation/web/active_record_connection_management.rb
 - lib/salestation/web/error_mapper.rb
+- lib/salestation/web/extractors.rb
 - lib/salestation/web/request_logger.rb
 - lib/salestation/web/responses.rb
 - lib/salestation/web/statsd_middleware.rb
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: ''