blacksheep 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75dfef125950bec755e918dba9e56bf6877ab8a3baedc2e42d16b62e31aa395c
-  data.tar.gz: 4ef04a290cd93670d126e910022cada3a16bb446af06eb26e759073c87e2a3b6
+  metadata.gz: 0f9f95a300f2d7c84826615cb86a66fabe8ecdd680edabf6b9e960973d8f5f83
+  data.tar.gz: 3cdfd65ec9647bed1ff5df0261b000227f395d379a9c310e8def4de9b0439c83
 SHA512:
-  metadata.gz: '0084555561e9b92801cf7524379c6e3523eda987a612beb869f8be81abf69c4ebba673ebf609c1310074f7f2d65c954998061cb70701e1052a6efb6507431eeb'
-  data.tar.gz: d5e729097addb0df435e051c8289de2e8c0ca06d1d17d1690c630ab251a657d169719b5dc70cde2744537aac5f0cf544d9ee05d2596668151ff306609d5054b2
+  metadata.gz: ac515283bff176a47ffa4b6159e169c7a3776bc1e2d0f587182e479420b805b0633e2f909a9720bbff15bcc68776ce9f180e51e6a014e2e2ef2ae261b6114d94
+  data.tar.gz: 1c7008322b347109e570b87f8a83b6512a7380c4021e779655fb80f8bd426efc9aad3a1a606c73dd09e7735f2a85dd927e5f8f472ce5650323ec7d90283c82cf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    blacksheep (0.1.0)
+    blacksheep (0.2.2)
       dry-matcher
 
 GEM
@@ -38,4 +38,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/README.md

@@ -24,24 +24,24 @@ Or install it yourself as:
 
 ### Actions
 
-Core if blacksheep is the Blacksheep::Action. It provides basic fuctionality to handle rest API actions - but can handle other actions as well. The core methods of Actions are:
+Core of blacksheep is the `Blacksheep::Action`. It provides basic functionality to handle rest API actions - but can handle other actions as well. The core methods of actions are:
 
-  * #perform, and…
-  * #call
+  * #perform with a block that implements the action
+  * #call on an action instance for processing and a potential block for result matching (see dcorators below).
 
 `#perform` takes a block that is executed with the params passed. #perform has the following api:
   `#perform(params, current_user: (default to nil), **options)`
 
-`#call` can be used when a Blacksheep::Action is sublassed as an action processing its opertation in a call method with the same signature of `#perform`
+`#call` can be used when a Blacksheep::Action is sublassed as an action processing its opertation in a call method with the same signature of `#perform`. When using the `ResultMatcher` decorator a block can be used for result matching.
 
 
 ```ruby
-##perform sample
+#perform sample
 action_result = Blacksheep::Action.new.perform(params) do |params|
   # do somethin with the params that return a `Blacksheep::ActionResult`
 end
 
-##perform sample
+#call sample
 action_result = MyAction.new.call(params, current_user: current_user)
 ```
 
@@ -50,14 +50,14 @@ action_result = MyAction.new.call(params, current_user: current_user)
 
 ### Decorators
 
-This alone does not give any benefit. It more interesting to modifiy the action with decorators such as:
+This alone does not give any benefit. Modifying the action with decorators adds additional functionality:
 
   * `JsonTransformer`
   * `Localizer`
   * `DefaultErrorHandler`
   * `ResultMatcher`
 
-The decaorators can be configured globaly by defining them in an initializer.
+The decaorators can be configured globally by defining them in an initializer.
 
 ```ruby
 # Defining decorator wheras innermost is first
@@ -74,7 +74,7 @@ A localizer sets the I18n locale when passed in a request parameter named `_loca
 
 #### Blacksheep::Decorators::DefaultErrorHandler
 
-A default error handler can be used in API opertions. The handler catches an error and returns a JsonResultObject such as
+A default error handler can be used in API opertions. The handler catches an error and returns an ActionResult such as…
 
 ```ruby
 def handle_exception(exception)
@@ -93,20 +93,20 @@ def handle_exception(exception)
 end
 ```
 
-You can write your own Errorhandler by including the module `Blacksheep::Decorators::ErrorHandler` and implementing the method `#handle(exception)`.
+You can write your own ErrorHandler by including the module `Blacksheep::Decorators::ErrorHandler` and implementing the method `#handle_exception(<Exception>)`.
 
 
 #### Blacksheep::Decorators::JsonTransformer
 
-Assuming the params is a json payload with a specific caseing (e.g. camelCase when used in a JS application such as vue) the JsonTransfomer takes the params and tranforms it's keys into snake_case as used in ruby often.
-The request has to define the case passed (and hence desired response casing) in the parameter `_case`. If the case is requests as `camel` then paramter keys are tranformed to `snake_case` before going into the action and are transformed back into CamelCase when leaving the operation.
+Assuming the params is a json payload with a specific caseing (e.g. camelCase when used in a JS application such as Vue) the JsonTransfomer takes the params and transforms it's keys into snake_case as used in ruby often.
+The request has to define the case passed (and hence desired response casing) in the parameter `_case`. If the case is requests as `camel` then parameter keys are transformed to `snake_case` before beeing passed into the action and are transformed back into CamelCase when leaving the operation.
 
 If JsonTransfomer is used the action should return a simple JSON structure which is transfformed and stored in an ActionResult.
 
 
 #### Blacksheep::Decorators::ResultMatcher
 
-This decorator can be used when implementing your own actions by subclassing `Blacksheep::Action` and using the  `#call` style for processing. Adding the matcher decorator enables to write a matchers such as e.g.
+This decorator can be used when implementing your own actions by subclassing `Blacksheep::Action` and using the  `#call` style for processing. Adding the `ResultMatcher` decorator enables to write a matcher block such as…
 
 ```ruby
 MyAction.new.call(params) do |m|
@@ -122,7 +122,7 @@ MyAction.new.call(params) do |m|
 end
 ```
 
-The action has to return a Blacksheep::ActionResult which is check for status :ok in sucess case and any other status in failure case.
+The action has to return a Blacksheep::ActionResult which is checked for status `:ok` for success case and any other status in failure case.
 
 
 ## Development
@@ -134,7 +134,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ```
 gem build blacksheep
 gem push blacksheep-0.x.y.gem
-```
+``
 
 ## Contributing
 

data/blacksheep.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
     spec.metadata["homepage_uri"] = spec.homepage
-    # spec.metadata["source_code_uri"] = "Put your gem's public repo URL here."
+    spec.metadata["source_code_uri"] = "https://github.com/verticonaut/blacksheep"
     # spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
   else
     raise "RubyGems 2.0 or newer is required to protect against " \

data/lib/blacksheep/version.rb

@@ -1,3 +1,3 @@
 module Blacksheep
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacksheep
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Martin Schweizer
@@ -99,6 +99,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: http://verticonaut.me
+  source_code_uri: https://github.com/verticonaut/blacksheep
 post_install_message:
 rdoc_options: []
 require_paths: