patch_retention 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 109e3aa27d410ae2245f0b1de8a71a1531951869ff99e1c122e406c172e41c5b
-  data.tar.gz: 6666fdc1241ae1bb07fe9e5a014fd6f8c4950c9e9521ebb1c4d1e036c9135f03
+  metadata.gz: a4e08ff07a6967ecf42cb39dc2996ac46076344f46ed37c546f8dc2f676da7bb
+  data.tar.gz: bc86913cf3b560d6eefe94fa722996b7d5442de0200d1060bb5607c1384ad492
 SHA512:
-  metadata.gz: 747343cd474efbbf2e881bf9921cc0b9c4166821a96f2fcf69edcc8effee88481b0f80bcfae9921b631fb66a72df39d2934e4f69424df7c2352d4f2faaf5a28f
-  data.tar.gz: 18b13644f200d75450d070b085a054d02da6aab70d51981cce43126371d50dfe2eefc2c42bf2caa70d9d878cdcc15e18f9337dc7d721d5f1b4c85b6bc0e1ba3e
+  metadata.gz: 931fdeb3e17af3b102cd5cf749530c1c3f8601e3ac9a33dd7e74af53618b0a5d95a68366ec694280052263d06d28f6e073efb11df3a3f1896df69a6dd86b0a20
+  data.tar.gz: 1a8e1c80c352bb5e936abe07f922e688e63559e4670d98c2e2e7273f91124e0a16317d946e82638066898a349bf17582c94832a7d5c4a70dddc7b46127bb4c2a

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.4.0] - 2025-12-30
+
+### Changed
+- **BREAKING**: Upgraded Faraday from 1.x to 2.x (`~> 2.7`)
+- Simplified HTTP request/response handling using Faraday 2.x JSON middleware
+- Refactored `util.rb` to handle pre-parsed JSON responses
+
+### Security
+- Fixed rexml security vulnerability (CVE-2025-58767) by requiring version >= 3.4.2
+
 ## [0.3.2] - 2025-01-19
 
 ### Added

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    patch_retention (0.3.1)
-      faraday (~> 1.10)
+    patch_retention (0.4.0)
+      faraday (~> 2.7)
       zeitwerk (~> 2.6)
 
 GEM
@@ -23,34 +23,19 @@ GEM
       rexml
     diff-lcs (1.5.0)
     dotenv (2.8.1)
-    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.1)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.1.1)
-      multipart-post (~> 2.0)
-    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)
+    faraday (2.14.0)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.2)
+      net-http (~> 0.5)
     hashdiff (1.2.0)
     json (2.7.0)
     language_server-protocol (3.17.0.3)
+    logger (1.7.0)
     method_source (1.0.0)
-    multipart-post (2.4.1)
+    net-http (0.9.1)
+      uri (>= 0.11.1)
     parallel (1.23.0)
     parser (3.2.2.4)
       ast (~> 2.4.1)
@@ -63,7 +48,7 @@ GEM
     rainbow (3.1.1)
     rake (13.1.0)
     regexp_parser (2.8.2)
-    rexml (3.4.1)
+    rexml (3.4.4)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -93,9 +78,9 @@ GEM
     rubocop-shopify (2.15.1)
       rubocop (~> 1.51)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
     thor (1.4.0)
     unicode-display_width (2.5.0)
+    uri (1.1.1)
     vcr (6.3.1)
       base64
     webmock (3.25.1)
@@ -115,7 +100,7 @@ DEPENDENCIES
   patch_retention!
   pry
   rake (~> 13.0)
-  rexml (>= 3.3.9)
+  rexml (>= 3.4.2)
   rspec (~> 3.0)
   rubocop (~> 1.21)
   rubocop-shopify (~> 2.15)

data/lib/patch_retention/calendar_items.rb

@@ -19,11 +19,10 @@ module PatchRetention
         payload[:tags] = tags if tags
 
         response = PatchRetention.connection(config).post("/v2/calendar_items") do |req|
-          req.body = payload.to_json
-          req.headers["Content-Type"] = "application/json"
+          req.body = payload
         end
 
-        JSON.parse(response.body)
+        response.body
       rescue Faraday::Error => e
         raise Error, "Failed to create calendar item: #{e.message}"
       end
@@ -40,11 +39,10 @@ module PatchRetention
         payload[:tags] = tags if tags
 
         response = PatchRetention.connection(config).patch("/v2/calendar_items/#{calendar_item_id}") do |req|
-          req.body = payload.to_json
-          req.headers["Content-Type"] = "application/json"
+          req.body = payload
         end
 
-        JSON.parse(response.body)
+        response.body
       rescue Faraday::Error => e
         raise Error, "Failed to update calendar item: #{e.message}"
       end
@@ -52,7 +50,7 @@ module PatchRetention
       def find(calendar_item_id:, config: nil)
         response = PatchRetention.connection(config).get("/v2/calendar_items/#{calendar_item_id}")
 
-        JSON.parse(response.body)
+        response.body
       rescue Faraday::Error => e
         raise Error, "Failed to find calendar item: #{e.message}"
       end
@@ -77,7 +75,7 @@ module PatchRetention
 
         response = PatchRetention.connection(config).get("/v2/calendar_items", params)
 
-        JSON.parse(response.body)
+        response.body
       rescue Faraday::Error => e
         raise Error, "Failed to retrieve calendar items: #{e.message}"
       end

data/lib/patch_retention/contacts/update.rb

@@ -7,7 +7,7 @@ module PatchRetention::Contacts::Update
   def call(id, contact_params, config = nil)
     raise_error_if_present do
       PatchRetention.connection(config).put("#{PatchRetention::Contacts::API_PATH}/#{id}") do |req|
-        req.body = contact_params.to_json
+        req.body = contact_params
       end
     end
   end

data/lib/patch_retention/memberships.rb

@@ -17,11 +17,10 @@ module PatchRetention
         payload[:data] = data if data
 
         response = PatchRetention.connection(config).post("/v2/memberships") do |req|
-          req.body = payload.to_json
-          req.headers["Content-Type"] = "application/json"
+          req.body = payload
         end
 
-        JSON.parse(response.body)
+        response.body
       rescue Faraday::Error => e
         # You might want to handle different types of Faraday errors differently
         # or raise a custom error class
@@ -39,11 +38,10 @@ module PatchRetention
         payload[:status] = status if status
 
         response = PatchRetention.connection(config).patch("/v2/memberships/#{membership_id}") do |req|
-          req.body = payload.to_json
-          req.headers["Content-Type"] = "application/json"
+          req.body = payload
         end
 
-        JSON.parse(response.body)
+        response.body
       rescue Faraday::Error => e
         raise Error, "Failed to update membership: #{e.message}"
       end
@@ -51,7 +49,7 @@ module PatchRetention
       def find(membership_id:, config: nil)
         response = PatchRetention.connection(config).get("/v2/memberships/#{membership_id}")
 
-        JSON.parse(response.body)
+        response.body
       rescue Faraday::Error => e
         raise Error, "Failed to find membership: #{e.message}"
       end

data/lib/patch_retention/products.rb

@@ -17,11 +17,10 @@ module PatchRetention
         payload[:external_data] = external_data if external_data
 
         response = PatchRetention.connection(config).post("/v2/products") do |req|
-          req.body = payload.to_json
-          req.headers["Content-Type"] = "application/json"
+          req.body = payload
         end
 
-        JSON.parse(response.body)
+        response.body
       rescue Faraday::Error => e
         # You might want to handle different types of Faraday errors differently
         # or raise a custom error class
@@ -41,11 +40,10 @@ module PatchRetention
         payload[:external_data] = external_data if external_data
 
         response = PatchRetention.connection(config).patch("/v2/products/#{product_id}") do |req|
-          req.body = payload.to_json
-          req.headers["Content-Type"] = "application/json"
+          req.body = payload
         end
 
-        JSON.parse(response.body)
+        response.body
       rescue Faraday::Error => e
         raise Error, "Failed to update product: #{e.message}"
       end
