moonrope 1.2.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3dec6b64d723aeb2e166a548bd1b0979e6f8639
-  data.tar.gz: 1578b8fcea65a8fa2a8021cf2e8d1ddb3b5db665
+  metadata.gz: 1be661422027acf61678bd7b6a73932376b53ec3
+  data.tar.gz: 3ea06c9d8c46916c81b833d6c0bd7328e7886580
 SHA512:
-  metadata.gz: e78a8573273c0bc8a0f4f892bbef61142c0b391fd01909130952c606cfd11888974569751659ba4d016763e7f143de9f199f22b6a5f01941c4fd4f4816665c5b
-  data.tar.gz: 5829ec72fbbbcce330cf9666927a270b4351a4c9bf26c2bba5edaecbb0301d3b3d7a452af049cba0a1523593a97cd29655f99f47f43936d7fabdaee5a6903cbf
+  metadata.gz: adf31e337346e9f3013a1d89b6583ef1dc87a0fd771c21aaf4c871460e31abdc6f95c839922df56cc8eaaac91dec05b60fe15f3ad99ab0eff86cde9b171155a7
+  data.tar.gz: 3256a19d2938b43720bdf9ea95ffac7f5f86704c9acffce1977c7f16591ea0eacfbc1de49b96fa3b5a0782fba49955e52a6407c75da60efbbb71781fdb219791

data/lib/moonrope/action.rb

@@ -1,27 +1,27 @@
 module Moonrope
   class Action
-    
+
     # @return [Moonrope::Controller] the associated controller
     attr_reader :controller
-    
+
     # @return [Symbol] the name of the action
     attr_reader :name
-    
+
     # @return [Moonrope::DSL::Action] the action's DSL
     attr_reader :dsl
-    
+
     # @return [Hash] the params available for the action
     attr_reader :params
-    
+
     # @return [String] the description of the action
     attr_accessor :description
-    
+
     # @return [Proc] the access check condition for the action
     attr_accessor :access
-    
+
     # @return [Proc] the action for the action
     attr_accessor :action
-    
+
     #
     # Initialize a new action
     #
@@ -36,9 +36,9 @@ module Moonrope
       @dsl = Moonrope::DSL::ActionDSL.new(self)
       @dsl.instance_eval(&block) if block_given?
     end
-    
+
     #
-    # Return a hash of all params for this action which are 
+    # Return a hash of all params for this action which are
     #
     # @return [Hash] hash with field names as keys with default values
     #
@@ -48,7 +48,7 @@ module Moonrope
         h
       end
     end
-    
+
     #
     # Execute a block of code and catch approprite Moonrope errors and return
     # a result.
@@ -74,12 +74,12 @@ module Moonrope
         end
       end
     end
-    
+
     #
     # Executes the action and returns a ActionResult object with the result
     # of the action.
     #
-    # @param request [Moonrope::Request or Moonrope::EvalEnvironment] 
+    # @param request [Moonrope::Request or Moonrope::EvalEnvironment]
     # @return [Moonrope::ActionResult]
     #
     def execute(request = nil)
@@ -88,38 +88,38 @@ module Moonrope
       else
         eval_environment = EvalEnvironment.new(@controller.base, request)
       end
-      
+
       #
       # Set this actions default parameters in the eval environment so that
       # it has access to them.
       #
       eval_environment.default_params = self.default_params
-      
+
       #
       # Set the current action to the eval environment so it knows what action
       # invoked this.
       #
       eval_environment.action = self
-      
+
       convert_errors_to_action_result do
         #
         # Validate the parameters
         #
         self.validate_parameters(eval_environment.params)
-        
+
         start_time = Time.now
-        
+
         # Run before filters
         controller.before_actions_for(name).each do |action|
           eval_environment.instance_eval(&action.block)
         end
-        
+
         # Run the actual action
         response = eval_environment.instance_eval(&action)
-        
+
         # Calculate the length of time this request takes
         time_to_run = Time.now - start_time
-        
+
         # Prepare a action result
         result = ActionResult.new(self)
         result.data     = response
@@ -127,12 +127,12 @@ module Moonrope
         result.time     = time_to_run.round(2)
         result.flags    = eval_environment.flags
         result.headers  = eval_environment.headers
-        
+
         # Return the result object
         result
       end
     end
-    
+
     #
     # Check whether the authenticated user has access to this request.
     # Accepts a Request or an EvalEnvironment.
@@ -146,9 +146,9 @@ module Moonrope
       else
         eval_environment = EvalEnvironment.new(@controller.base, request)
       end
-      
+
       access_condition = self.access || @controller.access || @controller.base.default_access
-      
+
       if eval_environment.auth
         # If there's no authentication object, access is permitted otherwise
         # we'll do the normal testing.
@@ -174,7 +174,7 @@ module Moonrope
         !access_condition
       end
     end
-    
+
     #
     # Return whether or not the passed ParamSet is valid for this action
     #
@@ -186,17 +186,17 @@ module Moonrope
         if value[:required] && param_set[name].nil?
           raise Moonrope::Errors::ParameterError, "`#{name}` parameter is required but is missing"
         end
-        
+
         if value[:regex] && param_set[name] && !(param_set[name].to_s =~ value[:regex])
           raise Moonrope::Errors::ParameterError, "`#{name}` parameter is invalid"
         end
-        
+
         if value[:type] && param_set[name] && !param_set[name].is_a?(value[:type])
           raise Moonrope::Errors::ParameterError, "`#{name}` should be a `#{value[:type]}` but is a `#{param_set[name].class}`"
         end
       end
       true
     end
-         
+
   end
 end

data/lib/moonrope/action_result.rb

@@ -1,6 +1,6 @@
 module Moonrope
   class ActionResult
-    
+
     #
     # Initialize a new result from a Moonrope::Action.
     #
@@ -12,22 +12,22 @@ module Moonrope
       @time = nil
       @flags = {}
     end
-    
+
     # @return [Object] the return value from the action
     attr_accessor :data
-    
+
     # @return [String] the status of the request
     attr_accessor :status
-    
+
     # @return [Hash] headers which have been set in the action
     attr_accessor :headers
-    
+
     # @return [Float] the length of time to process the action
     attr_accessor :time
-    
+
     # @return [Hash] flags which have been set in the action
     attr_accessor :flags
-    
+
     #
     # Return a Hash representation of this ActionResult without the
     # headers.
@@ -49,7 +49,7 @@ module Moonrope
         :data => self.data
       }
     end
-    
+
     #
     # Return the ActionResult's hash with a JSON.
     #
@@ -58,6 +58,6 @@ module Moonrope
     def to_json
       to_hash.to_json
     end
-    
+
   end
 end

data/lib/moonrope/base.rb

@@ -1,8 +1,8 @@
 module Moonrope
   class Base
-    
+
     #
-    # Load a set of Moonrope configuration files from a given 
+    # Load a set of Moonrope configuration files from a given
     # directory.
     #
     # @param path [String] the path to a directory containing Moonrope files
@@ -13,34 +13,34 @@ module Moonrope
       api.load(path)
       api
     end
-    
+
     # @return [Array] the array of defined structures
     attr_reader :structures
-    
+
     # @return [Array] the array of defined controllers
     attr_accessor :controllers
-    
+
     # @return [Array] the array of defined helpers
     attr_accessor :helpers
-    
+
     # @return [Moonrope::DSL::BaseDSL] the base DSL
     attr_accessor :dsl
-    
+
     # @return [Proc] the authentictor
     attr_accessor :authenticator
-    
+
     # @return [Proc] the default access condition
     attr_accessor :default_access
-    
+
     # @return [Array] the array of directories to load from  (if relevant)
     attr_accessor :load_directories
-    
+
     # @return [String] the moonrope environment
     attr_accessor :environment
-    
+
     # @return [Proc] a proc to execute before every request
     attr_accessor :on_request
-    
+
     #
     # Initialize a new instance of the Moonrope::Base
     #
@@ -53,7 +53,7 @@ module Moonrope
       @dsl = Moonrope::DSL::BaseDSL.new(self)
       @dsl.instance_eval(&block) if block_given?
     end
-    
+
     #
     # Reset the whole base to contain no data.
     #
