Merge branch 'upgrade-faraday' into 'master'

Upgrade faraday

See merge request kdanmobile/shared-code-base/gems/json_requester!17

Author: 蔡耀賢

.gitlab-ci.yml

@@ -6,8 +6,20 @@ include:
 stages:
   - test
   - sast_upload
+  - rspec
   - publish
 
+rspec:
+  stage: rspec
+  image: ruby:3.3.5
+  tags:
+    - arm64
+  script:
+    - bundle install
+    - rspec spec -fd
+  only:
+    - master
+
 to_gem:
   stage: publish
   image: ruby:3.3.5
@@ -23,4 +35,4 @@ to_gem:
     - gem build json_requester.gemspec
     - gem push $GEM_NAME
   only:
-    - master
+    - /release-\d+\.\d+\.\d+(\.\d+)?/

.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

CHANGELOG.md

@@ -1,3 +1,13 @@
+## [2.0.0] - 2025-04-25
+
+### Breaking changes
+
+- Upgrade Faraday to version 2.x.
+- Remove support for Ruby 2.7 and below.
+
+### Features
+- Add rspec for testing.
+
 ## [1.1.3] - 2024-10-28
 - Replace `.present?` method with `object_present?` for string in `json_send` method. 
 

Gemfile

@@ -2,5 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 
-# http request
-gem 'faraday', '~> 1.10'
+# Simple, but flexible HTTP client library, with support for multiple backends.
+gem 'faraday', '~> 2.13.1'
+# Perform multipart-post requests using Faraday.
+gem 'faraday-multipart', '~> 1.1.0'

Gemfile.lock

@@ -1,50 +1,70 @@
 PATH
   remote: .
   specs:
-    json_requester (1.1.3)
-      faraday (~> 1.10, >= 1.10.3)
+    json_requester (2.0.0)
+      faraday (~> 2.0, >= 2.0.1)
+      faraday-multipart (~> 1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    bigdecimal (3.1.9)
     coderay (1.1.3)
-    faraday (1.10.4)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.4)
-      multipart-post (~> 2)
-    faraday-net_http (1.0.2)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.6.1)
+    faraday (2.13.1)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-multipart (1.1.0)
+      multipart-post (~> 2.0)
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    hashdiff (1.1.2)
+    json (2.11.3)
+    logger (1.7.0)
     method_source (1.1.0)
     multipart-post (2.4.1)
+    net-http (0.6.0)
+      uri
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    ruby2_keywords (0.0.5)
+    public_suffix (6.0.1)
+    rexml (3.4.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    uri (1.0.3)
+    webmock (3.25.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  faraday (~> 1.10)
+  faraday (~> 2.13.1)
+  faraday-multipart (~> 1.1.0)
   json_requester!
   pry (~> 0.14.2)
+  rspec (~> 3.0)
+  webmock (~> 3.25, >= 3.25.1)
 
 BUNDLED WITH
-   2.5.22
+   2.6.8

README.md

@@ -4,16 +4,25 @@
 
 ### Install
 
+If you want to use faraday 1.x version, install json_requester 1.x version:
 ```bash
-$ gem install json_requester
+$ gem install json_requester -v '~> 1.0'
+```
+
+If you want to use faraday 2.x version, install json_requester 2.x version:
+```bash
+$ gem install json_requester -v '~> 2.0'
 ```
 
 ### How to Use
 
 ```ruby
+  # initialize the JsonRequester class
   host = 'http://httpbingo.org'
   # `timeout` at Faraday gem default is 60 secs.
   # `user_agent` at Faraday gem default is like "Faraday v1.10.0", it would be deep_merge at Faraday default setting.
+  # `multipart` option enables multipart form requests (for file uploads), default is false
+  # `ssl_verify` controls SSL certificate verification, default is true
   requester = JsonRequester.new(host, timeout: 120, user_agent: 'My Agent 1.2')
 
   http_method = :get  # :get / :post / :put / :delete
@@ -31,10 +40,30 @@ $ gem install json_requester
   # other methods: `form_send`, `multipart_form_send`
   # `sort_params` at Faraday gem default is true.
   # `content_type_charset` default is 'utf-8', this will add ; charset=utf-8 after `Content-Type` header (ex. `Content-Type=application/json; charset=utf-8`).
+  # `need_response_header` when set to true will include response headers in the result
   res = requester.http_send(http_method, path, params, headers, sort_params: true, content_type_charset: 'utf-8')
 
   # http response code
   puts res['status'] # 200, 404, .. etc
   # the response JSON body
-  puts res['body'] # { foo: 'bar' }  
+  puts res['body'] # { foo: 'bar' }
+
+  # If need_response_header is true, you can access response headers
+  puts res['headers'] if res.key?('headers')
+
+  # For form-encoded requests (application/x-www-form-urlencoded)
+  form_res = requester.form_send(:post, '/post', params, headers)
+  
+  # For file uploads or multipart form requests
+  # First initialize with multipart: true
+  multipart_requester = JsonRequester.new(host, multipart: true)
+  
+  # Then prepare your payload with file objects
+  upload_params = {
+    file: Faraday::Multipart::FilePart.new('path/to/file.txt', 'text/plain'),
+    description: 'File upload example'
+  }
+  
+  # Send multipart request
+  upload_res = multipart_requester.multipart_form_send(:post, '/upload_path', upload_params, headers)
 ```

VERSION.md

@@ -1 +1 @@
-1.1.3
+2.0.0

json_requester.gemspec

@@ -18,7 +18,10 @@ Gem::Specification.new do |s|
   s.rdoc_options     = ['--charset=UTF-8']
   s.require_path     = "lib"
 
-  s.required_ruby_version = '>= 2.5.1'
-  s.add_runtime_dependency 'faraday', '~> 1.10', '>= 1.10.3'
+  s.required_ruby_version = '>= 3.0.0'
+  s.add_runtime_dependency "faraday", "~> 2.0", ">= 2.0.1"
+  s.add_runtime_dependency 'faraday-multipart', '~> 1.1.0'
   s.add_development_dependency 'pry', '~> 0.14.2'
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "webmock", "~> 3.25", ">= 3.25.1"
 end

lib/json_requester.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require 'faraday/multipart'
 require 'json'
 
 class JsonRequester
@@ -75,8 +76,12 @@ 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?
+    options = { 
+      url: host,
+      ssl: { verify: @ssl_verify }
+    }
 
-    Faraday.new(url: host, ssl: { verify: @ssl_verify }) do |faraday|
+    Faraday.new(options) 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
@@ -112,6 +117,7 @@ def object_present?(object)
   def object_blank?(object)
     # Ref: https://github.com/rails/rails/blob/v7.1.4.2/activesupport/lib/active_support/core_ext/object/blank.rb#L18
     # active_support blank? method
+    return true if object.nil?
     object.respond_to?(:empty?) ? !!object.empty? : false
   end
 

spec/fixtures/sample.txt

@@ -0,0 +1 @@
+This is a test file for multipart upload testing.