qm 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df2e09fa4efffc09c430a3b09adbd272e75aa8b7
-  data.tar.gz: 69673e6ad48389d7a5add4bbacd7398e8ea79cad
+  metadata.gz: da264638d70859692298a689d2a92d025733719f
+  data.tar.gz: 10ed26e4b45118477d7b48ac2adc611e9e4a3093
 SHA512:
-  metadata.gz: b11d41f038f63a42226953b69a6db5e779479f669ab57c39a4a36a0732f4fc287685018d4a87dd88fe52ef929c4c950da0d6f96e794d5e14b74dd18343d8b89e
-  data.tar.gz: 0a3e11577bb084ad0bdb06ef7dadfc3057f51b6e47853b319c822ae7813fbd2a3c9ed9147659260929ace1f58d4f1b460e4ae229b1a1639020e385fe5f485a8e
+  metadata.gz: fef5c587e41035dbaa90bb16a1320f3f41b7ab9f306fb454ae5bb662b7ca5f8a5fbd83b275767e58484a9167fafbbf7afd8c727513b96dff3257cda93eefd374
+  data.tar.gz: 3b43abf641787cc89a3730899c1ce44ef665d6b597079190b871d35545f0665ac9f90491f18a029d77fb4a5c0736a43a848a0d08ce4c566ff2bf611b5b0f6fda

data/README.md

