simple_action 0.0.1.pre1 → 0.0.1.pre3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzUwZDEyY2UxMjMwMzZlZWE2ODg0MjMzMjUwZTJhYTIzZGE3ODM0Nw==
+    OGNmNTZkMDQxNDllYjJkMGQ5NjhlZjMyMTRiODEyNTk1Y2I0YzRkYg==
   data.tar.gz: !binary |-
-    ZjE0MmM4ZmExM2FmZGQwOGVlNTI4ZTJkZTBhN2M3ZjQ4MzZkMjQ1Yw==
+    ZWUxMDRiNmRlOWRiNWFjMGNhNTYyZGMzNzQ1YmE1NjFmMTEzNTcwMQ==
 SHA512:
   metadata.gz: !binary |-
-    NzAxYjQxMGQ2ZWEwNDMxZDAyMGFkMWUxYzZiMDkxNjUzYTZkODk5ZjBmMjRl
-    MjA1MDBmZWQyMjVkNjJlNTUwNWNmZWQ3Yzg3Zjg3MGM2ZjExY2JhNzM0ZDIw
-    ZDE5MDcxM2JkOGUyYjQwZGFjODFkZmQ5NTJlZjU5ZmQxMDY2NDM=
+    ZTVmZWZmOTk0MmVjYzQ5Yjk1ZTRiZjBkYzk4OTQ3N2YwYmJkZjg3MDQ0NDk2
+    Nzg5ZTY0MTkzMDBkNjQwM2FiY2Q4MzFjMGQ5ODIyMmY4ODc5OTQyZGFmMzE3
+    Zjk5NWVjNjA3YmFjODNmOTEyNDNmNGU5MjgwOTExOWE3ZmFjMjg=
   data.tar.gz: !binary |-
-    Nzg4ZjZjNWMzZDA2YjYyYWZkMTliNzEzZmI4NDllZmM4NjE1OTNlMGQyNDU0
-    MmY3NjE5MTcwM2E0NzE3ZTQwNmM3ZTc5NDAzM2IxYmRiZTRiMTk4N2FhYWVk
-    NmRiZDg5ZmMwZTMxZjg5ZmU1ZjZjYjg2ZDRhNGI3OTdlMWQzZWY=
+    MDg1NDRiNmRiZjdjYzA1NTFmYjk2ZTUzMzA5NDM2Zjk0N2M3NDIxYWRhMjEx
+    ZmMxMDgxZGVkYzM5YjM1NjE2NjMzMGVkMjg0YmU4MmU2OTVlNjNhYjJhNjQy
+    MDBjYzZkZDY1YzE4OGMyZWRmNzg5ODc1Y2ZhMjc2NTU1ZjYxMWM=

data/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     simple_action (0.0.1.pre1)
-      simple_params (>= 0.0.2.pre9, < 1.0)
+      simple_params (>= 0.0.4, < 1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -32,7 +32,7 @@ GEM
     ice_nine (0.11.1)
     json (1.8.2)
     method_source (0.8.2)
-    minitest (5.5.1)
+    minitest (5.6.1)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -46,8 +46,11 @@ GEM
     rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.3)
-    simple_params (0.0.2.pre9)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simple_params (0.0.4)
       activemodel (>= 3.0, < 5.0)
+      shoulda-matchers (~> 2.8)
       virtus (>= 1.0.0)
     slop (3.6.0)
     thread_safe (0.3.5)

data/README.md

