mailosaur 0.0.15

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 501a6cd736f697c7ce94be900f857908a429236e
+  data.tar.gz: 30b1efc11055ef774708c6626420988a907b4136
+SHA512:
+  metadata.gz: 779191e3b09423f86fac7d48d723e739fc0840056fbb447ac436b0d021cfef8f5863548a91bfdb0d700e5121f2e1f78df0dfcbf0d48fd6155701591126a58dff
+  data.tar.gz: 34afbb94d69fd211d0bc37f30dea9ac8cbf9ec137bb26a5cf86dd092d0324bfbfcebe46edb9db68b342f2491d9797b564c296d7a94c3d575ab45cca0237f361a

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Clickity Ltd
+
+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,77 @@
+# Mailosaur Ruby bindings
+
+Mailosaur allows you to automate tests that require email. You can also use it for manual testing as it gives you unlimited test email addresses or use it as a fake/dummy SMTP service.
+
+For more info go to [mailosaur.com](https://mailosaur.com/)
+
+
+## Installation
+
+  gem install mailosaur
+
+## Usage
+```ruby
+require 'mailosaur'
+require "test/unit"
+
+mailbox = Mailosaur.new(mailbox,apikey)
+
+emails = mailbox.getEmailsByRecipient('anything.1eaaeef6@mailosaur.in')
+
+assert_equal('something', emails[0].Subject, 'The subject should be something')
+```
+##Api
+
+*functions:*
+
+- **Email[] GetEmails(String searchPattern)** - Retrieves all emails which have the searchPattern text in their body or subject.
+
+- **Email[] GetEmailsByRecipient(String recipientEmail)** - 
+Retrieves all emails sent to the given recipient.
+
+- **Email GetEmail(String emailId)** - 
+Retrieves the email with the given id.
+
+- **Void DeleteAllEmail()** - 
+Deletes all emails in a mailbox.
+
+- **Void DeleteEmail(String emailId)** - 
+Deletes the email with the given id.
+
+- **Byte[] GetAttachment(String attachmentId)** - 
+Retrieves the attachment with specified id.
+
+- **Byte[] GetRawEmail(String rawId)** - 
+Retrieves the complete raw EML file for the rawId given. RawId is a property on the email object.
+
+- **String GenerateEmailAddress()** - 
+Generates a random email address which can be used to send emails into the mailbox.
+
+*structures*
+
+- **Email** - The core object returned by the Mailosaur API
+  - **id** - The email identifier
+  - **creationdate** - The date your email was received by Mailosaur
+  - **senderHost** - The host name of the machine that sent the email
+  - **rawId** - Reference for raw email data
+  - **html** - The HTML content of the email
+    - **links** - All links found within the HTML content of the email
+    - **images** - All images found within the HTML content of the email
+    - **body** - Unescaped HTML body of the email
+  - **text** - The text content of the email
+    - **links** - All links found within the text content of the email
+    - **body** - Text body of the email
+  - **headers** - Contains all email headers as object properties
+  - **subject** - Email subject
+  - **priority** - Email priority
+  - **from** - Details of email sender(s)
+    - **address** - Email address
+    - **name** - Email sender name
+  - **to** - Details of email recipient(s)
+    - **address** - Email address
+    - **name** - Email recipient name
+  - **attachments** - Details of any attachments found within the email
+    - **id** - Attachment identifier
+    - **fileName** - Attachment file name
+    - **length** - Attachment file size (in bytes)
+    - **contentType** - Attachment mime type (e.g. "image/png")

data/lib/mailosaur.rb

@@ -0,0 +1,100 @@
+require 'rubygems'
+require 'rest_client'
+require 'json'
+require 'rest_client'
+require 'securerandom'
+require 'date'
+require "#{File.dirname(__FILE__)}/mailosaur/email"
+
+# Main class to access Mailosaur.com api.
+class Mailosaur
+  @MAILBOX
+  @API_KEY
+  @BASE_URI
+
+  # Pass in your mailbox id and api key to authenticate
+  # Leave mailbox and/or apiKey empty to load settings from environment.
+  # export MAILOSAUR_APIKEY=abcex7
+  # export MAILOSAUR_MAILBOX=123456abcde
+  def initialize(mailbox, apiKey)
+    @MAILBOX = ENV['MAILOSAUR_MAILBOX'] || mailbox
+    @API_KEY = ENV['MAILOSAUR_APIKEY'] || apiKey
+    @BASE_URI = 'https://mailosaur.com/v2'
+  end
+
+  # Retrieves all emails which have the searchPattern text in their body or subject.
+  def getEmails(searchCriteria = Hash.new)
+    if searchCriteria.is_a? String
+      search = searchCriteria
+      searchCriteria = Hash.new
+      searchCriteria['search'] = search
+    end
+    searchCriteria['key'] = @API_KEY
+    searchCriteria['mailbox'] = @MAILBOX
+    for i in 1..10
+      response = RestClient.get("#{@BASE_URI}/emails", {:params => searchCriteria})
+      data = JSON.parse(response.body)
+      emails = data.map { |em| Email.new(em) }
+
+      if !emails.nil? && emails.length>0
+        return emails
+      end
+      # back off and retry
+      sleep(i*i)
+    end
+  end
+
+  # Retrieves all emails sent to the given recipient.
+  def getEmailsByRecipient(recipientEmail)
+    searchCriteria = Hash.new
+    searchCriteria['recipient']= recipientEmail
+    return getEmails(searchCriteria)
+  end
+
+  # Retrieves the email with the given id.
+  def getEmail(emailId)
+    params = Hash.new
+    params['key'] = @API_KEY
+    response = RestClient.get(@BASE_URI + '/email/' + emailId, {:params => params})
+    data = JSON.parse(response.body)
+    email = Email.new(data)
+    return email
+  end
+
+  # Deletes all emails in a mailbox.
+  def deleteAllEmail
+    queryParams = Hash.new
+    queryParams['key'] = @API_KEY
+    queryParams['mailbox'] = @MAILBOX
+    RestClient.post("#{@BASE_URI}/emails/deleteall", nil, {:params => queryParams})
+  end
+
+  # Deletes the email with the given id.
+  def deleteEmail(emailId)
+    params = Hash.new
+    params['key'] = @API_KEY
+    RestClient.post(@BASE_URI + '/email/' + emailId + '/delete/', nil,{:params => params})
+  end
+
+  # Retrieves the attachment with specified id.
+  def getAttachment(attachmentId)
+    params = Hash.new
+    params['key'] = @API_KEY
+    response = RestClient.get(@BASE_URI + '/attachment/' + attachmentId, {:params => params})
+    return response.body
+  end
+
+  # Retrieves the complete raw EML file for the rawId given. RawId is a property on the email object.
+  def getRawEmail(rawId)
+    params = Hash.new
+    params['key'] = @API_KEY
+    response = RestClient.get(@BASE_URI + '/raw/' + rawId, {:params => params})
+    return response.body
+  end
+
+  # Generates a random email address which can be used to send emails into the mailbox.
+  def generateEmailAddress()
+    uuid = SecureRandom.hex(3)
+    return "%s.%s@mailosaur.in" % [uuid, @MAILBOX]
+  end
+end

data/lib/mailosaur/attachment.rb

@@ -0,0 +1,10 @@
+class Attachment
+  attr_accessor :contentType, :fileName, :length, :id
+
+  def initialize(hash)
+    @contentType = hash['contentType']
+    @fileName = hash['fileName']
+    @length = hash['length']
+    @id = hash['id']
+  end
+end

data/lib/mailosaur/email.rb

@@ -0,0 +1,23 @@
+require "#{File.dirname(__FILE__)}/email_address"
+require "#{File.dirname(__FILE__)}/email_data"
+require "#{File.dirname(__FILE__)}/attachment"
+
+class Email
+  attr_accessor :id, :creationdate, :senderHost, :from, :to, :mailbox, :rawId, :html, :text, :headers, :subject, :priority, :attachments
+
+  def initialize(hash)
+    @id = hash['id']
+    @creationdate = DateTime.iso8601(hash['creationdate'])
+    @senderHost = hash['senderHost']
+    @from= hash['from'].map { |f| EmailAddress.new(f) }
+    @to= hash['to'].map { |t| EmailAddress.new(t) }
+    @mailbox = hash['mailbox']
+    @rawId = hash['rawId']
+    @html = hash.has_key?('html')?EmailData.new(hash['html']):nil
+    @text = hash.has_key?('text')?EmailData.new(hash['text']):nil
+    @headers = hash['headers']
+    @subject = hash['subject']
+    @priority = hash['priority']
+    @attachments = hash.has_key?('attachments')?hash['attachments'].map { |a| Attachment.new(a) } : nil
+  end
+end

data/lib/mailosaur/email_address.rb

@@ -0,0 +1,9 @@
+class EmailAddress
+  attr_accessor :address, :name
+
+  def initialize(hash)
+    @address = hash['address']
+    @name = hash['name']
+  end
+end
+

data/lib/mailosaur/email_data.rb

@@ -0,0 +1,13 @@
+require "#{File.dirname(__FILE__)}/link"
+require "#{File.dirname(__FILE__)}/image"
+
+
+class EmailData
+  attr_accessor :links, :body, :images
+
+  def initialize(hash)
+    @links =hash.has_key?('links') ? hash['links'].map { |a| Link.new(a) } : nil
+    @body = hash['body']
+    @images = hash.has_key?('images') ? hash['images'].map { |a| Image.new(a) } : nil
+  end
+end

data/lib/mailosaur/image.rb

@@ -0,0 +1,8 @@
+class Image
+  attr_accessor :src, :alt
+
+  def initialize(hash)
+    @src = hash['src']
+    @alt = hash['alt']
+  end
+end

data/lib/mailosaur/link.rb

@@ -0,0 +1,8 @@
+class Link
+  attr_accessor :href, :text
+
+  def initialize(hash)
+    @href = hash['href']
+    @text = hash['text']
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: mailosaur
+version: !ruby/object:Gem::Version
+  version: 0.0.15
+platform: ruby
+authors:
+- Clickity Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.6
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+description: Gem containing ruby bindings for the mailosaur.com mail testing api.
+email: support@mailosaur.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/mailosaur.rb
+- lib/mailosaur/attachment.rb
+- lib/mailosaur/email.rb
+- lib/mailosaur/email_address.rb
+- lib/mailosaur/email_data.rb
+- lib/mailosaur/image.rb
+- lib/mailosaur/link.rb
+homepage: http://mailosaur.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Bindings for mailosaur.com
+test_files: []