moonrope 1.2.5 → 1.3.0

data/lib/moonrope/request.rb

@@ -1,15 +1,15 @@
 module Moonrope
   class Request
-        
+
     class << self
       attr_accessor :path_regex
-      
+
       # @return [Regex] the regex which should be matched for all API requests
       def path_regex
         @path_regex ||= /\A\/api\/([\w\/\-\.]+)?/
       end
     end
-    
+
     # @return [Hash] the rack environment
     attr_reader :env
     # @return [String] the name of the controller which was requested
@@ -18,7 +18,7 @@ module Moonrope
     attr_reader :action_name
     # @return [Object] the authenticated user
     attr_reader :authenticated_user
-    
+
     #
     # Initialize a new Moonrope::Request
     #
@@ -34,7 +34,7 @@ module Moonrope
       end
       @version, @controller_name, @action_name = path ? path.split("/") : [nil, nil, nil]
     end
-    
+
     #
     # Return the requested API version from the request
     #
@@ -45,7 +45,7 @@ module Moonrope
       version = 1 if version == 0
       version
     end
-    
+
     #
     # Return whether or not this request is valid and can continue?
     #
@@ -54,16 +54,16 @@ module Moonrope
     def valid?
       !!(version > 0 && [controller_name, action_name].all? { |c| c =~ /\A[\w\-\.]+\z/} && controller && action)
     end
-    
+
     #
     # Return the controller object for the request
-    # 
+    #
     # @return [Moonrope::Controller]
     #
     def controller
       @controller ||= @base.controller(controller_name.to_sym)
     end
-    
+
     #
     # Return the action object for the request
     #
@@ -72,7 +72,7 @@ module Moonrope
     def action
       @action ||= controller.actions[action_name.to_sym]
     end
-    
+
     #
     # Execute the appropriate action for the request after running
     # the various authentication checks.
@@ -84,7 +84,7 @@ module Moonrope
       if @base.authenticator
         result = action.convert_errors_to_action_result do
           @authenticated_user = eval_env.instance_eval(&@base.authenticator)
-          # If we are authenticated, check whether the action permits access to 
+          # If we are authenticated, check whether the action permits access to
           # this user, if not raise an error.
           if authenticated?
             unless action.check_access(eval_env) == true
@@ -92,7 +92,7 @@ module Moonrope
             end
           end
         end
-        
+
         if result.is_a?(Moonrope::ActionResult)
           # If we already have a result, we should return it and no longer execute
           # this request.
@@ -101,7 +101,7 @@ module Moonrope
       end
       action.execute(eval_env)
     end
-    
+
     #
     # Return all user supplier parameters
     #
@@ -110,7 +110,7 @@ module Moonrope
     def params
       @params ||= Moonrope::ParamSet.new(rack_request.params['params'])
     end
-    
+
     #
     # Return all HTTP headers from the request
     #
@@ -119,7 +119,7 @@ module Moonrope
     def headers
       @headers ||= self.class.extract_http_request_headers(@env)
     end
-    
+
     #
     # Is this request to the API anonymous?
     #
@@ -128,7 +128,7 @@ module Moonrope
     def anonymous?
       authenticated_user.nil?
     end
-    
+
     #
     # Is this request to the API authenticated?
     #
@@ -137,9 +137,9 @@ module Moonrope
     def authenticated?
       !(authenticated_user.nil? || authenticated_user == false)
     end
-    
+
     private
-    
+
     #
     # Return/create a rack request object for use internally
     #
@@ -148,7 +148,7 @@ module Moonrope
     def rack_request
       @rack_request ||= ::Rack::Request.new(@env)
     end
-    
+
     #
     # Extract headers from the rack env
     #
@@ -165,6 +165,6 @@ module Moonrope
         hash
       end
     end
-    
+
   end
 end

data/lib/moonrope/structure.rb

@@ -1,27 +1,27 @@
 module Moonrope
   class Structure
-    
+
     # @return [Symbol] the name of the structure
     attr_accessor :name
-    
+
     # @return [Proc] the basic data block
     attr_accessor :basic
-    
+
     # @return [Proc] the full data block
     attr_accessor :full
-    
+
     # @return [Moonrope::DSL::StructureDSL] the DSL
     attr_reader :dsl
