drip-ruby 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d4e777f5ca779726700304adcdce97c48cd8537
-  data.tar.gz: bd5ed6afa3f0c4c436fabf4b8d3f759bbf07aea4
+  metadata.gz: 88627464a71686f9b3adcf9be0e40fc818856bb4
+  data.tar.gz: 20acf82185d43a600bab243510c58a9c0828ad2b
 SHA512:
-  metadata.gz: e1be434ca69b2b16b0c6b192d1cd30cb8a7853426d477f30c2a1c761ffa5cfe129658d73854b8622697f784e0a7089dab1e194f036a11671fd0ff6d45ba7adba
-  data.tar.gz: f9b0b6e8ea3631d3f67ef935177106d497627170f6b2f11c82f135c68929860dbf05b350c91269c6e1b9883377d00e5d70a5653594222ec1a5be32e0769f5527
+  metadata.gz: df49725e0364d09f2f5b48552e829d6726e2ea402cd390fc6ea2a6cd8b091d6b8ba49a5644e7f4bf4d19a08b17fcf63bc620101cfa4311bedd614ca425b22849
+  data.tar.gz: 69bd895065c5d133f164b5c3fe05caf9e1607fbf801a384cadac9da46b2ccc4e8ddd7dc07df6310282d02e8159668a25dd9a221da3c4858b4865f09af4c83bd1

data/.travis.yml

@@ -3,5 +3,3 @@ sudo: false
 rvm:
   - 2.1.0
   - jruby-19mode
-  - rbx-2
-  - ruby-head

data/README.md

@@ -5,6 +5,8 @@ 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:
@@ -69,12 +71,15 @@ as methods on the client object. The following methods are currently available:
 | Subscribe to a campaign    | `#subscribe(email, campaign_id, options = {})`       |
 | Unsubscribe                | `#unsubscribe(id_or_email, options = {})`            |
 | Delete                     | `#delete_subscriber(id_or_email)`                    |
+| List tags                  | `#tags`                                              |
 | Apply a tag                | `#apply_tag(email, tag)`                             |
 | Remove a tag               | `#remove_tag(email, tag)`                            |
 | Track an event             | `#track_event(email, action, properties = {})`       |
 | Track a batch of events    | `#track_events(events)`                              |
 | List campaigns             | `#campaigns`                                         |
-
+| Create a purchase          | `#create_purchase(email, amount, options = {})`      |
+| List purchases for a subscriber | `#purchases(email)`                             |
+| Fetch a purchase           | `#purchase(email, id)`                               |
 
 **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

data/drip-ruby.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 1.9.3'
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "shoulda-context", "~> 1.0"
@@ -26,5 +28,4 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "faraday", "~> 0.9"
   spec.add_runtime_dependency "faraday_middleware", "~> 0.9"
-  spec.add_runtime_dependency "json", "~> 1.8"
 end

data/lib/drip/client.rb

@@ -4,6 +4,7 @@ require "drip/client/subscribers"
 require "drip/client/tags"
 require "drip/client/events"
 require "drip/client/campaigns"
+require "drip/client/purchases"
 require "faraday"
 require "faraday_middleware"
 require "json"
@@ -15,6 +16,7 @@ module Drip
     include Tags
     include Events
     include Campaigns
+    include Purchases
 
     attr_accessor :access_token, :api_key, :account_id
 
@@ -34,37 +36,31 @@ module Drip
     end
 
     def get(url, options = {})
-      build_response do
-        connection.get do |req|
-          req.url url
-          req.params = options
-        end
-      end
+      make_request(:get, url, options)
     end
 
     def post(url, options = {})
-      build_response do
-        connection.post do |req|
-          req.url url
-          req.body = options.to_json
-        end
-      end
+      make_request(:post, url, options)
     end
 
     def put(url, options = {})
-      build_response do
-        connection.put do |req|
-          req.url url
-          req.body = options.to_json
-        end
-      end
+      make_request(:put, url, options)
     end
 
     def delete(url, options = {})
+      make_request(:delete, url, options)
+    end
+
+    def make_request(verb, url, options)
       build_response do
-        connection.delete do |req|
+        connection.send(verb) do |req|
           req.url url
-          req.body = options.to_json
+
+          if verb == :get
+            req.params = options
+          else
+            req.body = options.to_json
+          end
         end
       end
     end

data/lib/drip/client/accounts.rb

@@ -8,100 +8,6 @@ module Drip
       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
-
-      # Public: Delete a subscriber.
-      #
-      # id_or_email - Required. The String id or email address of the subscriber.
-      #
-      # Returns No Content.
-      # See https://www.getdrip.com/docs/rest-api#fdelete_subscriber
-      def delete_subscriber(id_or_email)
-        delete "#{account_id}/subscribers/#{CGI.escape id_or_email}"
-      end
     end
   end
 end