@@ -1,2 +1,108 @@
-# simple_action
-A simple Service Object class for internal services, API endpoints, etc.
+# Simple Action
+
+Simple Action provides a convenient DSL for building API endpoints and service objects.  It builds significantly off the the parameter coercion/validation support provided by Simple Params [simple_params](https://github.com/brycesenz/simple_params).
+
+The design of this gem was greatly influenced by this post by Philippe Creux:
+http://brewhouse.io/blog/2014/04/30/gourmet-service-objects.html
+
+This class provides the following benefits for building API endpoints:
+  * Easy assignment and automatic validation of parameters with ActiveModel-like errors.
+  * A simple syntax for defining the execution block
+  * Easy validation, for integration into controllers
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_action'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_action
+
+## Defining your Service Class & Working with Rails Controllers
+
+A service class is defined by two things - the parameters it accepts, and the `execute` method:
+
+```ruby
+class RegisterUser < SimpleAction::Service
+  params do
+    param :name
+    param :age, type: :integer, validations: { numericality: { greater_than_or_equal_to: 18 } }
+    param :hair_color, default: "brown", validations: { inclusion: { in: ["brown", "red", "blonde", "white"] }}
+  end
+
+  def execute
+    user = User.create(name: name, age: age, hair_color: hair_color)
+    UserMailer.welcome_letter(user).deliver
+    user
+  end
+end
+```
+
+The class is executed via a `run` call to the class itself:
+
+```ruby
+response = RegisterUser.run(name: "Tom", age: 21)
+response.valid? #=> true
+response.errors.empty? #=> true
+response.result #=> User, id: 1, name: "Tom", age: 21
+
+response = RegisterUser.run(name: nil, age: 21)
+response.valid? #=> false
+response.errors[:name] #=> ["can't be blank"]
+response.result #=> nil
+```
+
+## Working with Rails Controllers
+
+Building off of the example service class above, our controller logic can now be greatly simplified, as such
+
+```ruby
+class UserController < ApplicationController
+  ...
+
+  def new
+    @registration = RegisterUser.new
+    render action: :new
+  end
+
+  def create
+    registration = RegisterUser.run(params[:register_user])
+    if registration.valid?
+      @user = registration.result
+      redirect_to @user, notice: "Success!"
+    else
+      @registration = registration
+      render action: :new, alert: "Errors!"
+    end
+  end
+```
+
+Because the service class behaves like an ActiveModel object with regards to it's attribute assignment and parameter validation, it will continue to work with Rails forms.
+
+
+# ApiPie Documentation
+
+If your project is using [apipie-rails](http://example.com/ "apipie-rails"),
+then SimpleAction is able to automatically generate the documentation markup
+for apipie.
+
+```ruby
+api :POST, '/users', "Registers a user"
+eval(RegisterUser.api_pie_documentation)
+```
+
+This feature is also delegated to the SimpleParams class.  You can read more on the details of that functionality here [simple_params](https://github.com/brycesenz/simple_params).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/simple_action/response.rb

@@ -21,5 +21,6 @@ module SimpleAction
     def result
       @result
     end
+    alias_method :value, :result
   end
 end

data/lib/simple_action/service.rb

@@ -12,7 +12,7 @@ module SimpleAction
       def run(params = {})
         instance = self.new(params)
         result = transaction do
-            instance.execute if instance.valid?
+          instance.execute if instance.valid?
         end
         Response.new(instance, result)
       end

data/lib/simple_action/version.rb

@@ -1,3 +1,3 @@
 module SimpleAction
-  VERSION = "0.0.1.pre1"
+  VERSION = "0.0.1.pre3"
 end

data/simple_action.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "simple_params", ">= 0.0.2.pre9", "< 1.0"
+  spec.add_dependency "simple_params", ">= 0.0.4", "< 1.0"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.1"
   spec.add_development_dependency "rspec", "~> 2.6"

data/spec/response_spec.rb

@@ -81,4 +81,24 @@ describe SimpleAction::Response do
       end
     end
   end
+
+  describe "#value" do
+    let(:object) { DummyServiceObjectClass.new(name: "Dummy") }
+
+    context "with no result provided" do
+      let(:response) { described_class.new(object) }
+
+      it "is nil" do
+        response.value.should be_nil
+      end
+    end
+
+    context "with response provided" do
+      let(:response) { described_class.new(object, 53) }
+
+      it "is 53" do
+        response.value.should eq(53)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_action
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre1
+  version: 0.0.1.pre3
 platform: ruby
 authors:
 - brycesenz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_params
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.2.pre9
+        version: 0.0.4
     - - <
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.2.pre9
+        version: 0.0.4
     - - <
       - !ruby/object:Gem::Version
         version: '1.0'