drip-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 399ac5f6deb63991f5d809be4cfb1ff91814122c
+  data.tar.gz: 2e0edbc7c6f951004b3ab07b3b7549518e8eb2ec
+SHA512:
+  metadata.gz: 4d5835097d80f4988c1134090077b06e6b15193733455d4fcef4faeb1898d50a0d78b845535d29eb687f5ab135a0819e13ed26025de1f03acfcd306d850065a8
+  data.tar.gz: f08e9b1009bed397d34a7cf88629639d76ba344ca260857baded67fa09920afc1a95aaa20bc6b722f040c8f9cdf8cba985d6790c9bf70a4d4e159e8e42a87e1b

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - jruby-19mode
+  - rbx-2
+  - ruby-head
+  - jruby-head
+  - ree

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in drip-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Derrick Reimer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Drip Ruby Bindings
+
+A Ruby toolkit for the [Drip](https://www.getdrip.com/) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'drip-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install drip-ruby
+
+## Usage
+
+To begin making requests, spin up a new Drip client:
+
+```ruby
+client = Drip::Client.new do |c|
+  c.api_key = "YOUR_API_TOKEN"
+  c.account_id = "YOUR_ACCOUNT_ID"
+end
+```
+
+You can find your API key [here](https://www.getdrip.com/settings/general)
+and your account ID [here](https://www.getdrip.com/settings/site).
+
+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:
+
+| Action                     | Method                                               |
+| :------------------------- | :--------------------------------------------------- |
+| Create/update a subscriber | `#create_or_update_subscriber(email, options = {})`  |
+| Fetch a subscriber         | `#subscriber(id_or_email)`                           |
+| Subscribe to a campaign    | `#subscribe(email, campaign_id, options = {})`       |
+| Unsubscribe                | `#unsubscribe(id_or_email, options = {})`            |
+| Apply a tag                | `#apply_tag(email, tag)`                             |
+| Remove a tag               | `#remove_tag(email, tag)`                            |
+| Track an event             | `#track_event(email, action, properties = {})`       |
+
+
+**Note:** We do not have complete API coverage yet. If we are missing an API method
+that you need to use in your application, please file an issue and/or open a
+pull request. [See the official REST API docs](https://www.getdrip.com/docs/rest-api)
+for a complete API reference.
+
+## Examples
+
+```ruby
+client = Drip::Client.new do |c|
+  c.api_key = "YOUR_API_TOKEN"
+  c.account_id = "YOUR_ACCOUNT_ID"
+end
+
+# Fetch a subscriber
+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

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/drip-ruby.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'drip/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "drip-ruby"
+  spec.version       = Drip::VERSION
+  spec.authors       = ["Derrick Reimer"]
+  spec.email         = ["derrickreimer@gmail.com"]
+  spec.summary       = %q{A Ruby gem for interacting with the Drip API}
+  spec.description   = %q{A simple wrapper for the Drip API}
+  spec.homepage      = "http://github.com/DripEmail/drip-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "shoulda-context", "~> 1.0"
+  spec.add_development_dependency "mocha"
+
+  spec.add_runtime_dependency "faraday"
+  spec.add_runtime_dependency "faraday_middleware"
+  spec.add_runtime_dependency "json"
+end

data/lib/drip.rb

@@ -0,0 +1,2 @@
+require "drip/version"
+require "drip/client"

data/lib/drip/client.rb

@@ -0,0 +1,82 @@
+require "drip/response"
+require "drip/client/subscribers"
+require "drip/client/tags"
+require "drip/client/events"
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+module Drip
+  class Client
+    include Subscribers
+    include Tags
+    include Events
+
+    attr_accessor :api_key, :account_id
+
+    def initialize
+      yield(self) if block_given?
+    end
+
+    def generate_resource(key, *args)
+      { key => args }
+    end
+
+    def content_type
+      'application/vnd.api+json'
+    end
+
+    def get(url, options = {})
+      build_response do
+        connection.get do |req|
+          req.url url
+          req.params = options
+        end
+      end
+    end
+
+    def post(url, options = {})
+      build_response do
+        connection.post do |req|
+          req.url url
+          req.body = options.to_json
+        end
+      end
+    end
+
+    def put(url, options = {})
+      build_response do
+        connection.put do |req|
+          req.url url
+          req.body = options.to_json
+        end
+      end
+    end
+
+    def delete(url, options = {})
+      build_response do
+        connection.delete do |req|
+          req.url url
+          req.body = options.to_json
+        end
+      end
+    end
+
+    def build_response(&block)
+      response = yield
+      Drip::Response.new(response.status, response.body)
+    end
+
+    def connection
+      @connection ||= Faraday.new do |f|
+        f.adapter :net_http
+        f.url_prefix = "https://api.getdrip.com/v2/"
+        f.headers['User-Agent'] = "Drip Ruby v#{Drip::VERSION}"
+        f.headers['Content-Type'] = content_type
+        f.headers['Accept'] = "*/*"
+        f.basic_auth api_key, ""
+        f.response :json, :content_type => /\bjson$/
+      end
+    end
+  end
+end

data/lib/drip/client/events.rb

@@ -0,0 +1,20 @@
+require "cgi"
+
+module Drip
+  class Client
+    module Events
+      # Public: Track an event.
+      #
+      # email      - Required. The String email address of the subscriber.
+      # action     - Required. The String event action.
+      # properties - Optional. A Hash of event properties.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#record_event
+      def track_event(email, action, properties = {})
+        data = { "email" => email, "action" => action, "properties" => properties }
+        post "#{account_id}/events", generate_resource("events", data)
+      end
+    end
+  end
+end

data/lib/drip/client/subscribers.rb

@@ -0,0 +1,81 @@
+require "cgi"
+
+module Drip
+  class Client
+    module Subscribers
+      # Public: Fetch a subscriber.
+      #
+      # id_or_email - Required. The String id or email address of the subscriber.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#fetch_subscriber
+      def subscriber(id_or_email)
+        get "#{account_id}/subscribers/#{CGI.escape id_or_email}"
+      end
+
+      # Public: Create or update a subscriber.
+      #
+      # options - A Hash of options.
+      #           - email         - Required. The String subscriber email address.
+      #           - new_email     - Optional. A new email address for the subscriber.
+      #                             If provided and a subscriber with the email above
+      #                             does not exist, this address will be used to
+      #                             create a new subscriber.
+      #           - time_zone     - Optional. The subscriber's time zone (in Olsen
+      #                             format). Defaults to Etc/UTC.
+      #           - custom_fields - Optional. A Hash of custom field data.
+      #           - tags          - Optional. An Array of tags.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#create_or_update_subscriber
+      def create_or_update_subscriber(email, options = {})
+        data = options.merge(:email => email)
+        post "#{account_id}/subscribers", generate_resource("subscribers", data)
+      end
+
+      # Public: Unsubscribe a subscriber globally or from a specific campaign.
+      #
+      # id_or_email - Required. The String id or email address of the subscriber.
+      # options     - A Hash of options.
+      #               - campaign_id - Optional. The campaign from which to
+      #                               unsubscribe the subscriber. Defaults to all.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#unsubscribe
+      def unsubscribe(id_or_email, options = {})
+        url = "#{account_id}/subscribers/#{CGI.escape id_or_email}/unsubscribe"
+        url += options[:campaign_id] ? "?campaign_id=#{options[:campaign_id]}" : ""
+        post url
+      end
+
+      # Public: Subscribe to a campaign.
+      #
+      # email       - Required. The String email address of the subscriber.
+      # campaign_id - Required. The String campaign id.
+      # options     - Optional. A Hash of options.
+      #               - double_optin  - Optional. If true, the double opt-in confirmation
+      #                                 email is sent; if false, the confirmation
+      #                                 email is skipped. Defaults to the value set
+      #                                 on the campaign.
+      #               - starting_email_index - Optional. The index (zero-based) of
+      #                                 the email to send first. Defaults to 0.
+      #               - time_zone     - Optional. The subscriber's time zone (in Olsen
+      #                                 format). Defaults to Etc/UTC.
+      #               - custom_fields - Optional. A Hash of custom field data.
+      #               - tags          - Optional. An Array of tags.
+      #               - reactivate_if_removed - Optional. If true, re-subscribe
+      #                                 the subscriber to the campaign if there
+      #                                 is a removed subscriber in Drip with the same
+      #                                 email address; otherwise, respond with
+      #                                 422 Unprocessable Entity. Defaults to true.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#subscribe
+      def subscribe(email, campaign_id, options = {})
+        data = options.merge("email" => email)
+        url = "#{account_id}/campaigns/#{campaign_id}/subscribers"
+        post url, generate_resource("subscribers", data)
+      end
+    end
+  end
+end

data/lib/drip/client/tags.rb

@@ -0,0 +1,30 @@
+require "cgi"
+
+module Drip
+  class Client
+    module Tags
+      # Public: Apply a tag to a subscriber.
+      #
+      # email - The String email address of the subscriber.
+      # tag   - The String tag to apply.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#apply_tag
+      def apply_tag(email, tag)
+        data = { "email" => email, "tag" => tag }
+        post "#{account_id}/tags", generate_resource("tags", data)
+      end
+
+      # Public: Remove a tag from a subscriber.
+      #
+      # email - The String email address of the subscriber.
+      # tag   - The String tag to remove.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#remove_tag
+      def remove_tag(email, tag)
+        delete "#{account_id}/subscribers/#{CGI.escape email}/tags/#{CGI.escape tag}"
+      end
+    end
+  end
+end

data/lib/drip/collection.rb

@@ -0,0 +1,39 @@
+module Drip
+  class Collection
+    include Enumerable
+
+    attr_reader :raw_items, :items
+
+    def initialize(raw_items)
+      @raw_items = raw_items.dup.freeze
+      @items = parse_items
+    end
+
+    def self.collection_name
+      "resources"
+    end
+
+    def self.resource_name
+      "resource"
+    end
+
+    def item_class
+      @item_class ||= Drip::Resources.
+        find_class(self.class.resource_name)
+    end
+
+    def parse_items
+      raw_items.map do |raw_item|
+        item_class.new(raw_item)
+      end
+    end
+
+    def singular?
+      items.length < 2
+    end
+
+    def each(&block)
+      items.each { |item| yield(item) }
+    end
+  end
+end