halcyon 0.5.3 → 0.5.4

data/lib/halcyon.rb

@@ -15,7 +15,7 @@ $:.unshift File.dirname(__FILE__)
 # 
 module Halcyon
   
-  VERSION = [0,5,3] unless defined?(Halcyon::VERSION)
+  VERSION = [0,5,4] unless defined?(Halcyon::VERSION)
   
   autoload :Application, 'halcyon/application'
   autoload :Client, 'halcyon/client'
@@ -81,5 +81,6 @@ Object.send(:include, Halcyon::Logging::Helpers)
 module Rack
   
   autoload :JSONP, 'rack/jsonp'
+  autoload :PostBodyContentTypeParsers, 'rack/post_body_content_type_parsers'
   
 end

data/lib/halcyon/application.rb

@@ -167,7 +167,7 @@ module Halcyon
       when String
         # pulled from URL, so camelize (from extlib) and symbolize first
         begin
-          Object.const_get(route[:controller].camel_case.to_sym).new(env)
+          Object.full_const_get(route[:controller].to_const_string).new(env)
         rescue NameError => e
           raise NotFound.new
         end

data/lib/halcyon/client.rb

@@ -43,8 +43,11 @@ module Halcyon
     
     USER_AGENT = "JSON/#{JSON::VERSION} Compatible (en-US) Halcyon::Client/#{Halcyon.version}".freeze
     CONTENT_TYPE = "application/x-www-form-urlencoded".freeze
+    ACCEPT = "application/json, */*".freeze
+    
     DEFAULT_OPTIONS = {
-      :raise_exceptions => false
+      :raise_exceptions => false,
+      :encode_post_body_as_json => false
     }
     
     attr_accessor :uri # The server URI
@@ -103,6 +106,7 @@ module Halcyon
     # except that it is not executed in a block.
     # 
     # The differences are purely semantic and of personal taste.
+    # 
     def initialize(uri, headers = {})
       self.uri = URI.parse(uri)
       self.headers = headers
@@ -112,21 +116,36 @@ module Halcyon
       end
     end
     
+    # Sets the option to raise exceptions when the response from the server is
+    # not a +200+ response.
+    # 
     def raise_exceptions!(setting = true)
       self.options[:raise_exceptions] = setting
     end
     
+    # Sets the option to encode the POST body as +application/json+ compatible.
+    # 
+    def encode_post_body_as_json!(setting = true)
+      if self.options[:encode_post_body_as_json] = setting
+        set_content_type "application/json"
+      else
+        set_content_type "application/x-www-form-urlencoded"
+      end
+    end
+    
     #--
     # Request Handling
     #++
     
     # Performs a GET request on the URI specified.
+    # 
     def get(uri, headers={})
       req = Net::HTTP::Get.new(uri)
       request(req, headers)
     end
     
     # Performs a POST request on the URI specified.
+    # 
     def post(uri, data = {}, headers={})
       req = Net::HTTP::Post.new(uri)
       req.body = format_body(data)
@@ -134,19 +153,21 @@ module Halcyon
     end
     
     # Performs a DELETE request on the URI specified.
+    # 
     def delete(uri, headers={})
       req = Net::HTTP::Delete.new(uri)
       request(req, headers)
     end
     
     # Performs a PUT request on the URI specified.
+    # 
     def put(uri, data = {}, headers={})
       req = Net::HTTP::Put.new(uri)
       req.body = format_body(data)
       request(req, headers)
     end
     
-  private
+    private
     
     # Performs an arbitrary HTTP request, receive the response, parse it with
     # JSON, and return it to the caller. This is a private method because the
@@ -160,9 +181,11 @@ module Halcyon
     # (defined in Halcyon::Exceptions) which all inherit from
     # +Halcyon::Exceptions+. It is up to the client to handle these
     # exceptions specifically.
+    # 
     def request(req, headers={})
       # set default headers
       req["User-Agent"] = USER_AGENT
+      req["Accept"] = ACCEPT
       req["Content-Type"] = CONTENT_TYPE unless req.body.nil?
       req["Content-Length"] = req.body unless req.body.nil?
       
@@ -171,8 +194,10 @@ module Halcyon
         req[header] = value
       end
       
-      # prepare and send HTTP request
-      res = Net::HTTP.start(self.uri.host, self.uri.port) {|http|http.request(req)}
+      # prepare and send HTTP/S request
+      serv = Net::HTTP.new(self.uri.host, self.uri.port)
+      prepare_server(serv) if private_methods.include?('prepare_server')
+      res = serv.start { |http| http.request(req) }
       
       # parse response
       # unescape just in case any problematic characters were POSTed through
@@ -192,9 +217,24 @@ module Halcyon
     
     # Formats the data of a POST or PUT request (the body) into an acceptable
     # format according to Net::HTTP for sending through as a Hash.
+    # 
     def format_body(data)
       data = {:body => data} unless data.is_a? Hash
-      Rack::Utils.build_query(data)
+      case CONTENT_TYPE
+      when "application/x-www-form-urlencoded"
+        Rack::Utils.build_query(data)
+      when "application/json"
+        data.to_json
+      else
+        raise ArgumentError.new("Unsupported Content-Type for POST body: #{CONTENT_TYPE}")
+      end
+    end
+    
+    # Sets the +CONTENT_TYPE+ to the appropriate type.
+    # 
+    def set_content_type(content_type)
+      self.class.send(:remove_const, :CONTENT_TYPE)
+      self.class.const_set(:CONTENT_TYPE, content_type.freeze)
     end
     
   end

data/lib/halcyon/client/ssl.rb

@@ -4,34 +4,10 @@ module Halcyon
   class Client
     private
     
-    def request(req, headers={})
-      # set default headers
-      req["Content-Type"] = CONTENT_TYPE
-      req["User-Agent"] = USER_AGENT
-      
-      # apply provided headers
-      self.headers.merge(headers).each do |(header, value)|
-        req[header] = value
-      end
-      
-      # prepare and send HTTPS request
-      serv = Net::HTTP.new(self.uri.host, self.uri.port)
+    # Sets the SSL-specific options for the Server.
+    # 
+    def prepare_server(serv)
       serv.use_ssl = true if self.uri.scheme == 'https'
-      res = serv.start {|http|http.request(req)}
-      
-      # parse response
-      body = JSON.parse(res.body).to_mash
-      
-      # handle non-successes
-      if self.options[:raise_exceptions] && !res.kind_of?(Net::HTTPSuccess)
-        raise self.class.const_get(Exceptions::HTTP_STATUS_CODES[body[:status]].tr(' ', '_').camel_case.gsub(/( |\-)/,'')).new
-      end
-      
-      # return response
-      body
-    rescue Halcyon::Exceptions::Base => e
-      # log exception if logger is in place
-      raise
     end
     
   end

data/lib/rack/jsonp.rb

@@ -31,7 +31,7 @@ module Rack
     # 
     def pad(callback, response, body = "")
       response.each{ |s| body << s }
-      "#{callback}(#{body})" 
+      "#{callback}(#{body})"
     end
     
   end

data/lib/rack/post_body_content_type_parsers.rb

@@ -0,0 +1,38 @@
+begin
+  require 'json'
+rescue LoadError => e
+  require 'json/pure'
+end
+
+module Rack
+  
+  # A Rack middleware for parsing POST/PUT body data when Content-Type is
+  # not one of the standard supported types, like <tt>application/json</tt>.
+  # 
+  class PostBodyContentTypeParsers
+    
+    # Constants
+    # 
+    CONTENT_TYPE = 'CONTENT_TYPE'.freeze
+    POST_BODY = 'rack.input'.freeze
+    FORM_INPUT = 'rack.request.form_input'.freeze
+    FORM_HASH = 'rack.request.form_hash'.freeze
+    
+    # Supported Content-Types
+    # 
+    APPLICATION_JSON = 'application/json'.freeze
+    
+    def initialize(app)
+      @app = app
+    end
+    
+    def call(env)
+      case env[CONTENT_TYPE]
+      when APPLICATION_JSON
+        env.update(FORM_HASH => JSON.parse(env[POST_BODY].read), FORM_INPUT => env[POST_BODY])
+      end
+      @app.call(env)
+    end
+    
+  end
+end

