flexirest 1.13.0 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4953df31ca4ca1d055e7a80ce2cd7a0df8e53cc4b67544b80d1a91ee2aa366a4
-  data.tar.gz: 0f500061fd78240f0f2c2d8c19934d5c6c5f777f32de82c8bc2330415fd6c768
+  metadata.gz: 152b5d789cff3ee4ccd09c6090d4f5bee5b431a96fb34797d5d189882585c235
+  data.tar.gz: 91c220948c05caec4b7f625d618c1b3e180272013a8dee3157bd66cbaf039bbb
 SHA512:
-  metadata.gz: 6c45c501ef89cc34a66a66ca585088e7af146348b2c42ffd0c36fe4559a957ae4bc5f579b207b238c5d0e5a0625bb1000f937a144a2107ce3eff79272d07286a
-  data.tar.gz: 9ea32ee11733ee70ea539d37f094fb8e9f730c82c4a14f84e5322102ab380af0c5dc12a3ac258968e8ec9a6ebd6b84ae780e54ec9a518744888c6ee62be40e7f
+  metadata.gz: 7440c4c8b5122e296360ece864f8ffd9ba59ae83429badd94c587ce700ecab20e823b3cff166c2623ecde5a5f5697737caf1684ac3237f5b20a63213d2dc42e0
+  data.tar.gz: e54a1e79e49dca9a29ed9c6d04ee43ea7a0da4943b6b873ff30d9df8377605d418a84ad391cccaad60d65102f9d43936b191bb2a5f6c4f8889ca011381e7a529

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.13.1
+
+Bugfix:
+
+- Ruby 4.0 removed `ostruct` from the standard library, and Flexirest builds OpenStructs internally, so it is now required explicitly and declared as a runtime dependency rather than relying on the host application to provide it
+- Proxy routes with parameters (e.g. `get "/things/:id"`) no longer mutate the string they are given, so declaring one with a frozen string literal works. Previously `ProxyBase.add_mapping` built the regex with `gsub!` on the caller's string, which warns under Ruby 3.4+ chilled string literals and raises `FrozenError` under `--enable=frozen-string-literal`
+- A forced URL is now duplicated before `before_request` callbacks run, so the documented `request.url.gsub!` pattern works when the URL passed to `_request` is a frozen string literal
+
 ## 1.13.0
 
 Bugfix:

data/Rakefile

@@ -1,3 +1,8 @@
+# IMPORTANT: bundler/setup so a bare `rake spec` runs the same suite as CI's
+# `bundle exec rake`. Several specs are defined conditionally on
+# Gem.loaded_specs["api-auth"], which only lists *activated* gems - without Bundler
+# those guards read false and the examples silently vanish rather than fail.
+require "bundler/setup"
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new('spec')

data/flexirest.gemspec

@@ -38,6 +38,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rest-client'
   spec.add_development_dependency 'timecop'
 
+  # A default gem up to Ruby 3.4 and dropped from the stdlib in 4.0, so declare it
+  # rather than assume the host application provides it.
+  spec.add_runtime_dependency "ostruct"
   spec.add_runtime_dependency "mime-types"
   spec.add_runtime_dependency "multi_json"
   spec.add_runtime_dependency "crack"

data/lib/flexirest/proxy_base.rb

@@ -39,11 +39,14 @@ module Flexirest
         @mappings ||= []
 
         if match.is_a?(String) && (param_keys = match.scan(/:\w+/)) && param_keys.any?
-          param_keys.each do |key|
-            match.gsub!(key, "([^/]+)")
-          end
+          # Build the pattern from a copy rather than mutating the caller's string. A
+          # route is almost always declared with a string literal, and under Ruby 3.4+
+          # those are chilled (mutating one warns); with frozen string literals enabled
+          # - Ruby 4.0's --enable=frozen-string-literal, or a magic comment - the same
+          # mutation raises FrozenError and the proxy class fails to load.
+          pattern = param_keys.reduce(match.dup) { |acc, key| acc.gsub(key, "([^/]+)") }
           param_keys = param_keys.map {|k| k.gsub(":", "").to_sym}
-          match = Regexp.new(match)
+          match = Regexp.new(pattern)
         end
 
         @mappings << OpenStruct.new(http_method:method_type, match:match, block:block, param_keys:param_keys)

data/lib/flexirest/request.rb

@@ -426,7 +426,10 @@ module Flexirest
     def prepare_url
       missing = []
       if @forced_url && @forced_url.present?
-        @url = @forced_url
+        # dup for the same reason as the branch below: before_request callbacks are
+        # documented to rewrite the URL in place with gsub!, and a forced URL is
+        # usually a string literal from the caller.
+        @url = @forced_url.dup
       else
         @url = @method[:url].dup
         matches = @url.scan(/(:[a-z_-]+)/)

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.13.0"
+  VERSION = "1.13.1"
 end

data/lib/flexirest.rb

@@ -1,3 +1,7 @@
+# ostruct stopped being a default gem in Ruby 4.0, and Flexirest builds OpenStructs in
+# Request and ProxyBase, so require it explicitly rather than relying on the host
+# application having pulled it in.
+require "ostruct"
 require 'active_support/all'
 require "flexirest/version"
 require "flexirest/attribute_parsing"

data/spec/lib/callbacks_spec.rb

@@ -42,7 +42,11 @@ class SubClassedCallbacksExample < CallbacksExample
 end
 
 describe Flexirest::Callbacks do
-  let(:request) { OpenStruct.new(get_params:{}, post_params:{}, url:"http://www.example.com", headers:Flexirest::HeadersList.new) }
+  # The unary + matters: these examples exercise callbacks rewriting the URL in place
+  # with gsub!, which is the documented API (docs/using-callbacks.md). A real request
+  # hands callbacks a mutable String, so the double has to as well - a frozen literal
+  # here would fail under frozen string literals for a reason the library doesn't have.
+  let(:request) { OpenStruct.new(get_params:{}, post_params:{}, url:+"http://www.example.com", headers:Flexirest::HeadersList.new) }
   let(:response) { OpenStruct.new(body:"") }
 
   it "should call through to adjust the parameters" do

data/spec/lib/connection_manager_spec.rb

@@ -5,6 +5,27 @@ describe Flexirest::ConnectionManager do
     Flexirest::ConnectionManager.reset!
   end
 
+  # IMPORTANT: The two typhoeus examples below set a *global* adapter. Reset it in an
+  # after hook rather than on the last line of each example: if the example raises
+  # first that line never runs, every later spec in the suite inherits
+  # adapter = :typhoeus, and they all fail with ":typhoeus is not registered on
+  # Faraday::Adapter". Specs run in random order, so that turns one local failure into
+  # a suite-wide cascade whose size depends on the seed.
+  after(:each) do
+    Flexirest::Base._reset_configuration!
+  end
+
+  # Gem.loaded_specs only lists gems that have been *activated*, not every gem in the
+  # bundle, so it is not a reliable way to ask whether faraday-typhoeus is installed -
+  # when it reads as absent the require is skipped and :typhoeus is never registered.
+  # Just attempt the require and let the older typhoeus-provided adapter be the
+  # fallback.
+  def require_typhoeus_adapter
+    require 'faraday/typhoeus'
+  rescue LoadError
+    require 'typhoeus/adapters/faraday'
+  end
+
   it "should have a get_connection method" do
     expect(Flexirest::ConnectionManager).to respond_to("get_connection")
   end
@@ -35,19 +56,17 @@ describe Flexirest::ConnectionManager do
   end
 
   it "should call 'in_parallel' for a session and yield procedure inside that block" do
-    require 'faraday/typhoeus' if Gem.loaded_specs["faraday-typhoeus"].present?
+    require_typhoeus_adapter
     Flexirest::Base.adapter = :typhoeus
     Flexirest::ConnectionManager.get_connection("http://www.example.com").session
     expect { |b| Flexirest::ConnectionManager.in_parallel("http://www.example.com", &b)}.to yield_control
-    Flexirest::Base._reset_configuration!
   end
 
   it "should raise Flexirest::MissingOptionalLibraryError if Typhoeus isn't available" do
-    require 'faraday/typhoeus' if Gem.loaded_specs["faraday-typhoeus"].present?
+    require_typhoeus_adapter
     Flexirest::Base.adapter = :typhoeus
     Flexirest::ConnectionManager.get_connection("http://www.example.com").session
     expect(Flexirest::ConnectionManager).to receive(:require).and_raise(LoadError)
     expect { Flexirest::ConnectionManager.in_parallel("http://www.example.com")}.to raise_error(Flexirest::MissingOptionalLibraryError)
-    Flexirest::Base._reset_configuration!
   end
 end

data/spec/lib/proxy_spec.rb

@@ -265,6 +265,18 @@ describe Flexirest::Base do
     expect(paths.sort).to eq(expected.sort)
   end
 
+  it "builds a parameterised route without mutating the string it was given" do
+    route = "/frozen/:id/:name".freeze
+    proxy = Class.new(Flexirest::ProxyBase)
+
+    expect { proxy.get(route) { passthrough } }.to_not raise_error
+    expect(route).to eq("/frozen/:id/:name")
+
+    mapping = proxy.instance_variable_get(:@mappings).last
+    expect(mapping.param_keys).to eq(%i[id name])
+    expect("/frozen/12/john").to match(mapping.match)
+  end
+
   it "properly passes basic HTTP auth credentials" do
     host, credentials, url_path = 'www.example.com', 'user:pass', '/getAll?id=1'
     ProxyClientExample.base_url "http://#{credentials}@#{host}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.13.1
 platform: ruby
 authors:
 - Andy Jeffries
@@ -191,6 +191,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -405,7 +419,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: This gem is for accessing REST services in a flexible way.  ActiveResource
   already exists for this, but it doesn't work where the resource naming doesn't follow