Class: BatchlyApi::JobsController

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

Instance Method Summary collapse

Instance Method Details

#add_job(request) ⇒ Object

Adds a new job to batchly. The following steps are involved when creating a new job

-> Get a list of projects. If needed, create a new project.
-> Add datasources for source and destination
-> Get a list of processors. If needed, create a new processor
-> Create a job with source, destination, project and processor identifier

Parameters:

Returns:

  • JobModel response from the API call



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/batchly_api/controllers/jobs_controller.rb', line 89

def add_job request
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Jobs"

  # 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_job(id) ⇒ Object

Deletes the job and deactivates any scheduler associated with the job.

Parameters:

  • id (String) —

    Required parameter: Job Identifier

Returns:

  • void response from the API call



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
194
195
196
197
 
# File 'lib/batchly_api/controllers/jobs_controller.rb', line 165

def delete_job id
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Jobs/{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_job(id) ⇒ Object

Describes in detail the job

Parameters:

  • id (String) —

    Required parameter: Job Identifier

Returns:

  • JobModel response from the API call



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
157
158
159
160
 
# File 'lib/batchly_api/controllers/jobs_controller.rb', line 125

def describe_job id
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Jobs/{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

#execute_job(id, request: nil) ⇒ Object

Creates a run for the submitted job identifier. The run is started if the job is not scheduled. Only one run for a job can be active. Returns conflict response if a job is already executing.

Parameters:

  • id (String) —

    Required parameter: Job Id that needs to be executed

  • request (ExecuteJobRequest) (defaults to: nil) —

    Optional parameter: Request parameters can be null if default parameters can be used for execution. If present, Request values will be considered instead of defaults

Returns:

  • RunModel response from the API call



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
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/batchly_api/controllers/jobs_controller.rb', line 10

def execute_job id, request: nil
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Jobs/{id}/Execute"

  # 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, "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 == 409
    raise APIException.new "Conflict", 409, 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_jobs ⇒ Object

Returns a List of all active jobs in batchly



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/batchly_api/controllers/jobs_controller.rb', line 52

def list_jobs
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Jobs"

  # 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