mailosaur 3.0.1 → 5.0.1.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb60832dfc4f6ea5c42450e1733c30e8ceac6441
-  data.tar.gz: c3765814b8c70be32e9836257168bbf1b8d2b636
+  metadata.gz: 2772f46b22f0d06dc15d344da11a920d4ef5e0a3
+  data.tar.gz: f15a8d95db05af6cdc6a7adc0349f6b2848a11a6
 SHA512:
-  metadata.gz: 12e972454e095c55a67202c8224b8ee159a54bc579522322c6cb41a1130d955bc83fb135bf27d0110546316a7b11feafb5d12dbe7d614fbf1b274db0d3d16f77
-  data.tar.gz: 1393cc44adeff1ee9e0e1ba7bfa1a59d87398a87694850776a1dd0b7313e8959d8e022fc3270dbf0fd68d7463e879fe16869f4145f61b676da85a2ed3a9d9630
+  metadata.gz: 06123714d9199f2cde600f72f7fe15514110df7e2d0e917976fa1e2f4f9d61970440d48eddeb9a143174d84affbfdc181f17b0fc64b1d1573d73c33be048dfff
+  data.tar.gz: 53983c63b008a4a0719830c49cd3817ce8216c8b4c8ef11656ae7d38dd5ce9bac729d0f7c02687239601c17f92d6496f4d1d02935b730c27e82754635c8069e5

data/LICENSE

@@ -1,20 +1,21 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2014 Mailosaur Ltd (https://mailosaur.com)
+Copyright (c) 2018 Mailosaur Ltd (https://mailosaur.com)
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -14,6 +14,45 @@ gem install mailosaur
 
 [Mailosaur's documentation](https://mailosaur.com/docs) includes all the information and usage examples you'll need.
 
+## Building
+
+1. Install [Node.js](https://nodejs.org/) (LTS)
+
+2. Install [AutoRest](https://github.com/Azure/autorest) using `npm`
+
+```
+# Depending on your configuration you may need to be elevated or root to run this. (on OSX/Linux use 'sudo')
+npm install -g autorest
+```
+
+3. Run the build script
+
+```
+./build.sh
+```
+
+### AutoRest Configuration
+
+This project uses [AutoRest](https://github.com/Azure/autorest), below is the configuration that the `autorest` command will automatically pick up.
+
+> see https://aka.ms/autorest
+
+```yaml
+input-file: https://mailosaur.com/swagger/latest/swagger.json
+```
+
+```yaml
+ruby:
+    output-folder: lib
+    add-credentials: true
+    sync-methods: essential 
+    use-internal-constructors: true
+    override-client-name: MailosaurBaseClient
+    namespace: Mailosaur
+    package-name: Mailosaur
+    package-version: 5.0.1
+```
+
 ## Running tests
 
 Once you've cloned this repository locally, you can simply run:
@@ -21,17 +60,12 @@ Once you've cloned this repository locally, you can simply run:
 ```
 bundle install
 
-export MAILOSAUR_MAILBOX_ID=yourmailbox
-export MAILOSAUR_API_KEY=yourapikey
+export MAILOSAUR_API_KEY=your_api_key
+export MAILOSAUR_SERVER=server_id
 
-bundle exec rake
+bundle exec rake test
 ```
 
 ## Contacting us
 
 You can get us at [support@mailosaur.com](mailto:support@mailosaur.com)
-
-## License
-
-Copyright (c) 2016 Mailosaur Ltd
-Distributed under MIT license.

data/lib/Mailosaur/analysis.rb

@@ -0,0 +1,184 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Mailosaur
+  #
+  # # Introduction
+  #
+  # This is an overview of the Mailosaur API. This API a RESTful JSON interface
+  # with predictable, resource-oriented URLs. We make use of HTTP response
+  # codes to indicate
+  # API errors.
+  #
+  # We use built-in HTTP features, like HTTP authentication and HTTP verbs,
+  # which are understood
+  # by off-the-shelf HTTP clients.
+  #
+  # [Official client libraries](/docs/client-libraries/) available for most
+  # popular languages.
+  #
+  # # Authentication
+  #
+  # Authenticate your account when using the API by including your API key in
+  # the request.
+  # You can [manage your API keys](/app/account/api-access/) in the Mailosaur
+  # UI. Your API key carrys many privileges,
+  # so be sure to keep it secret! Do not share your API key in
+  # publicly-accessible areas such
+  # GitHub, client-side code, and so on.
+  #
+  # All API requests must be made over HTTPS. Calls made over plain HTTP will
+  # fail.
+  # API requests without authentication will also fail.
+  #
+  # # Errors
+  #
+  # ## HTTP status codes
+  #
+  # Mailosaur uses conventional HTTP response codes to indicate the success or
+  # failure of an
+  # API request. In general, codes in the `2xx` range indicate success, codes
+  # in the `4xx` range
+  # indicate an error that failed given the information provided (e.g., a
+  # required parameter
+  # was omitted), and codes in the `5xx` range indicate an error with
+  # Mailosaur's servers (give us a shout in the unlikely event that you see one
+  # of those).
+  #
+  # | Code | Description |
+  # |---|---|
+  # | 200 - OK | Request was successful. |
+  # | 204 - No Content | Request was successful, no response content. |
+  # | 400 - Bad Request | The request could be handled, often due to missing a
+  # required parameter. |
+  # | 401 - Unauthorized | No valid API key provided. |
+  # | 404 - Not Found | The requested resource doesn't exist. |
+  # | 5XX - Server Errors | Something went wrong at Mailosaur. (Give us a
+  # shout). |
+  #
+  # ## Error handling
+  #
+  # In of an error the server will return as much information as possible. In
+  # the case of a `401` or
+  # `404` error the status code gives as much information as you'd need. But
+  # for `400` errors
+  # Mailosaur will return a JSON object containing the structure below.
+  #
+  # Note that our client libraries convert responses to appropriate
+  # language-specific objects.
+  #
+  # | Property | Description |
+  # |---|---|
+  # | `type` | The type of error returned. Can be: api_connection_error,
+  # api_error, authentication_error, card_error, idempotency_error
+  # invalid_request_error, or rate_limit_error. |
+  # | `message` | A human-readable message providing more details about the
+  # error. |
+  # | `parameters` | A JSON object containing a key for each property name at
+  # fault, with a human-readable message per field |
+  # | `model` | The request model that we sent and failed to be processed |
+  #
+  class Analysis
+
+    #
+    # Creates and initializes a new instance of the Analysis class.
+    # @param client service class for accessing basic functionality.
+    #
+    def initialize(client)
+      @client = client
+    end
+
+    # @return [MailosaurBaseClient] reference to the MailosaurBaseClient
+    attr_reader :client
+
+    #
+    # Perform a spam test
+    #
+    # Perform spam testing on the specified email
+    #
+    # @param email The identifier of the email to be analyzed.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [SpamAnalysisResult] operation results.
+    #
+    def spam(email, custom_headers:nil)
+      response = spam_async(email, custom_headers:custom_headers).value!
+      response.body unless response.nil?
+    end
+
+    #
+    # Perform a spam test
+    #
+    # Perform spam testing on the specified email
+    #
+    # @param email The identifier of the email to be analyzed.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [MsRest::HttpOperationResponse] HTTP response information.
+    #
+    def spam_with_http_info(email, custom_headers:nil)
+      spam_async(email, custom_headers:custom_headers).value!
+    end
+
+    #
+    # Perform a spam test
+    #
+    # Perform spam testing on the specified email
+    #
+    # @param email The identifier of the email to be analyzed.
+    # @param [Hash{String => String}] A hash of custom headers that will be added
+    # to the HTTP request.
+    #
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    def spam_async(email, custom_headers:nil)
+      fail ArgumentError, 'email is nil' if email.nil?
+
+
+      request_headers = {}
+      request_headers['Content-Type'] = 'application/json; charset=utf-8'
+      path_template = 'api/analysis/spam/{email}'
+
+      request_url = @base_url || @client.base_url
+
+      options = {
+          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
+          path_params: {'email' => email},
+          headers: request_headers.merge(custom_headers || {}),
+          base_url: request_url
+      }
+      promise = @client.make_request_async(:get, path_template, options)
+
+      promise = promise.then do |result|
+        http_response = result.response
+        status_code = http_response.status
+        response_content = http_response.body
+        unless status_code == 200
+          error_model = JSON.load(response_content)
+          mailosaur_error = Mailosaur::MailosaurError.new('Operation returned an invalid status code \'' + status_code.to_s + '\'', error_model)
+          raise mailosaur_error
+        end
+
+        # Deserialize Response
+        if status_code == 200
+          begin
+            parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
+            result_mapper = Mailosaur::Models::SpamAnalysisResult.mapper()
+            result.body = @client.deserialize(result_mapper, parsed_response)
+          rescue Exception => e
+            fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
+          end
+        end
+
+        result
+      end
+
+      promise.execute
+    end
+
+  end
+end

data/lib/Mailosaur/files.rb

@@ -0,0 +1,291 @@
+# encoding: utf-8
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is
+# regenerated.
+
+module Mailosaur
+  #
+  # # Introduction
+  #
+  # This is an overview of the Mailosaur API. This API a RESTful JSON interface
+  # with predictable, resource-oriented URLs. We make use of HTTP response
+  # codes to indicate
+  # API errors.
+  #
+  # We use built-in HTTP features, like HTTP authentication and HTTP verbs,
+  # which are understood
+  # by off-the-shelf HTTP clients.
+  #
+  # [Official client libraries](/docs/client-libraries/) available for most
+  # popular languages.
+  #
+  # # Authentication
+  #
+  # Authenticate your account when using the API by including your API key in
+  # the request.
+  # You can [manage your API keys](/app/account/api-access/) in the Mailosaur
+  # UI. Your API key carrys many privileges,
+  # so be sure to keep it secret! Do not share your API key in
+  # publicly-accessible areas such
+  # GitHub, client-side code, and so on.
+  #
+  # All API requests must be made over HTTPS. Calls made over plain HTTP will
+  # fail.
+  # API requests without authentication will also fail.
+  #
+  # # Errors
+  #
+  # ## HTTP status codes
+  #
+  # Mailosaur uses conventional HTTP response codes to indicate the success or
+  # failure of an
+  # API request. In general, codes in the `2xx` range indicate success, codes
+  # in the `4xx` range
+  # indicate an error that failed given the information provided (e.g., a
+  # required parameter
+  # was omitted), and codes in the `5xx` range indicate an error with
+  # Mailosaur's servers (give us a shout in the unlikely event that you see one
+  # of those).
+  #
+  # | Code | Description |
+  # |---|---|
+  # | 200 - OK | Request was successful. |
+  # | 204 - No Content | Request was successful, no response content. |
+  # | 400 - Bad Request | The request could be handled, often due to missing a
+  # required parameter. |
+  # | 401 - Unauthorized | No valid API key provided. |
+  # | 404 - Not Found | The requested resource doesn't exist. |
+  # | 5XX - Server Errors | Something went wrong at Mailosaur. (Give us a
+  # shout). |
+  #
+  # ## Error handling
+  #
+  # In of an error the server will return as much information as possible. In
+  # the case of a `401` or
+  # `404` error the status code gives as much information as you'd need. But
+  # for `400` errors
+  # Mailosaur will return a JSON object containing the structure below.
+  #
+  # Note that our client libraries convert responses to appropriate
+  # language-specific objects.
+  #
+  # | Property | Description |
+  # |---|---|
+  # | `type` | The type of error returned. Can be: api_connection_error,
+  # api_error, authentication_error, card_error, idempotency_error
+  # invalid_request_error, or rate_limit_error. |
+  # | `message` | A human-readable message providing more details about the
+  # error. |
+  # | `parameters` | A JSON object containing a key for each property name at
+  # fault, with a human-readable message per field |
+  # | `model` | The request model that we sent and failed to be processed |
+  #
+  class Files
+
+    #
+    # Creates and initializes a new instance of the Files class.
+    # @param client service class for accessing basic functionality.
+    #
+    def initialize(client)
+      @client = client
+    end
+
+    # @return [MailosaurBaseClient] reference to the MailosaurBaseClient
+    attr_reader :client
+
+    #
+    # Download an attachment
+    #
+    # Downloads a single attachment. Simply supply the unique identifier for the
+    # required attachment.
+    #
+    # @param id The identifier of the attachment to be downloaded.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [NOT_IMPLEMENTED] operation results.
+    #
+    def get_attachment(id, custom_headers:nil)
+      response = get_attachment_async(id, custom_headers:custom_headers).value!
+      response.body unless response.nil?
+    end
+
+    #
+    # Download an attachment
+    #
+    # Downloads a single attachment. Simply supply the unique identifier for the
+    # required attachment.
+    #
+    # @param id The identifier of the attachment to be downloaded.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [MsRest::HttpOperationResponse] HTTP response information.
+    #
+    def get_attachment_with_http_info(id, custom_headers:nil)
+      get_attachment_async(id, custom_headers:custom_headers).value!
+    end
+
+    #
+    # Download an attachment
+    #
+    # Downloads a single attachment. Simply supply the unique identifier for the
+    # required attachment.
+    #
+    # @param id The identifier of the attachment to be downloaded.
+    # @param [Hash{String => String}] A hash of custom headers that will be added
+    # to the HTTP request.
+    #
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    def get_attachment_async(id, custom_headers:nil)
+      fail ArgumentError, 'id is nil' if id.nil?
+
+
+      request_headers = {}
+      request_headers['Content-Type'] = 'application/json; charset=utf-8'
+      path_template = 'api/files/attachments/{id}'
+
+      request_url = @base_url || @client.base_url
+
+      options = {
+          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
+          path_params: {'id' => id},
+          headers: request_headers.merge(custom_headers || {}),
+          base_url: request_url
+      }
+      promise = @client.make_request_async(:get, path_template, options)
+
+      promise = promise.then do |result|
+        http_response = result.response
+        status_code = http_response.status
+        response_content = http_response.body
+        unless status_code == 200
+          error_model = JSON.load(response_content)
+          mailosaur_error = Mailosaur::MailosaurError.new('Operation returned an invalid status code \'' + status_code.to_s + '\'', error_model)
+          raise mailosaur_error
+        end
+
+        # Deserialize Response
+        if status_code == 200
+          begin
+            parsed_response = response_content
+            result_mapper = {
+              client_side_validation: true,
+              required: false,
+              serialized_name: 'parsed_response',
+              type: {
+                name: 'Stream'
+              }
+            }
+            result.body = @client.deserialize(result_mapper, parsed_response)
+          rescue Exception => e
+            fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
+          end
+        end
+
+        result
+      end
+
+      promise.execute
+    end
+
+    #
+    # Download EML
+    #
+    # Downloads an EML file representing the specified email. Simply supply the
+    # unique identifier for the required email.
+    #
+    # @param id The identifier of the email to be downloaded.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [NOT_IMPLEMENTED] operation results.
+    #
+    def get_email(id, custom_headers:nil)
+      response = get_email_async(id, custom_headers:custom_headers).value!
+      response.body unless response.nil?
+    end
+
+    #
+    # Download EML
+    #
+    # Downloads an EML file representing the specified email. Simply supply the
+    # unique identifier for the required email.
+    #
+    # @param id The identifier of the email to be downloaded.
+    # @param custom_headers [Hash{String => String}] A hash of custom headers that
+    # will be added to the HTTP request.
+    #
+    # @return [MsRest::HttpOperationResponse] HTTP response information.
+    #
+    def get_email_with_http_info(id, custom_headers:nil)
+      get_email_async(id, custom_headers:custom_headers).value!
+    end
+
+    #
+    # Download EML
+    #
+    # Downloads an EML file representing the specified email. Simply supply the
+    # unique identifier for the required email.
+    #
+    # @param id The identifier of the email to be downloaded.
+    # @param [Hash{String => String}] A hash of custom headers that will be added
+    # to the HTTP request.
+    #
+    # @return [Concurrent::Promise] Promise object which holds the HTTP response.
+    #
+    def get_email_async(id, custom_headers:nil)
+      fail ArgumentError, 'id is nil' if id.nil?
+
+
+      request_headers = {}
+      request_headers['Content-Type'] = 'application/json; charset=utf-8'
+      path_template = 'api/files/email/{id}'
+
+      request_url = @base_url || @client.base_url
+
+      options = {
+          middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
+          path_params: {'id' => id},
+          headers: request_headers.merge(custom_headers || {}),
+          base_url: request_url
+      }
+      promise = @client.make_request_async(:get, path_template, options)
+
+      promise = promise.then do |result|
+        http_response = result.response
+        status_code = http_response.status
+        response_content = http_response.body
+        unless status_code == 200
+          error_model = JSON.load(response_content)
+          mailosaur_error = Mailosaur::MailosaurError.new('Operation returned an invalid status code \'' + status_code.to_s + '\'', error_model)
+          raise mailosaur_error
+        end
+
+        # Deserialize Response
+        if status_code == 200
+          begin
+            parsed_response = response_content
+            result_mapper = {
+              client_side_validation: true,
+              required: false,
+              serialized_name: 'parsed_response',
+              type: {
+                name: 'Stream'
+              }
+            }
+            result.body = @client.deserialize(result_mapper, parsed_response)
+          rescue Exception => e
+            fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
+          end
+        end
+
+        result
+      end
+
+      promise.execute
+    end
+
+  end
+end