mailosaur 0.0.17 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6953dda6f7d708942053af12e89965e0600085c0
-  data.tar.gz: 141d25ea3ba910931c04d57003e7853b387817d1
+  metadata.gz: 958bed120db8df13a226f1f8cbfb58c0b6675d3f
+  data.tar.gz: 2339ed43752ac88db945241349114715dd722f0a
 SHA512:
-  metadata.gz: b0e021f78701c9f5db9e2e8a08979195a6152bf682f842103e0a34f7bbc1058b40e6ae5468e0eeeef97c3fd4156322a258669c23dc532250722e8c3bce574753
-  data.tar.gz: 644bfdf04cea4a5562b353749e47f3994d5ab3a1c5a47a15b76f19a2f650580783f776d506aa5f41aae0aaad4aeda77dee19b2783b7f91597019bce6582ac1ef
+  metadata.gz: 7ad786ad1421004232b750c89b6645f4ea9e53b66ede0fef35d6b8f988640c91e813ca3985a4145451043a740d55f5d081b3ca6851ee0dfb06dfc7625a4799f8
+  data.tar.gz: 89117a52e1f693a10824314ee6f6725aa7dcc1ff35809ac61bdf0f28684b1ae5df9df81ac71488683ed521a641383ce257efe62d73f638b61777c4691f9d0eee

data/README.md

@@ -7,47 +7,54 @@ For more info go to [mailosaur.com](https://mailosaur.com/)
 
 ## Installation
 
-  gem install mailosaur
+  ``` 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')
+emails = mailbox.get_emails_by_recipient('anything.1eaaeef6@mailosaur.in')
 ```
+
+Optional: Timeout
+
+- Default timeout is set to 20, if you want to increase or decrease this, set the time in seconds to the `MAILOSAUR_TIMEOUT` variable.
+
+``` export MAILOSAUR_TIMEOUT=60 ```
+
+
 ##Api
 
 *functions:*
 
-- **Email[] GetEmails(String searchPattern)** - Retrieves all emails which have the searchPattern text in their body or subject.
+- get_emails - Retrieves all emails
+
+- get_emails('search_text') - Retrieves all emails with ``` search_text ``` in their body or subject.
 
-- **Email[] GetEmailsByRecipient(String recipientEmail)** - 
+- get_emails_by_recipient('recipient_email') -
 Retrieves all emails sent to the given recipient.
 
-- **Email GetEmail(String emailId)** - 
+- get_email('email_id') -
 Retrieves the email with the given id.
 
-- **Void DeleteAllEmail()** - 
+- delete_all_emails -
 Deletes all emails in a mailbox.
 
-- **Void DeleteEmail(String emailId)** - 
+- delete_email('email_id') -
 Deletes the email with the given id.
 
-- **Byte[] GetAttachment(String attachmentId)** - 
+- get_attachment('attachment_id') -
 Retrieves the attachment with specified id.
 
-- **Byte[] GetRawEmail(String rawId)** - 
+- get_raw_email('raw_id') -
 Retrieves the complete raw EML file for the rawId given. RawId is a property on the email object.
 
-- **String GenerateEmailAddress()** - 
+- generate_email_address -
 Generates a random email address which can be used to send emails into the mailbox.
 
-*structures*
+*Email Object Structure*
 
 - **Email** - The core object returned by the Mailosaur API
   - **id** - The email identifier

data/lib/helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'rest_client'
+require 'json'
+require 'securerandom'
+require "#{File.dirname(__FILE__)}/mailosaur/email"
+require "#{File.dirname(__FILE__)}/mailosaur/message_generator"

data/lib/mailosaur.rb

@@ -1,100 +1,123 @@
-require 'rubygems'
-require 'rest_client'
-require 'json'
-require 'rest_client'
-require 'securerandom'
-require 'date'
-require "#{File.dirname(__FILE__)}/mailosaur/email"
+require_relative 'helper.rb'
 
-# Main class to access Mailosaur.com api.
 class Mailosaur
-  @MAILBOX
-  @API_KEY
-  @BASE_URI
+  attr_reader :message
 
-  # 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'
+  def initialize(mailbox, apiKey, timeout=20)
+    @mailbox  = ENV['MAILOSAUR_MAILBOX'] || mailbox
+    @api_key  = ENV['MAILOSAUR_APIKEY']  || apiKey
+    @timeout  = timeout
+    @base_uri = 'https://mailosaur.com/v2'
+    @message  = MessageGenerator.new
   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
+  def get_emails(search_criteria = {})
+    if search_criteria.is_a? String
+      search_criteria = {'search' => search_criteria}
     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)
+    search_criteria['key']     = @api_key
+    search_criteria['mailbox'] = @mailbox
+    response = send_get_emails_request(search_criteria)
+    if response.length > 2
+      data   = JSON.parse(response.body)
+      data.map { |em| Email.new(em) }
+    else
+      message.no_emails_found(search_criteria)
     end
   end
 
   # Retrieves all emails sent to the given recipient.
-  def getEmailsByRecipient(recipientEmail)
-    searchCriteria = Hash.new
-    searchCriteria['recipient']= recipientEmail
-    return getEmails(searchCriteria)
+  def get_emails_by_recipient(recipient_email)
+    search_criteria = {'recipient' => recipient_email}
+    get_emails(search_criteria)
   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
+  def get_email(email_id)
+    params   = {'key' => @api_key}
+    response = RestClient.get("#{@base_uri}/email/#{email_id}", {:params => params})
+    data     = JSON.parse(response.body)
+    Email.new(data)
   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})
+  # Deletes all emails in a @mailbox.
+  def delete_all_emails
+    query_params = {'key' => @api_key, '@mailbox' => @mailbox }
+    RestClient.post("#{@base_uri}/emails/deleteall", nil, {:params => query_params})
   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})
+  def delete_email(email_id)
+    params = {'key' => @api_key}
+    RestClient.post("#{@base_uri}/email/#{email_id}/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
+  def get_attachment(attachment_id)
+    params = {'key' => @api_key}
+    RestClient.get("#{@base_uri}/attachment/#{attachment_id}", {:params => params}).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
+  def get_raw_email(raw_id)
+    params = {'key' => @api_key}
+    RestClient.get("#{@base_uri}/raw/#{raw_id}", {:params => params}).body
   end
 
-  # Generates a random email address which can be used to send emails into the mailbox.
-  def generateEmailAddress()
+  # Generates a random email address which can be used to send emails into the @mailbox.
+  def generate_email_address
     uuid = SecureRandom.hex(3)
-    return "%s.%s@mailosaur.in" % [uuid, @MAILBOX]
+    "%s.%s@mailosaur.in" % [uuid, @mailbox]
+  end
+
+  # old methods
+  def getEmails(search_criteria = {})
+    message.new_syntax('getEmails')
+    get_emails(search_criteria)
+  end
+  def getEmailsByRecipient(recipient_email)
+    message.new_syntax('getEmailsByRecipient')
+    get_emails_by_recipient(recipient_email)
+  end
+  def getEmail(email_id)
+    message.new_syntax('getEmail')
+    get_email(email_id)
+  end
+  def deleteAllEmail
+    message.new_syntax('deleteAllEmail')
+    delete_all_emails
+  end
+  def deleteEmail(email_id)
+    message.new_syntax('deleteEmail')
+    delete_email(email_id)
+  end
+  def getAttachment(attachment_id)
+    message.new_syntax('getAttachment')
+    get_attachment(attachment_id)
+  end
+  def getRawEmail(raw_id)
+    message.new_syntax('getRawEmail')
+    get_raw_email(raw_id)
+  end
+  def generateEmailAddress
+    message.new_syntax('generateEmailAddress')
+    generate_email_address
+  end
+
+  private
+
+  def send_get_emails_request(search_criteria)
+    r = ''
+    begin
+      Timeout::timeout(@timeout) {
+        until r.length > 2 && !r.nil?
+          r = RestClient.get("#{@base_uri}/emails", {:params => search_criteria})
+        end
+        r
+      }
+    rescue Timeout::Error
+      ''
+    end
   end
 end

data/lib/mailosaur/message_generator.rb

@@ -0,0 +1,31 @@
+class MessageGenerator
+  attr_accessor :message
+
+  def no_emails_found(data)
+    "\e[36m No emails were found for #{data} \e[0m\n\e[32m Try checking the params. \e[0m"
+  end
+
+  def new_syntax(method)
+    puts ":::::: Please use new syntax for #{method} ::::::\n
+          \e[36m @mailbox.#{look_ruby(method)}(params) \e[0m"
+  end
+
+  def sleep
+    puts "\e[36m Let's give the email some time to get there... \e[0m"
+  end
+
+  private
+
+  def look_ruby(method)
+    output = String.new
+    caps   = method.scan(/[A-Z]+/).map(&:downcase!)
+    other  = method.split(/[A-Z]+/)
+    a3 = other.join('_ ')
+    a4 = a3.split(' ')
+    words = ''
+    other.count.times do |i|
+      words << "#{a4[i]}#{caps[i]}"
+    end
+    words
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.1.1
 platform: ruby
 authors:
 - Clickity Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-22 00:00:00.000000000 Z
+date: 2016-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -88,6 +88,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/helper.rb
 - lib/mailosaur.rb
 - lib/mailosaur/attachment.rb
 - lib/mailosaur/email.rb
@@ -95,6 +96,7 @@ files:
 - lib/mailosaur/email_data.rb
 - lib/mailosaur/image.rb
 - lib/mailosaur/link.rb
+- lib/mailosaur/message_generator.rb
 homepage: http://mailosaur.com
 licenses:
 - MIT