This is a simple API Wrapper for the contactually API.
Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.travis.yml
Gemfile
Gemfile.lock
LICENSE.txt
README.md
Rakefile
contactually-api.gemspec

README.md

Contactually-API

Code Climate Build Status

This is a simple API Wrapper for the contactually API. It is not feature complete, as it does not support all available API endpoints yet, but I guess for most use cases this will be fine. Feel free to contribute!

Installation

Add this line to your application's Gemfile:

gem 'contactually-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install contactually-api

Usage

Configuration

As contactually-api is shipped with sensible defaults, that will allow you to start right away, there are a couple of settings you may want to adjust, depending on your applications requirements.

The available configuration options are:

Configuration goes as follows:

    Contactually.configure do |c|
      c.api_key           = "YOURKEY"
      c.contactually_url  = "URL"
    end

How to use the gem

    contactually = Contactually::API.new
    contacts = contactually.contacts.index
    # => [#<Contactually::Contact id=1234, ...>, #<Contactually::Contact id=1235, ...>, ...]
    notes = contactually.notes.index
    # => [#<Contactually::Note id=2345, ...>, #<Contactually::Note id=2346, ...>, ...]
    groupings = contactually.groupings.index
    # => [#<Contactually::Grouping id=3456, ...>, #<Contactually::Grouping id=3457, ...>, ...]

    contact = { contact: { first_name: 'Jane', last_name: 'Doe', ... } }
    contactually.contacts.create(contact)
    # => #<Contactually::Contact id=9876, first_name='Jane', last_name='Doe', ...>

Implemented endpoints are:

  • Accounts
  • Contact Groupings
  • Contacts
  • Contents
  • Groupings
  • Notes
  • Tasks

The API is documented here: Contactually API Docs

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