moonrope 1.4.1 → 2.0.0

data/lib/moonrope/structure.rb

@@ -1,3 +1,5 @@
+require 'moonrope/dsl/structure_dsl'
+
 module Moonrope
   class Structure
 
@@ -22,6 +24,9 @@ module Moonrope
     # @return [Hash] attributes which should be included in this structure
     attr_reader :attributes
 
+    # @return [Bool] should this structure be documented
+    attr_accessor :doc
+
     #
     # Initialize a new structure
     #
@@ -37,6 +42,15 @@ module Moonrope
       @dsl.instance_eval(&block) if block_given?
     end
 
+    #
+    # Return details for the given attribute
+    #
+    def attribute(name)
+      @attributes[:basic].select { |p| p.name == name }.first ||
+      @attributes[:full].select { |p| p.name == name }.first ||
+      @attributes[:expansion].select { |p| p.name == name }.first
+    end
+
     #
     # Return a hash for this struture
     #
@@ -46,7 +60,7 @@ module Moonrope
     #
     def hash(object, options = {})
       # Set up an environment
-      environment = EvalEnvironment.new(base, options[:request], :o => object)
+      environment = EvalEnvironment.new(base, options[:request], options[:request] ? options[:request].action : nil, :o => object)
 
       # Set a new hash
       hash = Hash.new
@@ -83,7 +97,7 @@ module Moonrope
         # Add the expansions
         expansions.each do |name, expansion|
           next if options[:expansions].is_a?(Array) && !options[:expansions].include?(name.to_sym)
-          next unless expansion[:conditions].all? { |condition| environment.instance_eval(&condition) }
+          next unless check_conditions(environment, expansion[:conditions])
           DeepMerge.deep_merge!({name.to_sym => environment.instance_eval(&expansion[:block])}, hash)
         end
       end
@@ -92,8 +106,59 @@ module Moonrope
       hash
     end
 
+    #
+    # Return an array of all expansions which are available on this structure
+    #
+    def all_expansions
+      @attributes[:expansion].map(&:name) + expansions.keys
+    end
+
+    #
+    # Return the description for a given condition hash
+    #
+    def description_for_condition(condition)
+      if condition[:authenticator] && condition[:access_rule]
+        if authenticator = base.authenticators[condition[:authenticator]]
+          if access_rule = authenticator.rules[condition[:access_rule]]
+            access_rule[:description]
+          end
+        end
+      else
+        condition[:description]
+      end
+    end
+
     private
 
+    #
+    # Call all conditions provided and return whether they pass or not
+    #
+    def check_conditions(environment, conditions)
+      conditions.each do |condition|
+        if condition[:block]
+          unless environment.instance_eval(&condition[:block])
+            return false
+          end
+        elsif condition[:authenticator] && condition[:access_rule]
+          if authenticator = base.authenticators[condition[:authenticator]]
+            if access_rule = authenticator.rules[condition[:access_rule]]
+              # If we have an authenticator and access rule, use the access rule
+              # block with this environment to determine if we should include the
+              # given block or not.
+              unless environment.instance_exec(self, &access_rule[:block])
+                return false
+              end
+            else
+              raise Moonrope::Errors::MissingAccessRule, "The rule '#{condition[:access_rule]}' was not found on '#{authenticator.name}' authenticator"
+            end
+          else
+            raise Moonrope::Errors::MissingAuthenticator, "The authentication '#{condition[:authenticator]}' was not found"
+          end
+        end
+      end
+      true
+    end
+
     #
     # Return a returnable hash for a given set of structured fields.
     #
@@ -103,14 +168,7 @@ module Moonrope
         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
+            unless check_conditions(environment, attribute.conditions)
               # Skip this item because a condition didn't evaluate
               # to true.
               next
@@ -146,7 +204,12 @@ module Moonrope
     # Return a value for a structured field.
     #
     def value_for_attribute(object, environment,  attribute)
-      value = object.send(attribute.source_attribute)
+      if attribute.source_attribute.is_a?(Proc)
+        value = environment.instance_eval(&attribute.source_attribute)
+      else
+        value = object.send(attribute.source_attribute)
+      end
+
       if value && attribute.structure
         # If a structure is required, lookup the desired structure and set the
         # hash value as appropriate.

data/lib/moonrope/structure_attribute.rb

@@ -11,6 +11,7 @@ module Moonrope
     attr_accessor :structure_opts
     attr_accessor :value
     attr_accessor :example
+    attr_accessor :doc
 
     def initialize(type, name)
       @type = type
@@ -23,5 +24,19 @@ module Moonrope
       @source_attribute || @name
     end
 
+    def name_with_groups
+      ([groups] + [name]).flatten.compact.join('.')
+    end
+
+    def example
+      @example ||= begin
+        if value_type == :timestamp
+          "2016-12-25 09:42:00 +0000"
+        elsif value_type == :boolean
+          "false"
+        end
+      end
+    end
+
   end
 end

data/lib/moonrope/version.rb

@@ -1,3 +1,3 @@
 module Moonrope
-  VERSION = '1.4.1'
+  VERSION = '2.0.0'
 end

data/lib/moonrope.rb

@@ -11,7 +11,8 @@ require 'moonrope/dsl/base_dsl'
 require 'moonrope/dsl/action_dsl'
 require 'moonrope/dsl/controller_dsl'
 require 'moonrope/dsl/structure_dsl'
-
+require 'moonrope/dsl/authenticator_dsl'
+require 'moonrope/authenticator'
 require 'moonrope/errors'
 require 'moonrope/eval_helpers'
 require 'moonrope/eval_environment'
@@ -26,13 +27,13 @@ require 'moonrope/version'
 require 'moonrope/railtie' if defined?(Rails)
 
 module Moonrope
-  
+
   class << self
     attr_accessor :logger
-    
+
     def logger
       @logger ||= Logger.new(STDOUT)
     end
   end
-    
+
 end

data/moonrope.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "moonrope/version"
+
+Gem::Specification.new do |s|
+  s.name        = "moonrope"
+  s.version     = Moonrope::VERSION
+  s.authors     = ["Adam Cooke"]
+  s.email       = ["adam@atechmedia.com"]
+  s.homepage    = "http://adamcooke.io"
+  s.licenses    = ['MIT']
+  s.summary     = "An API server DSL."
+  s.description = "A full library allowing you to create sexy DSLs to define your RPC-like APIs."
+  s.files = Dir["**/*"]
+  s.bindir = "bin"
+  s.executables << 'moonrope'
+  s.add_dependency "json", "~> 1.7"
+  s.add_dependency "rack", ">= 1.4"
+  s.add_dependency "deep_merge", "~> 1.0"
+  s.add_development_dependency "rake", '~> 10.3'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+$:.unshift(File.expand_path(File.join('..', 'lib')))
+
+RSpec.configure do |config|
+  config.color = true
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+end
+
+class FakeRequest
+
+  def initialize(options = {})
+    @options = options
+  end
+
+  def params
+    @params ||= Moonrope::ParamSet.new(@options[:params] || {})
+  end
+
+  def version
+    @options[:version]
+  end
+
+  def identity
+    @options[:identity]
+  end
+
+  def action
+    nil
+  end
+
+end