Class: Reddit::Base::BasicClient

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/reddit/base/basic_client.rb

Overview

Basic client that doesn’t make assumptions regarding response type.

The reddit API isn’t always consistent with its response types so may return HTML even when JSON is requested. Error pages are a common and unavoidable example.

Direct Known Subclasses

Client

Constant Summary collapse

DEFAULT_URL = 
'http://www.reddit.com'.freeze
DEFAULT_URL_SECURE = 
'https://ssl.reddit.com'.freeze
DEFAULT_OPTIONS = 
{
  headers: {'User-Agent' => "reddit-base, a reddit client for ruby by /u/dobs (v#{VERSION})"},
  rem: true,
  retries: 3,
  secure: false
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ BasicClient

Returns a new instance of BasicClient.



47
48
49
 
# File 'lib/reddit/base/basic_client.rb', line 47

def initialize(options)
  build_connection(options)
end

Instance Attribute Details

#connection ⇒ Object (readonly)

Returns the value of attribute connection.



21
22
23
 
# File 'lib/reddit/base/basic_client.rb', line 21

def connection
  @connection
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



21
22
23
 
# File 'lib/reddit/base/basic_client.rb', line 21

def options
  @options
end

Instance Method Details

#build_connection(options) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/reddit/base/basic_client.rb', line 25

def build_connection(options)
  @options = DEFAULT_OPTIONS.merge(options)

  @headers = @options.delete(:headers)
  @retries = @options.delete(:retries)
  @secure  = @options.delete(:secure)

  @url = @options[:url] || (@secure ? DEFAULT_URL_SECURE : DEFAULT_URL)

  @connection = Faraday.new(url: @url, headers: @headers) do |builder|
    builder.request  :multipart
    builder.request  :url_encoded
    builder.request  :reddit_authentication, @options
    builder.request  :retry, max: @retries, interval: 2, exceptions: FaradayMiddleware::Reddit::RETRIABLE_ERRORS
    builder.response :follow_redirects
    builder.response :reddit_raise_error
    builder.use      :reddit_modhash
    builder.use      :reddit_rate_limit
    builder.adapter  Faraday.default_adapter
  end
end