flexirest 1.13.0 → 1.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4953df31ca4ca1d055e7a80ce2cd7a0df8e53cc4b67544b80d1a91ee2aa366a4
-  data.tar.gz: 0f500061fd78240f0f2c2d8c19934d5c6c5f777f32de82c8bc2330415fd6c768
+  metadata.gz: d8b2caeda24cf6df9d105be2899483c18887dfa8903e54e0142d05f4be406ba4
+  data.tar.gz: 4072891a3796efbfa0323977dc922c57acbf77cce41f94ed50f95a63911dc70e
 SHA512:
-  metadata.gz: 6c45c501ef89cc34a66a66ca585088e7af146348b2c42ffd0c36fe4559a957ae4bc5f579b207b238c5d0e5a0625bb1000f937a144a2107ce3eff79272d07286a
-  data.tar.gz: 9ea32ee11733ee70ea539d37f094fb8e9f730c82c4a14f84e5322102ab380af0c5dc12a3ac258968e8ec9a6ebd6b84ae780e54ec9a518744888c6ee62be40e7f
+  metadata.gz: f07a2703870fbcd9c4d7b1862ccd95b8cf38a6e67c0caeca51706361b1bd871c4b49698fb69719747890e18adf22f1b809d8c3cf8e13d977758f88780d23db24
+  data.tar.gz: 3d4051535dda8ecac777686b506008cdb104aa832cd1fa4ac668ae01c1d129d53f92ac863ca69e3abebc3da55f6275a19ab259d3bdabf2bf477f9bf4059f73c4

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 1.13.2
+
+Bugfix:
+
+- multi_json 1.21 renamed its module to `MultiJSON` and replaced `load`/`dump` with `parse`/`generate`, deprecating the old names with one-time warnings that appeared in host applications' test output. Flexirest now calls the current API (and `symbolize_names` rather than the deprecated `symbolize_keys`), so it requires multi_json >= 1.21
+
+## 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,8 +38,11 @@ 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 "multi_json", ">= 1.21"
   spec.add_runtime_dependency "crack"
   spec.add_runtime_dependency "faraday", "~> 2.7"
 

data/lib/flexirest/lazy_association_loader.rb

@@ -87,7 +87,7 @@ module Flexirest
 
     def ensure_lazy_loaded
       if @object.nil?
-        method = MultiJson.load(MultiJson.dump(@request.method),:symbolize_keys => true)
+        method = MultiJSON.parse(MultiJSON.generate(@request.method), symbolize_names: true)
         method[:method] = :get
         method[:options][:url] = @url
         method[:options][:overridden_name] = @options[:overridden_name]

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)
@@ -96,7 +99,7 @@ module Flexirest
           if incoming_content_type && incoming_content_type["xml"]
             result.body = yield Crack::XML.parse(result.body)
           else
-            result.body = yield MultiJson.load(result.body)
+            result.body = yield MultiJSON.parse(result.body)
           end
         end
         result

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_-]+)/)
@@ -869,9 +872,9 @@ module Flexirest
         body = @response.body
       elsif is_json_response?
         begin
-          body = @response.body.blank? ? {} : MultiJson.load(@response.body)
+          body = @response.body.blank? ? {} : MultiJSON.parse(@response.body)
           body = {} if body.nil?
-        rescue MultiJson::ParseError
+        rescue MultiJSON::ParseError
           raise ResponseParseException.new(status:@response.status, body:@response.body, headers:@response.headers)
         end
 

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.13.0"
+  VERSION = "1.13.2"
 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/base_without_validation_spec.rb

@@ -520,11 +520,11 @@ describe Flexirest::BaseWithoutValidation do
     let(:location) { EmptyExample.new(place:"Room 1408") }
     let(:lazy) { Laz }
     let(:object) { EmptyExample.new(name:"Programming 101", location:location, students:[student1, student2]) }
-    let(:json_parsed_object) { MultiJson.load(object.to_json) }
+    let(:json_parsed_object) { MultiJSON.parse(object.to_json) }
 
     it "should be able to export to valid json" do
       expect(object.to_json).to_not be_blank
-      expect{MultiJson.load(object.to_json)}.to_not raise_error
+      expect{MultiJSON.parse(object.to_json)}.to_not raise_error
     end
 
     it "should not be using Object's #to_json method" do

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/json_api_spec.rb

