drip-ruby 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20b8acc735371bed7872d258a98d0ff9ce347917
-  data.tar.gz: 2ac3d040c408dd94e9265da324168af97fe5952d
+  metadata.gz: 9517d2daf672dbd3ce976aa87445eaba6b13c401
+  data.tar.gz: 32f6963d29532bfb0b051c791d4646e829adef5c
 SHA512:
-  metadata.gz: 55d9319bfe2d614f8e7f58bbf7dfea07f567617ec588d6dabb86c8e6f64bd0f237f520b0dda6454fcf869272eac3f2db3a1a35ab94c1eb0ea4de840ce27b2291
-  data.tar.gz: 3867dd7fa45da8936f023506517377905ddc2e1995b5e93d7ddb906e6306ae4143969e52f3128e4821f636323df1ea9970212598372cb55908cbf00d246d0ae9
+  metadata.gz: 9450ed93e3e54dc5c9f412b7eb621bc156d001a2aeedd2ce73b2f680f9ad82d296653d6668c29bae08f853056999644cc251f4f1282ae1acb42c58541dfd09f5
+  data.tar.gz: b79a01d2437d10bfd8baf8a1b787ddc2bffdc2dcd9c0035c0ae515a92c0077e247ee529f6e019d812b19a2f2a78daa4c9149c7c530f5c6c2149437df31695cf4

data/.travis.yml

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

data/README.md

