yajl-ruby 0.5.12 → 0.6.0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.6.0 (August 19th, 2009)
+* Added POST, PUT and DELETE support to Yajl::HttpStream
+** POST support initially contributed by jdg (http://github.com/jdg) - Although oortle (http://github.com/oortle) coded it up in a fork with it as well.
+
 ## 0.5.12 (July 31st, 2009)
 * Add another option that can be passed to Yajl::Encoder's constructor (:terminator) to allow the caller some control over
   when a full JSON string has been generated by the encoder. More information on it's use in the README

data/README.rdoc

@@ -180,7 +180,7 @@ Using EventMachine and you want to encode and send in chunks?
    #
    # Send our MOTD and status
    @encoder.encode(@motd) do |chunk|
-     if chunk.nil?
+     if chunk.nil? # got our terminator, encoding is done
        close_connection_after_writing
      else
        send_data(chunk)

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 5
-:patch: 12
+:minor: 6
+:patch: 0
 :major: 0

data/lib/yajl.rb

@@ -13,7 +13,7 @@ require 'yajl_ext'
 #
 # Ruby bindings to the excellent Yajl (Yet Another JSON Parser) ANSI C library.
 module Yajl
-  VERSION = "0.5.12"
+  VERSION = "0.6.0"
   
   class Parser
     # A helper method for parse-and-forget use-cases

data/lib/yajl/http_stream.rb

@@ -16,86 +16,112 @@ module Yajl
     ALLOWED_MIME_TYPES = ["application/json", "text/plain"]
     
     # Makes a basic HTTP GET request to the URI provided
-    # 1. a raw socket is opened to the server/host provided
-    # 2. the request is made using HTTP/1.0, Accept-encoding: gzip (deflate support coming soon, too)
-    # 3. the response is read until the end of the headers
-    # 4. the _socket itself_ is passed directly to Yajl, for direct parsing off the stream; As it's being received over the wire!
     def self.get(uri, opts = {}, &block)
-      user_agent = opts.has_key?('User-Agent') ? opts.delete(['User-Agent']) : "Yajl::HttpStream #{Yajl::VERSION}"
-      
-      socket = TCPSocket.new(uri.host, uri.port)
-      request = "GET #{uri.path}#{uri.query ? "?"+uri.query : nil} HTTP/1.1\r\n"
-      request << "Host: #{uri.host}\r\n"
-      request << "Authorization: Basic #{[uri.userinfo].pack('m')}\r\n" unless uri.userinfo.nil?
-      request << "User-Agent: #{user_agent}\r\n"
-      request << "Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\r\n"
-      request << "Connection: close\r\n"
-      encodings = []
-      encodings << "bzip2" if defined?(Yajl::Bzip2)
-      encodings << "gzip" if defined?(Yajl::Gzip)
-      encodings << "deflate" if defined?(Yajl::Deflate)
-      request << "Accept-Encoding: #{encodings.join(',')}\r\n" if encodings.any?
-      request << "Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\r\n"
-      request << "\r\n\r\n"
-      socket.write(request)
-      response_head = {}
-      response_head[:headers] = {}
-      
-      socket.each_line do |line|
-        if line == "\r\n" # end of the headers
-          break
-        else
-          header = line.split(": ")
-          if header.size == 1
-            header = header[0].split(" ")
-            response_head[:version] = header[0]
-            response_head[:code] = header[1].to_i
-            response_head[:msg] = header[2]
-            # this is the response code line
-          else
-            response_head[:headers][header[0]] = header[1].strip
-          end
+      request("GET", uri, opts, &block)
+    end
+
+    # Makes a basic HTTP POST request to the URI provided
+    def self.post(uri, body, opts = {}, &block)
+      request("POST", uri, opts.merge({:body => body}), &block)
+    end
+    
+    # Makes a basic HTTP PUT request to the URI provided
+    def self.put(uri, body, opts = {}, &block)
+      request("PUT", uri, opts.merge({:body => body}), &block)
+    end
+    
+    # Makes a basic HTTP DELETE request to the URI provided
+    def self.delete(uri, opts = {}, &block)
+      request("DELETE", uri, opts, &block)
+    end
+    
+    protected
+      def self.request(method, uri, opts = {}, &block)
+        user_agent = opts.has_key?('User-Agent') ? opts.delete(['User-Agent']) : "Yajl::HttpStream #{Yajl::VERSION}"
+        if method == "POST" || method == "PUT"
+          content_type = opts.has_key?('Content-Type') ? opts.delete(['Content-Type']) : "application/x-www-form-urlencoded"
+          body = opts.delete(:body)
         end
-      end
-      parser = Yajl::Parser.new(opts)
-      if response_head[:headers]["Transfer-Encoding"] == 'chunked'
-        if block_given?
-          parser.on_parse_complete = block
-          chunkLeft = 0
-          while !socket.eof? && (size = socket.gets.hex)
-            next if size == 0
-            json = socket.read(size)
-            chunkLeft = size-json.size
-            if chunkLeft == 0
-              parser << json
+
+        socket = TCPSocket.new(uri.host, uri.port)
+        request = "#{method} #{uri.path}#{uri.query ? "?"+uri.query : nil} HTTP/1.1\r\n"
+        request << "Host: #{uri.host}\r\n"
+        request << "Authorization: Basic #{[uri.userinfo].pack('m').strip!}\r\n" unless uri.userinfo.nil?
+        request << "User-Agent: #{user_agent}\r\n"
+        request << "Accept: */*\r\n"
+        if method == "POST" || method == "PUT"
+          request << "Content-Length: #{body.length}\r\n"
+          request << "Content-Type: #{content_type}\r\n"
+        end
+        request << "Connection: close\r\n"
+        encodings = []
+        encodings << "bzip2" if defined?(Yajl::Bzip2)
+        encodings << "gzip" if defined?(Yajl::Gzip)
+        encodings << "deflate" if defined?(Yajl::Deflate)
+        request << "Accept-Encoding: #{encodings.join(',')}\r\n" if encodings.any?
+        request << "Accept-Charset: utf-8\r\n\r\n"
+        if method == "POST" || method == "PUT"
+          request << body
+        end
+        socket.write(request)
+        response_head = {}
+        response_head[:headers] = {}
+
+        socket.each_line do |line|
+          if line == "\r\n" # end of the headers
+            break
+          else
+            header = line.split(": ")
+            if header.size == 1
+              header = header[0].split(" ")
+              response_head[:version] = header[0]
+              response_head[:code] = header[1].to_i
+              response_head[:msg] = header[2]
+              # this is the response code line
             else
-              # received only part of the chunk, grab the rest
-              parser << socket.read(chunkLeft)
+              response_head[:headers][header[0]] = header[1].strip
             end
           end
-        else
-          raise Exception, "Chunked responses detected, but no block given to handle the chunks."
         end
-      else
-        content_type = response_head[:headers]["Content-Type"].split(';')
-        content_type = content_type.first
-        if ALLOWED_MIME_TYPES.include?(content_type)
-          case response_head[:headers]["Content-Encoding"]
-          when "gzip"
-            return Yajl::Gzip::StreamReader.parse(socket, opts)
-          when "deflate"
-            return Yajl::Deflate::StreamReader.parse(socket, opts.merge({:deflate_options => -Zlib::MAX_WBITS}))
-          when "bzip2"
-            return Yajl::Bzip2::StreamReader.parse(socket, opts)
+        parser = Yajl::Parser.new(opts)
+        if response_head[:headers]["Transfer-Encoding"] == 'chunked'
+          if block_given?
+            parser.on_parse_complete = block
+            chunkLeft = 0
+            while !socket.eof? && (size = socket.gets.hex)
+              next if size == 0
+              json = socket.read(size)
+              chunkLeft = size-json.size
+              if chunkLeft == 0
+                parser << json
+              else
+                # received only part of the chunk, grab the rest
+                parser << socket.read(chunkLeft)
+              end
+            end
           else
-            return Yajl::Parser.new(opts).parse(socket)
+            raise Exception, "Chunked responses detected, but no block given to handle the chunks."
           end
         else
-          raise InvalidContentType, "The response MIME type #{content_type}"
+          content_type = response_head[:headers]["Content-Type"].split(';')
+          content_type = content_type.first
+          if ALLOWED_MIME_TYPES.include?(content_type)
+            case response_head[:headers]["Content-Encoding"]
+            when "gzip"
+              return Yajl::Gzip::StreamReader.parse(socket, opts)
+            when "deflate"
+              return Yajl::Deflate::StreamReader.parse(socket, opts.merge({:deflate_options => -Zlib::MAX_WBITS}))
+            when "bzip2"
+              return Yajl::Bzip2::StreamReader.parse(socket, opts)
+            else
+              return Yajl::Parser.new(opts).parse(socket)
+            end
+          else
+            raise InvalidContentType, "The response MIME type #{content_type}"
+          end
         end
+      ensure
+        socket.close
       end
-    ensure
-      socket.close
-    end
   end
 end

data/spec/http/http_delete_spec.rb

@@ -0,0 +1,85 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+require 'yajl/bzip2'
+require 'yajl/gzip'
+require 'yajl/deflate'
+require 'yajl/http_stream'
+
+def parse_off_headers(io)
+  io.each_line do |line|
+    if line == "\r\n" # end of the headers
+      break
+    end
+  end
+end
+
+describe "Yajl HTTP DELETE request" do
+  before(:all) do
+    raw = File.new(File.expand_path(File.dirname(__FILE__) + '/fixtures/http.raw.dump'), 'r')
+    parse_off_headers(raw)
+    @template_hash = Yajl::Parser.parse(raw)
+    
+    raw.rewind
+    parse_off_headers(raw)
+    @template_hash_symbolized = Yajl::Parser.parse(raw, :symbolize_keys => true)
+    
+    @deflate = File.new(File.expand_path(File.dirname(__FILE__) + '/fixtures/http.deflate.dump'), 'r')
+    @gzip = File.new(File.expand_path(File.dirname(__FILE__) + '/fixtures/http.gzip.dump'), 'r')
+  end
+  
+  after(:each) do
+    @file_path = nil
+  end
+  
+  def prepare_mock_request_dump(format=:raw)
+    @request = File.new(File.expand_path(File.dirname(__FILE__) + "/fixtures/http.#{format}.dump"), 'r')
+    @uri = 'file://'+File.expand_path(File.dirname(__FILE__) + "/fixtures/http/http.#{format}.dump")
+    TCPSocket.should_receive(:new).and_return(@request)
+    @request.should_receive(:write)
+    @uri.should_receive(:host).at_least(2).times
+    @uri.should_receive(:port)
+    @uri.should_receive(:path)
+    @uri.should_receive(:query)
+    @uri.should_receive(:userinfo)
+  end
+  
+  it "should parse a raw response" do
+    prepare_mock_request_dump :raw
+    @template_hash.should == Yajl::HttpStream.delete(@uri)
+  end
+  
+  it "should parse a raw response and symbolize keys" do
+    prepare_mock_request_dump :raw
+    @template_hash_symbolized.should == Yajl::HttpStream.delete(@uri, :symbolize_keys => true)
+  end
+  
+  it "should parse a bzip2 compressed response" do
+    prepare_mock_request_dump :bzip2
+    @template_hash.should == Yajl::HttpStream.delete(@uri)
+  end
+  
+  it "should parse a bzip2 compressed response and symbolize keys" do
+    prepare_mock_request_dump :bzip2
+    @template_hash_symbolized.should == Yajl::HttpStream.delete(@uri, :symbolize_keys => true)
+  end
+  
+  it "should parse a deflate compressed response" do
+    prepare_mock_request_dump :deflate
+    @template_hash.should == Yajl::HttpStream.delete(@uri)
+  end
+  
+  it "should parse a deflate compressed response and symbolize keys" do
+    prepare_mock_request_dump :deflate
+    @template_hash_symbolized.should == Yajl::HttpStream.delete(@uri, :symbolize_keys => true)
+  end
+  
+  it "should parse a gzip compressed response" do
+    prepare_mock_request_dump :gzip
+    @template_hash.should == Yajl::HttpStream.delete(@uri)
+  end
+  
+  it "should parse a gzip compressed response and symbolize keys" do
+    prepare_mock_request_dump :gzip
+    @template_hash_symbolized.should == Yajl::HttpStream.delete(@uri, :symbolize_keys => true)
+  end
+end

data/spec/http/http_post_spec.rb

@@ -0,0 +1,86 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+require 'yajl/bzip2'
+require 'yajl/gzip'
+require 'yajl/deflate'
+require 'yajl/http_stream'
+
+def parse_off_headers(io)
+  io.each_line do |line|
+    if line == "\r\n" # end of the headers
+      break
+    end
+  end
+end
+
+describe "Yajl HTTP POST request" do
+  before(:all) do
+    raw = File.new(File.expand_path(File.dirname(__FILE__) + '/fixtures/http.raw.dump'), 'r')
+    parse_off_headers(raw)
+    @template_hash = Yajl::Parser.parse(raw)
+    
+    raw.rewind
+    parse_off_headers(raw)
+    @template_hash_symbolized = Yajl::Parser.parse(raw, :symbolize_keys => true)
+    
+    @deflate = File.new(File.expand_path(File.dirname(__FILE__) + '/fixtures/http.deflate.dump'), 'r')
+    @gzip = File.new(File.expand_path(File.dirname(__FILE__) + '/fixtures/http.gzip.dump'), 'r')
+    @body = "blah=foo&bar=baz"
+  end
+  
+  after(:each) do
+    @file_path = nil
+  end
+  
+  def prepare_mock_request_dump(format=:raw)
+    @request = File.new(File.expand_path(File.dirname(__FILE__) + "/fixtures/http.#{format}.dump"), 'r')
+    @uri = 'file://'+File.expand_path(File.dirname(__FILE__) + "/fixtures/http/http.#{format}.dump")
+    TCPSocket.should_receive(:new).and_return(@request)
+    @request.should_receive(:write)
+    @uri.should_receive(:host).at_least(2).times
+    @uri.should_receive(:port)
+    @uri.should_receive(:path)
+    @uri.should_receive(:query)
+    @uri.should_receive(:userinfo)
+  end
+  
+  it "should parse a raw response" do
+    prepare_mock_request_dump :raw
+    @template_hash.should == Yajl::HttpStream.post(@uri, @body)
+  end
+  
+  it "should parse a raw response and symbolize keys" do
+    prepare_mock_request_dump :raw
+    @template_hash_symbolized.should == Yajl::HttpStream.post(@uri, @body, :symbolize_keys => true)
+  end
+  
+  it "should parse a bzip2 compressed response" do
+    prepare_mock_request_dump :bzip2
+    @template_hash.should == Yajl::HttpStream.post(@uri, @body)
+  end
+  
+  it "should parse a bzip2 compressed response and symbolize keys" do
+    prepare_mock_request_dump :bzip2
+    @template_hash_symbolized.should == Yajl::HttpStream.post(@uri, @body, :symbolize_keys => true)
+  end
+  
+  it "should parse a deflate compressed response" do
+    prepare_mock_request_dump :deflate
+    @template_hash.should == Yajl::HttpStream.post(@uri, @body)
+  end
+  
+  it "should parse a deflate compressed response and symbolize keys" do
+    prepare_mock_request_dump :deflate
+    @template_hash_symbolized.should == Yajl::HttpStream.post(@uri, @body, :symbolize_keys => true)
+  end
+  
+  it "should parse a gzip compressed response" do
+    prepare_mock_request_dump :gzip
+    @template_hash.should == Yajl::HttpStream.post(@uri, @body)
+  end
+  
+  it "should parse a gzip compressed response and symbolize keys" do
+    prepare_mock_request_dump :gzip
+    @template_hash_symbolized.should == Yajl::HttpStream.post(@uri, @body, :symbolize_keys => true)
+  end
+end

data/spec/http/http_put_spec.rb

@@ -0,0 +1,86 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+require 'yajl/bzip2'
+require 'yajl/gzip'
+require 'yajl/deflate'
+require 'yajl/http_stream'
+
+def parse_off_headers(io)
+  io.each_line do |line|
+    if line == "\r\n" # end of the headers
+      break
+    end
+  end
+end
+
+describe "Yajl HTTP PUT request" do
+  before(:all) do
+    raw = File.new(File.expand_path(File.dirname(__FILE__) + '/fixtures/http.raw.dump'), 'r')
+    parse_off_headers(raw)
+    @template_hash = Yajl::Parser.parse(raw)
+    
+    raw.rewind
+    parse_off_headers(raw)
+    @template_hash_symbolized = Yajl::Parser.parse(raw, :symbolize_keys => true)
+    
+    @deflate = File.new(File.expand_path(File.dirname(__FILE__) + '/fixtures/http.deflate.dump'), 'r')
+    @gzip = File.new(File.expand_path(File.dirname(__FILE__) + '/fixtures/http.gzip.dump'), 'r')
+    @body = "blah=foo&bar=baz"
+  end
+  
+  after(:each) do
+    @file_path = nil
+  end
+  
+  def prepare_mock_request_dump(format=:raw)
+    @request = File.new(File.expand_path(File.dirname(__FILE__) + "/fixtures/http.#{format}.dump"), 'r')
+    @uri = 'file://'+File.expand_path(File.dirname(__FILE__) + "/fixtures/http/http.#{format}.dump")
+    TCPSocket.should_receive(:new).and_return(@request)
+    @request.should_receive(:write)
+    @uri.should_receive(:host).at_least(2).times
+    @uri.should_receive(:port)
+    @uri.should_receive(:path)
+    @uri.should_receive(:query)
+    @uri.should_receive(:userinfo)
+  end
+  
+  it "should parse a raw response" do
+    prepare_mock_request_dump :raw
+    @template_hash.should == Yajl::HttpStream.put(@uri, @body)
+  end
+  
+  it "should parse a raw response and symbolize keys" do
+    prepare_mock_request_dump :raw
+    @template_hash_symbolized.should == Yajl::HttpStream.put(@uri, @body, :symbolize_keys => true)
+  end
+  
+  it "should parse a bzip2 compressed response" do
+    prepare_mock_request_dump :bzip2
+    @template_hash.should == Yajl::HttpStream.put(@uri, @body)
+  end
+  
+  it "should parse a bzip2 compressed response and symbolize keys" do
+    prepare_mock_request_dump :bzip2
+    @template_hash_symbolized.should == Yajl::HttpStream.put(@uri, @body, :symbolize_keys => true)
+  end
+  
+  it "should parse a deflate compressed response" do
+    prepare_mock_request_dump :deflate
+    @template_hash.should == Yajl::HttpStream.put(@uri, @body)
+  end
+  
+  it "should parse a deflate compressed response and symbolize keys" do
+    prepare_mock_request_dump :deflate
+    @template_hash_symbolized.should == Yajl::HttpStream.put(@uri, @body, :symbolize_keys => true)
+  end
+  
+  it "should parse a gzip compressed response" do
+    prepare_mock_request_dump :gzip
+    @template_hash.should == Yajl::HttpStream.put(@uri, @body)
+  end
+  
+  it "should parse a gzip compressed response and symbolize keys" do
+    prepare_mock_request_dump :gzip
+    @template_hash_symbolized.should == Yajl::HttpStream.put(@uri, @body, :symbolize_keys => true)
+  end
+end

data/yajl-ruby.gemspec

@@ -1,12 +1,15 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{yajl-ruby}
-  s.version = "0.5.12"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Lopez", "Lloyd Hilaiel"]
-  s.date = %q{2009-07-31}
+  s.date = %q{2009-08-19}
   s.email = %q{seniorlopez@gmail.com}
   s.extensions = ["ext/extconf.rb"]
   s.extra_rdoc_files = [
@@ -80,7 +83,10 @@ Gem::Specification.new do |s|
      "spec/http/fixtures/http.deflate.dump",
      "spec/http/fixtures/http.gzip.dump",
      "spec/http/fixtures/http.raw.dump",
-     "spec/http/http_spec.rb",
+     "spec/http/http_delete_spec.rb",
+     "spec/http/http_get_spec.rb",
+     "spec/http/http_post_spec.rb",
+     "spec/http/http_put_spec.rb",
      "spec/json_gem_compatibility/compatibility_spec.rb",
      "spec/parsing/active_support_spec.rb",
      "spec/parsing/chunked_spec.rb",
@@ -156,7 +162,10 @@ Gem::Specification.new do |s|
   s.summary = %q{Ruby C bindings to the excellent Yajl JSON stream-based parser library.}
   s.test_files = [
     "spec/encoding/encoding_spec.rb",
-     "spec/http/http_spec.rb",
+     "spec/http/http_delete_spec.rb",
+     "spec/http/http_get_spec.rb",
+     "spec/http/http_post_spec.rb",
+     "spec/http/http_put_spec.rb",
      "spec/json_gem_compatibility/compatibility_spec.rb",
      "spec/parsing/active_support_spec.rb",
      "spec/parsing/chunked_spec.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yajl-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.5.12
+  version: 0.6.0
 platform: ruby
 authors: 
 - Brian Lopez
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-31 00:00:00 -07:00
+date: 2009-08-19 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -90,7 +90,10 @@ files:
 - spec/http/fixtures/http.deflate.dump
 - spec/http/fixtures/http.gzip.dump
 - spec/http/fixtures/http.raw.dump
-- spec/http/http_spec.rb
+- spec/http/http_delete_spec.rb
+- spec/http/http_get_spec.rb
+- spec/http/http_post_spec.rb
+- spec/http/http_put_spec.rb
 - spec/json_gem_compatibility/compatibility_spec.rb
 - spec/parsing/active_support_spec.rb
 - spec/parsing/chunked_spec.rb
@@ -184,12 +187,14 @@ requirements: []
 rubyforge_project: yajl-ruby
 rubygems_version: 1.3.5
 signing_key: 
-source: 
 specification_version: 3
 summary: Ruby C bindings to the excellent Yajl JSON stream-based parser library.
 test_files: 
 - spec/encoding/encoding_spec.rb
-- spec/http/http_spec.rb
+- spec/http/http_delete_spec.rb
+- spec/http/http_get_spec.rb
+- spec/http/http_post_spec.rb
+- spec/http/http_put_spec.rb
 - spec/json_gem_compatibility/compatibility_spec.rb
 - spec/parsing/active_support_spec.rb
 - spec/parsing/chunked_spec.rb