json_requester 1.0.11 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f5093495b6cc5e5ea2778c405bac7f712130a0d5a4e4b4dbd5d307606c20b98
-  data.tar.gz: a01404be960fc093d0637ab4890981d42a67161fea04f26151984bf661a6e48c
+  metadata.gz: cc7d06fc0826a6e7c0de5aa79a3f0f3bfa8825939594a46bd0f94d00fff2b4e2
+  data.tar.gz: 251126b9edcdd2c645f7510f388d6ab5f80b4954695c309c99bb402758a6ec10
 SHA512:
-  metadata.gz: 95a2aedf37245b98f0167a7e099c5dbf650796dab009025b3075022cb5d8fe9c56ff5759b1075e7d272fcad51a43a68a33e999558d1f0e3932d099eb14bb9781
-  data.tar.gz: 6d32b1f828a49cb7f9fd98a6c1ea487feb74472e1cd64ec6256c4fccb4969a9389144c15d26957de2de838b162d41af0c1c4f01845a6dce4981b79eba737555a
+  metadata.gz: d2eddf1750ef801739e6dae0108a085954b3e0d41276f171a365ba5df5bb99f84ce666467fdcb2c5824c9a6c6be9a35976e219a3e2c95cd848e00e5bae5cd92b
+  data.tar.gz: 7d2d352b07533fd5906ddf8ea08687d8e320cd1dad193f46abe576bc0b4b304981956e8f87ef84fe32794d958554531dd2cbfffbbd9b676e4cebf84b7f121384

data/README.md

@@ -13,7 +13,8 @@ $ gem install json_requester
 ```ruby
   host = 'http://httpbingo.org'
   # `timeout` at Faraday gem default is 60 secs.
-  requester = JsonRequester.new(host, timeout: 120)
+  # `user_agent` at Faraday gem default is like "Faraday v1.10.0", it would be deep_merge at Faraday default setting.
+  requester = JsonRequester.new(host, timeout: 120, user_agent: 'My Agent 1.2')
   
   http_method = :get  # :get / :post / :put / :delete
   path = ''

data/lib/json_requester.rb

@@ -4,35 +4,36 @@ require 'json'
 class JsonRequester
   attr_reader :host, :conn
 
-  def initialize(host, multipart: false, ssl_verify: true, timeout: 60)
+  def initialize(host, multipart: false, ssl_verify: true, timeout: 60, user_agent: '')
     @host = host
     @multipart = multipart
     @ssl_verify = ssl_verify
     @timeout = timeout
+    @user_agent = user_agent.strip.to_s
   end
 
-  def http_send(http_method, path, params={}, headers={}, sort_params: true)
+  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, sort_params: sort_params)
+      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, sort_params: sort_params)
+      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={}, sort_params: true)
+  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={}, sort_params: true)
+  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
@@ -40,12 +41,12 @@ class JsonRequester
       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={}, sort_params: true)
+  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
@@ -53,19 +54,19 @@ class JsonRequester
       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={}, sort_params: true)
+  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
@@ -73,6 +74,7 @@ class JsonRequester
   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.default_connection_options = { headers: { user_agent: @user_agent } } unless @user_agent.empty?
 
     Faraday.new(url: host, ssl: { verify: @ssl_verify }) do |faraday|
       faraday.request :multipart if @multipart  # multipart form POST request
@@ -83,7 +85,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)
@@ -92,7 +94,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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_requester
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.1.0
 platform: ruby
 authors:
 - JiaRou Lee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-17 00:00:00.000000000 Z
+date: 2023-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,34 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.10.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.10.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 0.14.2
 description: wrapper of faraday
 email: laura34963@kdanmobile.com
 executables: []
@@ -59,7 +59,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/kdan-mobile-software-ltd/json_requester
   changelog_uri: https://github.com/kdan-mobile-software-ltd/json_requester/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -75,8 +75,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Basic Wrapper of Faraday
 test_files: []