smtp2go 0.0.1 → 1.0.0

checksums.yaml

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

data/.travis.yml

@@ -1,11 +1,15 @@
 sudo: false
 language: ruby
 rvm:
-- 2.3.1
+- 2.4.1
+- 2.3.3
+- 2.2.6
+- 2.1.10
 before_install: gem install bundler -v 1.13.7
+service_name: travis-ci
 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=
+    secure: SwkR+0rZUYXK/nvYa6PBYj310weZNQyHrMFp+lqW+9vmrvefJ25LJ7qhOM7HV4lpFWC1dkSNcrnATFia77ufS4b77VaGewl2r+Olx4UuXJiPKeyigATnc3djZ9VDSXXqMojf0D0NxC+xyq0k4v5CKZvv3CUoU6fnJZd0hwHGRMFPuZbL7uQu0PD0lryhg/QhzXgGWPA80h0IioehyAAJ1mmDF0y9yUckzMDfeyIhVmJD22IwNeezpqpZknkAo35Ev43pRTZlo3A2+WzuZoNY9lPRwoC+kMEzhQqBRNj4OanCPo7iCId152qLjnJdoukSAso3AEa7SoQr3SRduYuAvj8X7ItWnzGKNCSyatBnAU6fXcbRaRHNaqTCAUYBx6dWV5xqRa20EYKX97xLGRA4hIxLHeS3pZckcBoi1O81cLsXbBtT1hxffy48gpxANf0a2+pjkMz61BbnPhfNEvH/SmZUsyLBQTZp9LIKX54qT5Gwr8aGVl638UK70r9PqBL5yGIOCIWUtUGAipSAHkDFfe2l6w3sIqXNP9P4RuVSQhon1LzS/rMXU9PUqka5Dzvnn4+ndiqNm+QfwUKJznYeROhY+tO/VIbZ/T3LGReyf103rvpiIuNzkU5ZL6PQubgoVhN4cjK29zEcMygtZPmqmIqf2PPTURCD+XZ5BiQP/+4=
+env:
+  global:
+    secure: QZFzauATbVLgE4XpZXB2RXHc1ZbqdW7ErbPCRah1QYEnEvUhKRNWuXNCg1HZEYy6BsKJtiJBEMh5lnwfYwnui+ZfEwvSGttamQxcU7ymOZK3LUVsg6LC5oObpgeaUzl+6CeLYjrf3cUjUBJ4GnVoxTbRk5+UyKORWnUyMn/p9/CLkz7rwCsMnTIFFZDcvdZEeAhHq/UchKpfKb0cQJWO4rLBTr9Qf5SlCr5lhg3pUOnqN8O1DMV2TqoTsU+X5RePYR+9EnGPAQ5axQwM1MQQCip71rGT1EDctKbuzvvVkd0bz+Q6Hz/SfdpQ9sEG3tzb8/tiU/Hrwp7D6k7f2KoZXjJMlP3fEWSrw1t2h9GymuVwbRU0CJzI0CGOebHdGnTAdJwavrT7KCFyOpxjI0tWUu6s0BzooDtFtnLyYHQ/91GmesQ1Bv+Y6CxOMM7uq9i8uFq5Y+EGnHNIz/MaSP39dkuJuwXWxLjA4sc8CGexxLvGYI7M5upaF06KJQnSbjVhDK7O5YPT4/3y1+Q3uveKESXqqu8peZWNnYN3KLXV0mTzRsHxk3FQF12ADjyqjIwzdvk/i1GO68qKnQvxJMQCVrMPYXtbUQNwJOgGFMmwQGM8yX6fWqPLRv41h9PScv+ZjUtHiy8B4SirXY1mTqlUu3GRPGXVkwtdxw5Dlc540aA=

data/Guardfile

@@ -1,5 +1,5 @@
-guard :rspec, cmd: 'rspec --format documentation', :all_on_start => true do
+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" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 end

data/README.md

@@ -1,6 +1,16 @@
-# Smtp2go
+[![Build Status](https://travis-ci.org/smtp2go-oss/smtp2go-ruby.svg?branch=master)](https://travis-ci.org/smtp2go-oss/smtp2go-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/smtp2go-oss/smtp2go-ruby/badge.svg?branch=master)](https://coveralls.io/github/smtp2go-oss/smtp2go-ruby?branch=master)
+[![Gem Version](https://badge.fury.io/rb/smtp2go.svg)](https://badge.fury.io/rb/smtp2go)
+[![Dependency Status](https://gemnasium.com/badges/github.com/smtp2go-oss/smtp2go-ruby.svg)](https://gemnasium.com/github.com/smtp2go-oss/smtp2go-ruby)
+[![Code Climate](https://codeclimate.com/github/smtp2go-oss/smtp2go-ruby/badges/gpa.svg)](https://codeclimate.com/github/smtp2go-oss/smtp2go-ruby)
+[![Issue Count](https://codeclimate.com/github/smtp2go-oss/smtp2go-ruby/badges/issue_count.svg)](https://codeclimate.com/github/smtp2go-oss/smtp2go-ruby)
+[![license](https://img.shields.io/github/license/smtp2go-oss/smtp2go-ruby.svg)]()
 
-Library for interfacing with the [https://apidoc.smtp2go.com/documentation/#/README](SMTP2Go API)
+# smtp2go
+
+Library for interfacing with the [smtp2go API](https://apidoc.smtp2go.com/documentation/#/README)
+
+We also have a [Ruby on Rails Library ](https://github.com/smtp2go-oss/smtp2go-rails)
 
 ## Installation
 
@@ -24,22 +34,52 @@ Sign up for a free account [here](https://www.smtp2go.com/pricing) and get an AP
 
     $ 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)
+Here is a REPL session showing a successful send and probing of the response object:
+
+    [1] pry(main)> require 'smtp2go'
+    => true
+    [2] pry(main)> client = Smtp2go::Smtp2goClient.new
+    => #<Smtp2go::Smtp2goClient:0x007fb6ee17b108
+     @api_key="<redacted>",
+     @headers=
+      {"Content-Type"=>"application/json",
+       "X-Smtp2go-Api"=>"smtp2go-ruby",
+    [3] pry(main)> payload = {
+    [3] pry(main)*>   sender: 'dave@example.com',
+    [3] pry(main)*>   recipients: ['matt@example.com'],
+    [3] pry(main)*>   subject: 'Test Message',
+    [3] pry(main)*>   text: 'Test message',
+    [3] pry(main)*>   html: '<html><body><h1>Test HTML message</h1></body></html>'}</html>'}
+    => {:sender=>'dave@example.com',
+     :recipients=>['matt@example.com'],
+     :subject=>'Test Message',
+     :text=>'Test message',
+     :html=>'<html><body><h1>Test HTML message</h1></body></html>'}</html>'}
+    [4] pry(main)> response = client.send payload
+    => #<Smtp2go::Smtp2goResponse:0x007fb6ee268840
+     @rate_limit=
+      #<Smtp2go::RateLimit:0x007fb6ee268818
+       @limit="250",
+       @remaining="250",
+       @reset="51">,
+     @response=
+      {"request_id"=>"<redacted>",
+       "data"=>{"failures"=>[], "succeeded"=>1, "failed"=>0}}>
+    [5] pry(main)> response.rate_limit
+    => #<Smtp2go::RateLimit:0x007fb6ee268818
+     @limit="250",
+     @remaining="250",
+     @reset="51">
+    [6] pry(main)> response.success?
+    => true
+    [7] pry(main)> response.errors
+    => nil
+    [8] pry(main)> response.json
+    => {"request_id"=>"<redacted>",
+     "data"=>{"failures"=>[], "succeeded"=>1, "failed"=>0}}
+    [9] pry(main)>
+
+Full API documentation can be found [here](https://apidoc.smtp2go.com/documentation/#/README), with Ruby specific docs [here](http://www.rubydoc.info/gems/smtp2go/0.0.1) 
 
 
 ## Development
@@ -50,7 +90,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/smtp2go-oss/smtp2go.
+Bug reports and pull requests are welcome on GitHub at https://github.com/smtp2go-oss/smtp2go-ruby.
 
 
 ## License

data/Rakefile

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

data/lib/smtp2go/core.rb

@@ -5,41 +5,45 @@ require 'smtp2go/settings'
 
 module Smtp2go
   # Ruby Library for interacting with the smtp2go API
-
   class Smtp2goClient
+    # Client to handle API interfacing
     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
+      raise Smtp2goAPIKeyException unless @api_key
     end
 
     # @param sender [String] the from email address
-    # @param recipients [Array <String>] the recipient email addresses
+    # @param recipients [Array <String>] the email address of the recipient(s)
     # @param subject [String] the email subject
-    # @param body [String] the email body
+    # @param text [String] the email text content (optional if html is passed)
+    # @param html [String] the email html content (optional if text is passed)
     # @return [Smtp2goResponse] response object
-    def send(sender:, recipients:, subject:, message:)
+    def send(sender:, recipients:, subject:, text: nil, html: nil)
+      raise Smtp2goParameterException unless [html, text].any?
       payload = {
-        'api_key' => @api_key,
-        'sender' => sender,
-        'to' => recipients,
-        'subject' => subject,
-        'text_body' => message,
+        api_key: @api_key,
+        sender: sender,
+        to: recipients,
+        subject: subject,
+        text_body: text,
+        html_body: html
       }
       response = HTTParty.post(
         @send_endpoint,
-        :body => JSON.dump(payload),
-        :headers => @headers)
-      return Smtp2goResponse.new response
+        body: JSON.dump(payload),
+        headers: @headers
+      )
+      Smtp2goResponse.new response
     end
   end
 
+  # Wraps response object with smtp2go specific data
   class Smtp2goResponse
     attr_reader :rate_limit
-    def initialize response
+    def initialize(response)
       @response = response
       @rate_limit = RateLimit.new @response.headers
     end
@@ -49,15 +53,15 @@ module Smtp2go
     end
 
     def success?
-      self.json['data']['succeeded'] ? true : false
+      json['data']['succeeded'] ? true : false
     end
 
     def errors
-      self.json['data']['error']
+      json['data']['error']
     end
 
     def request_id
-      self.json['request_id']
+      json['request_id']
     end
 
     def status_code
@@ -65,9 +69,10 @@ module Smtp2go
     end
   end
 
+  # Rate limiting class to be attached to response
   class RateLimit
     attr_reader :limit, :remaining, :reset
-    def initialize headers
+    def initialize(headers)
       @limit = headers['x-ratelimit-limit']
       @remaining = headers['x-ratelimit-remaining']
       @reset = headers['x-ratelimit-reset']

data/lib/smtp2go/exceptions.rb

@@ -1,4 +1,16 @@
 module Smtp2go
-  class Smtp2goAPIKeyException < StandardError
+  class Smtp2goBaseException < StandardError
+  end
+
+  class Smtp2goAPIKeyException < Smtp2goBaseException
+    def message
+      'Smtp2go requires SMTP2GO_API_KEY Environment Variable to be set'
+    end
+  end
+
+  class Smtp2goParameterException < Smtp2goBaseException
+    def message
+      'send call requires either text or html arguments'
+    end
   end
 end

data/lib/smtp2go/settings.rb

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

data/lib/smtp2go/version.rb

@@ -1,3 +1,3 @@
 module Smtp2go
-  VERSION = "0.0.1"
+  VERSION = '1.0.0'.freeze
 end

data/smtp2go.gemspec

@@ -30,12 +30,13 @@ Gem::Specification.new do |spec|
   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 'bundler', '~> 1.13'
+  spec.add_development_dependency 'coveralls', '~> 0.8.19'
   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 'rake', '~> 12.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"
+  spec.add_runtime_dependency 'httparty', '~> 0.14.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smtp2go
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - smtp2go
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-13 00:00:00.000000000 Z
+date: 2017-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.19
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.19
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -70,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement