Module: Caselaw

Defined in:
lib/caselaw.rb,
lib/caselaw/client.rb,
lib/caselaw/errors.rb,
lib/caselaw/request.rb,
lib/caselaw/version.rb,
lib/caselaw/client/cases.rb,
lib/caselaw/jurisdiction.rb,
lib/caselaw/client/courts.rb,
lib/caselaw/client/volumes.rb,
lib/caselaw/client/citations.rb,
lib/caselaw/client/reporters.rb,
lib/caselaw/client/jurisdictions.rb

Defined Under Namespace

Modules: Cases, Citations, Courts, Jurisdictions, Reporters, Request, Volumes Classes: Client, ConfigurationError, Error, Forbidden, Jurisdiction, NotFound, Unauthorized

Constant Summary collapse

VERSION = 
"0.1.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.settings ⇒ Object

Returns the value of attribute settings.



9
10
11
 
# File 'lib/caselaw.rb', line 9

def settings
  @settings
end

Class Method Details

.configuration ⇒ Object

Return global config hash



26
27
28
 
# File 'lib/caselaw.rb', line 26

def self.configuration
  settings
end

.configure(params = {}) ⇒ Object

Global configuration settings



18
19
20
21
22
23
 
# File 'lib/caselaw.rb', line 18

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

.new(params = {}) ⇒ Object 



13
14
15
 
# File 'lib/caselaw.rb', line 13

def self.new(params = {})
  Caselaw::Client.new(params)
end

.reset_configuration ⇒ Object

Resets the global configuration



31
32
33
 
# File 'lib/caselaw.rb', line 31

def self.reset_configuration
  self.settings = {}
end