moonrope 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ec14194988474a3b6e4e0d3e40ffafb64a3fb4c1
-  data.tar.gz: 968649b6047917e0713c0510ed32d2c66d4265d9
+SHA256:
+  metadata.gz: e34dcc98aecf5558f04b21b81aeb19c419597a21d7c736363ed681a322feee06
+  data.tar.gz: b4ad2c14aed545aefa3be780e8d0e778c75d0828d3426ebc022a3d540a05e023
 SHA512:
-  metadata.gz: dbda03f158543eb581faf08fe4954ce4ac567bf03017e0e33dcef295da04b28d262eaa0038facc3e8c62e84f42fdd79f41580e571ba01a659a335c0ff564a1bf
-  data.tar.gz: 64e355f2ef7a89bd545e951070737d2668de5a38c60013b1355c2277a4f0b02318e4d0e7223bd675e2a5364d2d1f9c887b30c3fb3730b9c170c8eddbaf432058
+  metadata.gz: 7395cad7eb23fe964de419d8daf4cfb9fbf4009160dd51e8bec84fe278301be830e822da463ddd139d02c47c0ca805f51d1273777419151a65c1b3168bc68ee0
+  data.tar.gz: 3bbd5d843bf9f608057374c147f056e4a16e1afa2f2928cc2bf99de51e1d274a59317d8524827150e7ffad00a5b208a9efa3edf9ebd037d25935fe596bf00925

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    moonrope (2.0.0)
+    moonrope (2.0.2)
       deep_merge (~> 1.0)
-      json (~> 1.7)
+      json
       rack (>= 1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    deep_merge (1.0.1)
+    deep_merge (1.2.1)
     diff-lcs (1.2.5)
-    json (1.8.3)
+    json (2.3.1)
     rack (1.5.2)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -35,7 +35,7 @@ PLATFORMS
 DEPENDENCIES
   moonrope!
   rack-test (~> 0)
-  rake (~> 10.3)
+  rake
   rspec
   rspec-core
   rspec-expectations
@@ -44,4 +44,4 @@ DEPENDENCIES
   yard (~> 0.8)
 
 BUNDLED WITH
-   1.10.6
+   1.17.2

data/lib/moonrope/base.rb

@@ -48,6 +48,9 @@ module Moonrope
     # @return [Proc] a proc to execute before every request
     attr_accessor :on_request
 
+    # @return [Boolean] is SSL forced?
+    attr_accessor :force_ssl
+
     #
     # Initialize a new instance of the Moonrope::Base
     #
@@ -68,6 +71,7 @@ module Moonrope
       @environment = other.environment
       @load_directories = other.load_directories
       @on_request = other.on_request
+      other.request_callbacks.each { |block| self.register_request_callback(&block) }
       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
@@ -231,5 +235,27 @@ module Moonrope
       @request_error_callbacks ||= []
     end
 
+    #
+    # Set a block which will be executed whenever a request is received by moonrope.
+    #
+    #
+    def register_request_callback(&block)
+      request_callbacks << block
+    end
+
+    #
+    # Return an array of request callbacks
+    #
+    def request_callbacks
+      @request_callbacks ||= []
+    end
+
+    #
+    # Should SSL be forced?
+    #
+    def force_ssl?
+      @force_ssl || false
+    end
+
   end
 end

data/lib/moonrope/rack_middleware.rb

@@ -52,27 +52,33 @@ module Moonrope
         # Reload if needed
         #
         if @options[:reload_on_each_request]
-          base = @base.copy
+          @base = @base.copy
           begin
-            base.load
+            @base.load
           rescue => e
-            return generate_error_triplet(@base, e, global_headers)
+            return generate_error_triplet(@base, nil, e, global_headers)
           end
-        else
-          base = @base
         end
 
         #
-        # Call the on request block if one has been defined for the base.
+        # Create a new request object
         #
-        if base.on_request.is_a?(Proc)
-          base.on_request.call(base, env)
+        request = base.request(env, $1)
+
+        #
+        # If force SSL is enabled, don't allow requests to proceed if they're
+        # not SSL
+        #
+        if base.force_ssl? && !request.ssl?
+          return [400, global_headers, [{:status => 'http-not-supported', :message => "Non-secure HTTP connections are not supported. Requests should be made using https:// rather than http://."}.to_json]]
         end
 
         #
-        # Create a new request object
+        # Call the on request block if one has been defined for the base.
         #
-        request = base.request(env, $1)
+        if base.on_request.is_a?(Proc)
+          base.on_request.call(base, env)
+        end
 
         #
         # Check the request is valid
@@ -87,13 +93,22 @@ 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]]
+          headers = global_headers.merge(result.headers)
+          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}"
+
+          base.request_callbacks.each do |callback|
+            # Call each request callback and provide the request, the result
+            # and the raw that's being returned to the user.
+            callback.call(request, result, json, headers)
+          end
+
+          [200, headers, [json]]
         rescue JSON::ParserError => e
           [400, global_headers, [{:status => 'invalid-json', :details => e.message}.to_json]]
         rescue => e
