gizmo-codescratch 0.0.2

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Craig Wickesser
+
+MIT License
+
+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,52 @@
+gizmo [![Build Status](https://secure.travis-ci.org/codescratch/gizmo.png?branch=master)](http://travis-ci.org/codescratch/gizmo)
+=====
+
+Removing the crud from developing an API to support CRUD, in the name of Gizmo.
+
+## Installation
+
+The preferred method for installing Gizmo is with bundler. Simply add Gizmo to your `Gemfile`:
+
+   gem "gizmo"
+
+## Usage
+
+```ruby
+class PostsController < ApplicationController
+  include Gizmo
+
+  # for a simple HTML request
+  def index
+    gizmo_response = find_all Post
+    @posts = gizmo_response.data
+  end
+
+  # for a JSON request
+  def index
+    render find_all(Post.order_by([[:updated_at, :desc]])).to_hash
+  end
+
+  def show
+    render find(Post, params[:id]).to_hash
+  end
+
+  def create
+    render make(Post, params[:post]).to_hash
+  end
+
+  def update
+    render modify(CmsSupport::Post, params[:id], params[:post]).to_hash
+  end
+
+  def destroy
+    render delete(CmsSupport::Post, params[:id]).to_hash
+  end
+end
+```
+
+## TODO
+
+* look for TODO's
+* abtract persistence layer to suport Mongoid, ActiveRecord, etc
+* error handling :)
+* The gizmo more or less expects to be included into a Rails controller.

data/lib/gizmo.rb

@@ -0,0 +1,100 @@
+require 'logger'
+require 'mongoid'
+
+require "gizmo/version"
+require "gizmo/models"
+require "gizmo/base_operation"
+require "gizmo/find_all"
+require "gizmo/find"
+require "gizmo/search"
+require "gizmo/make"
+require "gizmo/modify"
+require "gizmo/delete"
+require "gizmo/aop"
+
+module Gizmo
+  @logger = Logger.new STDERR
+
+  class << self
+    attr_accessor :logger
+  end
+
+  # Find all items
+  #
+  # @param [Mongoid::Criteria] criteria
+  #
+  # @return [Gizmo::Response]
+  def find_all(*args)
+    context = create_context
+    operation = FindAll.new(context)
+    response = operation.call(*args)
+    operation.set_response_headers response
+    response
+  end
+
+  # Find an item
+  #
+  # @param [Mongoid::Criteria] criteria
+  # @param [String, Moped::BSON::ObjecId] id
+  #
+  # @return [Gizmo::Response]
+  def find(*args)
+    context = create_context
+    Find.new(context).call(*args)
+  end
+
+  def search(*args)
+    context = create_context
+    Search.new(context).call(*args)
+  end
+
+  # Make a new instance of an item
+  #
+  # @param [Mongoid::Criteria] criteria
+  # @param [Hash] attrs
+  #
+  # @return [Gizmo::Response]
+  def make(*args)
+    context = create_context
+    operation = Make.new(context)
+    response = operation.call(*args)
+    operation.set_response_headers response
+    response
+  end
+
+  # Modify an item
+  #
+  # @param [Mongoid::Criteria] criteria
+  # @param [String, Moped::BSON::ObjecId] id
+  # @param [Hash] attrs
+  #
+  # @return [Gizmo::Response]
+  def modify(*args)
+    context = create_context
+    Modify.new(context).call(*args)
+  end
+
+  # Delete an item
+  #
+  # @param [Mongoid::Criteria] criteria
+  # @param [String, Moped::BSON::ObjecId] id
+  #
+  # @return [Gizmo::Response]
+  def delete(*args)
+    context = create_context
+    Delete.new(context).call(*args)
+  end
+
+  private
+
+  def create_context
+    if defined?(ActionController) && self.kind_of?(ActionController::Base)
+      Context.new(gizmo: self, format: request.format.to_sym, callback: params[:callback])
+    else
+      Context.new(gizmo: self, format: :json, callback: nil)
+    end
+  end
+
+
+end
+

data/lib/gizmo/aop.rb

@@ -0,0 +1,3 @@
+module Gizmo
+  require 'gizmo/aop/exception_handling'
+end

data/lib/gizmo/aop/exception_handling.rb

@@ -0,0 +1,44 @@
+require 'aquarium'
+
+module Gizmo
+  class ExceptionHandling
+    include Aquarium::DSL
+
+    def self.log_error(error)
+      puts "ERROR:: #{error.message}: #{error.backtrace}"
+
+      if defined?(Rails) && Rails.logger
+        Rails.logger.error "#{error.message}: #{error.backtrace}"
+      end
+    end
+
+    #around :calls_to => [:find_all, :find, :make, :modify, :delete], :in_types => /Controller$/ do |jp, obj, *args|
+    types = [Gizmo::FindAll, Gizmo::Find, Gizmo::Make, Gizmo::Modify, Gizmo::Delete]
+    around :calls_to => [:call], :in_types => types do |jp, operation, *args|
+      production = ENV['RAILS_ENV'] == 'production'
+
+      begin
+        response = jp.proceed
+      rescue Mongoid::Errors::DocumentNotFound => ex
+        err = Error.new("Unable to locate #{args.first} with id=#{args[1]}", production ? [] : ex.backtrace.slice(0, 10))
+        log_error err
+        response = operation.create_response
+        response.status = 404
+        response.data = err
+      rescue Mongoid::Errors::Validations => ex
+        err = ValidationError.new("Validation failed for one or more fields", ex.document.errors)
+        log_error err
+        response = operation.create_response
+        response.status = 422
+        response.data = err
+      rescue Exception => ex
+        err = Error.new("[test] Internal server error occurred: #{ex.message}", production ? [] : ex.backtrace.slice(0, 10))
+        log_error err
+        response = operation.create_response
+        response.status = 500
+        response.data = err
+      end
+      response
+    end
+  end
+end

data/lib/gizmo/base_operation.rb

@@ -0,0 +1,32 @@
+module Gizmo
+  class BaseOperation
+
+    attr_reader :context
+
+    # Creates a new Find and sets its context
+    #
+    # @param [Gizmo::Context] context
+    def initialize(context)
+      @context = context
+    end
+
+    def create_response
+      Response.new(format: context.format, callback: context.callback, status: default_status)
+    end
+
+    def default_status
+      200
+    end
+
+    # Set headers on the response
+    #
+    # @param [Gizmo::Response] gizmo_response a response used to set headers on the HTTP response
+    def set_response_headers(gizmo_response)
+      if context.gizmo.respond_to?(:headers) && gizmo_response.headers
+        gizmo_response.headers.each do |name, value|
+          context.gizmo.headers[name] = value
+        end
+      end
+    end
+  end
+end

data/lib/gizmo/delete.rb

@@ -0,0 +1,17 @@
+module Gizmo
+  class Delete < BaseOperation
+
+    # Delete a single item using the provided criteria.
+    #
+    # @param [Mongoid::Criteria] criteria   the criteria to use for deleting a single item
+    # @param [String, Moped::BSON::ObjectId] id   the ID of the item being deleted
+    #
+    # @return [Gizmo::Response]
+    def call(criteria, id)
+      response = create_response
+      criteria.find(id).delete
+      response.data = {}
+      response
+    end
+  end
+end

data/lib/gizmo/find.rb

@@ -0,0 +1,23 @@
+module Gizmo
+  class Find < BaseOperation
+
+    # Find a single item using the provided criteria.
+    #
+    # @param [Mongoid::Criteria] criteria         the criteria to use for finding a single item
+    # @param [String, Moped::BSON::ObjectId] id   the ID of the item being found
+    #
+    # @return [Gizmo::Response]
+    def call(criteria, id=nil)
+      response = create_response
+      if criteria.is_a? Mongoid::Criteria
+        response.data = criteria.where(:id=>id).first
+      elsif !criteria.respond_to?(:find) && id.nil?
+        response.data = criteria
+      else
+        response.data = criteria.find id
+      end
+      raise Mongoid::Errors::DocumentNotFound.new(criteria.klass, :id=>id) if response.data.nil?
+      response
+    end
+  end
+end

data/lib/gizmo/find_all.rb

@@ -0,0 +1,17 @@
+module Gizmo
+  class FindAll < BaseOperation
+
+    # Find all items using the provided criteria.
+    #
+    # @param [Mongoid::Criteria] criteria   the criteria to use for finding all items
+    #
+    # @return [Gizmo::Response]
+    def call(criteria)
+      response = create_response
+      all_items = criteria.all
+      response.header 'X-Total-Results', all_items.count
+      response.data = all_items
+      response
+    end
+  end
+end

data/lib/gizmo/make.rb

@@ -0,0 +1,35 @@
+module Gizmo
+  class Make < BaseOperation
+
+
+    # Make a single item using the provided criteria.
+    #
+    # @param [Mongoid::Criteria] criteria   the criteria to use for making a single item
+    # @param [Hash] attrs                   the attributes used to make a new instance
+    # @param [Proc] location_proc           a Proc that will be invoked with the ID of the newly
+    #                                       created item, defaults to nil.
+    #
+    # @return [Gizmo::Response]
+    def call(criteria, attrs, location_proc=nil)
+
+      response = create_response
+      item = criteria.create!(attrs)
+      response.data = item
+
+      if context.gizmo.respond_to?(:url_for)
+        if location_proc.nil?
+          url = context.gizmo.url_for item
+        else
+          url = location_proc.call(item.id)
+        end
+
+        response.header :Location, url unless url.nil?
+      end
+      response
+    end
+
+    def default_status
+      201
+    end
+  end
+end

data/lib/gizmo/models.rb

@@ -0,0 +1,6 @@
+module Gizmo
+  require 'gizmo/models/response'
+  require 'gizmo/models/context'
+  require 'gizmo/models/error'
+  require 'gizmo/models/validation_error'
+end

data/lib/gizmo/models/context.rb

@@ -0,0 +1,15 @@
+module Gizmo
+  # Provides context when performing an operation (i.e. find_all, find)
+  class Context
+
+    attr_accessor :format, :callback, :gizmo
+
+    # TODO document options
+    def initialize(attrs={})
+      attrs.each do |key, val|
+        setter = :"#{key}="
+        send setter, val if respond_to?(setter)
+      end
+    end
+  end
+end

data/lib/gizmo/models/error.rb

@@ -0,0 +1,14 @@
+module Gizmo
+  class Error
+    attr_reader :message, :backtrace
+
+    def initialize(message, backtrace=nil)
+      @message = message
+      @backtrace = backtrace
+    end
+
+    def as_json(opts={})
+      {message: message, backtrace: backtrace}
+    end
+  end
+end

data/lib/gizmo/models/response.rb

@@ -0,0 +1,30 @@
+module Gizmo
+  class Response
+
+    attr_accessor :format, :data, :callback, :status, :headers
+
+    # TODO document options
+    def initialize(attrs={})
+      @headers = {}
+
+      attrs.each do |name, val|
+        setter = :"#{name}="
+        send(setter, val) if respond_to? setter
+      end
+    end
+
+    def header(name, value)
+      headers[name.to_s] = value.to_s
+    end
+
+    def to_hash(opts={})
+      hash = {
+        format => data.as_json(opts),
+        status: status,
+        callback: callback
+      }
+      hash[:headers] = headers unless headers.nil? || headers.empty?
+      hash
+    end
+  end
+end

data/lib/gizmo/models/validation_error.rb

@@ -0,0 +1,15 @@
+module Gizmo
+  class ValidationError < Error
+    attr_reader :errors
+
+    def initialize(message, errors, backtrace=nil)
+      @message = message
+      @errors = errors
+      @backtrace = backtrace
+    end
+
+    def as_json(opts={})
+      {message: message, errors: errors, backtrace: backtrace}
+    end
+  end
+end

data/lib/gizmo/modify.rb

@@ -0,0 +1,36 @@
+module Gizmo
+  class Modify < BaseOperation
+
+    # Modify a single item using the provided criteria.
+    #
+    # @param [Mongoid::Criteria] criteria         the criteria to use for finding the item to update
+    # @param [String, Moped::BSON::ObjectId] id   the ID of the item being updated
+    # @param [Hash] attrs                         the attributes used to update an existing instance
+    # @param [Proc] update_strategy               The default update strategy
+    # does a mass update of attributes, which is not always ideal. A block can
+    # be given which will be passed two parameters: the item to update and the attributes.
+    # The block must return the data it wishes to send back in the response.
+    #
+    # @return [Gizmo::Response]
+    def call(criteria, id, attrs, update_strategy=nil)
+      attrs.delete '_id'
+
+      response = create_response
+      #TODO: refactor this pattern
+      if criteria.is_a? Mongoid::Criteria
+        item = criteria.where(:id=>id).first
+        raise Mongoid::Errors::DocumentNotFound.new(criteria.klass, :id=>id) if item.nil?
+      else
+        item = criteria.find id
+      end
+
+      if update_strategy.nil?
+        item.update_attributes!(attrs)
+      else
+        item = update_strategy.call item, attrs
+      end
+      response.data = item
+      response
+    end
+  end
+end

data/lib/gizmo/search.rb

@@ -0,0 +1,36 @@
+module Gizmo
+  class Search < BaseOperation
+
+    # Search for items.
+    #
+    # @param [Mongoid::Criteria] criteria   the criteria to use for searching the database
+    # @param [Hash] params                  parameters used for searching
+    # @option params [String] :term       the field to search
+    # @option params [String] :query      the value used for searching
+    # @option params [Integer] :num_items the maximum number of items to return, default 10
+    # @option params [Boolean] :fuzzy     true if fuzzy matching should be used, false otherwise, default to false
+    # @param [Proc]                         if a block is given, it will be passed the criteria and params. It should
+    #                                       return the result/data. note: the block will be used to perform the search.
+    #
+    # @return [Gizmo::Response]
+    def call(criteria, params={})
+      response = create_response
+      if block_given?
+        response.data = yield criteria, params
+      else
+        term = params[:term]
+        query = params[:query]
+        num_items = (params[:num_items] || 10).to_i
+        num_items = 10 if num_items > 100 || num_items < 1
+
+        fuzzy = !!((params[:fuzzy] || "") =~ /true/i)
+        if fuzzy
+          query = /#{query}/i
+        end
+
+        response.data = criteria.where(term => query).limit(num_items)
+      end
+      response
+    end
+  end
+end

data/lib/gizmo/version.rb

@@ -0,0 +1,3 @@
+module Gizmo
+  VERSION = "0.0.2" unless defined?(Gizmo::VERSION)
+end

data/spec/support/futz_controller.rb

@@ -0,0 +1,12 @@
+class FutzController
+  include Gizmo
+  attr_accessor :headers
+
+  def initialize
+    @headers = {}
+  end
+
+  def url_for(obj)
+    "http://localhost:3000/posts/#{obj.id.to_s}"
+  end
+end

data/spec/support/models_for_testing.rb

@@ -0,0 +1,18 @@
+module ModelsForTesting
+  class Post
+    include Mongoid::Document
+
+    field :title, type: String
+    field :content, type: String
+    has_many :comments
+    validates_presence_of :title
+  end
+
+  class Comment
+    include Mongoid::Document
+    field :message, type: String
+    field :author, type: String
+    belongs_to :post
+
+  end
+end

data/spec/support/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  sessions:
+    default:
+      database: gizmo_test
+      hosts:
+        - localhost:27017

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: gizmo-codescratch
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Craig Wickesser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aquarium
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Removing the crud from developing an API to support CRUD, in the name
+  of Gizmo.
+email:
+- craig@codescratch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/gizmo/aop/exception_handling.rb
+- lib/gizmo/aop.rb
+- lib/gizmo/base_operation.rb
+- lib/gizmo/delete.rb
+- lib/gizmo/find.rb
+- lib/gizmo/find_all.rb
+- lib/gizmo/make.rb
+- lib/gizmo/models/context.rb
+- lib/gizmo/models/error.rb
+- lib/gizmo/models/response.rb
+- lib/gizmo/models/validation_error.rb
+- lib/gizmo/models.rb
+- lib/gizmo/modify.rb
+- lib/gizmo/search.rb
+- lib/gizmo/version.rb
+- lib/gizmo.rb
+- spec/support/futz_controller.rb
+- spec/support/models_for_testing.rb
+- spec/support/mongoid.yml
+homepage: http://codescratch.github.com/gizmo/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2973191327364084079
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2973191327364084079
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Removing the crud from developing an API to support CRUD, in the name of
+  Gizmo.
+test_files: []