giraffesoft-classy_resources 0.0.1

data/README.rdoc

@@ -0,0 +1,30 @@
+= Classy Resources
+
+Think resource_controller, except for Sinatra.
+
+= Usage
+
+  require 'rubygems'
+  require 'sinatra'
+  require 'classy_resources'
+  require 'classy_resources/active_record'
+  # ... or require 'classy_resources/sequel'
+  # more ORMs coming (it's also easy to implement your own)...
+
+  define_resource :posts, :member     => [:get, :put, :delete],
+                          :collection => [:get, :post],
+                          :formats    => [:xml, :json, :yaml]
+
+The above declaration will create the five actions specified, each responding to all of the formats listed.
+  
+  - GET /resources.format      # => index
+  - POST /resources.format     # => create
+  - GET /resources/1.format    # => show
+  - PUT /resources/1.format    # => update
+  - DELETE /resources/1.format # => destroy
+
+Since ClassyResources was designed to be active resource compatible, the params formats and return values are what AR expects.
+
+== Copyright
+
+Copyright (c) 2008 James Golick, Daniel Haran, GiraffeSoft Inc.. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 0

data/lib/classy_resources/active_record.rb

@@ -0,0 +1,26 @@
+module ClassyResources
+  module ActiveRecord
+    def load_collection(resource)
+      class_for(resource).all
+    end
+
+    def create_object(resource, params)
+      class_for(resource).create!(params)
+    end
+
+    def find_object(resource, id)
+      class_for(resource).find(id)
+    end
+
+    def update_object(object, params)
+      object.update_attributes(params)
+    end
+
+    def destroy_object(object)
+      object.destroy
+    end
+  end
+end
+
+include ClassyResources::ActiveRecord
+

data/lib/classy_resources/mime_type.rb

