moonrope 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9692810430240c41d7a72ae72a4c9db1134359e
-  data.tar.gz: f87635e0c45475aab9be1f764af4661f736bd3a3
+  metadata.gz: aaca3dee3108ec017c94921848e0cf7bf5de4136
+  data.tar.gz: 703c784363fe0cc329931c7568c5603b1b863bef
 SHA512:
-  metadata.gz: 3d2a7fdb9279de606ea73fcb20dc6fe18bf6e2e13eb5016ee0bf6f513f3391fdc10d345eacab8b90474c249261e883af8312ea80c9004666fd092414f35f0586
-  data.tar.gz: 37b832788c055a6fc24361d9f7acae8957eed70fb392210500cfcd25f6232c97e7b259d6c2e3ea0f4776448bb5bb43ce57be4cb69a8af6bd8759cfbc86079031
+  metadata.gz: e28959e2e988a35fbb030b944dafeb086b0c973f9691cc23c2c0d23cf63fb2b3cc03b776af60c7e6022241b749ee6fb85b6f9d78fedc03c90c61bba2f4e9df53
+  data.tar.gz: e5917f0184a0113189a5291b6a91240c987dd52d9725728d57ab69e9cffaedd2f7148ce01b67a79f326c714859f3c9c1d8e2112301a6641ae1a43b46a6abefb8

data/lib/moonrope/action.rb

@@ -147,12 +147,31 @@ module Moonrope
         eval_environment = EvalEnvironment.new(@controller.base, request)
       end
       
-      if eval_environment.auth && access.is_a?(Proc)
-        !!eval_environment.instance_eval(&access)
-      elsif @controller.base.default_access.is_a?(Proc)
-        !!eval_environment.instance_exec(self, &@controller.base.default_access)
+      access_condition = self.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.
+        if access_condition.is_a?(Proc)
+          !!eval_environment.instance_exec(self, &access_condition)
+        elsif access_condition.is_a?(Symbol)
+          !!(eval_environment.auth.respond_to?(access_condition) && eval_environment.auth.send(access_condition))
+        elsif access_condition.is_a?(Hash) && access_condition[:must_be] && access_condition[:with]
+          !!(eval_environment.auth.is_a?(access_condition[:must_be]) &&
+              eval_environment.auth.respond_to?(access_condition[:with]) &&
+              eval_environment.auth.send(access_condition[:with])
+            )
+        elsif access_condition.is_a?(Hash) && access_condition[:must_be]
+          !!(eval_environment.auth.is_a?(access_condition[:must_be]))
+        elsif access_condition == true
+          true
+        else
+          false
+        end
       else
-        false
+        # No authentication object is available to test with. The result here
+        # depends on whether or not an access condition has been defined or not.
+        !access_condition
       end
     end
     

data/lib/moonrope/dsl/structure_dsl.rb

@@ -2,6 +2,18 @@ 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
       #
@@ -9,53 +21,62 @@ module Moonrope
       #
       def initialize(structure)
         @structure = structure
+        @options = {}
+        @groups = []
+        @conditions = []
       end
       
-      # @return [Moonrope::Structure] the associated structure
-      attr_reader :structure
-    
-      #
-      # Set the basic variables for the structure.
-      #
-      # @yield stores the contents of the block for the basic data
-      # @return [void]
-      #
-      def basic(&block)
-        structure.basic = block
+      def scope(options = {}, &block)
+        scope_dsl = self.class.new(@structure)
+        scope_dsl.options = options
+        scope_dsl.instance_eval(&block)
       end
-
-      #
-      # Set the full variables for the structure.
-      #
-      # @yield stores the contents of the block for the full data
-      # @return [void]
-      #
-      def full(&block)
-        structure.full = block
+      
+      def group(name, &block)
+        scope_dsl = self.class.new(@structure)
+        scope_dsl.groups = [@groups, name].flatten
+        scope_dsl.instance_eval(&block)
       end
-    
-      #
-      # Add a new expansion.
-      #
-      # @param name [Symbol] the name of the expansion
-      # @yield sets the block to execute for the expansion if requested
-      # @return [void]
-      #
-      def expansion(name, &block)
-        structure.expansions[name] = block
+      
+      def condition(condition, &block)
+        scope_dsl = self.class.new(@structure)
+        scope_dsl.conditions = [@conditions, condition].flatten
+        scope_dsl.instance_eval(&block)
       end
