kenji 1.1.1 → 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf14e401da97852b1581ed7c36fecb4ca5730150
+  data.tar.gz: 640b48b7bd7caaedd92c7a7071c74b09917c8cb2
+SHA512:
+  metadata.gz: ec8185bb579998a5108aa4059d7c229500fb0340ef098c5888897d76a3e66166939d1e99052f0071b9fae161c12d5675c9f44747a5753a053bfed08b8b8dbe4f
+  data.tar.gz: 8074e6d539c044abbb5bc031cb6f9a3c5978ed81440ea3482574f26663ff08e785b591f9458c60835379b4cc49a86ac814ef4971da4e9885b3f216189f78faef

data/.gitignore

@@ -1,2 +1 @@
 pkg
-Gemfile.lock

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    kenji (1.1.1)
+      json
+      rack (~> 1.5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    inifile (2.0.2)
+    json (1.8.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.3)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  inifile
+  kenji!
+  rack-test
+  rake
+  rspec

data/README.md

@@ -100,12 +100,23 @@ And already, your app is ready to go:
 
 ## Changelog
 
+#### 1.1.2
+
+- The `respond_raw` method allows responding with raw data, instead of the
+  default which serializes the response as a JSON object.
+- Supports PATCH requests natively.
+- Remove support for `auto_cors`. Instead of having Kenji implement it
+  automatically, use a middleware like [Rack::Cors][rack-cors] which does
+  a better job than the barebones implementation in Kenji does.
+
+[rack-cors]: https://github.com/cyu/rack-cors
+
 #### 1.1.1
 
-- No longer catching ArgumentErrors when calling the block for a route.  This
+- No longer catching ArgumentErrors when calling the block for a route. This
   fixes a bug where Kenji incorrectly responds with a 404 when the block is
   passed the wrong number of arguments.
-- Fixed logic for matching a pass.  the path now must match the pass exactly
+- Fixed logic for matching a pass. the path now must match the pass exactly
   whereas before the pass would match if any subset of the path matched the
   pass.
 

data/lib/kenji/controller.rb

@@ -35,7 +35,10 @@ module Kenji
       route(:delete, path, &block)
     end
 
-    # TODO: figure out whether I want PATCH, OPTIONS, HEAD
+    # Route PATCH
+    def self.patch(path, &block)
+      route(:patch, path, &block)
+    end
 
     # Route all methods for given path
     def self.all(path, &block)

data/lib/kenji/version.rb

@@ -1,4 +1,4 @@
 module Kenji
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end
 

data/lib/kenji.rb

@@ -27,10 +27,6 @@ module Kenji
     #
     # `options` is an options hash that accepts the following keys:
     #
-    #   :auto_cors => true | false
-    #
-    #     automatically deal with CORS / Access-Control
-    #
     #   :directory => String (path)
     #     
     #     this is the preferred way of setting the root directory, when
@@ -71,7 +67,6 @@ module Kenji
       options[:directory] = File.expand_path(root) if root
       
       @options = {
-        auto_cors: true,
         catch_exceptions: true,
         root_controller: nil,
         directory: File.expand_path(Dir.getwd),
@@ -86,8 +81,6 @@ module Kenji
     #
     def call
 
-      auto_cors if @options[:auto_cors]
-
       catch(:KenjiRespondControlFlowInterrupt) do
         path = @env['PATH_INFO']
 
@@ -100,7 +93,8 @@ module Kenji
         method = @env['REQUEST_METHOD'].downcase.to_sym
 
         segments = path.split('/')
-        segments = segments.unshift('') unless segments.first == ''    # ensure existence of leading /'s empty segment
+        # ensure existence of leading /'s empty segment
+        segments = segments.unshift('') unless segments.first == ''
 
         if @options[:root_controller]
           controller = controller_instance(@options[:root_controller])
@@ -111,7 +105,8 @@ module Kenji
           acc = ''; out = '', success = false
           while head = segments.shift
             acc = "#{acc}/#{head}"
-            if controller = controller_for(acc)                   # if we have a valid controller 
+            # if we have a valid controller 
+            if controller = controller_for(acc)
               subpath = '/'+segments.join('/')
               out = controller.call(method, subpath).to_json
               success = true
@@ -126,21 +121,12 @@ module Kenji
       end
     rescue Exception => e
       raise e unless @options[:catch_exceptions]
-      @stderr.puts e.inspect                                    # log exceptions
+      # log exceptions
+      @stderr.puts e.inspect
       e.backtrace.each {|b| @stderr.puts "  #{b}" }
       response_500
     end
 
-    # 500 error
-    def response_500
-      [500, @headers, [{status: 500, message: 'Something went wrong...'}.to_json]]
-    end
-
-    # 404 error
-    def response_404
-      [404, @headers, [{status: 404, message: 'Not found!'}.to_json]]
-    end
-
 
 
     # Methods for users!
@@ -180,33 +166,35 @@ module Kenji
     #
     def respond(code, message, hash={})
       @status = code
-      response = {            # default structure. TODO: figure out if i really want to keep this 
-        :status => code,
-        :message => message
+      response = {            # default structure.
+        status: code,
+        message: message,
       }.merge(hash)
       throw(:KenjiRespondControlFlowInterrupt, [@status, @headers, [response.to_json]])
     end
 
+    # Respond with raw bytes
+    #
+    # `data` can either be a string or an IO object.
+    #
+    def respond_raw(status = 200, data)
+      @status = status
+      body = data.is_a?(IO) ? data : [data]
+      throw(:KenjiRespondControlFlowInterrupt, [@status, @headers, data])
+    end
 
 
     # Private methods
     private
 
-    # Deals with silly HTTP CORS Access-Control restrictions by automatically
-    # allowing all requests.
-    #
-    def auto_cors
-      origin = env['HTTP_ORIGIN']
-      header 'Access-Control-Allow-Origin' => origin if origin
-
-      if env['REQUEST_METHOD'] == 'OPTIONS'
-        header 'Access-Control-Allow-Methods' => 'OPTIONS, GET, POST, PUT, DELETE'
+    # 500 error
+    def response_500
+      [500, @headers, [{status: 500, message: 'Something went wrong...'}.to_json]]
+    end
 
-        if requested_headers = env['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']
-          header 'Access-Control-Allow-Headers' => requested_headers
-        end
-        respond(200, 'CORS is allowed.')
-      end
+    # 404 error
+    def response_404
+      [404, @headers, [{status: 404, message: 'Not found!'}.to_json]]
     end
 
     # Will attempt to fetch the controller, and verify that it is a implements
@@ -227,7 +215,10 @@ module Kenji
     #
     def controller_instance(controller_class)
       # ensure protocol compliance
-      return unless controller_class.method_defined?(:call) && controller_class.instance_method(:call).arity == 2
+      unless (controller_class.method_defined?(:call) &&
+              controller_class.instance_method(:call).arity == 2)
+        return
+      end
       controller = controller_class.new
       controller.kenji = self if controller.respond_to?(:kenji=)
       return controller if controller

data/spec/1/controllers/main.rb

@@ -21,8 +21,22 @@ class MainController < Kenji::Controller
     {status:1337}
   end
 
+  patch '/' do
+    {status:1337}
+  end
+
   get '/respond' do
     kenji.respond(123, 'hello')
     raise # never called
   end
+
+  get '/respond-raw' do
+    kenji.respond_raw('hello raw')
+    raise # never called
+  end
+
+  get '/respond-io' do
+    kenji.respond_raw(123, StringIO.new('hello io'))
+    raise # never called
+  end
 end

data/spec/kenji_spec.rb

@@ -51,7 +51,7 @@ describe Kenji::Kenji, 'expected responses' do
       last_response.body.should == expected_response
     end
 
-    [:post, :put, :delete].each do |method|
+    [:post, :put, :delete, :patch].each do |method|
 
       it "should route a #{method.to_s.upcase} to a defined #{method.to_s} call" do
         send(method, '/main')
@@ -74,19 +74,18 @@ describe Kenji::Kenji, 'expected responses' do
       last_response.status.should == 123
     end
 
-    it 'should automatically allow CORS for simple requests' do
-      header 'Origin', 'foo'
-      get '/main/hello'
-      last_response.header['Access-Control-Allow-Origin'].should == 'foo'
+    it 'should use respond immediately with kenji.respond_raw' do
+      get '/main/respond-raw'
+      expected_response = 'hello raw'
+      last_response.body.should == expected_response
+      last_response.status.should == 200
     end
 
-    it 'should automatically allow CORS for complex requests' do
-      header 'Origin', 'foo'
-      header 'Access-Control-Request-Headers', 'Bar'
-      options '/main/hello'
-      last_response.header['Access-Control-Allow-Origin'].should == 'foo'
-      last_response.header['Access-Control-Allow-Methods'].should == 'OPTIONS, GET, POST, PUT, DELETE'
-      last_response.header['Access-Control-Allow-Headers'].should == 'Bar'
+    it 'should use respond immediately with kenji.respond_raw is passed an IO' do
+      get '/main/respond-io'
+      expected_response = 'hello io'
+      last_response.body.should == expected_response
+      last_response.status.should == 123
     end
 
   end

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: kenji
 version: !ruby/object:Gem::Version
-  version: 1.1.1
-  prerelease: 
+  version: 1.1.2
 platform: ruby
 authors:
 - Kenneth Ballenegger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-27 00:00:00.000000000 Z
+date: 2014-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A lightweight Ruby web framework.
@@ -99,8 +88,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -132,27 +122,26 @@ files:
 - spec/kenji_spec.rb
 homepage: https://github.com/kballenegger/kenji
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Kenji
 test_files:
 - spec/1/controllers/main.rb