serviceable 0.2 → 0.4

data/lib/serviceable.rb

@@ -15,50 +15,58 @@ module Serviceable
     #
     def acts_as_service(object,options={})
 
-      before_filter :assign_new_instance, :only => :create
-      before_filter :assign_existing_instance, :only => [ :show, :update, :destroy ]
-      before_filter :assign_instances, :only => :index
+      before_filter :assign_new_instance, only: :create
+      before_filter :assign_existing_instance, only: [ :show, :update, :destroy ]
+      before_filter :assign_collection, only: [ :index, :count ]
+      before_filter :did_assign_collection, only: [ :index, :count ]
 
       define_method("index") do
         respond_to do |format|
-          format.json { eval "render :json => @#{object.to_s.pluralize}.to_json(merge_options(options[:index]))" }
-          format.xml  { eval "render :xml => @#{object.to_s.pluralize}.to_xml(merge_options(options[:index]))" }
+          format.json { render json: @collection.to_json(merge_options(options[:index])) }
+          format.xml  { render xml: @collection.to_xml(merge_options(options[:index])) }
+        end
+      end
+      
+      define_method("count") do
+        respond_to do |format|
+          format.json { render json: @collection.count }
+          format.xml { render xml: @collection.count }
         end
       end
 
       define_method("create") do
         respond_to do |format|
-          if eval "@#{object}.save"
-            format.json { eval "render :json => @#{object}" }
-            format.xml  { eval "render :xml => @#{object}" }
+          if @instance.save
+            format.json { render json: @instance }
+            format.xml  { render xml: @instance }
           else
-            format.json { eval "render :json => { :errors => @#{object}.errors.full_messages }, :status => :unprocessable_entity" }
-            format.xml  { eval "render :xml => { :errors => @#{object}.errors.full_messages }, :status => :unprocessable_entity" }
+            format.json { render json: { errors: @instance.errors.full_messages }, status: :unprocessable_entity }
+            format.xml  { render xml: { errors: @instance.errors.full_messages }, status: :unprocessable_entity }
           end
         end
       end
 
       define_method("show") do
         respond_to do |format|
-          format.json { eval "render :json => @#{object}.to_json(options[:show])" }
-          format.xml  { eval "render :xml => @#{object}.to_xml(options[:show])" }
+          format.json { render json: @instance.to_json(merge_options(options[:show])) }
+          format.xml  { render xml: @instance.to_xml(merge_options(options[:show])) }
         end
       end
 
       define_method("update") do
         respond_to do |format|
-          if eval "@#{object}.update_attributes(params[object])"
+          if @instance.update_attributes(params[object])
             format.json { head :ok }
             format.xml  { head :ok }
           else
-            format.json { eval "render :json => { :errors => @#{object}.errors.full_messages }, :status => :unprocessable_entity" }
-            format.xml  { eval "render :xml => { :errors => @#{object}.errors.full_messages }, :status => :unprocessable_entity" }
+            format.json { render json: { errors: @instance.errors.full_messages }, status: :unprocessable_entity }
+            format.xml  { render xml: { errors: @instance.errors.full_messages }, status: :unprocessable_entity }
           end
         end
       end
 
       define_method("destroy") do
-        eval "@#{object}.destroy"
+        @instance.destroy
 
         respond_to do |format|
           format.json { head :no_content }
@@ -66,27 +74,97 @@ module Serviceable
         end
       end
 
+      # query string params can be given in the following formats:
+      # only=field1,field2
+      # except=field1,field2
+      # include=assoc1
+      # 
+      # if an included association is present, only and except params can be nested
+      # include[user][except]=encrypted_password
+      # include[user][only][]=first_name&include[user][only][]=last_name
+      # include[user][only]=first_name,last_name
       define_method("merge_options") do |options={}|
         merged_options = options || {}
         for key in [:only, :except, :include]
-          merged_options = merged_options.merge({key => params[key].split(",")}) if params[key]
+          opts = {key => params[key]} if params[key]
+          merged_options = merged_options.merge(opts) if opts
         end
