serviceable 0.4.2 → 0.4.3

data/README.md

@@ -1,5 +1,4 @@
-Serviceable
-=========
+# Serviceable
 
 Serviceable aims to reduce code duplication for common patterns, such as JSON/XML
 API endpoints. Instead of repeating the same patterns in multiple controllers and
@@ -19,8 +18,7 @@ Route:
     resources :posts
 
 
-Standard CRUD
--------------
+## Standard CRUD
 
     POST /posts.json
     GET /posts.json
@@ -28,20 +26,55 @@ Standard CRUD
     PUT /posts/1.json
     DELETE /posts/1.json
 
-Query Params
-------------
+## Query Params
+
+Full listing returned when no query params are given
 
     GET /posts.json
     [{"id":1,"title":"First Post!","body":"Feels good to be first","created_at":"20130727T16:26:00Z"}]
 
+Use the <code>only</code> param to specify fields on the collection
+
     GET /posts.json?only=id,title
     [{"id":1,"title","First post!"}]
-    
+
+Use the <code>include</code> param to specify associated objects or collections
+
     GET /posts.json?include=user
     [{"id":1,"title":"First Post!","body":"Feels good to be first","created_at":"20130727T16:26:00Z","user":{"id":2,"first_name":"Jim","last_name":"Walker","display_name":"Jim W."}}]
 
-Filter Params
--------------
+Combine params to configure the result contents
+
+    GET /posts.json?only=id,title&include[user][only]=first_name,last_name
+    [{"id":1,"title":"First Post!","user":{"first_name":"Jim","last_name":"Walker"}}]
+
+## Filter Params
+
+Use the <code>where</code> param to filter the results
+
+    GET /posts.json?where[posts][published]=true
+
+Use associated objects or collections to filter the set
 
     GET /posts.json?where[tags][label]=Pinball
-    returns a set of posts tagged as "Pinball"
+
+## Integrating with jQuery
+
+Working with a serviceable endpoint is easy with jQuery. Here's an example of a request for all posts
+tagged as "Pinball" including only post id and title:
+
+    $.ajax({
+      url: '/posts.json',
+      type: 'GET',
+      data: {
+        where: {
+          tags: {
+            label: 'Pinball'
+          }
+        },
+        only: 'id,title'
+      },
+      success: function(xhr,msg,data) {
+        console.log("received "+data.responseJSON.length+" results");
+      }
+    });

data/lib/serviceable.rb

@@ -150,7 +150,7 @@ module Serviceable
                   elsif op==:lt
                     @collection = @collection.where("#{assoc}.#{target_column} < ?",value)
                   elsif op==:in
-                    @collection = @collection.where("#{assoc}.#{target_column} IN (?)",value)
+                    @collection = @collection.where("#{assoc}.#{target_column} IN (?)",value.split(','))
                   end
                 end
               end  
@@ -168,7 +168,6 @@ module Serviceable
       
       define_method("is_time_column?") do |column|
         object.to_s.capitalize.constantize.columns.select {|e| e.name==column.to_s}.first.type == :timestamp rescue false
-        # !!column[-3,3]=='_at'
       end
       
       define_method("is_boolean_column?") do |column|

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: serviceable
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 0
   - 4
-  - 2
-  version: 0.4.2
+  - 3
+  version: 0.4.3
 platform: ruby
 authors: 
 - Aubrey Goodman