toast 0.9.5 → 1.0.0

data/lib/toast/config_dsl/via_verb.rb

@@ -0,0 +1,49 @@
+class Toast::ConfigDSL::ViaVerb
+  include Toast::ConfigDSL::Common
+
+  def allow &block
+    stack_push 'allow' do
+
+      unless block.arity.in? [3, -2, -1]
+        raise_config_error 'Allow rule must list arguments as |*all|, |auth, *rest| or |auth, request_model, uri_params|'
+      end
+
+      @config_data.permissions << block
+    end
+  end
+
+  def handler &block
+    stack_push 'handler' do
+
+      # arity check for custom handlers
+      expected_arity = case Toast::ConfigDSL.stack[-3]
+                       when /\Asingle/
+                         1
+                       when /\Acollection/
+                         case Toast::ConfigDSL.stack[-2]
+                         when 'via_get'  then 1
+                         when 'via_post' then 2
+                         end
+
+                       when /\Aassociation/
+                         case Toast::ConfigDSL.stack[-2]
+                         when 'via_get'                    then 2
+                         when /\Avia_(post|link|unlink)\z/ then 3
+                         end
+
+                       when /\Aexpose/
+                         case Toast::ConfigDSL.stack[-2]
+                         when /\Avia_(get|delete)\z/ then 2
+                         when 'via_patch'              then 3
+                         end
+                       end
+
+
+      if block.arity != expected_arity
+        raise_config_error "Handler block must take exactly #{expected_arity} argument#{expected_arity==1?'':'s'}"
+      end
+
+      @config_data.handler = block
+    end
+  end
+end

data/lib/toast/config_dsl.rb

@@ -1,233 +1,68 @@
 module Toast
   module ConfigDSL
 
