mailgun-ruby 1.0.3 → 1.1.0

data/lib/mailgun/response.rb

@@ -0,0 +1,55 @@
+module Mailgun
+  # A Mailgun::Response object is instantiated for each response generated
+  # by the Client request. The Response object supports deserialization of
+  # the JSON result. Or, if you prefer JSON or YAML formatting, call the
+  # method for conversion.
+  #
+  # See the Github documentation for full examples.
+  class Response
+    # All responses have a payload and a code corresponding to http, though
+    #   slightly different
+    attr_accessor :body, :code
+
+    def initialize(response)
+      @body = response.body
+      @code = response.code
+    end
+
+    # Return response as Ruby Hash
+    #
+    # @return [Hash] A standard Ruby Hash containing the HTTP result.
+
+    def to_h
+      JSON.parse(@body)
+    rescue => err
+      raise ParseError.new(err), err
+    end
+
+    # Replace @body with Ruby Hash
+    #
+    # @return [Hash] A standard Ruby Hash containing the HTTP result.
+    def to_h!
+      @body = JSON.parse(@body)
+    rescue => err
+      raise ParseError.new(err), err
+    end
+
+    # Return response as Yaml
+    #
+    # @return [String] A string containing response as YAML
+    def to_yaml
+      YAML.dump(to_h)
+    rescue => err
+      raise ParseError.new(err), err
+    end
+
+    # Replace @body with YAML
+    #
+    # @return [String] A string containing response as YAML
+    def to_yaml!
+      @body = YAML.dump(to_h)
+    rescue => err
+      raise ParseError.new(err), err
+    end
+  end
+end

data/lib/mailgun/version.rb

@@ -1,5 +1,4 @@
+# It's the version. Yeay!
 module Mailgun
-
-  VERSION = "1.0.3"
-
+  VERSION = '1.1.0'
 end

data/lib/mailgun/webhooks/webhooks.rb

@@ -0,0 +1,101 @@
+module Mailgun
+
+  # A Mailgun::Webhooks object is a simple CRUD interface to Mailgun Webhooks.
+  # Uses Mailgun
+  class Webhooks
+
+    # Public creates a new Mailgun::Webhooks instance.
+    #   Defaults to Mailgun::Client
+    def initialize(client = Mailgun::Client.new)
+      @client = client
+    end
+
+    # Public: Get Webhooks
+    #
+    # domain  - a string the domain name to retrieve webhooks for
+    # options - a Hash of options
+    #
+    # Returns a Hash of the list of domains or nil
+    def list(domain, options = {})
+      res = @client.get("domains/#{domain}/webhooks", options)
+      res.to_h['webhooks']
+    end
+    alias_method :get_webhooks, :list
+
+    # Public: Get webook information for a specific action
+    #
+    # domain - a String of Domain name to find a webhook url for
+    # action - a String identifying the webhook to get the URL for
+    #
+    # Returns a String of the url for the identified webhook or an
+    #   empty String if one is not set
+    def info(domain, action)
+      res = @client.get("domains/#{domain}/webhooks/#{action}")
+      res.to_h['webhook']['url'] || ''
+    rescue NoMethodError
+      ''
+    end
+    alias_method :get_webhook_url, :info
+
+    # Public: Add webhook
+    #
+    # domain - A String of the domain name (ex. domain.com)
+    # action - A String of the action to create a webhook for
+    # url    - A String of the url of the webhook
+    #
+    # Returns a Boolean of whether the webhook was created
+    def create(domain, action, url = '')
+      res = @client.post("domains/#{domain}/webhooks", id: action, url: url)
+      res.to_h['webhook'] == url && res.to_h[message] == 'Webhook has been created'
+    end
+    alias_method :add, :create
+    alias_method :add_webhook, :create
+
+    # Public: Sets all webhooks to the same URL
+    #
+    # domain - A String of the domain name
+    # url    - A String of the url to set all webhooks to
+    #
+    # Returns true or false
+    def create_all(domain, url = '')
+      %w(bounce click deliver drop open spam unsubscribe).each do |action|
+        add_webhook domain, action, url
+      end
+      true
+    rescue
+      false
+    end
+    alias_method :add_all_webhooks, :create_all
+
+    # Public: Delete a specific webhook
+    #
+    # domain - The required String of domain name
+    # action - The required String of the webhook action to delete
+    #
+    # Returns a Boolean of the success
+    def remove(domain, action)
+      fail Mailgun::ParameterError('Domain not provided to remove webhook from') unless domain
+      fail Mailgun::ParameterError('Action not provided to identify webhook to remove') unless action
+      @client.delete("domains/#{domain}/webhooks/#{action}").to_h['message'] == 'Webhook has been deleted'
+    rescue Mailgun::CommunicationError
+      false
+    end
+    alias_method :delete, :remove
+    alias_method :delete_webhook, :remove
+
+    # Public: Delete all webhooks for a domain
+    #
+    # domain - A required String of the domain to remove all webhooks for
+    #
+    # Returns a Boolean on the success
+    def remove_all(domain)
+      fail Mailgun::ParameterError('Domain not provided to remove webhooks from') unless domain
+      %w(bounce click deliver drop open spam unsubscribe).each do |action|
+        delete_webhook domain, action
+      end
+    end
+    alias_method :delete_all, :remove_all
+    alias_method :delete_all_webooks, :remove_all
+
+  end
+end

data/mailgun.gemspec

@@ -5,28 +5,34 @@ require 'mailgun/version'
 
 Gem::Specification.new do |spec|
 
-  spec.name             = "mailgun-ruby"
+  spec.name             = 'mailgun-ruby'
   spec.version          = Mailgun::VERSION
-  spec.homepage         = "http://www.mailgun.com"
+  spec.homepage         = 'http://www.mailgun.com'
   spec.platform         = Gem::Platform::RUBY
   spec.license          = 'Apache'
 
   spec.summary          = "Mailgun's Official Ruby SDK"
   spec.description      = "Mailgun's Official Ruby SDK for interacting with the Mailgun API."
 
-  spec.authors          = ["Mailgun", "Travis Swientek"]
-  spec.email            = "support@mailgunhq.com"
+  spec.authors          = ['Mailgun', 'Travis Swientek']
+  spec.email            = 'support@mailgunhq.com'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rspec", "~> 2.14"
-  spec.add_development_dependency "rake", "~> 10.1"
+  spec.required_ruby_version = '>= 1.9.3'
 
-  spec.add_dependency "rest-client", "~> 1.6"
-  spec.add_dependency "json", "~> 1.8"
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'webmock', '~> 1.22'
+  spec.add_development_dependency 'pry', '~> 0.9'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+
+  spec.add_dependency 'rest-client', '~> 1.6'
+  spec.add_dependency 'json', '~> 1.8'
 
 end

data/spec/integration/bounces_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "bounces" }
+
+describe 'For the Bounces endpoint', order: :defined, vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @email = "integration-test-email@#{TESTDOMAIN}"
+  end
+
+  it 'creates a bounce' do
+    @result = @mg_obj.post("#{@domain}/bounces",
+                           {:address => @email,
+                            :code => 550,
+                            :error => "Integration Test"})
+
+    @result.to_h!
+    expect(@result.body["message"]).to eq("Address has been added to the bounces table")
+    expect(@result.body["address"]).to eq(@email)
+  end
+
+  it 'get a bounce.' do
+    result = @mg_obj.get("#{@domain}/bounces/#{@email}")
+
+    result.to_h!
+    expect(result.body["code"]).to eq("550")
+    expect(result.body["address"]).to eq(@email)
+    expect(result.body["error"]).to eq("Integration Test")
+  end
+
+  it 'gets a list of bounces.' do
+    result = @mg_obj.get("#{@domain}/bounces")
+
+    result.to_h!
+    expect(result.body["items"].length).to be > 0
+  end
+
+  it 'deletes a bounce' do
+    @mg_obj.delete("#{@domain}/bounces/#{@email}")
+  end
+
+end

data/spec/integration/campaign_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "campaigns" }
+
+describe 'For the campaigns endpoint', vcr: vcr_opts do
+  before(:all) do
+    skip 'pending removal'
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @campaign_id = "integration_test_campaign"
+  end
+
+  it 'creates a campaign' do
+    result = @mg_obj.post("#{@domain}/campaigns", {:name => 'My Campaign',
+                                                   :id => @campaign_id})
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Campaign created")
+    expect(result.body["campaign"]["id"]).to eq(@campaign_id)
+    expect(result.body["campaign"]["name"]).to eq('My Campaign')
+  end
+
+  it 'get a campaign.' do
+    result = @mg_obj.get("#{@domain}/campaigns/#{@campaign_id}")
+
+    result.to_h!
+    expect(result.body["id"]).to eq(@campaign_id)
+    expect(result.body["name"]).to eq('My Campaign')
+  end
+
+  it 'gets a list of all campaigns.' do
+    result = @mg_obj.get("#{@domain}/campaigns", {:limit => 50})
+
+    result.to_h!
+    expect(result.body["total_count"]).to be > 0
+  end
+
+  it 'update a campaign.' do
+    result = @mg_obj.put("#{@domain}/campaigns/#{@campaign_id}", {:name => 'My Updated Campaign',
+                                                                  :id => @campaign_id})
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Campaign updated")
+    expect(result.body["campaign"]["id"]).to eq(@campaign_id)
+    expect(result.body["campaign"]["name"]).to eq('My Updated Campaign')
+  end
+
+  it 'get campaign events.' do
+    expect{@mg_obj.get("#{@domain}/campaigns/#{@campaign_id}/events", {:groupby => "clicked"})}.not_to raise_error
+  end
+
+  it 'get campaign stats.' do
+    expect{@mg_obj.get("#{@domain}/campaigns/#{@campaign_id}/stats", {:groupby => "domain"})}.not_to raise_error
+  end
+
+  it 'removes a campaign' do
+    @mg_obj.delete("#{@domain}/campaigns/#{@campaign_id}")
+  end
+end

