json_requester 1.0.9 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97dd6e0bf2910e13ec4badfedeed6a2e81d31c728e12e25eab181a1c8cc25ef9
-  data.tar.gz: f93f5fa627e90339bf734b8e96367bdf6924f18c6f747625bedabd943ba97cba
+  metadata.gz: 9f5093495b6cc5e5ea2778c405bac7f712130a0d5a4e4b4dbd5d307606c20b98
+  data.tar.gz: a01404be960fc093d0637ab4890981d42a67161fea04f26151984bf661a6e48c
 SHA512:
-  metadata.gz: 39f4cda3e36460c8f8647513823974c90211a12ac509e495a3c79188381c07eb217f2abc7d874f094d7276b1c3fe5166bf87fc15b0e3d21f4a81e828340cd629
-  data.tar.gz: fe699ae45d3d99e81d1b15e48e6a0e0219ebf2ca8b75f144a028091664bbe9dbcf473c2a1aa294db2bc2fe3a998e6a90d2f1c0493c6a933ab91ec9a41849c141
+  metadata.gz: 95a2aedf37245b98f0167a7e099c5dbf650796dab009025b3075022cb5d8fe9c56ff5759b1075e7d272fcad51a43a68a33e999558d1f0e3932d099eb14bb9781
+  data.tar.gz: 6d32b1f828a49cb7f9fd98a6c1ea487feb74472e1cd64ec6256c4fccb4969a9389144c15d26957de2de838b162d41af0c1c4f01845a6dce4981b79eba737555a

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

@@ -4,23 +4,24 @@ require 'json'
 class JsonRequester
   attr_reader :host, :conn
 
-  def initialize(host, multipart: false, ssl_verify: true)
+  def initialize(host, multipart: false, ssl_verify: true, timeout: 60)
     @host = host
     @multipart = multipart
     @ssl_verify = ssl_verify
+    @timeout = timeout
   end
 
-  def http_send(http_method, path, params={}, headers={})
+  def http_send(http_method, path, params={}, headers={}, sort_params: true)
     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)
     else
-      json_send(http_method, path, params, headers)
+      json_send(http_method, path, params, headers, sort_params: sort_params)
     end
   end
 
-  def normal_send(http_method, path, params={}, headers={})
-    conn = init_conn
+  def normal_send(http_method, path, params={}, headers={}, sort_params: true)
+    conn = init_conn(sort_params: sort_params)
     res = conn.send(http_method) do |req|
       req.url path
       req.headers = headers if object_present?(headers)
@@ -31,8 +32,8 @@ class JsonRequester
     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)
+    conn = init_conn(sort_params: sort_params)
     res = conn.send(http_method) do |req|
       req.url path
       req.headers = headers if object_present?(headers)
@@ -44,12 +45,12 @@ class JsonRequester
     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)
+    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)
@@ -57,8 +58,8 @@ class JsonRequester
     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)
+    conn = init_conn(sort_params: sort_params)
     res = conn.send(http_method) do |req|
       req.url path
       req.headers = headers if object_present?(headers)
@@ -69,12 +70,16 @@ class JsonRequester
 
   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
       faraday.response :logger                  # log requests to $stdout
       faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      faraday.options.timeout = @timeout
     end
   end
 

metadata

@@ -1,19 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: json_requester
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.11
 platform: ruby
 authors:
 - JiaRou Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-08-17 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: []