data/spec/halcyon/application_spec.rb

@@ -61,4 +61,9 @@ describe "Halcyon::Application" do
     body['body'].should == "Internal Server Error"
   end
   
+  it "should dispatch to controllers inside of modules" do
+    response = Rack::MockRequest.new(@app).get("/nested/tests")
+    response.status.should == 200
+  end
+  
 end

data/spec/halcyon/client_spec.rb

@@ -31,6 +31,21 @@ end
 # Tests
 #++
 
+module Halcyon
+  class Client
+    private
+    def prepare_server(serv)
+      class << serv
+        alias :request_without_header_inspection :request
+        def request(req, body = nil, &block)
+          $accept = req["Accept"]
+          request_without_header_inspection(req, body, &block)
+        end
+      end
+    end
+  end
+end
+
 describe "Halcyon::Client" do
   
   before do
@@ -55,7 +70,7 @@ describe "Halcyon::Client" do
     @client.get('/nonexistent/route')[:status].should == 404
     
     # tell it to raise exceptions
-    @client.raise_exceptions! true
+    @client.raise_exceptions!
     should.raise(Halcyon::Exceptions::NotFound) { @client.get('/nonexistent/route') }
     @client.get('/time')[:status].should == 200
   end
@@ -80,4 +95,30 @@ describe "Halcyon::Client" do
     response[:body].should == {'controller' => 'application', 'action' => 'returner', 'key' => "%todd"}
   end
   
+  it "should render the POST body with the correct content type, allowing application/json is set" do
+    body = {:key => "value"}
+    
+    # default behavior is to set the POST body to application/x-www-form-urlencoded
+    @client.send(:format_body, body) == "key=value"
+    @client.post('/returner', body)[:body][:key].should == "value"
+    
+    # tell it to send as application/json
+    @client.encode_post_body_as_json!
+    @client.send(:format_body, body).should == body.to_json
+    @client.post('/returner', body)[:body][:key].should == nil
+    # The server will not return the values from the POST body because it is
+    # not set to parse application/json values. Like your own apps, you must
+    # set it manually to accept this type of body encoding.
+    
+    # set it back to ensure that the change is reversed
+    @client.encode_post_body_as_json! false
+    @client.send(:format_body, body) == "key=value"
+    @client.post('/returner', body)[:body][:key].should == "value"
+  end
+  
+  it "should set the Accept header to the appropriate type" do
+    @client.get('/returner')[:status].should == 200
+    $accept.should == Halcyon::Client::ACCEPT
+  end
+  
 end

data/spec/rack/jsonp.rb

@@ -0,0 +1,31 @@
+app = lambda do |env|
+  [200, {'Content-Type' => 'text/plain'}, {'bar' => 'foo'}.to_json]
+end
+
+jsonp_app = Rack::Builder.new do
+  use Rack::JSONP
+  run app
+end
+
+describe "Rack::JSONP" do
+  
+  before do
+    @log = ''
+    @logger = Logger.new(StringIO.new(@log))
+    Halcyon.config.use do |c|
+      c[:logger] = @logger
+    end
+    @app = Halcyon::Runner.new
+  end
+  
+  it "should wrap the response body in the Javascript callback when provided" do
+    body = jsonp_app.call(Rack::MockRequest.env_for("/", :input => "foo=bar&callback=foo")).last
+    body.should == 'foo({"bar":"foo"})'
+  end
+  
+  it "should not change anything if no :callback param is provided" do
+    body = app.call(Rack::MockRequest.env_for("/", :input => "foo=bar")).last
+    body.should == {'bar' => 'foo'}.to_json
+  end
+  
+end

