mailosaur 7.0.1 → 7.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6e3bc63d01ecbecc505562a188a9b7c122b812d12a9b1e3437ace3b5348f6f5
-  data.tar.gz: be81cb74fddd57bbc539d4fb9c3723436e2b5af60d695413785d2f7c7ea6892e
+  metadata.gz: 433da61cccbbf2683597e2dca5da83d0db8d127189e1a780cb0d620994f8d625
+  data.tar.gz: 3a3d1d058f2d5a62bd728228e32d0a7c78f07e11cc755f29f295ae544ac26ca1
 SHA512:
-  metadata.gz: '058e76420f70a2525437f99b37e2ee0c9ebbb67330b1c3a9be36f5d650fb51e1839929be54f765719b7df71e002624b4223f949c5762452429ceb5f968f96dc3'
-  data.tar.gz: a176041bec46bec551bcaff33d9b01213aa5652d223629fa7028d9f73807c132d8770bba10b3b6a34af78600e4db9a34f7a6df8964a08f59b5690bf0834d00f6
+  metadata.gz: afa9cc3cdd1b0c37b5364673824ce6695c662036595c3eaca91dbc2a76c99622f729b28fa6cf3d796e834f98a908074aeb2c5c498de79ebf3669ec3b4e79d67e
+  data.tar.gz: 9a5f5e6a88e53c754032b4ef79ff59b61a859c9413f79da4b9992f6c5e7917ce56eeb8ffb3c09252a0c35775314f648fc1d8d5ffb0a9e29232c5285fbbff9bbc

data/lib/Mailosaur/messages.rb

@@ -132,10 +132,12 @@ module Mailosaur
     # (in milliseconds).
     # @param received_after [DateTime] Limits results to only messages received
     # after this date/time.
+    # @param error_on_timeout [Boolean] When set to false, an error will not be
+    # throw if timeout is reached (default: true).
     #
     # @return [MessageListResult] operation results.
     #
-    def search(server, criteria, page: nil, items_per_page: nil, timeout: nil, received_after: nil) # rubocop:disable all
+    def search(server, criteria, page: nil, items_per_page: nil, timeout: nil, received_after: nil, error_on_timeout: true) # rubocop:disable all
       url = 'api/messages/search?server=' + server
       url += page ? '&page=' + page.to_s : ''
       url += items_per_page ? '&itemsPerPage=' + items_per_page.to_s : ''
@@ -160,6 +162,8 @@ module Mailosaur
 
         ## Stop if timeout will be exceeded
         if ((1000 * (Time.now.to_f - start_time).to_i) + delay) > timeout
+          return Mailosaur::Models::MessageListResult.new(model) unless error_on_timeout
+
           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
 

data/lib/Mailosaur/models/server.rb

@@ -3,21 +3,15 @@ module Mailosaur
     class Server < BaseModel
       def initialize(data = {})
         @id = data['id']
-        @password = data['password']
         @name = data['name']
         @users = data['users']
         @messages = data['messages']
-        @forwarding_rules = []
-        (data['forwardingRules'] || []).each do |i| @forwarding_rules << Mailosaur::Models::ForwardingRule.new(i) end
       end
 
       # @return [String] Unique identifier for the server. Used as username for
       # SMTP/POP3 authentication.
       attr_accessor :id
 
-      # @return [String] SMTP/POP3 password.
-      attr_accessor :password
-
       # @return [String] A name used to identify the server.
       attr_accessor :name
 
@@ -26,10 +20,6 @@ module Mailosaur
 
       # @return [Integer] The number of messages currently in the server.
       attr_accessor :messages
-
-      # @return [Array<ForwardingRule>] The rules used to manage email
-      # forwarding for this server.
-      attr_accessor :forwarding_rules
     end
   end
 end

data/lib/Mailosaur/models/usage_account_limit.rb

