salestation 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ad0a5c28c6ca1928c3bc706710d16a3bc0866c3
-  data.tar.gz: fdaaedb5d408d3d4cd352ee19c54a084ee55ff0c
+  metadata.gz: 7af82fc0b7698f3f66945b5291d2a2d9ccf869bd
+  data.tar.gz: e0f635d0e541cb790124900cc7c6b2cc10a8fc5e
 SHA512:
-  metadata.gz: ffaa1d8a34ea0d68084a7392579c97307cfed6561620e0de64a2970d4daddba3d8ba2ea2d25c4d168cba0d0e921715fc7cb85ec480e06fafd82477af484019fe
-  data.tar.gz: a1cc884e2202b47881d7bda8e6c377bf761fbaca1a8882d8c6070fb66607b2e3097121e7823960eeadbef9b3e9ef175312a7fd74722a5bf19c7c612ce04ea0ec
+  metadata.gz: deab697cdfd27d779bdf67e09508e0dbadb602e0351b6727592f9d695e54de121223133f01d8e92af3ca818fe5952b3f8831f49c776b5e508ea8f61c23081db5
+  data.tar.gz: 818726078b70b2e9a44b6af528e81a8e2aaef8ceffba89ec299b61c345c67a002152d164f6200fd31dfa5f33ca46f584118760728c70ad8fd713f6cca194f0b3

data/README.md

@@ -1,9 +1,5 @@
 # Salestation
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/salestation`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,13 +12,66 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install salestation
+### Using Salestation with Sinatra
 
-## Usage
+First include `Salestation::Web`. This will provide a method called `process` to execute a request and Responses module for return codes.
+```ruby
+class Webapp < Sinatra::Base
+  include Salestation::Web.new
+end
+```
 
-TODO: Write usage instructions here
+Create Salestation application:
+```ruby
+  def app
+    @_app ||= Salestation::App.new(env: ENVIRONMENT)
+  end
+```
+
+Define a route
+```ruby
+post '/hello/:name' do
+  process(
+    HelloUser.call(app.create_request(
+      name: params['name']
+    )).map(Responses.to_ok)
+  )
+end
+```
+
+Define chain
+```ruby
+class HelloUser
+  def self.call(request)
+    request >> upcase >> format
+  end
+
+  def self.upcase
+    -> (request) do
+      input.with_input(name: input.fetch(:name).upcase)
+    end
+  end
+
+  def self.format
+    -> (request) do
+      name = request.input.fetch(:name)
+      Deterministic::Result::Success(message: "Hello #{name}")
+    end
+  end
+end
+```
+
+### Using custom errors in error mapper
+
+Salestation allows and recommends you to define your own custom errors. This is useful when your app has error classes that are not general enough for the salestation library.
+
+```ruby
+  include Salestation::Web.new(errors: {
+    CustomError => -> (error) { CustomResponse.new(error) }
+  })
+```
 
 ## Development
 

data/lib/salestation/web/error_mapper.rb

@@ -1,7 +1,9 @@
 module Salestation
-  module Web
-    module ErrorMapper
-      ERROR_TO_RESPONSE = {
+  class Web < Module
+    class ErrorMapper
+      UndefinedErrorClass = Class.new(StandardError)
+
+      ERROR_TO_RESPONSE_DEFAULTS = {
         App::Errors::InvalidInput => -> (error) {
           Responses::UnprocessableEntityFromSchemaErrors.create(error)
         },
@@ -19,9 +21,13 @@ module Salestation
         }
       }.freeze
 
-      def self.map
+      def initialize(map = {})
+        @error_to_response_map = ERROR_TO_RESPONSE_DEFAULTS.merge(map)
+      end
+
+      def map
         -> (error) do
-          _, error_mapper = ERROR_TO_RESPONSE
+          _, error_mapper = @error_to_response_map
             .find {|error_type, _| error.kind_of?(error_type) }
 
           # Interpret a Failure from the application layer as Success in the web
@@ -32,7 +38,7 @@ module Salestation
           elsif error.is_a?(Hash)
             Deterministic::Result::Success(Responses::InternalError.new(error))
           else
-            raise "Unknown error #{error.class.name}"
+            raise UndefinedErrorClass, "Undefined error class: #{error.class.name}"
           end
         end
       end

data/lib/salestation/web/responses.rb

@@ -1,5 +1,5 @@
 module Salestation
-  module Web
+  class Web < Module
     module Responses
       def self.to_created
         -> (object) { Deterministic::Result::Success(Responses::Created.new(body: object)) }

data/lib/salestation/web.rb

@@ -1,22 +1,31 @@
 require 'deterministic'
 require 'dry-struct'
 require 'dry-types'
+require 'json'
 
 module Salestation
-  module Web
+  class Web < Module
     module Types
       include Dry::Types.module
     end
 
-    def process(response)
-      result = response.map_err(&ErrorMapper.map).value
-
-      status result.status
-      json JSON.dump(result.body)
+    def initialize(errors: {})
+      @error_mapper = ErrorMapper.new(errors)
     end
 
-    def create_request(env, input)
-      App::Request.create(env: env, input: input)
+    def included(base)
+      error_mapper = @error_mapper
+
+      base.class_eval do
+        const_set :Responses, Salestation::Web::Responses
+
+        define_method(:process) do |response|
+          result = response.map_err(error_mapper.map).value
+
+          status result.status
+          json JSON.dump(result.body)
+        end
+      end
     end
   end
 end

data/salestation.gemspec

@@ -4,9 +4,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "salestation"
-  spec.version       = "0.0.6"
-  spec.authors       = ["SaleMove Developers"]
-  spec.email         = ["support@salemove.com"]
+  spec.version       = "0.1.0"
+  spec.authors       = ["SaleMove TechMovers"]
+  spec.email         = ["techmovers@salemove.com"]
 
   spec.summary       = %q{}
   spec.description   = %q{}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salestation
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
-- SaleMove Developers
+- SaleMove TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,7 +96,7 @@ dependencies:
         version: '0'
 description: ''
 email:
-- support@salemove.com
+- techmovers@salemove.com
 executables: []
 extensions: []
 extra_rdoc_files: []