Module: ActiveRemote::Integration

Extended by:
ActiveSupport::Concern
Included in:
Base
Defined in:
lib/active_remote/integration.rb

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#cache_key ⇒ Object

Returns a stable cache key that can be used to identify this record.

Product.new.cache_key     # => "products/new"
Product.find(5).cache_key # => "products/5"

If ActiveRecord::Base.cache_versioning is turned off, as it was in Rails 5.1 and earlier, the cache key will also include a version.

Product.cache_versioning = false
Person.find(5).cache_key  # => "people/5-20071224150000" (updated_at available)



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/active_remote/integration.rb', line 62

def cache_key
  case
  when new_record? then
    "#{model_name.cache_key}/new"
  when ::ActiveRemote.config.default_cache_key_updated_at? && (timestamp = self[:updated_at]) then
    timestamp = timestamp.utc.to_s(self.class.cache_timestamp_format)
    "#{model_name.cache_key}/#{send(primary_key)}-#{timestamp}"
  else
    "#{model_name.cache_key}/#{send(primary_key)}"
  end
end

#cache_key_with_version ⇒ Object

Returns a cache key along with the version.



75
76
77
78
79
80
81
 
# File 'lib/active_remote/integration.rb', line 75

def cache_key_with_version
  if (version = cache_version)
    "#{cache_key}-#{version}"
  else
    cache_key
  end
end

#cache_version ⇒ Object

Returns a cache version that can be used together with the cache key to form a recyclable caching scheme. By default, the #updated_at column is used for the cache_version, but this method can be overwritten to return something else.

Note, this method will return nil if ActiveRecord::Base.cache_versioning is set to false (which it is by default until Rails 6.0).



89
90
91
92
93
 
# File 'lib/active_remote/integration.rb', line 89

def cache_version
  if cache_versioning && (timestamp = try(:updated_at))
    timestamp.utc.to_s(:usec)
  end
end

#to_param ⇒ Object

Returns a String, which Action Pack uses for constructing a URL to this object. The default implementation returns this record's id as a String, or nil if this record's unsaved.

For example, suppose that you have a User model, and that you have a resources :users route. Normally, user_path will construct a path with the user object's 'id' in it:

user = User.find_by(name: 'Phusion')
user_path(user)  # => "/users/1"

You can override to_param in your model to make user_path construct a path using the user's name instead of the user's id:

class User < ActiveRecord::Base
  def to_param  # overridden
    name
  end
end

user = User.find_by(name: 'Phusion')
user_path(user)  # => "/users/Phusion"



46
47
48
49
 
# File 'lib/active_remote/integration.rb', line 46

def to_param
  key = send(primary_key)
  key&.to_s
end