ably-em-http-request 1.1.8

data/examples/digest_auth/server.rb

@@ -0,0 +1,28 @@
+require 'webrick'
+
+include WEBrick
+
+config = { :Realm => 'DigestAuth_REALM' }
+
+htdigest = WEBrick::HTTPAuth::Htdigest.new 'my_password_file'
+htdigest.set_passwd config[:Realm], 'digest_username', 'digest_password'
+htdigest.flush
+
+config[:UserDB] = htdigest
+
+digest_auth = WEBrick::HTTPAuth::DigestAuth.new config
+
+class TestServlet < HTTPServlet::AbstractServlet
+  def do_GET(req, res)
+    @options[0][:authenticator].authenticate req, res
+    res.body = "You are authenticated to see the super secret data\n"
+  end
+end
+
+s = HTTPServer.new(:Port => 3000)
+s.mount('/', TestServlet, {:authenticator => digest_auth})
+trap("INT") do
+  File.delete('my_password_file')
+  s.shutdown
+end
+s.start

data/examples/fetch.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'eventmachine'
+require '../lib/em-http'
+
+urls = ARGV
+if urls.size < 1
+  puts "Usage: #{$0} <url> <url> <...>"
+  exit
+end
+
+pending = urls.size
+
+EM.run do
+  urls.each do |url|
+    http = EM::AblyHttpRequest::HttpRequest.new(url).get
+    http.callback {
+      puts "#{url}\n#{http.response_header.status} - #{http.response.length} bytes\n"
+      puts http.response
+
+      pending -= 1
+      EM.stop if pending < 1
+    }
+    http.errback {
+      puts "#{url}\n" + http.error
+
+      pending -= 1
+      EM.stop if pending < 1
+    }
+  end
+end

data/examples/fibered-http.rb

@@ -0,0 +1,51 @@
+$: << 'lib' << '../lib'
+
+require 'eventmachine'
+require 'em-http'
+require 'fiber'
+
+# Using Fibers in Ruby 1.9 to simulate blocking IO / IO scheduling
+# while using the async EventMachine API's
+
+def async_fetch(url)
+  f = Fiber.current
+  http = EventMachine::AblyHttpRequest::HttpRequest.new(url, :connect_timeout => 10, :inactivity_timeout => 20).get
+
+  http.callback { f.resume(http) }
+  http.errback  { f.resume(http) }
+
+  Fiber.yield
+
+  if http.error
+    p [:HTTP_ERROR, http.error]
+  end
+
+  http
+end
+
+EventMachine.run do
+  Fiber.new{
+
+    puts "Setting up HTTP request #1"
+    data = async_fetch('http://0.0.0.0/')
+    puts "Fetched page #1: #{data.response_header.status}"
+
+    puts "Setting up HTTP request #2"
+    data = async_fetch('http://www.yahoo.com/')
+    puts "Fetched page #2: #{data.response_header.status}"
+
+    puts "Setting up HTTP request #3"
+    data = async_fetch('http://non-existing.domain/')
+    puts "Fetched page #3: #{data.response_header.status}"
+
+    EventMachine.stop
+  }.resume
+end
+
+puts "Done"
+
+#  Setting up HTTP request #1
+#  Fetched page #1: 302
+#  Setting up HTTP request #2
+#  Fetched page #2: 200
+#  Done

data/examples/multi.rb

@@ -0,0 +1,25 @@
+$: << '../lib' << 'lib'
+
+require 'eventmachine'
+require 'em-http'
+
+EventMachine.run {
+  multi = EventMachine::AblyHttpRequest::MultiRequest.new
+
+  reqs = [
+    'http://google.com/',
+    'http://google.ca:81/'
+  ]
+
+  reqs.each_with_index do |url, idx|
+    http = EventMachine::AblyHttpRequest::HttpRequest.new(url, :connect_timeout => 1)
+    req = http.get
+    multi.add idx, req
+  end
+
+  multi.callback  do
+    p multi.responses[:callback].size
+    p multi.responses[:errback].size
+    EventMachine.stop
+  end
+}

data/examples/oauth-tweet.rb