@@ -479,7 +479,7 @@ describe 'JSON API' do
 
     it 'should be able to call #.create on class' do
       expect_any_instance_of(Flexirest::Connection).to receive(:post) { |_, path, data|
-        hash = MultiJson.load(data)
+        hash = MultiJSON.parse(data)
         expect(path).to eq('/articles')
         expect(hash['data']).to_not be_nil
         expect(hash['data']['id']).to be_nil
@@ -490,7 +490,7 @@ describe 'JSON API' do
 
     it 'should be able to call #.create with params on class' do
       expect_any_instance_of(Flexirest::Connection).to receive(:post) { |_, path, data|
-        hash = MultiJson.load(data)
+        hash = MultiJSON.parse(data)
         expect(path).to eq('/articles')
         expect(hash['data']).to_not be_nil
         expect(hash['data']['id']).to be_nil
@@ -505,7 +505,7 @@ describe 'JSON API' do
 
     it 'should perform a post request in proper json api format' do
       expect_any_instance_of(Flexirest::Connection).to receive(:post) { |_, path, data|
-        hash = MultiJson.load(data)
+        hash = MultiJSON.parse(data)
         expect(path).to eq('/articles')
         expect(hash['data']).to_not be_nil
         expect(hash['data']['id']).to be_nil
@@ -533,7 +533,7 @@ describe 'JSON API' do
 
     it 'should perform a patch request in proper json api format' do
       expect_any_instance_of(Flexirest::Connection).to receive(:patch) { |_, path, data|
-        hash = MultiJson.load(data)
+        hash = MultiJSON.parse(data)
         expect(path).to eq('/articles/1')
         expect(hash['data']).to_not be_nil
         expect(hash['data']['id']).to_not be_nil
@@ -554,7 +554,7 @@ describe 'JSON API' do
 
     it 'should have placed the right type value in the request' do
       expect_any_instance_of(Flexirest::Connection).to receive(:patch) { |_, _, data|
-        hash = MultiJson.load(data)
+        hash = MultiJSON.parse(data)
         expect(hash['data']['type']).to eq(JsonAPIExample::ArticleAlias.alias_type.to_s)
         expect(hash['data']['relationships']['author']['data']['type']).to eq(JsonAPIExample::AuthorAlias.alias_type.to_s)
       }.and_return(::FaradayResponseMock.new(OpenStruct.new(body: '{}', response_headers: {})))

data/spec/lib/multi_json_api_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe "multi_json API" do
+  before :each do
+    class MultiJsonChildExample < Flexirest::Base
+      base_url "http://www.example.com"
+
+      get :find, "/child/:id"
+    end
+
+    class MultiJsonExampleClient < Flexirest::Base
+      base_url "http://www.example.com"
+
+      get :find, "/find/:id"
+      get :parent, "/parent", lazy: { children: MultiJsonChildExample }, fake: "{\"children\": [\"http://www.example.com/child/1\"]}"
+    end
+  end
+
+  # multi_json warns once per process for each deprecated entry point, so a
+  # warning emitted by an earlier spec would make a later one look clean.
+  # Message expectations on the deprecated surface - the legacy MultiJson module
+  # (whose const_missing serves MultiJson::ParseError) and the load/dump aliases
+  # on MultiJSON itself - hold regardless of spec order.
+  def expect_no_deprecated_json_api
+    [MultiJson, MultiJSON].each do |target|
+      %i[load dump decode encode const_missing].each do |name|
+        expect(target).to_not receive(name) if target.respond_to?(name)
+      end
+    end
+  end
+
+  def response_for(body)
+    ::FaradayResponseMock.new(OpenStruct.new(status: 200, response_headers: { "Content-Type" => "application/json" }, body: body))
+  end
+
+  it "parses a response body" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:get).with(any_args).and_return(response_for("{\"name\":\"Billy\"}"))
+    expect_no_deprecated_json_api
+
+    expect(MultiJsonExampleClient.find(id: 1).name).to eq("Billy")
+  end
+
+  it "reports a body it cannot parse" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:get).with(any_args).and_return(response_for("{\"name\": Billy"))
+    expect_no_deprecated_json_api
+
+    expect { MultiJsonExampleClient.find(id: 1) }.to raise_error(Flexirest::ResponseParseException)
+  end
+
+  it "loads a lazy association" do
+    loader = MultiJsonExampleClient.parent.children.first
+    expect(loader).to be_an_instance_of(Flexirest::LazyAssociationLoader)
+    expect_any_instance_of(Flexirest::Connection).to receive(:get).with(any_args).and_return(response_for("{\"name\":\"Jane\"}"))
+    expect_no_deprecated_json_api
+
+    expect(loader.name).to eq("Jane")
+  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}"

data/spec/lib/request_spec.rb

@@ -206,7 +206,7 @@ describe Flexirest::Request do
     class CallbackBodyExampleClient < ExampleClient
       base_url "http://www.example.com"
       before_request do |name, request|
-        request.body = MultiJson.dump(request.post_params)
+        request.body = MultiJSON.generate(request.post_params)
       end
 
       post :save, "/save"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.13.2
 platform: ruby
 authors:
 - Andy Jeffries
@@ -192,7 +192,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -206,7 +206,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -219,6 +219,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: crack
   requirement: !ruby/object:Gem::Requirement
@@ -376,6 +390,7 @@ files:
 - spec/lib/lazy_loader_spec.rb
 - spec/lib/logger_spec.rb
 - spec/lib/mapping_spec.rb
+- spec/lib/multi_json_api_spec.rb
 - spec/lib/plain_response_spec.rb
 - spec/lib/proxy_spec.rb
 - spec/lib/recording_spec.rb
@@ -405,7 +420,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
@@ -430,6 +445,7 @@ test_files:
 - spec/lib/lazy_loader_spec.rb
 - spec/lib/logger_spec.rb
 - spec/lib/mapping_spec.rb
+- spec/lib/multi_json_api_spec.rb
 - spec/lib/plain_response_spec.rb
 - spec/lib/proxy_spec.rb
 - spec/lib/recording_spec.rb