mailinator_client 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 020d864e0cc2093d379fb2e408c3f8920bd334f186a568616bfc25abbf3d5c54
-  data.tar.gz: 5678100c51aa2a4590d3ae5b22cf745b1a5d7bb271863d698b9b0b0956417da0
+  metadata.gz: 9f84751a84c2f12dd32480148d28b58875645036b6e9ee37ec3b576f312c6344
+  data.tar.gz: bac6eaadc70a33e194df359bb2457f2e41583c04f210ab48ad0457cc8a44ada9
 SHA512:
-  metadata.gz: d7d96ebfb16dd1d9e03c20b3a1b7b536bccc26df6c26c35cf3522f0f04f1c116b6db2fcd3f6b57a470ce7e2e23858c8792ddb3e309672413faeafdbf253b8f4f
-  data.tar.gz: c36b73eaddb172d66f475158a2f89e6b548ca29239c4e0264a6549c489434ac61f8721a828e5fb1290a19e6e7212605fdb360dc7e822a2566662e2578c75eae3
+  metadata.gz: 913642bb4acca4b7a5ec4c0e7b06ddb3436e297bae4200bf884d9929423d692d40846f3deb3657dabf0aa0cacae59b7f9fdcbf32fd266a4b193c786b4c0446f9
+  data.tar.gz: d449cf69820f51a4c8721aed676da788b6b11336c70cb6017f7aee9681fa8758862a84fb528746957349000b637c3a14b7d37cc1e8855b2876d16bea8490061c

data/.gitignore

@@ -0,0 +1,23 @@
+*~
+\#*
+.\#*
+.DS_Store
+*_flymake.*
+*.LCK
+.bundle
+vendor/bundle
+bin
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+_yardoc
+coverage
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock

data/.markdownlint.json

@@ -0,0 +1,11 @@
+{
+  "default": true,
+  "MD009": { "br_spaces": 2 },
+  "MD013": false,
+  "MD033": false,
+  "MD041": false,
+  "MD007": { "indent": 4 },
+  "MD014": false,
+  "MD034": false,
+  "MD026": false
+}

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+ - 2.5
+ - 2.4
+ - 2.3
+ - 2.2
+ - 2.1

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Manybrain, Inc.
+
+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.

data/README.md