data/lib/drip/client/purchases.rb

@@ -0,0 +1,66 @@
+require "cgi"
+
+module Drip
+  class Client
+    module Purchases
+      # Public: Create a purchase.
+      #
+      # email   - Required. The String email address of the subscriber.
+      # amount  - Required. The total amount of the purchase in cents.
+      # options - A Hash of options.
+      #           - properties    - Optional. An Object containing properties about
+      #                             the order.
+      #           - items         - Optional. An Array of objects containing information
+      #                             about specific order items.
+      #                             - name        - Required. The product name.
+      #                             - amount      - Required. The line total (in
+      #                                             cents).
+      #                             - quantity    - Optional. The quantity of the
+      #                                             item purchased (if omitted,
+      #                                             defaults to 1).
+      #                             - product_id  - Optional. A unique identifier
+      #                                             for the specific product.
+      #                             - sku         - Optional. The product SKU number.
+      #                             - properties  - Optional. An Object containing
+      #                                             properties about the line item.
+      #            - provider    - Optional. The identifier for the provider from
+      #                            which the purchase data was received
+      #            - order_id    - Optional. A unique identifier for the order
+      #                            (generally the primary key generated by the
+      #                            order management system).
+      #            - permalink   - Optional. A URL for the human-readable
+      #                            interface to view the order details.
+      #            - occurred_at - Optional. The String time at which the event
+      #                            occurred in ISO-8601 format. Defaults to the
+      #                            current time.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#create_purchase
+      def create_purchase(email, amount, options = {})
+        data = options.merge(:amount => amount)
+        post "#{account_id}/subscribers/#{CGI.escape email}/purchases", generate_resource("purchases", data)
+      end
+
+      # Public: Fetch a list of purchases for a subscriber.
+      #
+      # email - The String email address of the subscriber.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#list_purchases
+      def purchases(email)
+        get "#{account_id}/subscribers/#{CGI.escape email}/purchases"
+      end
+
+      # Public: Fetch a purchase.
+      #
+      # email - The String email address of the subscriber.
+      # id    - The String ID of the purchase
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#list_purchases
+      def purchase(email, id)
+        get "#{account_id}/subscribers/#{CGI.escape email}/purchases/#{id}"
+      end
+    end
+  end
+end

data/lib/drip/client/subscribers.rb

@@ -31,8 +31,8 @@ module Drip
 
       # Public: Create or update a subscriber.
       #
+      # email   - Required. The String subscriber email address.
       # 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

data/lib/drip/client/tags.rb

@@ -3,6 +3,14 @@ require "cgi"
 module Drip
   class Client
     module Tags
+      # Public: Get all tags for the account.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#tags
+      def tags
+        get "#{account_id}/tags"
+      end
+
       # Public: Apply a tag to a subscriber.
       #
       # email - The String email address of the subscriber.

data/lib/drip/collections.rb

@@ -1,6 +1,8 @@
 require "drip/collections/accounts"
 require "drip/collections/subscribers"
+require "drip/collections/tags"
 require "drip/collections/errors"
+require "drip/collections/purchases"
 
 module Drip
   module Collections
@@ -8,7 +10,9 @@ module Drip
       [
         Drip::Accounts,
         Drip::Subscribers,
-        Drip::Errors
+        Drip::Errors,
+        Drip::Tags,
+        Drip::Purchases
       ]
     end
 

data/lib/drip/collections/purchases.rb

@@ -0,0 +1,13 @@
+require "drip/collection"
+
+module Drip
+  class Purchases < Collection
+    def self.collection_name
+      "purchases"
+    end
+
+    def self.resource_name
+      "purchase"
+    end
+  end
+end

data/lib/drip/collections/tags.rb

@@ -0,0 +1,13 @@
+require "drip/collection"
+
+module Drip
+  class Tags < Collection
+    def self.collection_name
+      "tags"
+    end
+
+    def self.resource_name
+      "tag"
+    end
+  end
+end

data/lib/drip/resources.rb

@@ -1,6 +1,8 @@
 require "drip/resources/account"
 require "drip/resources/subscriber"
+require "drip/resources/tag"
 require "drip/resources/error"
+require "drip/resources/purchase"
 
 module Drip
   module Resources
@@ -8,7 +10,9 @@ module Drip
       [
         Drip::Account,
         Drip::Subscriber,
-        Drip::Error
+        Drip::Error,
+        Drip::Tags,
+        Drip::Purchase
       ]
     end
 

data/lib/drip/resources/purchase.rb

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

data/lib/drip/resources/tag.rb

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

data/lib/drip/version.rb