@@ -64,7 +64,7 @@ module Moonrope
       @authenticator = nil
       @default_access = nil
     end
-    
+
     #
     # Reload this whole base API from the path
     #
@@ -84,9 +84,9 @@ module Moonrope
         raise Moonrope::Errors::Error, "Can't reload Moonrope::Base as it wasn't required from a directory"
       end
     end
-    
+
     alias_method :reload, :load
-    
+
     #
     # Load from a given directory
     #
@@ -100,7 +100,7 @@ module Moonrope
         false
       end
     end
-    
+
     #
     # Add a dirctory to the directories to load
     #
@@ -112,7 +112,7 @@ module Moonrope
         false
       end
     end
-    
+
     #
     # Return a structure of the given name
     #
@@ -122,9 +122,9 @@ module Moonrope
     def structure(name)
       structures.select { |s| s.name == name }.first
     end
-    
+
     alias_method :[], :structure
-    
+
     #
     # Return a controller of the given name
     #
@@ -134,9 +134,9 @@ module Moonrope
     def controller(name)
       controllers.select { |a| a.name == name }.first
     end
-    
+
     alias_method :/, :controller
-    
+
     #
     # Create a new rack request for this API.
     #
@@ -145,7 +145,7 @@ module Moonrope
     def request(*args)
       Moonrope::Request.new(self, *args)
     end
-    
+
     #
     # Return a helper for the given name and, potentially controller
     #
@@ -162,7 +162,7 @@ module Moonrope
       end
       matched_helpers.first
     end
-    
+
     #
     # Return all the external errors which are registered for this base
     #
@@ -171,15 +171,15 @@ module Moonrope
     def external_errors
       @external_errors ||= {}
     end
-    
+
     #
     # Register a new external error
     #
-    # @param error_class [Class] a class which should be caught 
+    # @param error_class [Class] a class which should be caught
     #
     def register_external_error(error_class, &block)
       self.external_errors[error_class] = block
     end
-    
+
   end
 end

data/lib/moonrope/before_action.rb

@@ -1,15 +1,15 @@
 module Moonrope
   class BeforeAction
-    
+
     # @return [Array] the names of actions to execute this request on
     attr_accessor :actions
-    
+
     # @return [Proc] the block to execute in this action
     attr_accessor :block
-    
+
     # @return [Moonrope::Controller] the associated controller
     attr_reader :controller
-    
+
     #
     # Initilize a new BeforeAction
     #
@@ -19,6 +19,6 @@ module Moonrope
       @controller = controller
       @actions = []
     end
-    
+
   end
 end

data/lib/moonrope/controller.rb

@@ -1,9 +1,9 @@
 module Moonrope
   class Controller
-    
+
     attr_accessor :name, :actions, :access, :befores
     attr_reader :base, :dsl
-    
+
     #
     # Initalize a new Moonrope::Controller
     #
@@ -20,7 +20,7 @@ module Moonrope
       @dsl = Moonrope::DSL::ControllerDSL.new(self)
       @dsl.instance_eval(&block) if block_given?
     end
-    
+
     #
     # Return an array of before actions which must be executed for
     # the given action.
@@ -33,7 +33,7 @@ module Moonrope
         b.actions.empty? || b.actions.include?(action)
       end
     end
-    
+
     #
     # Lookup and return an action in this controller by name.
     #
@@ -43,8 +43,8 @@ module Moonrope
     def action(action)
       actions[action.to_sym]
     end
-    
+
     alias_method :/, :action
-    
+
   end
 end

data/lib/moonrope/dsl/action_dsl.rb

@@ -1,8 +1,8 @@
 module Moonrope
   module DSL
     class ActionDSL
-      
-      # 
+
+      #
       # Initialize a new ActionDSL
       #
       # @param action [Moonrope::Action]
@@ -10,8 +10,8 @@ module Moonrope
       def initialize(action)
         @action = action
       end
-      
-      # 
+
+      #
       # Set the description for the action
       #
       #   description "Returns all users which are configured"
@@ -22,21 +22,26 @@ module Moonrope
       def description(value)
         @action.description = value
       end
-      
+
       #
       # Add a new param to the action's param set.
       #
       #   param :page, "The page number", :default => 2
       #
       # @param name [Symbol] the name of the param
