Using VCR to stub requests

[coreyward]

I was having issues w/ VCR not recording cassettes when using JsonApiClient, despite the Faraday underpinnings. The issue appears to be the following lines in connection.rb:

    # insert middleware before ParseJson - middleware executed in reverse order -
    #   inserted middleware will run after json parsed
    def use(middleware, *args, &block)
      return if faraday.builder.locked?
      faraday.builder.insert_before(Middleware::ParseJson, middleware, *args, &block)
    end

Because Connection wraps the Faraday connection, I believe the VCR-provided hook_into :faraday was ineffective. Adding the middleware manually using connection.use VCR::Middleware::Faraday results in an ArgumentError: VCR::Response initialized with an invalid body: <Hash …>.

The solution, for me, was to insert the VCR middleware after Middleware::ParseJson:

VCR.configure do
  faraday = API::Base.connection.faraday
  faraday.builder.insert_after(JsonApiClient::Middleware::ParseJson, VCR::Middleware::Faraday)
end

Note: API::Base in the example above inherits from JsonApiClient::Resource.