moonrope 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5af89a4e614e26c289fad12a69304c7a2f293562
-  data.tar.gz: e2db44de7655b8d4d3aa659fd814b1fdca6af522
+  metadata.gz: ec14194988474a3b6e4e0d3e40ffafb64a3fb4c1
+  data.tar.gz: 968649b6047917e0713c0510ed32d2c66d4265d9
 SHA512:
-  metadata.gz: 90e9f623a0f62e3564fc9ba17850684f263810a04c707ff11765d12522ceef810d8524f8c93b8cc9b3a29e6a72663593552fe6050016c57c7ffe373128969d0c
-  data.tar.gz: 1d661f3d8acc4352ecc936ccbbf42d18afbefcf128db5b993e0c3edd947b84b360af8b6864e21a974b12c29c44be50e04d233c83a46afe1cce7fbd6c62704e8f
+  metadata.gz: dbda03f158543eb581faf08fe4954ce4ac567bf03017e0e33dcef295da04b28d262eaa0038facc3e8c62e84f42fdd79f41580e571ba01a659a335c0ff564a1bf
+  data.tar.gz: 64e355f2ef7a89bd545e951070737d2668de5a38c60013b1355c2277a4f0b02318e4d0e7223bd675e2a5364d2d1f9c887b30c3fb3730b9c170c8eddbaf432058

data/lib/moonrope/action.rb

@@ -107,19 +107,21 @@ module Moonrope
     # Execute a block of code and catch approprite Moonrope errors and return
     # a result.
     #
-    def convert_errors_to_action_result(&block)
+    def convert_errors_to_action_result(start_time = nil, &block)
       begin
         yield block
       rescue => exception
         case exception
         when Moonrope::Errors::RequestError
           result = ActionResult.new(self)
+          result.time = start_time ? (Time.now - start_time).round(2) : nil
           result.status = exception.status
           result.data = exception.data
           result
         else
           if error_block = @controller.base.external_errors[exception.class]
             result = ActionResult.new(self)
+            result.time = start_time ? (Time.now - start_time).round(2) : nil
             error_block.call(exception, result)
             result
           else
@@ -149,14 +151,14 @@ module Moonrope
       #
       eval_environment.default_params = self.default_params
 
-      convert_errors_to_action_result do
+      start_time = Time.now
+
+      convert_errors_to_action_result(start_time) 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)

data/lib/moonrope/authenticator.rb

@@ -17,6 +17,9 @@ module Moonrope
     # @return [Symbol] the name of the authenticator
     attr_reader :name
 
+    # @return [String] the friendly name for the authenticator
+    attr_accessor :friendly_name
+
     # @return [String] the description for the authenticator
     attr_accessor :description
 

data/lib/moonrope/base.rb

@@ -61,6 +61,23 @@ module Moonrope
       @dsl.instance_eval(&block) if block_given?
     end
 
+    #
+    # Make a new base based on configuration
+    #
+    def copy_from(other)
+      @environment = other.environment
+      @load_directories = other.load_directories
+      @on_request = other.on_request
+      other.request_error_callbacks.each { |block| self.register_request_error_callback(&block) }
+      other.external_errors.each { |error, block| self.register_external_error(error, &block) }
+    end
+
+    def copy
+      new_base = self.class.new
+      new_base.copy_from(self)
+      new_base
+    end
+
     #
     # Reset the whole base to contain no data.
     #

data/lib/moonrope/dsl/authenticator_dsl.rb

@@ -6,6 +6,10 @@ module Moonrope
         @authenticator = authenticator
       end
 
+      def friendly_name(value)
+        @authenticator.friendly_name = value
+      end
+
       def description(value)
         @authenticator.description = value
       end

data/lib/moonrope/dsl/structure_dsl.rb

@@ -77,6 +77,7 @@ module Moonrope
         attribute.value             = options[:value]
         attribute.example           = options[:eg] || options[:example]
         attribute.doc               = options[:doc]
+        attribute.mutation          = options[:mutation]
         attribute.groups            = @groups
         attribute.conditions        = @conditions
         @structure.attributes[type] << attribute

data/lib/moonrope/rack_middleware.rb

@@ -25,23 +25,6 @@ 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
         #
@@ -65,6 +48,32 @@ module Moonrope
         #
         global_headers['Content-Type'] = 'application/json'
 
