serviceable 0.1

data/LICENSE

@@ -0,0 +1,24 @@
+LICENSE
+
+The MIT License
+
+Copyright (c) 2011-2013 Aubrey Goodman and VerifIP, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,37 @@
+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
+trying to maintain that over time, we extracted those patterns into a module.
+
+
+class PostsController < ApplicationController
+
+  include Serviceable
+  acts_as_service :post
+
+end
+
+resources :posts
+
+
+
+Standard CRUD
+-------------
+
+POST /posts.json
+GET /posts.json
+GET /posts/1.json
+PUT /posts/1.json
+DELETE /posts/1.json
+
+Query Params
+------------
+
+GET /posts.json
+[{"id":1,"title":"First Post!","body":"Feels good to be first","created_at":"20130727T16:26:00Z"}]
+
+GET /posts.json?only=id,title
+[{"id":1,"title","First post!"}]
+

data/lib/serviceable.rb

@@ -0,0 +1,92 @@
+module Serviceable
+  
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    
+    # Serviceable Usage
+    #
+    # Controller:
+    # class PostsController
+    #   acts_as_service :post
+    # end
+    #
+    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
+
+      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]))" }
+        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}" }
+          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" }
+          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])" }
+        end
+      end
+
+      define_method("update") do
+        respond_to do |format|
+          if eval "@#{object}.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" }
+          end
+        end
+      end
+
+      define_method("destroy") do
+        eval "@#{object}.destroy"
+
+        respond_to do |format|
+          format.json { head :ok }
+          format.xml  { head :ok }
+        end
+      end
+
+      define_method("merge_options") do |options={}|
+        merged_options = options || {}
+        for key in [:only, :except]
+          merged_options = merged_options.merge({key => params[key].split(",")}) if params[key]
+        end
+        return merged_options
+      end
+      
+      define_method("assign_existing_instance") do
+        eval "@#{object} = object.to_s.camelize.constantize.find(params[:id])"
+      end
+      
+      define_method("assign_new_instance") do
+        eval "@#{object} = object.to_s.camelize.constantize.new(params[:#{object}])"
+      end
+      
+      define_method("assign_instances") do
+        eval "@#{object.to_s.pluralize} = object.to_s.camelize.constantize.scoped"
+      end
+    end
+      
+  end
+  
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: serviceable
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Aubrey Goodman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-07-27 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.
+email: aubrey.goodman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/serviceable.rb
+- LICENSE
+- README.md
+homepage: https://github.com/verifip/serviceable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Standardized Rails web services with design-time configuration and query string filtering support
+test_files: []
+