acts_responsible 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1669e05d3269e0ffb9b5ecf35ba727f571e09c1a
-  data.tar.gz: c57a006f18a768035260dd372a8f3bcb7520ef4c
+  metadata.gz: 9908d8a71f51a90e2f7181da2fef994149221d79
+  data.tar.gz: cc9c2624bd1c6a8170fc6dad96a17afc17e7a444
 SHA512:
-  metadata.gz: 6ecdfbf7202c1d6a6fa957b1248a38a590a92c871119b39f4ea6b0c8d5e8ded595a05fe0b582c743694f8eb78244b21adde55814e23ce0560f94f770e24dd7fc
-  data.tar.gz: 82e560c6615670f6c0fa32a9fa461827517fe7a4a4106e12ecbc8f504d86d48ab68bd055d6b6e7f3fc42452b8621413659bcfd2a468cf7ac32087564c69f4d8d
+  metadata.gz: abc86965229b146a8b839210eca05244ac8e42967d01426d912589e29bfb58e64b8261ea6b4c678f6293a55b0c7f5ab877d11b1a75a739ec1fdbb6ea3ad1c00d
+  data.tar.gz: ad6d540123e0808f725022845a094a0ec62b36dc61707f498e59e46219acb05a0275913aaac5cc5b352914efc3c3b08896f082ca6c8fdf6280980c46d9647e48

data/README.md

@@ -1,7 +1,5 @@
 # ActsResponsible
 
-TODO: Write a gem description
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,11 +16,66 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+1.  Add `acts_responsible` to your API controller(s):
+
+    ```ruby
+    include ActsResponsible
+
+    class Api::V1::ApiController < ApplicationController
+
+      acts_responsible('api/v1')
+
+    end
+    ```
+
+2.  Render your responses, complete with errors or metadata:
+
+    ```ruby
+    class Api::V1::PostsController < API::V1::ApiController
+
+      def index
+        @posts = Post.all
+        # 200 OK with a root-level `posts` collection that
+        # renders @posts using a "posts/post" RABL template
+        render_response @posts, 'posts', 'posts/post'
+      end
+      
+      def create
+        @post = Post.new(article_params)
+        if @post.save
+          # render the new post's `id` using a simple "id" RABL template
+          render_response @post, 'post', 'id'
+          # OR we could simply render a 200 OK with empty body
+          render_empty_response
+        else
+          # take an HTTP status code and automatically parse ActiveRecord errors
+          render_error :unprocessable_entity, @post.errors
+        end
+      end
+
+    end
+    ```
+
+-   Example `posts/post.rabl` template:
+
+    ```ruby
+    attributes :id, :title, :body
+
+    node :created_at do |post|
+      post.created_at.utc.to_i
+    end
+    ```
+
+-   Example `id.rabl` template:
+
+    ```ruby
+    attributes :id
+    ```
+
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/acts_responsible/fork )
+1. Fork it ( https://github.com/danlite/acts_responsible/fork )
 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`)

data/lib/acts_responsible/version.rb

@@ -1,3 +1,3 @@
 module ActsResponsible
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: acts_responsible
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Daniel Lichty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rabl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement