smtp2go 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4155068c14c95b7f38616a5c2b45742957755a01
+  data.tar.gz: 71dca8df7287bf32c467969bd2ac419d1a193d9e
+SHA512:
+  metadata.gz: 9812d58cf9c8a20530efc2a40d1654fa47c02d67f7b803e702863e91c8c01738b9eed5fc848f779d72eb6561d8c4d0a4bdb810b0dc1a213f941dfb54748c64ff
+  data.tar.gz: 4915f1df675785fa8ef538d53c186dc0a059f4de601ac0ab20592dc1cd30f3dba8f324a534112b7130c4b1ee2c476443413d6eacb9816d715d8505003a02e53d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+- 2.3.1
+before_install: gem install bundler -v 1.13.7
+notifications:
+  slack:
+    template:
+      - "Build status: 👻%{result}👻 in %{duration} "
+      - "<%{build_url}|#%{build_number}> (<%{compare_url}|%{commit}>) of %{repository}@%{branch} by %{author}"
+    secure: VukzX7mAGmtiPlKGVk2HUy2lcs/ukgLcg5/PZv4KPgmckmjxhPcho2b3j0vpO/soMuLxStUwsUSqqp0SW8lZrkn43Szb9ijHtQLYVi9ADAXegiC6O6p/uelhzqyu+OVvGqRMrTfUPhhNCWbis6RSQEZcROJPMBQLgPF0MuPXAwWV12eL8u/0LsfT0EP9m8rle7bRPexBiDNJiNJj9M3GZz/ZNpBakRLjEUH6OBiG6dTXQx2W6jizKf+/Nu3MH52FydJIXvwzpFiiTLz7GRW3BCyL0hCTw7ya/IOr/4Fh416hQ6cNRyIsPyzmBZYILuJVQdhMjRdIfr29yUPgms3aWYx5uQ2GwgZ6FRvdnLrtOHXcDmUgj/r2IB9K7aVtQnS0BXzS3e745BgyufwH3/lJsebZ2KbMtBN3utcinSn2uAgTPVGUQlrxvOPp5jac7zisdIQwrNBoVY/pipybp/jzG/6be5lLBxTQM9UmXoZSXfy4D4Rfcr+w6eZqbbTYJ0EJmPFc+b1rDVaqxS1BTTYWq4dJVL6hAMR4Gb9wSM+iFQi536S49P/+ZuVvw4WtG4+i2eFkfFZzbt82pVRClYr8Ip8RJ8oQrpGb0N9CsRG5PrQLch6mNR+/njMkZfFTYqyWjVpg73g8TMSzg871tG7jESgOs2rAEBSbW+adfAvQixo=

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'rspec --format documentation', :all_on_start => true do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 smtp2go
+
+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,58 @@
+# Smtp2go
+
+Library for interfacing with the [https://apidoc.smtp2go.com/documentation/#/README](SMTP2Go API)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smtp2go'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smtp2go
+
+## Usage
+
+Sign up for a free account [here](https://www.smtp2go.com/pricing) and get an API key. At your shell, run:
+
+    $ export SMTP2GO_API_KEY="<your_API_key>"
+
+Then sending mail is as simple as:
+
+    require 'smtp2go'
+
+    smtp2go_client = Smtp2go::Smtp2goClient.new
+
+    payload = {
+      :sender=>"dave@example.com",
+      :recipients=>["matt@example.com"],
+      :subject=>"Trying out smtp2go!",
+      :message=>"Test Message"
+    }
+
+    response = smtp2go_client.send(payload)
+
+Full API documentation can be found [here](https://apidoc.smtp2go.com/documentation/#/README)
+
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/smtp2go-oss/smtp2go.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "smtp2go"
+
+# 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

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/lib/smtp2go.rb

@@ -0,0 +1,4 @@
+require 'smtp2go/core'
+
+module Smtp2go
+end

data/lib/smtp2go/core.rb

@@ -0,0 +1,76 @@
+require 'json'
+require 'httparty'
+require 'smtp2go/exceptions'
+require 'smtp2go/settings'
+
+module Smtp2go
+  # Ruby Library for interacting with the smtp2go API
+
+  class Smtp2goClient
+    attr_reader :headers, :send_endpoint
+    def initialize
+      @api_key = ENV['SMTP2GO_API_KEY']
+      @headers = HEADERS
+      @send_endpoint = SEND_ENDPOINT
+      raise Smtp2goAPIKeyException,
+        'smtp2go requires SMTP2GO_API_KEY Environment Variable to be set' if not @api_key
+    end
+
+    # @param sender [String] the from email address
+    # @param recipients [Array <String>] the recipient email addresses
+    # @param subject [String] the email subject
+    # @param body [String] the email body
+    # @return [Smtp2goResponse] response object
+    def send(sender:, recipients:, subject:, message:)
+      payload = {
+        'api_key' => @api_key,
+        'sender' => sender,
+        'to' => recipients,
+        'subject' => subject,
+        'text_body' => message,
+      }
+      response = HTTParty.post(
+        @send_endpoint,
+        :body => JSON.dump(payload),
+        :headers => @headers)
+      return Smtp2goResponse.new response
+    end
+  end
+
+  class Smtp2goResponse
+    attr_reader :rate_limit
+    def initialize response
+      @response = response
+      @rate_limit = RateLimit.new @response.headers
+    end
+
+    def json
+      JSON.parse @response.body
+    end
+
+    def success?
+      self.json['data']['succeeded'] ? true : false
+    end
+
+    def errors
+      self.json['data']['error']
+    end
+
+    def request_id
+      self.json['request_id']
+    end
+
+    def status_code
+      @response.code
+    end
+  end
+
+  class RateLimit
+    attr_reader :limit, :remaining, :reset
+    def initialize headers
+      @limit = headers['x-ratelimit-limit']
+      @remaining = headers['x-ratelimit-remaining']
+      @reset = headers['x-ratelimit-reset']
+    end
+  end
+end

data/lib/smtp2go/exceptions.rb

@@ -0,0 +1,4 @@
+module Smtp2go
+  class Smtp2goAPIKeyException < StandardError
+  end
+end

data/lib/smtp2go/settings.rb

@@ -0,0 +1,12 @@
+require 'smtp2go/version'
+
+module Smtp2go
+  API_ROOT = 'https://api.smtp2go.com/v3/'
+  API_SEND_URL = 'email/send'
+  SEND_ENDPOINT = API_ROOT + API_SEND_URL
+  HEADERS = {
+    'Content-Type' => 'application/json',
+    'X-Smtp2go-Api' => 'smtp2go-ruby',
+    'X-Smtp2go-Api-Version' => VERSION,
+  }
+end

data/lib/smtp2go/version.rb

@@ -0,0 +1,3 @@
+module Smtp2go
+  VERSION = "0.0.1"
+end

data/smtp2go.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smtp2go/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smtp2go"
+  spec.version       = Smtp2go::VERSION
+  spec.authors       = ["smtp2go"]
+  spec.email         = ["devs@smtp2go.com"]
+
+  spec.summary       = %q{Library for interfacing with smtp2go API}
+  spec.description   = %q{Interacts directly with smtp2go's API to facilitate sending of email.}
+  spec.homepage      = "https://github.com/smtp2go-oss/smtp2go-ruby.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency 'guard', '~> 2.13', '>= 2.13.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.6', '>= 4.6.4'
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.3'
+  spec.add_development_dependency 'webmock', '~> 2.3', '>= 2.3.2'
+  spec.add_runtime_dependency "httparty", "~> 0.14.0"
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: smtp2go
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- smtp2go
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+- !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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Interacts directly with smtp2go's API to facilitate sending of email.
+email:
+- devs@smtp2go.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smtp2go.rb
+- lib/smtp2go/core.rb
+- lib/smtp2go/exceptions.rb
+- lib/smtp2go/settings.rb
+- lib/smtp2go/version.rb
+- smtp2go.gemspec
+homepage: https://github.com/smtp2go-oss/smtp2go-ruby.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Library for interfacing with smtp2go API
+test_files: []