drip-ruby 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5aafc1c74dbc6f3b1394f304f7d1b9ceb3fe829d
-  data.tar.gz: 9a83f650a30e9c127c1a594fcbbd6964af009966
+SHA256:
+  metadata.gz: 0116b3930cb8e30ecf0291777d9acd336661f6c600a594632cd8b831bf042b9b
+  data.tar.gz: ecf5f5ea8225363976fb5993aa0a3fd29be1796261508a829027e71f6d458d65
 SHA512:
-  metadata.gz: 0a36ee1b8ac89b1fb63663e49d383acc3a3d15ff22e6bccf3afe5a5ab6cf17d4c76b5ae5369fe8a44383317d1db63fbda43432e1ad9c41c37ad3569bd9377a58
-  data.tar.gz: 64d97aea9e8937326694c91e34abbd8825890dc31476e0efc22403fef440b9569edf4a5b0ddd3b211e32a3e859290aaa4269acd29698c4d8da380cea578c0ffd
+  metadata.gz: ce290db0ffdae723d78d12d71e7f71f47c0b632c50d3d63d8f1c544d90e0cf367f43c4c73cab06b8321daf4d20764bc1ad4b5e0fb6e7086c93d6a95d85278880
+  data.tar.gz: e2f2f8f62441222da207c808f63b130c8be44ce6808faee5d681d6653481a2620d552f79487bdb8daeb45bcd24092b0ea19386342b9da72427e190b6b304e5ac

data/README.md

@@ -120,13 +120,15 @@ as methods on the client object. The following methods are currently available:
 | List all forms            | `#forms`                                              |
 | Fetch a form              | `#form(id)`                                           |
 
