mailosaur 7.7.0 → 7.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f91c18a443ec50a2034fab26e92fef85673a3aa5c4afde59f95763ca6c84b26f
-  data.tar.gz: 8a0ecf04c844630ac316548778135e6f0ba36ae0302b05bfd7c1b81c16bc05cf
+  metadata.gz: 7dfdb822b3d29505aeb7067c60e791373a77f20cc6f1c4e95b4323e6cf1a65f3
+  data.tar.gz: 35d5c43fefa421955864f81150a66480bdbbf30414cab12155b275c36513a697
 SHA512:
-  metadata.gz: 5bfab6fd07260d62159be23a80d8196fe73c2f7fba2b756ccf1e7d9b9b26ec7d50dfd7fd01b065830e3fc4c0e62ef656343b6478dcc419dbcea1c03c769d8cde
-  data.tar.gz: 837c2559149390868a1928ec653df6083b86b8830b8280687ad5dd8e2661e275943ed6bf0a7b8aaeccfa6665817b945e0767124236f94611980fdf2ea8281c9e
+  metadata.gz: '069da6916260150acf8b993f768140933951e4c5957a0d690a91a45259d6b1c38a7ba51bde1c81f26bef64b213efc7b9a95d1a1cce20e8648c6b60fa62aa484e'
+  data.tar.gz: f7c9ecede2e30ea41814656c766972bedb9bc9505b6ac7c787e4e3e47405393a01c0e62f7164c60e49a90420532ebd1bd36c6983c23a2289ff087b609ca4aa98

data/lib/Mailosaur/analysis.rb

@@ -24,7 +24,7 @@ module Mailosaur
     def spam(email)
       response = conn.get "api/analysis/spam/#{email}"
       @handle_http_error.call(response) unless response.status == 200
-      model = JSON.load(response.body)
+      model = JSON.parse(response.body)
       Mailosaur::Models::SpamAnalysisResult.new(model)
     end
   end

data/lib/Mailosaur/devices.rb

@@ -0,0 +1,83 @@
+module Mailosaur
+  class Devices
+    #
+    # Creates and initializes a new instance of the Devices class.
+    # @param client connection.
+    #
+    def initialize(conn, handle_http_error)
+      @conn = conn
+      @handle_http_error = handle_http_error
+    end
+
+    # @return [Connection] the client connection.
+    attr_reader :conn
+
+    #
+    # List all devices
+    #
+    # Returns a list of your virtual security devices.
+    #
+    # @return [DeviceListResult] operation results.
+    #
+    def list
+      response = conn.get 'api/devices'
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.parse(response.body)
+      Mailosaur::Models::DeviceListResult.new(model)
+    end
+
+    #
+    # Create a device
+    #
+    # Creates a new virtual security device and returns it.
+    #
+    # @param device_create_options [DeviceCreateOptions]
+    #
+    # @return [Device] operation results.
+    #
+    def create(device_create_options)
+      response = conn.post 'api/devices', device_create_options.to_json
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.parse(response.body)
+      Mailosaur::Models::Device.new(model)
+    end
+
+    #
+    # Retrieve OTP
+    #
+    # Retrieves the current one-time password for a saved device, or given base32-encoded shared secret.
+    #
+    # @param query [String] Either the unique identifier of the device, or a base32-encoded shared secret.
+    #
+    # @return [OtpResult] operation results.
+    #
+    def otp(query)
+      if query.include? '-'
+        response = conn.get "api/devices/#{query}/otp"
+        @handle_http_error.call(response) unless response.status == 200
+        model = JSON.parse(response.body)
+        return Mailosaur::Models::OtpResult.new(model)
+      end
+
+      options = Mailosaur::Models::DeviceCreateOptions.new
+      options.shared_secret = query
+      response = conn.post 'api/devices/otp', options.to_json
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.parse(response.body)
+      Mailosaur::Models::OtpResult.new(model)
+    end
+
+    #
+    # Delete a device
+    #
+    # Permanently deletes a device. This operation cannot be undone.
+    #
+    # @param id [String] The identifier of the device to be deleted.
+    #
+    def delete(id)
+      response = conn.delete "api/devices/#{id}"
+      @handle_http_error.call(response) unless response.status == 204
+      nil
+    end
+  end
+end

data/lib/Mailosaur/messages.rb

@@ -51,7 +51,7 @@ module Mailosaur
     def get_by_id(id)
       response = conn.get "api/messages/#{id}"
       @handle_http_error.call(response) unless response.status == 200
-      model = JSON.load(response.body)
+      model = JSON.parse(response.body)
       Mailosaur::Models::Message.new(model)
     end
 
@@ -96,7 +96,7 @@ module Mailosaur
 
       @handle_http_error.call(response) unless response.status == 200
 
-      model = JSON.load(response.body)
+      model = JSON.parse(response.body)
       Mailosaur::Models::MessageListResult.new(model)
     end
 
@@ -137,7 +137,7 @@ module Mailosaur
     #
     # @return [MessageListResult] operation results.
     #
-    def search(server, criteria, page: nil, items_per_page: nil, timeout: nil, received_after: nil, error_on_timeout: true) # rubocop:disable all
+    def search(server, criteria, page: nil, items_per_page: nil, timeout: nil, received_after: nil, error_on_timeout: true)
       url = "api/messages/search?server=#{server}"
       url += page ? "&page=#{page}" : ''
       url += items_per_page ? "&itemsPerPage=#{items_per_page}" : ''
@@ -151,7 +151,7 @@ module Mailosaur
 
         @handle_http_error.call(response) unless response.status == 200
 
-        model = JSON.load(response.body)
+        model = JSON.parse(response.body)
         return Mailosaur::Models::MessageListResult.new(model) if timeout.to_i.zero? || !model['items'].empty?
 
         delay_pattern = (response.headers['x-ms-delay'] || '1000').split(',').map(&:to_i)
@@ -186,7 +186,7 @@ module Mailosaur
     def create(server, message_create_options)
       response = conn.post "api/messages?server=#{server}", message_create_options.to_json
       @handle_http_error.call(response) unless response.status == 200
-      model = JSON.load(response.body)
+      model = JSON.parse(response.body)
       Mailosaur::Models::Message.new(model)
     end
 
@@ -204,7 +204,7 @@ module Mailosaur
     def forward(id, message_forward_options)
       response = conn.post "api/messages/#{id}/forward", message_forward_options.to_json
       @handle_http_error.call(response) unless response.status == 200
-      model = JSON.load(response.body)
+      model = JSON.parse(response.body)
       Mailosaur::Models::Message.new(model)
     end
 
@@ -223,7 +223,7 @@ module Mailosaur
     def reply(id, message_reply_options)
       response = conn.post "api/messages/#{id}/reply", message_reply_options.to_json
       @handle_http_error.call(response) unless response.status == 200
-      model = JSON.load(response.body)
+      model = JSON.parse(response.body)
       Mailosaur::Models::Message.new(model)
     end
   end

data/lib/Mailosaur/models/device.rb

@@ -0,0 +1,16 @@
+module Mailosaur
+  module Models
+    class Device < BaseModel
+      def initialize(data = {})
+        @id = data['id']
+        @name = data['name']
+      end
+
+      # @return [String] Unique identifier for the device.
+      attr_accessor :id
+
+      # @return [String] The name of the device.
+      attr_accessor :name
+    end
+  end
+end

data/lib/Mailosaur/models/device_create_options.rb

@@ -0,0 +1,16 @@
+module Mailosaur
+  module Models
+    class DeviceCreateOptions < BaseModel
+      def initialize(data = {})
+        @name = data['name']
+        @shared_secret = data['shared_secret']
+      end
+
+      # @return [String] A name used to identify the device.
+      attr_accessor :name
+
+      # @return [String] The base32-encoded shared secret for this device.
+      attr_accessor :shared_secret
+    end
+  end
+end

data/lib/Mailosaur/models/device_list_result.rb

@@ -0,0 +1,13 @@
+module Mailosaur
+  module Models
+    class DeviceListResult < BaseModel
+      def initialize(data = {})
+        @items = []
+        (data['items'] || []).each { |i| @items << Mailosaur::Models::Device.new(i) }
+      end
+
+      # @return [Array<Device>] The individual devices forming the result.
+      attr_accessor :items
+    end
+  end
+end

data/lib/Mailosaur/models/otp_result.rb

@@ -0,0 +1,16 @@
+module Mailosaur
+  module Models
+    class OtpResult < BaseModel
+      def initialize(data = {})
+        @code = data['code']
+        @expires = data['expires']
+      end
+
+      # @return [String] The current one-time password.
+      attr_accessor :code
+
+      # @return [String] The expiry date/time of the current one-time password.
+      attr_accessor :expires
+    end
+  end
+end

data/lib/Mailosaur/servers.rb

@@ -23,7 +23,7 @@ module Mailosaur
     def list
       response = conn.get 'api/servers'
       @handle_http_error.call(response) unless response.status == 200
-      model = JSON.load(response.body)
+      model = JSON.parse(response.body)
       Mailosaur::Models::ServerListResult.new(model)
     end
 
@@ -39,7 +39,7 @@ module Mailosaur
     def create(server_create_options)
       response = conn.post 'api/servers', server_create_options.to_json
       @handle_http_error.call(response) unless response.status == 200
-      model = JSON.load(response.body)
+      model = JSON.parse(response.body)
       Mailosaur::Models::Server.new(model)
     end
 
@@ -56,7 +56,7 @@ module Mailosaur
     def get(id)
       response = conn.get "api/servers/#{id}"
       @handle_http_error.call(response) unless response.status == 200
-      model = JSON.load(response.body)
+      model = JSON.parse(response.body)
       Mailosaur::Models::Server.new(model)
     end
 
@@ -73,7 +73,7 @@ module Mailosaur
     def get_password(id)
       response = conn.get "api/servers/#{id}/password"
       @handle_http_error.call(response) unless response.status == 200
-      model = JSON.load(response.body)
+      model = JSON.parse(response.body)
       model['value']
     end
 
@@ -90,7 +90,7 @@ module Mailosaur
     def update(id, server)
       response = conn.put "api/servers/#{id}", server.to_json
       @handle_http_error.call(response) unless response.status == 200
-      model = JSON.load(response.body)
+      model = JSON.parse(response.body)
       Mailosaur::Models::Server.new(model)
     end
 
@@ -110,7 +110,7 @@ module Mailosaur
 
     def generate_email_address(server)
       host = ENV['MAILOSAUR_SMTP_HOST'] || 'mailosaur.net'
-      '%s@%s.%s' % [SecureRandom.hex(3), server, host]
+      format('%s@%s.%s', SecureRandom.hex(3), server, host)
     end
   end
 end

data/lib/Mailosaur/usage.rb

@@ -22,7 +22,7 @@ module Mailosaur
     def limits
       response = conn.get 'api/usage/limits'
       @handle_http_error.call(response) unless response.status == 200
-      model = JSON.load(response.body)
+      model = JSON.parse(response.body)
       Mailosaur::Models::UsageAccountLimits.new(model)
     end
 
@@ -34,7 +34,7 @@ module Mailosaur
     def transactions
       response = conn.get 'api/usage/transactions'
       @handle_http_error.call(response) unless response.status == 200
-      model = JSON.load(response.body)
+      model = JSON.parse(response.body)
       Mailosaur::Models::UsageTransactionListResult.new(model)
     end
   end

data/lib/Mailosaur/version.rb

@@ -1,3 +1,3 @@
 module Mailosaur
-    VERSION = '7.7.0'.freeze
+    VERSION = '7.10.0'.freeze
 end

data/lib/mailosaur.rb

@@ -14,6 +14,7 @@ module Mailosaur
   autoload :Messages,                                           'Mailosaur/messages.rb'
   autoload :Servers,                                            'Mailosaur/servers.rb'
   autoload :Usage,                                              'Mailosaur/usage.rb'
+  autoload :Devices,                                            'Mailosaur/devices.rb'
   autoload :MailosaurError,                                     'Mailosaur/mailosaur_error.rb'
 
   module Models
@@ -42,6 +43,10 @@ module Mailosaur
     autoload :UsageAccountLimit,                                  'Mailosaur/models/usage_account_limit.rb'
     autoload :UsageTransactionListResult,                         'Mailosaur/models/usage_transaction_list_result.rb'
     autoload :UsageTransaction,                                   'Mailosaur/models/usage_transaction.rb'
+    autoload :Device,                                             'Mailosaur/models/device.rb'
+    autoload :DeviceListResult,                                   'Mailosaur/models/device_list_result.rb'
+    autoload :DeviceCreateOptions,                                'Mailosaur/models/device_create_options.rb'
+    autoload :OtpResult,                                          'Mailosaur/models/otp_result.rb'
     autoload :BaseModel,                                          'Mailosaur/models/base_model.rb'
   end
 
@@ -81,6 +86,11 @@ module Mailosaur
       @usage ||= Usage.new(connection, method(:handle_http_error))
     end
 
+    # @return [Devices] usage
+    def devices
+      @devices ||= Devices.new(connection, method(:handle_http_error))
+    end
+
     private
 
     def connection
@@ -89,19 +99,37 @@ module Mailosaur
           content_type: 'application/json; charset=utf-8',
           user_agent: "mailosaur-ruby/#{Mailosaur::VERSION}"
         }
-      }).tap { |conn| conn.request(:basic_auth, @api_key, '') }
+      }).tap do |conn|
+        case Faraday::VERSION
+        when /^0/
+          conn.basic_auth @api_key, ''
+        when /^1/
+          conn.request(:basic_auth, @api_key, '')
+        else
+          conn.request(:authorization, :basic, @api_key, '')
+        end
+      end
     end
 
     def handle_http_error(response)
+      message = ''
       case response.status
       when 400
-        raise Mailosaur::MailosaurError.new('Request had one or more invalid parameters.', 'invalid_request', response.status, response.body)
+        begin
+          json = JSON.parse(response.body)
+          json['errors'].each do |err|
+            message += format('(%s) %s\r\n', err['field'], err['detail'][0]['description'])
+          end
+        rescue StandardError
+          message = 'Request had one or more invalid parameters.'
+        end
+        raise Mailosaur::MailosaurError.new(message, '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)
+        raise Mailosaur::MailosaurError.new('Not found, check input parameters.', '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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 7.7.0
+  version: 7.10.0
 platform: ruby
 authors:
 - Mailosaur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
+date: 2022-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -56,20 +56,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.1
+        version: 2.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.1
+        version: 2.7.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -90,54 +90,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.30.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.30.0
 - !ruby/object:Gem::Dependency
   name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.7
+        version: 3.5.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.7
+        version: 3.5.3
 description: The Mailosaur Ruby library lets you integrate email and SMS testing into
   your continuous integration process.
 email: code@mailosaur.com
@@ -148,12 +148,16 @@ files:
 - LICENSE
 - README.md
 - lib/Mailosaur/analysis.rb
+- lib/Mailosaur/devices.rb
 - lib/Mailosaur/files.rb
 - lib/Mailosaur/mailosaur_error.rb
 - lib/Mailosaur/messages.rb
 - lib/Mailosaur/models/attachment.rb
 - lib/Mailosaur/models/base_model.rb
 - lib/Mailosaur/models/code.rb
+- lib/Mailosaur/models/device.rb
+- lib/Mailosaur/models/device_create_options.rb
+- lib/Mailosaur/models/device_list_result.rb
 - lib/Mailosaur/models/image.rb
 - lib/Mailosaur/models/link.rb
 - lib/Mailosaur/models/message.rb
@@ -166,6 +170,7 @@ files:
 - lib/Mailosaur/models/message_reply_options.rb
 - lib/Mailosaur/models/message_summary.rb
 - lib/Mailosaur/models/metadata.rb
+- lib/Mailosaur/models/otp_result.rb
 - lib/Mailosaur/models/search_criteria.rb
 - lib/Mailosaur/models/server.rb
 - lib/Mailosaur/models/server_create_options.rb
@@ -206,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: The Mailosaur Ruby library