@@ -0,0 +1,16 @@
+module Mailosaur
+  module Models
+    class UsageAccountLimit < BaseModel
+      def initialize(data = {})
+        @limit = data['limit']
+        @current = data['current']
+      end
+
+      # @return [Integer] The limit.
+      attr_accessor :limit
+
+      # @return [Integer] The current usage.
+      attr_accessor :current
+    end
+  end
+end

data/lib/Mailosaur/models/usage_account_limits.rb

@@ -0,0 +1,24 @@
+module Mailosaur
+  module Models
+    class UsageAccountLimits < BaseModel
+      def initialize(data = {})
+        @servers = Mailosaur::Models::UsageAccountLimit.new(data['servers'])
+        @users = Mailosaur::Models::UsageAccountLimit.new(data['users'])
+        @email = Mailosaur::Models::UsageAccountLimit.new(data['email'])
+        @sms = Mailosaur::Models::UsageAccountLimit.new(data['sms'])
+      end
+
+      # @return [UsageAccountLimit]
+      attr_accessor :servers
+
+      # @return [UsageAccountLimit]
+      attr_accessor :users
+
+      # @return [UsageAccountLimit]
+      attr_accessor :email
+
+      # @return [UsageAccountLimit]
+      attr_accessor :sms
+    end
+  end
+end

data/lib/Mailosaur/models/usage_transaction.rb

@@ -0,0 +1,20 @@
+module Mailosaur
+  module Models
+    class UsageTransaction < BaseModel
+      def initialize(data = {})
+        @timestamp = DateTime.parse(data['timestamp'])
+        @email = data['email']
+        @sms = data['sms']
+      end
+
+      # @return [DateTime] The datetime that this transaction occurred.
+      attr_accessor :timestamp
+
+      # @return [Integer] The count of emails.
+      attr_accessor :email
+
+      # @return [Integer] The count of SMS messages.
+      attr_accessor :sms
+    end
+  end
+end

data/lib/Mailosaur/models/usage_transaction_list_result.rb

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

data/lib/Mailosaur/servers.rb

@@ -60,6 +60,23 @@ module Mailosaur
       Mailosaur::Models::Server.new(model)
     end
 
+    #
+    # Retrieve server password
+    #
+    # Retrieves the password for use with SMTP and POP3 for a single server.
+    # Simply supply the unique identifier for the required server.
+    #
+    # @param id [String] The identifier of the server.
+    #
+    # @return [String] Server password.
+    #
+    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['value']
+    end
+
     #
     # Update a server
     #
@@ -92,8 +109,8 @@ module Mailosaur
     end
 
     def generate_email_address(server)
-      host = ENV['MAILOSAUR_SMTP_HOST'] || 'mailosaur.io'
-      '%s.%s@%s' % [SecureRandom.hex(3), server, host]
+      host = ENV['MAILOSAUR_SMTP_HOST'] || 'mailosaur.net'
+      '%s@%s.%s' % [SecureRandom.hex(3), server, host]
     end
   end
 end

data/lib/Mailosaur/usage.rb

@@ -0,0 +1,41 @@
+module Mailosaur
+  class Usage
+    #
+    # Creates and initializes a new instance of the Usage 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
+
+    #
+    # Retrieve account usage limits.
+    #
+    # Details the current limits and usage for your account.
+    #
+    # @return [UsageAccountLimits] operation results.
+    #
+    def limits
+      response = conn.get 'api/usage/limits'
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.load(response.body)
+      Mailosaur::Models::UsageAccountLimits.new(model)
+    end
+
+    #
+    # List account transactions. Retrieves the last 31 days of transactional usage.
+    #
+    # @return [UsageTransactionListResult] operation results.
+    #
+    def transactions
+      response = conn.get 'api/usage/transactions'
+      @handle_http_error.call(response) unless response.status == 200
+      model = JSON.load(response.body)
+      Mailosaur::Models::UsageTransactionListResult.new(model)
+    end
+  end
+end

data/lib/Mailosaur/version.rb

