toast 0.8.13 → 0.8.14

data/README.md

@@ -23,16 +23,21 @@ Toast works with
 
 See the [User Manual](https://github.com/robokopp/toast/wiki/User-Manual) for a detailed description.
 
+Status
+=====
+
+Toast is ready for production and is being used in productive
+applications since 2012. However, misconfigurations can have undesired
+effects.
+
 WARNING
 =======
 
-This version is experimental and probably not bullet
-proof. As soon as the gem is loaded a controller with ready routing is
-enabled serving the annotated model's data records.
+A soon the gem is loaded a controller with ready routing is enabled
+serving the annotated model's data records at least for reading for
+everybody.
 
-Version 1.0.0 of Toast is planned to be a production-ready implementation,
-which will be finished within 2012. Until then API/DSL changes must
-be expected with each minor update.
+You need to implement authorization yourself.
 
 Example
 =======

data/app/controller/toast_controller.rb

@@ -1,3 +1,5 @@
+require 'rack-link_headers'
+
 class ToastController < ApplicationController
 
   def catch_all
@@ -11,7 +13,37 @@ class ToastController < ApplicationController
         request.headers["LINK"] =~ /(#{request.protocol + request.host + request.script_name})(.*)/
       end
 
-      render @resource.apply(request.method, request.body.read, request.content_type, $2)
+      toast_response = @resource.apply(request.method, request.body.read, request.content_type, $2)
+
+      # pagination
+      if pi = toast_response[:pagination_info]
+        # URL w/o parameters
+
+        url =  request.url.split('?').first
+        qpar = request.query_parameters.clone
+
+        # change/add page parameter
+        link_header = []
+
+        if pi[:prev]
+          qpar[:page] = pi[:prev]
+          response.link "#{url}?#{qpar.to_query}", :rel => :prev
+        end
+
+        if pi[:next]
+          qpar[:page] = pi[:next]
+          response.link "#{url}?#{qpar.to_query}", :rel => :next
+        end
+
+        qpar[:page] = pi[:last]
+        response.link "#{url}?#{qpar.to_query}", :rel => :last
+
+        qpar[:page] = 1
+        response.link "#{url}?#{qpar.to_query}", :rel => :first
+
+      end
+
+      render toast_response
 
     rescue Toast::ResourceNotFound => e
       return head(:not_found)
@@ -22,6 +54,9 @@ class ToastController < ApplicationController
     rescue Toast::PayloadFormatError => e
       return head(:bad_request)
 
+    rescue Toast::BadRequest => e
+      return head(:bad_request)
+
     rescue Toast::MethodNotAllowed => e
       return head(:method_not_allowed)
 

data/lib/toast/association.rb

@@ -29,18 +29,24 @@ module Toast
 
       reflection = @model.reflect_on_association(@assoc.to_sym)
 
-      result =
+      if reflection.collection?
+
+
         if(@config.pass_params_to.include?(@assoc) and
            reflection.options[:extend] and
            reflection.options[:extend].detect{|e| e.method_defined? :find_by_params} )
-          @record.send(@assoc).find_by_params(@params)
+
+          result, pagination_info = paginate_query( @config, @assoc,
+                                                    @record.send(@assoc).find_by_params(@params), @params)
         else
-          @record.send(@assoc)
+
+          result, pagination_info = paginate_query( @config, @assoc,
+                                                    @record.send(@assoc), @params)
+
         end
 
-      raise ResourceNotFound if result.nil?
+        raise ResourceNotFound if result.nil?
 
-      if result.is_a? ActiveRecord::Relation or result.is_a? Array
         {
           :json => result.map{|r|
             r.represent( @associate_config_out.in_collection.exposed_attributes,
@@ -49,9 +55,23 @@ module Toast
                          @associate_config_out.media_type )
           },
           :status => :ok,
-          :content_type => @associate_config_out.in_collection.media_type
+          :content_type => @associate_config_out.in_collection.media_type,
+          :pagination_info => pagination_info
         }
+
       else
+
+        result =
+          if(@config.pass_params_to.include?(@assoc) and
+             reflection.options[:extend] and
+             reflectin.options[:extend].detect{|e| e.method_defined? :find_by_params} )
+            @record.send(@assoc).find_by_params(@params)
+          else
+            @record.send(@assoc)
+          end
+
+        raise ResourceNotFound if result.nil?
+
         {
           :json =>  result.represent( @associate_config_out.exposed_attributes,
                                       @associate_config_out.exposed_associations,

data/lib/toast/collection.rb

@@ -32,27 +32,33 @@ module Toast
       #        will be successful, but if it's not checked the error
       #        message is not helpful to find the error.
 
-      records = if @config_out.pass_params_to.include?(@collection)
-                  if @model.method(@collection).arity**2 != 1
-                    raise "Toast Error: Class method '#{@collection}' of model '#{@model}' must accept one parameter, as configured by 'acts_as_resource > pass_params_to'."
-                  end
-                  # fetch results
-                  @model.send(@collection, @params)
-
-                else
-
-                  if @model.method(@collection).arity > 0
-                    raise "Toast Error: Class method '#{@collection}' of model '#{@model}' must not accept any parameter, as configured by 'acts_as_resource'"
-                  end
-                  # fetch results
-                  @model.send(@collection)
-                end
+      if @config_out.pass_params_to.include?(@collection)
+        if @model.method(@collection).arity**2 != 1
+          raise "Toast Error: Class method '#{@collection}' of model '#{@model}' must accept one parameter, as configured by 'acts_as_resource > pass_params_to'."
+        end
+
+        # fetch results
+        #binding.pry if $halt
+        records, pagination_info = paginate_query( @config_out, @collection,
+                                                   @model.send(@collection, @params),
+                                                   @params )
+      else
+
+        if @model.method(@collection).arity > 0
+          raise "Toast Error: Class method '#{@collection}' of model '#{@model}' must not accept any parameter, as configured by 'acts_as_resource'"
+        end
+
+        records, pagination_info = paginate_query( @config_out, @collection,
+                                                   @model.send(@collection=='all'? 'scoped': @collection), # #scoped ?: #all would trigger query too early
+                                                   @params )
+      end
 
       case @format
       when "html"
         {
           :template => "resources/#{@model.to_s.pluralize.underscore}",
-          :locals => { @model.to_s.pluralize.underscore.to_sym => records }
+          :locals => { @model.to_s.pluralize.underscore.to_sym => records,
+                       :pagination_info => pagination_info }
         }
       when "json"
         {
@@ -63,7 +69,8 @@ module Toast
                          @config_out.media_type)
           },
           :status => :ok,
-          :content_type => @config_out.in_collection.media_type
+          :content_type => @config_out.in_collection.media_type,
+          :pagination_info => pagination_info
         }
       else
         raise ResourceNotFound
@@ -127,5 +134,6 @@ module Toast
     def unlink l
       raise MethodNotAllowed
     end
+
   end
 end

data/lib/toast/config_dsl.rb

@@ -18,7 +18,7 @@ module Toast
         @in_collection = ConfigDSL::InCollection.new model, self
         @media_type = "application/json"
         @apidoc = {}
-
+        @paginations = {}
         @model.attr_accessible []
       end
 
@@ -112,12 +112,23 @@ module Toast
         @apidoc = arg
       end
 
+      def paginate collection_name, options={}
+        options.reverse_merge! :page_size => 30
+
+        @paginations[collection_name.to_s] = {:page_size => options[:page_size]}
+      end
+
       # non DSL methods
       dsl_methods false
 
       def field_comments
         @field_comments
       end
+
+      def paginations
+        @paginations
+      end
+
     end
 
     class InCollection

data/lib/toast/resource.rb

@@ -8,6 +8,7 @@ module Toast
   class UnsupportedMediaType < Exception; end
   class RequestedVersionNotDefined < Exception; end
   class ResourceNotAcceptable < Exception; end
+  class BadRequest < Exception; end
 
   # Represents a resource. There are following resource types as sub classes:
   # Record, Collection, Association, Single
@@ -135,5 +136,40 @@ module Toast
 
       out
     end
+
+
+    def paginate_query config, relation_name, relation, params
+
+      if pagination = config.paginations[relation_name] and params[:page] =~ /\d+/
+
+        raise Toast::BadRequest.new("Page 0 not defined. Paging starts with 1") if params[:page].to_i == 0
+
+        ps = pagination[:page_size].to_i
+        total = relation.count
+
+        page = params[:page].to_i
+        total_pages = (total/ps) + (total%ps == 0 ? 0 : 1)
+
+        pagination_info = {}
+
+        if total_pages > 0
+
+          if page > total_pages
+            pagination_info[:prev] = total_pages
+          else
+            pagination_info[:prev] = page - 1 unless page == 1
+            pagination_info[:next] = page + 1 if page < total_pages
+          end
+
+          pagination_info[:last] = total_pages
+        else
+          pagination_info[:last] = 1
+        end
+
+        [relation.limit(ps).offset((page-1) * ps), pagination_info]
+      else
+        [relation, nil]
+      end
+    end
   end
 end

data/lib/toast/version.rb

@@ -1,3 +1,3 @@
 module Toast
-  VERSION = '0.8.13'
+  VERSION = '0.8.14'
 end

metadata

@@ -1,81 +1,112 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: toast
-version: !ruby/object:Gem::Version
-  version: 0.8.13
+version: !ruby/object:Gem::Version 
+  hash: 35
+  prerelease: 
+  segments: 
+  - 0
+  - 8
+  - 14
+  version: 0.8.14
 platform: ruby
-authors:
-- robokopp (Robert Anniés)
+authors: 
+- "robokopp (Robert Anni\xC3\xA9s)"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-04-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 3.1.0
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 3
+        - 1
+        - 0
         version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: blockenspiel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.2
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: blockenspiel
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 4
+        - 2
         version: 0.4.2
-- !ruby/object:Gem::Dependency
-  name: rack-accept-media-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rack-accept-media-types
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: ffaker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rack-link_headers
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 2
+        - 2
+        version: 2.2.2
+  type: :runtime
+  version_requirements: *id005
 description: |-
   Toast is an extension to Ruby on Rails that lets you expose any
   ActiveRecord model as a resource according to the REST paradigm via a generic controller. The default
   representation format is JSON or can be anything
 email: robokopp@fernwerk.net
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.md
-files:
+files: 
 - app/controller/toast_controller.rb
 - config/routes.rb
 - lib/toast.rb
@@ -89,27 +120,39 @@ files:
 - lib/toast/resource.rb
 - lib/toast/single.rb
 - README.md
+has_rdoc: true
 homepage: https://github.com/robokopp/toast
 licenses: []
-metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+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: 2.0.3
+rubygems_version: 1.6.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Toast adds a RESTful interface to ActiveRecord models in Ruby on Rails.
 test_files: []
+

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: b312ad41453a5e1c9d8c38fb0ebfc38d0d1c26fe
-  data.tar.gz: c09def11305a4ec61d570f98ef71de7982da41af
-SHA512:
-  metadata.gz: 6aad28550213a443d1d8b3d0a8b4f4dbf282f83a1295b90c40f7e3cc1155900aaab227276455f24b5343f6bf6b670cc56d2dabe13bcb3799652a4d799692694d
-  data.tar.gz: 42421ba7a9854ce1b8ce0aceaf3c5716fe069ab3e396c90167a895a8a7b84cce0ddcaf4d6b68d38dfbbb86ee61acda3ac9b4f455d8ce8984108f8b93f8eaa819