Class: ShopifyGraphql::Client

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

Constant Summary collapse

RETRIABLE_EXCEPTIONS = 
[
  Errno::ETIMEDOUT,
  Errno::ECONNREFUSED,
  Errno::EHOSTUNREACH,
  'Timeout::Error',
  Faraday::TimeoutError,
  Faraday::RetriableResponse,
  Faraday::ParsingError,
  Faraday::ConnectionFailed,
].freeze

Instance Method Summary collapse

Constructor Details

#initialize(api_version = ShopifyAPI::Base.api_version) ⇒ Client

Returns a new instance of Client.



14
15
16
 
# File 'lib/shopify_graphql/client.rb', line 14

def initialize(api_version = ShopifyAPI::Base.api_version)
  @api_version = api_version
end

Instance Method Details

#api_url ⇒ Object 



31
32
33
 
# File 'lib/shopify_graphql/client.rb', line 31

def api_url
  [ShopifyAPI::Base.site, @api_version.construct_graphql_path].join
end

#connection ⇒ Object 



39
40
41
42
43
44
45
 
# File 'lib/shopify_graphql/client.rb', line 39

def connection
  @connection ||= Faraday.new(url: api_url, headers: request_headers) do |conn|
    conn.request :json
    conn.response :json, parser_options: { object_class: OpenStruct }
    conn.request :retry, max: 3, interval: 1, backoff_factor: 2, exceptions: RETRIABLE_EXCEPTIONS
  end
end

#execute(query, **variables) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/shopify_graphql/client.rb', line 18

def execute(query, **variables)
  operation_name = variables.delete(:operation_name)
  response = connection.post do |req|
    req.body = {
      query: query,
      operationName: operation_name,
      variables: variables,
    }.to_json
  end
  response = handle_response(response)
  ShopifyGraphql::Response.new(response)
end

#handle_graphql_errors(response) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/shopify_graphql/client.rb', line 82

def handle_graphql_errors(response)
  return response if response.errors.blank?

  error = response.errors.first
  error_message = error.message
  error_code = error.extensions&.code
  error_doc = error.extensions&.documentation

  case error_code
  when "THROTTLED"
    raise TooManyRequests.new(response, error_message, code: error_code, doc: error_doc)
  else
    raise ConnectionError.new(response, error_message, code: error_code, doc: error_doc)
  end
end

#handle_response(response) ⇒ Object 



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
 
# File 'lib/shopify_graphql/client.rb', line 47

def handle_response(response)
  case response.status
  when 200..400
    handle_graphql_errors(response.body)
  when 400
    raise BadRequest.new(response.body, code: response.status)
  when 401
    raise UnauthorizedAccess.new(response.body, code: response.status)
  when 402
    raise PaymentRequired.new(response.body, code: response.status)
  when 403
    raise ForbiddenAccess.new(response.body, code: response.status)
  when 404
    raise ResourceNotFound.new(response.body, code: response.status)
  when 405
    raise MethodNotAllowed.new(response.body, code: response.status)
  when 409
    raise ResourceConflict.new(response.body, code: response.status)
  when 410
    raise ResourceGone.new(response.body, code: response.status)
  when 412
    raise PreconditionFailed.new(response.body, code: response.status)
  when 422
    raise ResourceInvalid.new(response.body, code: response.status)
  when 429
    raise TooManyRequests.new(response.body, code: response.status)
  when 401...500
    raise ClientError.new(response.body, code: response.status)
  when 500...600
    raise ServerError.new(response.body, code: response.status)
  else
    raise ConnectionError.new(response.body, "Unknown response code: #{response.status}")
  end
end

#handle_user_errors(response) ⇒ Object

Raises:



98
99
100
101
102
103
104
105
106
107
 
# File 'lib/shopify_graphql/client.rb', line 98

def handle_user_errors(response)
  return response if response.userErrors.blank?

  error = response.userErrors.first
  error_message = error.message
  error_fields = error.field
  error_code = error.code

  raise UserError.new(response, error_message, fields: error_fields, code: error_code)
end

#request_headers ⇒ Object 



35
36
37
 
# File 'lib/shopify_graphql/client.rb', line 35

def request_headers
  ShopifyAPI::Base.headers
end