drip-ruby 0.0.12 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7bfa63019608f669aab60be61b9771d95ab1666
-  data.tar.gz: a7708994dd22d0eea312cd3287ec632ea1e91a03
+  metadata.gz: 5aafc1c74dbc6f3b1394f304f7d1b9ceb3fe829d
+  data.tar.gz: 9a83f650a30e9c127c1a594fcbbd6964af009966
 SHA512:
-  metadata.gz: 02f2eaf930c8fe3ab029429b53ea4c2673677ab99b348a3a448d3e5670d1f0a69285c7b1c7b8fdf25fe4cae0d8c35fdc7fbe73bf22000e3c8dfd047f8f48a678
-  data.tar.gz: c50c9f97d8fd803084222660d162d0a559d26962632d99d5fa783a4d8c7b0907b82dc911600978c2702ca32025659fb7b469ed83daf5327e0e9d9eee308c7f9e
+  metadata.gz: 0a36ee1b8ac89b1fb63663e49d383acc3a3d15ff22e6bccf3afe5a5ab6cf17d4c76b5ae5369fe8a44383317d1db63fbda43432e1ad9c41c37ad3569bd9377a58
+  data.tar.gz: 64d97aea9e8937326694c91e34abbd8825890dc31476e0efc22403fef440b9569edf4a5b0ddd3b211e32a3e859290aaa4269acd29698c4d8da380cea578c0ffd

data/.rubocop.yml

@@ -0,0 +1,17 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'test/fixtures/**/*'
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Style/BracesAroundHashParameters:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,134 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-12-22 12:38:29 -0600 using RuboCop version 0.49.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles, IndentationWidth.
+# SupportedStyles: outdent, indent
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/ElseAlignment:
+  Exclude:
+    - 'lib/drip/response.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterMagicComment:
+  Exclude:
+    - 'drip-ruby.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles, IndentationWidth.
+# SupportedStyles: special_inside_parentheses, consistent, align_braces
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Width, IgnoredPatterns.
+Layout/IndentationWidth:
+  Exclude:
+    - 'lib/drip/response.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
+# SupportedStyles: aligned, indented, indented_relative_to_receiver
+Layout/MultilineMethodCallIndentation:
+  Exclude:
+    - 'lib/drip/collection.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleAlignWith, SupportedStylesAlignWith, AutoCorrect.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Lint/EndAlignment:
+  Exclude:
+    - 'lib/drip/response.rb'
+
+# Offense count: 1
+Lint/ScriptPermission:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'lib/drip/response.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/drip/client.rb'
+    - 'lib/drip/collection.rb'
+
+# Offense count: 7
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 48
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 189
+
+# Offense count: 78
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 108
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 16
+
+# Offense count: 22
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 42
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 2
+Style/MethodMissing:
+  Exclude:
+    - 'lib/drip/resource.rb'
+    - 'lib/drip/response.rb'
+
+# Offense count: 9
+# Cop supports --auto-correct.
+# Configuration parameters: Strict.
+Style/NumericLiterals:
+  MinDigits: 8
+
+# Offense count: 494
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiteralsInInterpolation:
+  Exclude:
+    - 'test/drip/client_test.rb'

data/README.md