@@ -0,0 +1,101 @@
+# Mailinator Ruby REST API Client
+
+[![Build Status](https://travis-ci.org/manybrain/mailinator-ruby-client.svg?branch=master)](https://travis-ci.org/manybrain/mailinator-ruby-client)  [![Gem Version](https://badge.fury.io/rb/mailinator_client.svg)](https://badge.fury.io/rb/mailinator_client)
+
+The [Mailinator](https://www.mailinator.com/) REST API client provides a simple way to use the comprehensive Mailinator API.
+
+This client works with Ruby 2.1 and higher. It uses [HTTParty](https://github.com/jnunemaker/httparty) under the covers for the actual HTTP communication.
+
+<br/>
+
+## Installation
+
+The latest stable version is available in RubyGems and can be installed using
+
+```bash
+gem install mailinator_client
+```
+
+<br/>
+
+## API Documentation
+
+### MailinatorClient
+
+MailinatorClient is the wrapping module, but it also acts as a singleton [Client](#mailinatorclient) instance. So if you only need a single client instance, you do not need to instantiate one yourself - the MailinatorClient module will act exactly like an instance of MailinatorClient::Client.
+
+<br/>
+
+### MailinatorClient::Client
+
+A client is a single api instance. By default, it is unauthenticated, but can be given an access token to perform authenticated requests.
+
+#### Initializer
+
+```ruby
+MailinatorClient::Client.new(auth_token: nil)
+```
+
+The ``Client()`` initializer takes the following arguments:
+
+* auth_token  
+  The access token to be used for authentication - by default there is no access token.
+
+#### Resources
+
+Each of the following is a method on the client object, and returns a wrapper for the actions against that particular resource. See each resource documentation file for more information.
+
+* [domains](docs/domains.md)  
+  Contains all of the actions that can be performed against the set of [Domains](https://manybrain.github.io/m8rdocs/#domains-api) that the currently authenticated user has access to - such as listing the domains.
+
+* [stats](docs/stats.md)  
+  Contains all of the actions that can be performed against the set of [Stats](https://manybrain.github.io/m8rdocs/#stats-api) that the currently authenticated user has access to - such as listing the team stats.
+
+* [rules](docs/rules.md)  
+  Contains all of the actions that can be performed against the set of [Rules](https://manybrain.github.io/m8rdocs/#rules-api) that the currently authenticated user has access to - such as listing the rules or creating a new rule.
+
+* [messages](docs/messages.md)  
+  Contains all of the actions that can be performed against the set of [Messages](https://manybrain.github.io/m8rdocs/#message-api) that the currently authenticated user has access to - such as listing the messages or injecting a new message.
+
+<br/>
+
+### MailinatorClient::ResponseError
+
+When the Mailinator API returns a unsuccessful response, an instance of ResponseError is thrown.
+
+#### ResponseError Accessors
+
+* code  
+  The status code returned from the Mailinator API.
+
+* type  
+  The type of error that occurred, such as "Authorization".
+
+* message  
+  A more detailed message about the particulars of the error.
+
+<br/>
+
+## Testing
+
+Run integration tests with real API Key.
+
+```ruby
+ruby -I test test/mailinator_client_api_test.rb
+```
+
+Most of the tests require env variables with valid values. Visit tests source code and review `mailinator_client_api_test.rb` file. The more env variables you set, the more tests are run.
+
+* `MAILINATOR_TEST_API_TOKEN` - API tokens for authentication; basic requirement across many tests;see also https://manybrain.github.io/m8rdocs/#api-authentication
+* `MAILINATOR_TEST_INBOX` - some already existing inbox within the private domain
+* `MAILINATOR_TEST_PHONE_NUMBER` - associated phone number within the private domain; see also https://manybrain.github.io/m8rdocs/#fetch-an-sms-messages
+* `MAILINATOR_TEST_MESSAGE_WITH_ATTACHMENT_ID` - existing message id within inbox (see above) within private domain (see above); see also https://manybrain.github.io/m8rdocs/#fetch-message
+* `MAILINATOR_TEST_ATTACHMENT_ID` - existing message id within inbox (see above) within private domain (see above); see also https://manybrain.github.io/m8rdocs/#fetch-message
+* `MAILINATOR_TEST_DELETE_DOMAIN` - don't use it unless you are 100% sure what you are doing
+
+
+*****
+
+Copyright (c) 2020 Manybrain, Inc
+
+<https://www.mailinator.com/>

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+desc "Default: run unit tests."
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/docs/domains.md

@@ -0,0 +1,32 @@
+# Domains Actions
+
+Details on the various actions that can be performed on the Domains resource, including the expected parameters and the potential responses.
+
+##### Contents
+
+*   [GetDomains](#getdomains)
+*   [GetDomain](#getdomain)
+
+<br/>
+
+## GetDomains
+
+Fetches a list of all your domains
+
+```ruby
+result = client.domains.get_domains()
+
+puts result
+```
+
+<br/>
+
+## GetDomain
+
+Fetches a specific domain
+
+```ruby
+result = client.domains.get_domain(domainId: my_domain_id)
+
+puts result
+```

data/docs/messages.md

@@ -0,0 +1,176 @@
+# Messages Actions
+
+Details on the various actions that can be performed on the Messages resource, including the expected parameters and the potential responses.
+
+##### Contents
+
+*   [FetchInbox](#fetchinbox)
+*   [FetchMessage](#fetchmessage)
+*   [FetchSMSMessage](#fetchsmsmessage)
+*   [FetchAttachments](#fetchattachments)
+*   [FetchAttachment](#fetchattachment)
+*   [FetchMessageLinks](#fetchmessagelinks)
+*   [DeleteAllDomainMessages](#deletealldomainmessages)
+*   [DeleteAllInboxMessages](#deleteallinboxmessages)
+*   [DeleteMessage](#deletemessage)
+*   [InjectMessage](#injectmessage)
+
+<br/>
+
+## FetchInbox
+
+Retrieves a list of messages summaries
+
+```ruby
+result = client.messages.fetch_inbox(
+  domainId: my_domain_id
+  inbox: my_inbox
+  skip: my_skip
+  limit: my_limit
+  sort: my_sort
+  decodeSubject: my_decode_subject)
+
+puts result
+```
+
+<br/>
+
+## FetchMessage
+
+Retrieves a specific message by id
+
+```ruby
+result = client.messages.fetch_inbox(
+  domainId: my_domain_id
+  inbox: my_inbox
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+
+## FetchSMSMessage
+
+Retrieves a specific SMS message by sms number
+
+```ruby
+result = client.messages.fetch_sms_message(
+  domainId: my_domain_id
+  inbox: my_inbox
+  teamSmsNumber: my_team_sms_number)
+
+puts result
+```
+
+<br/>
+
+
+## FetchAttachments
+
+Retrieves a list of attachments for a message
+
+```ruby
+result = client.messages.fetch_attachments(
+  domainId: my_domain_id
+  inbox: my_inbox
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+
+## FetchAttachment
+
+Retrieves a specific attachment
+
+```ruby
+result = client.messages.fetch_attachment(
+  domainId: my_domain_id
+  inbox: my_inbox
+  messageId: my_message_id
+  attachmentId: my_attachment_id)
+
+puts result
+```
+
+<br/>
+
+
+## FetchMessageLinks
+
+Retrieves all links found within a given email
+
+```ruby
+result = client.messages.fetch_message_links(
+  domainId: my_domain_id
+  inbox: my_inbox
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+
+## DeleteAllDomainMessages
+
+Deletes ALL messages from a Private Domain
+
+```ruby
+result = client.messages.delete_all_domain_messages(
+  domainId: my_domain_id)
+
+puts result
+```
+
+<br/>
+
+
+## DeleteAllInboxMessages
+
+Deletes ALL messages from a specific private inbox
+
+```ruby
+result = client.messages.delete_all_inbox_messages(
+  domainId: my_domain_id
+  inbox: my_inbox
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+
+## DeleteMessage
+
+Deletes a specific messages
+
+```ruby
+result = client.messages.delete_message(
+  domainId: my_domain_id
+  inbox: my_inbox
+  messageId: my_message_id)
+
+puts result
+```
+
+<br/>
+
+
+## InjectMessage
+
+Deliver a JSON message into your private domain
+
+```ruby
+result = client.messages.inject_message(
+  domainId: my_domain_id
+  inbox: my_inbox
+  messageToPost: my_message_to_post)
+
+puts result
+```

data/docs/rules.md

@@ -0,0 +1,95 @@
+# Rules Actions
+
+Details on the various actions that can be performed on the Rules resource, including the expected parameters and the potential responses.
+
+##### Contents
+
+*   [CreateRule](#createrule)
+*   [EnableRule](#enablerule)
+*   [DisableRule](#disablerule)
+*   [GetAllRules](#getallrules)
+*   [GetRule](#getrule)
+*   [DeleteRule](#deleterule)
+
+<br/>
+
+## CreateRule
+
+Creates a Rule
+
+```ruby
+result = client.rules.create_rule(
+  domainId: my_domain_id,
+  ruleToPost: my_rule_to_post
+)
+
+puts result
+```
+
+<br/>
+
+## EnableRule
+
+Enables an existing Rule
+
+```ruby
+result = client.rules.enable_rule(
+  domainId: my_domain_id
+  ruleId: my_rule_id)
+
+puts result
+```
+
+<br/>
+
+## DisableRule
+
+Disables an existing Rule
+
+```ruby
+result = client.rules.disable_rule(
+  domainId: my_domain_id
+  ruleId: my_rule_id)
+
+puts result
+```
+
+<br/>
+
+## GetAllRules
+
+Fetches all Rules for a Domain
+
+```ruby
+result = client.rules.get_all_rules(domainId: my_domain_id)
+
+puts result
+```
+
+<br/>
+
+## GetRule
+
+Fetches a specific rule for a Domain
+
+```ruby
+result = client.rules.get_rule(
+  domainId: my_domain_id
+  ruleId: my_rule_id)
+
+puts result
+```
+
+<br/>
+
+## DeleteRule
+
+Deletes a specific rule for a Domain
+
+```ruby
+result = client.rules.delete_rule(
+  domainId: my_domain_id
+  ruleId: my_rule_id)
+
+puts result
+```