/elefeely

Internal gem to interface with Elefeely-api

Primary LanguageRubyMIT LicenseMIT

Code Climate

Elefeely

Elefeely keeps track of your feelings for you. This Ruby gem provides the (admin) interface to speak to the the Elefeely-api, and is integrated into the elefeely-twilio-interface.

NOTE: This is not a gem intended for public use. Functionality is limited to admins with correct credentials.

Installation

Add this line to your application's Gemfile:

gem 'elefeely'

And then execute:

$ bundle

Or install it yourself as:

$ gem install elefeely

Configure

Configure the gem with:

Elefeely.configure(source_key: YOUR SOURCE KEY,
                   source_secret: YOUR SOURCE SECRET,
                   api_host: 'http://elefeely-api.herokuapp.com')

That's it! You're ready to talk to Elefeely.

Usage Examples

Verify a number:

Elefeely.verify_number('0123456789')

Retrieve verified phone numbers:

Elefeely.phone_numbers

Post a new feeling:

Elefeely.send_feeling(feeling: { source_event_id: '124156', score: 4}, uid: '4151231234')

Unsubscribe a number:

Elefeely.unsubscribe_number('0123456789')

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