toast 0.2.0 → 0.3.4

data/README.md

@@ -126,6 +126,13 @@ Installation
     cd toast
     rake install
 
+or with bundler (Gemfile) 
+
+    gem "toast", :git => "https://github.com/robokopp/toast.git"
+
+Note: There is a Gem on RubyGems.org too, but I will not keep it up-to-date for now. 
+Please use the git (edge) version.
+
 Test Suite
 ==========
 

data/app/controller/toast_controller.rb

@@ -3,14 +3,16 @@ class ToastController < ApplicationController
   def catch_all
 
     begin
-      resource = Toast::Resource.build( params, request )
-      render resource.apply(request.method, request.body.read)
 
+      @resource = Toast::Resource.build( params, request )     
+
+      render @resource.apply(request.method, request.body.read) 
+      
     rescue Toast::ResourceNotFound => e
       return head(:not_found)
 
     rescue Toast::PayloadInvalid => e
-      return head(:unprocessable_entity)
+      return render :text => e.message, :status => :forbidden 
 
     rescue Toast::PayloadFormatError => e
       return head(:bad_request)

data/config/routes.rb

@@ -5,8 +5,14 @@ Rails.application.routes.draw do
 
     resource_name = model.to_s.pluralize.underscore
 
-    match "#{model.toast_config.namespace}/#{resource_name}(/:id(/:subresource))" => 'toast#catch_all', :constraints => { :id => /\d+/ }, :resource => resource_name
-    match "#{model.toast_config.namespace}/#{resource_name}/:subresource" => 'toast#catch_all', :resource => resource_name
+    match("#{model.toast_config.namespace}/#{resource_name}(/:id(/:subresource))" => 'toast#catch_all', 
+          :constraints => { :id => /\d+/ }, 
+          :resource => resource_name,
+          :defaults => { :format => 'json' })
+    
+    match("#{model.toast_config.namespace}/#{resource_name}/:subresource" => 'toast#catch_all', 
+          :resource => resource_name,
+          :defaults => { :format => 'json' })
   end
 
   match ":resource(/:id(/:subresource))" => 'toast#not_found', :constraints => { :id => /\d+/ }

data/lib/toast/active_record_extensions.rb

@@ -41,7 +41,7 @@ module Toast
                                       self.class.toast_config.exposed_attributes
 
           out = exposed_attr.inject({}) do |acc, attr|
-            acc[attr] = self[attr]
+            acc[attr] = self.send attr
             acc
           end
 

data/lib/toast/{associate_collection.rb → association.rb}

@@ -1,9 +1,9 @@
 module Toast
-  class AssociateCollection < Resource
+  class Association < Resource
     
     attr_reader :model
 
-    def initialize model, id, subresource_name
+    def initialize model, id, subresource_name, format
       unless model.toast_config.exposed_associations.include? subresource_name
         raise ResourceNotFound
       end
@@ -11,6 +11,7 @@ module Toast
       @model = model
       @record = model.find(id) rescue raise(ResourceNotFound)
       @collection = subresource_name
+      @format = format
 
       @associate_model = Resource.get_class_by_resource_name subresource_name
       @associate_model.uri_base = @model.uri_base
@@ -18,11 +19,20 @@ module Toast
     end
 
     def get
-      records = @record.send(@collection)
-      {
-        :json => records.map{|r| r.exposed_attributes(:in_collection => true)},
-        :status => :ok
-      }
+      result = @record.send(@collection)
+
+      if result.is_a? Array 
+        {
+          :json => result.map{|r| r.exposed_attributes(:in_collection => true)},
+          :status => :ok
+        }
+      else
+        {
+          :json => result.exposed_attributes(:in_collection => true),
+          :status => :ok
+        }
+      end
+
     end
 
     def put
@@ -31,19 +41,18 @@ module Toast
 
     def post payload
 
-
       if self.media_type != @associate_model.toast_config.media_type
         raise UnsupportedMediaType
       end
 
-      if payload.keys.to_set != @associate_model.toast_config.exposed_attributes.to_set
+      if payload.keys.to_set != (@associate_model.toast_config.exposed_attributes.to_set - @associate_model.toast_config.auto_fields.to_set)
         raise PayloadInvalid
       end
 
       unless payload.is_a? Hash
         raise PayloadFormatError
       end 
-      #debugger  
+
       record = @record.send(@collection).create payload
       
       {

data/lib/toast/attribute.rb

@@ -3,7 +3,7 @@ module Toast
 
     attr_reader :model
 
-    def initialize model, id, attribute_name
+    def initialize model, id, attribute_name, format
       unless model.toast_config.exposed_attributes.include? attribute_name
         raise ResourceNotFound 
       end
@@ -11,6 +11,7 @@ module Toast
       @model = model
       @record = model.find(id) rescue raise(ResourceNotFound)
       @attribute_name = attribute_name
+      @format = format
     end
     
     def get
@@ -21,6 +22,7 @@ module Toast
     end
 
     def put payload
+      
       @record.update_attribute(@attribute_name, payload)
       { 
         :json => @record[@attribute_name],

data/lib/toast/config_dsl.rb

@@ -4,27 +4,22 @@ module Toast
     class Base
       include Blockenspiel::DSL
       dsl_attr_accessor :media_type, :has_many, :namespace
+      # attr_reader :exposed_attributes, :exposed_associations
 
       def initialize model
         @model = model
         @fields = []
+        @auto_fields = []
         @collections = []
+        @singles = []
         @media_type = "application/json"
-        @exposed_attributes = []
-        @exposed_associations = []
         @disallow_methods = []
+        @pass_params_to = []
         @in_collection = ConfigDSL::InCollection.new model, self
       end
 
       def fields= *fields
         @fields.push *ConfigDSL.sanitize(fields,"fields")
-        @fields.each do |attr_or_assoc|
-          if @model.new.attributes.keys.include? attr_or_assoc
-            @exposed_attributes << attr_or_assoc
-          else
-            @exposed_associations << attr_or_assoc
-          end
-        end
       end
 
       def fields *arg
@@ -32,6 +27,25 @@ module Toast
         self.fields = *arg
       end
 
+      def exposed_attributes
+        assocs = @model.reflect_on_all_associations.map{|a| a.name.to_s}
+        @fields.select{|f| !assocs.include?(f)}
+      end
+
+      def exposed_associations
+        assocs = @model.reflect_on_all_associations.map{|a| a.name.to_s}
+        @fields.select{|f| assocs.include?(f)}
+      end
+
+      def auto_fields= *arg
+        @auto_fields.push *ConfigDSL.sanitize(arg,"auto fields")
+      end
+
+      def auto_fields *arg
+        return(@auto_fields) if arg.empty?
+        self.auto_fields = *arg        
+      end
+     
       def disallow_methods= *arg
         @disallow_methods.push *ConfigDSL.sanitize(arg,"disallow methods")
       end
@@ -41,8 +55,15 @@ module Toast
         self.disallow_methods = *arg        
       end
 
-      attr_reader :exposed_attributes, :exposed_associations
+      def pass_params_to= *arg
+        @pass_params_to.push *ConfigDSL.sanitize(arg,"pass_params_to")
+      end
 
+      def pass_params_to *arg
+        return(@pass_params_to) if arg.empty?
+        self.pass_params_to = *arg        
+      end
+     
       def collections= collections=[]
         @collections = ConfigDSL.sanitize(collections, "collections")
       end
@@ -52,6 +73,15 @@ module Toast
         self.collections = *arg
       end
 
+      def singles= singles=[]
+        @singles = ConfigDSL.sanitize(singles, "singles")
+      end
+
+      def singles *arg
+        return(@singles) if arg.empty?
+        self.singles = *arg
+      end
+
       def in_collection &block
         if block_given?
           Blockenspiel.invoke( block, @in_collection)
@@ -70,24 +100,25 @@ module Toast
       def initialize model, base_config
         @model = model
         @fields = base_config.fields
-        @exposed_attributes = base_config.exposed_attributes
-        @exposed_associations = base_config.exposed_associations
+        @disallow_methods = []
+        # @exposed_attributes = base_config.exposed_attributes
+        # @exposed_associations = base_config.exposed_associations
         @media_type = "application/json"
       end
 
       def fields= *fields
         @fields = ConfigDSL.sanitize(fields,"fields")
 
-        @exposed_attributes = []
-        @exposed_associations = []
+        # @exposed_attributes = []
+        # @exposed_associations = []
 
-        @fields.each do |attr_or_assoc|
-          if @model.new.attributes.keys.include? attr_or_assoc
-            @exposed_attributes << attr_or_assoc
-          else
-            @exposed_associations << attr_or_assoc
-          end
-        end
+        # @fields.each do |attr_or_assoc|
+        #   if @model.new.attributes.keys.include? attr_or_assoc
+        #     @exposed_attributes << attr_or_assoc
+        #   else
+        #     @exposed_associations << attr_or_assoc
+        #   end
+        # end
       end
 
       def fields *arg
@@ -95,7 +126,26 @@ module Toast
         self.fields = *arg
       end
 
-      attr_reader :exposed_attributes, :exposed_associations
+      def exposed_attributes
+        assocs = @model.reflect_on_all_associations.map{|a| a.name.to_s}
+        @fields.select{|f| !assocs.include?(f)}
+      end
+
+      def exposed_associations
+        assocs = @model.reflect_on_all_associations.map{|a| a.name.to_s}
+        @fields.select{|f| assocs.include?(f)}
+      end
+
+      def disallow_methods= *arg
+        @disallow_methods.push *ConfigDSL.sanitize(arg,"disallow methods")
+      end
+
+      def disallow_methods *arg
+        return(@disallow_methods) if arg.empty?
+        self.disallow_methods = *arg        
+      end
+
+      # attr_reader :exposed_attributes, :exposed_associations
     end
 
 

data/lib/toast/engine.rb

@@ -1,9 +1,11 @@
 require 'toast/active_record_extensions.rb'
 require 'toast/resource.rb'
 require 'toast/root_collection'
-require 'toast/associate_collection'
+require 'toast/association'
 require 'toast/attribute'
 require 'toast/record'
+require 'toast/single'
+
 require 'action_dispatch/http/request'
 
 module Toast
@@ -19,7 +21,7 @@ module Toast
       begin
         Dir["#{Rails.root}/app/models/**/*.rb"].each{|m| require m }
 
-      rescue ActiveRecord::StatementInvalid
+      rescue 
         # raised when DB is not setup yet. (rake db:schema:load)
       end
 

data/lib/toast/record.rb

@@ -1,11 +1,12 @@
 module Toast
   class Record < Resource
 
-    attr_reader :model
+    attr_reader :model    
     
-    def initialize model, id
+    def initialize model, id, format
       @model = model      
       @record = model.find(id) rescue raise(ResourceNotFound.new)
+      @format = format
     end
 
     def post payload
@@ -24,23 +25,33 @@ module Toast
         raise PayloadFormatError
       end
 
-      if payload.keys.to_set != @model.toast_config.exposed_attributes.to_set
+      if payload.keys.to_set != (@model.toast_config.exposed_attributes.to_set - @model.toast_config.auto_fields.to_set)
         raise PayloadInvalid
       end
       
       @record.update_attributes payload
-     { 
+      { 
         :json => @record.exposed_attributes,
         :status => :ok,
         :location => @record.uri
       }
     end
 
-    def get 
-      {
-        :json => @record.exposed_attributes,
-        :status => :ok
-      }
+    def get
+      case @format
+      when "html", "xml"
+        {
+          :template => "resources/#{model.to_s.underscore}",
+          :locals => { model.to_s.underscore.to_sym => @record } # full record, view should filter
+        }
+      when "json"
+        {
+          :json => @record.exposed_attributes,
+          :status => :ok
+        }
+      else 
+        raise ResourceNotFound
+      end
     end
 
     def delete

data/lib/toast/resource.rb

@@ -21,29 +21,26 @@ module Toast
       resource_name = params[:resource]
       id = params[:id]
       subresource_name = params[:subresource]
-
-      uri_base = "#{request.protocol}#{request.host}"
-      unless (request.protocol == "http://" and request.port == 80) or
-             (request.protocol == "https://" and request.port == 443)
-        uri_base += ":#{request.port}"
-      end
+      format = params[:format]
 
       begin
-
+        
         model = get_class_by_resource_name resource_name
-
-        model.uri_base = uri_base
-        model.uri_base += "/#{model.toast_config.namespace}" if model.toast_config.namespace
+                
+        # base is complete URL until the resource name
+        model.uri_base = request.url.match(/(.*)\/#{resource_name}(?:\..+|\/|\z)/)[1]
 
         # decide which sub type
-        rsc = if id.nil?
-                Toast::RootCollection.new(model, subresource_name)
+        rsc = if id.nil? and model.toast_config.singles.include?(subresource_name)
+                Toast::Single.new(model, subresource_name, params.clone)                 
+              elsif id.nil?
+                Toast::RootCollection.new(model, subresource_name, params.clone)
               elsif subresource_name.nil?
-                Toast::Record.new(model, id)
+                Toast::Record.new(model, id, format)
               elsif model.toast_config.exposed_associations.include? subresource_name
-                Toast::AssociateCollection.new(model, id, subresource_name)
+                Toast::Association.new(model, id, subresource_name, format)                
               elsif model.toast_config.exposed_attributes.include? subresource_name
-                Toast::Attribute.new(model, id, subresource_name)
+                Toast::Attribute.new(model, id, subresource_name, format)
               else
                 raise ResourceNotFound
               end
@@ -82,7 +79,7 @@ module Toast
         self.send(method.downcase)
       else
         raise MethodNotAllowed
-      end
+      end            
     end
   end
 end

data/lib/toast/root_collection.rb

@@ -3,7 +3,7 @@ module Toast
     
     attr_reader :model
     
-    def initialize model, subresource_name
+    def initialize model, subresource_name, params
       
       subresource_name ||= "all"
       
@@ -13,14 +13,35 @@ module Toast
 
       @model = model
       @collection = subresource_name
+      @params = params
+      @format = params[:format]
     end
 
     def get
-      records = @model.send(@collection)
-      {
-        :json => records.map{|r| r.exposed_attributes(:in_collection => true)},
-        :status => :ok
-      }
+      if @model.toast_config.in_collection.disallow_methods.include? "get"
+        raise MethodNotAllowed 
+      end
+       
+      records = if @model.toast_config.pass_params_to.include?(@collection) 
+                  @model.send(@collection, @params)
+                else
+                  @model.send(@collection)
+                end
+
+      case @format
+      when "html"
+        {
+          :template => "resources/#{model.to_s.pluralize.underscore}",
+          :locals => { model.to_s.pluralize.underscore.to_sym => records } 
+        }
+      when "json"        
+        {
+          :json => records.map{|r| r.exposed_attributes(:in_collection => true)},
+          :status => :ok
+        }
+      else
+        raise ResourceNotFound
+      end
     end
 
     def put
@@ -28,6 +49,10 @@ module Toast
     end
 
     def post payload
+      if @model.toast_config.in_collection.disallow_methods.include? "post"
+        raise MethodNotAllowed
+      end
+        
       if @collection != "all"
         raise MethodNotAllowed
       end
@@ -40,17 +65,23 @@ module Toast
         raise PayloadFormatError
       end
 
-      if payload.keys.to_set != @model.toast_config.exposed_attributes.to_set
+      if payload.keys.to_set != (@model.toast_config.exposed_attributes.to_set - @model.toast_config.auto_fields.to_set)
         raise PayloadInvalid
       end
       
-      record = @model.create payload
-      
-      {
-        :json => record.exposed_attributes,
-        :location => record.uri,
-        :status => :created
-      }
+
+      begin
+        record = @model.create! payload              
+
+        {
+          :json => record.exposed_attributes,
+          :location => record.uri,
+          :status => :created
+        }
+
+      rescue ActiveRecord::RecordInvalid => e
+        raise PayloadInvalid.new(e.message)
+      end
     end
 
     def delete

data/lib/toast/single.rb

@@ -0,0 +1,69 @@
+module Toast
+
+  # A Single resource is queried without an ID, by custom class methods
+  # or scopes of the model or ActiveRecord single finders like:
+  # first, last
+
+  # The single resource name must be a class method of the model and
+  # must return nil or an instance.
+  
+  # GET is the only allowed verb. To make changes the URI with ID has
+  # to be used.
+  class Single < Resource
+    
+    attr_reader :model
+    
+    def initialize model, subresource_name, params
+            
+      unless model.toast_config.singles.include? subresource_name
+        raise ResourceNotFound
+      end
+
+      @model = model
+      @single_finder = subresource_name
+      @params = params
+      @format = params[:format]
+    end
+
+    def get
+      if @model.toast_config.in_collection.disallow_methods.include? "get"
+        raise MethodNotAllowed 
+      end
+       
+      record = if @model.toast_config.pass_params_to.include?(@single_finder) 
+                  @model.send(@single_finder, @params)
+                else
+                  @model.send(@single_finder)
+                end
+
+      raise ResourceNotFound if record.nil?
+      
+      case @format
+      when "html"
+        {
+          :template => "resources/#{model.to_s.underscore}",
+          :locals => { model.to_s.pluralize.underscore.to_sym => record } 
+        }
+      when "json"        
+        {
+          :json => record.exposed_attributes,
+          :status => :ok
+        }
+      else
+        raise ResourceNotFound
+      end
+    end
+
+    def put
+      raise MethodNotAllowed
+    end
+
+    def post payload
+      raise MethodNotAllowed
+    end
+
+    def delete
+      raise MethodNotAllowed
+    end
+  end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: toast
 version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
-  - 2
-  - 0
-  version: 0.2.0
+  - 3
+  - 4
+  version: 0.3.4
 platform: ruby
 authors: 
 - Robert Annies
@@ -15,18 +14,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-25 00:00:00 +02:00
+date: 2012-02-29 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: blockenspiel
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
         segments: 
         - 0
         - 4
@@ -50,13 +47,14 @@ files:
 - config/routes.rb
 - lib/toast.rb
 - lib/toast/active_record_extensions.rb
-- lib/toast/associate_collection.rb
+- lib/toast/association.rb
 - lib/toast/attribute.rb
 - lib/toast/config_dsl.rb
 - lib/toast/engine.rb
 - lib/toast/record.rb
 - lib/toast/resource.rb
 - lib/toast/root_collection.rb
+- lib/toast/single.rb
 - README.md
 has_rdoc: true
 homepage: https://github.com/robokopp/toast
@@ -68,27 +66,23 @@ 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.6.2
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Toast adds a RESTful interface to ActiveRecord models in Ruby on Rails.