mailosaur 5.0.2 → 5.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6873ba1b5eb8d927299a2a1e98bfa0c9358fdc1e
-  data.tar.gz: bb0b7f78965bb63ad0e6daad0f6909a834856e4c
+SHA256:
+  metadata.gz: 0ac89c532d7f0519c3a2d620af601b75e7b83dffc3df92e842acb7de6610d2a1
+  data.tar.gz: f1dc7d047492d560f764fbf3f3ac7937e26a29f4ce163c744f017562cbba4e33
 SHA512:
-  metadata.gz: c1e2af464eab76853b7299d5ac1bbe85a8a7f23e856f605a1200813b7e9fcc362ecf2ce66860b447409d03a88cab7e82b1e3b1d6fe619f406c1cd2600d23fe5a
-  data.tar.gz: bfaa9d18ce603e8c8ee0d4533d62919446e04af6936956dda6ff20ebf34ffb508aac807405feb8b207d2c8b2b67ee1539190d1ea53ad2c91b546d0d060dcc09a
+  metadata.gz: fc72c693120dc3a6730d96c7666a4100bd000a6ef237470df762737cc0bfb00a6b7979e5be9ba273e11a92dd8ab68e19a14dd42a83d6ed2ea9d14fe7d78e7eec
+  data.tar.gz: 8c6982baaee8c5c733ed3816440340a746606512acf1f0d1e523aca08f11129ffab06481ffef676f484273952460f86caa8b2fec529f959489e08f9d63322810

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Mailosaur Ltd (https://mailosaur.com)
+Copyright (c) 2019 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

data/README.md

@@ -14,45 +14,6 @@ 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.2
-```
-
 ## Running tests
 
 Once you've cloned this repository locally, you can simply run:

data/lib/Mailosaur/analysis.rb

@@ -1,97 +1,16 @@
-# 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.
+    # @param conn client connection.
     #
-    def initialize(client)
-      @client = client
+    def initialize(conn)
+      @conn = conn
     end
 
-    # @return [MailosaurBaseClient] reference to the MailosaurBaseClient
-    attr_reader :client
+    # @return [Connection] the client connection.
+    attr_reader :conn
 
     #
     # Perform a spam test
@@ -99,86 +18,20 @@ module Mailosaur
     # 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
+    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
 
-      promise.execute
+      model = JSON.load(response.body)
+      Mailosaur::Models::SpamAnalysisResult.new(model)
     end
-
   end
 end

data/lib/Mailosaur/files.rb

@@ -1,97 +1,16 @@
-# 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.
+    # @param client connection.
     #
-    def initialize(client)
-      @client = client
+    def initialize(conn)
+      @conn = conn
     end
 
-    # @return [MailosaurBaseClient] reference to the MailosaurBaseClient
-    attr_reader :client
+    # @return [Connection] the client connection.
+    attr_reader :conn
 
     #
     # Download an attachment
@@ -100,94 +19,19 @@ module Mailosaur
     # 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
+    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
 
-      promise.execute
+      response.body
     end
 
     #
@@ -197,95 +41,19 @@ module Mailosaur
     # 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
+    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
 
-      promise.execute
+      response.body
     end
-
   end
 end