@@ -0,0 +1,35 @@
+$: << 'lib' << '../lib'
+
+require 'em-http'
+require 'em-http/middleware/oauth'
+require 'em-http/middleware/json_response'
+
+require 'pp'
+
+OAuthConfig = {
+  :consumer_key     => '',
+  :consumer_secret  => '',
+  :access_token     => '',
+  :access_token_secret => ''
+}
+
+EM.run do
+  # automatically parse the JSON response into a Ruby object
+  EventMachine::AblyHttpRequest::HttpRequest.use EventMachine::AblyHttpRequest::Middleware::JSONResponse
+
+  # sign the request with OAuth credentials
+  conn = EventMachine::AblyHttpRequest::HttpRequest.new('http://api.twitter.com/1/statuses/home_timeline.json')
+  conn.use EventMachine::AblyHttpRequest::Middleware::OAuth, OAuthConfig
+
+  http = conn.get
+  http.callback do
+    pp http.response
+    EM.stop
+  end
+
+  http.errback do
+    puts "Failed retrieving user stream."
+    pp http.response
+    EM.stop
+  end
+end

data/examples/socks5.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'eventmachine'
+require '../lib/em-http'
+
+EM.run do
+  # Establish a SOCKS5 tunnel via SSH
+  # ssh -D 8000 some_remote_machine
+
+  connection_options = {:proxy => {:host => '127.0.0.1', :port => 8000, :type => :socks5}}
+  http = EM::AblyHttpRequest::HttpRequest.new('http://igvita.com/', connection_options).get :redirects => 2
+
+  http.callback {
+    puts "#{http.response_header.status} - #{http.response.length} bytes\n"
+    puts http.response
+    EM.stop
+  }
+
+  http.errback {
+    puts "Error: " + http.error
+    puts http.inspect
+    EM.stop
+  }
+end

data/lib/em/io_streamer.rb

@@ -0,0 +1,51 @@
+require 'em/streamer'
+
+# similar to EventMachine::FileStreamer, but for any IO object
+module EventMachine
+  module AblyHttpRequest
+    class IOStreamer
+      include Deferrable
+      CHUNK_SIZE = 16384
+
+      # @param [EventMachine::Connection] connection
+      # @param [IO] io Data source
+      # @param [Integer] Data size
+      #
+      # @option opts [Boolean] :http_chunks (false) Use HTTP 1.1 style chunked-encoding semantics.
+      def initialize(connection, io, opts = {})
+        @connection = connection
+        @io = io
+        @http_chunks = opts[:http_chunks]
+
+        @buff = String.new
+        @io.binmode if @io.respond_to?(:binmode)
+        stream_one_chunk
+      end
+
+    private
+
+      # Used internally to stream one chunk at a time over multiple reactor ticks
+      # @private
+      def stream_one_chunk
+        loop do
+          if @io.eof?
+            @connection.send_data "0\r\n\r\n" if @http_chunks
+            succeed
+            break
+          end
+
+          if @connection.respond_to?(:get_outbound_data_size) && (@connection.get_outbound_data_size > FileStreamer::BackpressureLevel)
+            EventMachine::next_tick { stream_one_chunk }
+            break
+          end
+
+          if @io.read(CHUNK_SIZE, @buff)
+            @connection.send_data("#{@buff.length.to_s(16)}\r\n") if @http_chunks
+            @connection.send_data(@buff)
+            @connection.send_data("\r\n") if @http_chunks
+          end
+        end
+      end
+    end
+  end
+end

data/lib/em-http/client.rb

@@ -0,0 +1,343 @@
+require 'cookiejar'
+
+module EventMachine
+  module AblyHttpRequest
+
+
+    class HttpClient
+      include Deferrable
+      include HttpEncoding
+      include HttpStatus
+
+      TRANSFER_ENCODING="TRANSFER_ENCODING"
+      CONTENT_ENCODING="CONTENT_ENCODING"
+      CONTENT_LENGTH="CONTENT_LENGTH"
+      CONTENT_TYPE="CONTENT_TYPE"
+      LAST_MODIFIED="LAST_MODIFIED"
+      KEEP_ALIVE="CONNECTION"
+      SET_COOKIE="SET_COOKIE"
+      LOCATION="LOCATION"
+      HOST="HOST"
+      ETAG="ETAG"
+
+      CRLF="\r\n"
+
+      attr_accessor :state, :response, :conn
+      attr_reader   :response_header, :error, :content_charset, :req, :cookies
+
+      def initialize(conn, options)
+        @conn = conn
+        @req  = options
+
+        @stream    = nil
+        @headers   = nil
+        @cookies   = []
+        @cookiejar = CookieJar.new
+
+        reset!
+      end
+
+      def reset!
+        @response_header = HttpResponseHeader.new
+        @state = :response_header
+
+        @response = ''
+        @error = nil
+        @content_decoder = nil
+        @content_charset = nil
+      end
+
+      def last_effective_url; @req.uri; end
+      def redirects; @req.followed; end
+      def peer; @conn.peer; end
+
+      def connection_completed
+        @state = :response_header
+
+        head, body = build_request, @req.body
+        @conn.middleware.each do |m|
+          head, body = m.request(self, head, body) if m.respond_to?(:request)
+        end
+
+        send_request(head, body)
+      end
+
+      def on_request_complete
+        begin
+          @content_decoder.finalize! if @content_decoder
+        rescue HttpDecoders::DecoderError
+          on_error "Content-decoder error"
+        end
+
+        unbind
+      end
+
+      def continue?
+        @response_header.status == 100 && (@req.method == 'POST' || @req.method == 'PUT')
+      end
+
+      def finished?
+        @state == :finished || (@state == :body && @response_header.content_length.nil?)
+      end
+
+      def redirect?
+        @response_header.redirection? && @req.follow_redirect?
+      end
+
+      def unbind(reason = nil)
+        if finished?
+          if redirect?
+
+            begin
+              @conn.middleware.each do |m|
+                m.response(self) if m.respond_to?(:response)
+              end
+
+              # one of the injected middlewares could have changed
+              # our redirect settings, check if we still want to
+              # follow the location header
+              if redirect?
+                @req.followed += 1
+
+                @cookies.clear
+                @cookies = @cookiejar.get(@response_header.location).map(&:to_s) if @req.pass_cookies
+
+                @conn.redirect(self, @response_header.location)
+              else
+                succeed(self)
+              end
+
+            rescue => e
+              on_error(e.message)
+            end
+          else
+            succeed(self)
+          end
+
+        else
+          on_error(reason || 'connection closed by server')
+        end
+      end
+
+      def on_error(msg = nil)
+        @error = msg
+        fail(self)
+      end
+      alias :close :on_error
+
+      def stream(&blk); @stream = blk; end
+      def headers(&blk); @headers = blk; end
+
+      def normalize_body(body)
+        body.is_a?(Hash) ? form_encode_body(body) : body
+      end
+
+      def build_request
+        head    = @req.headers ? munge_header_keys(@req.headers) : {}
+
+        if @conn.connopts.http_proxy?
+          proxy = @conn.connopts.proxy
+          head['proxy-authorization'] = proxy[:authorization] if proxy[:authorization]
+        end
+
+        # Set the cookie header if provided
+        if cookie = head['cookie']
+          @cookies << encode_cookie(cookie) if cookie
+        end
+        head['cookie'] = @cookies.compact.uniq.join("; ").squeeze(";") unless @cookies.empty?
+
+        # Set connection close unless keepalive
+        if !@req.keepalive
+          head['connection'] = 'close'
+        end
+
+        # Set the Host header if it hasn't been specified already
+        head['host'] ||= encode_host
+
+        # Set the User-Agent if it hasn't been specified
+        if !head.key?('user-agent')
+          head['user-agent'] = 'EventMachine HttpClient'
+        elsif head['user-agent'].nil?
+          head.delete('user-agent')
+        end
+
+        # Set the Accept-Encoding header if none is provided
+        if !head.key?('accept-encoding') && req.compressed
+          head['accept-encoding'] = 'gzip, compressed'
+        end
+
+        # Set the auth from the URI if given
+        head['Authorization'] = @req.uri.userinfo.split(/:/, 2) if @req.uri.userinfo
+
+        head
+      end
+
+      def send_request(head, body)
+        body    = normalize_body(body)
+        file    = @req.file
+        query   = @req.query
+
+        # Set the Content-Length if file is given
+        head['content-length'] = File.size(file) if file
+
+        # Set the Content-Length if body is given,
+        # or we're doing an empty post or put
+        if body
+          head['content-length'] ||= body.respond_to?(:bytesize) ? body.bytesize : body.size
+        elsif @req.method == 'POST' or @req.method == 'PUT'
+          # wont happen if body is set and we already set content-length above
+          head['content-length'] ||= 0
+        end
+
+        # Set content-type header if missing and body is a Ruby hash
+        if !head['content-type'] and @req.body.is_a? Hash
+          head['content-type'] = 'application/x-www-form-urlencoded'
+        end
+
+        request_header ||= encode_request(@req.method, @req.uri, query, @conn.connopts)
+        request_header << encode_headers(head)
+        request_header << CRLF
+        @conn.send_data request_header
+
+        @req_body = body || (@req.file && Pathname.new(@req.file))
+        send_request_body unless @req.headers['expect'] == '100-continue'
+      end
+
+      def on_body_data(data)
+        if @content_decoder
+          begin
+            @content_decoder << data
+          rescue HttpDecoders::DecoderError
+            on_error "Content-decoder error"
+          end
+        else
+          on_decoded_body_data(data)
+        end
+      end
+
+      def on_decoded_body_data(data)
+        data.force_encoding @content_charset if @content_charset
+        if @stream
+          @stream.call(data)
+        else
+          @response << data
+        end
+      end
+
+      def request_body_pending?
+        !!@req_body
+      end
+
+      def send_request_body
+        return  if @req_body.nil?
+
+        if @req_body.is_a?(String)
+          @conn.send_data @req_body
+
+        elsif @req_body.is_a?(Pathname)
+          @conn.stream_file_data @req_body.to_path, http_chunks: false
+
+        elsif @req_body.respond_to?(:read) && @req_body.respond_to?(:eof?)   # IO or IO-like object
+          @conn.stream_data @req_body
+
+        else
+          raise "Don't know how to send request body: #{@req_body.inspect}"
+        end
+        @req_body = nil
+      end
+
+      def parse_response_header(header, version, status)
+        @response_header.raw = header
+        header.each do |key, val|
+          @response_header[key.upcase.gsub('-','_')] = val
+        end
+
+        @response_header.http_version = version.join('.')
+        @response_header.http_status  = status
+        @response_header.http_reason  = CODE[status] || 'unknown'
+
+        # invoke headers callback after full parse
+        # if one is specified by the user
+        @headers.call(@response_header) if @headers
+
+        unless @response_header.http_status and @response_header.http_reason
+          @state = :invalid
+          on_error "no HTTP response"
+          return
+        end
+
+        # add set-cookie's to cookie list
+        if @response_header.cookie && @req.pass_cookies
+          [@response_header.cookie].flatten.each {|cookie| @cookiejar.set(cookie, @req.uri)}
+        end
+
+        # correct location header - some servers will incorrectly give a relative URI
+        if @response_header.location
+          begin
+            location = Addressable::URI.parse(@response_header.location)
+            location.path = "/" if location.path.empty?
+
+            if location.relative?
+              location = @req.uri.join(location)
+            else
+              # if redirect is to an absolute url, check for correct URI structure
+              raise if location.host.nil?
+            end
+
+            @response_header[LOCATION] = location.to_s
+
+          rescue
+            on_error "Location header format error"
+            return
+          end
+        end
+
+        # Fire callbacks immediately after recieving header requests
+        # if the request method is HEAD. In case of a redirect, terminate
+        # current connection and reinitialize the process.
+        if @req.method == "HEAD"
+          @state = :finished
+          return
+        end
+
+        if @response_header.chunked_encoding?
+          @state = :chunk_header
+        elsif @response_header.content_length
+          @state = :body
+        else
+          @state = :body
+        end
+
+        if @req.decoding && decoder_class = HttpDecoders.decoder_for_encoding(response_header[CONTENT_ENCODING])
+          begin
+            @content_decoder = decoder_class.new do |s| on_decoded_body_data(s) end
+          rescue HttpDecoders::DecoderError
+            on_error "Content-decoder error"
+          end
+        end
+
+        # handle malformed header - Content-Type repetitions.
+        content_type = [response_header[CONTENT_TYPE]].flatten.first
+
+        if String.method_defined?(:force_encoding) && /;\s*charset=\s*(.+?)\s*(;|$)/.match(content_type)
+          @content_charset = Encoding.find($1.gsub(/^\"|\"$/, '')) rescue Encoding.default_external
+        end
+      end
+
+      class CookieJar
+        def initialize
+          @jar = ::CookieJar::Jar.new
+        end
+
+        def set string, uri
+          @jar.set_cookie(uri, string) rescue nil # drop invalid cookies
+        end
+
+        def get uri
+          uri = URI.parse(uri) rescue nil
+          uri ? @jar.get_cookies(uri) : []
+        end
+      end # CookieJar
+    end
+  end
+end

data/lib/em-http/core_ext/bytesize.rb

@@ -0,0 +1,6 @@
+# bytesize was introduced in 1.8.7+
+if RUBY_VERSION <= "1.8.6"
+  class String
+    def bytesize; self.size; end
+  end
+end