0.0
No commit activity in last 3 years
No release in over 3 years
Ruby Library for interactions with the Iterable API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.12
~> 10.0
~> 3.0

Runtime

< 4.0, >= 1.2.0
>= 1.8.1, ~> 1.8
< 4.0, >= 1.25.1
< 4.0, >= 1.6.7
 Project Readme

Iterable

Build Status Gem Version Code Climate

A Ruby wrapper for the Iterable API. Documentation can be found here.

Installation

Add this line to your application's Gemfile:

gem 'iterable-api', require: 'iterable'

And then execute:

$ bundle

Or install it yourself as:

$ gem install iterable-api

Usage

Client

require 'iterable-api`

client = Iterable::Api.new('YOUR_API_KEY')
client.lists

Supported Endpoints

All responses are sent back as Hashie objects

Lists

  • lists - return all lists
  • lists/subscribe - subscribe a user to a list

Users

  • users/{email} - find a user by email
  • users/{id} - find a user by id
  • users/update - create/update a user

Commerce

  • commerce/trackPurchase - Track a purchase. 'shoppingCartItems' field on the user profile is cleared. User profile is also updated (created otherwise) using the user request field
  • commerce/updateCart - Updates the 'shoppingCartItems' field on the user profile with shopping cart items. User profile is updated (created otherwise) via the user field.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/iterable-api.

License

The gem is available as open source under the terms of the MIT License.