@@ -0,0 +1,216 @@
+# borrowed from activesupport
+require 'set'
+
+module Mime
+  SET              = []
+  EXTENSION_LOOKUP = Hash.new { |h, k| h[k] = Type.new(k) unless k.blank? }
+  LOOKUP           = Hash.new { |h, k| h[k] = Type.new(k) unless k.blank? }
+
+  # Encapsulates the notion of a mime type. Can be used at render time, for example, with:
+  #
+  #   class PostsController < ActionController::Base
+  #     def show
+  #       @post = Post.find(params[:id])
+  #
+  #       respond_to do |format|
+  #         format.html
+  #         format.ics { render :text => post.to_ics, :mime_type => Mime::Type["text/calendar"]  }
+  #         format.xml { render :xml => @people.to_xml }
+  #       end
+  #     end
+  #   end
+  class Type
+    def self.html_types; @@html_types; end
+    def self.browser_generated_types; @@browser_generated_types; end
+
+    @@html_types = Set.new [:html, :all]
+
+    @@browser_generated_types = Set.new [:html, :url_encoded_form, :multipart_form, :text]
+
+    # A simple helper class used in parsing the accept header
+    class AcceptItem #:nodoc:
+      attr_accessor :order, :name, :q
+
+      def initialize(order, name, q=nil)
+        @order = order
+        @name = name.strip
+        q ||= 0.0 if @name == Mime::ALL # default wilcard match to end of list
+        @q = ((q || 1.0).to_f * 100).to_i
+      end
+
+      def to_s
+        @name
+      end
+
+      def <=>(item)
+        result = item.q <=> q
+        result = order <=> item.order if result == 0
+        result
+      end
+
+      def ==(item)
+        name == (item.respond_to?(:name) ? item.name : item)
+      end
+    end
+
+    class << self
+      def lookup(string)
+        LOOKUP[string]
+      end
+
+      def lookup_by_extension(extension)
+        EXTENSION_LOOKUP[extension]
+      end
+
+      # Registers an alias that's not used on mime type lookup, but can be referenced directly. Especially useful for
+      # rendering different HTML versions depending on the user agent, like an iPhone.
+      def register_alias(string, symbol, extension_synonyms = [])
+        register(string, symbol, [], extension_synonyms, true)
+      end
+
+      def register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false)
+        Mime.instance_eval { const_set symbol.to_s.upcase, Type.new(string, symbol, mime_type_synonyms) }
+
+        SET << Mime.const_get(symbol.to_s.upcase)
+
+        ([string] + mime_type_synonyms).each { |string| LOOKUP[string] = SET.last } unless skip_lookup
+        ([symbol.to_s] + extension_synonyms).each { |ext| EXTENSION_LOOKUP[ext] = SET.last }
+      end
+
+      def parse(accept_header)
+        if accept_header !~ /,/
+          [Mime::Type.lookup(accept_header)]
+        else
+          # keep track of creation order to keep the subsequent sort stable
+          list = []
+          accept_header.split(/,/).each_with_index do |header, index| 
+            params, q = header.split(/;\s*q=/)       
+            if params
+              params.strip!          
+              list << AcceptItem.new(index, params, q) unless params.empty?
+            end
+          end
+          list.sort!
+
+          # Take care of the broken text/xml entry by renaming or deleting it
+          text_xml = list.index("text/xml")
+          app_xml = list.index(Mime::XML.to_s)
+
+          if text_xml && app_xml
+            # set the q value to the max of the two
+            list[app_xml].q = [list[text_xml].q, list[app_xml].q].max
+
+            # make sure app_xml is ahead of text_xml in the list
+            if app_xml > text_xml
+              list[app_xml], list[text_xml] = list[text_xml], list[app_xml]
+              app_xml, text_xml = text_xml, app_xml
+            end
+
+            # delete text_xml from the list
+            list.delete_at(text_xml)
+
+          elsif text_xml
+            list[text_xml].name = Mime::XML.to_s
+          end
+
+          # Look for more specific XML-based types and sort them ahead of app/xml
+
+          if app_xml
+            idx = app_xml
+            app_xml_type = list[app_xml]
+
+            while(idx < list.length)
+              type = list[idx]
+              break if type.q < app_xml_type.q
+              if type.name =~ /\+xml$/
+                list[app_xml], list[idx] = list[idx], list[app_xml]
+                app_xml = idx
+              end
+              idx += 1
+            end
+          end
+
+          list.map! { |i| Mime::Type.lookup(i.name) }.uniq!
+          list
+        end
+      end
+    end
+    
+    def initialize(string, symbol = nil, synonyms = [])
+      @symbol, @synonyms = symbol, synonyms
+      @string = string
+    end
+    
+    def to_s
+      @string
+    end
+    
+    def to_str
+      to_s
+    end
+    
+    def to_sym
+      @symbol || @string.to_sym
+    end
+
+    def ===(list)
+      if list.is_a?(Array)
+        (@synonyms + [ self ]).any? { |synonym| list.include?(synonym) }
+      else
+        super
+      end
+    end
+    
+    def ==(mime_type)
+      return false if mime_type.blank?
+      (@synonyms + [ self ]).any? do |synonym| 
+        synonym.to_s == mime_type.to_s || synonym.to_sym == mime_type.to_sym 
+      end
+    end
+
+    # Returns true if Action Pack should check requests using this Mime Type for possible request forgery.  See
+    # ActionController::RequestForgeryProtection.
+    def verify_request?
+      browser_generated?
+    end
+
+    def html?
+      @@html_types.include?(to_sym) || @string =~ /html/
+    end
+
+    def browser_generated?
+      @@browser_generated_types.include?(to_sym)
+    end
+
+    private
+      def method_missing(method, *args)
+        if method.to_s =~ /(\w+)\?$/
+          $1.downcase.to_sym == to_sym
+        else
+          super
+        end
+      end
+  end
+end
+
+# Build list of Mime types for HTTP responses
+# http://www.iana.org/assignments/media-types/
+
+Mime::Type.register "*/*", :all
+Mime::Type.register "text/plain", :text, [], %w(txt)
+Mime::Type.register "text/html", :html, %w( application/xhtml+xml ), %w( xhtml )
+Mime::Type.register "text/javascript", :js, %w( application/javascript application/x-javascript )
+Mime::Type.register "text/css", :css
+Mime::Type.register "text/calendar", :ics
+Mime::Type.register "text/csv", :csv
+Mime::Type.register "application/xml", :xml, %w( text/xml application/x-xml )
+Mime::Type.register "application/rss+xml", :rss
+Mime::Type.register "application/atom+xml", :atom
+Mime::Type.register "application/x-yaml", :yaml, %w( text/yaml )
+
+Mime::Type.register "multipart/form-data", :multipart_form
+Mime::Type.register "application/x-www-form-urlencoded", :url_encoded_form
+
+# http://www.ietf.org/rfc/rfc4627.txt
+# http://www.json.org/JSONRequest.html
+Mime::Type.register "application/json", :json, %w( text/x-json application/jsonrequest )

data/lib/classy_resources/sequel.rb

@@ -0,0 +1,25 @@
+module ClassyResources
+  module Sequel
+    def load_collection(resources)
+      class_for(resources).all
+    end
+
+    def create_object(resource, params)
+      class_for(resource).create(params)
+    end
+
+    def find_object(resource, id)
+      class_for(resource).find(:id => id)
+    end
+
+    def update_object(object, params)
+      object.update(params)
+    end
+
+    def destroy_object(object)
+      object.destroy
+    end
+  end
+end
+
+include ClassyResources::Sequel

