toast 0.4.1 → 0.5.0

data/app/controller/toast_controller.rb

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

data/config/routes.rb

@@ -8,6 +8,7 @@ Rails.application.routes.draw do
     match("#{model.toast_config.namespace}/#{resource_name}(/:id(/:subresource))" => 'toast#catch_all', 
           :constraints => { :id => /\d+/ }, 
           :resource => resource_name,
+          :as => resource_name,
           :defaults => { :format => 'json' })
     
     match("#{model.toast_config.namespace}/#{resource_name}/:subresource" => 'toast#catch_all', 

data/lib/toast/active_record_extensions.rb

@@ -25,9 +25,12 @@ module Toast
 
       # add instance methods
       self.class_eval do
-        # Return toast's standard uri for a record
-        def uri
-          "#{self.class.uri_base}/#{self.class.to_s.pluralize.underscore}/#{self.id}"
+        # Return the path segment of the URI of this record
+        def uri_fullpath
+          "/" +
+            (self.class.toast_config.namespace ? self.class.toast_config.namespace+"/" : "") +
+            self.class.to_s.pluralize.underscore + "/" +
+            self.id.to_s
         end
 
         # Returns a Hash with all exposed attributes
@@ -45,22 +48,13 @@ module Toast
             acc
           end
 
-          # association URIs
-          exposed_assoc =
-            options[:in_collection] ? self.class.toast_config.in_collection.exposed_associations :
-                                      self.class.toast_config.exposed_associations
-
-          exposed_assoc.each do |assoc|
-            out[assoc] = self.uri + "/" + assoc
-          end
-
-          out["uri"] = self.uri if options[:with_uri]
-
           out
         end
       end
     end
 
+    alias acts_as_resource resourceful_model
+
     # defaults for non resourceful-models
     def is_resourceful_model?
       false

data/lib/toast/association.rb

@@ -24,12 +24,16 @@ module Toast
 
       if result.is_a? Array 
         {
-          :json => result.map{|r| r.exposed_attributes(:in_collection => true)},
+          :json => result.map{|r|
+            r.exposed_attributes(:in_collection => true).
+            merge( uri_fields(r, true) )
+          },
           :status => :ok
         }
       else
         {
-          :json => result.exposed_attributes(:in_collection => true),
+          :json => result.exposed_attributes(:in_collection => true).
+                   merge( uri_fields(result) ),
           :status => :ok
         }
       end
@@ -37,48 +41,11 @@ module Toast
     end
 
     def put payload
-      # only for has_one/belongs_to assocs            
-      raise MethodNotAllowed if @is_collection
-
-      
-      begin 
-        payload = ActiveSupport::JSON.decode(payload)
-      rescue
-        raise PayloadFormatError
-      end
-
-
-      unless payload.is_a? Hash
-        raise PayloadFormatError
-      end
-      
-      # update see record
-      if self.media_type != @associate_model.toast_config.media_type
-        raise UnsupportedMediaType
-      end
-
-      # silently ignore all exposed readable, but not writable fields
-      (@associate_model.toast_config.readables - @associate_model.toast_config.writables).each do |rof|
-        payload.delete(rof)
-      end
-      
-      record = @record.send(@assoc)
-      
-      # set the virtual attributes 
-      (payload.keys.to_set - record.attribute_names.to_set).each do |vattr|
-        record.send("#{vattr}=", payload.delete(vattr))             
-      end 
-      
-      # mass-update for the rest 
-      record.update_attributes payload
-      { 
-        :json => record.exposed_attributes,
-        :status => :ok,
-        :location => record.uri
-      }      
+      raise MethodNotAllowed 
     end
 
     def post payload
+      raise MethodNotAllowed unless @model.toast_config.writables.include? @assoc
 
       if self.media_type != @associate_model.toast_config.media_type
         raise UnsupportedMediaType
@@ -105,8 +72,8 @@ module Toast
         record = @record.send(@assoc).create! payload
       
         {
-          :json => record.exposed_attributes,
-          :location => record.uri,
+          :json => record.exposed_attributes.merge( uri_fields(record) ),
+          :location => self.base_uri + record.uri_fullpath,
           :status => :created
         }
       

data/lib/toast/config_dsl.rb

@@ -7,12 +7,13 @@ module Toast
 
       def initialize model
         @model = model
-        @readables = ["uri"]
+        @readables = []
         @writables = []
         @collections = []
         @singles = []
         @media_type = "application/json"
-        @disallow_methods = []
+        @deletable = false
+        @postable = false
         @pass_params_to = []
         @in_collection = ConfigDSL::InCollection.new model, self
       end
@@ -28,43 +29,40 @@ module Toast
       end
 
       def readables= arg
-        #if arg.first == :all
-        #  @readables.push @model.attribute_names - ConfigDSL.sanitize(args.last[:except], "readables")
-        #else
-          @readables.push *ConfigDSL.sanitize(arg,"readables")          
-        #end
+          @readables.push *ConfigDSL.sanitize(arg,"readables")
       end
 
       # args: Array or :all, :except => Array
       def readables *arg
         return(@readables) if arg.empty?
-        self.readables = arg        
+        self.readables = arg
       end
 
       def writables= arg
-        #if arg.first == :all
-        #  @writables.push @model.attribute_names - ConfigDSL.sanitize(args.last[:except], "writables")
-        #else
-        # white list writables (protect the rest from mass-assignment)
         @model.attr_accessible *arg
-        @writables.push *ConfigDSL.sanitize(arg,"writables")          
-        #end
+        @writables.push *ConfigDSL.sanitize(arg,"writables")
       end
 
       # args: Array or :all, :except => Array
       def writables *arg
         return(@writables) if arg.empty?
-        self.writables = arg        
+        self.writables = arg
+      end
+
+      def deletable
+        @deletable = true
       end
 
-     
-      def disallow_methods= arg
-        @disallow_methods.push *ConfigDSL.sanitize(arg,"disallow methods")
+      def deletable?
+        @deletable
       end
 
-      def disallow_methods *arg
-        return(@disallow_methods) if arg.empty?
-        self.disallow_methods = arg        
+      def postable
+        @postable = true
+      end
+
+      def postable?
+        @postable
       end
 
       def pass_params_to= arg
@@ -73,9 +71,9 @@ module Toast
 
       def pass_params_to *arg
         return(@pass_params_to) if arg.empty?
-        self.pass_params_to = arg        
+        self.pass_params_to = arg
       end
-     
+
       def collections= collections=[]
         @collections = ConfigDSL.sanitize(collections, "collections")
       end
@@ -111,15 +109,14 @@ module Toast
 
       def initialize model, base_config
         @model = model
-        @readables = base_config.readables # must assign a reference 
-        @writables = base_config.writables # must assign a reference 
-        @disallow_methods = []
+        @readables = base_config.readables # must assign a reference
+        @writables = base_config.writables # must assign a reference
         @media_type = "application/json"
       end
 
       def readables= readables
         @writables = [] # forget inherited writables
-        @readables = ConfigDSL.sanitize(readables,"readables") << "uri"
+        @readables = ConfigDSL.sanitize(readables,"readables")
       end
 
       def readables *arg
@@ -146,16 +143,6 @@ module Toast
         assocs = @model.reflect_on_all_associations.map{|a| a.name.to_s}
         (@readables + @writables).uniq.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
-
     end
 
 

data/lib/toast/engine.rb

@@ -24,6 +24,23 @@ module Toast
         # raised when DB is not setup yet. (rake db:schema:load)
       end
 
+      # Monkey patch the request class for Rails 3.0, Rack 1.2
+      # Backport from Rack 1.3
+      if Rack.release == "1.2"
+        class Rack::Request
+          def base_url
+            url = scheme + "://"
+            url << host
+
+            if scheme == "https" && port != 443 ||
+                scheme == "http" && port != 80
+              url << ":#{port}"
+            end
+
+            url
+          end
+        end
+      end
     end
   end
 end

data/lib/toast/record.rb

@@ -31,12 +31,12 @@ module Toast
       unless payload.is_a? Hash
         raise PayloadFormatError
       end
-      
-      # silently ignore all exposed readable, but not writable fields
-      (@model.toast_config.readables - @model.toast_config.writables).each do |rof|
+
+      # ignore all exposed readable, but not writable fields
+      (@model.toast_config.readables - @model.toast_config.writables + ["uri"]).each do |rof|
         payload.delete(rof)
       end
-      
+
       # set the virtual attributes 
       (payload.keys.to_set - @record.attribute_names.to_set).each do |vattr|
         @record.send("#{vattr}=", payload.delete(vattr))             
@@ -45,9 +45,9 @@ module Toast
       # mass-update for the rest 
       @record.update_attributes payload
       { 
-        :json => @record.exposed_attributes,
+        :json => @record.exposed_attributes.merge( uri_fields(@record) ),
         :status => :ok,
-        :location => @record.uri
+        :location => self.base_uri + @record.uri_fullpath
       }
     end
 
@@ -58,9 +58,9 @@ module Toast
           :template => "resources/#{model.to_s.underscore}",
           :locals => { model.to_s.underscore.to_sym => @record } # full record, view should filter
         }
