Class: SongstatsSDK::HTTPClient

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

Constant Summary collapse

DEFAULT_BASE_URL = 
"https://api.songstats.com"
DEFAULT_TIMEOUT_SECONDS = 
30
RETRYABLE_STATUS_CODES = 
[429, 500, 502, 503, 504].freeze
RETRYABLE_EXCEPTIONS = 
[
  EOFError,
  IOError,
  SocketError,
  Timeout::Error,
  Errno::ECONNRESET,
  Errno::ECONNREFUSED,
  Errno::ETIMEDOUT,
  Net::OpenTimeout,
  Net::ReadTimeout
].freeze

Instance Method Summary collapse

Constructor Details

#initialize(api_key:, base_url: DEFAULT_BASE_URL, timeout: DEFAULT_TIMEOUT_SECONDS, max_retries: 2, adapter: nil, user_agent: nil) ⇒ HTTPClient

Returns a new instance of HTTPClient.

Raises:

  • (ArgumentError) 


57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/songstats_sdk/http_client.rb', line 57

def initialize(api_key:, base_url: DEFAULT_BASE_URL, timeout: DEFAULT_TIMEOUT_SECONDS, max_retries: 2, adapter: nil,
  user_agent: nil)
  raise ArgumentError, "api_key is required" if api_key.to_s.empty?
  raise ArgumentError, "max_retries must be >= 0" if max_retries.to_i.negative?

  @api_key = api_key
  @base_url = base_url
  @timeout = timeout
  @max_retries = max_retries.to_i
  @adapter = adapter || NetHTTPAdapter.new
  @user_agent = user_agent || "songstats-ruby-sdk/#{VERSION}"
end

Instance Method Details

#close ⇒ Object 



70
71
72
 
# File 'lib/songstats_sdk/http_client.rb', line 70

def close
  @adapter.close if @adapter.respond_to?(:close)
end

#request(method, path, params: nil, json: nil) ⇒ Object 



74
75
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
 
# File 'lib/songstats_sdk/http_client.rb', line 74

def request(method, path, params: nil, json: nil)
  endpoint = "/enterprise/v1/#{path.to_s.delete_prefix('/')}"
  attempts = 0

  loop do
    begin
      response = @adapter.request(
        method: method.to_sym,
        base_url: @base_url,
        path: endpoint,
        headers: request_headers,
        params: params,
        json: json,
        timeout: @timeout
      )
    rescue *RETRYABLE_EXCEPTIONS => e
      if attempts < @max_retries
        sleep(backoff_seconds(attempts))
        attempts += 1
        next
      end
      raise SongstatsTransportError, e.message
    end

    if RETRYABLE_STATUS_CODES.include?(response.status) && attempts < @max_retries
      sleep(backoff_seconds(attempts))
      attempts += 1
      next
    end

    return decode_response(response.body) if response.status.between?(200, 299)

    raise build_api_error(response)
  end
end