tradesman 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88a8291acc6f38c6d19ff311c2c2ab950c755288
-  data.tar.gz: dca95fa986b0e498bec27f5205fbec416d547c78
+  metadata.gz: 0ea231527a974f62567a09d96470e63b76b4d4dc
+  data.tar.gz: 69f01315549ff78600d26241d780ce82a05bb680
 SHA512:
-  metadata.gz: e403a3da8460e086194e472c92d2827e2e132da3f2150dc26b7a7d248b476f851289f70e6fc95959efd7ee90646981eaaf29bd12a78c94c111fe918893b8563d
-  data.tar.gz: c601b711e3e59ae362c9fed58870c1b5e3f92e488963d49a9a956c27c0156e9869ce7520bdfc50e55d46643f4cd9ca67006efb26253523e3972fa2f4b178ba4e
+  metadata.gz: d96de3e357daa072bc382cd35e20ef70c90c7cb685a96a5a5c5351b3e275e8e5b363984e460165eca368fe3247ef3fef0dcb68544508922948499c1a8e455524
+  data.tar.gz: d36f8d0d668865ac215bd49674132fd74bf40229fb61b12f77c16530ba00f8a0c736e613626d704c62750f1832e6b6146c3853487cb212828fac8bee31926b18

data/README.md

@@ -1,6 +1,6 @@
 # Tradesman
 
-Tradesman lets you invoke human-readble classes that handle the pass, fail, and invalid cases of common create, update, and delete actions without having to write the code!
+Tradesman lets you invoke human-readble classes that handle the pass, fail, and invalid cases of common create, update, and delete actions.
 
 ## Usage
 
@@ -19,7 +19,8 @@ outcome.result #=> Error Class
 outcome.type #=> :validation
 
 # With invalid parameters - fail loudly!
-outcome = Tradesman::CreateUser.go!(invalid_user_params) #=> raises Tradesman::Invalid or Tradesman::Failure
+outcome = Tradesman::CreateUser.go!(invalid_user_params)
+#=> raises Tradesman::Invalid or Tradesman::Failure
 
 # Passing a block - Well-suited for Controllers
 Tradesman::UpdateUser.go(params[:id], user_update_params) do
