rocketio 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf979ed0411d6e6e4388a1832715d82a792054e6
-  data.tar.gz: 4a9cd0d72c951843860d0872ba5310caf3932b11
+  metadata.gz: ac617b26c0a9352ff073f5e194202d8e09f90c4c
+  data.tar.gz: 1e9aa0b25987687e5d1b25193bfb60bf014e6fa2
 SHA512:
-  metadata.gz: 7cfb21a58bae0e43d65b07fe1cee2355f5126407ca942e30058aac18cb644f77a2566335dc83c15778405b7c688ce82290c887c90cb77facca232b115595b860
-  data.tar.gz: 7b1a235d42e494da7e923e7116223107cd6f4c310b2e069c4baf3629ab864d0a72caf9d8e32cb10bc03b7daaea3196cb8f4983c99d1968461b467006473023a9
+  metadata.gz: 143b5e6041e82d762c8a55ad0d4fc759bbd05a5cbaddca814141c76cd04fabc07ae17df6e168525b3f518ec3944140ebc18ce9275be13765dfdd8f70ff363489
+  data.tar.gz: 9e087b5c7c644b4a84ac5830824537902710ea8d3203e882e08b33139184ee6802960d4a85819e173c9360fa9369be29a8dac71a2c69d0c7e204a57ca6d4566e

data/lib/rocketio.rb

@@ -62,7 +62,11 @@ module RocketIO
   DEFAULT_CONTENT_TYPE     = 'text/html'.freeze
   CONTENT_LENGTH           = 'Content-Length'.freeze
   CONTENT_DISPOSITION      = 'Content-Disposition'.freeze
+
   APPLICATION_OCTET_STREAM = 'application/octet-stream'.freeze
+  APPLICATION_JSON         = 'application/json'.freeze
+  APPLICATION_JSON_REGEXP  = /application\/json/i
+
   DEFAULT_AUTH_REALM       = 'AccessRestricted'.freeze
   DEFAULT_TOKEN_AUTH_REALM = 'Application'.freeze
 
@@ -71,31 +75,39 @@ module RocketIO
   HTTP_ACCEPT    = 'HTTP_ACCEPT'.freeze
   REMOTE_USER    = 'REMOTE_USER'.freeze
 
-  HTTP_CONNECTION          = 'HTTP_CONNECTION'.freeze
+  HTTP_CONTENT_TYPE = 'CONTENT_TYPE'.freeze
+  HTTP_CONNECTION = 'HTTP_CONNECTION'.freeze
+
   HTTP_AUTHORIZATION_KEYS  = ['HTTP_AUTHORIZATION', 'X-HTTP_AUTHORIZATION', 'X_HTTP_AUTHORIZATION'].map(&:freeze).freeze
   HTTP_AUTHORIZATION_MOCKS = {
     basic:  'Basic Og=='.freeze,
     digest: 'Digest opaque="", qop="auth", uri="%s"'.freeze
   }.freeze
-  HTTP_UPGRADE             = 'HTTP_UPGRADE'.freeze
-  UPGRADE                  = 'upgrade'.freeze
-  WEBSOCKET                = 'websocket'.freeze
-  HTTP_1_1                 = 'HTTP/1.1'.freeze
-  HTTP_VERSION             = 'HTTP_VERSION'.freeze
-  HTTP_X_FORWARDED_HOST    = 'HTTP_X_FORWARDED_HOST'.freeze
-  HTTP_IF_MATCH            = 'HTTP_IF_MATCH'.freeze
-  HTTP_IF_NONE_MATCH       = 'HTTP_IF_NONE_MATCH'.freeze
-  HTTP_IF_MODIFIED_SINCE   = 'HTTP_IF_MODIFIED_SINCE'.freeze
+
+  HTTP_UPGRADE = 'HTTP_UPGRADE'.freeze
+
+  UPGRADE = 'upgrade'.freeze
+  WEBSOCKET = 'websocket'.freeze
+
+  HTTP_1_1 = 'HTTP/1.1'.freeze
+  HTTP_VERSION = 'HTTP_VERSION'.freeze
+  HTTP_X_FORWARDED_HOST = 'HTTP_X_FORWARDED_HOST'.freeze
+  HTTP_IF_MATCH = 'HTTP_IF_MATCH'.freeze
+  HTTP_IF_NONE_MATCH = 'HTTP_IF_NONE_MATCH'.freeze
+  HTTP_IF_MODIFIED_SINCE = 'HTTP_IF_MODIFIED_SINCE'.freeze
   HTTP_IF_UNMODIFIED_SINCE = 'HTTP_IF_UNMODIFIED_SINCE'.freeze
