Name: hubspot-ruby
Owner: Rainforest QA
Description: Ruby wrappers for the HubSpot REST API
Created: 2015-09-28 19:50:58.0
Updated: 2015-09-28 19:51:00.0
Pushed: 2015-09-08 16:05:14.0
Homepage: https://developers.hubspot.com/docs/endpoints
Size: 1361
Language: Ruby
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Wraps the HubSpot REST API for convenient access from ruby applications.
Documentation for the HubSpot REST API can be found here: https://developers.hubspot.com/docs/endpoints
gem install hubspot-ruby
Or with bundler,
"hubspot-ruby"
Before using the library, you must initialize it with your HubSpot API key. If you're using Rails, put this code in an initializer:
pot.configure(hapikey: "YOUR_API_KEY")
If you're have a HubSpot account, you can get your api key by logging in and visiting this url: https://app.hubspot.com/keys/get
For now, this library only supports authentication with a HubSpot API key (aka “hapikey”). OAuth is not yet supported.
Here's what you can do for now:
pot::Contact.create!("email@address.com", {firstname: "First", lastname: "Last"})
These methods will return a Hubspot::Contact
object if successful, nil
otherwise:
pot::Contact.find_by_email("email@address.com")
pot::Contact.find_by_id(12345) # Pass the contact VID
Given an instance of Hubspot::Contact
, update its attributes with:
act.update!({firstname: "First", lastname: "Last"})
All tests can be run with rake spec
. Isolate fast-running tests with rake spec:quick
.
GET requests are pretty easy to test with VCR, but for POST/PUT requests, you probably want to update verify the state
of a live HubSpot instance. To do this, please add “live” tests to spec/live/
, using the rspec label live: true
in
order to disable VCR.
“Live” tests can be isolated with rake spec:live
.
This project and the code therein was not created by and is not supported by HubSpot, Inc or any of its affiliates.
Copyright (c) 2013 Omada Health Inc. See LICENSE.txt for further details.