Class: Smplkit::Jobs::JobsClient

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

Overview

The active-record entry points are #new_recurring_job, #new_manual_job, and #schedule: instantiate a draft, mutate fields, then call Smplkit::Jobs::Job#save. Run history and the cancel / rerun run actions live on #runs.

Reachable as client.jobs (Smplkit::Client) or constructed directly —JobsClient.new resolves credentials from ~/.smplkit / env vars.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_key = nil, profile: nil, base_domain: nil, scheme: nil, debug: nil, extra_headers: nil, environment: nil, auth_client: nil) ⇒ JobsClient

Returns a new instance of JobsClient.

Parameters:

  • api_key (String, nil) (defaults to: nil) —

    API key. When omitted, resolved from SMPLKIT_API_KEY or ~/.smplkit.

  • profile (String, nil) (defaults to: nil) —

    Named ~/.smplkit profile section.

  • base_domain (String, nil) (defaults to: nil) —

    Base domain for API requests (default “smplkit.com”).

  • scheme (String, nil) (defaults to: nil) —

    URL scheme (default “https”).

  • debug (Boolean, nil) (defaults to: nil) —

    Enable SDK debug logging.

  • extra_headers (Hash, nil) (defaults to: nil) —

    Extra headers attached to every request.

  • environment (String, nil) (defaults to: nil) —

    Default environment for environment-scoped operations — the environment a one-off job created through this client is born in, the default a manual run executes in, and the default scope for runs.list. nil leaves these unset (the credential’s permitted environment is implied where unambiguous).

  • auth_client (Object, nil) (defaults to: nil) —

    Internal — a pre-built transport supplied by a top-level client so the jobs surface shares one connection pool. Not for direct use.



158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/smplkit/jobs/client.rb', line 158

def initialize(api_key = nil, profile: nil, base_domain: nil, scheme: nil,
               debug: nil, extra_headers: nil, environment: nil, auth_client: nil)
  auth = auth_client || Jobs.jobs_transport(
    api_key: api_key, profile: profile, base_domain: base_domain,
    scheme: scheme, debug: debug, extra_headers: extra_headers
  )
  @environment = environment
  @api = SmplkitGeneratedClient::Jobs::JobsApi.new(auth)
  @runs = RunsClient.new(SmplkitGeneratedClient::Jobs::RunsApi.new(auth), environment: environment)
  @usage_api = SmplkitGeneratedClient::Jobs::UsageApi.new(auth)
end

Instance Attribute Details

#runs ⇒ RunsClient (readonly)

Returns Run history and run actions (client.jobs.runs).

Returns:

  • (RunsClient) —

    Run history and run actions (client.jobs.runs).



140
141
142
 
# File 'lib/smplkit/jobs/client.rb', line 140

def runs
  @runs
end

Class Method Details

.open(*args, **kwargs) ⇒ Object

Construct, yield to the block, and close on exit.



177
178
179
180
181
182
183
184
 
# File 'lib/smplkit/jobs/client.rb', line 177

def self.open(*args, **kwargs)
  client = new(*args, **kwargs)
  begin
    yield client
  ensure
    client.close
  end
end

Instance Method Details

#_create_job(job) ⇒ Object

Raises:

  • (ArgumentError) 


352
353
354
355
356
357
 
# File 'lib/smplkit/jobs/client.rb', line 352

def _create_job(job)
  raise ArgumentError, "Job.id is required on create (caller-supplied key)" if job.id.nil? || job.id.empty?

  resp = Jobs.call_api { @api.create_job(build_create_body(job), x_smplkit_environment: job.birth_environment) }
  Job.from_resource(resp.data, client: self)
end

#_update_job(job) ⇒ Object

Header values come back in plaintext on the GET path, so a fetched job round-trips through this full-replace PUT with its header values intact — no need to re-enter secrets.

Raises:

  • (ArgumentError) 


367
368
369
370
371
372
 
# File 'lib/smplkit/jobs/client.rb', line 367

def _update_job(job)
  raise ArgumentError, "cannot update a Job with no id" if job.id.nil?

  resp = Jobs.call_api { @api.update_job(job.id, build_body(job), x_smplkit_environment: @environment) }
  Job.from_resource(resp.data, client: self)
end

#close ⇒ Object

The generated ApiClient owns Faraday connections that release on GC; there is no explicit shutdown to call.



