Boomi Atomsphere API client for Ruby

Unofficial Ruby client for the Dell Boomi Atomsphere API. Implements the JSON flavour of Boomi's "RESTish" API.

https://github.com/warrenguy/atomsphere-ruby

Status

Implements authentication (including OTP), querying, and some actions. See Usage below.

Usage

Install the atomsphere gem from rubygems or add it to your Gemfile:

source 'https://rubygems.org'
gem 'atomsphere'

and require atomsphere:

require 'atomsphere'

Configuration

Atomsphere.configure do |config|
  config.account_id = '' # Boomi account ID
  config.username   = '' # user name
  config.password   = '' # user password
  config.otp_secret = '' # base32 OTP secret for two-factor auth
end

Alternatively, environment variables may be used:

BOOMI_ACCOUNT_ID
BOOMI_USERNAME
BOOMI_PASSWORD
BOOMI_OTP_SECRET

Querying

Using the query builder:

query = Atomsphere.query(:atom) do
  group :or do
    date_installed.less_than '2018-12-01T00:00:00Z'
    group :and do
      status.not_equals :online
      type.not_equals :cloud
    end
  end
end

See more examples at https://warrenguy.github.io/atomsphere-ruby/Atomsphere.html#query-class_method

Inspect the query filter:

query.to_hash
query.to_json

Run the query:

query.run

See results from all pages that have been fetched:

query.results

Fetch the next page (returns false if last_page? is true):

query.next_page

Iterate over next_page until last_page? is true and see all results:

query.all_results

Actions

Atomsphere.get_assignable_roles
Atomsphere.execute_process atom_id: '12345-uuid-12345', process_id: '12345-uuid-12345'
Atomsphere.change_listener_status listener_id: '12345-uuid-12345', container_id: '12345-uuid-12345', action: :pause

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

atomsphere