@@ -53,7 +51,7 @@ module PatchRetention
       def find(product_id:, config: nil)
         response = PatchRetention.connection(config).get("/v2/products/#{product_id}")
 
-        JSON.parse(response.body)
+        response.body
       rescue Faraday::Error => e
         raise Error, "Failed to find product: #{e.message}"
       end

data/lib/patch_retention/util.rb

@@ -11,24 +11,23 @@ module PatchRetention
       response = yield
       raise PatchRetention::Error, parse_error_message(response) unless response.status.between?(200, 206)
 
-      begin
-        JSON.parse(response.body)
-      rescue JSON::ParserError
-        true
+      case response.body
+      when Hash, Array then response.body
+      else true
       end
     end
 
-    # Parses the error message from the response.
-    # Raises a PatchRetention::Error if the response status is 502 and the body is blank.
+    # Extracts error message from the response.
     # @param response [Object] The response to parse the error message from.
     # @return [String] The error message parsed from the response body.
     def parse_error_message(response)
-      if response.status == 502 && response.body.blank?
-        raise PatchRetention::Error,
-          "Internal Server Error: Patch API"
+      if response.body.is_a?(Hash) && response.body["error"]
+        response.body["error"]
+      elsif response.status == 502
+        "Internal Server Error: Patch API"
+      else
+        "Request failed with status #{response.status}"
       end
-
-      JSON.parse(response.body)["error"]
     end
   end
 end

data/lib/patch_retention/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PatchRetention
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/patch_retention.rb

@@ -37,6 +37,7 @@ module PatchRetention
         },
       ) do |builder|
         builder.request(:json)
+        builder.response(:json)
       end
     end
   end

data/patch_retention.gemspec

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "lib/patch_retention/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "patch_retention"
+  spec.version = PatchRetention::VERSION
+  spec.authors = ["Playbypoint", "Gerardo Ortega", "Segundo Rebaza"]
+  spec.email = ["webmaster@playbypoint.com", "g3ortega@gmail.com", "alvaro.rp1593@gmail.com"]
+
+  spec.summary = "Patch Retention API wrapper."
+  spec.description = "Patch Retention API wrapper."
+  spec.homepage = "https://playbypoint.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  # spec.metadata["allowed_push_host"] = "Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://playbypoint.com"
+  spec.metadata["changelog_uri"] = "https://playbypoint.com"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    %x(git ls-files -z).split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies
+  spec.add_dependency("faraday", "~> 2.7")
+  spec.add_dependency("zeitwerk", "~> 2.6")
+
+  # Development dependencies
+  spec.add_development_dependency("bundler", "~> 2.0")
+  spec.add_development_dependency("bundler-audit", "~> 0.9")
+  spec.add_development_dependency("byebug")
+  spec.add_development_dependency("dotenv", "~> 2.8")
+  spec.add_development_dependency("pry")
+  spec.add_development_dependency("rake", "~> 13.0")
+  spec.add_development_dependency("rspec", "~> 3.0")
+  spec.add_development_dependency("rubocop", "~> 1.21")
+  spec.add_development_dependency("rubocop-shopify", "~> 2.15")
+  spec.add_development_dependency("thor", ">= 1.4.0")
+  spec.add_development_dependency("vcr", "~> 6.0")
+  spec.add_development_dependency("webmock", "~> 3.0")
+
+  # Security update for rexml
+  spec.add_development_dependency("rexml", ">= 3.4.2")
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: patch_retention
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Playbypoint
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-19 00:00:00.000000000 Z
+date: 2025-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -214,14 +214,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.9
+        version: 3.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.9
+        version: 3.4.2
 description: Patch Retention API wrapper.
 email:
 - webmaster@playbypoint.com
@@ -267,6 +267,7 @@ files:
 - lib/patch_retention/products.rb
 - lib/patch_retention/util.rb
 - lib/patch_retention/version.rb
+- patch_retention.gemspec
 - script/setup_test_env
 - sig/patch_retention.rbs
 homepage: https://playbypoint.com