data/spec/rack/post_body_content_type_parsers_spec.rb

@@ -0,0 +1,37 @@
+app = lambda do |env|
+  request = Rack::Request.new(env)
+  [200, {'Content-Type' => 'text/plain'}, request.POST]
+end
+
+def env_for_post_with_headers(path, headers, body)
+  Rack::MockRequest.env_for(path, {:method => "POST", :input => body}.merge(headers))
+end
+
+describe "Rack::PostBodyContentTypeParsers" do
+  
+  before do
+    @log = ''
+    @logger = Logger.new(StringIO.new(@log))
+    Halcyon.config.use do |c|
+      c[:logger] = @logger
+    end
+    @app = Halcyon::Runner.new
+  end
+  
+  it "should handle requests with POST body Content-Type of application/json" do
+    parser = Rack::PostBodyContentTypeParsers.new(app)
+    env = env_for_post_with_headers('/', {'Content_Type'.upcase => 'application/json'}, {:body => "asdf", :status => "12"}.to_json)
+    
+    response_body = parser.call(env).last
+    
+    response_body['body'].should == "asdf"
+    response_body['status'].should == "12"
+  end
+  
+  it "should change nothing when the POST body content type isn't application/json" do
+    response_body = app.call(Rack::MockRequest.env_for("/", :input => "body=asdf&status=12")).last
+    response_body['body'].should == "asdf"
+    response_body['status'].should == "12"
+  end
+  
+end

data/spec/spec_helper.rb

@@ -85,6 +85,17 @@ class Resources < Application
   end
 end
 
+# Nested controller
+module Nested
+  class Tests < Application
+    
+    def index
+      ok
+    end
+    
+  end
+end
+
 # Models
 
 class Model
@@ -100,6 +111,7 @@ Halcyon.configurable_attr(:environment)
 Halcyon::Application.route do |r|
   r.resources :resources
   
+  r.match('/nested/tests').to(:controller => 'nested/tests', :action => 'index')
   r.match('/hello/:name').to(:controller => 'specs', :action => 'greeter')
   r.match('/:action').to(:controller => 'specs')
   r.match('/:controller/:action').to()

data/support/generators/halcyon/templates/runner.ru

@@ -5,4 +5,9 @@ $:.unshift(Halcyon.root/'lib')
 puts "(Starting in #{Halcyon.root})"
 
 Thin::Logging.silent = true if defined? Thin
+
+# Uncomment if you plan to allow clients to send requests with the POST body
+# Content-Type as application/json.
+# use Rack::PostBodyContentTypeParsers
+
 run Halcyon::Runner.new

data/support/generators/halcyon_flat/templates/runner.ru

@@ -5,4 +5,8 @@ puts "(Starting in #{Halcyon.root})"
 
 Thin::Logging.silent = true if defined? Thin
 
+# Uncomment if you plan to allow clients to send requests with the POST body
+# Content-Type as application/json.
+# use Rack::PostBodyContentTypeParsers
+
 run Halcyon::Runner.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: halcyon
 version: !ruby/object:Gem::Version 
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors: 
 - Matt Todd
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-28 00:00:00 -04:00
+date: 2008-09-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -85,6 +85,9 @@ files:
 - spec/halcyon/logging_spec.rb
 - spec/halcyon/router_spec.rb
 - spec/halcyon/runner_spec.rb
+- spec/rack
+- spec/rack/jsonp.rb
+- spec/rack/post_body_content_type_parsers_spec.rb
 - spec/spec_helper.rb
 - lib/halcyon
 - lib/halcyon/application
@@ -117,6 +120,7 @@ files:
 - lib/halcyon.rb
 - lib/rack
 - lib/rack/jsonp.rb
+- lib/rack/post_body_content_type_parsers.rb
 - support/generators
 - support/generators/halcyon
 - support/generators/halcyon/halcyon_generator.rb