drip-ruby

KO | EN

gitlite — search

#python #hacktoberfest #typescript #golang #android #machine-learning #rust #linux #docker #awesome #awesome-list #security #ios #openai

(★ 29)

A Ruby gem for interacting with Drip's REST API v2.0

drip-ruby Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Drip Ruby Client

A Ruby toolkit for the [Drip](https://www.getdrip.com/) API.

[![CI](https://github.com/DripEmail/drip-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/DripEmail/drip-ruby/actions/workflows/ci.yml)
[![Gem Version](https://badge.fury.io/rb/drip-ruby.svg)](https://badge.fury.io/rb/drip-ruby)

## Installation

Add this line to your application's Gemfile:

gem 'drip-ruby', require: 'drip'

And then execute:

$ bundle

Or install it yourself as:

$ gem install drip-ruby

## Authentication

For private integrations, you may use your personal API Token (found
[here](https://www.getdrip.com/user/edit)) via the `api_key` setting:

```ruby
client = Drip::Client.new do |c|
  c.api_key = "YOUR_API_KEY"
  c.account_id = "YOUR_ACCOUNT_ID"
end
```

For public integrations, pass in the user's OAuth token via the `access_token`
setting:

```ruby
client = Drip::Client.new do |c|
  c.access_token = "YOUR_ACCESS_TOKEN"
  c.account_id = "YOUR_ACCOUNT_ID"
end
```

You may also pass client options in an argument hash:

```ruby
client = Drip::Client.new(
  access_token: "YOUR_ACCESS_TOKEN"
  account_id: "YOUR_ACCOUNT_ID"
)
```

Your account ID can be found [here](https://www.getdrip.com/settings/site).
Most API actions require an account ID, with the exception of methods like
the "list accounts" endpoint.

## Usage

Since the Drip client is a flat API client, most API actions are available
as methods on the client object. The following methods are currently available:

#### Accounts

#### Broadcasts

#### Campaigns

| Actions                    | Methods                                              |
| :------------------------- | :--------------------------------------------------- |
| List campaigns             | `#campaigns(options = {})`                           |
| Fetch a campaign           | `#campaign(id)`                                      |
| Activate a campaign        | `#activate_campaign(id)`                             |
| Pause a campaign           | `#pause_campaign(id)`                                |
| List campaign subscribers  | `#campaign_subscribers(id)`                          |
| Subscribe to a campaign    | See the `#subscribe` method on "Subscribers" below   |

#### Campaign Subscriptions

#### Conversions

| Actions                    | Methods                                              |
| :------------------------- | :--------------------------------------------------- |
| List all conversions       | `#conversions(options = {})`                         |
| Fetch a conversion         | `#conversion(id)`                                    |

#### Custom Fields

#### Events

| Actions                    | Methods                                              |
| :------------------------- | :--------------------------------------------------- |
| Track an event             | `#track_event(email, action, properties = {})`       |
| Track a batch of events    | `#track_events(events)`                              |
| List all custom event actions | `#event_actions`                                  |

#### Forms

#### Orders

| Actions                    | Methods                                              |
| :------------------------- | :--------------------------------------------------- |
| Create or update an order  | `#create_or_update_order(email, options = {})`       |
| Create or update a batch of orders  | `#create_or_update_orders(orders = {})`     |
| Create or update a refund  | `#create_or_update_refund(options = {})`             |

#### Subscribers

| Actions                    | Methods                                              |
| :------------------------- | :--------------------------------------------------- |
| List subscribers           | `#subscribers(options = {})`                         |
| Create/update a subscriber | `#create_or_update_subscriber(email, options = {})`  |
| Create/update a batch of subscribers | `#create_or_update_subscribers(subscribers)` |
| Unsubscribe a batch of subscribers | `#unsubscribe_subscribers(subscribers)`      |
| Fetch a subscriber         | `#subscriber(id_or_email)`                           |
| Delete                     | `#delete_subscriber(id_or_email)`                    |
| Subscribe to a campaign    | `#subscribe(email, campaign_id, options = {})`       |
| Unsubscribe from all mailings | `#unsubscribe_from_all(id_or_email)`              |
| Unsubscribe                | `#unsubscribe(id_or_email, options = {})`            |

#### Tags

#### Webhooks

#### Workflows

| Actions                    | Methods                                              |
| :------------------------- | :--------------------------------------------------- |
| List workflows             | `#workflows`                                         |
| Fetch a workflow           | `#workflow(id)`                                      |
| Activate a workflow        | `#activate_workflow(id)`                             |
| Pause a workflow           | `#pause_workflow(id)`                                |
| Start a subscriber on a workflow | `#start_subscriber_workflow(id, options = {})` |
| Remove a subscriber from a workflow | `#remove_subscriber_workflow(workflow_id, id_or_email)` |

#### Workflow Triggers

| Actions                    | Methods                                              |
| :------------------------- | :--------------------------------------------------- |
| List workflow triggers     | `#workflow_triggers(id)`                             |
| Create a workflow trigger  | `#create_workflow_trigger(id, options = {})`         |
| Update a workflow trigger  | `#update_workflow_trigger(id, options = {}`          |

[See the official REST API docs](https://www.getdrip.com/docs/rest-api) for a complete API reference and explanations.

## Use Cases

Here are some common use cases for the API client.

### Fetching user accounts

Once you have an access token for a Drip user, you can fetch their accounts.

Initialize your client and pull down the user's accounts. To make further calls, set the account_id
on your client to the account you want to access.

```ruby
client = Drip::Client.new do |c|
  c.access_token = "YOUR_ACCESS_TOKEN"
end

resp = client.accounts
# => <Drip::Response ...>

account_id = resp.accounts.first.id
# => "9999999"

client.account_id = account_id
```

### Fetching subscriber data

Subscribers can be looked up by their email address or by their Drip subscriber
ID. Most of the time you will want to look up subscribers by their email address,
unless you've already stored this ID in your database.

```ruby
resp = client.subscriber("foo@example.com")
# => <Drip::Response ...>

resp.success?
# => true

subscriber = resp.subscribers.first
subscriber.email
# => "foo@example.com"
```

## Contributing

1. Fork it ( https://github.com/DripEmail/drip-ruby/fork )
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 a new Pull Request

drip-ruby

drip-ruby Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

drip-ruby

drip-ruby Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README