Class: GdsApi::JsonClient

Inherits:
Object
  • Object
show all
Includes:
ExceptionHandling
Defined in:
lib/gds_api/json_client.rb

Constant Summary collapse

DEFAULT_REQUEST_HEADERS = 
{
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
    'User-Agent' => "GDS Api Client v. #{GdsApi::VERSION}"
}
DEFAULT_TIMEOUT_IN_SECONDS = 
4
DEFAULT_CACHE_SIZE = 
100
DEFAULT_CACHE_TTL =

15 minutes

15 * 60

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ExceptionHandling

#build_specific_http_error, #ignoring, #ignoring_missing

Constructor Details

#initialize(options = {}) ⇒ JsonClient

Returns a new instance of JsonClient.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/gds_api/json_client.rb', line 36

def initialize(options = {})
  if options[:disable_timeout] or options[:timeout].to_i < 0
    raise "It is no longer possible to disable the timeout."
  end

  @logger = options[:logger] || GdsApi::Base.logger

  if options[:disable_cache] || (options[:cache_size] == 0)
    @cache = NullCache.new
  else
    cache_size = options[:cache_size] || DEFAULT_CACHE_SIZE
    cache_ttl = options[:cache_ttl] || DEFAULT_CACHE_TTL
    @cache = JsonClient.cache(cache_size, cache_ttl)
  end
  @options = options
end

Instance Attribute Details

#cache ⇒ Object

Returns the value of attribute cache.



34
35
36
 
# File 'lib/gds_api/json_client.rb', line 34

def cache
  @cache
end

#logger ⇒ Object

Returns the value of attribute logger.



34
35
36
 
# File 'lib/gds_api/json_client.rb', line 34

def logger
  @logger
end

#options ⇒ Object

Returns the value of attribute options.



34
35
36
 
# File 'lib/gds_api/json_client.rb', line 34

def options
  @options
end

Class Method Details

.cache(size = DEFAULT_CACHE_SIZE, ttl = DEFAULT_CACHE_TTL) ⇒ Object

Cache TTL will be overridden for a given request/response by the Expires header if it is included in the response.

LRUCache doesn’t respect a cache size of 0, and instead effectively creates a cache with a size of 1.



19
20
21
 
# File 'lib/gds_api/json_client.rb', line 19

def self.cache(size=DEFAULT_CACHE_SIZE, ttl=DEFAULT_CACHE_TTL)
  @cache ||= LRUCache.new(max_size: size, ttl: ttl)
end

.cache=(c) ⇒ Object

Set the caching implementation. Default is LRUCache. Can be Anything which responds to:

[](key)
[]=(key, value)
store(key, value, expiry_time=nil) - or a Ruby Time object



30
31
32
 
# File 'lib/gds_api/json_client.rb', line 30

def self.cache=(c)
  @cache = c
end

Instance Method Details

#delete_json!(url, params = nil, additional_headers = {}) ⇒ Object 



98
99
100
 
# File 'lib/gds_api/json_client.rb', line 98

def delete_json!(url, params = nil, additional_headers = {})
  do_json_request(:delete, url, params, additional_headers)
end

#get_json!(url, additional_headers = {}, &create_response) ⇒ Object 



86
87
88
 
# File 'lib/gds_api/json_client.rb', line 86

def get_json!(url, additional_headers = {}, &create_response)
  do_json_request(:get, url, nil, additional_headers, &create_response)
end

#get_raw(url) ⇒ Object 



66
67
68
69
70
 
# File 'lib/gds_api/json_client.rb', line 66

def get_raw(url)
  ignoring_missing do
    get_raw!(url)
  end
end

#get_raw!(url) ⇒ Object 



62
63
64
 
# File 'lib/gds_api/json_client.rb', line 62

def get_raw!(url)
  do_raw_request(:get, url)
end

#post_json!(url, params = {}, additional_headers = {}) ⇒ Object 



90
91
92
 
# File 'lib/gds_api/json_client.rb', line 90

def post_json!(url, params = {}, additional_headers = {})
  do_json_request(:post, url, params, additional_headers)
end

#post_multipart(url, params) ⇒ Object 



102
103
104
105
106
107
 
# File 'lib/gds_api/json_client.rb', line 102

def post_multipart(url, params)
  r = do_raw_request(:post, url, params.merge({
    :multipart => true
  }))
  Response.new(r)
end

#put_json!(url, params, additional_headers = {}) ⇒ Object 



94
95
96
 
# File 'lib/gds_api/json_client.rb', line 94

def put_json!(url, params, additional_headers = {})
  do_json_request(:put, url, params, additional_headers)
end

#put_multipart(url, params) ⇒ Object 



109
110
111
112
113
114
 
# File 'lib/gds_api/json_client.rb', line 109

def put_multipart(url, params)
  r = do_raw_request(:put, url, params.merge({
    :multipart => true
  }))
  Response.new(r)
end