@@ -1,3 +1,3 @@
 module Drip
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/test/drip/client/purchases_test.rb

@@ -0,0 +1,94 @@
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+
+class Drip::Client::PurchasesTest < Drip::TestCase
+  def setup
+    @stubs = Faraday::Adapter::Test::Stubs.new
+
+    @connection = Faraday.new do |builder|
+      builder.adapter :test, @stubs
+    end
+
+    @client = Drip::Client.new { |c| c.account_id = "12345" }
+    @client.expects(:connection).at_least_once.returns(@connection)
+  end
+
+  context "#create_purchase" do
+    setup do
+      @email = "derrick@getdrip.com"
+      @amount = 3900
+      @properties = {
+        address: '123 Anywhere St'
+      }
+
+      @items = [
+        {
+          name: 'foo',
+          amount: 100
+        },
+        {
+          name: 'bar',
+          amount: 200
+        }
+      ]
+
+      @payload = {
+        purchases: [{
+          properties: @properties,
+          items: @items,
+          amount: @amount
+        }]
+      }.to_json
+
+      @response_status = 201
+      @response_body = stub
+
+      @stubs.post "12345/subscribers/#{CGI.escape @email}/purchases", @payload 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.create_purchase(@email, @amount, {
+        properties: @properties,
+        items: @items
+      })
+    end
+  end
+
+  context "#purchases" do
+    setup do
+      @email = "derrick@getdrip.com"
+      @response_status = 201
+      @response_body = stub
+
+      @stubs.get "12345/subscribers/#{CGI.escape @email}/purchases" 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.purchases(@email)
+    end
+  end
+
+  context "#purchase" do
+    setup do
+      @email = "derrick@getdrip.com"
+      @id = '23456'
+      @response_status = 201
+      @response_body = stub
+
+      @stubs.get "12345/subscribers/#{CGI.escape @email}/purchases/#{@id}" 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.purchase(@email, @id)
+    end
+  end
+
+end

data/test/drip/client/tags_test.rb

@@ -12,6 +12,22 @@ class Drip::Client::TagsTest < Drip::TestCase
     @client.expects(:connection).at_least_once.returns(@connection)
   end
 
+  context "#tags" do
+    setup do
+      @response_status = 200
+      @response_body = stub
+
+      @stubs.get "12345/tags" 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.tags
+    end
+  end
+
   context "#apply_tag" do
     setup do
       @email = "derrick@getdrip.com"

data/test/drip/collections_test.rb

@@ -5,6 +5,7 @@ class Drip::CollectionsTest < Drip::TestCase
     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")
+    assert_equal Drip::Purchases, Drip::Collections.find_class("purchases")
   end
 
   should "return base collection by default" do

data/test/drip/resources_test.rb

@@ -4,6 +4,7 @@ class Drip::ResourcesTest < Drip::TestCase
   should "find resources" do
     assert_equal Drip::Subscriber, Drip::Resources.find_class("subscriber")
     assert_equal Drip::Error, Drip::Resources.find_class("error")
+    assert_equal Drip::Purchase, Drip::Resources.find_class("purchase")
   end
 
   should "return base resource by default" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drip-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Derrick Reimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-11 00:00:00.000000000 Z
+date: 2017-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,20 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 description: A simple wrapper for the Drip API
 email:
 - derrickreimer@gmail.com
@@ -141,23 +127,29 @@ files:
 - lib/drip/client/accounts.rb
 - lib/drip/client/campaigns.rb
 - lib/drip/client/events.rb
+- lib/drip/client/purchases.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/purchases.rb
 - lib/drip/collections/subscribers.rb
+- lib/drip/collections/tags.rb
 - lib/drip/resource.rb
 - lib/drip/resources.rb
 - lib/drip/resources/account.rb
 - lib/drip/resources/error.rb
+- lib/drip/resources/purchase.rb
 - lib/drip/resources/subscriber.rb
+- lib/drip/resources/tag.rb
 - lib/drip/response.rb
 - lib/drip/version.rb
 - test/drip/client/accounts_test.rb
 - test/drip/client/campaigns_test.rb
 - test/drip/client/events_test.rb
+- test/drip/client/purchases_test.rb
 - test/drip/client/subscribers_test.rb
 - test/drip/client/tags_test.rb
 - test/drip/client_test.rb
@@ -183,7 +175,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -191,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for interacting with the Drip API
@@ -199,6 +191,7 @@ test_files:
 - test/drip/client/accounts_test.rb
 - test/drip/client/campaigns_test.rb
 - test/drip/client/events_test.rb
+- test/drip/client/purchases_test.rb
 - test/drip/client/subscribers_test.rb
 - test/drip/client/tags_test.rb
 - test/drip/client_test.rb