simple_spark 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 676d80d0849c4c6c5afda568f14191eade9233f1
+  data.tar.gz: 4997b6feca164a87ecc49d31919c14c96f91c8d0
+SHA512:
+  metadata.gz: 6ce14c7ad7ef085b1b5b4e3d4f7dba76d80ac5a081175f967a4dbc0efb8fc01e18d4ca366243d9485961ab3a74f46d6a70d2314d7a33c7807893dc575166aa8f
+  data.tar.gz: 982fc09009aceb4fcdafb2938afc5e784d5bb0a38c78806fbebe76619372202cbe8a6a098782f2440f11f289b6718959567297a6b73b633cb4cd91eebc5dcd75

data/.gitignore

@@ -0,0 +1,22 @@
+*.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

data/.rubocop.yml

@@ -0,0 +1,19 @@
+Metrics/LineLength:
+  Max: 250
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be a Fixnum or
+  # a Float.
+  Max: 25
+
+AllCops:
+  Exclude:
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'tmp/**/*'
+    - 'log/**/*'
+    - 'bin/**/*'
+

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - jruby
+  - 2.2.0
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - jakcharlton@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard :rspec, cmd: 'rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Jak Charlton
+
+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,444 @@
+# SimpleSpark
+
+[![Build Status](https://travis-ci.org/leadmachineapp/simple_spark.png?branch=master)](https://travis-ci.org/leadmachineapp/simple_spark)
+
+This gem is an alternative to the [official Ruby gem](https://github.com/SparkPost/ruby-sparkpost) provided by [SparkPost](http://www.sparkpost.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_spark'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install simple_spark
+```
+## Usage
+
+### Why?
+
+The official gem is somewhat lacking in functionality, though with the demise of Mandrill it seems SparkPost may have decided to restart development on it.
+
+But, not being in a mood to wait, and as we would have to write wrappers around all the functions we would need anyway, it seemed much easier to write the wrapper as a gem and allow others to use it too.
+
+The official gem currently only supports the send_message (create) method of /transmissions and it does it with a limited argument set. As it uses method parameters for each of the arguments it supports, it is not possible to use all the functionality the SparkPost API has. This gem will allow passing the parameters as hashes, allowing you to directly copy an API example into code and take full advantage of all the API functions.
+
+### Status
+
+It's day one, and it's a day one project.
+
+
+## Endpoints
+
+### Creating a Client
+
+First you need to ensure you are requiring the library
+
+```ruby
+require 'simple_spark'
+```
+
+The simplest version of the client is to just provide your [API key from SparkPost](https://app.sparkpost.com/account/credentials)
+
+```ruby
+simple_spark = SimpleSpark::Client.new('your_api_key')
+```
+
+You can also use ENV vars to configure the key, setting ENV['SPARKPOST_API_KEY'] will allow you to just use
+
+```ruby
+simple_spark = SimpleSpark::Client.new
+```
+
+You can also override the other options if you need to in advanced scenarios, the full signature is (api_key, api_host, base_path, debug), i.e.
+
+```ruby
+simple_spark = SimpleSpark::Client.new('your_api_key', 'https://api.sparkpost.com',  '/api/v1/', false)
+```
+
+Setting debug to true will cause [Excon](https://github.com/excon/excon) to output full debug information to the log, to default the other values and just set debug, send nil values
+
+This will default to true if you are running under Rails and are in a development environment, otherwise it will default to false (setting other values to nil will cause them to use their defaults)
+
+```ruby
+simple_spark = SimpleSpark::Client.new(nil, nil, nil, true)
+```
+
+### Transmissions
+
+#### List
+
+List all Transmissions
+
+When messages are sent the Transmission will be deleted, so this will only return transmissions that are about to be sent or are scheduled for the future
+
+```ruby
+simple_spark.transmissions.list
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/transmissions/list" target="_blank">see SparkPost API Documentation</a>
+
+#### Create
+
+Create a new Transmission
+
+```ruby
+properties = {
+  options: { open_tracking: true, click_tracking: true },
+  campaign_id: 'christmas_campaign',
+  return_path: 'bounces-christmas-campaign@sp.neekme.com',
+  metadata: {user_type: 'students'},
+  substitution_data: { sender: 'Big Store Team' },
+  recipients:  [
+    { address: { email: 'yourcustomer@theirdomain.com', name: 'Your Customer' },
+      tags: ['greeting', 'sales'],
+      metadata: { place: 'Earth' }, substitution_data: { address: '123 Their Road' } }
+  ],
+  content:
+  { from: { name: 'Your Name', email: 'you@yourdomain.com' },
+    subject: 'I am a test email',
+    reply_to: 'Sales <sales@yourdomain.com>',
+    headers: { 'X-Customer-CampaignID' => 'christmas_campaign' },
+    text: 'Hi from {{sender}} ... this is a test, and here is your address {{address}}',
+    html: '<p>Hi from {{sender}}</p<p>This is a test</p>'
+  }
+}
+
+simple_spark.transmissions.create(properties)
+```
+
+To send attachments, they need to be Base64 encoded
+
+```ruby
+require 'base64'
+
+properties = {
+  recipients:  [{ address: { email: 'yourcustomer@theirdomain.com', name: 'Your Customer' }],
+  content:
+  { from: { name: 'Your Name', email: 'you@yourdomain.com' },
+    subject: 'I am a test email',
+    html: '<p>Hi from {{sender}}</p<p>This is a test</p>',
+    attachments: [{ name: "attachment.txt", type: "text/plain", data: attachment }]
+  }
+}
+
+# load your file contents first, then use Base64 to encode them
+encoded_attachment = Base64.encode64('My file contents')
+properties[:content][:attachments] = [{ name: "attachment.txt", type: "text/plain", data: encoded_attachment }]
+
+simple_spark.transmissions.create(properties)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/transmissions/create" target="_blank">see SparkPost API Documentation</a>
+
+### Messsage Events
+
+#### Samples
+
+List an example of the event data that will be included in a response from the Message Events search endpoint
+
+```ruby
+simple_spark.message_events.samples
+```
+
+To limit to just some events
+
+```ruby
+simple_spark.message_events.samples('bounce')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/message-events/events-samples" target="_blank">see SparkPost API Documentation</a>
+
+#### Search
+
+Perform a filtered search for message event data. The response is sorted by descending timestamp. For full options you should consult the SparkPost API documentation
+
+```ruby
+simple_spark.message_events.search(campaign_ids: 'christmas-campaign, summer-campaign')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/message-events/events-samples" target="_blank">see SparkPost API Documentation</a>
+
+### Webhooks
+
+#### List
+
+List all Webhooks, optionally providing a timezone property
+
+```ruby
+simple_spark.webhooks.list('America/New_York')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/webhooks/list" target="_blank">see SparkPost API Documentation</a>
+
+#### Create
+
+Create a new Webhook
+
+```ruby
+simple_spark.webhooks.create(values)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/webhooks/create" target="_blank">see SparkPost API Documentation</a>
+
+#### Retrieve
+
+Retrieves a Webhook
+
+```ruby
+simple_spark.webhooks.retrieve(webhook_id)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/webhooks/retrieve" target="_blank">see SparkPost API Documentation</a>
+
+#### Update
+
+Updates a Webhook with new values
+
+```ruby
+properties = { "name" => "New name" }
+simple_spark.webhooks.update(webhook_id, properties)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/webhooks/update-and-delete" target="_blank">see SparkPost API Documentation</a>
+
+#### Validate
+
+Validates a Webhook by sending an example message event batch from the Webhooks API to the target URL
+
+```ruby
+simple_spark.webhooks.validate(webhook_id)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/webhooks/validate" target="_blank">see SparkPost API Documentation</a>
+
+#### Batch Status
+
+Retrieve the Batch Status Information for a Webhook
+
+```ruby
+simple_spark.webhooks.batch_status(webhook_id)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/webhooks/batch-status" target="_blank">see SparkPost API Documentation</a>
+
+#### Samples
+
+List an example of the event data that will be sent from a webhook
+
+```ruby
+simple_spark.webhooks.samples
+```
+
+To limit to just some events
+
+```ruby
+simple_spark.webhooks.samples('bounce')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/message-events/events-samples" target="_blank">see SparkPost API Documentation</a>
+
+### Sending Domains
+
+#### List
+
+List all Sending Domains
+
+```ruby
+simple_spark.sending_domains.list
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/sending-domains/create-and-list" target="_blank">see SparkPost API Documentation</a>
+
+#### Create
+
+Create a new Sending Domain
+
+```ruby
+simple_spark.sending_domains.create('mail.mydomain.com')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/sending-domains/create-and-list" target="_blank">see SparkPost API Documentation</a>
+
+#### Retrieve
+
+Retrieves a Sending Template by its domain name
+
+```ruby
+simple_spark.sending_domains.retrieve('mail.mydomain.com')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/sending-domains/retrieve-update-and-delete" target="_blank">see SparkPost API Documentation</a>
+
+#### Update
+
+Updates a Sending Domain with new values
+
+```ruby
+properties = { "tracking_domain" => "new.tracking.domain" }
+simple_spark.sending_domains.update('mail.mydomain.com', properties)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/sending-domains/retrieve-update-and-delete" target="_blank">see SparkPost API Documentation</a>
+
+#### Verify
+
+Forces verification of a Sending Domain.
+
+Including the fields "dkim_verify" and/or "spf_verify" in the request initiates a check against the associated DNS record
+type for the specified sending domain.Including the fields "postmaster_at_verify" and/or "abuse_at_verify" in the request
+results in an email sent to the specified sending domain's postmaster@ and/or abuse@ mailbox where a verification link can
+be clicked. Including the fields "postmaster_at_token" and/or "abuse_at_token" in the request initiates a check of the provided
+token(s) against the stored token(s) for the specified sending domain.
+
+```ruby
+properties = { "dkim_verify": true, "spf_verify": true }
+simple_spark.sending_domains.retrieve('mail.mydomain.com', properties)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/sending-domains/verify" target="_blank">see SparkPost API Documentation</a>
+
+#### Delete
+
+Deletes a Sending Domain permanently
+
+```ruby
+simple_spark.sending_domains.delete('mail.mydomain.com')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/sending-domains/retrieve-update-and-delete" target="_blank">see SparkPost API Documentation</a>
+
+### Inbound Domains
+
+#### List
+
+List all Inbound Domains
+
+```ruby
+simple_spark.inbound_domains.list
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/inbound-domains/create-and-list" target="_blank">see SparkPost API Documentation</a>
+
+#### Create
+
+Create a new Inbound Domain
+
+```ruby
+simple_spark.inbound_domains.create('mail.mydomain.com')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/inbound-domains/create-and-list" target="_blank">see SparkPost API Documentation</a>
+
+#### Retrieve
+
+Retrieves an Inbound Template by its domain name
+
+```ruby
+simple_spark.inbound_domains.retrieve('mail.mydomain.com')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/inbound-domains/retrieve-and-delete" target="_blank">see SparkPost API Documentation</a>
+
+#### Delete
+
+Deletes an Inbound Domain permanently
+
+```ruby
+simple_spark.inbound_domains.delete('mail.mydomain.com')
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/inbound-domains/retrieve-and-delete" target="_blank">see SparkPost API Documentation</a>
+
+### Templates
+
+#### List
+
+List all templates
+
+```ruby
+simple_spark.templates.list
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/templates/create-and-list" target="_blank">see SparkPost API Documentation</a>
+
+#### Create
+
+Create a new Template
+
+```ruby
+properties = { "name" => "Summer Sale!",
+               "content"=> { "from" => "marketing@yourdomain.com",
+                             "subject"=> "Summer deals",
+                             "html"=> "<b>Check out these deals!</b>"
+                           }
+             }
+simple_spark.templates.create(properties)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/templates/create-and-list" target="_blank">see SparkPost API Documentation</a>
+
+#### Retrieve
+
+Retrieves a Template by its ID
+
+```ruby
+draft = nil
+simple_spark.templates.retrieve(yourtemplateid, draft)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/templates/retrieve" target="_blank">see SparkPost API Documentation</a>
+
+#### Update
+
+Updates a Template with new values
+
+```ruby
+properties = { "name" => "Sorry, the Winter Sale!" }}
+update_published = false
+simple_spark.templates.update(yourtemplateid, properties, update_published)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/templates/update" target="_blank">see SparkPost API Documentation</a>
+
+#### Preview
+
+Merges the template with the Substitution data and returns the result
+
+```ruby
+properties = { substitution_data: { name: 'Mr test User' } }
+draft = nil
+simple_spark.templates.preview(yourtemplateid, properties, draft)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/templates/preview" target="_blank">see SparkPost API Documentation</a>
+
+#### Delete
+
+Deletes a template permanently
+
+```ruby
+simple_spark.templates.delete(yourtemplateid)
+```
+
+<a href="https://developers.sparkpost.com/api/#/reference/templates/delete" target="_blank">see SparkPost API Documentation</a>
+
+## Contributing
+
+Not right now, but in time ...
+
+1. Fork it ( https://github.com/leadmachineapp/simple_spark/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,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'progress']
+end
+
+task :default => :spec

data/lib/simple_spark/client.rb

@@ -0,0 +1,82 @@
+require 'rubygems'
+require 'excon'
+require 'json'
+
+module SimpleSpark
+  class Client
+    def initialize(api_key = nil, api_host = 'https://api.sparkpost.com', base_path = '/api/v1/', debug = nil)
+      @api_key = api_key || ENV['SPARKPOST_API_KEY']
+      @api_host = api_host || 'https://api.sparkpost.com'
+      @base_path = base_path || '/api/v1/'
+
+      fail Exceptions::InvalidConfiguration.new, 'You must provide a SparkPost API key' unless @api_key
+      fail Exceptions::InvalidConfiguration.new, 'You must provide a SparkPost API host' unless @api_host # this should never occur unless the default above is changed
+      fail Exceptions::InvalidConfiguration.new, 'You must provide a SparkPost base path' unless @base_path # this should never occur unless the default above is changed
+
+      rails_development = !(defined?(Rails) && Rails.env.development?).nil?
+
+      @debug = debug.nil? ? rails_development : debug
+      @session = Excon.new(@api_host, debug: @debug)
+    end
+
+    def call(method, path, body_values = {}, query_params = {})
+      fail Exceptions::InvalidConfiguration.new({ method: method }), 'Only GET, POST, PUT and DELETE are supported' unless [:get, :post, :put, :delete].include?(method)
+
+      path = "#{@base_path}#{path}"
+      params = { path: path, headers: default_headers }
+      params[:body] = body_values.to_json unless body_values.empty?
+      params[:query] = query_params unless query_params.empty?
+      response = @session.send(method.to_s, params)
+
+      process_response(response)
+    end
+
+    def process_response(response)
+      return true if response.status == 204
+
+      response_body = JSON.parse(response.body)
+      if response_body['errors']
+        Exceptions::Error.fail_with_exception_for_status(response.status, response_body['errors'])
+      else
+        response_body['results'] ? response_body['results'] : true
+      end
+    end
+
+    # Copied from http://apidock.com/ruby/ERB/Util/url_encode
+    def url_encode(s)
+      s.to_s.dup.force_encoding("ASCII-8BIT").gsub(/[^a-zA-Z0-9_\-.]/) { sprintf("%%%02X", $&.unpack("C")[0]) }
+    end
+
+    def default_headers
+      {
+        'User-Agent' => 'simple_spark/' + VERSION,
+        'Content-Type' => 'application/json',
+        'Authorization' => @api_key
+      }
+    end
+
+    def inbound_domains
+      Endpoints::InboundDomains.new(self)
+    end
+
+    def sending_domains
+      Endpoints::SendingDomains.new(self)
+    end
+
+    def templates
+      Endpoints::Templates.new(self)
+    end
+
+    def transmissions
+      Endpoints::Transmissions.new(self)
+    end
+
+    def message_events
+      Endpoints::MessageEvents.new(self)
+    end
+
+    def webhooks
+      Endpoints::Webhooks.new(self)
+    end
+  end
+end

data/lib/simple_spark/endpoints/inbound_domains.rb

@@ -0,0 +1,44 @@
+module SimpleSpark
+  module Endpoints
+    # Provides access to the /inbound-domains endpoint
+    # See: https://developers.sparkpost.com/api/#/reference/inbound-domains
+    class InboundDomains
+      attr_accessor :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      # Lists your inbound domains
+      # @return [Array] a list of Inbound Domain hash objects
+      # @note See: https://developers.sparkpost.com/api/#/reference/inbound-domains/create-and-list
+      def list
+        @client.call(:get, 'inbound-domains')
+      end
+
+      # Create an inbound domain
+      # @param domain_name [String] the domain name to create
+      # @note See: https://developers.sparkpost.com/api/#/reference/inbound-domains/create-and-list
+      def create(domain_name)
+        @client.call(:post, 'inbound-domains', domain: domain_name)
+      end
+
+      # Retrieve an inbound domain
+      # @param domain_name [String] the domain name to retrieve
+      # @return [Hash] an Inbound Domain hash object
+      # @note See: https://developers.sparkpost.com/api/#/reference/inbound-domains/retrieve-and-delete
+      def retrieve(domain_name)
+        domain_name = @client.url_encode(domain_name)
+        @client.call(:get, "inbound-domains/#{domain_name}")
+      end
+
+      # Delete an inbound domain
+      # @param domain_name [String] the domain name to delete
+      # @note See: https://developers.sparkpost.com/api/#/reference/inbound-domains/retrieve-and-delete
+      def delete(domain_name)
+        domain_name = @client.url_encode(domain_name)
+        @client.call(:delete, "inbound-domains/#{domain_name}")
+      end
+    end
+  end
+end