Unable to set site outside of Base class

[dmbrooking]

So I have something similiar to the example code. If I do this:

module MyApi
  # this is an "abstract" base class that
  class Base < JsonApiClient::Resource
    # set the api base url in an abstract base class
    self.site = "http://example.com/"
  end
end

everything works.

If I try and set the site var outside of MyApi::Base, it fails.

If I have

MyApi::Base.site = "http://example.com/"
module MyApi
  # this is an "abstract" base class that
  class Base < JsonApiClient::Resource
  end
end

the connection fails with the error of

     # Errno::ECONNREFUSED:
     #   Connection refused - connect(2) for nil port 80

Using pry, if I get the following:

[1] pry(#<RSpec::ExampleGroups::RecordType>)> MyApi::Base.site
=> "http://example.com/"
[2] pry(#<RSpec::ExampleGroups::RecordType>)> cd MyApi::Base
[3] pry(MyApi::Base):1> self.site
=> "http://example.com/"
[4] pry(MyApi::Base):1> site
=> "http://example.com/"

which is what I expect. I'm not sure what's happening...

[natemacinnes]

I have encountered this issue as well attempting to use the project in a multiple endpoint setup in different environments.

I have different sites depending on whether or not I am in development, staging or production.

I discovered that all requests were going to the hard coded site and not the one that it was set to in the initializer from the the config file.

I am looking into a fix now.
Will keep you updated.
EDIT: Work around below.

Ex:

module MyApi
    # abstract base class
    class Base < JsonApiClient::Resource
        self.site = "https://myapi.com/" 
    end
end

[1] > MyApi::Base.site
=> "https://myapi.com/"
[2] > availabilities = MyApi::Availabilities.new
[3] > availabilities.save
# The resulting log from Farraday::Logger
INFO -- : post https://myapi.com/availabilities

Now attempting the same thing but setting the Base.site from the console

[1] > MyApi::Base.site
=> "https://myapi.com/"
[2] > MyApi::Base.site = "https://myotherapi.com/" 
[3] > MyApi::Base.site
=> "https://myotherapi.com/"
[4] >availabilities = MyApi::Availabilities.new
[5] >availabilities.save
# The resulting log from Farraday::Logger
INFO -- : post https://myapi.com/availabilities

[natemacinnes]

The problem is that when the site class attribute is changed after boot the connection is never rebuilt. So the URL that Faraday uses for requests is never updated. (see @url_prefix)

[1] >MyApi::Base.connection
=> #<JsonApiClient::Connection:0x007fa57b40fd30 
@faraday=#<Faraday::Connection:0x007fa57b40fa60 @parallel_manager=nil, 
@headers={"User-Agent"=>"Faraday v0.9.2"}, 
@params={}, 
@options=#<Faraday::RequestOptions (empty)>, 
@ssl=#<Faraday::SSLOptions (empty)>, 
@default_parallel_manager=nil, 
@builder=#<Faraday::RackBuilder:0x007fa57b40f538 
@handlers=[FaradayMiddleware::EncodeJson, JsonApiClient::Middleware::JsonRequest, JsonApiClient::Middleware::Status, EnjoyApi::Request, Faraday::Response::Logger, JsonApiClient::Middleware::ParseJson, Faraday::Adapter::NetHttp]>, 
@url_prefix=#<URI::HTTPS https://myapi.com/>, 
@proxy=nil>>

In the JsonApiClient::Resource class you can see on line 104 the connection does not get rebuild per request.
Calling MyApi::Base.connection(rebuild: true) will have the desired effect of changing updating the url in the connection to that of the resource's site.
As seen in the _build_conneciton function on line 281

I have successfully overwrote the site=(value) function in order to ensure that the connection is rebuilt if the site is changed.

Ex:

def site=(url)
    super(url)
    self.connection(rebuild: true)
end

[1] > MyApi::Base.site = "https://someotherapi.com/"
[2] > MyApi::Base.connection
=> #<JsonApiClient::Connection:0x007fa57b40fd30 
@faraday=#<Faraday::Connection:0x007fa57b40fa60 @parallel_manager=nil, 
@headers={"User-Agent"=>"Faraday v0.9.2"}, 
@params={}, 
@options=#<Faraday::RequestOptions (empty)>, 
@ssl=#<Faraday::SSLOptions (empty)>, 
@default_parallel_manager=nil, 
@builder=#<Faraday::RackBuilder:0x007fa57b40f538 
@handlers=[FaradayMiddleware::EncodeJson, JsonApiClient::Middleware::JsonRequest, JsonApiClient::Middleware::Status, JsonApiClient::Middleware::ParseJson, Faraday::Adapter::NetHttp]>, 
@url_prefix=#<URI::HTTPS https://someotherapi.com/>, 
@proxy=nil>>

My next challenge is adding my custom request class MyApi::Request back to the @handlers array.

UPDATE: Adding connection.use MyApi::Request after resetting the connection resolved the issue.

Once I get this project patched I will try to think of a way that this knowledge could be included in the project, if it is worthwhile.

[jessepollak]

I ran into this issue as well. It seems to me that this is a design-level issue with the library: primarily that it relies on a singleton connection to make all the requests. Ideally, there'd be a way to pass a connection object on a per-object/request basis, rather than maintaining that state at the class level.

[krainboltgreene]

Yeah, this totally kills my application's ability to communicate with multiple (yet similar) resources.

[wgrrrr]

I've opened #255 to discuss refactoring the storage of connection objects (which would impact this issue as well).

[gaorlov]

This looks resolved. Please reopen if not

[raldred]

@gaorlov I realise this is an old issue, but it is not fixed by #255.

Class Base < JsonApiClient::Resource
   self.site = 'http://host.com/v1'
end

Class Sub < Base
   self.site = 'http://host.com/v2'
end

The connection is not rebuilt and effectively caches the site originally set in the Base class
The only solution currently is to use the workaround proposed by @natemacinnes

I've adapted that slightly to also reapply any middleware

def self.site=(url)
  super(url)
  previous_middleware = connection.faraday.builder.handlers.map(&:klass)
  connection(true)
  current_middleware = connection.faraday.builder.handlers.map(&:klass)

  (previous_middleware - current_middleware).each do |middleware|
    connection.use(middleware)
  end
end