class GdsApi::JsonClient

def self.cache(size = DEFAULT_CACHE_SIZE, ttl = DEFAULT_CACHE_TTL)

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

header if it is included in the response.
Cache TTL will be overridden for a given request/response by the Expires
def self.cache(size = DEFAULT_CACHE_SIZE, ttl = DEFAULT_CACHE_TTL)
  @cache ||= LRUCache.new(max_size: size, ttl: ttl)
end

def self.default_request_headers

def self.default_request_headers
  {
    'Accept' => 'application/json',
    # GOVUK_APP_NAME is set for all apps by Puppet
    'User-Agent' => "gds-api-adapters/#{GdsApi::VERSION} (#{ENV['GOVUK_APP_NAME']})"
  }
end

def self.default_request_with_json_body_headers

def self.default_request_with_json_body_headers
  self.default_request_headers.merge(
    'Content-Type' => 'application/json',
  )
end

def delete_json(url, additional_headers = {})

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

def delete_json_with_params!(url, params, additional_headers = {})

def delete_json_with_params!(url, params, additional_headers = {})
  warn <<-doc
    DEPRECATION NOTICE: Delete requests should not include parameters.
    Do not use this method as the ability to do this will be removed.
    Called from: #{caller[2]}
  doc
  do_json_request(:delete, url, params, additional_headers)
end

def do_json_request(method, url, params = nil, additional_headers = {}, &create_response)

from the Net::HTTPResponse
create_response: optional block to instantiate a custom response object
additional_headers: headers to set on the request (in addition to the default ones)
params: the data to send (JSON-serialised) in the request body
url: the request URL
method: the symbolic name of the method to use, e.g. :get, :post
def do_json_request(method, url, params = nil, additional_headers = {}, &create_response)
  begin
    response = do_request_with_cache(method, url, (params.to_json if params), additional_headers)
  rescue RestClient::Exception => e
    # Attempt to parse the body as JSON if possible
    error_details = begin
      e.http_body ? JSON.parse(e.http_body) : nil
    rescue JSON::ParserError
      nil
    end
    raise build_specific_http_error(e, url, error_details, params)
  end
  # If no custom response is given, just instantiate Response
  create_response ||= Proc.new { |r| Response.new(r) }
  create_response.call(response)
end

def do_raw_request(method, url, params = nil)

def do_raw_request(method, url, params = nil)
  do_request(method, url, params)
rescue RestClient::Exception => e
  raise build_specific_http_error(e, url, nil, params)
end

def do_request(method, url, params = nil, additional_headers = {})

def do_request(method, url, params = nil, additional_headers = {})
  loggable = { request_uri: url, start_time: Time.now.to_f }
  start_logging = loggable.merge(action: 'start')
  logger.debug start_logging.to_json
  method_params = {
    method: method,
    url: url,
  }
  case method
  when :get, :delete
    default_headers = self.class.default_request_headers
  else
    default_headers = self.class.default_request_with_json_body_headers
  end
  method_params[:payload] = params
  method_params = with_timeout(method_params)
  method_params = with_headers(method_params, default_headers, additional_headers)
  method_params = with_auth_options(method_params)
  if URI.parse(url).is_a? URI::HTTPS
    method_params = with_ssl_options(method_params)
  end
  return ::RestClient::Request.execute(method_params)
rescue Errno::ECONNREFUSED => e
  logger.error loggable.merge(status: 'refused', error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
  raise GdsApi::EndpointNotFound.new("Could not connect to #{url}")
rescue RestClient::Exceptions::Timeout => e
  logger.error loggable.merge(status: 'timeout', error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
  raise GdsApi::TimedOutException.new
rescue URI::InvalidURIError => e
  logger.error loggable.merge(status: 'invalid_uri', error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
  raise GdsApi::InvalidUrl
rescue RestClient::Exception => e
  # Log the error here, since we have access to loggable, but raise the
  # exception up to the calling method to deal with
  loggable.merge!(status: e.http_code, end_time: Time.now.to_f, body: e.http_body)
  logger.warn loggable.to_json
  raise
rescue Errno::ECONNRESET => e
  logger.error loggable.merge(status: 'connection_reset', error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
  raise GdsApi::TimedOutException.new
end

def do_request_with_cache(method, url, params = nil, additional_headers = {})

def do_request_with_cache(method, url, params = nil, additional_headers = {})
  # Only read GET requests from the cache: any other request methods should
  # always be passed through. Note that this means HEAD requests won't get
  # cached, but that would involve separating the cache by method and URL.
  # Also, we don't generally make HEAD requests.
  use_cache = (method == :get)
  if use_cache
    cached_response = @cache[url]
    return cached_response if cached_response
  end
  response = do_request(method, url, params, additional_headers)
  if use_cache
    cache_time = response_cache_time(response)
    # If cache_time is nil, this will fall back on @cache's default
    @cache.store(url, response, cache_time)
  end
  response
end

def get_json(url, additional_headers = {}, &create_response)

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

def get_raw(url)

def get_raw(url)
  get_raw!(url)
end

def get_raw!(url)

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

def initialize(options = {})

def initialize(options = {})
  if options[:disable_timeout] || options[:timeout].to_i < 0
    raise "It is no longer possible to disable the timeout."
  end
  @logger = options[:logger] || NullLogger.instance
  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

def patch_json(url, params, additional_headers = {})

def patch_json(url, params, additional_headers = {})
  do_json_request(:patch, url, params, additional_headers)
end

def post_json(url, params = {}, additional_headers = {})

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

def post_multipart(url, params)

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

def put_json(url, params, additional_headers = {})

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

def put_multipart(url, params)

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

def response_cache_time(response)

or nil if no cache information is provided
Return either a Time object representing the expiry time of the response
def response_cache_time(response)
  if response.headers[:cache_control]
    cache_control = Rack::Cache::CacheControl.new(response.headers[:cache_control])
    if cache_control.private? || cache_control.no_cache? || cache_control.no_store?
      Time.now.utc
    elsif cache_control.max_age
      Time.now.utc + cache_control.max_age
    end
  elsif response.headers[:expires]
    Time.httpdate response.headers[:expires]
  end
end

def with_auth_options(method_params)

parameters with authentication information included
Take a hash of parameters for Request#execute; return a hash of
def with_auth_options(method_params)
  if @options[:bearer_token]
    headers = method_params[:headers] || {}
    method_params.merge(headers: headers.merge(
      "Authorization" => "Bearer #{@options[:bearer_token]}"
    ))
  elsif @options[:basic_auth]
    method_params.merge(
      user: @options[:basic_auth][:user],
      password: @options[:basic_auth][:password]
    )
  else
    method_params
  end
end

def with_headers(method_params, default_headers, additional_headers)

def with_headers(method_params, default_headers, additional_headers)
  method_params.merge(
    headers: default_headers
      .merge(method_params[:headers] || {})
      .merge(GdsApi::GovukHeaders.headers)
      .merge(additional_headers)
  )
end

def with_ssl_options(method_params)

def with_ssl_options(method_params)
  method_params.merge(
    # This is the default value anyway, but we should probably be explicit
    verify_ssl: OpenSSL::SSL::VERIFY_NONE
  )
end

def with_timeout(method_params)

parameters with timeouts included
Take a hash of parameters for Request#execute; return a hash of
def with_timeout(method_params)
  method_params.merge(
    timeout: options[:timeout] || DEFAULT_TIMEOUT_IN_SECONDS,
    open_timeout: options[:timeout] || DEFAULT_TIMEOUT_IN_SECONDS,
  )
end