mailosaur 6.0.6 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93384f72178b70f3cbf990d30be7d7110ede5b6e81338486d019b041d10b829c
-  data.tar.gz: 5b7342050cd44184dab1ffdf453c7eac88c12ccfae420dccab9f19b29aca66f7
+  metadata.gz: 7ded354d904892b5edb18803695bda97a368a55bcf8bee8f1b3f7cc3d54223a8
+  data.tar.gz: 5e7e2e660129a7c4067d1ef74075f3f1be5e2ca8a78411199acb77b3c6b2352d
 SHA512:
-  metadata.gz: 57d70f504d3b930d4d017a82c6de18cb89d6b9518219a9c5fb3b3cde1ab386f082977aba014ef698afb0052d07a79305738c9b531afcb8c0ad37acb711945ac5
-  data.tar.gz: ce5fc8101e3eff75a329c775fafe54b9615f81a928fde391e8932129ade0f90023c8352551f616e612c06d4b7f661a48e4ec940cc3de6b570ce97ce075ceac77
+  metadata.gz: c2217d5763f88bc5c4d8a5f769ab327c0a31e1e781300a8cff5fb264297568c05e664c4d431359b49cc401e1756b9a52e070d71a87489822da0069aaf3bf8d9c
+  data.tar.gz: a489db754706165b9c1a5637d73bd5fd5ab236c3fdfa81f6fe25e36d534b789425290e1c63d33107c0a79bc177e1eb20ee93101b3ab0dc8a18d7b99a6814b465

data/lib/Mailosaur/analysis.rb

@@ -4,8 +4,9 @@ module Mailosaur
     # Creates and initializes a new instance of the Analysis class.
     # @param conn client connection.
     #
-    def initialize(conn)
+    def initialize(conn, handle_http_error)
       @conn = conn
+      @handle_http_error = handle_http_error
     end
 
     # @return [Connection] the client connection.
@@ -22,13 +23,7 @@ module Mailosaur
     #
     def spam(email)
       response = conn.get 'api/analysis/spam/' + email
-
-      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
-
+      @handle_http_error.call(response) unless response.status == 200
       model = JSON.load(response.body)
       Mailosaur::Models::SpamAnalysisResult.new(model)
     end

data/lib/Mailosaur/files.rb

@@ -4,8 +4,9 @@ module Mailosaur
     # Creates and initializes a new instance of the Files class.
     # @param client connection.
     #
-    def initialize(conn)
+    def initialize(conn, handle_http_error)
       @conn = conn
+      @handle_http_error = handle_http_error
     end
 
     # @return [Connection] the client connection.
@@ -23,13 +24,7 @@ module Mailosaur
     #
     def get_attachment(id)
       response = conn.get 'api/files/attachments/' + id
-
-      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
-
+      @handle_http_error.call(response) unless response.status == 200
       response.body
     end
 
@@ -45,13 +40,7 @@ module Mailosaur
     #
     def get_email(id)
       response = conn.get 'api/files/email/' + id
-
-      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
-
+      @handle_http_error.call(response) unless response.status == 200
       response.body
     end
   end

data/lib/Mailosaur/mailosaur_error.rb

@@ -1,23 +1,15 @@
-require 'json'
-
 module Mailosaur
   class MailosaurError < StandardError
-    attr_reader :type
-    attr_reader :messages
-    attr_reader :model
+    attr_reader :error_type
+    attr_reader :http_status_code
+    attr_reader :http_response_body
 
-    def initialize(message, error_model)
+    def initialize(message = '', error_type = '', http_status_code = nil, http_response_body = nil)
       super(message)
 
-      @type = nil
-      @messages = nil
-      @model = nil
-
-      unless error_model.nil?
-        @type = error_model['type']
-        @messages = error_model['messages']
-        @model = error_model['model']
-      end
+      @error_type = error_type
+      @http_status_code = http_status_code
+      @http_response_body = http_response_body
     end
   end
 end

data/lib/Mailosaur/messages.rb

@@ -6,8 +6,9 @@ module Mailosaur
     # Creates and initializes a new instance of the Messages class.
     # @param client connection.
     #
