Module: ActiveRestClient::Caching::ClassMethods

Defined in:
lib/active_rest_client/caching.rb

Constant Summary collapse

@@perform_caching = 
true

Instance Method Summary collapse

Instance Method Details

#_reset_caching! ⇒ Object 



40
41
42
43
44
 
# File 'lib/active_rest_client/caching.rb', line 40

def _reset_caching!
  @@perform_caching = false
  @perform_caching = false
  @@cache_store = nil
end

#cache_store ⇒ Object 



31
32
33
34
35
36
37
38
 
# File 'lib/active_rest_client/caching.rb', line 31

def cache_store
  rails_cache_store = if Object.const_defined?(:Rails)
    ::Rails.cache
  else
    nil
  end
  (@@cache_store rescue nil) || rails_cache_store
end

#cache_store=(value) ⇒ Object

Raises:



23
24
25
26
27
28
29
 
# File 'lib/active_rest_client/caching.rb', line 23

def cache_store=(value)
  @@cache_store = nil if value.nil? and return
  raise InvalidCacheStoreException.new("Cache store does not implement #read") unless value.respond_to?(:read)
  raise InvalidCacheStoreException.new("Cache store does not implement #write") unless value.respond_to?(:write)
  raise InvalidCacheStoreException.new("Cache store does not implement #fetch") unless value.respond_to?(:fetch)
  @@cache_store = value
end

#perform_caching(value = nil) ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/active_rest_client/caching.rb', line 6

def perform_caching(value = nil)
  if value.nil?
    if @perform_caching.nil?
      @@perform_caching
    else
      @perform_caching
    end
  else
    @perform_caching = value
  end
end

#perform_caching=(value) ⇒ Object 



18
19
20
21
 
# File 'lib/active_rest_client/caching.rb', line 18

def perform_caching=(value)
  @@perform_caching = value
  @perform_caching = value
end

#read_cached_response(request) ⇒ Object 



46
47
48
49
50
51
52
53
 
# File 'lib/active_rest_client/caching.rb', line 46

def read_cached_response(request)
  if cache_store && perform_caching
    key = "#{request.class_name}:#{request.original_url}"
    ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{key} - Trying to read from cache"
    value = cache_store.read(key)
    value = Marshal.load(value) rescue value
  end
end

#write_cached_response(request, response, result) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/active_rest_client/caching.rb', line 55

def write_cached_response(request, response, result)
  return if result.is_a? Symbol
  return unless perform_caching
  return unless !result.respond_to?(:_status) || [200, 304].include?(result._status)

  response.headers.keys.select{|h| h.is_a? String}.each do |key|
    response.headers[key.downcase.to_sym] = response.headers[key]
  end

  if cache_store && (response.headers[:etag] || response.headers[:expires])
    key = "#{request.class_name}:#{request.original_url}"
    ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{key} - Writing to cache"
    cached_response = CachedResponse.new(status:response.status, result:result)
    cached_response.etag = response.headers[:etag] if response.headers[:etag]
    cached_response.expires = Time.parse(response.headers[:expires]) if response.headers[:expires]
    cache_store.write(key, Marshal.dump(cached_response), {})
  end
end