@@ -4,7 +4,7 @@ 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)
-
+[![Gem Version](https://badge.fury.io/rb/drip-ruby.svg)](https://badge.fury.io/rb/drip-ruby)
 
 
 ## Installation
@@ -61,30 +61,124 @@ the "list accounts" endpoint.
 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                                               |
+#### Accounts
+
+| Actions                    | Methods                                              |
 | :------------------------- | :--------------------------------------------------- |
 | List accounts              | `#accounts`                                          |
+| Fetch an account           | `#account(id)`                                       |
+
+#### Broadcasts
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
+| List broadcasts            | `#broadcasts`                                        |
+| Fetch a broadcast          | `#broadcast(id)`                                     |
+
+#### Campaigns
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
+| List campaigns             | `#campaigns(options = {})`                           |
+| Fetch a campaign           | `#campaign(id)`                                      |
+| Activate a campaign        | `#activate_campaign(id)`                             |
+| Pause a campaign           | `#pause_campaign(id)`                                |
+| List campaign subscribers  | `#campaign_subscribers(id)`                          |
+| Subscribe to a campaign    | See the `#subscribe` method on "Subscribers" below   |
+
+#### Campaign Subscriptions
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
+| List subscriber subscriptions | `#campaign_subscriptions(subscriber_id)`          |
+
+#### Conversions
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
+| List all conversions       | `#conversions(options = {})`                         |
+| Fetch a conversion         | `#conversion(id)`                                    |
+
+#### Custom Fields
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
+| List all custom fields     | `#custom_fields`                                     |
+
+#### Events
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
+| Track an event             | `#track_event(email, action, properties = {})`       |
+| Track a batch of events    | `#track_events(events)`                              |
+| List all custom event actions | `#event_actions`                                  |
+
+#### Forms
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
+| List all forms            | `#forms`                                              |
+| Fetch a form              | `#form(id)`                                           |
+
+#### Purchases
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
+| List purchases for a subscriber | `#purchases(email)`                             |
+| Create a purchase          | `#create_purchase(email, amount, options = {})`      |
+| Fetch a purchase           | `#purchase(email, id)`                               |
+
+#### Subscribers
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
 | List subscribers           | `#subscribers(options = {})`                         |
 | Create/update a subscriber | `#create_or_update_subscriber(email, options = {})`  |
 | Create/update a batch of subscribers | `#create_or_update_subscribers(subscribers)` |
+| Unsubscribe a batch of subscribers | `#unsubscribe_subscribers(subscribers)`      |
 | Fetch a subscriber         | `#subscriber(id_or_email)`                           |
+| Delete                     | `#delete_subscriber(id_or_email)`                    |
 | Subscribe to a campaign    | `#subscribe(email, campaign_id, options = {})`       |
+| Unsubscribe from all mailings | `#unsubscribe_from_all(id_or_email)`              |
 | Unsubscribe                | `#unsubscribe(id_or_email, options = {})`            |
-| Delete                     | `#delete_subscriber(id_or_email)`                    |
+
+#### Tags
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
 | 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
-pull request. [See the official REST API docs](https://www.getdrip.com/docs/rest-api)
-for a complete API reference.
+#### Webhooks
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
+| List webhooks              | `#webhooks`                                          |
+| Fetch a webhook            | `#webhook(id)`                                       |
+| Create a new webhook       | `#create_webhook(post_url, include_received_email, events)` |
+| Delete a webhook           | `#delete_webhook(id)`                                |
+
+#### Workflows
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
+| List workflows             | `#workflows`                                         |
+| Fetch a workflow           | `#workflow(id)`                                      |
+| Activate a workflow        | `#activate_workflow(id)`                             |
+| Pause a workflow           | `#pause_workflow(id)`                                |
+| Start a subscriber on a workflow | `#start_subscriber_workflow(id, options = {})` |
+| Remove a subscriber from a workflow | `#remove_subscriber_workflow(workflow_id, id_or_email)` |
+
+#### Workflow Triggers
+
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
+| List workflow triggers     | `#workflow_triggers(id)`                             |
+| Create a workflow trigger  | `#create_workflow_trigger(id, options = {})`         |
+| Update a workflow trigger  | `#update_workflow_trigger(id, options = {}`          |
+
+[See the official REST API docs](https://www.getdrip.com/docs/rest-api) for a complete API reference and explanations.
 
 ## Use Cases
 

data/Rakefile

@@ -9,4 +9,4 @@ Rake::TestTask.new do |t|
 end
 
 desc "Run tests"
-task :default => :test
+task default: :test

data/drip-ruby.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   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.summary       = 'A Ruby gem for interacting with the Drip API'
+  spec.description   = 'A simple wrapper for the Drip API'
   spec.homepage      = "http://github.com/DripEmail/drip-ruby"
   spec.license       = "MIT"
 

data/lib/drip/client.rb

@@ -1,10 +1,18 @@
 require "drip/response"
 require "drip/client/accounts"
-require "drip/client/subscribers"
-require "drip/client/tags"
-require "drip/client/events"
+require "drip/client/broadcasts"
 require "drip/client/campaigns"
+require "drip/client/campaign_subscriptions"
+require "drip/client/conversions"
+require "drip/client/custom_fields"
+require "drip/client/events"
+require "drip/client/forms"
 require "drip/client/purchases"
+require "drip/client/subscribers"
+require "drip/client/tags"
+require "drip/client/webhooks"
+require "drip/client/workflows"
+require "drip/client/workflow_triggers"
 require "faraday"
 require "faraday_middleware"
 require "json"
@@ -12,11 +20,19 @@ require "json"
 module Drip
   class Client
     include Accounts
-    include Subscribers
-    include Tags
-    include Events
+    include Broadcasts
     include Campaigns
+    include CampaignSubscriptions
+    include Conversions
+    include CustomFields
+    include Events
+    include Forms
     include Purchases
+    include Subscribers
+    include Tags
+    include Webhooks
+    include Workflows
+    include WorkflowTriggers
 
     attr_accessor :access_token, :api_key, :account_id
 
@@ -83,7 +99,7 @@ module Drip
           f.basic_auth api_key, ""
         end
 
-        f.response :json, :content_type => /\bjson$/
+        f.response :json, content_type: /\bjson$/
         f.adapter :net_http
       end
     end

data/lib/drip/client/accounts.rb

@@ -8,6 +8,16 @@ module Drip
       def accounts
         get "accounts"
       end
+
+      # Public: Fetch an account.
+      #
+      # id - Required. The String id of the account.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#accounts
+      def account(id)
+        get "accounts/#{id}"
+      end
     end
   end
 end

data/lib/drip/client/broadcasts.rb

@@ -0,0 +1,29 @@
+module Drip
+  class Client
+    module Broadcasts
+      # Public: Fetch all broadcasts to which the authenticated user has access
+      #
+      # options - A Hash of options.
+      #           - status - Optional. Filter by one of the following statuses:
+      #                      draft, or scheduled, or sent. Defaults to all.
+      #           - sort   - Optional. Sort results by one of these fields:
+      #                      `send_at`, `name`. Default sorting is `created_at`
+      #
+      # Returns a Drip::Response
+      # See https://www.getdrip.com/docs/rest-api#broadcasts
+      def broadcasts(options = {})
+        get "#{account_id}/broadcasts", options
+      end
+
+      # Public: Fetch a broadcast.
+      #
+      # id - Required. The String id of the broadcast.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#broadcasts
+      def broadcast(id)
+        get "#{account_id}/broadcasts/#{id}"
+      end
+    end
+  end
+end

data/lib/drip/client/campaign_subscriptions.rb

@@ -0,0 +1,15 @@
+module Drip
+  class Client
+    module CampaignSubscriptions
+      # Public: List all of a subscriber's campaign subscriptions
+      #
+      # subscriber_id - Required. The String subscriber id of the subscriber
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs.rest-api#campaign_subscriptions
+      def campaign_subscriptions(subscriber_id)
+        get "#{account_id}/subscribers/#{subscriber_id}/campaign_subscriptions"
+      end
+    end
+  end
+end