-  HTTP_X_REQUESTED_WITH    = 'HTTP_X_REQUESTED_WITH'.freeze
-  XML_HTTP_REQUEST         = 'XMLHttpRequest'.freeze
-
-  LOCATION       = 'Location'.freeze
-  CACHE_CONTROL  = 'Cache-Control'.freeze
-  EXPIRES        = 'Expires'.freeze
-  LAST_MODIFIED  = 'Last-Modified'.freeze
-  ETAG           = 'ETag'.freeze
-  ETAG_KINDS     = [:strong, :weak].freeze
+  HTTP_X_REQUESTED_WITH = 'HTTP_X_REQUESTED_WITH'.freeze
+  XML_HTTP_REQUEST = 'XMLHttpRequest'.freeze
+
+  LOCATION = 'Location'.freeze
+  CACHE_CONTROL = 'Cache-Control'.freeze
+  EXPIRES = 'Expires'.freeze
+  LAST_MODIFIED = 'Last-Modified'.freeze
+
+  ETAG = 'ETag'.freeze
+  ETAG_KINDS = [:strong, :weak].freeze
+
+  RACK_INPUT = 'rack.input'.freeze
 
   DROP_BODY_RESPONSES = {204 => true, 205 => true, 304 => true}.freeze
 

data/lib/rocketio/application.rb

@@ -13,7 +13,11 @@ module RocketIO
       catch :__response__ do # catch 404 errors and potential `halt` calls from middleware
         controller, method, path_params = @router.resolve_path(env[PATH_INFO])
 
-        controller || Controller.new(INDEX_METHOD, EMPTY_ARRAY, env).error(404)
+        unless controller
+          controller = Controller.new
+          controller.instance_variable_set(:@__env__, env)
+          controller.error(404)
+        end
 
         controller = controller.new(method, path_params)
         chain = controller.middleware.reverse.inject(controller) {|app,ware| ware.call(app)}

data/lib/rocketio/controller.rb

@@ -2,7 +2,7 @@ module RocketIO
   class Controller
     extend Forwardable
 
-    def_delegators :'self.class', :url, :api, :dirname, :parameters_policy
+    def_delegators :'self.class', :url, :api, :dirname, :path_params_expected
     def_delegators :request, :session, :request_method
     def_delegators RocketIO, :environment
     def_delegators RocketIO, :indifferent_params, :indifferent_hash, :mime_type
@@ -15,10 +15,9 @@ module RocketIO
       def_delegators RocketIO, :"#{env}?"
     end
 
-    def initialize requested_method = RocketIO::INDEX_METHOD, path_params = RocketIO::EMPTY_ARRAY, env = nil
-      @__requested_method__ = requested_method
+    def initialize requested_method = RocketIO::INDEX_METHOD, path_params = RocketIO::EMPTY_ARRAY
+      @__requested_method__ = requested_method.to_sym
       @__path_params_array__ = path_params.freeze
-      @__env__ = env if env
     end
 
     # call requested method
@@ -26,35 +25,35 @@ module RocketIO
     # @param  [Hash] env
     # @return [Rack::Response]
     #
-    def call env
+    def call env, params: nil
       @__env__ = env
+      @__params__ = params if params
       catch :__response__ do
 
         api[requested_method] || error(501)
 
         if error_handlers[500]
           begin
-            __call__(env)
+            __call__
           rescue Exception => e
             error(500, e)
           end
         else
-          __call__(env)
+          __call__
         end
       end
     end
 
     private
-    def __call__ env
+    def __call__
 
       validate_or_request_authentication_if_needed
       validate_or_request_authorization_if_needed
-      validate_parameters
 
       __run__ proc {
         invoke_before_filter
         invoke_around_filter proc {
-          response.body = public_send(requested_method, *path_params_array)
+          response.body = public_send(requested_method, *requested_method_arguments)
         }
         invoke_after_filter
       }
