Tuneup Technology App Ruby Client Library

The Ruby client library for the Tuneup Technology App.

This library allows you to interact with the customers, tickets, inventory, and locations objects without needing to do the hard work of binding your calls and data to endpoints. Simply call an action such as Customer.create and pass some data and let the library do the rest.

Install

# Install the client library
gem install tuneuptechnology

Example

require 'tuneuptechnology'

client = TuneupTechnology::Client.new ENV['API_EMAIL'], ENV['API_KEY']

customer = client.customers.create(
  {
    'firstname' => 'Jake',
    'lastname' => 'Peralta',
    'email' => '[email protected]',
    'phone' => '8015551234',
    'user_id' => 1,
    'notes' => 'Believes he is a good detective.',
    'location_id' => 2
  }
)

puts customer

Other examples can be found in the /examples directory. Alter according to your needs.

Usage

[email protected] API_KEY=123... ruby create_customer.rb

Documentation

Up-to-date API documentation can be found here.

Development

# Install locally
bundle install

# Lint project
rubocop

# Run tests
bundle exec rspec

Releasing

As a separate PR from the feature/bug PR:

1. Update the version string in tuneuptechnology.rb and tuneuptechnology.gemspec files
2. Update CHANGELOG
3. Create a GitHub tag with proper Ruby version semantics (eg: v1.0.0)
4. Publish to RubyGems