Initial release

Author: dim

.gitignore

@@ -0,0 +1 @@
+spec/resty/

Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+gem "multi_json"
+gem "oj"
+gem "sinatra"
+
+group :test do
+  gem "rspec"
+  gem "thin"
+  gem "resty_test"
+end

Gemfile.lock

@@ -0,0 +1,42 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    daemons (1.1.9)
+    diff-lcs (1.1.3)
+    eventmachine (1.0.0)
+    excon (0.16.10)
+    multi_json (1.5.0)
+    oj (2.0.2)
+    rack (1.4.4)
+    rack-protection (1.3.2)
+      rack
+    resty_test (0.1.0)
+      excon
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    sinatra (1.3.3)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    thin (1.5.0)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  multi_json
+  oj
+  resty_test
+  rspec
+  sinatra
+  thin

README.markdown

@@ -0,0 +1,159 @@
+Name
+====
+
+lua-resty-http - Lua HTTP client driver for ngx_lua
+
+Example
+=======
+
+    server {
+      location /test {
+        content_by_lua '
+          local http   = require "resty.http"
+          local client = http:new()
+          client:set_timeout(1000) -- 1 sec
+
+          local ok, err = client:connect("checkip.amazonaws.com", 80)
+          if not ok then
+            ngx.say("failed to connect: ", err)
+            return
+          end
+
+          local res, err = client:request({ path = "/" })
+          if not res then
+            ngx.say("failed to retrieve: ", err)
+            return
+          end
+
+          -- close connection, or put it into the connection pool
+          if res.headers["connection"] == "close" then
+            local ok, err = client:close()
+            if not ok then
+              ngx.say("failed to close: ", err)
+              return
+            end
+          else
+            client:set_keepalive(0, 100)
+          end
+
+          if res.status >= 200 and res.status < 300 then
+            ngx.say("My IP is: " .. res.body)
+          else
+            ngx.say("Query returned a non-200 response: " .. res.status)
+          end
+        ';
+      }
+    }
+
+API
+===
+
+new
+---
+`syntax: client, err = http:new()`
+
+Creates a HTTP object.
+
+connect
+-------
+`syntax: ok, err = client:connect(host, port?, conf?)`
+
+Attempts to connect to the remote `host` and `port`. Port 80 is assumed, when no port is given.
+
+Before actually resolving the host name and connecting to the remote backend, this method will always look up the connection pool for matched idle connections created by previous calls of this method.
+
+An optional Lua `conf` table can be specified to declare various options:
+
+* `scheme`
+: Specifies a scheme, defaults to "http" or "https", depending on the port.
+* `path`
+: Specifies a default endpoint.
+
+request
+-------
+`syntax: res, err = client:request(opts?)`
+
+Attempts to retrieve data from a remote location.
+
+An optional Lua `opts` table can be specified to declare various options:
+
+* `method`
+: Specifies the request method, defaults to `'get'`.
+* `path`
+: Specifies the path, defaults to `'/'`.
+* `query`
+: Specifies query parameters. Accepts either a string or a Lua table.
+* `headers`
+: Specifies request headers. Accepts a Lua table.
+
+Returns a `res` object containing three attributes:
+
+* `res.status` (number)
+: The resonse status, e.g. 200
+* `res.headers` (table)
+: A Lua table with response headers
+* `res.body` (string)
+: The plain response body
+
+set_timeout
+----------
+`syntax: client:set_timeout(time)`
+
+Sets the timeout (in ms) protection for subsequent operations, including the `connect` method.
+
+set_keepalive
+------------
+`syntax: ok, err = client:set_keepalive(max_idle_timeout, pool_size)`
+
+Puts the current connection immediately into the ngx_lua cosocket connection pool.
+
+You can specify the max idle timeout (in ms) when the connection is in the pool and the maximal size of the pool every nginx worker process.
+
+In case of success, returns `1`. In case of errors, returns `nil` with a string describing the error.
+
+Only call this method in the place you would have called the `close` method instead. Calling this method will immediately turn the current connection into the `closed` state. Any subsequent operations other than `connect()` on the current object will return the `closed` error.
+
+get_reused_times
+----------------
+`syntax: times, err = client:get_reused_times()`
+
+This method returns the (successfully) reused times for the current connection. In case of error, it returns `nil` and a string describing the error.
+
+close
+-----
+`syntax: ok, err = client:close()`
+
+Closes the current connection and returns the status.
+
+In case of success, returns `1`. In case of errors, returns `nil` with a string describing the error.
+
+Licence
+=======
+
+Some code and documentation parts were (shamelessly) taken from [lua-resty-redis](https://github.com/agentzh/lua-resty-redis), MIT, Copyright by Yichun Zhang.
+
+Greatly inspired by [excon](https://github.com/geemus/excon), MIT, Copyright by Wesley Beary.
+
+This code is covered by MIT License.
+(The MIT License)
+
+Copyright (c) 2013 Black Square Media Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+include Rake::DSL
+
+require 'rspec/mocks/version'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default: run specs.'
+task :default => :spec

benchmark/nginx.conf

@@ -0,0 +1,56 @@
+worker_processes 1;
+events {
+  worker_connections 1024;
+}
+
+http {
+
+  lua_package_path  'lib/?.lua;;';
+
+  init_by_lua '
+    cjson = require("cjson")
+    http  = require("resty.http")
+  ';
+
+  server {
+    listen 1984;
+
+    location /http {
+      content_by_lua '
+        local params = ngx.req.get_uri_args()
+        local clnt,_ = http:new()
+        local total = 0
+        local times = tonumber(params.times) or 100
+
+        clnt:set_timeout(1000)
+
+        for _=1,times do
+          clnt:connect("127.0.0.1", 1986)
+          local res, _  = clnt:request({ query = params })
+          total = total + #res.body
+          clnt:set_keepalive()
+        end
+        ngx.print(total)
+      ';
+    }
+
+    location /capture {
+      content_by_lua '
+        local params = ngx.req.get_uri_args()
+        local total = 0
+        local times = tonumber(params.times) or 100
+
+        for _=1,times do
+          local res, _  = ngx.location.capture("/proxy/delegate", { args = params })
+          total = total + #res.body
+        end
+        ngx.print(total)
+      ';
+    }
+
+    location /proxy/delegate {
+      internal;
+      proxy_pass http://127.0.0.1:1986;
+    }
+  }
+}

benchmark/vs_proxy.rb

@@ -0,0 +1,72 @@
+=begin
+Very naive resty.http vs capture/proxy benchmark:
+
+    $ ruby benchmark/vs_proxy.rb
+    == Sinatra/1.3.3 has taken the stage on 1986 for test with backup from Thin
+    >> Thin web server (v1.5.0 codename Knife)
+    >> Maximum connections set to 1024
+    >> Listening on 0.0.0.0:1986, CTRL+C to stop
+    Rehearsal --------------------------------------------------------
+    S via resty.http       0.110000   0.030000   0.140000 (  0.147134)
+    S via capture/proxy    0.080000   0.010000   0.090000 (  0.104620)
+    L via resty.http       0.020000   0.020000   0.040000 (  0.056494)
+    L via capture/proxy    0.030000   0.010000   0.040000 (  0.166540)
+    ----------------------------------------------- total: 0.310000sec
+
+                               user     system      total        real
+    S via resty.http       0.040000   0.020000   0.060000 (  0.073327)
+    S via capture/proxy    0.040000   0.030000   0.070000 (  0.084767)
+    L via resty.http       0.010000   0.020000   0.030000 (  0.048865)
+    L via capture/proxy    0.020000   0.020000   0.040000 (  0.172873)
+
+=end
+ENV['RACK_ENV'] ||= 'test'
+
+require 'bundler/setup'
+require 'resty_test'
+require 'benchmark'
+
+RestyTest.configure do |c|
+  c.root = File.expand_path("../../spec/resty", __FILE__)
+  c.config_file = File.expand_path("../nginx.conf", __FILE__)
+end
+
+BACKEND = Thread.new do
+  require 'sinatra/base'
+
+  class Server < Sinatra::Base
+
+    get '/*' do
+      len = params[:len].to_i if params[:len]
+      "A" * (len || 1024)
+    end
+
+    run! port: 1986
+  end
+end
+
+RestyTest.start!
+sleep(1)
+client = Excon.new("http://127.0.0.1:1984")
+lquery = { len: (1024 * 1024 * 2), times: 5 }
+
+
+Benchmark.bmbm(20) do |x|
+  x.report "S via resty.http" do
+    raise "Invalid response size" unless client.post(path: "/http").body == "102400"
+  end
+  x.report "S via capture/proxy" do
+    raise "Invalid response size" unless client.post(path: "/capture").body == "102400"
+  end
+
+  x.report "L via resty.http" do
+    raise "Invalid response size" unless client.post(path: "/http", query: lquery).body == "10485760"
+  end
+  x.report "L via capture/proxy" do
+    raise "Invalid response size" unless client.post(path: "/capture", query: lquery).body == "10485760"
+  end
+end
+
+BACKEND.exit
+sleep(0.1) while BACKEND.alive?
+RestyTest.stop!