@@ -65,6 +64,10 @@ module RocketIO
         response.body ||= RocketIO::EMPTY_ARRAY
       end
 
+      if env[RocketIO::HTTP_ACCEPT] == RocketIO::APPLICATION_JSON
+        response[RocketIO::CONTENT_TYPE] = RocketIO::APPLICATION_JSON
+      end
+
       response.finish
     end
 
@@ -76,20 +79,23 @@ module RocketIO
       @__env__
     end
 
-    def validate_parameters
-
-      if path_params_array.size >= api[requested_method][:parameters_policy][:min]
-        return if api[requested_method][:parameters_policy][:max] == :* ||
-          path_params_array.size <= api[requested_method][:parameters_policy][:max]
-      end
-
-      error(409)
-    end
-
     def requested_method
       @__requested_method__
     end
 
+    def requested_method_arguments
+      if api[requested_method][:params_accepted_as_last_argument?]
+        [
+          *path_params_array,
+          # creating a shallow params copy with symbolized keys
+          # cause Ruby does not accept string keys for keyword arguments
+          params.keys.each_with_object({}) {|k,o| o[k.to_sym] = params[k]}
+        ]
+      else
+        path_params_array
+      end
+    end
+
     def path_params_array
       @__path_params_array__
     end
@@ -105,7 +111,7 @@ module RocketIO
     end
 
     def params
-      @__params__ ||= indifferent_params(request.params)
+      @__params__ ||= indifferent_params(json? ? __parse_json_body__ : request.params)
     end
 
     def request
@@ -250,13 +256,11 @@ module RocketIO
       return if self == RocketIO::Controller
       return unless public_instance_methods(false).include?(meth)
 
-      parameters = instance_method(meth).parameters
+      params, path_params = instance_method(meth).parameters.partition {|p| p[0] =~ /\Akey/}
 
       api[meth] = {
-        # api methods should be called with a predetermined set of parameters
-        # so setting an appropriate policy for just defined method based on its parameters.
-        path_params: RocketIO.path_params(parameters).freeze,
-        parameters_policy: RocketIO.parameters_policy(parameters).freeze
+        path_params: RocketIO.path_params(path_params).freeze,
+        params_accepted_as_last_argument?: params.any?,
       }
     end
 

data/lib/rocketio/controller/error_handlers.rb

@@ -73,17 +73,6 @@ module RocketIO
       RocketIO.error_renderer(404, xhr?, env: env)
     end
 