-    
+
     # @return [Hash] all expansions for the structure
     attr_reader :expansions
-    
+
     # @return [Moonrope::Base] the base API
     attr_reader :base
-    
+
     # @return [Hash] attributes which should be included in this structure
     attr_reader :attributes
-    
+
     #
     # Initialize a new structure
     #
@@ -36,7 +36,7 @@ module Moonrope
       @dsl = Moonrope::DSL::StructureDSL.new(self)
       @dsl.instance_eval(&block) if block_given?
     end
-    
+
     #
     # Return a hash for this struture
     #
@@ -47,52 +47,52 @@ module Moonrope
     def hash(object, options = {})
       # Set up an environment
       environment = EvalEnvironment.new(base, options[:request], :o => object)
-      
+
       # Set a new hash
       hash = Hash.new
-      
+
       # Add the 'basic' structured fields
       DeepMerge.deep_merge! hash_for_attributes(@attributes[:basic], object, environment), hash
-      
+
       # Always get a basic hash to work from
       if self.basic.is_a?(Proc)
         DeepMerge.deep_merge! environment.instance_eval(&self.basic), hash
       end
-      
+
       # Enhance with the full hash if requested
       if options[:full]
-        
+
         # Add the 'full' structured fields
         DeepMerge.deep_merge! hash_for_attributes(@attributes[:full], object, environment), hash
-        
+
         if self.full.is_a?(Proc)
           full_hash = environment.instance_eval(&self.full)
           DeepMerge.deep_merge! full_hash,hash
         end
       end
-      
+
       # Add expansions
-      if options[:expansions]        
-        
+      if options[:expansions]
+
         # Add structured expansions
         @attributes[:expansion].each do |attribute|
           next if options[:expansions].is_a?(Array) && !options[:expansions].include?(attribute.name.to_sym)
           DeepMerge.deep_merge! hash_for_attributes([attribute], object, environment), hash
         end
-        
+
         # Add the expansions
         expansions.each do |name, expansion|
           next if options[:expansions].is_a?(Array) && !options[:expansions].include?(name.to_sym)
           DeepMerge.deep_merge!({name.to_sym => environment.instance_eval(&expansion)}, hash)
         end
       end
-      
+
       # Return the hash
       hash
     end
-    
+
     private
-    
+
     #
     # Return a returnable hash for a given set of structured fields.
     #
@@ -100,7 +100,7 @@ module Moonrope
       return {} unless attributes.is_a?(Array)
       Hash.new.tap do |hash|
         attributes.each do |attribute|
-          
+
           unless attribute.conditions.empty?
             matched = false
             attribute.conditions.each do |condition|
@@ -115,7 +115,7 @@ module Moonrope
               next
             end
           end
-          
+
           if attribute.value.is_a?(Proc)
             value = environment.instance_eval(&attribute.value)
           elsif attribute.value
@@ -123,7 +123,7 @@ module Moonrope
           else
             value = value_for_attribute(object, environment, attribute)
           end
-          
+
           if attribute.groups.empty?
             hash[attribute.name] = value
           else
@@ -136,11 +136,11 @@ module Moonrope
               last_hash = last_hash[group]
             end
           end
-          
+
         end
       end
     end
-    
+
     #
     # Return a value for a structured field.
     #
@@ -164,6 +164,6 @@ module Moonrope
         value
       end
     end
-    
+
   end
 end

data/lib/moonrope/structure_attribute.rb

@@ -1,6 +1,6 @@
 module Moonrope
   class StructureAttribute
-    
+
     attr_accessor :name
     attr_accessor :groups
     attr_accessor :conditions
@@ -11,18 +11,17 @@ module Moonrope
     attr_accessor :structure_opts
     attr_accessor :value
     attr_accessor :example
-    
-    def initialize(type, name, description)
+
+    def initialize(type, name)
       @type = type
       @name = name
-      @description = description
       @groups = []
       @conditions = []
     end
-    
+
     def source_attribute
       @source_attribute || @name
     end
-    
+
   end
 end

data/lib/moonrope/version.rb

@@ -1,3 +1,3 @@
 module Moonrope
-  VERSION = '1.2.5'
-end
+  VERSION = '1.3.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moonrope
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.3.0
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-06 00:00:00.000000000 Z
+date: 2014-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json