mailosaur 5.0.20 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ac89c532d7f0519c3a2d620af601b75e7b83dffc3df92e842acb7de6610d2a1
-  data.tar.gz: f1dc7d047492d560f764fbf3f3ac7937e26a29f4ce163c744f017562cbba4e33
+  metadata.gz: ec06119b13b80148c1afc565e3aa3645d3784c2aec0772da7d2d43443b37cc18
+  data.tar.gz: d2fc23557ffab91c12b3bad70942212395f0d16beaf00feecf5f8914a8d77635
 SHA512:
-  metadata.gz: fc72c693120dc3a6730d96c7666a4100bd000a6ef237470df762737cc0bfb00a6b7979e5be9ba273e11a92dd8ab68e19a14dd42a83d6ed2ea9d14fe7d78e7eec
-  data.tar.gz: 8c6982baaee8c5c733ed3816440340a746606512acf1f0d1e523aca08f11129ffab06481ffef676f484273952460f86caa8b2fec529f959489e08f9d63322810
+  metadata.gz: 8c1212d6c8b230bb1944cd8066fd3498278206ddaae60c44844fc531ec11ddf9a6b800a34ce55403190f0fe873b51ffe30925904e4d7dd580ed7854ea18c2cf7
+  data.tar.gz: 6497b4bb404036491fe89bb5a3fb1e2c6ea81ae8e339e0ed986c69c0286a3852ffd535e97446c95a7ee765481782693c7d5a7ab69a78fb1f4b7a89400f516bca

data/lib/Mailosaur/messages.rb

@@ -12,6 +12,33 @@ module Mailosaur
     # @return [Connection] the client connection.
     attr_reader :conn
 
+    #
+    # Retrieve a message using search criteria
+    #
+    # Returns as soon as a message matching the specified search criteria is
+    # found. This is the most efficient method of looking up a message.
+    #
+    # @param server [String] The identifier of the server hosting the message.
+    # @param criteria [SearchCriteria] The search criteria to use in order to find
+    # a match.
+    # @param timeout [Integer] Specify how long to wait for a matching result 
+    # (in milliseconds).
+    # @param received_after [DateTime] Limits results to only messages received 
+    # after this date/time.
+    #
+    # @return [Message] operation results.
+    #
+    def get(server, criteria, timeout:10000, received_after:DateTime.now - (1.0/24))
+      # Defaults timeout to 10s, receivedAfter to 1h
+      if server.length > 8
+        raise Mailosaur::MailosaurError.new('Use get_by_id to retrieve a message using its identifier', nil)
+      end
+
+      result = search(server, criteria, timeout:timeout, received_after:received_after)
+      return get_by_id(result.items[0].id)
+    end
+    
+
     #
     # Retrieve a message
     #
@@ -22,7 +49,7 @@ module Mailosaur
     #
     # @return [Message] operation results.
     #
-    def get(id)
+    def get_by_id(id)
       response = conn.get 'api/messages/' + id
       
       unless response.status == 200
@@ -121,49 +148,51 @@ module Mailosaur
     # pagination.
     # @param items_per_page [Integer] A limit on the number of results to be
     # returned per page. Can be set between 1 and 1000 items, the default is 50.
+    # @param timeout [Integer] Specify how long to wait for a matching result 
+    # (in milliseconds).
+    # @param received_after [DateTime] Limits results to only messages received 
+    # after this date/time.
     #
     # @return [MessageListResult] operation results.
     #
-    def search(server, criteria, page:nil, items_per_page:nil)
+    def search(server, criteria, page:nil, items_per_page:nil, timeout:nil, received_after:nil)
       url = 'api/messages/search?server=' + server
-      url += page ? '&page=' + page : ''
-      url += items_per_page ? '&itemsPerPage=' + items_per_page : ''
-      
-      response = conn.post url, criteria.to_json
-      
-      unless response.status == 200
-        error_model = JSON.load(response.body)
-        mailosaur_error = Mailosaur::MailosaurError.new('Operation returned an invalid status code \'' + response.status.to_s + '\'', error_model)
-        raise mailosaur_error
-      end
-
-      model = JSON.load(response.body)
-      Mailosaur::Models::MessageListResult.new(model)
-    end
-
-    #
-    # Wait for a specific message
-    #
-    # Returns as soon as a message matching the specified search criteria is found.
-    # This is the most efficient method of looking up a message.
-    #
-    # @param server [String] The identifier of the server hosting the message.
-    # @param criteria [SearchCriteria] The search criteria to use in order to find
-    # a match.
-    #
-    # @return [Message] operation results.
-    #
-    def wait_for(server, criteria)
-      response = conn.post 'api/messages/await?server=' + server, criteria.to_json
-      
-      unless response.status == 200
-        error_model = JSON.load(response.body)
-        mailosaur_error = Mailosaur::MailosaurError.new('Operation returned an invalid status code \'' + response.status.to_s + '\'', error_model)
-        raise mailosaur_error
+      url += page ? '&page=' + page.to_s : ''
+      url += items_per_page ? '&itemsPerPage=' + items_per_page.to_s : ''
+      url += received_after ? '&receivedAfter=' + received_after.iso8601 : ''
+
+      poll_count = 0
+      start_time = Time.now.to_f
+
+      loop do      
+        response = conn.post url, criteria.to_json
+        
+        unless response.status == 200
+          error_model = JSON.load(response.body)
+          mailosaur_error = Mailosaur::MailosaurError.new('Operation returned an invalid status code \'' + response.status.to_s + '\'', error_model)
+          raise mailosaur_error
+        end
+
+        model = JSON.load(response.body)
+        if timeout.to_i == 0 || model['items'].length != 0
+          return Mailosaur::Models::MessageListResult.new(model)
+        end
+
+        delay_pattern = (response.headers['x-ms-delay'] || '1000').split(',').map{ |x| x.to_i }
+        
+        delay = poll_count >= delay_pattern.length ? 
+          delay_pattern[delay_pattern.length - 1] : 
+          delay_pattern[poll_count]
+          
+        poll_count += 1
+
+        ## Stop if timeout will be exceeded
+        if ((1000 * (Time.now.to_f - start_time).to_i) + delay) > timeout
+          raise Mailosaur::MailosaurError.new('No matching messages were found in time', nil)
+        end
+
+        sleep (delay / 1000)
       end
-
-      model = JSON.load(response.body)
-      Mailosaur::Models::Message.new(model)
     end
   end
 end

data/lib/Mailosaur/version.rb

@@ -1,3 +1,3 @@
 module Mailosaur
-    VERSION = '5.0.20'
+    VERSION = '6.0.0'
 end

data/lib/mailosaur.rb

@@ -6,6 +6,7 @@ require 'securerandom'
 require 'time'
 require 'faraday'
 require 'Mailosaur/module_definition'
+require 'Mailosaur/version'
 
 module Mailosaur
   autoload :Analysis,                                           'Mailosaur/analysis.rb'
@@ -33,7 +34,7 @@ module Mailosaur
     autoload :ServerListResult,                                   'Mailosaur/models/server_list_result.rb'
     autoload :SpamFilterResults,                                  'Mailosaur/models/spam_filter_results.rb'
     autoload :ServerCreateOptions,                                'Mailosaur/models/server_create_options.rb'
-autoload :BaseModel,                                              'Mailosaur/models/base_model.rb'
+    autoload :BaseModel,                                          'Mailosaur/models/base_model.rb'
   end
 
   class MailosaurClient
@@ -58,7 +59,7 @@ autoload :BaseModel,                                              'Mailosaur/mod
       conn = Faraday.new(base_url || 'https://mailosaur.com/', {
         :headers => {
           :content_type => 'application/json; charset=utf-8',
-          :user_agent => 'mailosaur-ruby/5.0.20'
+          :user_agent => 'mailosaur-ruby/' + Mailosaur::VERSION
         }
       })
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 5.0.20
+  version: 6.0.0
 platform: ruby
 authors:
 - Mailosaur Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-13 00:00:00.000000000 Z
+date: 2019-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Ruby client library for Mailosaur