@@ -1,14 +1,17 @@
-# qm
+qm
+==
+
 
 The `qm` gem for [Ruby](http://www.ruby-lang.org/) includes a
 [QMachine](https://www.qmachine.org) API server and a web server. It uses
 [MongoDB](http://www.mongodb.org/) for persistent storage, and it can
 optionally log traffic data into a different MongoDB collection instead of
-logging to stdout. A client is planned.
+logging to stdout. A client is also in development.
 
-The repository contains vestigial definitions for using
-[SQLite](https://www.sqlite.org/), but these may "evolve away" in the future,
-primarily due to the
+Note that the original [SQLite](https://www.sqlite.org/) definitions are now
+only available in the
+[`sqlite3` branch](https://github.com/qmachine/qm-ruby/tree/sqlite3). This
+decision was motivated primarily by the
 [obstacle it poses](https://devcenter.heroku.com/articles/sqlite3)
 to deploying on [Heroku](https://www.heroku.com). If you are absolutely in love
 with SQLite (or just hate MongoDB), consider trying the
@@ -21,4 +24,3 @@ For more information, please see the
 
 [![Gem Version](https://badge.fury.io/rb/qm.svg)](http://badge.fury.io/rb/qm) [![Dependency Status](https://gemnasium.com/qmachine/qm-ruby.png)](https://gemnasium.com/qmachine/qm-ruby)
 
-<!-- vim:set syntax=markdown: -->

data/lib/defs-mongo.rb

@@ -2,7 +2,7 @@
 
 #-  defs-mongo.rb ~~
 #                                                       ~~ (c) SRW, 16 Jul 2014
-#                                                   ~~ last updated 21 Aug 2014
+#                                                   ~~ last updated 14 Dec 2014
 
 require 'json'
 require 'mongo'
@@ -99,7 +99,7 @@ module Sinatra
                 host:   request.host,
                 ip:     request.ip,
                 method: request.request_method,
-                #status_code: response.status,
+                status_code: response.status,
                 timestamp: Time.now,
                 url:    request.fullpath
             })

data/lib/qm.rb

@@ -2,7 +2,7 @@
 
 #-  qm.rb ~~
 #                                                       ~~ (c) SRW, 12 Apr 2013
-#                                                   ~~ last updated 17 Nov 2014
+#                                                   ~~ last updated 07 Dec 2014
 
 module QM
 
@@ -22,7 +22,7 @@ module QM
             configure do
                 convert = lambda do |x|
                   # This converts all keys in a hash to symbols recursively.
-                    if (x.is_a?(Hash)) then
+                    if x.is_a?(Hash) then
                         x = x.inject({}) do |memo, (k, v)|
                             memo[k.to_sym] = convert.call(v)
                             memo
@@ -32,11 +32,11 @@ module QM
                 end
                 options = convert.call(options)
                 set options
-                if (settings.persistent_storage.has_key?(:mongo)) then
+                if settings.persistent_storage.has_key?(:mongo) then
                     helpers Sinatra::MongoAPIDefs
                     mongo_api_connect
                 end
-                if (settings.trafficlog_storage.has_key?(:mongo)) then
+                if settings.trafficlog_storage.has_key?(:mongo) then
                     helpers Sinatra::MongoLogDefs
                     mongo_log_connect
                     after do

data/lib/service.rb

@@ -16,7 +16,7 @@
 #   of a 'box', 'key', or 'status' value.
 #
 #                                                       ~~ (c) SRW, 24 Apr 2013
-#                                                   ~~ last updated 28 Aug 2014
+#                                                   ~~ last updated 12 Jan 2015
 
 require 'sinatra'
 require 'sinatra/cross_origin'
@@ -34,6 +34,7 @@ class QMachineService < Sinatra::Base
             enable_cors:            false,
             enable_web_server:      false,
             hostname:               '0.0.0.0',
+            max_body_size:          1048576, # 1024 * 1024 = 1 MB
             persistent_storage:     {},
             port:                   8177,
             public_folder:          'public',
@@ -41,12 +42,15 @@ class QMachineService < Sinatra::Base
 
       # Sinatra mappings and options needed by QMachine.
 
-        mime_type webapp: 'application/x-web-app-manifest+json'
+        mime_type :webapp, 'application/x-web-app-manifest+json'
 
         set bind: lambda { settings.hostname },
             logging: true,
+            raise_errors: false,
             run: false,
-            static: lambda { settings.enable_web_server }
+            show_exceptions: false,
+            static: lambda { settings.enable_web_server },
+            x_cascade: false
 
       # See also: http://www.sinatrarb.com/configuration.html
 
@@ -65,9 +69,14 @@ class QMachineService < Sinatra::Base
      # that are loaded at runtime by `QM::launch_service`.
 
         def hang_up
-          # This helper method "hangs up" on a request by sending a nondescript
-          # 444 response back to the client, a convention taken from nginx.
-            halt [444, {'Content-Type' => 'text/plain'}, ['']]
+          # This helper literally "hangs up" on the request by immediately
+          # halting further processing, responding with a nondescript 444
+          # status code and an empty body, and then closing the connection.
+          # Unfortunately, closing the connection in this way caused problems
+          # in the Node.js implementation, which suggests that this is not the
+          # correct solution for all concurrency models ... argh.
+            headers = {'Connection' => 'close', 'Content-Type' => 'text/plain'}
+            halt [444, headers, ['']]
         end
 
     end
@@ -88,8 +97,9 @@ class QMachineService < Sinatra::Base
         hang_up unless (settings.enable_api_server?) and
                 ((version == 'box') or (version == 'v1')) and
                 (@box.match(/^[\w\-]+$/)) and
-                ((@key.is_a?(String) and @key.match(/^[A-Za-z0-9]+$/)) or
-                (@status.is_a?(String) and @status.match(/^[A-Za-z0-9]+$/)))
+                ((@key.is_a?(String) and @key.match(/^[\w\-]+$/)) or
+                (@status.is_a?(String) and @status.match(/^[\w\-]+$/))) and
+                (request.content_length.to_s.to_i(10) < settings.max_body_size)
         cross_origin if settings.enable_cors?
     end
 
@@ -112,12 +122,16 @@ class QMachineService < Sinatra::Base
       # such as when uploading results or submitting new tasks.
         hang_up unless @key.is_a?(String) and not @status.is_a?(String)
         body = request.body.read
-        x = JSON.parse(body)
+        begin
+            x = JSON.parse(body)
+        rescue JSON::ParserError
+            hang_up
+        end
         hang_up unless (@box == x['box']) and (@key == x['key'])
         if x['status'].is_a?(String) then
           # This arm runs only when a client writes an avar which represents a
           # task description.
-            hang_up unless x['status'].match(/^[A-Za-z0-9]+$/)
+            hang_up unless x['status'].match(/^[\w\-]+$/)
             set_avar([@box, @key, x['status'], body])
         else
           # This arm runs when a client is writing a "regular avar".
@@ -127,10 +141,16 @@ class QMachineService < Sinatra::Base
     end
 
     get '/robots.txt' do
-      # This route tells web crawlers to keep out of an API server, but it
-      # delegates to a static file if the web server is enabled.
-        pass if settings.enable_web_server?
-        y = "User-agent: *\nDisallow: /\n"
+      # This route delegates to the web server, if it was enabled at launch and
+      # if the appropriate file exists; otherwise, it returns a message to web
+      # crawlers instructing them to keep out.
+        robots_file = File.join(settings.public_folder, 'robots.txt')
+        if settings.enable_web_server? then
+            pass if File.exists?(robots_file)
+            y = "User-agent: *\nDisallow: /box/\nDisallow: /v1/\n"
+        else
+            y = "User-agent: *\nDisallow: /\n"
+        end
         return [200, {'Content-Type' => 'text/plain'}, [y]]
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qm
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Sean Wilkinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.3.2
-description: This is a port of the QMachine web service.
+description: Ruby port of QMachine web service + in-progress client
 email: sean@mathbiol.org
 executables: []
 extensions: []
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: 'QMachine: A platform for World Wide Computing'