-#### Purchases
+#### Orders
+
+**Note:** The beta purchases endpoint has been deprecated and its methods have been removed from the gem except `create_purchase`, which now sends requests to the Order creation endpoint [here](https://developer.drip.com/#orders)
 
 | Actions                    | Methods                                              |
 | :------------------------- | :--------------------------------------------------- |
-| List purchases for a subscriber | `#purchases(email)`                             |
-| Create a purchase          | `#create_purchase(email, amount, options = {})`      |
-| Fetch a purchase           | `#purchase(email, id)`                               |
+| 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
 

data/lib/drip/client/events.rb

@@ -1,5 +1,3 @@
-require "cgi"
-
 module Drip
   class Client
     module Events

data/lib/drip/client/orders.rb

@@ -0,0 +1,45 @@
+module Drip
+  class Client
+    module Orders
+      # Public: Create or update an order.
+      #
+      # email      - Required. The String email address of the subscriber.
+      # options    - Required. A Hash of additional order options. Refer to the
+      #                       Drip API docs for the required schema.
+      #
+      # Returns a Drip::Response.
+      # See https://developer.drip.com/#orders
+      def create_or_update_order(email, options = {})
+        data = options.merge(email: email)
+        post "#{account_id}/orders", generate_resource("orders", data)
+      end
+
+      # Public: Create or update a batch of orders.
+      #
+      # orders      - Required. An Array with between 1 and 1000 objects containing order data
+      #
+      # Returns a Drip::Response.
+      # See https://developer.drip.com/#create-or-update-a-batch-of-orders
+      def create_or_update_orders(orders)
+        post "#{account_id}/orders/batches", generate_resource("batches", { "orders" => orders })
+      end
+
+      # Public: Create or update a refund.
+      #
+      # options      - Required. A Hash of refund properties
+      #                 amount	            - Required. The amount of the refund.
+      #                 provider            - Required. The provider for the Order being refunded.
+      #                 order_upstream_id   - Required. The upstream_id for the Order being refunded.
+      #                 upstream_id	        - The unique id of refund in the order management system.
+      #                 note	              - A note about the refund.
+      #                 processed_at        - The String time at which the refund was processed in 
+      #                                       ISO-8601 format.
+      #
+      # Returns a Drip::Response.
+      # See https://developer.drip.com/#create-or-update-a-refund
+      def create_or_update_refund(options)
+        post "#{account_id}/refunds", generate_resource("refunds", options)
+      end
+    end
+  end
+end

data/lib/drip/client/purchases.rb

@@ -1,5 +1,3 @@
-require "cgi"
-
 module Drip
   class Client
     module Purchases
@@ -7,59 +5,18 @@ module Drip
       #
       # 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.
-      #
+      # options  - Required. A Hash of additional order options. Refer to the
+      #                      Drip API docs for the required schema.
       # 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.
+      # See https://developer.drip.com/#orders
       #
-      # 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
+      # DEPRECATED: The beta Purchase endpoint has been deprecated and this method now sends
+      # requests to the Order creation endpoint. Please use `create_or_update_order` instead
+      def create_purchase(email, amount, options = {})
+        warn "[DEPRECATED] `create_purchase` is deprecated. Please use `create_or_update_order` instead."
 
-      # 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}"
+        data = options.merge({ amount: amount, email: email })
+        post "#{account_id}/orders", generate_resource("orders", data)
       end
     end
   end

data/lib/drip/client.rb

@@ -7,6 +7,7 @@ require "drip/client/conversions"
 require "drip/client/custom_fields"
 require "drip/client/events"
 require "drip/client/forms"
+require "drip/client/orders"
 require "drip/client/purchases"
 require "drip/client/subscribers"
 require "drip/client/tags"
@@ -27,6 +28,7 @@ module Drip
     include CustomFields
     include Events
     include Forms
+    include Orders
     include Purchases
     include Subscribers
     include Tags

data/lib/drip/collections/orders.rb

@@ -0,0 +1,13 @@
+require "drip/collection"
+
+module Drip
+  class Orders < Collection
+    def self.collection_name
+      "orders"
+    end
+
+    def self.resource_name
+      "order"
+    end
+  end
+end

data/lib/drip/collections.rb

@@ -3,6 +3,7 @@ require "drip/collections/broadcasts"
 require "drip/collections/campaigns"
 require "drip/collections/campaign_subscriptions"
 require "drip/collections/errors"
+require "drip/collections/orders"
 require "drip/collections/purchases"
 require "drip/collections/subscribers"
 require "drip/collections/tags"
@@ -19,6 +20,7 @@ module Drip
         Drip::Campaigns,
         Drip::CampaignSubscriptions,
         Drip::Errors,
+        Drip::Orders,
         Drip::Purchases,
         Drip::Subscribers,
         Drip::Tags,

data/lib/drip/resources/order.rb

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

data/lib/drip/resources.rb

@@ -3,6 +3,7 @@ require "drip/resources/broadcast"
 require "drip/resources/campaign"
 require "drip/resources/campaign_subscription"
 require "drip/resources/error"
+require "drip/resources/order"
 require "drip/resources/purchase"
 require "drip/resources/subscriber"
 require "drip/resources/tag"
@@ -19,6 +20,7 @@ module Drip
         Drip::Campaign,
         Drip::CampaignSubscription,
         Drip::Error,
+        Drip::Order,
         Drip::Purchase,
         Drip::Subscriber,
         Drip::Tag,

data/lib/drip/version.rb

@@ -1,3 +1,3 @@
 module Drip
-  VERSION = "1.0.0".freeze
+  VERSION = "2.0.0".freeze
 end

data/test/drip/client/orders_test.rb

@@ -0,0 +1,120 @@
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+
+class Drip::Client::OrdersTest < 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_or_update_order" do
+    setup do
+      @email = "drippy@drip.com"
+      @options = {
+        "email": @email,
+        "provider": "shopify",
+        "upstream_id": "abcdef",
+        "amount": 4900,
+        "tax": 100,
+        "fees": 0,
+        "discount": 0,
+        "currency_code": "USD",
+        "properties": {
+          "size": "medium",
+          "color": "red"
+        }
+      }
+      @payload = { "orders" => [@options] }.to_json
+      @response_status = 202
+      @response_body = stub
+
+      @stubs.post "12345/orders", @payload do
+        [@response_status, {}, @response_body]
+      end
+    end
+
+    should "send the correct request" do
+      expected = Drip::Response.new(@response_status, @response_body)
+      assert_equal expected, @client.create_or_update_order(@email, @options)
+    end
+  end
+
+  context "#create_or_update_orders" do
+    setup do
+      @orders = [
+        {
+          "email": "drippy@drip.com",
+          "provider": "shopify",
+          "upstream_id": "abcdef",
+          "amount": 4900,
+          "tax": 100,
+          "fees": 0,
+          "discount": 0,
+          "currency_code": "USD",
+          "properties": {
+            "size": "medium",
+            "color": "red"
+          }
+        },
+        {
+          "email": "dripster@drip.com",
+          "provider": "shopify",
+          "upstream_id": "abcdef",
+          "amount": 1500,
+          "tax": 10,
+          "fees": 0,
+          "discount": 0,
+          "currency_code": "SGD",
+          "properties": {
+            "size": "medium",
+            "color": "black"
+          }
+        }
+      ]
+
+      @payload = { "batches" => [{ "orders" => @orders }] }.to_json
+      @response_status = 202
+      @response_body = stub
+
+      @stubs.post "12345/orders/batches", @payload do
+        [@response_status, {}, @response_body]
+      end
+    end
+
+    should "send the correct request" do
+      expected = Drip::Response.new(@response_status, @response_body)
+      assert_equal expected, @client.create_or_update_orders(@orders)
+    end
+  end
+
+  context "#create_or_update_refund" do
+    setup do
+      @options = {
+        "provider": "shopify",
+        "order_upstream_id": "abcdef",
+        "amount": 4900,
+        "upstream_id": "tuvwx",
+        "note": "Incorrect size",
+        "processed_at": "2013-06-22T10:41:11Z"
+      }
+
+      @payload = { "refunds" => [@options] }.to_json
+      @response_status = 202
+      @response_body = stub
+
+      @stubs.post "12345/refunds", @payload do
+        [@response_status, {}, @response_body]
+      end
+    end
+
+    should "send the correct request" do
+      expected = Drip::Response.new(@response_status, @response_body)
+      assert_equal expected, @client.create_or_update_refund(@options)
+    end
+  end
+end

data/test/drip/client/purchases_test.rb

@@ -15,79 +15,33 @@ class Drip::Client::PurchasesTest < Drip::TestCase
   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
+      @amount = 4900
+      @options = {
+        "email": @email,
+        "provider": "shopify",
+        "upstream_id": "abcdef",
+        "amount": @amount,
+        "tax": 100,
+        "fees": 0,
+        "discount": 0,
+        "currency_code": "USD",
+        "properties": {
+          "size": "medium",
+          "color": "red"
         }
-      ]
-
-      @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
+      }
+      @payload = { "orders" => [@options] }.to_json
+      @response_status = 202
       @response_body = stub
 
