tradesman 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff0c272af8227151aed9bfd3117d3e9e563a2421
-  data.tar.gz: cfd71b052b452a8c03b9661b58c5de9780bb8a6f
+  metadata.gz: 11e364aa8aa559b1fde2cc8dbe60a017ceae2b99
+  data.tar.gz: 490d82d0fdd65109eb01f8a1a3a6d9f0282029c2
 SHA512:
-  metadata.gz: cda47f9fbfa8af03503eefc79f27752efa57688c02a847a30fa909cc6d5576bdcefea4e296b44925b42c87fae104d6850778d8c0133105c8fc069411a31bfc45
-  data.tar.gz: 507e619be7e917d84a4c4d657c7e2b77d3a22fa346a3bd40b94fce02383f43d83c3afb0a409cf3dbe91d42a7c450c2ee88151f13df70acb70b4f61313fc64d1a
+  metadata.gz: d6924c2f37b47fefe39b121951b52407d7f8a7251e931a5207b2d6c8df6be6c297f0b7c1f5395f12f0211c53d31edbac90e8b41979f61893d95be67cc01b4db7
+  data.tar.gz: 635b74cfa73a87ae22900419d71d11c0c7c1110468079f39087cda3b25b3d5008c3e9e269253bf7a3a8ba8d374111aaa4da3747e843c565e62db9cafce844637

data/README.md

@@ -263,6 +263,82 @@ end
 Tradesman.reset
 ```
 
+## Mocking & Stubbing in Tests
+
+Tradesman uses the [Tzu](https://github.com/onfido/tzu) command library,
+which has a specialized (and well-documented) gem for mocking/stubbing, [TzuMock](https://github.com/onfido/tzu_mock).
+
+Since Tradesman classes are just dynamically generated Tzu commands with a slightly different interface,
+you must configure TzuMock to accept the Tradesman interface.
+
+```ruby
+# spec/spec_helper.rb
+TzuMock.configure { |config| config.stub_methods = [:go, :go!] }
+```
+
+Then, you can use TzuMock to stub any Tradesman outcome - `success`, `invalid`, and `failure`.
+
+```ruby
+# app/controllers/users_controller.rb
+class UsersController < ActionController::Base
+  def create
+    Tradesman::CreateUser.go(params) do
+      success do |result|
+        @user = result
+        render 'user'
+      end
+
+      invalid do |error|
+        render 'error'
+      end
+    end
+  end
+end
+
+# spec/controllers/users_controller.rb
+describe '#create' do
+  context 'on success' do
+    let(:entity) { Horza.single(FactoryGirl.attributes_for(:user)) }
+
+    before do
+      TzuMock.success(Tradesman::CreateUser, entity)
+      post :create, request
+    end
+
+    it 'assigns user' do
+      expect(assigns(:user)).to eq entity
+    end
+
+    it 'renders the user template' do
+      expect(response).to render_template('user')
+    end
+  end
+
+  context 'on invalid' do
+    before do
+      TzuMock.invalid(Tradesman::CreateUser, { error: 'invalid path' })
+      post :create, request
+    end
+
+    it 'renders the error template' do
+      expect(response).to render_template('error')
+    end
+  end
+end
+```
+
+Note that Tradesman returns [Horza](https://github.com/onfido/horza) entities by default, so it is recommended to return Horza entities when stubbing.
+Horza provides two shortcuts for this:
+
+```ruby
+# Single entity, takes a hash
+Horza.single(hash) #=> Horza::Entities::Single
+
+# Collection, takes an array
+Horza.collection(items) #=> Horza::Entities::Collection
+```
+
+
 ## Edge Cases
 
 **Models ending with double 's'**

data/lib/tradesman/error_handling.rb

@@ -3,7 +3,7 @@ module Tradesman
     def run_and_convert_exceptions(&block)
       block.call
     rescue *expected_errors_map.keys => e
-      raise tradesman_error_from_gem_error(e.class)
+      raise tradesman_error_from_gem_error(e.class).new(e.message)
     end
 
     def tradesman_error_from_gem_error(gem_error)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tradesman
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Blake Turner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-23 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: horza
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.6
+        version: 0.3.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.6
+        version: 0.3.8
 - !ruby/object:Gem::Dependency
   name: tzu
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1.0
+        version: 0.0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.1.0
+        version: 0.0.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement