pew_pew 0.0.1

data/lib/pew_pew/resources/complaints.rb

@@ -0,0 +1,40 @@
+module PewPew
+  module Resources
+    class Complaints
+      include Resource
+      include Domain
+
+      # Fetches all spam complaints.
+      #
+      # @return [Mash] the response body
+      def all
+        get("#{domain}/complaints")
+      end
+
+      # Fetch all spam complaints by address.
+      #
+      # @param address [String] the address to fetch spam complaints for
+      # @return [Mash] the response body
+      def find(address)
+        get("#{domain}/complaints/#{address}")
+      end
+
+      # Creates a new spam complaint.
+      #
+      # @option params [String] :address the email address to add
+      # @return [Mash] the response body
+      def create(params)
+        post("#{domain}/complaints", params)
+      end
+
+      # Removes existing spam complaints.
+      #
+      # @param address_or_id [String] the address to remove all the spam
+      #   complaints for
+      # @return [Mash] the response body
+      def remove(address_or_id)
+        delete("#{domain}/complaints/#{address_or_id}")
+      end
+    end
+  end
+end

data/lib/pew_pew/resources/lists.rb

@@ -0,0 +1,121 @@
+require 'json'
+
+module PewPew
+  module Resources
+    class Lists
+      include Resource
+
+      # Fetches all defined mailing lists.
+      #
+      # @return [Mash] the response body
+      def all
+        get('lists')
+      end
+
+      # Fetch a mailing list by email address.
+      #
+      # @param address [String] the email address of the mailing list to fetch
+      # @return [Mash] the response body
+      def find(address)
+        get("lists/#{address}")
+      end
+
+      # Creates a new mailing list.
+      #
+      # @option params [String] :description optional list description
+      # @option params [String] :name optional mailing list name
+      # @option params [String] :address email address for the mailing list
+      # @return [Mash] the response body
+      def create(params)
+        post('lists', params)
+      end
+
+      # Updates an existing mailing list by email address.
+      #
+      # @param address [String] the email address of the mailing list to update
+      # @option params [String] :description optional list description
+      # @option params [String] :name optional mailing list name
+      # @option params [String] :address email address for the mailing list
+      # @return [Mash] the response body
+      def update(address, params)
+        put("lists/#{address}", params)
+      end
+
+      # Removes an existing mailing list by email address.
+      #
+      # @param address [String] the email address of the mailing list to remove
+      # @return [Mash] the response body
+      def remove(address)
+        delete("lists/#{address}")
+      end
+
+      # Fetches a summary of the results for a given mailing list, like numbers
+      # of clicks, opens, etc. Includes unique numbers (e.g. number of unique
+      # recipients who clicked) as well.
+      #
+      # @param address [String] the email address of the mailing list to fetch
+      # @return [Mash] the response body
+      def stats(address)
+        get("lists/#{address}/stats")
+      end
+
+      # Fetches all defined mailing list members.
+      #
+      # @param address [String] the email address of the mailing list
+      # @return [Mash] the response body
+      def all_members(address)
+        get("lists/#{address}/members")
+      end
+
+      # Fetch a mailing list member by email address.
+      #
+      # @param address [String] the email address of the mailing list
+      # @param member_address [String] the email address of the member to fetch
+      # @return [Mash] the response body
+      def find_member(address, member_address)
+        get("lists/#{address}/members/#{member_address}")
+      end
+
+      # Adds a new member to a mailing list.
+      #
+      # @param address [String] the email address of the mailing list
+      # @option params [String] :address the email address of the member
+      # @option params [String] :name optional member name
+      # @option params [Hash] :vars optional dictionary of arbitrary member
+      #   parameters (will be encoded as JSON)
+      # @option params [Boolean] :subscribed if false, add the member as
+      #   unsubscribed
+      # @option params [Boolean] :upsert if true, update an existing member
+      #   instead of returning an error
+      # @return [Mash] the response body
+      def create_member(address, params)
+        params[:vars] = params[:vars].to_json
+        post("lists/#{address}/members", params)
+      end
+
+      # Updates an existing mailing list member by email address.
+      #
+      # @param address [String] the email address of the mailing list
+      # @param member_address [String] the email address of the member to update
+      # @option params [String] :address the email address of the member
+      # @option params [String] :name optional member name
+      # @option params [Hash] :vars optional dictionary of arbitrary member
+      #   parameters (will be encoded as JSON)
+      # @option params [Boolean] :subscribed if false, add the member as
+      #   unsubscribed
+      # @return [Mash] the response body
+      def update_member(address, member_address, params)
+        put("lists/#{address}/members/#{member_address}", params)
+      end
+
+      # Removes an existing mailing list member by email address.
+      #
+      # @param address [String] the email address of the mailing list
+      # @param member_address [String] the email address of the member to remove
+      # @return [Mash] the response body
+      def remove_member(address, member_address)
+        delete("lists/#{address}/members/#{member_address}")
+      end
+    end
+  end
+end

data/lib/pew_pew/resources/logs.rb

@@ -0,0 +1,12 @@
+module PewPew
+  module Resources
+    class Logs
+      include Resource
+      include Domain
+
+      def all
+        get("#{domain}/log")
+      end
+    end
+  end
+end

data/lib/pew_pew/resources/mailboxes.rb

@@ -0,0 +1,41 @@
+module PewPew
+  module Resources
+    class Mailboxes
+      include Resource
+      include Domain
+
+      # Fetches all defined mailboxes.
+      #
+      # @return [Mash] the response body
+      def all
+        get("#{domain}/mailboxes")
+      end
+
+      # Creates a new mailbox.
+      #
+      # @option params [String] :mailbox the name of the mailbox
+      # @option params [String] :password the mailbox password
+      # @return [Mash] the response body
+      def create(params)
+        post("#{domain}/mailboxes", params)
+      end
+
+      # Updates an existing mailbox by mailbox name.
+      #
+      # @param mailbox [String] the name of the mailbox to be updated
+      # @option params [String] :password the mailbox password
+      # @return [Mash] the response body
+      def update(mailbox, params)
+        put("#{domain}/mailboxes/#{mailbox}", params)
+      end
+
+      # Removes an existing mailbox by mailbox name.
+      #
+      # @param mailbox [String] the name of the mailbox to be deleted
+      # @return [Mash] the response body
+      def remove(mailbox)
+        delete("#{domain}/mailboxes/#{mailbox}")
+      end
+    end
+  end
+end

data/lib/pew_pew/resources/messages.rb

@@ -0,0 +1,37 @@
+module PewPew
+  module Resources
+    class Messages
+      include Resource
+      include Domain
+
+      # Sends an email.
+      #
+      # @option params [String] :from email address to use for the `From` header
+      # @option params [String, Array<String>] :to recipient or list of
+      #   recipient email addresses
+      # @option params [String] :cc same as `:to`, but for CC
+      # @option params [String] :bcc same as `:to`, but for BCC
+      # @option params [String] :subject message subject
+      # @option params [String] :text text version of the message body
+      # @option params [String] :html HTML version of the message body
+      # @option params [File, Array<File>] :attachment file attachments
+      # @option params [File, Array<File>] :inline inline file attachments
+      # @return [Mash] the response body
+      def send_email(params)
+        post("#{domain}/messages", params)
+      end
+
+      # Sends a MIME email.
+      #
+      # @option params [String, Array<String>] :to recipient or list of
+      #   recipient email addresses
+      # @option params [File] :message file containing the full MIME content
+      #   of the message
+      # @return [Mash] the response body
+      def send_mime(params)
+        headers = { content_type: 'multipart/form-data' }
+        post("#{domain}/messages.mime", params, headers)
+      end
+    end
+  end
+end

data/lib/pew_pew/resources/routes.rb

@@ -0,0 +1,57 @@
+module PewPew
+  module Resources
+    class Routes
+      include Resource
+
+      # Fetches all defined routes.
+      #
+      # @return [Mash] the response body
+      def all
+        get('routes')
+      end
+
+      # Fetch a route by ID.
+      #
+      # @param id [String] the ID of the route to be fetched
+      # @return [Mash] the response body
+      def find(id)
+        get("routes/#{id}")
+      end
+
+      # Creates a new route.
+      #
+      # @option params [Fixnum] :priority smaller number indicates higher
+      #   priority; higher priority routes are handled first; Defaults to 0
+      # @option params [String] :description arbitrary description of the route
+      # @option params [String] :expression the filter expression
+      # @option params [String, Array<String>] :action the route action(s) to
+      #   be executed when the expression evaluates to true
+      # @return [Mash] the response body
+      def create(params)
+        post('routes', params)
+      end
+
+      # Updates an existing route by ID.
+      #
+      # @param id [String] the ID of the route to be updated
+      # @option params [Fixnum] :priority smaller number indicates higher
+      #   priority; higher priority routes are handled first; Defaults to 0
+      # @option params [String] :description arbitrary description of the route
+      # @option params [String] :expression the filter expression
+      # @option params [String, Array<String>] :action the route action(s) to
+      #   be executed when the expression evaluates to true
+      # @return [Mash] the response body
+      def update(id, params)
+        put("routes/#{id}", params)
+      end
+
+      # Removes an existing route by ID.
+      #
+      # @param id [String] the ID of the route to be deleted
+      # @return [Mash] the response body
+      def remove(id)
+        delete("routes/#{id}")
+      end
+    end
+  end
+end

data/lib/pew_pew/resources/stats.rb

@@ -0,0 +1,12 @@
+module PewPew
+  module Resources
+    class Stats
+      include Resource
+      include Domain
+
+      def all
+        get("#{domain}/stats")
+      end
+    end
+  end
+end

data/lib/pew_pew/resources/unsubscribes.rb

@@ -0,0 +1,43 @@
+module PewPew
+  module Resources
+    class Unsubscribes
+      include Resource
+      include Domain
+
+      # Fetches all unsubscribe events.
+      #
+      # @return [Mash] the response body
+      def all
+        get("#{domain}/unsubscribes")
+      end
+
+      # Fetch all unsubscribe events by address.
+      #
+      # @param address [String] the address to fetch unsubscribe events for
+      # @return [Mash] the response body
+      def find(address)
+        get("#{domain}/unsubscribes/#{address}")
+      end
+
+      # Creates a new unsubscribe event.
+      #
+      # @option params [String] :address the email address to unsubscribe
+      # @option params [String] :tag optional tag to unsubscribe from (defaults
+      #   to unsubscribing the address completely from the domain)
+      # @return [Mash] the response body
+      def create(params)
+        params[:tag] ||= '*'
+        post("#{domain}/unsubscribes", params)
+      end
+
+      # Removes existing unsubscribe events.
+      #
+      # @param address_or_id [String] the address to remove all the unsubscribe
+      #   events for, or a single unsubscribe event ID to remove
+      # @return [Mash] the response body
+      def remove(address_or_id)
+        delete("#{domain}/unsubscribes/#{address_or_id}")
+      end
+    end
+  end
+end

data/lib/pew_pew/response.rb

@@ -0,0 +1,11 @@
+require 'hashie'
+
+module PewPew
+  class Response < Hashie::Mash
+    undef :count
+
+    def success?
+      status == 200
+    end
+  end
+end

data/lib/pew_pew/version.rb

@@ -0,0 +1,3 @@
+module PewPew
+  VERSION = '0.0.1'
+end

data/pew_pew.gemspec

@@ -0,0 +1,20 @@
+require './lib/pew_pew/version'
+
+Gem::Specification.new do |gem|
+  gem.name = 'pew_pew'
+  gem.version = PewPew::VERSION
+  gem.summary = 'A Ruby client library for using the Mailgun web service.'
+  gem.homepage = 'http://github.com/tylerhunt/pew_pew'
+  gem.author = 'Tyler Hunt'
+
+  gem.add_dependency 'faraday_middleware', '~> 0.8.0'
+  gem.add_dependency 'hashie', '~> 1.1'
+  gem.add_dependency 'relax', '~> 0.2.0'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'vcr', '~> 2.2'
+
+  gem.files = `git ls-files`.split($\)
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end

data/spec/fixtures/bounces.yml

@@ -0,0 +1,144 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.mailgun.net/v2/<%= domain %>/bounces
+    body:
+      encoding: US-ASCII
+      string: address=test%40example.com&code=554&error=Relay+access+denied
+    headers:
+      User-Agent:
+      - PewPew Ruby Gem 0.0.1
+      Authorization:
+      - Basic <%= basic_auth %>
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.0.14
+      date:
+      - Sat, 02 Jun 2012 07:24:08 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '96'
+      content-disposition:
+      - inline
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"message\": \"Address has been added to the bounces table\",
+        \n  \"address\": \"test@example.com\"\n}"
+    http_version: 
+  recorded_at: Sat, 02 Jun 2012 07:24:08 GMT
+- request:
+    method: get
+    uri: https://api.mailgun.net/v2/<%= domain %>/bounces/test@example.com
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - PewPew Ruby Gem 0.0.1
+      Authorization:
+      - Basic <%= basic_auth %>
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.0.14
+      date:
+      - Sat, 02 Jun 2012 07:24:33 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '161'
+      content-disposition:
+      - inline
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"bounce\": {\n    \"code\": \"554\",\n    \"created_at\": \"Sat,
+        02 Jun 2012 07:24:08 GMT\",\n    \"error\": \"Relay access denied\",\n    \"address\":
+        \"test@example.com\"\n  }\n}"
+    http_version: 
+  recorded_at: Sat, 02 Jun 2012 07:24:33 GMT
+- request:
+    method: get
+    uri: https://api.mailgun.net/v2/<%= domain %>/bounces
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - PewPew Ruby Gem 0.0.1
+      Authorization:
+      - Basic <%= basic_auth %>
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.0.14
+      date:
+      - Sat, 02 Jun 2012 07:25:45 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '200'
+      content-disposition:
+      - inline
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"total_count\": 1,\n  \"items\": [\n    {\n      \"code\":
+        \"554\",\n      \"created_at\": \"Sat, 02 Jun 2012 07:24:08 GMT\",\n      \"error\":
+        \"Relay access denied\",\n      \"address\": \"test@example.com\"\n    }\n
+        \ ]\n}"
+    http_version: 
+  recorded_at: Sat, 02 Jun 2012 07:25:45 GMT
+- request:
+    method: delete
+    uri: https://api.mailgun.net/v2/<%= domain %>/bounces/test@example.com
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - PewPew Ruby Gem 0.0.1
+      Authorization:
+      - Basic <%= basic_auth %>
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      server:
+      - nginx/1.0.14
+      date:
+      - Sat, 02 Jun 2012 07:26:15 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '85'
+      content-disposition:
+      - inline
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"message\": \"Bounced address has been removed\", \n  \"address\":
+        \"test@example.com\"\n}"
+    http_version: 
+  recorded_at: Sat, 02 Jun 2012 07:26:15 GMT
+recorded_with: VCR 2.2.0