172
173
174
 
# File 'lib/smplkit/jobs/client.rb', line 172

def close
  nil
end

#delete(id) ⇒ nil

Delete a job by its id.

Parameters:

  • id (String) —

    Identifier of the job to delete.

Returns:

  • (nil) 


315
316
317
318
 
# File 'lib/smplkit/jobs/client.rb', line 315

def delete(id)
  Jobs.call_api { @api.delete_job(id) }
  nil
end

#get(id) ⇒ Smplkit::Jobs::Job

Fetch a single job by id. The returned instance is bound to this client, so job.save and job.delete work.

Parameters:

  • id (String)

Returns:



306
307
308
309
 
# File 'lib/smplkit/jobs/client.rb', line 306

def get(id)
  resp = Jobs.call_api { @api.get_job(id) }
  Job.from_resource(resp.data, client: self)
end

#list(kind: nil, scheduled: nil, name: nil, page_number: nil, page_size: nil) ⇒ Array<Smplkit::Jobs::Job>

List jobs for the authenticated account.

Parameters:

  • kind (String, nil) (defaults to: nil) —

    Filter to a single Smplkit::Jobs::JobKind (JobKind::RECURRING / JobKind::MANUAL / JobKind::ONE_OFF). nil lists recurring and manual jobs; one-off jobs are omitted unless you pass JobKind::ONE_OFF.

  • scheduled (Boolean, nil) (defaults to: nil) —

    Filter to jobs that have an upcoming fire in some environment (true) or none (false) — the feed for an upcoming-runs view, which includes one-offs. nil does not filter on scheduling.

  • name (String, nil) (defaults to: nil) —

    Filter to jobs whose name contains this text (case-insensitive). nil lists all.

  • page_number (Integer, nil) (defaults to: nil) —

    1-based page number to return.

  • page_size (Integer, nil) (defaults to: nil) —

    Items per page.

Returns:



289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/smplkit/jobs/client.rb', line 289

def list(kind: nil, scheduled: nil, name: nil, page_number: nil, page_size: nil)
  opts = {}
  opts[:filter_kind] = kind unless kind.nil?
  opts[:filter_scheduled] = scheduled unless scheduled.nil?
  opts[:filter_name] = name unless name.nil?
  opts[:page_number] = page_number unless page_number.nil?
  opts[:page_size] = page_size unless page_size.nil?

  resp = Jobs.call_api { @api.list_jobs(opts) }
  (resp.data || []).map { |r| Job.from_resource(r, client: self) }
end

#new_manual_job(id, name:, configuration:, description: nil, environments: nil, concurrency_policy: "ALLOW") ⇒ Smplkit::Jobs::Job

Construct an unsaved manual Smplkit::Jobs::Job bound to this client. Call #save on the returned instance to create it.

A manual job has no schedule — it never auto-fires and runs only when triggered via #run / Smplkit::Jobs::Job#trigger.

Parameters:

  • id (String) —

    Caller-supplied unique identifier for the job. Unique within the account and immutable; the service returns 409 if another live job already uses this id.

  • name (String) —

    Human-readable name for the job.

  • configuration (Smplkit::Jobs::HttpConfig) —

    The HTTP request the job sends each time it runs.

  • description (String, nil) (defaults to: nil) —

    Optional free-text description.

  • environments (Hash{String => Smplkit::Jobs::JobEnvironment, Hash}, nil) (defaults to: nil) —

    Per-environment overrides keyed by environment key — each a Smplkit::Jobs::JobEnvironment, or a plain hash (+{ enabled: true }+, optionally with a :configuration HttpConfig override). The job is triggerable only in environments enabled here.

  • concurrency_policy (String) (defaults to: "ALLOW") —

    How overlapping runs are handled. Defaults to “ALLOW”.

Returns:



238
239
240
241
242
243
244
245
 
# File 'lib/smplkit/jobs/client.rb', line 238

def new_manual_job(id, name:, configuration:, description: nil,
                   environments: nil, concurrency_policy: "ALLOW")
  _new_job(
    id, name: name, schedule: nil, configuration: configuration,
        description: description, environments: environments,
        concurrency_policy: concurrency_policy, environment: nil
  )
end

#new_recurring_job(id, name:, schedule:, configuration:, description: nil, environments: nil, concurrency_policy: "ALLOW") ⇒ Smplkit::Jobs::Job

