Class: Webex::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/webex/request.rb

Constant Summary collapse

CLIENT_ERROR_STATUSES = 
(400...500).freeze
SERVER_ERROR_STATUSES = 
(500...600).freeze
UUID_REGEX_VALIDATOR = 
/\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(query:, variables:, operation_name:, headers: {}) ⇒ Request

Returns a new instance of Request.



9
10
11
12
13
14
15
16
17
 
# File 'lib/webex/request.rb', line 9

def initialize(query:, variables:, operation_name:, headers: {})
  @query = query
  @variables = variables
  @operation_name = operation_name
  @headers = headers
  @access_token = Webex::Events::Config.access_token
  @connection = self.class.connection
  validate_idempotency_key
end

Class Method Details

.connection ⇒ Faraday::Connection

Creates a Faraday connection instance.

Returns:

  • (Faraday::Connection) 


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/webex/request.rb', line 100

def self.connection
  Thread.current[:webex_events_connection] ||= Faraday.new(url: Webex::Events.endpoint_url) do |faraday|
    # faraday.use Faraday::Response::RaiseError
    faraday.request :url_encoded
    faraday.adapter Faraday.default_adapter

    faraday.options.timeout = Webex::Events::Config.timeout
    faraday.options.open_timeout = Webex::Events::Config.open_timeout
    faraday.options.write_timeout = Webex::Events::Config.write_timeout

    # force SSL/TLS
    faraday.ssl[:verify] = true
    faraday.ssl[:verify_hostname] = true
    faraday.ssl[:verify_mode] = OpenSSL::SSL::VERIFY_PEER
  end
end

.execute(query:, variables:, operation_name:, headers: {}) ⇒ Object 



117
118
119
 
# File 'lib/webex/request.rb', line 117

def self.execute(query:, variables:, operation_name:, headers: {})
  new(query: query, variables: variables, operation_name: operation_name, headers: headers).execute
end

Instance Method Details

#execute ⇒ Webex::Response

Executes GraphQL query

Returns:



27
28
29
30
31
32
33
34
35
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
 
# File 'lib/webex/request.rb', line 27

def execute
  response = @connection.post do |request|
    request.url '/graphql'
    request.body = {
      query: @query,
      variables: @variables,
      operation_name: @operation_name
    }.to_json

    request.headers.merge!(@headers)
    request.headers['Content-Type'] = 'application/json'
    request.headers['Authorization'] = 'Bearer %s' % @access_token
    request.headers['X-Sdk-Name'] = 'Ruby SDK'
    request.headers['X-Sdk-Version'] = Webex::Events::VERSION
    request.headers['X-Sdk-Lang-Version'] = Webex::Events.ruby_version
    request.headers['User-Agent'] = Webex::Events.user_agent
  end

  response = Webex::Response.new(response)
  return response if response.success?

  case response.status
  when 400
    case response.body.dig('extensions', 'code')
    when 'INVALID_TOKEN'
      raise Errors::InvalidAccessTokenError.new(response)
    when 'TOKEN_IS_EXPIRED'
      raise Errors::AccessTokenIsExpiredError.new(response)
    else
      raise Errors::BadRequestError.new(response)
    end
  when 401
    raise Errors::AuthenticationRequiredError.new(response)
  when 403
    raise Errors::AuthorizationFailedError.new(response)
  when 404
    raise Errors::ResourceNotFoundError.new(response)
  when 408
    raise Errors::RequestTimeoutError.new(response)
  when 409
    raise Errors::ConflictError.new(response)
  when 413
    raise Errors::QueryComplexityIsTooHighError.new(response)
  when 422
    raise Errors::UnprocessableEntityError.new(response)
  when 429
    extensions = response.body['extensions']
    if extensions['dailyAvailableCost'].to_i < 1
      raise Errors::DailyQuotaIsReachedError.new(response)
    end

    if extensions['availableCost'].to_i < 1
      raise Errors::SecondBasedQuotaIsReachedError.new(response)
    end
  when 500
    raise Errors::ServerError.new(response)
  when 502
    raise Errors::BadGatewayError.new(response)
  when 503
    raise Errors::ServiceUnavailableError.new(response)
  when 504
    raise Errors::GatewayTimeoutError.new(response)
  when CLIENT_ERROR_STATUSES
    raise Errors::ClientError.new(response)
  when SERVER_ERROR_STATUSES
    raise Errors::ServerError.new(response)
  when nil
    raise Errors::NilStatusError.new(response)
  end
end

#validate_idempotency_key ⇒ Object 



19
20
21
22
23
 
# File 'lib/webex/request.rb', line 19

def validate_idempotency_key
  unless @headers['Idempotency-Key'].nil?
    raise 'Idempotency-Key must be UUID format' unless UUID_REGEX_VALIDATOR.match?(@headers['Idempotency-Key'])
  end
end