-      @stubs.get "12345/subscribers/#{CGI.escape @email}/purchases/#{@id}" do
+      @stubs.post "12345/orders", @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.purchase(@email, @id)
+      assert_equal expected, @client.create_purchase(@email, @amount, @options)
     end
   end
 end

data/test/drip/collections_test.rb

@@ -7,6 +7,7 @@ class Drip::CollectionsTest < Drip::TestCase
     assert_equal Drip::Campaigns, Drip::Collections.find_class("campaigns")
     assert_equal Drip::CampaignSubscriptions, Drip::Collections.find_class("campaign_subscriptions")
     assert_equal Drip::Errors, Drip::Collections.find_class("errors")
+    assert_equal Drip::Orders, Drip::Collections.find_class("orders")
     assert_equal Drip::Purchases, Drip::Collections.find_class("purchases")
     assert_equal Drip::Subscribers, Drip::Collections.find_class("subscribers")
     assert_equal Drip::Tags, Drip::Collections.find_class("tags")

data/test/drip/resources/order_test.rb

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

data/test/drip/resources_test.rb

@@ -6,6 +6,7 @@ class Drip::ResourcesTest < Drip::TestCase
     assert_equal Drip::Campaign, Drip::Resources.find_class("campaign")
     assert_equal Drip::CampaignSubscription, Drip::Resources.find_class("campaign_subscription")
     assert_equal Drip::Error, Drip::Resources.find_class("error")
+    assert_equal Drip::Order, Drip::Resources.find_class("order")
     assert_equal Drip::Purchase, Drip::Resources.find_class("purchase")
     assert_equal Drip::Subscriber, Drip::Resources.find_class("subscriber")
     assert_equal Drip::Tag, Drip::Resources.find_class("tag")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drip-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Derrick Reimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-27 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,6 +134,7 @@ files:
 - lib/drip/client/custom_fields.rb
 - lib/drip/client/events.rb
 - lib/drip/client/forms.rb
+- lib/drip/client/orders.rb
 - lib/drip/client/purchases.rb
 - lib/drip/client/subscribers.rb
 - lib/drip/client/tags.rb
@@ -147,6 +148,7 @@ files:
 - lib/drip/collections/campaign_subscriptions.rb
 - lib/drip/collections/campaigns.rb
 - lib/drip/collections/errors.rb
+- lib/drip/collections/orders.rb
 - lib/drip/collections/purchases.rb
 - lib/drip/collections/subscribers.rb
 - lib/drip/collections/tags.rb
@@ -160,6 +162,7 @@ files:
 - lib/drip/resources/campaign.rb
 - lib/drip/resources/campaign_subscription.rb
 - lib/drip/resources/error.rb
+- lib/drip/resources/order.rb
 - lib/drip/resources/purchase.rb
 - lib/drip/resources/subscriber.rb
 - lib/drip/resources/tag.rb
@@ -176,6 +179,7 @@ files:
 - test/drip/client/custom_fields_test.rb
 - test/drip/client/events_test.rb
 - test/drip/client/forms_test.rb
+- test/drip/client/orders_test.rb
 - test/drip/client/purchases_test.rb
 - test/drip/client/subscribers_test.rb
 - test/drip/client/tags_test.rb
@@ -187,6 +191,7 @@ files:
 - test/drip/collections_test.rb
 - test/drip/resource_test.rb
 - test/drip/resources/account_test.rb
+- test/drip/resources/order_test.rb
 - test/drip/resources/subscriber_test.rb
 - test/drip/resources_test.rb
 - test/drip/response_test.rb
@@ -213,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for interacting with the Drip API
@@ -226,6 +231,7 @@ test_files:
 - test/drip/client/custom_fields_test.rb
 - test/drip/client/events_test.rb
 - test/drip/client/forms_test.rb
+- test/drip/client/orders_test.rb
 - test/drip/client/purchases_test.rb
 - test/drip/client/subscribers_test.rb
 - test/drip/client/tags_test.rb
@@ -237,6 +243,7 @@ test_files:
 - test/drip/collections_test.rb
 - test/drip/resource_test.rb
 - test/drip/resources/account_test.rb
+- test/drip/resources/order_test.rb
 - test/drip/resources/subscriber_test.rb
 - test/drip/resources_test.rb
 - test/drip/response_test.rb