Construct an unsaved recurring Smplkit::Jobs::Job bound to this client. Call #save on the returned instance to create it.

Parameters:

  • id (String) —

    Caller-supplied unique identifier for the job. Unique within the account and immutable; the service returns 409 if another live job already uses this id.

  • name (String) —

    Human-readable name for the job.

  • schedule (String) —

    The base cadence — a 5-field cron expression evaluated in UTC (e.g. “0 2 * * *”) — that every environment inherits unless it sets its own override.

  • configuration (Smplkit::Jobs::HttpConfig) —

    The HTTP request the job sends each time it fires.

  • description (String, nil) (defaults to: nil) —

    Optional free-text description.

  • environments (Hash{String => Smplkit::Jobs::JobEnvironment, Hash}, nil) (defaults to: nil) —

    Per-environment overrides keyed by environment key — each a Smplkit::Jobs::JobEnvironment, or a plain hash (+{ enabled: true }+, optionally with a :schedule cron override and/or a :configuration HttpConfig override). The job is scheduled only in environments enabled here.

  • concurrency_policy (String) (defaults to: "ALLOW") —

    How overlapping runs are handled. Defaults to “ALLOW”.

Returns:



208
209
210
211
212
213
214
215
 
# File 'lib/smplkit/jobs/client.rb', line 208

def new_recurring_job(id, name:, schedule:, configuration:, description: nil,
                      environments: nil, concurrency_policy: "ALLOW")
  _new_job(
    id, name: name, schedule: schedule, configuration: configuration,
        description: description, environments: environments,
        concurrency_policy: concurrency_policy, environment: nil
  )
end

#run(id, environment: nil) ⇒ Smplkit::Jobs::Run

Trigger one immediate, manual run of a job, ignoring its schedule.

This starts an ad-hoc run right now in addition to any scheduled runs; it does not alter the job’s schedule. To read or act on existing runs, use client.jobs.runs.

Parameters:

  • id (String) —

    Identifier of the job to run.

  • environment (String, nil) (defaults to: nil) —

    Environment the manual run executes in. Defaults to the client’s configured environment; when the job is enabled in exactly one environment that environment is used, and a single-environment credential implies it. The job must be enabled in the chosen environment.

Returns:



334
335
336
337
338
 
# File 'lib/smplkit/jobs/client.rb', line 334

def run(id, environment: nil)
  env = environment.nil? ? @environment : environment
  resp = Jobs.call_api { @api.run_job_now(id, x_smplkit_environment: env) }
  Run.from_resource(resp.data, runs: @runs)
end

#schedule(id, name:, schedule:, configuration:, description: nil, concurrency_policy: "ALLOW", environment: nil) ⇒ Smplkit::Jobs::Job

Construct an unsaved one-off Smplkit::Jobs::Job bound to this client. Call #save on the returned instance to create it.

A one-off job runs a single time at schedule and is then spent.

Parameters:

  • id (String) —

    Caller-supplied unique identifier for the job. Unique within the account and immutable; the service returns 409 if another live job already uses this id.

  • name (String) —

    Human-readable name for the job.

  • schedule (Time) —

    The instant the single run fires.

  • configuration (Smplkit::Jobs::HttpConfig) —

    The HTTP request the job sends when it runs.

  • description (String, nil) (defaults to: nil) —

    Optional free-text description.

  • concurrency_policy (String) (defaults to: "ALLOW") —

    How overlapping runs are handled. Defaults to “ALLOW”.

  • environment (String, nil) (defaults to: nil) —

    The environment the job is born in. Defaults to the client’s configured environment.

Returns:



265
266
267
268
269
270
271
272
 
# File 'lib/smplkit/jobs/client.rb', line 265

def schedule(id, name:, schedule:, configuration:, description: nil,
             concurrency_policy: "ALLOW", environment: nil)
  _new_job(
    id, name: name, schedule: schedule.iso8601, configuration: configuration,
        description: description, environments: nil,
        concurrency_policy: concurrency_policy, environment: environment
  )
end

#usage ⇒ Smplkit::Jobs::Usage

Current-period usage counters for the account.

Returns:



343
344
345
346
 
# File 'lib/smplkit/jobs/client.rb', line 343

def usage
  resp = Jobs.call_api { @usage_api.get_usage }
  Usage.from_resource(resp.data)
end