+        merged_options = deep_split(merged_options)
         return merged_options
       end
       
       define_method("assign_existing_instance") do
-        eval "@#{object} = object.to_s.camelize.constantize.find(params[:id])"
+        @instance = object.to_s.camelize.constantize
+        if params[:include].kind_of?(Hash)
+          @instance = @instance.includes(params[:include].keys)
+        end
+        if params[:include].kind_of?(String)
+          @instance = @instance.includes(params[:include].split(",").map(&:to_sym))
+        end
+        @instance = @instance.find(params[:id])
       end
       
       define_method("assign_new_instance") do
-        eval "@#{object} = object.to_s.camelize.constantize.new(params[:#{object}])"
+        @instance = object.to_s.camelize.constantize.new(params[object])
+      end
+      
+      # query string params can be used to filter collections
+      #
+      # filters apply on associated collections using the following conventions:
+      # where[user][category]=Expert
+      # where[user][created_at][gt]=20130807T12:34:56.789Z
+      #
+      # filters can be constructed with AND and OR behavior
+      # where[tags][id][in]=123,234,345  (OR)
+      # where[tags][id]=123&where[tags][id]=234  (AND)
+      define_method("assign_collection") do
+        @collection = object.to_s.camelize.constantize
+        if params[:include].kind_of?(Hash)
+          for assoc in params[:include].keys
+            @collection = @collection.includes(assoc.to_sym)
+          end
+        end
+        if params[:include].kind_of?(String)
+          @collection = @collection.includes(params[:include].split(",").map(&:to_sym))
+        end
+        for assoc in (params[:where].keys rescue [])
+          attrs = params[:where][assoc]
+          if attrs.kind_of?(Hash)
+            for target_column in attrs.keys
+              op = :eq if attrs[target_column].kind_of?(String)
+              op ||= attrs[target_column].keys[0].to_sym
+              value = attrs[target_column] if op==:eq
+              value ||= is_time_column?(target_column) ? Time.parse(attrs[target_column][op]) : attrs[target_column][op]
+              unless assoc.to_sym==object.to_s.pluralize.to_sym
+                @collection = @collection.includes(assoc)
+              end
+              puts "op: #{op}"
+              if op==:gt
+                @collection = @collection.where("#{assoc}.#{target_column} > ?",value)
+              elsif op==:lt
+                @collection = @collection.where("#{assoc}.#{target_column} < ?",value)
+              elsif op==:in
+                @collection = @collection.where("#{assoc}.#{target_column} IN (?)",value)
+              elsif op==:eq
+                @collection = @collection.where(assoc => { target_column => value })
+              end
+            end
+          else
+            @collection = @collection.includes(assoc).where(assoc => attrs)
+          end
+        end
       end
       
-      define_method("assign_instances") do
-        eval "@#{object.to_s.pluralize} = object.to_s.camelize.constantize.scoped"
+      # designed to traverse an entire hash, replacing delimited strings with arrays of symbols
+      define_method("deep_split") do |hash={},pivot=','|
+        Hash[hash.map {|k,v| [k.to_sym,v.kind_of?(String) ? v.split(pivot).map(&:to_sym) : (v.kind_of?(Hash) ? deep_split(v,pivot) : v)]}]
       end
-    end
       
+      define_method("is_time_column?") do |column|
+        !!column[-3,3]=='_at'
+      end
+    end
+
   end
   
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: serviceable
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 3
   prerelease: 
   segments: 
   - 0
-  - 2
-  version: "0.2"
+  - 4
+  version: "0.4"
 platform: ruby
 authors: 
 - Aubrey Goodman
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-07-27 00:00:00 Z
+date: 2013-08-08 00:00:00 Z
 dependencies: []
 
 description: Decorate your controller classes with acts_as_service :model_name, and instantly support JSON/XML CRUD interface. Override any callback method to customize your endpoint. Allow client to specify response contents using query string filter parameters.