Tiptaplab

The tiptaplab gem provides easy and painless access to the TipTap Lab API.

Add this line to your application's Gemfile:

gem 'tiptaplab'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tiptaplab

First, register your application with the TipTap Lab API

Then, create a new Tiptaplab::Api instance, specifying your app_id and app_secret:

api = Tiptaplab::Api.new(:app_id => YOUR_APP_ID, :app_secret => YOUR_APP_SECRET)

In addition to the required app_id and app_secret, you can specify :api_environment. If this is set to 'staging', the gem will use the TipTap Lab staging API. This is useful while your app is in development, but remember that API data created on staging will not be available once you switch to production mode, and that your App credentials may be different.

Once the API is initialized, you can fetch or create a Tiptaplab::User:

user = Tiptaplab::Model::User.create

You can optionally specify the User's attributes:

user = Tiptaplab::Model::User.create(:username => 'jsmith293931', :name => "John Q. Smith")

The User will have a ttl_id attribute containing it's unique TipTap Lab API ID number. Either this id or the username can be used to fetch the user again later:

user = Tiptaplab::Model::User.find(43341)

user = Tiptaplab::Model::User.find('jsmith293931')

Once you have a user, you can fetch it's trait scores and personality data:

> user.traits
 => [{
  "key": "health",
  "score": 1.33333333333333,
  "survey_version": 1
},
{
  "key": "optimal_stimulation",
  "score": 1.33333333333333,
  "survey_version": 1

}]

user.personality => { "title": "Explorer", "description": "As a member of the Explorer family...", "key": 'explorer' }

You can also make arbitrary calls to the api using the make_call method:

api.make_call(call_path, data, method)

The default data is an empty hash and the default method is 'GET', so you can make simple requests with just the call path:

> api.make_call('traits')
=> [{"title"=>"Susceptability", "key"=>"susceptability"}, {"title"=>"Diet", "key"=>"diet"}...

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