@@ -1,12 +1,15 @@
-# Drip Ruby Bindings
+# Drip Ruby Client
 
 A Ruby toolkit for the [Drip](https://www.getdrip.com/) API.
 
+[![Build Status](https://travis-ci.org/DripEmail/drip-ruby.svg?branch=master)](https://travis-ci.org/DripEmail/drip-ruby)
+[![Code Climate](https://codeclimate.com/github/DripEmail/drip-ruby/badges/gpa.svg)](https://codeclimate.com/github/DripEmail/drip-ruby)
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'drip-ruby', :require => 'drip'
+    gem 'drip-ruby', require: 'drip'
 
 And then execute:
 
@@ -16,9 +19,7 @@ Or install it yourself as:
 
     $ gem install drip-ruby
 
-## Usage
-
-Your account ID can be found [here](https://www.getdrip.com/settings/site).
+## Authentication
 
 For private integrations, you may use your personal API key (found
 [here](https://www.getdrip.com/user/edit)) via the `api_key` setting:
@@ -40,11 +41,27 @@ client = Drip::Client.new do |c|
 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:
 
 | Action                     | Method                                               |
 | :------------------------- | :--------------------------------------------------- |
+| List accounts              | `#accounts`                                          |
 | Create/update a subscriber | `#create_or_update_subscriber(email, options = {})`  |
 | Create/update a batch of subscribers | `#create_or_update_subscribers(subscribers)` |
 | Fetch a subscriber         | `#subscriber(id_or_email)`                           |
@@ -61,15 +78,17 @@ 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
+## Use Cases
 
-```ruby
-client = Drip::Client.new do |c|
-  c.api_key = "YOUR_API_TOKEN"
-  c.account_id = "YOUR_ACCOUNT_ID"
-end
+Here are some common use cases for the API client.
+
+### Fetching subscriber data
 
-# Fetch a subscriber
+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 ...>
 

data/drip-ruby.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "shoulda-context", "~> 1.0"
   spec.add_development_dependency "mocha", "~> 1.1"
+  spec.add_development_dependency "minitest", "~> 5.0"
 
   spec.add_runtime_dependency "faraday", "~> 0.9"
   spec.add_runtime_dependency "faraday_middleware", "~> 0.9"

data/lib/drip/client.rb

@@ -1,4 +1,5 @@
 require "drip/response"
+require "drip/client/accounts"
 require "drip/client/subscribers"
 require "drip/client/tags"
 require "drip/client/events"
@@ -8,13 +9,17 @@ require "json"
 
 module Drip
   class Client
+    include Accounts
     include Subscribers
     include Tags
     include Events
 
     attr_accessor :access_token, :api_key, :account_id
 
-    def initialize
+    def initialize(options = {})
+      @account_id = options[:account_id]
+      @access_token = options[:access_token]
+      @api_key = options[:api_key]
       yield(self) if block_given?
     end
 

data/lib/drip/client/accounts.rb

@@ -0,0 +1,97 @@
+module Drip
+  class Client
+    module Accounts
+      # Public: Fetch all accounts to which the authenticated user has access.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#accounts
+      def accounts
+        get "accounts"
+      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: Create or update a collection of subscribers.
+      #
+      # subscribers - Required. An Array of between 1 and 1000 Hashes of subscriber data.
+      #               - 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#subscriber_batches
+      def create_or_update_subscribers(subscribers)
+        url = "#{account_id}/subscribers/batches"
+        post url, generate_resource("batches", { "subscribers" => subscribers })
+      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/subscribers.rb

@@ -3,6 +3,22 @@ require "cgi"
 module Drip
   class Client
     module Subscribers
+      # Public: Fetch a subscriber.
+      #
+      # options - A Hash of options.
+      #           - status - Optional. Filter by one of the following statuses:
+      #                      active, or unsubscribed, or removed. Defaults to all.
+      #           - page   - Optional. Use this parameter to paginate through
+      #                      your list of subscribers. Each response contains a
+      #                      a `meta` object that includes `total_count` and
+      #                      `total_pages` attributes.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#list_subscribers
+      def subscribers(options = {})
+        get "#{account_id}/subscribers", options
+      end
+
       # Public: Fetch a subscriber.
       #
       # id_or_email - Required. The String id or email address of the subscriber.

data/lib/drip/collections.rb

@@ -1,3 +1,4 @@
+require "drip/collections/accounts"
 require "drip/collections/subscribers"
 require "drip/collections/errors"
 
@@ -5,17 +6,14 @@ module Drip
   module Collections
     def self.classes
       [
+        Drip::Accounts,
         Drip::Subscribers,
         Drip::Errors
       ]
     end
 
     def self.find_class(name)
-      matches = self.classes.select do |c|
-        c.collection_name == name
-      end
-
-      matches.first || Drip::Collection
+      self.classes.find { |c| c.collection_name == name } || Drip::Collection
     end
   end
 end

data/lib/drip/collections/accounts.rb

@@ -0,0 +1,13 @@
+require "drip/collection"
+
+module Drip
+  class Accounts < Collection
+    def self.collection_name
+      "accounts"
+    end
+
+    def self.resource_name
+      "account"
+    end
+  end
+end

data/lib/drip/resource.rb

@@ -1,3 +1,5 @@
+require "time"
+
 module Drip
   class Resource
     attr_reader :raw_attributes, :attributes
@@ -11,36 +13,30 @@ module Drip
       "resource"
     end
 
-    def attribute_keys
-      []
-    end
-
     def singular?
       true
     end
 
     def respond_to?(method_name, include_private = false)
-      attribute_keys.include?(method_name) || super
+      attributes.keys.include?(method_name.to_s) || super
     end
 
     def method_missing(method_name, *args, &block)
-      attribute_keys.include?(method_name) ? attributes[method_name] : super
+      attributes.keys.include?(method_name.to_s) ? attributes[method_name.to_s] : super
     end
 
   private
 
     def process(attributes)
       {}.tap do |attrs|
-        attribute_keys.each do |key|
-          raw_value = attributes[key.to_s]
-          attrs[key] = process_attribute(key, raw_value)
+        attributes.keys.each do |key|
+          attrs[key] = process_attribute(key, attributes[key])
         end
       end
     end
 
     def process_attribute(key, raw_value)
-      case key
-      when :created_at, :updated_at
+      if key.to_s =~ /_at$/ # auto-coerce times
         raw_value ? Time.parse(raw_value) : nil
       else
         raw_value

data/lib/drip/resources.rb

@@ -1,3 +1,4 @@
+require "drip/resources/account"
 require "drip/resources/subscriber"
 require "drip/resources/error"
 
@@ -5,17 +6,14 @@ module Drip
   module Resources
     def self.classes
       [
+        Drip::Account,
         Drip::Subscriber,
         Drip::Error
       ]
     end
 
     def self.find_class(name)
-      matches = self.classes.select do |c|
-        c.resource_name == name
-      end
-
-      matches.first || Drip::Resource
+      self.classes.find { |c| c.resource_name == name } || Drip::Resource
     end
   end
 end

data/lib/drip/resources/account.rb

@@ -0,0 +1,9 @@
+require "drip/resource"
+
+module Drip
+  class Account < Resource
+    def self.resource_name
+      "account"
+    end
+  end
+end

data/lib/drip/resources/error.rb

@@ -5,9 +5,5 @@ module Drip
     def self.resource_name
       "error"
     end
-
-    def attribute_keys
-      %i{code attribute message}
-    end
   end
 end

data/lib/drip/resources/subscriber.rb

@@ -1,15 +1,9 @@
 require "drip/resource"
-require "time"
 
 module Drip
   class Subscriber < Resource
     def self.resource_name
       "subscriber"
     end
-
-    def attribute_keys
-      %i{id status email custom_fields tags time_zone
-        utc_offset visitor_uuid created_at href}
-    end
   end
 end

data/lib/drip/version.rb

@@ -1,3 +1,3 @@
 module Drip
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/drip/client/accounts_test.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+
+class Drip::Client::AccountsTest < Drip::TestCase
+  def setup
+    @stubs = Faraday::Adapter::Test::Stubs.new
+
+    @connection = Faraday.new do |builder|
+      builder.adapter :test, @stubs
+    end
+
+    @client = Drip::Client.new
+    @client.expects(:connection).at_least_once.returns(@connection)
+  end
+
+  context "#accounts" do
+    setup do
+      @response_status = 200
+      @response_body = stub
+
+      @stubs.get "accounts" do
+        [@response_status, {}, @response_body]
+      end
+    end
+
+    should "send the right request" do
+      expected = Drip::Response.new(@response_status, @response_body)
+      assert_equal expected, @client.accounts
+    end
+  end
+end

data/test/drip/client/events_test.rb

@@ -1,5 +1,4 @@
 require File.dirname(__FILE__) + '/../../test_helper.rb'
-require "faraday"
 
 class Drip::Client::EventsTest < Drip::TestCase
   def setup

data/test/drip/client/subscribers_test.rb

@@ -1,5 +1,4 @@
 require File.dirname(__FILE__) + '/../../test_helper.rb'
-require "faraday"
 
 class Drip::Client::SubscribersTest < Drip::TestCase
   def setup
@@ -13,6 +12,22 @@ class Drip::Client::SubscribersTest < Drip::TestCase
     @client.expects(:connection).at_least_once.returns(@connection)
   end
 
+  context "#subscribers" do
+    setup do
+      @response_status = 200
+      @response_body = stub
+
+      @stubs.get "12345/subscribers" do
+        [@response_status, {}, @response_body]
+      end
+    end
+
+    should "send the right request" do
+      expected = Drip::Response.new(@response_status, @response_body)
+      assert_equal expected, @client.subscribers
+    end
+  end
+
   context "#subscriber" do
     setup do
       @id = "derrick@getdrip.com"

data/test/drip/client/tags_test.rb

@@ -1,5 +1,4 @@
 require File.dirname(__FILE__) + '/../../test_helper.rb'
-require "faraday"
 
 class Drip::Client::TagsTest < Drip::TestCase
   def setup

data/test/drip/client_test.rb

@@ -26,6 +26,18 @@ class Drip::ClientTest < Drip::TestCase
 
       assert_equal "1234567", client.account_id
     end
+
+    should "accept options via arguments" do
+      client = Drip::Client.new(
+        account_id: "1234567",
+        api_key: "aaaa",
+        access_token: "bbbb"
+      )
+
+      assert_equal "1234567", client.account_id
+      assert_equal "aaaa", client.api_key
+      assert_equal "bbbb", client.access_token
+    end
   end
 
   context "#generate_resource" do

data/test/drip/collections_test.rb

@@ -3,6 +3,7 @@ require File.dirname(__FILE__) + '/../test_helper.rb'
 class Drip::CollectionsTest < Drip::TestCase
   should "find collections" do
     assert_equal Drip::Subscribers, Drip::Collections.find_class("subscribers")
+    assert_equal Drip::Accounts, Drip::Collections.find_class("accounts")
     assert_equal Drip::Errors, Drip::Collections.find_class("errors")
   end
 

data/test/drip/resource_test.rb

@@ -2,33 +2,21 @@ require File.dirname(__FILE__) + '/../test_helper.rb'
 
 class Drip::ResourceTest < Drip::TestCase
   class TestResource < Drip::Resource
-    def attribute_keys
-      %i{id name}
-    end
-
-    def process_attribute(key, value)
-      case key
-      when :id
-        value.to_i
-      else
-        value
-      end
-    end
   end
 
-  should "respond to all attribute keys" do
-    resource = TestResource.new
+  should "respond to attributes passed in" do
+    resource = TestResource.new("id" => "1234")
     assert resource.respond_to?(:id)
-    assert resource.respond_to?(:name)
+    assert_equal "1234", resource.id
   end
 
-  should "process raw data" do
+  should "not respond to non-existant attributes" do
     resource = TestResource.new("id" => "1234")
-    assert_equal 1234, resource.id
+    assert !resource.respond_to?(:first_name)
   end
 
-  should "default unset attributes to nil" do
-    resource = TestResource.new("id" => "1234")
-    assert_equal nil, resource.name
+  should "coerce times" do
+    resource = TestResource.new("created_at" => "2015-06-15T10:00:00Z")
+    assert_equal Time.utc(2015, 6, 15, 10, 0, 0), resource.created_at
   end
 end

data/test/drip/resources/account_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+
+class Drip::AccountTest < Drip::TestCase
+  should "have a resource name" do
+    assert_equal "account", Drip::Account.resource_name
+  end
+end

data/test/drip/resources/subscriber_test.rb

@@ -1,20 +1,7 @@
 require File.dirname(__FILE__) + '/../../test_helper.rb'
 
 class Drip::SubscriberTest < Drip::TestCase
-  should "parse created_at" do
-    created_at = Time.new(2014, 11, 15, 3, 0, 0, 0)
-
-    data = load_json_fixture("resources/subscriber.json")
-    data["created_at"] = created_at.iso8601
-
-    resource = Drip::Subscriber.new(data)
-
-    assert_equal created_at, resource.created_at
-  end
-
-  context ".resource_name" do
-    should "be subscriber" do
-      assert_equal "subscriber", Drip::Subscriber.resource_name
-    end
+  should "have a resource name" do
+    assert_equal "subscriber", Drip::Subscriber.resource_name
   end
 end

data/test/drip/response_test.rb

@@ -28,7 +28,7 @@ class Drip::ResponseTest < Drip::TestCase
   context "#==" do
     should "be true if status and body are equal" do
       status = 200
-      body = { "foo" => "bar" }
+      body = { "subscribers" => [{ "foo" => "bar" }] }
 
       subject1 = Drip::Response.new(status, body.clone)
       subject2 = Drip::Response.new(status, body.clone)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drip-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Derrick Reimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2015-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -124,19 +138,23 @@ files:
 - drip-ruby.gemspec
 - lib/drip.rb
 - lib/drip/client.rb
+- lib/drip/client/accounts.rb
 - lib/drip/client/events.rb
 - lib/drip/client/subscribers.rb
 - lib/drip/client/tags.rb
 - lib/drip/collection.rb
 - lib/drip/collections.rb
+- lib/drip/collections/accounts.rb
 - lib/drip/collections/errors.rb
 - lib/drip/collections/subscribers.rb
 - lib/drip/resource.rb
 - lib/drip/resources.rb
+- lib/drip/resources/account.rb
 - lib/drip/resources/error.rb
 - lib/drip/resources/subscriber.rb
 - lib/drip/response.rb
 - lib/drip/version.rb
+- test/drip/client/accounts_test.rb
 - test/drip/client/events_test.rb
 - test/drip/client/subscribers_test.rb
 - test/drip/client/tags_test.rb
@@ -144,6 +162,7 @@ files:
 - test/drip/collection_test.rb
 - test/drip/collections_test.rb
 - test/drip/resource_test.rb
+- test/drip/resources/account_test.rb
 - test/drip/resources/subscriber_test.rb
 - test/drip/resources_test.rb
 - test/drip/response_test.rb
@@ -175,6 +194,7 @@ signing_key:
 specification_version: 4
 summary: A Ruby gem for interacting with the Drip API
 test_files:
+- test/drip/client/accounts_test.rb
 - test/drip/client/events_test.rb
 - test/drip/client/subscribers_test.rb
 - test/drip/client/tags_test.rb
@@ -182,6 +202,7 @@ test_files:
 - test/drip/collection_test.rb
 - test/drip/collections_test.rb
 - test/drip/resource_test.rb
+- test/drip/resources/account_test.rb
 - test/drip/resources/subscriber_test.rb
 - test/drip/resources_test.rb
 - test/drip/response_test.rb