data/lib/classy_resources.rb

@@ -0,0 +1,103 @@
+dir = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH << dir unless $LOAD_PATH.include?(dir)
+require 'classy_resources/mime_type'
+
+module ClassyResources
+  def class_for(resource)
+    resource.to_s.singularize.classify.constantize
+  end
+
+  def define_resource(*options)
+    ResourceBuilder.new(self, *options)
+  end
+
+  def collection_url_for(resource, format)
+    "/#{resource}.#{format}" 
+  end
+
+  def object_route_url(resource, format)
+    "/#{resource}/:id.#{format}"
+  end
+
+  def object_url_for(resource, format, object)
+    "/#{resource}/#{object.id}.#{format}"
+  end
+
+  def set_content_type(format)
+    content_type Mime.const_get(format.to_s.upcase).to_s
+  end
+
+  def serialize(object, format)
+    object.send(:"to_#{format}")
+  end
+
+  class ResourceBuilder
+    attr_reader :resources, :options, :main, :formats
+
+    def initialize(main, *args)
+      @main      = main
+      @options   = args.pop if args.last.is_a?(Hash)
+      @resources = args
+      @formats   = options[:formats] || :xml
+
+      build!
+    end
+
+    def build!
+      resources.each do |r|
+        [*formats].each do |f|
+          [:member, :collection].each do |t|
+            [*options[t]].each do |v|
+              send(:"define_#{t}_#{v}", r, f) unless v.nil?
+            end
+          end
+        end
+      end
+    end
+
+    protected
+      def define_collection_get(resource, format)
+        get collection_url_for(resource, format) do
+          set_content_type(format)
+          serialize(load_collection(resource), format)
+        end
+      end
+      
+      def define_collection_post(resource, format)
+        post collection_url_for(resource, format) do
+          set_content_type(format)
+          object = create_object(resource, params[resource.to_s.singularize])
+          redirect object_url_for(resource, format, object)
+        end
+      end
+
+      def define_member_get(resource, format)
+        get object_route_url(resource, format) do
+          set_content_type(format)
+          object = find_object(resource, params[:id])
+          serialize(object, format)
+        end
+      end
+
+      def define_member_put(resource, format)
+        put object_route_url(resource, format) do
+          set_content_type(format)
+          object = find_object(resource, params[:id])
+          update_object(object, params[resource.to_s.singularize])
+          serialize(object, format)
+        end
+      end
+
+      def define_member_delete(resource, format)
+        delete object_route_url(resource, format) do
+          set_content_type(format)
+          object = find_object(resource, params[:id])
+          destroy_object(object)
+          ""
+        end
+      end
+  end
+end
+
+include ClassyResources
+

data/test/active_record_test.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'sinatra'
+require 'sinatra/test/unit'
+require File.dirname(__FILE__) + '/fixtures/active_record_test_app'
+
+class ActiveRecordTest < Test::Unit::TestCase
+  context "on GET to /posts with xml" do
+    setup do
+      2.times { create_post }
+      get '/posts.xml'
+    end
+
+    expect { assert_equal 200, @response.status }
+    expect { assert_equal Post.all.to_xml, @response.body }
+    expect { assert_equal "application/xml", @response.content_type }
+  end
+
+  context "on GET to /posts with json" do
+    setup do
+      2.times { create_post }
+      get '/posts.json'
+    end
+
+    expect { assert_equal 200, @response.status }
+    expect { assert_equal Post.all.to_json, @response.body }
+    expect { assert_equal "application/json", @response.content_type }
+  end
+
+  context "on POST to /posts" do
+    setup do
+      Post.destroy_all
+      post '/posts.xml', :post => {:title => "whatever"}
+    end
+
+    expect { assert_equal 302, @response.status }
+    expect { assert_equal "/posts/#{Post.first.id}.xml", @response.location }
+    expect { assert_equal "whatever", Post.first.title }
+    expect { assert_equal "application/xml", @response.content_type }
+  end
+
+  context "on GET to /posts/id" do
+    setup do
+      @post = create_post
+      get "/posts/#{@post.id}.xml"
+    end
+
+    expect { assert_equal 200, @response.status }
+    expect { assert_equal @post.to_xml, @response.body }
+    expect { assert_equal "application/xml", @response.content_type }
+  end
+
+  context "on PUT to /posts/id" do
+    setup do
+      @post = create_post
+      put "/posts/#{@post.id}.xml", :post => {:title => "Changed!"}
+    end
+
+    expect { assert_equal 200, @response.status }
+    expect { assert_equal @post.reload.to_xml, @response.body }
+    expect { assert_equal "application/xml", @response.content_type }
+
+    should "update the post" do
+      assert_equal "Changed!", @post.reload.title
+    end
+  end
+
+  context "on DELETE to /posts/id" do
+    setup do
+      @post = create_post
+      delete "/posts/#{@post.id}.xml"
+    end
+
+    expect { assert_equal 200, @response.status }
+    expect { assert_equal "application/xml", @response.content_type }
+
+    should "destroy the post" do
+      assert_nil Post.find_by_id(@post)
+    end
+  end
+end