+        #
+        # Reload if needed
+        #
+        if @options[:reload_on_each_request]
+          base = @base.copy
+          begin
+            base.load
+          rescue => e
+            return generate_error_triplet(@base, e, global_headers)
+          end
+        else
+          base = @base
+        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)
+
         #
         # Check the request is valid
         #
@@ -78,30 +87,13 @@ module Moonrope
         begin
           result = request.execute
           json = result.to_json
+          Moonrope.logger.info "[#{Time.now.utc.strftime("%Y-%m-%d %H:%M:%S")}] controller=#{request.controller.name} action=#{request.action.name} status=#{result.status} time=#{result.time} ip=#{request.ip} size=#{json.bytesize}"
           global_headers['Content-Length'] = json.bytesize.to_s
           [200, global_headers.merge(result.headers), [json]]
         rescue JSON::ParserError => e
           [400, global_headers, [{:status => 'invalid-json', :details => e.message}.to_json]]
         rescue => e
-          Moonrope.logger.info e.class
-          Moonrope.logger.info e.message
-          Moonrope.logger.info e.backtrace.join("\n")
-
-          response = {:status => 'internal-server-error'}
-
-          # Call any request errors which have been registered on the base
-          @base.request_error_callbacks.each do |callback|
-            callback.call(request, e)
-          end
-
-          # 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]]
+          generate_error_triplet(base, e, global_headers)
         end
 
       else
@@ -113,5 +105,27 @@ module Moonrope
       end
     end
 
+    def generate_error_triplet(base, exception, headers = {})
+      Moonrope.logger.info exception.class
+      Moonrope.logger.info exception.message
+      Moonrope.logger.info exception.backtrace.join("\n")
+
+      response = {:status => 'internal-server-error'}
+
+      # Call any request errors which have been registered on the base
+      base.request_error_callbacks.each do |callback|
+        callback.call(request, exception)
+      end
+
+      # If in development, return more details about the exception which was raised.
+      if base.environment == 'development'
+        response[:error] = exception.class.to_s
+        response[:message] = exception.message
+        response[:backtrace] = exception.backtrace[0,6]
+      end
+
+      [500, headers, [response.to_json]]
+    end
+
   end
 end

data/lib/moonrope/request.rb

@@ -120,7 +120,7 @@ module Moonrope
     #
     def params
       @params ||= begin
-        if @env['CONTENT_TYPE'] == 'application/json'
+        if @env['CONTENT_TYPE'] && @env['CONTENT_TYPE'] =~ /\Aapplication\/json(;|\z)/i
           Moonrope::ParamSet.new(rack_request.body.read)
         else
           Moonrope::ParamSet.new(rack_request.params['params'])

data/lib/moonrope/structure.rb

@@ -85,13 +85,29 @@ module Moonrope
         end
       end
 
+      if options[:attributes]
+        hash.reject! { |k,v| !options[:attributes].include?(k.to_sym) }
+      end
+
       # Add expansions
       if options[:expansions]
 
+        if options[:expansions].is_a?(Array)
+          expansions_to_include = options[:expansions].each_with_object({}) do |expan, hash|
+            if expan.is_a?(Symbol) || expan.is_a?(String)
+              hash[expan.to_sym] = {}
+            elsif expan.is_a?(Hash)
+              hash[expan.first.first.to_sym] = expan.first.last
+            end
+          end
+        else
+          expansions_to_include = true
+        end
+
         # 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
+          next if expansions_to_include.is_a?(Hash) && !expansions_to_include.keys.include?(attribute.name.to_sym)
+          DeepMerge.deep_merge! hash_for_attributes([attribute], object, environment, :structure_opts => expansions_to_include.is_a?(Hash) && expansions_to_include[attribute.name.to_sym]), hash
         end
 
         # Add the expansions
@@ -162,7 +178,7 @@ module Moonrope
     #
     # Return a returnable hash for a given set of structured fields.
     #
-    def hash_for_attributes(attributes, object, environment)
+    def hash_for_attributes(attributes, object, environment, value_options = {})
       return {} unless attributes.is_a?(Array)
       Hash.new.tap do |hash|
         attributes.each do |attribute|
@@ -180,9 +196,11 @@ module Moonrope
           elsif attribute.value
             value = attribute.value
           else
-            value = value_for_attribute(object, environment, attribute)
+            value = value_for_attribute(object, environment, attribute, value_options)
           end
 
+          value = attribute.mutate(value)
+
           if attribute.groups.empty?
             hash[attribute.name] = value
           else
@@ -203,7 +221,7 @@ module Moonrope
     #
     # Return a value for a structured field.
     #
-    def value_for_attribute(object, environment,  attribute)
+    def value_for_attribute(object, environment, attribute, options = {})
       if attribute.source_attribute.is_a?(Proc)
         value = environment.instance_eval(&attribute.source_attribute)
       else
@@ -214,7 +232,7 @@ module Moonrope
         # 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 || {}
+          structure_opts = options[:structure_opts] || attribute.structure_opts || {}
           if value.respond_to?(:map)
             value.map do |v|
               structure.hash(v, structure_opts.merge(:request => environment.request))

data/lib/moonrope/structure_attribute.rb

@@ -12,6 +12,7 @@ module Moonrope
     attr_accessor :value
     attr_accessor :example
     attr_accessor :doc
+    attr_accessor :mutation
 
     def initialize(type, name)
       @type = type
@@ -28,12 +29,35 @@ module Moonrope
       ([groups] + [name]).flatten.compact.join('.')
     end
 
+    def mutate(value)
+      if mutation
+        value ? value.public_send(mutation) : nil
+      else
+        auto_mutate(value)
+      end
+    end
+
+    def auto_mutate(value)
+      case value_type
+      when :timestamp
+        value.is_a?(Time) ? value.to_s : value
+      when :unix_timestamp
+        value.to_i
+      else
+        value
+      end
+    end
+
     def example
       @example ||= begin
         if value_type == :timestamp
           "2016-12-25 09:42:00 +0000"
+        elsif value_type == :unix_timestamp
+          "1491070507"
         elsif value_type == :boolean
           "false"
+        elsif value_type == :uuid
+          "017dabc1-3f4f-47ab-ab7d-86e2ed0de679"
         end
       end
     end

data/lib/moonrope/version.rb

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

data/templates/basic/_action_form.erb

@@ -1,77 +1,77 @@
-<p class='tryFormActivate'><a class='tryFormActivate__button' href='#'>Try this request in your browser</a></p>
-<form class='tryForm'>
-  <input type='hidden' name='controller' value='<%= controller.name %>'>
-  <input type='hidden' name='action' value='<%= action.name %>'>
-  <div class='tryForm__header'>
-    <input type='text' id='host' name='host' value='<%= host %>'>
-    /api/
-    <input type='text' id='version' name='version' value='v1' class='v'>
-    /<%= controller.name %>/<%= action.name %>
-  </div>
+<% unless host.nil? %>
+  <p class='tryFormActivate'><a class='tryFormActivate__button' href='#'>Try this request in your browser</a></p>
+  <form class='tryForm'>
+    <input type='hidden' name='controller' value='<%= controller.name %>'>
+    <input type='hidden' name='action' value='<%= action.name %>'>
+    <div class='tryForm__header'>
+      <input type='text' id='host' name='host' value='<%= host %>'>
+      /api/
+      <input type='text' id='version' name='version' value='v1' class='v'>
+      /<%= controller.name %>/<%= action.name %>
+    </div>
 
-  <% if action.authenticator_to_use.is_a?(Moonrope::Authenticator) %>
-  <p class='tryForm__heading'>Headers</p>
-  <table class='tryForm__table'>
-    <% for name, options in action.authenticator_to_use.headers %>
-    <tr>
-      <td width="50%"><code><%= name %></code></td>
-      <td width="50%"><input type='text' class='tryForm__tableField headerField' name='<%= name %>'></td>
-    </tr>
+    <% if action.authenticator_to_use.is_a?(Moonrope::Authenticator) %>
+    <p class='tryForm__heading'>Headers</p>
+    <table class='tryForm__table'>
+      <% for name, options in action.authenticator_to_use.headers %>
+      <tr>
+        <td width="50%"><code><%= name %></code></td>
+        <td width="50%"><input type='text' class='tryForm__tableField headerField' name='<%= name %>'></td>
+      </tr>
+      <% end %>
+    </table>
     <% end %>
-  </table>
-  <% end %>
 