-    class Base
-      include Blockenspiel::DSL
-      dsl_attr_accessor :namespace, :media_type
-
-      def initialize model
-        @model = model
-        @readables = []
-        @writables = []
-        @field_comments = {}
-        @collections = []
-        @singles = []
-        @deletable = false
-        @postable = false
-        @pass_params_to = []
-        @in_collection = ConfigDSL::InCollection.new model, self
-        @media_type = "application/json"
-        @apidoc = {}
-        @paginations = {}
-        @model.attr_accessible []
-      end
-
-      def exposed_attributes
-        assocs = @model.reflect_on_all_associations.map{|a| a.name.to_s}
-        (@writables + @readables).uniq.select{|f| !assocs.include?(f)}
-      end
-
-      def exposed_associations
-        assocs = @model.reflect_on_all_associations.map{|a| a.name.to_s}
-        (@writables + @readables).uniq.select{|f| assocs.include?(f)}
-      end
-
-      def readables= arg
-        @field_comments.merge! ConfigDSL.get_comments(arg, 'ro')
-        @readables.push *ConfigDSL.normalize(arg,"readables")
-      end
-
-      # args: Array or :all, :except => Array
-      def readables *arg
-        return(@readables) if arg.empty?
-        self.readables = arg
-      end
-
-      def writables= arg
-        @field_comments.merge! ConfigDSL.get_comments(arg, 'rw')
-        @writables.push *ConfigDSL.normalize(arg,"writables")
-        @model.attr_accessible *@writables
-      end
-
-      # args: Array or :all, :except => Array
-      def writables *arg
-        return(@writables) if arg.empty?
-        self.writables = arg
-      end
-
-      def deletable
-        @deletable = true
-      end
-
-      def deletable?
-        @deletable
-      end
-
-      def postable
-        @postable = true
-      end
-
-      def postable?
-        @postable
-      end
-
-      def pass_params_to= arg
-        @pass_params_to.push *ConfigDSL.normalize(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.normalize(collections, "collections")
-      end
-
-      def collections *arg
-        return(@collections) if arg.empty?
-        self.collections = arg
-      end
-
-      def singles= singles=[]
-        @singles = ConfigDSL.normalize(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)
-        else
-          @in_collection
-        end
-      end
-
-      def apidoc arg=nil
-        return(@apidoc) if arg.nil?
-        raise "Toast Config Error (#{model.class}): apidoc argument must be a Hash." unless arg.is_a?(Hash)
-        @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
-
+    # the currently process config file name
+    mattr_accessor :cfg_name
+
+    # traces the descent into the configuration, while gathering config items
+    mattr_accessor :stack
+
+    # Interprets one config file and stores config info in the @expositions Array using OpenStruct.
+    #
+    # Params:
+    # +config+:: [String] The configuration file's content as string
+    # +fname+::  [String] The file name of the config file with path relative to +Rails.root+
+    #
+    # Return: +nil+
+    def self.get_config _toast_config, _toast_cfg_name
+
+      # using _toast_ prefix for all locals here, because they end up in the
+      # handler/allow block scope (closure)
+      # also freeze them to prevent accidental changes
+      # is there a way to remove closure vars with instance_eval?
+
+      _toast_config.freeze
+      _toast_cfg_name.freeze
+
+      @@cfg_name = _toast_cfg_name
+      @@stack    = []
+
+      _toast_base = ConfigDSL::Base.new
+      _toast_base.freeze
+      _toast_base.instance_eval(_toast_config, _toast_cfg_name)
+
+    rescue ArgumentError, NameError => _toast_error
+      _toast_base.raise_config_error _toast_error.message
     end
 
-    class InCollection
-      include Blockenspiel::DSL
-
-      dsl_attr_accessor :media_type
-
-      def initialize model, base_config
-        @model = model
-        @media_type = "application/json"
-        @readables = base_config.readables # must assign a reference
-        @writables = base_config.writables # must assign a reference
-      end
-
-      def readables= readables
-        @writables = [] # forget inherited writables
-        @readables = ConfigDSL.normalize(readables,"readables")
-      end
-
-      def readables *arg
-        return(@readables) if arg.empty?
-        self.readables = arg
-      end
-
-      def writables *arg
-        self.writables = 42
-      end
-
-      def writables= arg
-        puts
-        puts "Toast Config Warning (#{@model.class}): Defining \"writables\" in collection definition has no effect."
-        puts
-      end
-
-      def namespace *arg
-        self.writables = 42
-      end
-
-      def namespace= arg
-        puts
-        puts "Toast Config Warning (#{@model.class}): Defining \"namespace\" in collection definition has no effect."
-        puts
-      end
-
-      def exposed_attributes
-        assocs = @model.reflect_on_all_associations.map{|a| a.name.to_s}
-        (@readables + @writables).uniq.select{|f| !assocs.include?(f)}
-      end
-
-      def exposed_associations
-        assocs = @model.reflect_on_all_associations.map{|a| a.name.to_s}
-        (@readables + @writables).uniq.select{|f| assocs.include?(f)}
-      end
-
-    end # class InCollection
-
-    # Helper
-
-    # checks if list is made of symbols and strings
-    # converts a single value to an Array
-    # converts all symbols to strings
-    def self.normalize list, name
-      # make single element list
-      list = [list] unless list.is_a? Array
-
-      # remove all comments
-      list = list.map{|x| x.is_a?(Array) ? x.first : x}
-
-      # flatten
-      list = [list].flatten
-
-      # check class and stringify
-      list.map do |x|
-        if (!x.is_a?(Symbol) && !x.is_a?(String))
-          raise "Toast Config Error: '#{name}' should be a list of Symbols"
-        else
-          x.to_s
-        end
-      end
-    end
-
-    # fields (readables and writables) can have comments , if passed by Arrays of the form:
-    # [symbol, comment]
-    # returns a Hash of all commented or uncommented fields as:
-    # { FIELD_NAME => {:comment => COMMENT, :type => type } }
-    def self.get_comments arg, access
-      comments = {}
-
-      if arg.is_a? Array
-        arg.each do |f|
-          if f.is_a? Array
-            comments[ f.first.to_s ] = {:comment => f[1].to_s, :access => access, :type => f[2]}
-          else
-            comments[ f.to_s ] = {:comment => '[ no comment ]', :access => access, :type => nil}
-          end
-        end
-      end
-
-      comments
+    # Interprets the global settings file and stores data using OpenStruct
+    # Params:
+    # +config+:: [String] The configuration file's content as string
+    # +fname+::  [String] The file name of the config file with path relative to +Rails.root+
+    #
+    # Return: +nil+
+    def self.get_settings config, cfg_name
+      @@cfg_name = cfg_name
+      @@stack    = []
+
+      # defaults
+      Toast.settings = OpenStruct.new
+      Toast.settings.max_window = 42
+      Toast.settings.link_unlink_via_post = false
+      Toast.settings.authenticate = lambda{|r| r}
+
+      settings = ConfigDSL::Settings.new
+      settings.instance_eval(config, cfg_name)
+
+    rescue ArgumentError, NameError => error
+      settings.raise_config_error error.message
     end
   end
 end
+
+require 'toast/config_dsl/common'
+require 'toast/config_dsl/base'
+require 'toast/config_dsl/expose'
+require 'toast/config_dsl/association'
+require 'toast/config_dsl/via_verb'
+require 'toast/config_dsl/settings'

data/lib/toast/engine.rb

@@ -1,45 +1,34 @@
-require 'toast/active_record_extensions.rb'
-require 'toast/resource.rb'
-require 'toast/collection'
-require 'toast/association'
-require 'toast/record'
-require 'toast/single'
-
-require 'action_dispatch/http/request'
-require 'rack/accept_media_types'
-
 module Toast
   class Engine < Rails::Engine
 
     # configure our plugin on boot. other extension points such
     # as configuration, rake tasks, etc, are also available
     initializer "toast.initialize" do |app|
-      # Add 'acts_as_resource' declaration to ActiveRecord::Base
-      ActiveRecord::Base.extend Toast::ActiveRecordExtensions
-
-      # Load all models in app/models early to setup routing
-      begin
-        Dir["#{Rails.root}/app/models/**/*.rb"].each{|m| require_dependency m }
 
-      rescue
-        # raised when DB is not setup yet. (rake db:schema:load)
+      # allow LINK and UNLINK methods
+      if ActionDispatch::Request::HTTP_METHOD_LOOKUP['LINK'] == :link and
+        ActionDispatch::Request::HTTP_METHOD_LOOKUP['UNLINK'] == :unlink
+        Toast.info "INFO: LINK and UNLINK allowed by this Rails version: #{Rails.version}"
+      else
+        ActionDispatch::Request::HTTP_METHOD_LOOKUP['LINK'] = :link
+        ActionDispatch::Request::HTTP_METHOD_LOOKUP['UNLINK'] = :unlink
       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
+      # for LINK/UNLINK via POST and x-http-method-override header
+      app.middleware.unshift Rack::MethodOverride
 
-            if scheme == "https" && port != 443 ||
-                scheme == "http" && port != 80
-              url << ":#{port}"
-            end
+      # skip init if in test mode: Toast.init should be called in each test
+      unless Rails.env == 'test'
+        begin
+          Toast.info 'Loading Toast'
+          Toast.init
+          Toast.info "Exposed model classes: #{Toast.expositions.map{|e| e.model_class.name}.join(' ')}"
 
-            url
+        rescue Toast::ConfigError => error
+          error.message.split("\n").each do |line|
+            Toast.info line
           end
+          Toast.disable
         end
       end
     end

data/lib/toast/errors.rb

@@ -0,0 +1,41 @@
+module Toast::Errors
+  class ConfigNotFound < StandardError; end
+
+  class HandlerError < StandardError
+    attr_accessor :orig_error, :source_location
+
+    def initialize orig_error, source_location
+      @orig_error = orig_error
+      @source_location = source_location
+      super ''
+    end
+  end
+
+  class AllowError < HandlerError; end
+
+  class NotAllowed < StandardError
+    attr_accessor :source_location
+
+    def initialize source_location
+      @source_location = source_location
+      super ''
+    end
+  end
+
+  class BadRequest < StandardError
+    attr_accessor :source_location
+
+    def initialize message, source_location
+      @source_location = source_location
+      super message
+    end
+  end
+
+  class CustomAuthFailure < StandardError
+    attr_accessor :response_data
+
+    def initialize response_data
+      @response_data = response_data
+    end
+  end
+end

data/lib/toast/http_range.rb

@@ -0,0 +1,17 @@
+class Toast::HttpRange
+  attr_reader :start, :end, :size
+
+  def initialize range
+    if range.nil?
+      @start = 0
+      @end   = nil
+      @size  = nil
+    else
+      range =~ /\Aitems=(\d*)-(\d*)/
+      @start = Integer($1) rescue 0
+      @end   = Integer($2) rescue nil
+      @end   = nil if (@end and (@end < @start))
+      @size  = @end - @start + 1 rescue nil
+    end
+  end
+end