Module: ACTV::Default

Defined in:
lib/actv/default.rb

Class Method Summary collapse

Class Method Details

.api_key ⇒ Object 



81
82
83
 
# File 'lib/actv/default.rb', line 81

def api_key
  nil
end

.connection_options ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/actv/default.rb', line 34

def connection_options
  @connection_options ||= {
    :headers => {
      :accept => 'application/json',
      :user_agent => "Active Ruby Gem #{ACTV::VERSION}"
    },
    :open_timeout => 5,
    :raw => true,
    :ssl => {:verify => false},
    :timeout => 10,
  }
end

.consumer_key ⇒ Object 



65
66
67
 
# File 'lib/actv/default.rb', line 65

def consumer_key
  ENV['ACTV_CONSUMER_KEY']
end

.consumer_secret ⇒ Object 



69
70
71
 
# File 'lib/actv/default.rb', line 69

def consumer_secret
  ENV['ACTV_CONSUMER_SECRET']
end

.endpoint ⇒ Object

Note:

This is configurable in case you want to use HTTP instead of HTTPS or use a Active-compatible endpoint.

See Also:



22
23
24
 
# File 'lib/actv/default.rb', line 22

def endpoint
  @endpoint ||= 'http://api.amp.active.com'
end

.media_endpoint ⇒ Object 



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

def media_endpoint
  @media_endpoint ||= 'https://upload.active.com'
end

.middleware ⇒ Object

Note:

Faraday’s middleware stack implementation is comparable to that of Rack middleware. The order of middleware is important: the first middleware on the list wraps all others, while the last middleware is the innermost one.

See Also:



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/actv/default.rb', line 50

def middleware
  @middleware ||= Faraday::Builder.new(
    &Proc.new do |builder|
      builder.use ACTV::Request::MultipartWithFile # Convert file uploads to Faraday::UploadIO objects
      builder.use Faraday::Request::Multipart         # Checks for files in the payload
      builder.use Faraday::Request::UrlEncoded        # Convert request params as "www-form-urlencoded"
      builder.use ACTV::Response::RaiseClientError # Handle 4xx server responses
      builder.use ACTV::Response::ParseJson        # Parse JSON response bodies using MultiJson
      builder.use ACTV::Response::RaiseServerError # Handle 5xx server responses
      # builder.use ACTV::Response::RateLimit        # Update RateLimit object
      builder.adapter Faraday.default_adapter         # Set Faraday's HTTP adapter
    end
  )
end

.oauth_token ⇒ Object 



73
74
75
 
# File 'lib/actv/default.rb', line 73

def oauth_token
  ENV['ACTV_OAUTH_TOKEN']
end

.oauth_token_secret ⇒ Object 



77
78
79
 
# File 'lib/actv/default.rb', line 77

def oauth_token_secret
  ENV['ACTV_OAUTH_TOKEN_SECRET']
end

.options ⇒ Object 



14
15
16
 
# File 'lib/actv/default.rb', line 14

def options
  Hash[ACTV::Configurable.keys.map{|key| [key, send(key)]}]
end

.search_endpoint ⇒ Object 



30
31
32
 
# File 'lib/actv/default.rb', line 30

def search_endpoint
  @search_endpoint ||= 'https://search.active.com'
end