-      when "json"
+      when "json"       
         {
-          :json => @record.exposed_attributes,
+          :json => @record.exposed_attributes.merge( uri_fields(@record) ), 
           :status => :ok
         }
       else 
@@ -69,11 +69,14 @@ module Toast
     end
 
     def delete
+      raise MethodNotAllowed unless @model.toast_config.deletable?
+
       @record.destroy
       {
         :nothing => true,
         :status => :ok
       }
     end
+    
   end
 end

data/lib/toast/resource.rb

@@ -10,40 +10,37 @@ module Toast
   # Record, RootCollection, Association, Single
   class Resource
 
-    attr_accessor :media_type
+    attr_accessor :media_type, :base_uri
 
     def initialize
       raise 'ToastResource#new: use #build to create an instance'
     end
 
     def self.build params, request
-
       resource_name = params[:resource]
       id = params[:id]
       subresource_name = params[:subresource]
       format = params[:format]
 
       begin
-        
+
         model = get_class_by_resource_name resource_name
-                
-        # 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? and model.toast_config.singles.include?(subresource_name)
-                Toast::Single.new(model, subresource_name, params.clone)                 
+                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, format)
               elsif model.toast_config.exposed_associations.include? subresource_name
-                Toast::Association.new(model, id, subresource_name, format)                
+                Toast::Association.new(model, id, subresource_name, format)
               else
                 raise ResourceNotFound
               end