-      # @param description [String] a description of the action
-      # @param options [Hash] a hash of additional options
+      # @param description_or_options [String/Hash] a description of the action or options
+      # @param options_if_description [Hash] a hash of additional options if a description was provided
       # @return [void]
       #
-      def param(name, description, options = {})
-        @action.params[name] = options.merge(:description => description)
+      def param(name, description_or_options = {}, options_if_description = {})
+        if description_or_options.is_a?(String)
+          options = options_if_description.merge(:description => description_or_options)
+        else
+          options = description_or_options
+        end
+        @action.params[name] = options
       end
-      
+
       #
       # Set the access condition for the action.
       #
@@ -50,7 +55,7 @@ module Moonrope
       def access(value = nil, &block)
         @action.access = block_given? ? block : value
       end
-    
+
       #
       # Set the action to execute when this action is invoked.
       #
@@ -60,11 +65,11 @@ module Moonrope
       #
       # @yield the contents of the yield will be saved as the action
       # @return [void]
-      # 
+      #
       def action(&block)
         @action.action = block
       end
-    
+
     end
   end
 end

data/lib/moonrope/dsl/base_dsl.rb

@@ -1,7 +1,7 @@
 module Moonrope
   module DSL
     class BaseDSL
-      
+
       #
       # Initiaize a new BaseDSL
       #
@@ -10,7 +10,7 @@ module Moonrope
       def initialize(base)
         @base = base
       end
-    
+
       #
       # Define a new structure
       #
@@ -27,7 +27,7 @@ module Moonrope
         structure.dsl.instance_eval(&block) if block_given?
         structure
       end
-    
+
       #
       # Define a new controller or append values to an existing
       # controller if it has already been defined.
@@ -46,7 +46,7 @@ module Moonrope
         controller.dsl.instance_eval(&block) if block_given?
         controller
       end
-    
+
       #
       # Set the authenticator for the API.
       #
@@ -55,7 +55,7 @@ module Moonrope
       def authenticator(&block)
         @base.authenticator = block
       end
-      
+
       #
       # Set the default access check block.
       #
@@ -64,7 +64,7 @@ module Moonrope
       def default_access(value = nil, &block)
         @base.default_access = block_given? ? block : value
       end
-      
+
       #
       # Define a new helper in the global namespace
       #
@@ -80,7 +80,7 @@ module Moonrope
         @base.helpers << helper_instance
         helper_instance
       end
-      
+
     end
   end
 end

data/lib/moonrope/dsl/controller_dsl.rb

@@ -1,7 +1,7 @@
 module Moonrope
   module DSL
     class ControllerDSL
-      
+
       #
       # Initialize a new ControllerDSL
       #
@@ -10,10 +10,10 @@ module Moonrope
       def initialize(controller)
         @controller = controller
       end
-      
+
       # @return [Moonrope::Controller] the associated controller
       attr_reader :controller
-      
+
       #
       # Defines a new action within the controller.
       #
@@ -27,12 +27,12 @@ module Moonrope
         @controller.actions[name] = action
         action
       end
-      
+
       #
       # Defines a new before action within the controller.
       #
       # @param actions [Symbol] the names of the actions to apply to (none for all)
-      # @yield stores the block as the block to be executed 
+      # @yield stores the block as the block to be executed
       # @return [Moonrope::BeforeAction]
       #
       def before(*actions, &block)
@@ -42,7 +42,7 @@ module Moonrope
         @controller.befores << before_action
         before_action
       end
-      
+
       #
       # Defines the access required for controller methods which do not
       # define their own access.
@@ -50,7 +50,7 @@ module Moonrope
       def access(value = nil, &block)
         @controller.access = block_given? ? block : value
       end
-      
+
       #
       # Defines a new helper for this controller.
       #
@@ -61,7 +61,7 @@ module Moonrope
         if @controller.base.helper(name, @controller)
           raise Moonrope::Errors::HelperAlreadyDefined, "Helper has already been defined with name `#{name}`"
         end
-        
+
         @controller.base.helpers << Moonrope::Helper.new(name, @controller, options, &block)
       end
     end