sparkpost 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc6408b4b46931661f45f43c8b1f37e0492ea4ba
-  data.tar.gz: 8836156574c1979033b5b3638c3ec348c3519608
+  metadata.gz: 796669253fea19aa5100d4947812dcd522c5b740
+  data.tar.gz: 1ef22cf099b5f094ff1d4fe947f45e27bd3c6ae8
 SHA512:
-  metadata.gz: ebdcdd2123e18efc025c971ca8333bda26c691bed4d27f1cb8ec2c2d6db55cc0413efaa54543747a7e15316da343e41c5af83550d51878ef561d4312976089c9
-  data.tar.gz: 59b664eb000246a06381800f952d0d16a674f670ed1e93f539aef52ec319035e9c9d1dd30be86486552ca9c32725b8ae2b5cf2e799344bf84751f584e278b52d
+  metadata.gz: 3d8ebe367055686b7d287464754e8b868b9c25d228f8e96ccb3ff9ddafcf13be99555994badb816a63fc15a47fd7a7377d180c3083445473f9cf45863b8483a7
+  data.tar.gz: 6e5a7ff2c7532b778c5e87534a5d15d0e73bee8c53ed9bd452b2e3834e4730c0f8d74f5c18d0a13942b1094d7448a460d003bab998da0ec3b682f9efd78f22c5

data/.gitignore

@@ -19,3 +19,5 @@ tmp
 .idea
 .ruby-gemset
 coverage
+_examples
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Style/FirstParameterIndentation:
+    Enabled: false
+Documentation:
+    Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Exclude:
+    - spec/**/*
+AllCops:
+  Exclude:
+    - _examples/**/*

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 2.0.0
   - 2.1.2
   - 2.2.4
+  - 2.3.0
 notifications:
   slack:
     secure: VNIwgvrbcwj0b2gfYSOeTyK7rkV62/belwhYthasHmN+DoTsEJF4+HFVtzOykS72LM/f5Id5zieWtxYG+soy+yEOc1iZizXRpRJORtTYfZJB9RCffavosl322BcpoTX99cGyiZjWjOFH70UWlFMB3zT0jS+9icuTfk7ZqBX/zDA=

data/README.md

@@ -4,9 +4,9 @@
 
 # SparkPost Ruby API Client
 
-[![Travis CI](https://travis-ci.org/SparkPost/ruby-sparkpost.svg?branch=master)](https://travis-ci.org/SparkPost/ruby-sparkpost) [![Coverage Status](https://coveralls.io/repos/SparkPost/ruby-sparkpost/badge.svg?branch=master&service=github)](https://coveralls.io/github/SparkPost/ruby-sparkpost?branch=master)
+[![Travis CI](https://travis-ci.org/SparkPost/ruby-sparkpost.svg?branch=master)](https://travis-ci.org/SparkPost/ruby-sparkpost) [![Coverage Status](https://coveralls.io/repos/SparkPost/ruby-sparkpost/badge.svg?branch=master&service=github)](https://coveralls.io/github/SparkPost/ruby-sparkpost?branch=master) [![Slack Status](http://slack.sparkpost.com/badge.svg)](http://slack.sparkpost.com)
 
-The official Ruby client library for Sparkpost
+The official Ruby client library for SparkPost
 
 ## Installation
 
@@ -22,9 +22,59 @@ Or install it yourself as:
 
     $ gem install sparkpost
 
+**Important: Implementations may change frequently until we reach v1.0.0**
+
 ## Usage
 
-Check [examples/transmission.rb](examples/transmission.rb)
+**Send an email**
+
+```ruby
+require 'sparkpost'
+
+sp = SparkPost::Client.new() # api key was set in ENV through ENV['SPARKPOST_API_KEY']
+response = sp.transmission.send_message('RECIPIENT_EMAIL', 'SENDER_EMAIL', 'test email', '<h1>HTML message</h1>')
+puts response
+
+# {"total_rejected_recipients"=>0, "total_accepted_recipients"=>1, "id"=>"123456789123456789"}
+```
+
+**Send email with substitution data**
+
+```ruby
+require 'sparkpost'
+
+values = { substitution_data: { name: 'Sparky'}}
+sp = SparkPost::Client.new() # pass api key or get api key from ENV
+response = sp.transmission.send_message('RECIPIENT_EMAIL', 'SENDER_EMAIL', 'testemail', '<h1>HTML message from {{name}}</h1>', values)
+puts response
+
+# {"total_rejected_recipients"=>0, "total_accepted_recipients"=>1, "id"=>"123456789123456789"}
+```
+
+**Send email with attachment**
+
+*You need to base64 encode of your attachment contents.*
+
+```ruby
+require 'sparkpost'
+
+# assuming there is a file named attachment.txt in the same directory
+attachment = Base64.encode64(File.open(File.expand_path('../attachment.txt', __FILE__), 'r') { |f| f.read })
+
+# prepare attachment data to pass to send_message method
+values = {
+    attachments: [{
+        name: 'attachment.txt',
+        type: 'text/plain',
+        data: attachment
+    }]
+}
+
+sp = SparkPost::Client.new() # pass api key or get api key from ENV
+sp.transmission.send_message('RECIPIENT_EMAIL', 'SENDER_EMAIL', 'testemail', '<h1>Email with an attachment</h1>', values)
+```
+
+See: [examples](examples)
 
 ## Development
 

data/Rakefile

@@ -1,7 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task :default => :spec
-
+task default: [:rubocop, :spec]

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "sparkpost"
+require 'bundler/setup'
+require 'sparkpost'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "sparkpost"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/examples/template/list.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative '../../lib/sparkpost'
+
+sp = SparkPost::Client.new # api key was set in ENV
+templates = sp.template.list
+
+puts templates

data/examples/transmission/attachment.txt

@@ -0,0 +1 @@
+This attachment contains just this!

data/examples/transmission/send.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require_relative '../../lib/sparkpost'
+
+sp = SparkPost::Client.new # api key was set in ENV
+response = sp.transmission.send_message(
+    'RECIPIENT_EMAIL',
+    'SENDER_EMAIL',
+    'test email',
+    '<h1>HTML message</h1>')
+
+puts response

data/examples/transmission/with_attachment.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require 'base64'
+require_relative '../../lib/sparkpost'
+
+# read file and base64 encoding
+attachment = Base64.encode64(
+        File.open(File.expand_path('../attachment.txt', __FILE__), 'r', &:read))
+
+# prepare attachment data to pass to send_message method
+options = {
+  attachments: [{
+    name: 'Sparky.txt',
+    type: 'text/plain',
+    data: attachment
+  }]
+}
+
+sp = SparkPost::Client.new # pass api key or get api key from ENV
+
+# send message with attachment
+response = sp.transmission.send_message(
+    'RECIPIENT_EMAIL',
+    'SENDER_EMAIL',
+    'test email',
+    '<h1>Message with attachment</h1>',
+    options)
+
+puts response

data/examples/transmission/with_substitution.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require_relative '../../lib/sparkpost'
+
+values = { substitution_data: { name: 'Sparky' } }
+sp = SparkPost::Client.new # pass api key or get api key from ENV
+response = sp.transmission.send_message(
+    'RECIPIENT_EMAIL',
+    'SENDER_EMAIL',
+    'test email',
+    '<h1>HTML message from {{name}}</h1>',
+    values)
+
+puts response

data/examples/transmission/with_template.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require_relative '../../lib/sparkpost'
+
+# prepare the payload as required by SparkPost API endpoint
+payload = {
+  recipients: [{ address: { email: 'RECIPIENT_EMAIL' } }],
+  content: {
+    from: 'SENDER_EMAIL',
+    subject: 'test email',
+    template_id: 'YOUR_TEMPLATE_ID'
+  }
+}
+
+sp = SparkPost::Client.new # api key was set in ENV
+response = sp.transmission.send_payload(payload)
+
+puts response

data/lib/sparkpost.rb

@@ -1,3 +1,4 @@
 require_relative 'sparkpost/version'
 require_relative 'sparkpost/transmission'
-require_relative 'sparkpost/client'
+require_relative 'sparkpost/client'
+require_relative 'sparkpost/template'

data/lib/sparkpost/client.rb

@@ -1,23 +1,26 @@
 module SparkPost
-    class Client
-        attr_reader :transmission
-        
-        def initialize(api_key = nil, api_host = 'https://api.sparkpost.com')
-            @api_key = (api_key || ENV['SPARKPOST_API_KEY']).to_s
-            @api_host = (api_host || ENV['SPARKPOST_API_HOST']).to_s
+  class Client
+    attr_reader :transmission
+    attr_reader :template
+    def initialize(api_key = nil, api_host = 'https://api.sparkpost.com')
+      @api_key = (api_key || ENV['SPARKPOST_API_KEY']).to_s
+      @api_host = (api_host || ENV['SPARKPOST_API_HOST']).to_s
 
-            if @api_key.blank?
-                fail ArgumentError, 'No API key is provided. Either provide api_key with constructor or set SPARKPOST_API_KEY environment variable'
-            end
+      raise ArgumentError, 'No API key is provided. Either provide
+       api_key with constructor or set SPARKPOST_API_KEY environment
+        variable' if @api_key.blank?
 
+      raise ArgumentError, 'No API host is provided. Either provide
+       api_host with constructor or set SPARKPOST_API_HOST environment
+        variable' if @api_host.blank?
+    end
 
-            if @api_host.blank?
-                fail ArgumentError, 'No API host is provided. Either provide api_host with constructor or set SPARKPOST_API_HOST environment variable'
-            end
-        end
+    def transmission
+      @transmission ||= Transmission.new(@api_key, @api_host)
+    end
 
-        def transmission
-            @transmission ||= Transmission.new(@api_key, @api_host)
-        end
+    def template
+      @template ||= Template.new(@api_key, @api_host)
     end
-end
+  end
+end

data/lib/sparkpost/helpers.rb

@@ -0,0 +1,23 @@
+require_relative '../core_extensions/object'
+
+module SparkPost
+  module Helpers
+    def copy_value(src_hash, src_key, dst_hash, dst_key)
+      dst_hash[dst_key] = src_hash[src_key] if src_hash.key?(src_key)
+    end
+
+    def deep_merge(source_hash, other_hash)
+      source_hash.merge(other_hash) do |_key, oldval, newval|
+        if newval.respond_to?(:blank?) && newval.blank?
+          oldval
+        elsif oldval.is_a?(Hash) && newval.is_a?(Hash)
+          deep_merge(oldval, newval)
+        else
+          newval
+        end
+      end
+    end
+
+    module_function :copy_value, :deep_merge
+  end
+end

data/lib/sparkpost/request.rb

@@ -6,31 +6,63 @@ require_relative 'exceptions'
 
 module SparkPost
   module Request
-
-    def request(url, api_key, data)
+    def request(url, api_key, data, verb = 'POST')
       uri = URI.parse(url)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
+      http = configure_http(uri)
       headers = {
-          'User-Agent' => 'ruby-sparkpost/' + VERSION,
-          'Content-Type' => 'application/json',
-          'Authorization' => api_key
+        'User-Agent' => 'ruby-sparkpost/' + VERSION,
+        'Content-Type' => 'application/json',
+        'Authorization' => api_key
       }
-      req = Net::HTTP::Post.new(uri.path, initheader=headers)
-      req.body = data.to_json
+      req = configure_request(uri, headers, data, verb)
+      process_response(http.request(req))
+    end
+
+    def endpoint(subpath = nil, params = {})
+      url = String.new(@base_endpoint)
+      if subpath
+        url << '/' unless subpath.start_with?('/')
+        url << subpath
+      end
+      if params && params.any?
+        url << '?'
+        url << params.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join('&')
+      end
+      url
+    end
 
-      process_response(http.request(req));
+    def configure_http(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http
+    end
+
+    def configure_request(uri, headers, data, verb)
+      req = case verb
+            when 'GET'
+              Net::HTTP::Get.new(uri.path, headers)
+            when 'PUT'
+              Net::HTTP::Put.new(uri.path, headers)
+            when 'DELETE'
+              Net::HTTP::Delete.new(uri.path, headers)
+            else
+              Net::HTTP::Post.new(uri.path, headers)
+            end
+
+      req.body = JSON.generate(data) if data.present?
+      req
     end
 
     def process_response(response)
       response = JSON.parse(response.body)
       if response['errors']
-        fail SparkPost::DeliveryException, response['errors']
+        raise SparkPost::DeliveryException, response['errors']
       else
         response['results']
       end
-    end    
+    end
 
-    module_function :request, :process_response
+    module_function :request, :configure_http, :configure_request,
+                    :process_response
   end
 end

data/lib/sparkpost/template.rb

@@ -0,0 +1,112 @@
+require 'net/http'
+require 'uri'
+require_relative 'request'
+require_relative 'helpers'
+require_relative 'exceptions'
+
+module SparkPost
+  class Template
+    include Request
+    include Helpers
+
+    def initialize(api_key, api_host)
+      @api_key = api_key
+      @api_host = api_host
+      @base_endpoint = "#{@api_host}/api/v1/templates"
+    end
+
+    def create(id, from = nil, subject = nil, html = nil, **options)
+      data = deep_merge(
+        payload_from_args(id, from, subject, html),
+        payload_from_options(options)
+      )
+      request(endpoint, @api_key, data, 'POST')
+    end
+
+    def update(id, from = nil, subject = nil, html = nil, **options)
+      params = {}
+      copy_value(options, :update_published, params, :update_published)
+      data = deep_merge(
+        payload_from_args(nil, from, subject, html),
+        payload_from_options(options)
+      )
+      request(endpoint(id, params), @api_key, data, 'PUT')
+    end
+
+    def delete(id)
+      request(endpoint(id), @api_key, nil, 'DELETE')
+    end
+
+    def get(id, draft = nil)
+      params = {}
+      params[:draft] = draft unless draft.nil?
+      request(endpoint(id, params), @api_key, nil, 'GET')
+    end
+
+    def list
+      request(endpoint, @api_key, nil, 'GET')
+    end
+
+    def preview(id, substitution_data, draft = nil)
+      params = {}
+      params[:draft] = draft unless draft.nil?
+      request(
+        endpoint("#{id}/preview", params),
+        @api_key,
+        { substitution_data: substitution_data },
+        'POST'
+      )
+    end
+
+    private
+
+    def payload_from_args(id, from, subject, html)
+      model = { content: {}, options: {} }
+
+      model[:id] = id unless id.nil?
+      model[:content][:from] = from unless from.nil?
+      model[:content][:subject] = subject unless subject.nil?
+      model[:content][:html] = html unless html.nil?
+
+      model
+    end
+
+    def payload_from_options(**options)
+      model = { content: { from: {} }, options: {} }
+
+      # Mapping optional arguments to root
+      [
+        [:name, :name],
+        [:id, :id],
+        [:description, :description],
+        [:published, :published]
+      ].each { |skey, dkey| copy_value(options, skey, model, dkey) }
+
+      # Mapping optional arguments to options
+      [
+        [:track_opens, :open_tracking],
+        [:track_clicks, :click_tracking],
+        [:is_transactional, :transactional]
+      ].each { |skey, dkey| copy_value(options, skey, model[:options], dkey) }
+
+      # Mapping optional arguments to content
+      [
+        [:html, :html],
+        [:text, :text],
+        [:subject, :subject],
+        [:reply_to, :reply_to],
+        [:custom_headers, :headers]
+      ].each { |skey, dkey| copy_value(options, skey, model[:content], dkey) }
+
+      # Mapping optional arguments to sender information
+      [
+        [:from_email, :email],
+        [:from_name, :name]
+      ].each do |skey, dkey|
+        copy_value(options, skey, model[:content][:from], dkey)
+      end
+
+      model
+    end
+  end
+end