-        
+
         rsc.media_type = request.media_type
+        rsc.base_uri = request.base_url
 
         rsc
       rescue NameError
@@ -67,18 +64,31 @@ module Toast
     end
 
     def apply method, payload
-
-      raise MethodNotAllowed if self.model.toast_config.disallow_methods.include?(method.downcase)
-      
       case method
       when "PUT","POST"
         self.send(method.downcase, payload)
       when "DELETE","GET"
-        self.send(method.downcase)
+         self.send(method.downcase)
       else
         raise MethodNotAllowed
-      end            
+      end
+    end
+
+    private
+    def uri_fields record, in_collection=false
+      out = {}
+
+      exposed_assoc =
+        in_collection ? record.class.toast_config.in_collection.exposed_associations :
+                        record.class.toast_config.exposed_associations
+
+      exposed_assoc.each do |assoc|
+        out[assoc] = "#{self.base_uri}#{record.uri_fullpath}/#{assoc}"
+      end
+
+      out["uri"] = self.base_uri + record.uri_fullpath
+
+      out
     end
   end
 end
-

data/lib/toast/root_collection.rb

@@ -18,9 +18,6 @@ module Toast
     end
 
     def get
-      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)
@@ -36,7 +33,10 @@ module Toast
         }
       when "json"        
         {
-          :json => records.map{|r| r.exposed_attributes(:in_collection => true)},
+          :json => records.map{|r|
+            r.exposed_attributes(:in_collection => true).
+            merge( uri_fields(r, true) )
+          },
           :status => :ok
         }
       else
@@ -49,10 +49,8 @@ module Toast
     end
 
     def post payload
-      if @model.toast_config.in_collection.disallow_methods.include? "post"
-        raise MethodNotAllowed
-      end
-        
+      raise MethodNotAllowed unless @model.toast_config.postable?
+
       if @collection != "all"
         raise MethodNotAllowed
       end
@@ -71,7 +69,7 @@ module Toast
       end
 
       # silently ignore all exposed readable, but not writable fields
-      (@model.toast_config.readables - @model.toast_config.writables).each do |rof|
+      (@model.toast_config.readables - @model.toast_config.writables + ["uri"]).each do |rof|
         payload.delete(rof)
       end
       
@@ -79,8 +77,8 @@ module Toast
         record = @model.create! payload              
 
         {
-          :json => record.exposed_attributes,
-          :location => record.uri,
+          :json => record.exposed_attributes.merge( uri_fields(record) ),
+          :location => self.base_uri + record.uri_fullpath,
           :status => :created
         }
         

data/lib/toast/single.rb

@@ -6,47 +6,43 @@ module Toast
 
   # 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)
+      @record = if @model.toast_config.pass_params_to.include?(subresource_name)
+                  @model.send(subresource_name, @params)
                 else
-                  @model.send(@single_finder)
+                  @model.send(subresource_name)
                 end
 
-      raise ResourceNotFound if record.nil?
-      
+      raise ResourceNotFound if @record.nil?
+
+    end
+
+    def get
       case @format
       when "html"
         {
           :template => "resources/#{model.to_s.underscore}",
-          :locals => { model.to_s.pluralize.underscore.to_sym => record } 
+          :locals => { model.to_s.pluralize.underscore.to_sym => @record }
         }
-      when "json"        
+      when "json"
         {
-          :json => record.exposed_attributes,
+          :json => @record.exposed_attributes.merge( uri_fields(@record) ),
           :status => :ok
         }
       else
@@ -54,6 +50,7 @@ module Toast
       end
     end
 
+
     def put
       raise MethodNotAllowed
     end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 1
-  version: 0.4.1
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Robert Annies
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-13 00:00:00 +01:00
+date: 2012-03-20 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency