Class: BatchlyApi::ProjectsController

Inherits:
Object
  • Object
show all
Defined in:
lib/batchly_api/controllers/projects_controller.rb

Instance Method Summary collapse

Instance Method Details

#add_project(request) ⇒ Object

Creates a new project from the request information. Account Identifier should be a valid value and can be obtained from the ListAccounts endpoint.

Parameters:

Returns:

  • ProjectModel response from the API call



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
 
# File 'lib/batchly_api/controllers/projects_controller.rb', line 41

def add_project request
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Projects"

  # validate and preprocess url

  query_url = APIHelper.clean_url query_builder

  # prepare headers

  headers = {
    "user-agent" => "batchly/1.0.1",
    "accept" => "application/json",
    "content-type" => "application/json; charset=utf-8"
  }

  # append custom auth authorization

  CustomAuthUtility.append_custom_auth_params query_url, "POST", headers

  # invoke the API call request to fetch the response

  response = Unirest.post query_url, headers:headers, parameters:request.to_json

  # Error handling using HTTP status codes

  if response.code == 400
    raise APIException.new "BadRequest", 400, response.raw_body
  elsif !(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_project(id) ⇒ Object

Removes the project and deactivates all the jobs currently active in it.

Parameters:

  • id (String) —

    Required parameter: Project Identifier

Returns:

  • void response from the API call



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/batchly_api/controllers/projects_controller.rb', line 161

def delete_project id
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Projects/{id}"

  # process optional query parameters

  query_builder = APIHelper.append_url_with_template_parameters query_builder, {
    "id" => id,
  }

  # validate and preprocess url

  query_url = APIHelper.clean_url query_builder

  # prepare headers

  headers = {
    "user-agent" => "batchly/1.0.1"
  }

  # append custom auth authorization

  CustomAuthUtility.append_custom_auth_params query_url, "DELETE", headers

  # invoke the API call request to fetch the response

  response = Unirest.delete query_url, headers:headers

  # Error handling using HTTP status codes

  if response.code == 404
    raise APIException.new "NotFound", 404, response.raw_body
  elsif !(response.code.between?(200,206)) # [200,206] = HTTP OK

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

#describe_project(id) ⇒ Object

Returns the project information for the submitted identifier.

Parameters:

  • id (String) —

    Required parameter: Project Identifier

Returns:

  • ProjectModel response from the API call



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
109
110
111
112
 
# File 'lib/batchly_api/controllers/projects_controller.rb', line 77

def describe_project id
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Projects/{id}"

  # process optional query parameters

  query_builder = APIHelper.append_url_with_template_parameters query_builder, {
    "id" => id,
  }

  # validate and preprocess url

  query_url = APIHelper.clean_url query_builder

  # prepare headers

  headers = {
    "user-agent" => "batchly/1.0.1",
    "accept" => "application/json"
  }

  # append custom auth authorization

  CustomAuthUtility.append_custom_auth_params query_url, "GET", headers

  # 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 == 404
    raise APIException.new "NotFound", 404, response.raw_body
  elsif !(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_projects ⇒ Object

Returns the active list of projects within batchly. The information includes the account information under which the project operates.



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
35
36
 
# File 'lib/batchly_api/controllers/projects_controller.rb', line 8

def list_projects
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Projects"

  # validate and preprocess url

  query_url = APIHelper.clean_url query_builder

  # prepare headers

  headers = {
    "user-agent" => "batchly/1.0.1",
    "accept" => "application/json"
  }

  # append custom auth authorization

  CustomAuthUtility.append_custom_auth_params query_url, "GET", headers

  # 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

#update_project(id, request) ⇒ Object

Updates the project with new details. Projects belong to an account when created and this association cannot be altered.

Parameters:

  • id (String) —

    Required parameter: Project Identifier

  • request (UpdateProjectRequest) —

    Required parameter: Update Project Request

Returns:

  • ProjectModel response from the API call



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/batchly_api/controllers/projects_controller.rb', line 118

def update_project id, request
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Projects/{id}"

  # process optional query parameters

  query_builder = APIHelper.append_url_with_template_parameters query_builder, {
    "id" => id,
  }

  # validate and preprocess url

  query_url = APIHelper.clean_url query_builder

  # prepare headers

  headers = {
    "user-agent" => "batchly/1.0.1",
    "accept" => "application/json",
    "content-type" => "application/json; charset=utf-8"
  }

  # append custom auth authorization

  CustomAuthUtility.append_custom_auth_params query_url, "PUT", headers

  # invoke the API call request to fetch the response

  response = Unirest.put query_url, headers:headers, parameters:request.to_json

  # Error handling using HTTP status codes

  if response.code == 400
    raise APIException.new "BadRequest", 400, response.raw_body
  elsif response.code == 404
    raise APIException.new "NotFound", 404, response.raw_body
  elsif !(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