-  <% unless action.params.empty? %>
-  <p class='tryForm__heading'>Parameters</p>
-  <table class='tryForm__table'>
-    <% for name, param in action.params %>
-    <tr>
-      <td width="30%"><code><%= name %></code></td>
-      <td width="20%"><%= friendly_type param[:type] %></td>
-      <td width="50%"><input type='text' class='tryForm__tableField paramField' name='<%= name %>' placeholder='<%= param[:default] %>' data-type='<%= param[:type] %>'></td>
-    </tr>
+    <% unless action.params.empty? %>
+    <p class='tryForm__heading'>Parameters</p>
+    <table class='tryForm__table'>
+      <% for name, param in action.params %>
+      <tr>
+        <td width="30%"><code><%= name %></code></td>
+        <td width="20%"><%= friendly_type param[:type] %></td>
+        <td width="50%"><input type='text' class='tryForm__tableField paramField' name='<%= name %>' placeholder='<%= param[:default] %>' data-type='<%= param[:type] %>'></td>
+      </tr>
+      <% end %>
+    </table>
     <% end %>
-  </table>
-  <% end %>
 
-  <% if action.can_change_full? || action.can_change_expansions? %>
-  <p class='tryForm__heading'>Structures</p>
-  <table class='tryForm__table'>
-    <% if action.can_change_full? %>
-    <tr>
-      <td width="50%">Include extended attributes?</td>
-      <td width="50%">
-        <div class='tryForm__checkbox'>
-          <input type='checkbox' class='tryForm__fullAttrs' name='full' id="full_attrs" <% if action.includes_full_attributes? %>checked='checked'<%end%>>
-          <label for="full_attrs">Yes - include extended attributes</label>
-        </div>
-      </td>
-    </tr>
-    <% end %>
-    <% if action.can_change_expansions? %>
-    <tr>
-      <td width="50%">Include expansions?</td>
-      <td width="50%">
-        <% for expansion in action.available_expansions %>
+    <% if action.can_change_full? || action.can_change_expansions? %>
+    <p class='tryForm__heading'>Structures</p>
+    <table class='tryForm__table'>
+      <% if action.can_change_full? %>
+      <tr>
+        <td width="50%">Include extended attributes?</td>
+        <td width="50%">
           <div class='tryForm__checkbox'>
-            <input type='checkbox' class='tryForm__expansions' name='<%= expansion%>' id="expan_<%= expansion %>" <% if action.includes_expansion?(expansion) %>checked='checked'<%end%>>
-            <label for="expan_<%= expansion %>"><%= expansion %></label>
+            <input type='checkbox' class='tryForm__fullAttrs' name='full' id="full_attrs" <% if action.includes_full_attributes? %>checked='checked'<%end%>>
+            <label for="full_attrs">Yes - include extended attributes</label>
           </div>
-        <% end %>
-      </td>
-    </tr>
-    <% end %>
-
-  </table>
+        </td>
+      </tr>
+      <% end %>
+      <% if action.can_change_expansions? %>
+      <tr>
+        <td width="50%">Include expansions?</td>
+        <td width="50%">
+          <% for expansion in action.available_expansions %>
+            <div class='tryForm__checkbox'>
+              <input type='checkbox' class='tryForm__expansions' name='<%= expansion%>' id="expan_<%= expansion %>" <% if action.includes_expansion?(expansion) %>checked='checked'<%end%>>
+              <label for="expan_<%= expansion %>"><%= expansion %></label>
+            </div>
+          <% end %>
+        </td>
+      </tr>
+      <% end %>
 
-  <% end %>
+    </table>
 
-  <p class='tryForm__button'>
-    <button class='tryForm__buttonLink' type='submit'>Make this request</button>
-    <button class='tryForm__buttonLink tryFormCancel' type='button'>Cancel</button>
-  </p>
-
-  <pre class='tryForm__output'>The request output will be shown here...</pre>
-</form>
+    <% end %>
 
+    <p class='tryForm__button'>
+      <button class='tryForm__buttonLink' type='submit'>Make this request</button>
+      <button class='tryForm__buttonLink tryFormCancel' type='button'>Cancel</button>
+    </p>
 
+    <pre class='tryForm__output'>The request output will be shown here...</pre>
+  </form>
+<% end %>

data/templates/basic/assets/try.js

@@ -97,11 +97,17 @@ $(document).ready(function() {
         outputBox.text(JSON.stringify(data, null, 4))
         outputBox.show()
       },
-      error: function() {
+      error: function(xhr) {
         // Errors which occurr aren't very well reported at the moment.
         // They should be.
+        if(xhr.getResponseHeader('content-type') == 'application/json') {
+          var text = JSON.stringify(JSON.parse(xhr.responseText), null, 4)
+        } else {
+          var text = "Failed to make request."
+        }
+
         outputBox.show()
-        outputBox.text("Failed to make request.")
+        outputBox.text(text)
         outputBox.addClass('tryForm__output--error').removeClass('tryForm__output--success')
       }
     })

data/templates/basic/authenticator.erb

@@ -6,6 +6,7 @@
 <% else %>
 <% set_page_title "#{humanize(authenticator.name.to_s.capitalize)} Authenticator" %>
 <h1><%= humanize(authenticator.name.to_s.capitalize) %> Authenticator</h1>
+<% set_active_nav "authenticator-#{authenticator.name.to_s}" %>
 <% end %>
 
 <p class='text'>

data/templates/basic/layout.erb

@@ -17,10 +17,10 @@
               Home
             </a>
           </li>
-          <% if base.authenticators[:default] %>
+          <% base.authenticators.select { |k,v| v.friendly_name }.each do |id, authenticator| %>
           <li>
-            <a href='<%= path('authenticators/default') %>' class="<%= active_nav == 'authenticator-default' ? 'active' : '' %>">
-              Authentication
+            <a href='<%= path('authenticators/' + id.to_s) %>' class="<%= active_nav == "authenticator-" + id.to_s ? 'active' : '' %>">
+              <%= authenticator.friendly_name %>
             </a>
           </li>
           <% end %>

data/test/tests/rack_middleware_test.rb

@@ -68,6 +68,14 @@ class RackMiddlewareTest < Test::Unit::TestCase
     assert_equal 'Adam', response_json['data']
   end
 
+  def test_params_in_body_with_charset
+    post "/api/v1/users/echo", '{"name":"Adam"}', {'CONTENT_TYPE' => 'application/json; charset=utf8'}
+    assert_equal 200, last_response.status
+    assert response_json = JSON.parse(last_response.body)
+    assert_equal 'success', response_json['status']
+    assert_equal 'Adam', response_json['data']
+  end
+
   def test_passing_invalid_json_renders_a_bad_request
     get "/api/v1/users/list", {:params => "{invalidjson}"}
     assert_equal 400, last_response.status

data/test/tests/structures_test.rb

@@ -332,4 +332,59 @@ class StructuresTest < Test::Unit::TestCase
     assert_equal "Bananas!", base.structure(:animal).attributes[:basic].select { |a| a.name == :example2 }.first.description
   end
 
+  def test_mutating_values
+    base = Moonrope::Base.new do
+      structure :animal do
+        basic :name, :mutation => :downcase
+      end
+    end
+    assert_equal 'fido', base.structure(:animal).hash(Animal.new(:name => 'FIDO'))[:name]
+  end
+
+  def test_auto_mutating_values
+    base = Moonrope::Base.new do
+      structure :animal do
+        basic :name, :type => :unix_timestamp
+      end
+    end
+    assert_equal 1234567890, base.structure(:animal).hash(Animal.new(:name => Time.at(1234567890)))[:name]
+  end
+
+  def test_manually_selecting_attributes
+    base = Moonrope::Base.new do
+      structure :animal do
+        basic :id
+        basic :name
+      end
+    end
+    hash = base.structure(:animal).hash(Animal.new(:id => 12345, :name => "Fido"), :attributes => [:id])
+    assert_equal 12345, hash[:id]
+    assert_equal false, hash.has_key?(:name)
+  end
+
+
+  def test_setting_options_for_embedded_expansions
+    user = User.new(:id => 1, :username => 'dave')
+    animal1 = Animal.new(:id => 1, :name => 'Fido', :color => 'Ginger', :user => user)
+    animal2 = Animal.new(:id => 2, :name => 'Jess', :color => 'Black & White', :user => user)
+    user.animals << animal1
+    user.animals << animal2
+
+    base = Moonrope::Base.new do
+      structure :user do
+        basic { {:id => o.id, :username => o.username } }
+        expansion :animals, :structure => :animal
+      end
+
+      structure :animal do
+        basic :id
+        basic :name
+        full :color
+      end
+    end
+
+    hash = base.structure(:user).hash(user, :expansions => [{:animals => {:full => true}}])
+    assert_equal 'Ginger', hash[:animals][0][:color]
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moonrope
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-08 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -192,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: An API server DSL.