Class: APIConsumer

Inherits:
Object
  • Object
show all
Defined in:
lib/api_consumer.rb

Constant Summary collapse

DEFAULT_REQUEST_OPTS = 
{
  :method => :get,
  :headers => {
    "Accept" => "application/json",
    "Content-Type" => "application/json",
    "User-Agent" => "API-CONSUMER-#{ENV['RACK_ENV'] || 'dev'}"
  },
  :ttl => 300
}

Class Method Summary collapse

Class Method Details

.cache ⇒ Object 



170
171
172
 
# File 'lib/api_consumer.rb', line 170

def cache
  @cache ||= UberCache.new(settings[:cache_prefix], settings[:memcache_hosts])
end

.connection(connection_flag = :normal) ⇒ Object 



148
149
150
151
152
 
# File 'lib/api_consumer.rb', line 148

def connection(connection_flag = :normal)
  @connections ||= {}
  return @connections[connection_flag] if @connections[connection_flag]
  @connections[connection_flag] = create_connection
end

.create_connection(debug = false) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/api_consumer.rb', line 154

def create_connection(debug = false)
  if @uri.nil? || @uri.port.nil?
    log.info "CONNECTING TO: #{settings[:url]}"
    @uri = URI.parse("#{settings[:url]}/")
  end
  http = Net::HTTP.new(@uri.host, @uri.port)
  if settings[:ssl] == true
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
  end
  http.set_debug_output $stderr if debug
  http.open_timeout = 7
  http.read_timeout = 15
  http
end

.do_request(path, conn, opts = {}, &blk) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/api_consumer.rb', line 76

def do_request(path, conn, opts = {}, &blk)
  if(opts[:verbose])
    log.debug("Sending request to: #{conn.address}#{':' + conn.port.to_s if conn.port}#{path}")
  end
  if opts[:key] # cache if key sent
    read_val = nil
    return read_val if !opts[:reload] && read_val = cache.obj_read(opts[:key])
    opts[:ttl] ||= settings[:ttl] || DEFAULT_REQUEST_OPTS[:ttl]
  end
  opts[:headers] = DEFAULT_REQUEST_OPTS[:headers].merge(opts[:headers] || {})
  opts[:method] = opts[:method] || DEFAULT_REQUEST_OPTS[:method]

  req = if( opts[:method] == :get)
    Net::HTTP::Get.new(path)
  elsif( opts[:method] == :post)
    Net::HTTP::Post.new(path)
  elsif( opts[:method] == :delete)
    Net::HTTP::Delete.new(path)
  elsif( opts[:method] == :put)
    Net::HTTP::Put.new(path)
  else
    log.error "Unhandled HTTP method => (#{opts[:method]})"
  end
  opts[:headers].each { |k,v| req[k] = v }
  settings[:headers].each { |k,v| req[k] = v } if settings[:headers]
  req.basic_auth settings[:api_user], settings[:api_password] if settings[:api_user] && settings[:api_password]
  req["connection"] = 'keep-alive'
  req.body = opts[:body] if opts[:body]

  response = nil
  begin
    log.debug "CONN:" + conn.inspect
    log.debug "REQ:" + req.inspect
    response = conn.request(req)
    if( settings[:type] == "json")
      results = JSON.parse(response.body)
      if ![200, 201].include?(response.code.to_i)
        results = error_code(response.code, opts[:errors], results)
      end
      results = blk.call(results) if blk
      begin
        cache.obj_write(opts[:key], results, :ttl => opts[:ttl]) if opts[:key]
      rescue Exception => exception
        # write error messages to the log file but ignore exceptions in writing data to cache
        log.error exception.message
        log.error exception.backtrace
      end
      return results
    elsif( settings[:type] == "rss")
      rss = Nokogiri::XML(response.body)
      return rss.xpath("//item").map{ |i|
        { 'title' => i.xpath('title').inner_text,
          'link' => i.xpath('link').inner_text,
          'description' => i.xpath('description').inner_text
        }
      }
    elsif( settings[:type] == "xml")
      return Nori.new(nori_settings).parse(response.body)
    end
  rescue Exception => exception
    log.error exception.message
    log.error exception.backtrace
    if( settings[:type] == "json")
      return error_code(response ? response.code : "NO CODE" , opts[:errors])
    end
  end
  data = response.body
  data = blk.call(data) if blk
  cache.obj_write(opts[:key], data, :ttl => opts[:ttl]) if opts[:key]
  return data
end

.inherited(subclass) ⇒ Object 



13
14
15
16
17
18
 
# File 'lib/api_consumer.rb', line 13

def inherited(subclass)
  configs = YAML.load_file("config/#{snake_case(subclass)}.yml")
  configs[snake_case(subclass)].each{ |k,v| subclass.set(k.to_sym, v) }
  subclass.set_logger(Logger.new(subclass.settings[:log_file] || "./log/#{snake_case(subclass)}_api.log"), subclass.settings[:log_level])
  super
end

.log ⇒ Object 



25
26
27
 
# File 'lib/api_consumer.rb', line 25

def log
  @logger
end

.memcache? ⇒ Boolean

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/api_consumer.rb', line 51

def memcache?
  settings[:use_memcache]
end

.memcache_hosts ⇒ Object 



55
56
57
 
# File 'lib/api_consumer.rb', line 55

def memcache_hosts
  settings[:memcache_hosts]
end

.set(key, val) ⇒ Object 



59
60
61
 
# File 'lib/api_consumer.rb', line 59

def set(key, val)
  settings[key] = val
end

.set_log_level(level = nil) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/api_consumer.rb', line 29

def set_log_level(level=nil)
  if level.nil?
    level = if([nil, "development", "test"].include?(ENV['RACK_ENV']))
      :info
    else
      :warn
    end
  end
  @logger.level = case level.to_sym
  when :debug
    Logger::DEBUG
  when :info
    Logger::INFO
  when :error
    Logger::ERROR
  when :fatal
    Logger::FATAL
  else #warn
    Logger::WARN
  end
end

.set_logger(logger, level = nil) ⇒ Object 



20
21
22
23
 
# File 'lib/api_consumer.rb', line 20

def set_logger(logger, level=nil)
  @logger = logger.nil? ? Logger.new(STDERR) : logger
  set_log_level(level)
end

.settings ⇒ Object 



63
64
65
 
# File 'lib/api_consumer.rb', line 63

def settings
  @settings ||= {}
end