moonrope 1.2.5 → 1.3.0

data/lib/moonrope/dsl/structure_dsl.rb

@@ -1,19 +1,19 @@
 module Moonrope
   module DSL
     class StructureDSL
-      
+
       # @return [Moonrope::Structure] the associated structure
       attr_reader :structure
-      
+
       # @return [Array] groups which should applied
       attr_accessor :groups
-      
+
       # @return [Array] conditions which should applied
       attr_accessor :conditions
-      
+
       # @return [Hash] options
       attr_accessor :options
-      
+
       #
       # Initialize a new StructureDSL
       #
@@ -25,27 +25,36 @@ module Moonrope
         @groups = []
         @conditions = []
       end
-      
+
       def scope(options = {}, &block)
         scope_dsl = self.class.new(@structure)
         scope_dsl.options = options
         scope_dsl.instance_eval(&block)
       end
-      
+
       def group(name, &block)
         scope_dsl = self.class.new(@structure)
         scope_dsl.groups = [@groups, name].flatten
         scope_dsl.instance_eval(&block)
       end
-      
+
       def condition(condition, &block)
         scope_dsl = self.class.new(@structure)
         scope_dsl.conditions = [@conditions, condition].flatten
         scope_dsl.instance_eval(&block)
       end
-      
-      def attribute(type, name, description, options = {})
-        attribute                   = StructureAttribute.new(type, name, description)
+
+      def attribute(type, name, options_or_description = {}, options_if_description = {})
+
+        if options_or_description.is_a?(String)
+          options_if_description[:description] = options_or_description
+          options = options_if_description
+        else
+          options = options_or_description
+        end
+
+        attribute                   = StructureAttribute.new(type, name)
+        attribute.description       = options[:description]
         attribute.structure         = options[:structure]
         attribute.structure_opts    = options[:structure_opts]
         attribute.value_type        = options[:type]
@@ -56,7 +65,7 @@ module Moonrope
         attribute.conditions        = @conditions
         @structure.attributes[type] << attribute
       end
-      
+
       def basic(*args, &block)
         if block_given?
           @structure.basic = block
@@ -72,7 +81,7 @@ module Moonrope
           attribute(:full, *args)
         end
       end
-      
+
       def expansion(name, *args, &block)
         if block_given?
           @structure.expansions[name] = block
@@ -80,7 +89,7 @@ module Moonrope
           attribute(:expansion, name, *args)
         end
       end
-    
+
     end
   end
 end

data/lib/moonrope/errors.rb

@@ -1,54 +1,54 @@
 module Moonrope
   module Errors
-    
+
     class Error < StandardError
     end
-    
+
     class HelperAlreadyDefined < Error; end
-    
+
     class RequestError < Error
       attr_reader :options
-      
+
       def initialize(options)
         @options = options
       end
-      
+
       def status
         @options.is_a?(Hash) ? @options[:status] || 'error'  : 'error'
       end
-      
+
       def data
         {:message => @options}
       end
     end
-    
+
     class AccessDenied < RequestError
       def status
         'access-denied'
       end
     end
-    
+
     class NotFound < RequestError
       def status
         'not-found'
       end
     end
-    
+
     class ValidationError < RequestError
       def status
         'validation-error'
       end
-      
+
       def data
         {:errors => @options}
       end
     end
-    
+
     class ParameterError < RequestError
       def status
         'parameter-error'
       end
     end
-    
+
   end
 end

data/lib/moonrope/eval_environment.rb

@@ -1,26 +1,26 @@
 module Moonrope
   class EvalEnvironment
-    
+
     include Moonrope::EvalHelpers
-    
+
     # @return [Moonrope::Base] the base object
     attr_reader :base
-    
+
     # @return [Moonrope::Request] the associated request
     attr_reader :request
-    
+
     # @return [Hash] the headers
     attr_reader :headers
-    
+
     # @return [Hash] the flags
     attr_reader :flags
-    
+
     # @return [Hash] the default params to be merged with request params
     attr_accessor :default_params
-    
+
     # @return [Moonrope::Action] the action which invoked this environment
     attr_accessor :action
-    
+
     #
     # Initialize a new EvalEnvironment
     #
@@ -35,21 +35,21 @@ module Moonrope
       @default_params = {}
       reset
     end
-    
+
     #
     # @return [Integer] the requested API version
     #
     def version
       request ? request.version : 1
     end
-    
+
     #
     # @return [Object] the authenticated object
     #
     def auth
       request ? request.authenticated_user : nil
     end
-    
+
     #
     # @return [Hash] all parameters sent for this request including defaults
     #
@@ -60,7 +60,7 @@ module Moonrope
         params
       end
     end
-    
+
     #
     # Set a header which should be returned to the client.
     #
@@ -71,7 +71,7 @@ module Moonrope
     def set_header(name, value)
       @headers[name.to_s] = value
     end
-    
+
     #
     # Set a flag which should be returned to the client.
     #
@@ -82,17 +82,17 @@ module Moonrope
     def set_flag(name, value)
       @flags[name] = value
     end
-    
-    # 
+
+    #
     # Clear all flags & headers from this environment.
-    # 
+    #
     # @return [void]
     #
     def reset
       @flags = {}
       @headers = {}
     end
-    
+
     #
     # Attempts to find an return an accessor from the has
     #
@@ -109,10 +109,10 @@ module Moonrope
         super
       end
     end
-    
+
     #
     # Generate a new structure from the core DSL for the given
-    # object and return a hash or nil if the structure doesn't 
+    # object and return a hash or nil if the structure doesn't
     # exist.
     #
     # @param structure_name [Moonrope::Structure or Symbol] the structure to be used
@@ -131,7 +131,7 @@ module Moonrope
         nil
       end
     end
-    
+
     #
     # Return a Moonrope::Structure object for the provided name
     #
@@ -145,7 +145,7 @@ module Moonrope
         false
       end
     end
-    
+
     #
     # Return whether or not a given structure name is valid?
     #
@@ -154,6 +154,6 @@ module Moonrope
     def has_structure_for?(structure_name)
       self.structure_for(structure_name).is_a?(Moonrope::Structure)
     end
-    
+
   end
 end

data/lib/moonrope/eval_helpers.rb

@@ -1,6 +1,6 @@
 module Moonrope
   module EvalHelpers
-    
+
     #
     # Raise an error.
     #
@@ -17,7 +17,7 @@ module Moonrope
         raise Moonrope::Errors::RequestError, message
       end
     end
-    
+
     #
     # Return paginated information
     #
@@ -30,6 +30,6 @@ module Moonrope
         block.call(result)
       end
     end
-    
+
   end
 end

data/lib/moonrope/helper.rb

@@ -1,6 +1,6 @@
 module Moonrope
   class Helper
-    
+
     # @return [Symbol] the name of the helper
     attr_reader :name
 
@@ -9,10 +9,10 @@ module Moonrope
 
     # @return [Proc] the proc to execute
     attr_reader :block
-    
+
     # @return [Hash] options for this helper
     attr_reader :options
-    
+
     #
     # Initialize a new helper
     #
@@ -26,6 +26,6 @@ module Moonrope
       @options = options
       @block = block
     end
-    
+
   end
 end

data/lib/moonrope/param_set.rb

@@ -1,6 +1,6 @@
 module Moonrope
   class ParamSet
-    
+
     #
     # Initialize a new ParamSet
     #
@@ -12,7 +12,7 @@ module Moonrope
     end
 
     #
-    # Return the value for the given key 
+    # Return the value for the given key
     #
     # @param key [String] the key to lookup
     # @return [Object] the value
@@ -25,10 +25,10 @@ module Moonrope
       # Return the value
       value
     end
-    
+
     alias_method :[], :_value_for
     alias_method :method_missing, :_value_for
-    
+
     #
     # Set the defaults for the param set
     #
@@ -39,7 +39,7 @@ module Moonrope
         @defaults = defaults
       end
     end
-    
+
     #
     # Does the specified key exist?
     #
@@ -49,6 +49,6 @@ module Moonrope
     def has?(key)
       @params.keys.include?(key.to_s) || @defaults.keys.include?(key.to_s)
     end
-    
+
   end
 end

data/lib/moonrope/rack_middleware.rb

@@ -1,22 +1,22 @@
 module Moonrope
   class RackMiddleware