-          generate_error_triplet(base, e, global_headers)
+          generate_error_triplet(base, request, e, global_headers)
         end
 
       else
@@ -105,7 +120,7 @@ module Moonrope
       end
     end
 
-    def generate_error_triplet(base, exception, headers = {})
+    def generate_error_triplet(base, request, exception, headers = {})
       Moonrope.logger.info exception.class
       Moonrope.logger.info exception.message
       Moonrope.logger.info exception.backtrace.join("\n")

data/lib/moonrope/request.rb

@@ -164,6 +164,14 @@ module Moonrope
       rack_request.ip
     end
 
+    #
+    # Is this request on SSL?
+    #
+    # @return [Boolean]
+    def ssl?
+      rack_request.ssl?
+    end
+
     private
 
     #

data/lib/moonrope/structure.rb

@@ -95,7 +95,7 @@ module Moonrope
         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] = {}
+              hash[expan.to_sym] = nil
             elsif expan.is_a?(Hash)
               hash[expan.first.first.to_sym] = expan.first.last
             end
@@ -233,7 +233,7 @@ module Moonrope
         # hash value as appropriate.
         if structure = self.base.structure(attribute.structure)
           structure_opts = options[:structure_opts] || attribute.structure_opts || {}
-          if value.respond_to?(:map)
+          if value.is_a?(Enumerable) && value.respond_to?(:map)
             value.map do |v|
               structure.hash(v, structure_opts.merge(:request => environment.request))
             end

data/lib/moonrope/structure_attribute.rb

@@ -42,7 +42,7 @@ module Moonrope
       when :timestamp
         value.is_a?(Time) ? value.to_s : value
       when :unix_timestamp
-        value.to_i
+        value.nil? ? nil : value.to_i
       else
         value
       end

data/lib/moonrope/version.rb

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

data/moonrope.gemspec

@@ -14,8 +14,8 @@ Gem::Specification.new do |s|
   s.files = Dir["**/*"]
   s.bindir = "bin"
   s.executables << 'moonrope'
-  s.add_dependency "json", "~> 1.7"
+  s.add_dependency "json"
   s.add_dependency "rack", ">= 1.4"
   s.add_dependency "deep_merge", "~> 1.0"
-  s.add_development_dependency "rake", '~> 10.3'
+  s.add_development_dependency "rake"
 end

data/templates/basic/_action_form.erb

@@ -6,7 +6,7 @@
     <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'>
+      <input type='text' id='version' name='version' value='<%= version %>' class='v'>
       /<%= controller.name %>/<%= action.name %>
     </div>
 

data/test/tests/rack_middleware_test.rb

@@ -107,6 +107,20 @@ class RackMiddlewareTest < Test::Unit::TestCase
     assert_equal 2, request_count
   end
 
+  def test_force_ssl
+    begin
+      app.base.force_ssl = true
+      get "/api/v1/users/list"
+      assert_equal 400, last_response.status
+      assert response_json = JSON.parse(last_response.body)
+      assert_equal 'http-not-supported', response_json['status']
+
+      get "/api/v1/users/list", {}, {'HTTPS' => 'on'}
+      assert_equal 200, last_response.status
+    ensure
+      app.base.force_ssl = false
+    end
+  end
 
   private
 

data/test/tests/structures_test.rb

@@ -160,6 +160,14 @@ class StructuresTest < Test::Unit::TestCase
     assert_equal 'Fido', hash[:animals][0][:name]
     assert_equal 'Boris', hash[:animals][1][:name]
     assert_equal 'Black', hash[:animals][1][:hair_color]
+
+    # a full user hash with named extensions
+    hash = base.structure(:user).hash(user, :full => true, :expansions => [:animals])
+    # arrays
+    assert_equal Array, hash[:animals].class
+    assert_equal 'Fido', hash[:animals][0][:name]
+    assert_equal 'Boris', hash[:animals][1][:name]
+    assert_equal 'Black', hash[:animals][1][:hair_color]
   end
 
   def test_ifs

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: moonrope
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0'
 description: A full library allowing you to create sexy DSLs to define your RPC-like
   APIs.
 email:
@@ -91,23 +91,6 @@ files:
 - example/controllers/users_controller.rb
 - example/structures/pet_structure.rb
 - example/structures/user_structure.rb
