Class: OpenDataAPIRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/opendata-api/request.rb

Constant Summary collapse

@@api_key = 
''
@@uri_base = 
''
@@http_base = 
''

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(http, uri, api_key) ⇒ OpenDataAPIRequest

Returns a new instance of OpenDataAPIRequest.



8
9
10
11
12
13
 
# File 'lib/opendata-api/request.rb', line 8

def initialize(http, uri, api_key)
  @http = http
  @uri = uri
  @api_key = api_key
  @request = self.generate_request_for_api(uri, api_key)
end

Instance Attribute Details

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



2
3
4
 
# File 'lib/opendata-api/request.rb', line 2

def api_key
  @api_key
end

#request ⇒ Object (readonly)

Returns the value of attribute request.



2
3
4
 
# File 'lib/opendata-api/request.rb', line 2

def request
  @request
end

Class Method Details

.api_key ⇒ Object 



15
16
17
 
# File 'lib/opendata-api/request.rb', line 15

def self.api_key()
  @@api_key
end

.http_base ⇒ Object 



31
32
33
 
# File 'lib/opendata-api/request.rb', line 31

def self.http_base()
  @@http_base
end

.set_api_key(api_key) ⇒ Object 



19
20
21
 
# File 'lib/opendata-api/request.rb', line 19

def self.set_api_key(api_key)
  @@api_key = api_key
end

.set_http_base(http_base) ⇒ Object 



35
36
37
 
# File 'lib/opendata-api/request.rb', line 35

def self.set_http_base(http_base)
  @@http_base = http_base
end

.set_uri_base(uri_base) ⇒ Object 



27
28
29
 
# File 'lib/opendata-api/request.rb', line 27

def self.set_uri_base(uri_base)
  @@uri_base = uri_base
end

.uri_base ⇒ Object 



23
24
25
 
# File 'lib/opendata-api/request.rb', line 23

def self.uri_base()
  @@uri_base
end

Instance Method Details

#fetch(http_session, request, limit = 10) ⇒ Object

Fetch specific request



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/opendata-api/request.rb', line 54

def fetch(http_session, request, limit = 10)
  raise "Too many HTTP redirects" if limit == 0
  response = http_session.request(request) # Net::HTTPResponse object
  
  case response
  when Net::HTTPSuccess then
    if response['content-type'] =~ /json/i
      # puts """Response:\n\t
      # Code: #{response.code}\n\t
      # Message: #{response.message}\n\t
      # Class: #{response.class.name}\n\t
      # Headers: \n #{JSON.pretty_generate(response.to_hash)}
      # Body: \n #{JSON.pretty_generate(JSON.parse(response.body))}
      # """ 
      # puts "Response code #{response.code} for request to: #{request.uri}"
      response
    else
      raise Exception.new("Only JSON response supported")
    end
  when Net::HTTPRedirection then
    location = response['location']
    # puts Net::HTTP.get(URI.parse(location))
    warn "Redirected to #{location}"
    request = Net::HTTP::Get.new(location)
    self.fetch(http_session, request, limit - 1)
  else
    raise Exception.new("Unsupported HTTP Response #{response.inspect}")
  end
end

#generate_request_for_api(uri, api_key) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/opendata-api/request.rb', line 39

def generate_request_for_api(uri, api_key)
  # puts "Generating Request for URI: #{uri.to_s}\nURI Host/Port: #{uri.host}, #{uri.port}"
  request = Net::HTTP::Get.new(uri)

  request.initialize_http_header({
    "Accept" => "application/json",
    "Content-Type" => "application/json",
    "Authorization" => "apikey #{api_key}",
    "User-Agent" => "ruby/net::http"
  })
  # puts "Generated Request with Headers: #{request.to_hash.inspect}"
  request
end