email_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02c4d9d041900d7366dd821238fc996e60c533c0
+  data.tar.gz: '05851a091314a32d77f323b6129539872522bda8'
+SHA512:
+  metadata.gz: d5fff2b1cbf27d1f923701468dcc1176d560362befd5d889e120e15992d2a8e20ceafafb65a508574b8ccd34c54e957a1be3c0cbb52f8ab6a10dbaefa688ece5
+  data.tar.gz: 589fc56e84bc733eec479fb483944bc56328bf4a271d4a2c45fac262069736990675ec1acedcc1e49d345dad85921c61a9c73d93ca9ca5394ef3b29cb368a824

data/.gitignore

@@ -0,0 +1,148 @@
+## Coverage Testing ##
+coverage
+
+
+## Covers Ruby ##
+# https://github.com/github/gitignore/blob/master/Ruby.gitignore
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/tests/tmp/
+/tests/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# rspec failure tracking
+.rspec_status
+
+
+
+## Covers MacOS ##
+# https://github.com/github/gitignore/blob/master/Global/macOS.gitignore
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+
+## Covers JetBrains IDEs ##
+# https://github.com/github/gitignore/blob/master/Global/JetBrains.gitignore
+
+*.iml
+.idea/
+
+# User-specific stuff:
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/dictionaries
+
+# Sensitive or high-churn files:
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+
+# Gradle:
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# CMake
+cmake-build-debug/
+
+# Mongo Explorer plugin:
+.idea/**/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at vasili@moisiadis.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in email_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,154 @@
+PATH
+  remote: .
+  specs:
+    email_api (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.1.5)
+      actionview (= 5.1.5)
+      activesupport (= 5.1.5)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.5)
+      activesupport (= 5.1.5)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ansi (1.5.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    daemons (1.2.6)
+    diff-lcs (1.3)
+    docile (1.3.0)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.2.1)
+    erubi (1.7.1)
+    eventmachine (1.2.5)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    loofah (2.2.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    metaclass (0.0.4)
+    method_source (0.9.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    minitest-reporters (1.1.19)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (1.4.0)
+      metaclass (~> 0.0.1)
+    mustermann (1.0.2)
+    netrc (0.11.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    puma (3.11.3)
+    rack (2.0.4)
+    rack-protection (2.0.1)
+      rack
+    rack-test (0.8.3)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.5)
+      actionpack (= 5.1.5)
+      activesupport (= 5.1.5)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-rails (3.7.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sinatra (2.0.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.1)
+      tilt (~> 2.0)
+    thin (1.2.11)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  dotenv (~> 2.2.1)
+  email_api!
+  json (~> 2.1.0)
+  minitest (~> 5.11.3)
+  minitest-reporters (~> 1.1.19)
+  mocha (~> 1.4.0)
+  puma (~> 3.11.3)
+  rack-test (~> 0.8.3)
+  rake (~> 10.0)
+  rest-client (~> 2.0.2)
+  rspec (~> 3.0)
+  rspec-rails (~> 3.7.2)
+  simplecov (~> 0.16.1)
+  sinatra (~> 2.0.1)
+  thin (~> 1.2.5)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Vasili Moisiadis
+
+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,195 @@
+# Email API
+
+This Email API allows you to send plain-text only emails to clients through supported email service providers.
+
+Supports sending to multiple email recipients, CCs, BCCs.
+
+**Supported Providers:**
+* [Mailgun](https://www.mailgun.com/)
+* [Sendgrid](https://sendgrid.com/)
+
+
+## Requirements
+* Ruby > 1.9
+* API Credentials with supported providers
+
+
+## Installation
+
+### Ruby Gem Installation
+Add this line to your application's Gemfile:
+
+```ruby
+   gem 'email_api'
+```
+
+And then execute:
+
+```
+    $ bundle
+```
+
+Or install it yourself as:
+
+```
+    $ gem install email_api
+```
+
+### Environment Variables
+
+The gem uses environment variables to hold sensitive information. Create a `.env` file on the same directory level as where you are running the program.
+
+Inside the `.env` files, the following need to be defined:
+
+```
+    export SENDGRID_API_USER='<Sendgrid account username>'
+    export SENDGRID_API_KEY='<Sendgrid account password'
+    export MAILGUN_PRIVATE_KEY='<API given by Mailgun when creating an account>'
+    export MAILGUN_DOMAIN='<Domain given by Mailgun when creating an account>'
+    export TEST_NAME='<The identity name used to perform tests with>'
+    export TEST_EMAIL='<The email address to perform tests with>'
+```
+
+
+## API Usage
+
+All usages below denote `<hosting_server>`. This is the URL path to get to the API on whichever service you host it on.
+
+For demonstration purposes, see this example hosting server: [Demonstration Email API](http://email-api.moisiadis.com)
+
+### Ping
+
+#### Accepts
+* No parameters supported
+
+#### Returns
+* A hash containing the current time
+
+#### Example Usage
+```
+    <hosting_server>/ping
+```
+
+#### Example Response
+```
+    {
+      "time": "2000-01-01T00:00:00+00:00"
+    }
+```
+
+
+### Send
+
+#### Accepts
+Note: All **Email Addresses** below are expected in the format of `YOUR NAME <your email>`
+
+* `from`
+  * Usage: `YOUR NAME <your email>`
+  * Only one allowed email address allowed
+* `to`
+  * Usage: `YOUR NAME <your email>[, YOUR NAME <your email>]`
+  * Any number of email addresses allowed
+* `cc` [optional]
+  * Same usage and rules as `to`
+* `bcc` [optional]
+  * Same usage and rules as `to`
+* `subject`
+  * Plain text. Cannot be empty.
+* `content`
+  * Plain text. Cannot be empty.
+
+#### Returns
+* A hash response containing the email as parsed and the status of the request.
+
+#### Example Usage
+```
+    <hosting_server>/send?from=My Name <my@email.com>&to=Your Name <your@email.com>&cc=Friend 1 <friend_1@email.com>,Friend 2 <friend_2@email.com>&subject=Hello World&content=How are you today?
+```
+
+#### Example Response
+```
+    {
+      "email":
+      {
+        "from":
+        {
+          "name": "My Name",
+          "email": "my@email.com"
+        },
+        "to":
+        [{
+          "name": "Your Name",
+          "email": "your@email.com"
+        }],
+        "cc": 
+        [{
+          "name": "Friend 1",
+          "email": "friend_1@email.com"
+        },
+        {
+          "name": "Friend 2",
+          "email": "friend_2@email.com"
+        }],
+        "bcc": null,
+        "subject": "Hello World",
+        "content": "How are you today?"
+      },
+      "status":"200: OK"
+    }
+```
+
+
+## Development
+
+After checking out the repo at https://github.com/VasiliMoisiadis/email-api:
+
+### Development Installation
+
+There are two ways to install:
+
+For complete scripted installation:
+```
+    $ bash bin/setup
+```
+
+For more manual installation:
+```
+    $ bundle install
+```
+
+### Starting environment
+
+The provided web service at [Moisiadis.com](http://email-api.moisiadis.com) uses Puma, and it is the primary supported web server.
+
+Start using:
+```
+    $ puma config.ru
+```
+
+By default it will start on port 9292. See instructions on Puma [Configuration](https://github.com/puma/puma#configuration) to alter this. 
+
+### Tests
+
+Tests are performed using the [Minitest testing suite](http://docs.seattlerb.org/minitest/)
+
+Run using:
+```
+    $ rake test
+```
+
+Note: Can only be tested after complete installation - this includes environment variables.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/VasiliMoisiadis/email-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+
+## Code of Conduct
+
+Everyone interacting in the Email API project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/VasiliMoisiadis/email-api/blob/master/CODE_OF_CONDUCT.md).