json_requester 1.0.10 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61edfdc55b1925b3e1907fe89a32298b4baf64e2f63c7f7781bb3b1599801dce
-  data.tar.gz: 73be7e54ea0e2523f32c500bd2367caf339207173a1e17ab3d8a0bf5230648a6
+  metadata.gz: '0845954f6576fcb489054c9dba9649432baf657c49e83e77bfcc0e5c70cc0e89'
+  data.tar.gz: cbe77bc53e67caedf438644d5f5302fa5bbf78761f79a96762b3b401c126b035
 SHA512:
-  metadata.gz: 8666c62ffea8ed9a5c5f9b5ff46ffdddd2e11ff972508b6d7c13ceeb2f9101f01d84724baf06b0a89ec4a3d563e6dd7e2e786ed93f306595d4c3a0f41ca968a2
-  data.tar.gz: 001c495f700f71de07002edc11a92a7e9b7c862c2e9edb5c207ea8496c966753258242f514a69de1133eb7af16e2bab73a27ec77958ddc50da18182bb523dc68
+  metadata.gz: aa8352783d500877db5023c7d9f77d0cd5488e9af3418c25fba9e7cbb863e4e247bb40e534919e42ea15137636de0ced368c54d2148883e2c7139fe1e6386948
+  data.tar.gz: e0da8dcf1a2faaefedee3724d46fa56945db6d0495674a776870b813719c81299b8f5f10dad3aef0f2083995a609ba9e90d1994cf58477bf23d00e1ff1ce1772

data/README.md

@@ -4,15 +4,35 @@
 
 ### Install
 
-    gem install json_requester
+```bash
+$ gem install json_requester
+```
 
 ### How to Use
 
-    requester = JsonRequester.new(host)
-    res = requester.http_send(http_method, path, params, headers)
-    puts res['status']  # 200
-    puts res['body']    # { foo: 'bar' }
-    puts res['body_status']  # 'success'
+```ruby
+  host = 'http://httpbingo.org'
+  # `timeout` at Faraday gem default is 60 secs.
+  requester = JsonRequester.new(host, timeout: 120)
+  
+  http_method = :get  # :get / :post / :put / :delete
+  path = ''
+  headers = { 'Authorization' => 'Bearer token' }
 
-    puts res['status']  # 500
-    puts res['message'] # invalid method
+  # The `:get` method will use query params;
+  # Other HTTP methods will use JSON body to request.
+  params = {
+    key_1: 'value_1',
+    key_2: 'value_2'
+  }
+
+  # Request by using JSON body or query params, use the `http_send` method.
+  # other methods: `form_send`, `multipart_form_send`
+  # `sort_params` at Faraday gem default is true.
+  res = requester.http_send(http_method, path, params, headers, sort_params: true)
+  
+  # http response code
+  puts res['status'] # 200, 404, .. etc
+  # the response JSON body
+  puts res['body'] # { foo: 'bar' }  
+```

data/lib/json_requester.rb

@@ -11,66 +11,69 @@ class JsonRequester
     @timeout = timeout
   end
 
-  def http_send(http_method, path, params={}, headers={})
+  def http_send(http_method, path, params={}, headers={}, sort_params: true, need_response_header: false)
     puts "send #{http_method} reqeust to #{@host} with\npath: #{path}\nparams: #{params}\nheaders: #{headers}"
     if http_method == :get
-      normal_send(http_method, path, params, headers)
+      normal_send(http_method, path, params, headers, sort_params: sort_params, need_response_header: need_response_header)
     else
-      json_send(http_method, path, params, headers)
+      json_send(http_method, path, params, headers, sort_params: sort_params, need_response_header: need_response_header)
     end
   end
 
-  def normal_send(http_method, path, params={}, headers={})
-    conn = init_conn
+  def normal_send(http_method, path, params={}, headers={}, sort_params: true, need_response_header: false)
+    conn = init_conn(sort_params: sort_params)
     res = conn.send(http_method) do |req|
       req.url path
       req.headers = headers if object_present?(headers)
       req.params = params if object_present?(params)
     end
-    process_response(res)
+    process_response(res, need_response_header: need_response_header)
   rescue => e
     error_response(e)
   end
 
-  def json_send(http_method, path, params={}, headers={})
-    conn = init_conn
+  def json_send(http_method, path, params={}, headers={}, sort_params: true, need_response_header: false)
+    conn = init_conn(sort_params: sort_params)
     res = conn.send(http_method) do |req|
       req.url path
       req.headers = headers if object_present?(headers)
       req.headers['Content-Type'] = 'application/json;charset=utf-8'
       req.body = params.to_json if object_present?(params)
     end
-    process_response(res)
+    process_response(res, need_response_header: need_response_header)
   rescue => e
     error_response(e)
   end
 
-  def form_send(http_method, path, params={}, headers={})
-    conn = init_conn
+  def form_send(http_method, path, params={}, headers={}, sort_params: true, need_response_header: false)
+    conn = init_conn(sort_params: sort_params)
     res = conn.send(http_method) do |req|
       req.url path
       req.headers = headers if object_present?(headers)
-      req.headers['Content-Type'] = 'application/x-www-form-urlencoded ;charset=utf-8'
+      req.headers['Content-Type'] = 'application/x-www-form-urlencoded;charset=utf-8'
       req.body = URI.encode_www_form(params) if object_present?(params)
     end
-    process_response(res)
+    process_response(res, need_response_header: need_response_header)
   rescue => e
     error_response(e)
   end
 
-  def multipart_form_send(http_method, path, params={}, headers={})
-    conn = init_conn
+  def multipart_form_send(http_method, path, params={}, headers={}, sort_params: true, need_response_header: false)
+    conn = init_conn(sort_params: sort_params)
     res = conn.send(http_method) do |req|
       req.url path
       req.headers = headers if object_present?(headers)
       req.body = params if object_present?(params)
     end
-    process_response(res)
+    process_response(res, need_response_header: need_response_header)
   end
 
   private
 
-  def init_conn
+  def init_conn(sort_params: true)
+    # https://lostisland.github.io/faraday/#/customization/index?id=order-of-parameters
+    Faraday::NestedParamsEncoder.sort_params = sort_params # faraday default is true
+
     Faraday.new(url: host, ssl: { verify: @ssl_verify }) do |faraday|
       faraday.request :multipart if @multipart  # multipart form POST request
       faraday.request  :url_encoded             # form-encode POST params
@@ -80,7 +83,7 @@ class JsonRequester
     end
   end
 
-  def process_response(response)
+  def process_response(response, need_response_header: false)
     result = {'status' => response.status}
     begin
       body = JSON.parse(response.body)
@@ -89,7 +92,9 @@ class JsonRequester
     rescue
       body = {'body' => response.body}
     end
-    result.merge(body)
+    result.merge!(body)
+    result['headers'] = response.headers.to_h if need_response_header
+    result
   end
 
   def error_response(err)

metadata

@@ -1,19 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: json_requester
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.0.12
 platform: ruby
 authors:
 - JiaRou Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-03 00:00:00.000000000 Z
+date: 2023-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -21,9 +24,26 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
 description: wrapper of faraday
 email: laura34963@kdanmobile.com
 executables: []