-    def initialize(conn)
+    def initialize(conn, handle_http_error)
       @conn = conn
+      @handle_http_error = handle_http_error
     end
 
     # @return [Connection] the client connection.
@@ -31,7 +32,7 @@ module Mailosaur
     #
     def get(server, criteria, timeout: 10_000, received_after: DateTime.now - (1.0 / 24))
       # Defaults timeout to 10s, receivedAfter to 1h
-      raise Mailosaur::MailosaurError.new('Use get_by_id to retrieve a message using its identifier', nil) if server.length > 8
+      raise Mailosaur::MailosaurError.new('Must provide a valid Server ID.', 'invalid_request') if server.length != 8
 
       result = search(server, criteria, timeout: timeout, received_after: received_after)
       get_by_id(result.items[0].id)
@@ -49,13 +50,7 @@ module Mailosaur
     #
     def get_by_id(id)
       response = conn.get 'api/messages/' + id
-
-      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
-
+      @handle_http_error.call(response) unless response.status == 200
       model = JSON.load(response.body)
       Mailosaur::Models::Message.new(model)
     end
@@ -70,13 +65,7 @@ module Mailosaur
     #
     def delete(id)
       response = conn.delete 'api/messages/' + id
-
-      unless response.status == 204
-        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
-
+      @handle_http_error.call(response) unless response.status == 204
       nil
     end
 
@@ -99,17 +88,13 @@ module Mailosaur
     #
     def list(server, page: nil, items_per_page: nil, received_after: nil)
       url = 'api/messages?server=' + server
-      url += page ? '&page=' + page : ''
-      url += items_per_page ? '&itemsPerPage=' + items_per_page : ''
+      url += page ? '&page=' + page.to_s : ''
+      url += items_per_page ? '&itemsPerPage=' + items_per_page.to_s : ''
       url += received_after ? '&receivedAfter=' + CGI.escape(received_after.iso8601) : ''
 
       response = conn.get url
 
-      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
+      @handle_http_error.call(response) unless response.status == 200
 
       model = JSON.load(response.body)
       Mailosaur::Models::MessageListResult.new(model)
@@ -125,13 +110,7 @@ module Mailosaur
     #
     def delete_all(server)
       response = conn.delete 'api/messages?server=' + server
-
-      unless response.status == 204
-        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
-
+      @handle_http_error.call(response) unless response.status == 204
       nil
     end
 
@@ -168,11 +147,7 @@ module Mailosaur
       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) # rubocop:disable Metrics/LineLength
-          raise mailosaur_error
-        end
+        @handle_http_error.call(response) unless response.status == 200
 
         model = JSON.load(response.body)
         return Mailosaur::Models::MessageListResult.new(model) if timeout.to_i.zero? || !model['items'].empty?
@@ -185,7 +160,7 @@ module Mailosaur
 
         ## 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)
+          raise Mailosaur::MailosaurError.new('No matching messages found in time. By default, only messages received in the last hour are checked (use receivedAfter to override this).', 'search_timeout')
         end
 
         sleep(delay / 1000)

data/lib/Mailosaur/servers.rb

@@ -4,8 +4,9 @@ module Mailosaur
     # Creates and initializes a new instance of the Servers class.
     # @param client connection.
     #
-    def initialize(conn)
+    def initialize(conn, handle_http_error)
       @conn = conn
+      @handle_http_error = handle_http_error
     end
 
     # @return [Connection] the client connection.
@@ -21,13 +22,7 @@ module Mailosaur
     #
     def list
       response = conn.get 'api/servers'
-
-      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
-
+      @handle_http_error.call(response) unless response.status == 200
       model = JSON.load(response.body)
       Mailosaur::Models::ServerListResult.new(model)
     end
@@ -43,13 +38,7 @@ module Mailosaur
     #
     def create(server_create_options)
       response = conn.post 'api/servers', server_create_options.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
-
+      @handle_http_error.call(response) unless response.status == 200
       model = JSON.load(response.body)
       Mailosaur::Models::Server.new(model)
     end
@@ -66,13 +55,7 @@ module Mailosaur
     #
     def get(id)
       response = conn.get 'api/servers/' + id
-
-      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
-
+      @handle_http_error.call(response) unless response.status == 200
       model = JSON.load(response.body)
       Mailosaur::Models::Server.new(model)
     end
@@ -89,13 +72,7 @@ module Mailosaur
     #
     def update(id, server)
       response = conn.put 'api/servers/' + id, server.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
-
+      @handle_http_error.call(response) unless response.status == 200
       model = JSON.load(response.body)
       Mailosaur::Models::Server.new(model)
     end
@@ -110,13 +87,7 @@ module Mailosaur
     #
     def delete(id)
       response = conn.delete 'api/servers/' + id
-
-      unless response.status == 204
-        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
-
+      @handle_http_error.call(response) unless response.status == 204
       nil
     end
 

data/lib/Mailosaur/version.rb

@@ -1,3 +1,3 @@
 module Mailosaur
-    VERSION = '6.0.6'.freeze
+    VERSION = '7.0.0'.freeze
 end

data/lib/mailosaur.rb

@@ -50,22 +50,22 @@ module Mailosaur
 
     # @return [Analysis] analysis
     def analysis
-      @analysis ||= Analysis.new(connection)
+      @analysis ||= Analysis.new(connection, method(:handle_http_error))
     end
 
     # @return [Files] files
     def files
-      @files ||= Files.new(connection)
+      @files ||= Files.new(connection, method(:handle_http_error))
     end
 
     # @return [Messages] messages
     def messages
-      @messages ||= Messages.new(connection)
+      @messages ||= Messages.new(connection, method(:handle_http_error))
     end
 
     # @return [Servers] servers
     def servers
-      @servers ||= Servers.new(connection)
+      @servers ||= Servers.new(connection, method(:handle_http_error))
     end
 
     private
@@ -78,5 +78,20 @@ module Mailosaur
         }
       }).tap { |conn| conn.basic_auth(@api_key, '') }
     end
+
+    def handle_http_error(response)
+      case response.status
+      when 400
+        raise Mailosaur::MailosaurError.new('Request had one or more invalid parameters.', 'invalid_request', response.status, response.body)
+      when 401
+        raise Mailosaur::MailosaurError.new('Authentication failed, check your API key.', 'authentication_error', response.status, response.body)
+      when 403
+        raise Mailosaur::MailosaurError.new('Insufficient permission to perform that task.', 'permission_error', response.status, response.body)
+      when 404
+        raise Mailosaur::MailosaurError.new('Request did not find any matching resources.', 'invalid_request', response.status, response.body)
+      else
+        raise Mailosaur::MailosaurError.new('An API error occurred, see httpResponse for further information.', 'api_error', response.status, response.body)
+      end
+    end
   end
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 6.0.6
+  version: 7.0.0
 platform: ruby
 authors:
-- Mailosaur Ltd
+- Mailosaur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.0
     - - "<="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.0
     - - "<="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.5
     - - "<="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.7.5
     - - "<="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.5
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -74,22 +74,22 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -144,7 +144,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.7
-description: Ruby client library for Mailosaur.
+description: The Mailosaur Ruby library lets you integrate email and SMS testing into
+  your continuous integration process.
 email: code@mailosaur.com
 executables: []
 extensions: []
@@ -179,10 +180,15 @@ files:
 - lib/Mailosaur/servers.rb
 - lib/Mailosaur/version.rb
 - lib/mailosaur.rb
-homepage: https://mailosaur.com
+homepage: https://mailosaur.com/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/mailosaur/mailosaur-ruby/issues
+  documentation_uri: https://mailosaur.com/docs/email-testing/ruby/
+  github_repo: ssh://github.com/mailosaur/mailosaur-ruby
+  homepage_uri: https://mailosaur.com/
+  source_code_uri: https://github.com/mailosaur/mailosaur-ruby
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -198,8 +204,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Ruby client library for Mailosaur
+summary: The Mailosaur Ruby library
 test_files: []