email-delivery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b738e4413c8ba16e12ce54a080a1f31ac4b14d34
+  data.tar.gz: 44d39a22dcf9dede5ce83ffdf5f3653f8ac91d40
+SHA512:
+  metadata.gz: 01a9a705191fa4bfef31a01d2d63204506d565e75dc02cf86a16026c1f798a22dc69eba851ca83cdfb7dff938003f0d3f19439b3ad20444fa8fa4ff74e72ad0f
+  data.tar.gz: b23baf22896539318b9cb11c5a401ff6138159361dc52598ff5445869b1de615870c3c3ec1804d4c2256f6f396cb7a5b48b0d3563b9b79d2edc8dc27140be3bb

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.env
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.16.0.pre.2

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+ruby '2.3.3'
+
+git_source(:github) {|repo_name| "http://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in email-delivery.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    email-delivery (0.1.0)
+      rest-client (~> 2.0.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    byebug (9.1.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.2.1)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.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.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  byebug
+  dotenv (~> 2.2.1)
+  email-delivery!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-mocks (~> 3.0)
+
+RUBY VERSION
+   ruby 2.3.3p222
+
+BUNDLED WITH
+   1.16.0.pre.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Pranava Swaroop
+
+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,129 @@
+# Email::Delivery
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/email/delivery`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+This gem is a service (Backend) that accepts the necessary information and sends emails. It provides an abstraction between two different e-mail sevice providers and quickly falls over to a working provider without affecting the users.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'email-delivery'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install email-delivery
+
+## Inputs
+    
+    Input: Hash
+    {
+        'from':'me@test.com',
+        'to':['you_1@test.com, you_2@test.com'],
+        'cc':'you_3@test.com',
+        'bcc':['you_4@test.com', 'test_bcc2@mail.com'],
+        'subject':'test subject',
+        'text':'Hey testing now...'
+    }
+    
+    Output: Hash
+    {
+        'status': 0 || %w(1 2 3 4 5)
+        'message: 'success' || 'failure'
+    }
+    
+    Non-zero status code means it's a failure.
+    
+    1	from email-id invalid
+    2	to/cc/bcc email-id invalid
+    3	subject && text both are empty
+    4	email send failed (working)
+    5	email provider configuration not complete (working)
+
+## Usage
+
+    mail = Email::Delivery::Client.new do
+      from     'me@test.com'
+      to       'you@test.com'
+      subject  'Test subject'
+      body     'Hey testing now...'
+    end
+    
+    mail.dispatch
+    
+## Test
+
+    ### Send email with one email address
+    
+        mail = Email::Delivery::Client.new do
+              from     'me@test.com'
+              to       'you@test.com'
+              subject  'Test subject'
+              body     'Hey testing now...'
+            end
+            
+        output_hash = mail.dispatch
+        {
+          "message": "success", 
+          "status": 0
+        }
+    
+    ### send email with multiple emails,CC and BCC
+    
+         mail = Email::Delivery::Client.new do
+                  from     'me@test.com'
+                  to       ["you@test.com", "you_1@test.com"]
+                  cc       "you_2@test.com"
+                  bcc      "you_3@test.com"
+                  subject  'Test subject'
+                  body     'Hey testing now...'
+               end
+                  
+         output_hash = mail.dispatch
+         {
+             "message": "success", 
+             "status": 0
+         }
+     
+    ### send email and receive error message
+        mail = Email::Delivery::Client.new do
+                      from     'me@test.com'
+                      to       []
+                      cc       "BlahBlah"
+                      bcc      "YoYo"
+                      subject  'Test subject'
+                      body     'Hey testing now...'
+                   end
+                      
+        output_hash = mail.dispatch
+        {
+          "message": "to/cc/bcc email-ids are not valid. Please provide at least one valid to/cc/bcc email address.", 
+          "status": 2
+        }
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Issues
+    Mailgun setting up domain issues: So using the sandbox account where only authorized recepient list can recieve email.
+
+## Improvements
+    Message builder for the mail clients based on the input.
+    Custom ExceptionHandler based on api error codes.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/elitenomad/email-delivery.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "email/delivery"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/email-delivery.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "email/delivery/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "email-delivery"
+  spec.version       = Email::Delivery::VERSION
+  spec.authors       = ["Pranava Swaroop"]
+  spec.email         = ["stalin.pranava@gmail.com"]
+
+  spec.summary       = %q{A service (Backend) that accepts the necessary information and sends emails.}
+  spec.description   = %q{This gem is a service (Backend) that accepts the necessary information and sends emails. It provides an abstraction between two different e-mail sevice providers and quickly falls over to a working provider without affecting the users.}
+  spec.homepage      = "https://www.lifemeasure.com"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "rest-client", '~> 2.0.2'
+
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-mocks", "~> 3.0"
+  spec.add_development_dependency "dotenv", "~> 2.2.1"
+  spec.add_development_dependency "byebug"
+end

data/lib/email/delivery/client.rb

@@ -0,0 +1,50 @@
+=begin
+    This class acts like a interface (delegator to provider).
+    It will
+    - initialize default mail-client(MailGun)
+    - call 'do' method to send the emails.
+    - provide fail-over mechanism
+
+=end
+require 'email/delivery/mailgrun_client'
+require 'email/delivery/sendgrid_client'
+
+module Email
+  module Delivery
+    class Client
+      attr_accessor :from, :to, :cc, :bcc, :subject, :body, :status, :message
+
+      def initialize(from, to, cc, bcc, subject, body)
+        @from = from
+        @to = to
+        @cc = cc
+        @bcc = bcc
+        @subject = subject
+        @body = body
+        @status = nil
+        @message = nil
+      end
+
+      # Goal of this method is to serve email by one of the service providers
+      # In case of a failure return a status code and a failure message.
+      def dispatch
+        response = Email::Delivery::SendgridClient.new.dispatch(from, to, cc, bcc, subject, body)
+        if [200, 202].include?(response[:status])
+          status = 0
+          message = 'success'
+        else
+          response = Email::Delivery::MailgunClient.new.dispatch(from, to, cc, bcc, subject, body)
+          if response[:status] == 200
+            status = 0
+            message = 'success'
+          else
+            status = 4
+            message = "Emails failed in sending. The error message is as followed: #{ response[:message] }"
+          end
+        end
+
+        {status: status, message: message}
+      end
+    end
+  end
+end

data/lib/email/delivery/mailgrun_client.rb

@@ -0,0 +1,52 @@
+=begin
+    This class acts like a interface.
+    It will
+    - initialize default mail-client(MailGun)
+    - call 'do' method to send the emails.
+    - provide fail-over mechanism
+=end
+
+require 'rest-client'
+
+module Email
+  module Delivery
+    class MailgunClient
+      def initialize
+        @api_url = "https://api:#{ENV['MAILGUN_API_KEY']}@#{ENV['MAILGUN_API_URL']}"
+      end
+
+      def dispatch(from, to, cc, bcc, subject, body)
+        response = RestClient.post @api_url, payload(from, to, cc, bcc, subject, body)
+
+        {
+            status: response.code,
+            message: response.description
+        }
+      end
+
+      def payload(from, to, cc, bcc, subject, body)
+        data = {}
+        data[:from] = sandbox_from
+        data[:to] = to
+        data[:subject] = subject
+        data[:text] = body
+        unless cc.nil?
+          data[:cc] = cc
+        end
+
+        unless bcc.nil?
+          data[:bcc] = bcc
+        end
+        data
+      end
+
+      # Requires a custom domain setup
+      # https://app.mailgun.com/app/domains/new to manage custom 'from'
+      def sandbox_from
+        "Mailgun Sandbox <postmaster@sandboxd76a53e1a7614050ad917bab34226253.mailgun.org>"
+      end
+    end
+  end
+end
+
+

data/lib/email/delivery/sendgrid_client.rb

@@ -0,0 +1,89 @@
+=begin
+    This class acts like a interface.
+    It will
+    - initialize default mail-client(MailGun)
+    - call 'do' method to send the emails.
+    - provide fail-over mechanism
+=end
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Email
+  module Delivery
+    class SendgridClient
+      def dispatch(from, to, cc, bcc, subject, body)
+        response = RestClient.post("#{ENV['SENDGRID_API_URL']}", JSON.dump(payload(from, to, cc, bcc, subject, body)), headers=headers_hash)
+
+        {
+            status: response.code,
+            message: response.description
+        }
+      end
+
+      # This method helps to include all recipients defined within the to, cc, and bcc parameters,
+      # across each object that you include in the personalizations array.
+      def personalizations(to, cc, bcc)
+        personalizations_hash = {
+            "to" => recepient_list(to)
+        }
+
+        unless cc.nil?
+          personalizations_hash.merge!({ "cc" => recepient_list(cc) })
+        end
+
+        unless bcc.nil?
+          personalizations_hash.merge!({ "bcc" => recepient_list(cc) })
+        end
+
+        [
+            personalizations_hash
+        ]
+      end
+
+      def from(from)
+        {
+            "email" => from
+        }
+      end
+
+      def content(body)
+        [
+            {
+                "type" => "text/plain",
+                "value" => body
+            }
+        ]
+      end
+
+      def payload(from, to, cc, bcc, subject, body)
+        {
+            "personalizations" => personalizations(to, cc, bcc) ,
+            "from" => from(from) ,
+            "subject" => subject,
+            "content" => content(body)
+        }
+      end
+
+      def headers_hash
+        {
+            "Authorization" => "Bearer #{ENV['SENDGRID_API_KEY']}",
+            "content-type" => "application/json"
+        }
+      end
+
+      def recepient_list(lst)
+        if lst.is_a?(Array)
+          lst.map {|elem| {"email" => elem } }
+        else
+          [
+              {
+                  "email" => lst
+              }
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/email/delivery/version.rb

@@ -0,0 +1,5 @@
+module Email
+  module Delivery
+    VERSION = "0.1.0"
+  end
+end

data/lib/email/delivery.rb

@@ -0,0 +1,8 @@
+require "email/delivery/version"
+require "email/delivery/client"
+
+module Email
+  module Delivery
+    # Your code goes here...
+  end
+end

data/lib/generators/mailgum_creds.rb

@@ -0,0 +1,4 @@
+#this is the configuration file of the Mailgun provider
+
+mailgun_api_url=ENV['MAILGUN_API_URL']
+mailgun_key=ENV['MAILGUN_API_KEY']

data/lib/generators/provider_initializer.rb

@@ -0,0 +1,13 @@
+module Email
+  module Delivery
+    class Generator < Rails::Generators::Base
+      source_root(File.expand_path(File.dirname(__FILE__)))
+
+      desc "This generator creates an initializer file at config/initializers"
+      def copy_initializer_file
+        copy_file 'mailgun_creds.rb', 'config/initializers/mailgun_creds.rb'
+        copy_file 'sendgrid_creds.rb', 'config/initializers/sendgrid_creds.rb'
+      end
+    end
+  end
+end

data/lib/generators/sendgrid_creds.rb

@@ -0,0 +1,4 @@
+#this is the configuration file of the sendgrid
+
+sendgrid_api_url=ENV['SENDGRID_API_URL']
+sendgrid_key=ENV['SENDGRID_API_KEY']

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: email-delivery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pranava Swaroop
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a service (Backend) that accepts the necessary information
+  and sends emails. It provides an abstraction between two different e-mail sevice
+  providers and quickly falls over to a working provider without affecting the users.
+email:
+- stalin.pranava@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- email-delivery.gemspec
+- lib/email/delivery.rb
+- lib/email/delivery/client.rb
+- lib/email/delivery/mailgrun_client.rb
+- lib/email/delivery/sendgrid_client.rb
+- lib/email/delivery/version.rb
+- lib/generators/mailgum_creds.rb
+- lib/generators/provider_initializer.rb
+- lib/generators/sendgrid_creds.rb
+homepage: https://www.lifemeasure.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: A service (Backend) that accepts the necessary information and sends emails.
+test_files: []