feature: shortcut calling for requests APIs

Author: tokers

lib/resty/requests.lua

@@ -3,46 +3,102 @@
 local util = require "resty.requests.util"
 local session = require "resty.requests.session"
 
+
+local is_tab = util.is_tab
+local error = error
+
 local _M = { _VERSION = "0.7.2" }
 
 
+local function request_shortcut(method, opts)
+    method = method or opts.method
+    if not method then
+        error("no specified HTTP method")
+    end
+
+    local url = opts.url
+    local s = session.new()
+    return s:request(method, url, opts)
+end
+
+
 local function request(method, url, opts)
+    if not url and is_tab(method) then
+        -- shortcut type
+        return request_shortcut(nil, method)
+    end
+
     local s = session.new()
     return s:request(method, url, opts)
 end
 
 
 local function get(url, opts)
+    if not opts and is_tab(url) then
+        -- shortcut type
+        return request_shortcut("GET", url)
+    end
+
     return request("GET", url, opts)
 end
 
 
 local function head(url, opts)
+    if not opts and is_tab(url) then
+        -- shortcut type
+        return request_shortcut("HEAD", url)
+    end
+
     return request("HEAD", url, opts)
 end
 
 
 local function post(url, opts)
+    if not opts and is_tab(url) then
+        -- shortcut type
+        return request_shortcut("POST", url)
+    end
+
     return request("POST", url, opts)
 end
 
 
 local function put(url, opts)
+    if not opts and is_tab(url) then
+        -- shortcut type
+        return request_shortcut("PUT", url)
+    end
+
     return request("PUT", url, opts)
 end
 
 
 local function delete(url, opts)
+    if not opts and is_tab(url) then
+        -- shortcut type
+        return request_shortcut("DELETE", url)
+    end
+
     return request("DELETE", url, opts)
 end
 
 
 local function options(url, opts)
+    if not opts and is_tab(url) then
+        -- shortcut type
+        return request_shortcut("OPTIONS", url)
+    end
+
     return request("OPTIONS", url, opts)
 end
 
 
 local function patch(url, opts)
+    if not opts and is_tab(url) then
+        -- shortcut type
+        return request_shortcut("PATCH", url)
+    end
+
     return request("PATCH", url, opts)
 end
 

t/08-shortcut.t

@@ -0,0 +1,138 @@
+use Test::Nginx::Socket::Lua;
+use Cwd qw(cwd);
+
+my $pwd = cwd();
+
+repeat_each(1);
+plan tests => repeat_each() * (blocks() * 3);
+
+our $http_config = << 'EOC';
+    lua_package_path "lib/?.lua;;";
+
+    server {
+        listen 10088;
+        location = /t1 {
+            content_by_lua_block {
+                ngx.print("10088 virtual server")
+            }
+        }
+        location = /t2 {
+            content_by_lua_block {
+                ngx.req.read_body()
+                ngx.print(ngx.req.get_body_data())
+            }
+        }
+    }
+EOC
+
+no_long_string();
+run_tests();
+
+__DATA__
+
+
+=== TEST 1: shortcut GET request
+
+--- http_config eval: $::http_config
+
+--- config
+location = /t {
+    content_by_lua_block {
+        local requests = require "resty.requests"
+        local url = "http://127.0.0.1:10088/t1"
+        local r, err = requests.get { url = url, stream = false }
+        if not r then
+            ngx.log(ngx.ERR, err)
+        end
+
+        ngx.say(r.content)
+    }
+}
+
+--- request
+GET /t
+
+--- response_body
+10088 virtual server
+--- no_error_log
+[error]
+
+
+
+=== TEST 2: shortcut request without specified HTTP method
+
+--- http_config eval: $::http_config
+
+--- config
+location = /t {
+    content_by_lua_block {
+        local requests = require "resty.requests"
+        local url = "http://127.0.0.1:10088/t1"
+        local ok, err = pcall(requests.request, { url = url, stream = false })
+        ngx.say(err)
+    }
+}
+
+--- request
+GET /t
+
+--- response_body_like
+no specified HTTP method
+--- no_error_log
+[error]
+
+
+
+=== TEST 3: shortcut HEAD request
+
+--- http_config eval: $::http_config
+
+--- config
+location = /t {
+    content_by_lua_block {
+        local requests = require "resty.requests"
+        local url = "http://127.0.0.1:10088/t1"
+        local r, err = requests.head { url = url, stream = false }
+        if not r then
+            ngx.log(ngx.ERR, err)
+        end
+
+        ngx.say("ok")
+    }
+}
+
+--- request
+GET /t
+
+--- response_body
+ok
+--- no_error_log
+[error]
+
+
+
+=== TEST 4: shortcut POST request
+
+--- http_config eval: $::http_config
+
+--- config
+location = /t {
+    content_by_lua_block {
+        local requests = require "resty.requests"
+        local url = "http://127.0.0.1:10088/t2"
+        local r, err = requests.post { url = url, stream = false, body = "hello world" }
+        if not r then
+            ngx.log(ngx.ERR, err)
+        end
+
+        ngx.say(r.content)
+    }
+}
+
+--- request
+GET /t
+
+--- response_body
+hello world
+--- no_error_log
+[error]