Class: ScaleChain::APIKeyController

Inherits:
Object
  • Object
show all
Defined in:
lib/scalechain/controllers/api_key_controller.rb

Instance Method Summary collapse

Instance Method Details

#create ⇒ Object

Returns a newly created API key.

Returns:

  • mixed response from the API call



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/scalechain/controllers/api_key_controller.rb', line 8

def create
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/clients/new"

  # validate and preprocess url

  query_url = APIHelper.clean_url query_builder

  # prepare headers

  headers = {
    "user-agent" => "APIMATIC 2.0",
    "accept" => "application/json",
    "Authorization" => "Bearer %s" % (Configuration.o_auth_access_token)
  }

  # invoke the API call request to fetch the response

  response = Unirest.post query_url, headers:headers

  #Error handling using HTTP status codes

  if !(response.code.between?(200,206)) # [200,206] = HTTP OK

    raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
  end

  response.body
end

#delete(id) ⇒ Object

Returns the deleted API key id.

Parameters:

  • id (String) —

    Required parameter: An API key id

Returns:

  • mixed response from the API call



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
99
100
 
# File 'lib/scalechain/controllers/api_key_controller.rb', line 69

def delete id
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/clients/delete"

  # validate and preprocess url

  query_url = APIHelper.clean_url query_builder

  # prepare headers

  headers = {
    "user-agent" => "APIMATIC 2.0",
    "accept" => "application/json",
    "Authorization" => "Bearer %s" % (Configuration.o_auth_access_token)
  }

  # prepare parameters

  parameters = {
    "id" => id
  }

  # invoke the API call request to fetch the response

  response = Unirest.delete query_url, headers:headers, parameters:parameters

  #Error handling using HTTP status codes

  if !(response.code.between?(200,206)) # [200,206] = HTTP OK

    raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
  end

  response.body
end

#list ⇒ Object

Returns a collection of API keys for the authorized user.

Returns:

  • mixed response from the API call



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
 
# File 'lib/scalechain/controllers/api_key_controller.rb', line 38

def list
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/clients/list"

  # validate and preprocess url

  query_url = APIHelper.clean_url query_builder

  # prepare headers

  headers = {
    "user-agent" => "APIMATIC 2.0",
    "accept" => "application/json",
    "Authorization" => "Bearer %s" % (Configuration.o_auth_access_token)
  }

  # invoke the API call request to fetch the response

  response = Unirest.get query_url, headers:headers

  #Error handling using HTTP status codes

  if !(response.code.between?(200,206)) # [200,206] = HTTP OK

    raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
  end

  response.body
end