The Assistly Ruby Gem

A Ruby wrapper for the Assistly API

Installation

gem install assistly

What's new in 0.1?

This is the first release of the Assistly gem, based on the Twitter gem. Support for most of the Assistly API are handled. There is not yet support for Content or Macros.

Help! I'm getting: "Did not recognize your engine specification. Please specify either a symbol or a class. (RuntimeError)"

You'll need to explicitly require a JSON library. We recommend yajl-ruby.

Usage Examples

require "rubygems"
require "assistly"

# All methods require authentication. To get your Assistly OAuth credentials,
# register an app in the Assistly admin for your account at http://your-domain.assistly.com/admin
@assistly = Assistly.configure do |config|
  config.consumer_key = YOUR_CONSUMER_KEY
  config.consumer_secret = YOUR_CONSUMER_SECRET
  config.oauth_token = YOUR_OAUTH_TOKEN
  config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET
end

# List cases
@assistly.cases
@assistly.cases(:since_id => 12345)

# Get a specific case
@assistly.case(12345)

# Update a specific case
@assistly.update_case(12345, :subject => "Something Else")

# List customers
@assistly.customers
@assistly.customers(:since_id => 12345, :count => 5)

# Get a specific customer
@assistly.customer(12345)

# Create a customer
@assistly.create_customer(:name => "Chris Warren", :twitter => "cdwarren")

# Update a customer
@assistly.update_customer(12345, :name => "Christopher Warren")

# Add a customer email
@assistly.create_customer_email(12345, "foo@example.com")
@assistly.create_customer_email(12345, "foo@example.com", :customer_contact_type => "work")

# Update a customer email
@assistly.update_customer_email(12345, 54321, :email => "foo@example.com")
@assistly.update_customer_email(12345, 54321, :customer_contact_type => "work")

# List interactions
@assistly.interactions
@assistly.interactions(:since_id => 12345)
@assistly.interactions(:since_id => 12345, :count => 5)

# Create an interaction
@assistly.create_interaction(:interaction_subject => "this is a test", :customer_email => "foo@example.com")

# List users
@assistly.users

# Get a specific user
@assistly.user(12345)

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

Here are some ways you can contribute:

by using alpha, beta, and prerelease versions
by reporting bugs
by suggesting new features
by writing or editing documentation
by writing specifications
by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
by refactoring code
by closing issues
by reviewing patches

All contributors will be added to the HISTORY file and will receive the respect and gratitude of the community.

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. You can indicate support for an existing issuse by voting it up. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

Fork the project.
Create a topic branch.
Implement your feature or bug fix.
Add documentation for your feature or bug fix.
Run bundle exec rake doc:yard. If your changes are not 100% documented, go back to step 4.
Add specs for your feature or bug fix.
Run bundle exec rake spec. If your changes are not 100% covered, go back to step 6.
Commit and push your changes.
Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)