data/test/fixtures/active_record_test_app.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'sinatra'
+require 'classy_resources/active_record'
+require 'activerecord'
+
+ActiveRecord::Base.configurations = {'sqlite3' => {:adapter  => 'sqlite3', 
+                                                   :database => ':memory:'}}
+ActiveRecord::Base.establish_connection('sqlite3')
+
+ActiveRecord::Base.logger = Logger.new(STDERR)
+ActiveRecord::Base.logger.level = Logger::WARN
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :posts do |t|
+    t.string :title
+  end
+end
+
+class Post < ActiveRecord::Base
+end
+
+
+define_resource :posts, :collection => [:get, :post],
+                        :member     => [:get, :put, :delete],
+                        :formats    => [:xml, :json]

data/test/fixtures/sequel_test_app.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'sinatra'
+require 'classy_resources/sequel'
+require 'sequel'
+
+Sequel::Model.db = Sequel.sqlite
+
+Sequel::Model.db.instance_eval do
+  create_table! :users do
+    primary_key :id
+    varchar :name
+  end
+end
+
+class User < Sequel::Model(:users)
+end
+
+define_resource :users, :collection => [:get, :post],
+                        :member     => [:put, :delete, :get]

data/test/sequel_test.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'sinatra'
+require 'sinatra/test/unit'
+require File.dirname(__FILE__) + '/fixtures/sequel_test_app'
+require 'activesupport'
+
+class Sequel::Model
+  def to_xml(opts={})
+    values.to_xml(opts)
+  end
+end
+
+class SequelTest < Test::Unit::TestCase
+  context "on GET to /users with xml" do
+    setup do
+      2.times { create_user }
+      get '/users.xml'
+    end
+
+    expect { assert_equal 200, @response.status }
+    expect { assert_equal User.all.to_xml, @response.body }
+    expect { assert_equal "application/xml", @response.content_type }
+  end
+
+  context "on POST to /users" do
+    setup do
+      User.destroy_all
+      post '/users.xml', :user => {:name => "whatever"}
+    end
+
+    expect { assert_equal 302, @response.status }
+    expect { assert_equal "/users/#{User.first.id}.xml", @response.location }
+    expect { assert_equal "whatever", User.first.name }
+    expect { assert_equal "application/xml", @response.content_type }
+  end
+
+  context "on GET to /users/id" do
+    setup do
+      @user = create_user
+      get "/users/#{@user.id}.xml"
+    end
+
+    expect { assert_equal 200, @response.status }
+    expect { assert_equal @user.to_xml, @response.body }
+    expect { assert_equal "application/xml", @response.content_type }
+  end
+
+  context "on PUT to /users/id" do
+    setup do
+      @user = create_user
+      put "/users/#{@user.id}.xml", :user => {:name => "Changed!"}
+    end
+
+    expect { assert_equal 200, @response.status }
+    expect { assert_equal @user.reload.to_xml, @response.body }
+    expect { assert_equal "application/xml", @response.content_type }
+
+    should "update the user" do
+      assert_equal "Changed!", @user.reload.name
+    end
+  end
+
+  context "on DELETE to /users/id" do
+    setup do
+      @user = create_user
+      delete "/users/#{@user.id}.xml"
+    end
+
+    expect { assert_equal 200, @response.status }
+    expect { assert_equal "application/xml", @response.content_type }
+
+    should "destroy the user" do
+      assert_nil User.find(:id => @user.id)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/../lib/classy_resources'
+require 'rubygems'
+require 'test/unit'
+require 'context'
+require 'zebra'
+require 'mocha'
+
+class Test::Unit::TestCase
+  protected
+    def create_post(opts = {})
+      Post.create!({}.merge(opts))
+    end
+
+    def create_user(opts = {})
+      u = User.new({}.merge(opts))
+      u.save
+      u
+    end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: giraffesoft-classy_resources
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- James Golick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-27 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: TODO
+email: james@giraffesoft.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/classy_resources
+- lib/classy_resources/active_record.rb
+- lib/classy_resources/mime_type.rb
+- lib/classy_resources/sequel.rb
+- lib/classy_resources.rb
+- test/active_record_test.rb
+- test/fixtures
+- test/fixtures/active_record_test_app.rb
+- test/fixtures/sequel_test_app.rb
+- test/sequel_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/giraffesoft/classy_resources
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+