data/spec/integration/complaints_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "complaints" }
+
+describe 'For the Complaints endpoint', order: :defined, vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @email = "integration-test-email@#{TESTDOMAIN}"
+  end
+
+  it 'creates a complaint' do
+    @result = @mg_obj.post("#{@domain}/complaints", {:address => @email})
+
+    @result.to_h!
+    expect(@result.body["message"]).to eq("Address has been added to the complaints table")
+    expect(@result.body["address"]).to eq(@email)
+  end
+
+  it 'get a complaint.' do
+    result = @mg_obj.get("#{@domain}/complaints/#{@email}")
+
+    result.to_h!
+    expect(result.body["address"]).to eq(@email)
+  end
+
+  it 'gets a list of complaints.' do
+    result = @mg_obj.get("#{@domain}/complaints")
+
+    result.to_h!
+    expect(result.body["items"].length).to be > 0
+  end
+
+  it 'removes a complaint' do
+    @mg_obj.delete("#{@domain}/complaints/#{@email}")
+  end
+end

data/spec/integration/domains_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "domains" }
+
+describe 'For the domains endpoint', vcr: vcr_opts do
+  before(:all) do
+    @mg_client = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @mg_obj = Mailgun::Domains.new(@mg_client)
+    @domain = "integration-test.domain.invalid"
+  end
+
+  it 'creates the domain' do
+    result = @mg_obj.add_domain(@domain, { smtp_password: 'super_secret', spam_action: 'tag' })
+
+    expect(result['domain']["name"]).to eq(@domain)
+    expect(result['domain']["spam_action"]).to eq("tag")
+    expect(result['domain']["smtp_password"]).to eq("super_secret")
+  end
+
+  it 'get the domain.' do
+    result = @mg_obj.get(@domain)
+
+    expect(result).to include("domain")
+    expect(result["domain"]["name"]).to eq(@domain)
+  end
+
+  it 'gets a list of domains.' do
+    result = @mg_obj.get_domains
+
+    expect(result.size).to be > 0
+  end
+
+  it 'deletes a domain.' do
+    result = @mg_obj.delete(@domain)
+
+    expect(result).to be_truthy
+  end
+end

data/spec/integration/email_validation_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "email_validation" }
+
+describe 'For the Email Validation endpoint', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(PUB_APIKEY)
+  end
+
+  it 'validates an address.' do
+    result = @mg_obj.get("address/validate",
+                         {:address => "test@#{TESTDOMAIN}"})
+
+    result.to_h!
+    expect(result.body["is_valid"]).to eq(true)
+    expect(result.body["address"]).to eq("test@#{TESTDOMAIN}")
+  end
+
+  it 'parses an address.' do
+    result = @mg_obj.get("address/parse",
+                         {:addresses => "Alice <alice@#{TESTDOMAIN}>,bob@#{TESTDOMAIN},#{TESTDOMAIN}"})
+
+    result.to_h!
+    expect(result.body["parsed"]).to include("Alice <alice@#{TESTDOMAIN}>")
+    expect(result.body["parsed"]).to include("bob@#{TESTDOMAIN}")
+    expect(result.body["unparseable"]).to include("#{TESTDOMAIN}")
+  end
+end

data/spec/integration/events_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "events" }
+
+describe 'For the Events endpoint', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+  end
+
+  it 'get an event.' do
+    result = @mg_obj.get("#{@domain}/events", {:limit => 1})
+
+    result.to_h!
+    expect(result.body["items"].length).to be_within(1).of(1)
+    expect(result.body["paging"]).to include("next")
+    expect(result.body["paging"]).to include("previous")
+  end
+end