TenThousandFeet

Ruby wrapper for the 10,000ft API.

Installation

gem 'ten_thousand_feet'

Or

gem install ten_thousand_feet

Setup

require 'ten_thousand_feet'

# Initialize a new 10,000ft client
client = TenThousandFeet.new(auth: YOUR_AUTH_TOKEN)

# If you are using a sandbox environment you can optionally specify the sandbox URL
client = TenThousandFeet.new(auth: YOUR_AUTH_TOKEN, api_url: 'https://vnext-api.10000ft.com/api/v1')

API Methods

Note: 'options' will be different for each method. Check the official API documentation for a list of available options for each call.

'options' should be passed in as a hash:

# user_id = 1969
#
# options = {
#   first_name:   'Austin',
#   last_name:    'Powers',
#   display_name: 'Austin Danger Powers'
# }
#
# client.update_user(user_id, options)

Users

client.get_users(options)
client.show_user(user_id, options)
client.update_user(user_id, options)
client.create_user(options)

User Status

client.get_user_statuses(user_id, options)
client.create_user_status(user_id, options)

Assignments

client.get_assignments(user_id, options)
client.show_assignment(assignment_id, user_id, options)
client.create_assignment(user_id, options)
client.delete_assignment(assignment_id, user_id, options)

Projects

client.get_projects(options)
client.show_project(project_id, options)
client.update_project(project_id, options)
client.create_project(options)
client.delete_project(project_id, options)
client.get_project_time_entries(project_id, options)
client.get_project_users(project_id, options)

Phases

client.get_phases(project_id, options)
client.create_phases(project_id, options)
client.update_phases(project_id, phase_id, options)

Time Entries

client.get_time_entries(user_id, options)
client.show_time_entry(time_entry_id, user_id, options)
client.update_time_entry(time_entry_id, user_id, options)
client.create_time_entry(user_id, options)
client.delete_time_entry(time_entry_id, user_id, project_id, options)
client.get_all_time_entries(options)

Leave Types

client.get_leave_types(options)
client.show_leave_types(leave_type_id, options)

Bill Rates

client.get_bill_rate(project_id, bill_rate_id, options)
client.get_bill_rates(project_id, options)

To-Do

• Budget Items
• Budget Item Categories
• Tags Per Project
• Tags Per User

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request