-    
+
     #
     # Initialize a new Moonrope::Rack server
     #
     # @param app [Object] the next Rack application in the stack
     # @param base [Moonrope::Base] the base API to serve
     # @param options [Hash] a hash of options
-    # 
+    #
     #
     def initialize(app, base, options = {})
       @app = app
       @base = base
       @options = options
     end
-    
+
     attr_reader :base
-    
+
     #
     # Make a new request
     #
@@ -25,23 +25,23 @@ module Moonrope
     #
     def call(env)
       if env['PATH_INFO'] =~ Moonrope::Request.path_regex
-        
+
         if @options[:reload_on_each_request]
           @base.load
         end
-        
+
         #
         # Call the on request block if one has been defined for the base.
         #
         if @base.on_request.is_a?(Proc)
           @base.on_request.call(@base, env)
         end
-        
+
         #
         # Create a new request object
         #
         request = @base.request(env, $1)
-        
+
         #
         # Set some global headers which are always returned
         #
@@ -52,26 +52,26 @@ module Moonrope
           global_headers['Access-Control-Allow-Headers'] = env['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']
         end
         global_headers['Access-Control-Allow-Methods'] = '*'
-        
+
         #
         # Options always returns a 200
         #
         if env['REQUEST_METHOD'] == 'OPTIONS'
           return [200, global_headers, ['OK']]
         end
-        
+
         #
         # Responses are now in JSON
         #
         global_headers['Content-Type'] = 'application/json'
-        
+
         #
         # Check the request is valid
         #
         unless request.valid?
           return [400, global_headers, [{:status => 'invalid-controller-or-action'}.to_json]]
         end
-        
+
         #
         # Execute the request
         #
@@ -86,16 +86,16 @@ module Moonrope
           Moonrope.logger.info e.class
           Moonrope.logger.info e.message
           Moonrope.logger.info e.backtrace.join("\n")
-          
+
           response = {:status => 'internal-server-error'}
-          
+
           # If in development, return more details about the exception which was raised.
           if @base.environment == 'development'
             response[:error] = e.class.to_s
             response[:message] = e.message
             response[:backtrace] = e.backtrace[0,6]
           end
-          
+
           [500, global_headers, [response.to_json]]
         end
 
@@ -107,6 +107,6 @@ module Moonrope
         end
       end
     end
-    
+
   end
 end

data/lib/moonrope/railtie.rb

@@ -1,17 +1,17 @@
 module Moonrope
   class Railtie < Rails::Railtie
-    
+
     initializer 'moonrope.initialize' do |app|
-      
+
       # Initialize a new moonrope base.
       app.config.moonrope = Moonrope::Base.load(Rails.root.join('api'))
-            
+
       # Set the logger
       Moonrope.logger = Rails.logger
-      
+
       # Set the environment to match the Rails environment
       app.config.moonrope.environment = Rails.env.to_s
-      
+
       # Ensure all request use UTC
       app.config.moonrope.on_request = Proc.new do |base, env|
         Time.zone = 'UTC'
@@ -21,14 +21,14 @@ module Moonrope
       if app.config.respond_to?(:moonrope_request_path_regex) && app.config.moonrope_request_path_regex.is_a?(Regexp)
         Moonrope::Request.path_regex = app.config.moonrope_request_path_regex
       end
-      
+
       # Catch ActiveRecord::RecordNotFound exception as a standard not-found error
       if defined?(ActiveRecord)
         app.config.moonrope.register_external_error ActiveRecord::RecordNotFound do |exception, result|
           result.status = 'not-found'
           result.data = {:message => exception.message}
         end
-        
+
         # Add a helper for auto setting parameters
         app.config.moonrope.dsl.instance_eval do
           helper :auto_set_params_for, :unloadable => false do |object|
@@ -39,7 +39,7 @@ module Moonrope
           end
         end
       end
-      
+
       # Insert the Moonrope middleware into the application's middleware
       # stack (at the bottom).
       app.middleware.use(
@@ -47,8 +47,8 @@ module Moonrope
         app.config.moonrope,
         :reload_on_each_request => !app.config.cache_classes
       )
-      
+
     end
-    
+
   end
 end