@@ -1,3 +1,3 @@
 module Mailosaur
-    VERSION = '7.0.1'.freeze
+    VERSION = '7.3.0'.freeze
 end

data/lib/mailosaur.rb

@@ -13,6 +13,7 @@ module Mailosaur
   autoload :Files,                                              'Mailosaur/files.rb'
   autoload :Messages,                                           'Mailosaur/messages.rb'
   autoload :Servers,                                            'Mailosaur/servers.rb'
+  autoload :Usage,                                              'Mailosaur/usage.rb'
   autoload :MailosaurError,                                     'Mailosaur/mailosaur_error.rb'
 
   module Models
@@ -27,13 +28,16 @@ module Mailosaur
     autoload :MessageListResult,                                  'Mailosaur/models/message_list_result.rb'
     autoload :Attachment,                                         'Mailosaur/models/attachment.rb'
     autoload :SearchCriteria,                                     'Mailosaur/models/search_criteria.rb'
-    autoload :ForwardingRule,                                     'Mailosaur/models/forwarding_rule.rb'
     autoload :MessageContent,                                     'Mailosaur/models/message_content.rb'
     autoload :Server,                                             'Mailosaur/models/server.rb'
     autoload :Link,                                               'Mailosaur/models/link.rb'
     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 :UsageAccountLimits,                                 'Mailosaur/models/usage_account_limits.rb'
+    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 :BaseModel,                                          'Mailosaur/models/base_model.rb'
   end
 
@@ -68,6 +72,11 @@ module Mailosaur
       @servers ||= Servers.new(connection, method(:handle_http_error))
     end
 
+    # @return [Usage] usage
+    def usage
+      @usage ||= Usage.new(connection, method(:handle_http_error))
+    end
+
     private
 
     def connection

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailosaur
 version: !ruby/object:Gem::Version
-  version: 7.0.1
+  version: 7.3.0
 platform: ruby
 authors:
 - Mailosaur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -159,7 +159,6 @@ files:
 - lib/Mailosaur/messages.rb
 - lib/Mailosaur/models/attachment.rb
 - lib/Mailosaur/models/base_model.rb
-- lib/Mailosaur/models/forwarding_rule.rb
 - lib/Mailosaur/models/image.rb
 - lib/Mailosaur/models/link.rb
 - lib/Mailosaur/models/message.rb
@@ -176,8 +175,13 @@ files:
 - lib/Mailosaur/models/spam_analysis_result.rb
 - lib/Mailosaur/models/spam_assassin_rule.rb
 - lib/Mailosaur/models/spam_filter_results.rb
+- lib/Mailosaur/models/usage_account_limit.rb
+- lib/Mailosaur/models/usage_account_limits.rb
+- lib/Mailosaur/models/usage_transaction.rb
+- lib/Mailosaur/models/usage_transaction_list_result.rb
 - lib/Mailosaur/module_definition.rb
 - lib/Mailosaur/servers.rb
+- lib/Mailosaur/usage.rb
 - lib/Mailosaur/version.rb
 - lib/mailosaur.rb
 homepage: https://mailosaur.com/
@@ -204,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: The Mailosaur Ruby library

data/lib/Mailosaur/models/forwarding_rule.rb

@@ -1,25 +0,0 @@
-module Mailosaur
-  module Models
-    class ForwardingRule < BaseModel
-      def initialize(data = {})
-        @field = data['field']
-        @operator = data['operator']
-        @value = data['value']
-        @forward_to = data['forwardTo']
-      end
-
-      # @return [Enum] Possible values include: 'from', 'to', 'subject'
-      attr_accessor :field
-
-      # @return [Enum] Possible values include: 'endsWith', 'startsWith',
-      # 'contains'
-      attr_accessor :operator
-
-      # @return [String]
-      attr_accessor :value
-
-      # @return [String]
-      attr_accessor :forward_to
-    end
-  end
-end