-    
-      #
-      # Add a new restricted block.
-      #
-      # @yield instance evals the block within RestrictionDSL
-      # @return [Moonrope::DSL::RestrictionDSL]
-      #
-      def restricted(&block)
-        dsl = Moonrope::DSL::StructureRestrictionDSL.new
-        dsl.instance_eval(&block)
-        structure.restrictions << dsl
-        dsl
+      
+      def attribute(type, name, description, options = {})
+        attribute                   = StructureAttribute.new(type, name, description)
+        attribute.structure         = options[:structure]
+        attribute.structure_opts    = options[:structure_opts]
+        attribute.value_type        = options[:type]
+        attribute.source_attribute  = options[:source] || options[:name]
+        attribute.groups            = @groups
+        attribute.conditions        = @conditions
+        @structure.attributes[type] << attribute
+      end
+      
+      def basic(*args, &block)
+        if block_given?
+          @structure.basic = block
+        else
+          attribute(:basic, *args)
+        end
+      end
+
+      def full(*args, &block)
+        if block_given?
+          @structure.full = block
+        else
+          attribute(:full, *args)
+        end
+      end
+      
+      def expansion(name, *args, &block)
+        if block_given?
+          @structure.expansions[name] = block
+        else
+          attribute(:expansion, name, *args)
+        end
       end
     
     end

data/lib/moonrope/structure.rb

@@ -16,12 +16,12 @@ module Moonrope
     # @return [Hash] all expansions for the structure
     attr_reader :expansions
     
-    # @return [Array] all restrictions for the structure
-    attr_reader :restrictions
-    
     # @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
     #
@@ -32,7 +32,7 @@ module Moonrope
       @base = base
       @name = name
       @expansions = {}
-      @restrictions = []
+      @attributes = {:basic => [], :full => [], :expansion => []}
       @dsl = Moonrope::DSL::StructureDSL.new(self)
       @dsl.instance_eval(&block) if block_given?
     end
@@ -45,33 +45,45 @@ module Moonrope
     # @return [Hash]
     #
     def hash(object, options = {})
-      # Set up an environment for 
+      # Set up an environment
       environment = EvalEnvironment.new(base, options[:request], :o => object)
-
+      
+      # Set a new hash
+      hash = Hash.new
+      
+      # Add the 'basic' structured fields
+      hash.deep_merge! hash_for_attributes(@attributes[:basic], object, environment)
+      
       # Always get a basic hash to work from
-      hash = environment.instance_eval(&self.basic)
+      if self.basic.is_a?(Proc)
+        hash.deep_merge! environment.instance_eval(&self.basic)
+      end
       
       # Enhance with the full hash if requested
       if options[:full]
+        
+        # Add the 'full' structured fields
+        hash.deep_merge! hash_for_attributes(@attributes[:full], object, environment)
+        
         if self.full.is_a?(Proc)
           full_hash = environment.instance_eval(&self.full)
-          hash.merge!(full_hash)
-        end
-        
-        # Add restrictions
-        if environment.auth
-          @restrictions.each do |restriction|
-            next unless environment.instance_eval(&restriction.condition) == true
-            hash.merge!(environment.instance_eval(&restriction.data))
-          end
+          hash.deep_merge! full_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?(name.to_sym)
+          hash.deep_merge!(hash_for_attributes([attribute], object, environment))
+        end
+        
+        # Add the expansions
         expansions.each do |name, expansion|
           next if options[:expansions].is_a?(Array) && !options[:expansions].include?(name.to_sym)
-          hash.merge!(name => environment.instance_eval(&expansion))
+          hash.deep_merge!(name.to_sym => environment.instance_eval(&expansion))
         end
       end
       
@@ -79,5 +91,73 @@ module Moonrope
       hash
     end
     
