Class: ShopifyAPI::Clients::HttpClient

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/shopify_api/clients/http_client.rb

Direct Known Subclasses

Rest::Admin

Constant Summary collapse

RETRY_WAIT_TIME = 
1

Instance Method Summary collapse

Constructor Details

#initialize(base_path:, session: nil) ⇒ HttpClient

Returns a new instance of HttpClient.

Raises:



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/shopify_api/clients/http_client.rb', line 12

def initialize(base_path:, session: nil)
  session ||= Context.active_session
  raise Errors::NoActiveSessionError, "No passed or active session" unless session

  api_host = Context.api_host

  @base_uri = T.let("https://#{api_host || session.shop}", String)
  @base_uri_and_path = T.let("#{@base_uri}#{base_path}", String)

  user_agent_prefix = Context.user_agent_prefix.nil? ? "" : "#{Context.user_agent_prefix} | "

  @headers = T.let({
    "User-Agent": "#{user_agent_prefix}Shopify API Library v#{VERSION} | Ruby #{RUBY_VERSION}",
    "Accept": "application/json",
  }, T::Hash[T.any(Symbol, String), T.untyped])

  @headers["Host"] = session.shop unless api_host.nil?

  unless session.access_token.nil? || T.must(session.access_token).empty?
    @headers["X-Shopify-Access-Token"] = T.cast(session.access_token, String)
  end
end

Instance Method Details

#request(request, response_as_struct: false) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/shopify_api/clients/http_client.rb', line 36

def request(request, response_as_struct: false)
  request.verify

  headers = @headers
  headers["Content-Type"] = T.must(request.body_type) if request.body_type
  headers = headers.merge(T.must(request.extra_headers)) if request.extra_headers

  tries = 0
  response = HttpResponse.new(code: 0, headers: {}, body: "")
  while tries < request.tries
    tries += 1
    res = T.cast(HTTParty.send(
      request.http_method,
      request_url(request),
      headers: headers,
      query: request.query,
      body: request.body.class == Hash ? T.unsafe(request.body).to_json : request.body,
    ), HTTParty::Response)

    begin
      body = res.body.nil? || res.body.empty? ? {} : JSON.parse(res.body)
    rescue JSON::ParserError
      raise if res.code.to_i < 500

      body = res.body
    end

    if response_as_struct && body.is_a?(Hash)
      json_body = body.to_json
      body = JSON.parse(json_body, object_class: OpenStruct)
    end

    response = HttpResponse.new(code: res.code.to_i, headers: res.headers.to_h, body: body)

    if response.headers["x-shopify-api-deprecated-reason"]
      reason = T.must(response.headers["x-shopify-api-deprecated-reason"])[0]
      Context.logger.warn("Deprecated request to Shopify API at #{request.path}, received reason: #{reason}")
    end

    break if response.ok?

    error_message = serialized_error(response)

    unless [429, 500].include?(response.code)
      raise ShopifyAPI::Errors::HttpResponseError.new(response: response), error_message
    end

    if tries == request.tries
      raise ShopifyAPI::Errors::HttpResponseError.new(response: response), error_message if request.tries == 1

      raise ShopifyAPI::Errors::MaxHttpRetriesExceededError.new(response: response),
        "Exceeded maximum retry count of #{request.tries}. Last message: #{error_message}"
    end

    if response.code == 500 || response.headers["retry-after"].nil?
      sleep(RETRY_WAIT_TIME)
    else
      sleep(T.must(response.headers["retry-after"])[0].to_i)
    end
  end

  response
end