@@ -52,8 +53,6 @@ Tradesman::CreateUserForEmployer.go(employer, [user_params, user_params, user_pa
 Tradesman::UpdateUser.go([user1, user2, user3], update_params)
 
 # Update n records with n sets of parameters
-# Whenever you pass an id, you can either pass the id itself,
-# or an object that response to :id
 update_params = {
   user1.id => user1_params,
   user2.id => user2_params,
@@ -94,10 +93,63 @@ CreateInvoiceForCustomer
 
 Where 'For' is a string literal and **ParentRecord** is the parent model classname, CamelCased.
 
+## Parameters
+
+**Create**
+
+`Create` classes take either a parameters hash or an array of parameters hashes.
+
+Examples:
+```ruby
+Tradesman::CreateUser.go(params)
+Tradesman::CreateUser.go([params1, params2, params3])
+```
+
+**CreateForParent**
+
+`CreateForParent` classes take a parent and either a parameters hash or an array of parameters hashes.
+The parent can either be an :id or an object that responds to #id.
+
+Examples:
+```ruby
+Tradesman::CreateInvoiceForCustomer.go(customer, invoice_params)
+Tradesman::CreateInvoiceForCustomer.go(123, [invoice1, invoice2, invoice3])
+```
+
+**Update**
+
+`Update` classes take a record or array of records, and a paramter hash or array of parameter hashes.
+
+Examples:
+```ruby
+# Update a single record
+Tradesman::UpdateUser.go(user, update_params)
+
+# Update multiple records with the same parameters
+Tradesman::UpdateUser.go([111, 222, 333], update_params)
+
+# Update n records with n sets of parameters
+update_params = {
+  user1 => user1_params,
+  user2 => user2_params,
+  user3 => user3_params
+}
+Tradesman::UpdateUser.go(update_params.keys, update_params.values)
+```
+
+**Delete**
+
+`Delete` classes take either a record of array of records.
+
+Examples:
+```ruby
+Tradesman::DeleteUser.go(123)
+Tradesman::DeleteUser.go([user1, user2, user3])
+```
 
 ## Why is this necessary?
 
-At Onfido, we observed that many Create, Update and Delete actions we programmed were are simple and repeated (albeit with different records and parameter lists) in several locations. They can generally be broken in to the following steps:
+Many Create, Update and Delete actions we program are simple and often repeated (albeit with different records and parameter lists) in several locations. They can generally be broken in to the following steps:
 
 - Query existing record by some group of parameters, but generally just by :id (Update and Delete only)
 - Return 404 if record does not exist
@@ -129,17 +181,19 @@ Tradesman is designed to handle the above and a few other common use-cases to re
 
 Tradesman version of the above:
 ```ruby
-Tradesman::UpdateUser.go(user_id, user_params) do
-  success do |result|
-    @user = result
-    render 'user'
-  end
+def update
+  Tradesman::UpdateUser.go(params[:id], user_params) do
+    success do |result|
+      @user = result
+      render 'user'
+    end
 
-  invalid do |error|
-    render(text: error.message, status: 422)
-  end
+    invalid do |error|
+      render(text: error.message, status: 422)
+    end
 
-  failure { |result| render(text: 'false', status: 400) } # If you prefer one-liners
+    failure { |result| render(text: 'false', status: 400) } # If you prefer one-liners
+  end
 end
 
 private
@@ -149,20 +203,34 @@ def user_params
 end
 ```
 
-The Tradesman version says exactly what it does, is cruft free, and is much quicker to test (more on that later).
+The Tradesman version is self-documenting, cruft-free, and designed for testing.
 
 ## Config
 
 **Define your adapter**
 
+Tradesman sits on top of [Horza](https://github.com/onfido/horza/), and can use any of its adapters.
+
 ```ruby
 # config/initializers/tradesman.rb
 Tradesman.configure { |config| config.adapter = :active_record }
 ```
 
-**Development Mode and Model Namespaces**
+**Development Mode**
 
-Rails' lazy-loading in the development environment makes a bit more configuration necessary, particularly if you have wrapped your models in namespaces.
+Turn on development mode to help Tradesman cope with Rails' lazy-loading of classes.
+
+```ruby
+# config/initializers/tradesman.rb
+Tradesman.configure do |config|
+  config.adapter = :active_record
+  config.development_mode = Rails.env.development?
+end
+```
+
+**Model Namespaces**
+
+Lazy loading becomes more complex if your models are namespaced.
 
 Consider:
 ```ruby
@@ -179,7 +247,7 @@ module MyOtherNamespace
 end
 ```
 
-In order to help Tradesman lazy load these models, you need to enable development mode and configure any namespaces:
+In order to help Tradesman lazy load these models, you need to explicitly configure any namespaces:
 
 ```ruby
 # config/initializers/tradesman.rb
@@ -195,10 +263,6 @@ end
 Tradesman.reset
 ```
 
-## Adapters
-
-Tradesman sits on top of [Horza](https://github.com/onfido/horza/), and can use any of its adapters.
-
 ## Edge Cases
 
 **Models ending with double 's'**

data/lib/tradesman/class_methods.rb

@@ -24,9 +24,10 @@ module Tradesman
     end
 
     def id_from_obj(obj)
-      return obj.id if obj.respond_to? :id
-      raise Tradesman::InvalidId.new('ID must be an integer') unless obj.is_a? Integer
-      obj
+      id = obj.respond_to?(:id) ? obj.id : obj
+      Integer(id)
+    rescue ArgumentError
+      raise Tradesman::InvalidId.new('You must pass an object that responds to id or an integer')
     end
 
     def prepare_params(params)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tradesman
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Blake Turner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: horza