Class: Caselaw::Client

Inherits:

Object

• Object
• Caselaw::Client

Includes:

Cases, Citations, Courts, Jurisdictions, Reporters, Request, Volumes

Defined in:

lib/caselaw/client.rb

Constant Summary

Constants included from Jurisdictions

Jurisdictions::API_ENDPOINT

Constants included from Cases

Caselaw::Cases::API_ENDPOINT

Constants included from Request

Request::API_ROOT

Instance Attribute Summary

• #api_key ⇒ Object readonly

  Returns the value of attribute api_key.

Instance Method Summary

• #initialize(settings = {}) ⇒ Client constructor

  A new instance of Client.

Methods included from Jurisdictions

#jurisdiction, #search_jurisdictions

Methods included from Cases

#case, #cases_by_jurisdiction, #search_cases

Methods included from Request

#paginated_request, #parsed_response, #request, #slug

Constructor Details

#initialize(settings = {}) ⇒ Client

Returns a new instance of Client.

# File 'lib/caselaw/client.rb', line 21

def initialize(settings = {})
  fail(ArgumentError, "API key hash is required.") unless settings.is_a?(Hash)
  @api_key = settings[:api_key]
end

Instance Attribute Details

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.

# File 'lib/caselaw/client.rb', line 19

def api_key
  @api_key
end