wj-mailgun-ruby 1.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 052cfc6ec92461618676ecf1e4a108559fc62ae6
+  data.tar.gz: 3088cbccaa13f3c713b5f0dcdd6ddba4438dc624
+SHA512:
+  metadata.gz: b4167a00ccca88c41e0c245c3f5bdd93c2becf91bf8ab49e042e55e9ef1afcf9797ae076965b7bab8eaeaa4f19b5e8a74768b632a064a5699bb00075c316aa15
+  data.tar.gz: 7c9c6df32c8886f9338263673766ef4e1520c6396c1e54d61547e33aca891172da5e070f2a6e53e2f42bfdf6472a6247801600f25c44f83c48934ec08772a2cc

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+test.rb
+ruby
+.ruby-env.yml
+.rspec-local
+.tool-versions

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Enabled: false
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+Style/EmptyLinesAroundClassBody:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,22 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-01-07 12:11:06 -0500 using RuboCop version 0.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 169
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 9
+Style/AccessorMethodName:
+  Exclude:
+    - 'lib/mailgun/messages/message_builder.rb'

data/.ruby-env.yml.example

@@ -0,0 +1,12 @@
+---
+# To assist with testing.
+#
+# DO NOT CHANGE AND COMMIT. YOU HAVE BEEN WARNED.
+# Alternatively, use environment variables of the same.
+#
+# Replace <THESE_VALUES> with yours from
+# https://mailgun.com/app/dashboard (don't include <brackets>)
+# and rename to/save as: .ruby-env.yml
+MAILGUN_APIKEY : '<MAILGUN_APIKEY>'
+MAILGUN_PUB_APIKEY : '<MAILGUN_PUBLIC_APIKEY>'
+MAILGUN_TESTDOMAIN : '<MAILGUN_SANDBOX_DOMAIN>'

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p0

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+sudo: false
+rvm:
+- 2.0.0
+- 2.1
+- 2.2
+- 2.3.1
+script:
+- bundle install
+- bundle exec rake spec
+- '[[ "${TRAVIS_PULL_REQUEST}" == "false" ]] && ( bundle exec rake spec:integration
+  ) || ( echo "Testing PR - No integration tests available")'
+deploy:
+  provider: rubygems
+  api_key:
+    secure: DoX3w48gRyhDM1o1OLvtWsTi8ehLIarIsErzg/UlNRoLacQt5l5UzwD+u6wqsCEr4+c2uAHNahafpnw/j1rPG3LBPIXOK5A0SYbjovlckutiAC0330Q4PHwOZb73AFN1DG5JTeg4/fguEjdsEBdZObF7mh5gBMBQtNjo1Fos+4w=
+  gemspec: mailgun.gemspec
+  on:
+    tags: true
+    condition: "$TRAVIS_RUBY_VERSION == 2.3.1"
+notifications:
+  slack:
+    rooms:
+      secure: G4iBtDfFGeryQslfrKZK4hSPikOy9y3SDnpzwmN8SoB0uIAWE2mLfMUJZonKm7yoz+DbPU0u3c1SwiMLwHkXZhPdnJdC1fb1DpicXnVgGZYdiLGiY+OAwkvcBE9p3piWhpwigTjvmSqTaNSRL/VLhG4qwQbHU0fTl1M1zwU4e6c=

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mailgun.gemspec
+gemspec
+
+gem 'json', '~> 1.8', platform: :mri_19

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [2013] [Rackpace]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,241 @@
+Mailgun-Ruby
+============
+
+[![Build Status](https://travis-ci.org/mailgun/mailgun-ruby.svg?branch=master)](https://travis-ci.org/mailgun/mailgun-ruby) [![Gem Version](https://badge.fury.io/rb/mailgun-ruby.svg)](http://badge.fury.io/rb/mailgun-ruby)
+
+This is the Mailgun Ruby Library. This library contains methods for easily interacting
+with the Mailgun API.
+Below are examples to get you started. For additional examples, please see our
+official documentation at https://documentation.mailgun.com
+
+Installation
+------------
+Via RubyGems
+
+```ruby
+gem install mailgun-ruby
+```
+
+Gemfile:
+
+```ruby
+gem 'mailgun-ruby', '~>1.1.6'
+```
+
+Usage
+-----
+Here's how to send a message using the library:
+
+```ruby
+require 'mailgun'
+
+# First, instantiate the Mailgun Client with your API key
+mg_client = Mailgun::Client.new 'your-api-key'
+
+# Define your message parameters
+message_params =  { from: 'bob@sending_domain.com',
+                    to:   'sally@example.com',
+                    subject: 'The Ruby SDK is awesome!',
+                    text:    'It is really easy to send a message!'
+                  }
+
+# Send your message through the client
+mg_client.send_message 'sending_domain.com', message_params
+```
+
+Or obtain the last couple log items:
+
+```ruby
+# First, instantiate the Mailgun Client with your API key
+mg_client = Mailgun::Client.new 'your-secret-api-key'
+
+# Define the domain you wish to query
+domain = 'example.com'
+
+# Issue the get request
+result = mg_client.get("#{domain}/events", {:event => 'delivered'})
+```
+
+Rails
+-----
+
+The library can be initialized with a Rails initializer containing similar:
+```ruby
+Mailgun.configure do |config|
+  config.api_key = 'your-secret-api-key'
+end
+```
+Or have the initializer read your environment setting if you perfer.
+
+To use as the ActionMailer delivery method, add this to your `config/environments/whatever.rb`
+and replace `api-myapikey` and `mydomain.com` with your secret API key and domain, respectively:
+```ruby
+  config.action_mailer.delivery_method = :mailgun
+  config.action_mailer.mailgun_settings = {
+    api_key: 'api-myapikey',
+    domain: 'mydomain.com',
+  }
+```
+
+To get the Mailgun `message_id` after ActionMailer has successfully delivered the email:
+
+```ruby
+  mailer = UserNotifier.welcome_email(current_user)
+  mailer_response = mailer.deliver_now
+  mailgun_message_id = mailer_response.message_id
+```
+
+Response
+--------
+
+The results are returned in a Response class:
+
+```ruby
+result = mg_client.get("#{domain}/events", {:event => 'delivered'})
+
+# To Ruby standard Hash.
+result.to_h
+
+# To YAML.
+result.to_yaml
+
+# Or raw JSON
+result.body
+```
+
+Here's an example, breaking out the response:
+
+```ruby
+mg_client = Mailgun::Client.new("your-api-key")
+
+message_params =  {
+                   from: 'bob@example.com',
+                   to:   'sally@example.com',
+                   subject: 'The Ruby SDK is awesome!',
+                   text:    'It is really easy to send a message!'
+                  }
+
+result = mg_client.send_message('example.com', message_params).to_h!
+
+message_id = result['id']
+message = result['message']
+```
+
+Debugging
+---------
+
+Debugging the Ruby Library can be really helpful when things aren't working quite right.
+To debug the library, here are some suggestions:
+
+Set the endpoint to Mailgun's Postbin. A Postbin is a web service that allows you to
+post data, which is then displayed through a browser. This allows you to quickly determine
+what is actually being transmitted to Mailgun's API.
+
+**Step 1 - Create a new Postbin.**
+Go to http://bin.mailgun.net. The Postbin will generate a special URL. Save that URL.
+
+**Step 2 - Instantiate the Mailgun client using Postbin.**
+
+*Tip: The bin id will be the URL part after bin.mailgun.net. It will be random generated letters and numbers.
+For example, the bin id in this URL, http://bin.mailgun.net/aecf68de, is "aecf68de".*
+
+```ruby
+# First, instantiate the Mailgun Client with your API key
+mg_client = Mailgun::Client.new("your-api-key", "bin.mailgun.net", "aecf68de", ssl = false)
+
+# Define your message parameters
+message_params = {  from: 'bob@sending_domain.com',
+                    to: 'sally@example.com',
+                    subject: 'The Ruby SDK is awesome!',
+                    text: 'It is really easy to send a message!'
+                  }
+
+# Send your message through the client
+mg_client.send_message("sending_domain.com", message_params)
+```
+
+For usage examples on each API endpoint, head over to our official documentation
+pages. Or the [Snippets](docs/Snippets.md) file.
+
+This SDK includes the following components:
+- [Messages](docs/Messages.md)
+- [Message Builder](docs/MessageBuilder.md)
+- [Batch Message](docs/MessageBuilder.md)
+- [Opt-In Handler](docs/OptInHandler.md)
+- [Domains](docs/Domains.md)
+- [Webhooks](docs/Webhooks.md)
+- [Events](docs/Events.md)
+- [Suppressions](docs/Suppressions.md)
+
+Message Builder allows you to quickly create the array of parameters, required
+to send a message, by calling a methods for each parameter.
+Batch Message is an extension of Message Builder, and allows you to easily send
+a batch message job within a few seconds. The complexity of
+batch messaging is eliminated!
+
+Testing mail deliveries
+----------------------
+
+```ruby
+# First, instantiate the Mailgun Client with your API key
+mg_client = Mailgun::Client.new 'your-api-key'
+
+# Put the client in test mode
+mg_client.enable_test_mode!
+
+# Define your message parameters
+message_params = {  from: 'bob@sending_domain.com',
+                    to: 'sally@example.com',
+                    subject: 'The Ruby SDK is awesome!',
+                    text: 'It is really easy to send a message!'
+                  }
+
+# Send your message through the client
+# Note: This will not actually hit the API, and will return a generic OK response.
+mg_client.send_message('sending_domain.com', message_params)
+
+# You can now access a copy of message_params
+Mailgun::Client.deliveries.first[:from] # => 'bob@sending_domain.com'
+```
+
+Testing
+-------
+
+There are unit tests and integration tests. Unit tests do not require Mailgun account keys. Integration tests do.
+By default:
+```
+bundle exec rake spec
+```
+will run just unit tests. To run integration tests:
+```
+bundle exec rake spec:integration
+```
+will run just integration tests.
+```
+bundle exec rake spec:all
+```
+will run all both types.
+
+Integrations tests will run against [VCR](https://github.com/vcr/vcr) cassettes if they exist.
+If you'd like to run tests against your mailgun account, remove the cassettes.
+
+To set up Mailgun key information. See the example file: .ruby-env.yml.example.
+Rename this file to .ruby-env.yml and replace the items between the <> (including the <>) with the private
+and public keys, and sandbox domain. Alternatively use a different domain registered in Mailgun if you
+have one you want to test against.
+
+The MAILGUN_* variables in .ruby-env.yml(.example) can also be set as
+environment variables, if you'd like to do that instead.
+
+Support and Feedback
+--------------------
+
+Be sure to visit the Mailgun official
+[documentation website](https://documentation.mailgun.com/) for additional
+information about our API.
+
+If you find a bug, please submit the issue in Github directly.
+[Mailgun-Ruby Issues](https://github.com/mailgun/mailgun-ruby/issues)
+
+As always, if you need additional assistance, drop us a note through your Control Panel at
+[https://mailgun.com/cp/support](https://mailgun.com/cp/support).