-    # 409: Wrong number of arguments received
-    error 409 do
-      RocketIO.error_renderer(409, xhr?, {
-        url: url,
-        controller: self.class.to_s,
-        requested_method: requested_method,
-        expected: api[requested_method][:parameters_policy],
-        received: path_params_array
-      })
-    end
-
     # 501: Not Implemented
     error 501 do
       RocketIO.error_renderer(501, xhr?, {

data/lib/rocketio/controller/helpers.rb

@@ -73,6 +73,16 @@ module RocketIO
       env[RocketIO::HTTP_X_REQUESTED_WITH] == RocketIO::XML_HTTP_REQUEST
     end
 
+    def json?
+      # using regex because Content-Type may look like "application/json;charset=UTF-8"
+      # TODO: consider using Regexp#match? on Ruby 2.4
+      env[HTTP_CONTENT_TYPE] =~ RocketIO::APPLICATION_JSON_REGEXP
+    end
+
+    def __parse_json_body__
+      JSON.parse(env[RACK_INPUT].read)
+    end
+
     # switch controller and halt with returned response.
     # any arguments will be passed to requested method.
     #

data/lib/rocketio/controller/response.rb

@@ -59,6 +59,10 @@ module RocketIO
       if drop_body?
         close
         self.body = EMPTY_ARRAY
+      else
+        if headers[CONTENT_TYPE] == APPLICATION_JSON
+          self.body = [self.body.to_json]
+        end
       end
 
       [status.to_i, headers, self.body]

data/lib/rocketio/util.rb

@@ -31,7 +31,7 @@ module RocketIO
   #
   # @param [Array] parameters
   # @return [Array]
-  def parameters_policy parameters
+  def path_params_expected parameters
     min, max = 0, parameters.size
 
     unlimited = false

data/lib/rocketio/version.rb

@@ -1,3 +1,3 @@
 module RocketIO
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/test/error_handlers_test.rb

@@ -32,40 +32,6 @@ spec :ErrorHandlers do
     end
   end
 
-  context 'Parameters Error' do
-
-    it 'uses default handler' do
-      app mock_app(mock_controller {
-        def index; end
-      })
-      get :x
-      assert(last_response.status) == 409
-      assert(last_response.body) =~ /wrong arguments/i
-    end
-
-    it 'uses custom handler' do
-      app mock_app(mock_controller {
-        def index; end
-        error 409 do
-          'noway'
-        end
-      })
-      get :x
-      assert(last_response.status) == 409
-      assert(last_response.body) == 'noway'
-    end
-
-    it 'can be triggered manually' do
-      called = false
-      app mock_app(mock_controller {
-        define_method(:index) {called = true; error(409)}
-      })
-      get
-      assert(called) == true
-      assert(last_response.status) == 409
-    end
-  end
-
   context '500: Fatal Error' do
 
     it 'raises when no handler defined' do

data/test/json_body.rb

@@ -0,0 +1,13 @@
+require 'setup'
+
+spec 'JSON body and params' do
+  it 'is parsing JSON body if request Content-Type contains "application/json"' do
+    app mock_controller {
+      def index; params[:x] end
+    }
+    env[RocketIO::RACK_INPUT] = StringIO.new({x: :y}.to_json)
+    header['Content-Type'] = 'application/json'
+    get
+    assert(last_response.body) == 'y'
+  end
+end

data/test/keyword_arguments.rb

@@ -0,0 +1,11 @@
+require 'setup'
+
+spec :keyword_arguments do
+  it 'is accepting params as last argument' do
+    app mock_controller {
+      def index a, b:; a + b end
+    }
+    get :a, b: :b
+    assert(last_response.body) == 'ab'
+  end
+end

data/test/response_test.rb

@@ -116,4 +116,23 @@ spec RocketIO::Response do
     get
     assert(last_response).is_ok_with_body ''
   end
+
+  it "sets Content-Type to application/json when request's Accept header is application/json" do
+    app mock_controller {
+      def index; end
+    }
+    header['Accept'] = 'application/json'
+    get
+    assert(last_response.headers['Content-Type']) == 'application/json'
+  end
+
+  it "responds with a JSON body when request's Accept header is application/json" do
+    body = {x: :y}
+    app mock_controller {
+      define_method(:index) {body}
+    }
+    header['Accept'] = 'application/json'
+    get
+    assert(last_response.body) == body.to_json
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocketio
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Slee Woo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-25 00:00:00.000000000 Z
+date: 2016-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -174,7 +174,6 @@ files:
 - lib/rocketio/controller/token_auth.rb
 - lib/rocketio/controller/websocket.rb
 - lib/rocketio/error_templates/404.html
-- lib/rocketio/error_templates/409.html
 - lib/rocketio/error_templates/501.html
 - lib/rocketio/error_templates/layout.html
 - lib/rocketio/exceptions.rb
@@ -194,6 +193,8 @@ files:
 - test/filters_test.rb
 - test/halt_test.rb
 - test/helpers_test.rb
+- test/json_body.rb
+- test/keyword_arguments.rb
 - test/middleware_test.rb
 - test/redirect_test.rb
 - test/render/b.erb
@@ -241,5 +242,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: '["rocketio-0.2.1", "Simple, fast, scalable web framework for Ruby"]'
+summary: '["rocketio-0.3.0", "Simple, fast, scalable web framework for Ruby"]'
 test_files: []

data/lib/rocketio/error_templates/409.html

@@ -1,11 +0,0 @@
-<h1>409: Wrong arguments</h1>
-<h3>
-  <b>{{url}}</b> URL resolved to <b>{{controller}}#{{requested_method}}</b> method
-  but it was called with wrong arguments.
-  <div>
-    Expected: {min: {{expected.min}}, max: {{expected.max}}}
-  </div>
-  <div>
-    Received: {{received}}
-  </div>
-</h3>