-- html/assets/lock.svg
-- html/assets/reset.css
-- html/assets/style.css
-- html/assets/tool.svg
-- html/assets/try.js
-- html/authenticators/default.html
-- html/controllers/meta.html
-- html/controllers/meta/version.html
-- html/controllers/users.html
-- html/controllers/users/create.html
-- html/controllers/users/list.html
-- html/controllers/users/show.html
-- html/controllers/users/update.html
-- html/index.html
-- html/moonrope.txt
-- html/structures/pet.html
-- html/structures/user.html
 - lib/moonrope.rb
 - lib/moonrope/action.rb
 - lib/moonrope/action_result.rb
@@ -191,10 +174,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An API server DSL.
 test_files: []
-has_rdoc: 

data/html/assets/lock.svg

@@ -1,3 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="8" height="8" viewBox="0 0 8 8">
-  <path fill="#ed4300" d="M3 0c-1.1 0-2 .9-2 2v1h-1v4h6v-4h-1v-1c0-1.1-.9-2-2-2zm0 1c.56 0 1 .44 1 1v1h-2v-1c0-.56.44-1 1-1z" transform="translate(1)" />
-</svg>

data/html/assets/reset.css

@@ -1,101 +0,0 @@
-html, body, body div, span, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, abbr, address, cite, code, del, dfn, em, img, ins, kbd, q, samp, small, strong, sub, sup, var, b, i, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, figure, footer, header, hgroup, menu, nav, section, time, mark, audio, video {
-	margin: 0;
-	padding: 0;
-	border: 0;
-	outline: 0;
-	font-size: 100%;
-	letter-spacing:0;
-	vertical-align: baseline;
-	background: transparent;
-	font-weight:inherit;
-}
-
-* {
-	-webkit-box-sizing: border-box;
-	-moz-box-sizing: border-box;
-	box-sizing: border-box;
-}
-u { text-decoration: none;}
-b { font-weight:normal;}
-article, aside, figure, footer, header, hgroup, nav, section {display: block;}
-
-object,embed {max-width: 100%;}
-ul {list-style: none;}
-blockquote, q {quotes: none;}
-b,strong { font-weight:bold;}
-blockquote:before, blockquote:after, q:before, q:after {content: ''; content: none;}
-
-a {margin: 0; padding: 0; font-size: 100%; vertical-align: baseline; background: transparent;}
-
-del {text-decoration: line-through;}
-
-abbr[title], dfn[title] {border-bottom: 1px dotted #000; cursor: help;}
-
-/* tables still need cellspacing="0" in the markup */
-table {border-collapse: collapse; border-spacing: 0;}
-mark { color:inherit;}
-
-hr {display: block; height: 1px; border: 0; border-top: 1px solid #ccc; margin: 1em 0; padding: 0;}
-
-input, select {vertical-align: middle;}
-
-pre {
-	white-space: pre; /* CSS2 */
-	white-space: pre-wrap; /* CSS 2.1 */
-	white-space: pre-line; /* CSS 3 (and 2.1 as well, actually) */
-	word-wrap: break-word; /* IE */
-}
-
-input[type="radio"] {vertical-align: text-bottom;}
-input[type="checkbox"] {vertical-align: bottom; *vertical-align: baseline;}
-.ie6 input {vertical-align: text-bottom;}
-
-select, input, textarea {font: 99% sans-serif;}
-
-table {font-size: inherit; font: 100%;}
-
-/* Accessible focus treatment
-	people.opera.com/patrickl/experiments/keyboard/test */
-a:hover, a:active {outline: none;}
-
-small {font-size: 85%;}
-
-strong, th {font-weight: bold;}
-
-td, td img {vertical-align: top;}
-
-/* Make sure sup and sub don't screw with your line-heights
-	gist.github.com/413930 */
-sub, sup {font-size: 75%; line-height: 0; position: relative;}
-sup {top: -0.5em;}
-sub {bottom: -0.25em;}
-
-/* standardize any monospaced elements */
-pre, code, kbd, samp {font-family: monospace, sans-serif;}
-
-/* hand cursor on clickable elements */
-.clickable,
-label,
-input[type=button],
-input[type=submit],
-button {cursor: pointer;}
-
-/* Webkit browsers add a 2px margin outside the chrome of form elements */
-button, input, select, textarea {margin: 0;}
-
-/* make buttons play nice in IE */
-button {width: auto; overflow: visible;}
-
-/* scale images in IE7 more attractively */
-.ie7 img {-ms-interpolation-mode: bicubic;}
-
-/* prevent BG image flicker upon hover */
-.ie6 html {filter: expression(document.execCommand("BackgroundImageCache", false, true));}
-
-/* let's clear some floats */
-.clearfix:before, .clearfix:after { content: "\0020"; display: block; height: 0; overflow: hidden; }
-.clearfix:after { clear: both; }
-.clearfix { zoom: 1; }
-
-select, input, textarea, a { outline: none;}
-a { color:inherit;}