+    private
+    
+    #
+    # Return a returnable hash for a given set of structured fields.
+    #
+    def hash_for_attributes(attributes, object, environment)
+      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|
+              if !environment.instance_eval(&condition)
+                matched = true
+                break
+              end
+            end
+            if matched
+              # Skip this item because a condition didn't evaluate
+              # to true.
+              next
+            end
+          end
+          
+          value = value_for_attribute(object, environment, attribute)
+          
+          if attribute.groups.empty?
+            hash[attribute.name] = value
+          else
+            last_hash = hash
+            attribute.groups.each_with_index do |group, index|
+              last_hash[group] ||= {}
+              if index == attribute.groups.size - 1
+                last_hash[group][attribute.name] = value
+              end
+              last_hash = last_hash[group]
+            end
+          end
+          
+        end
+      end
+    end
+    
+    #
+    # Return a value for a structured field.
+    #
+    def value_for_attribute(object, environment,  attribute)
+      value = object.send(attribute.source_attribute)
+      if attribute.structure
+        # If a structure is required, lookup the desired structure and set the
+        # hash value as appropriate.
+        if structure = self.base.structure(attribute.structure)
+          structure_opts = attribute.structure_opts || {}
+          if value.is_a?(Array)
+            value.map do |v|
+              structure.hash(v, structure_opts.merge(:request => environment.request))
+            end
+          else
+            structure.hash(value, structure_opts.merge(:request => environment.request))
+          end
+        end
+      else
+        # Return the value as normal for non-structure values.
+        value
+      end
+    end
+    
   end
 end

data/lib/moonrope/structure_attribute.rb

@@ -0,0 +1,26 @@
+module Moonrope
+  class StructureAttribute
+    
+    attr_accessor :name
+    attr_accessor :groups
+    attr_accessor :conditions
+    attr_accessor :source_attribute
+    attr_accessor :description
+    attr_accessor :value_type
+    attr_accessor :structure
+    attr_accessor :structure_opts
+    
+    def initialize(type, name, description)
+      @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.1.4'
+  VERSION = '1.2.0'
 end

data/lib/moonrope.rb

@@ -1,5 +1,6 @@
 require 'json'
 require 'logger'
+require 'deep_merge'
 
 require 'moonrope/action'
 require 'moonrope/action_result'
@@ -10,7 +11,6 @@ require 'moonrope/dsl/base_dsl'
 require 'moonrope/dsl/action_dsl'
 require 'moonrope/dsl/controller_dsl'
 require 'moonrope/dsl/structure_dsl'
-require 'moonrope/dsl/structure_restriction_dsl'
 
 require 'moonrope/errors'
 require 'moonrope/eval_helpers'
@@ -20,6 +20,7 @@ require 'moonrope/param_set'
 require 'moonrope/rack_middleware'
 require 'moonrope/request'
 require 'moonrope/structure'
+require 'moonrope/structure_attribute'
 require 'moonrope/version'
 
 require 'moonrope/railtie' if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moonrope
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -113,7 +127,6 @@ files:
 - lib/moonrope/dsl/base_dsl.rb
 - lib/moonrope/dsl/controller_dsl.rb
 - lib/moonrope/dsl/structure_dsl.rb
-- lib/moonrope/dsl/structure_restriction_dsl.rb
 - lib/moonrope/errors.rb
 - lib/moonrope/eval_environment.rb
 - lib/moonrope/eval_helpers.rb
@@ -123,6 +136,7 @@ files:
 - lib/moonrope/railtie.rb
 - lib/moonrope/request.rb
 - lib/moonrope/structure.rb
+- lib/moonrope/structure_attribute.rb
 - lib/moonrope/version.rb
 homepage: http://adamcooke.io
 licenses:

data/lib/moonrope/dsl/structure_restriction_dsl.rb

@@ -1,27 +0,0 @@
-module Moonrope
-  module DSL
-    class StructureRestrictionDSL
-      
-      #
-      # Set or get the data block for the restriction
-      #
-      # @yield stores the contents of the block as the data
-      # @return [Proc]
-      #
-      def data(&block)
-        block_given? ? @data = block : @data
-      end
-
-      #
-      # Set or get the condition block for the restriction
-      #
-      # @yield stores the contents of the block as the condition
-      # @return [Proc]
-      #
-      def condition(&block)
-        block_given? ? @condition = block : @condition
-      end
-      
-    end
-  end
-end