deliverhq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e462abbcfd6e358d7e20738bd40256f8a8c566f2
+  data.tar.gz: 83c3930d8c6b9c28fce1d882b6f95102d2947d67
+SHA512:
+  metadata.gz: fee3b3845568a30620a9190747862a72ee7e6235f531edda741754f5ac53098b4527ccd772e36978bfea2650cd1e2431d544265145071114a1aef64ea3815895
+  data.tar.gz: 84970634bc7d6a533819426cd3db0845bf619f41a04a8bd9de6962e6d6c7d60963cee5b7fa6118e88450ca2e26f24790698cb3cf2cd6232bce10a766be7a2bdb

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+.DS_Store

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    deliverhq (0.0.1)
+      faraday (~> 0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    coveralls (0.8.2)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    docile (1.1.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    json (1.8.3)
+    mime-types (2.6.1)
+    minitest (5.8.0)
+    multipart-post (2.0.0)
+    netrc (0.10.3)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    safe_yaml (1.0.4)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.5.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+    vcr (2.9.3)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls (~> 0.8)
+  deliverhq!
+  minitest (~> 5.3)
+  rake (~> 10.4)
+  simplecov (~> 0.9)
+  vcr (~> 2.8)
+  webmock (~> 1.8)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2015, DataCentred Ltd
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,115 @@
+# DeliverHQ
+
+Rubygem wrapper for [deliverHQ](http://www.deliverhq.com/) API.
+
+[![Build Status](https://travis-ci.org/datacentred/deliverhq.svg)](https://travis-ci.org/datacentred/deliverhq) [![Coverage Status](https://coveralls.io/repos/datacentred/deliverhq/badge.svg?branch=master&service=github)](https://coveralls.io/github/datacentred/deliverhq?branch=master)
+
+## Installing
+
+```
+gem install deliverhq
+```
+
+or
+
+(in Gemfile or .gemspec)
+```ruby
+gem 'deliverhq'
+```
+
+then
+
+```ruby
+require 'deliverhq'
+```
+
+## Usage
+
+### Authentication
+
+Set your API ID and key using the two environment variables, `DELIVERHQ_ID` and `DELIVERHQ_KEY`. This can be found in the "Setup" section of your DeliverHQ account.
+
+### Sending E-Mail
+
+```ruby
+Deliverhq::send(from: 'you@yourdomain.com', to: 'recipient@theirdomain.com', subject: 'Hello!', plain_body: 'This is a test.')
+#=> #<Deliverhq::Message:0x007fc79...
+```
+
+### Domains
+
+```ruby
+# Retrieve all domains associated with your account
+Deliverhq::Domain.all
+#=> [#<Deliverhq::Domain:0x007fc79c1..]
+
+# Create a new domain
+domain = Deliverhq::Domain.create(name: 'test.com')
+#=> #<Deliverhq::Domain:0x007fc79c134a78 @id=7970, @account_id=506, @name="test.com", @verification_token="punqv7acjm", @verified_at=nil>
+
+# And remove it
+domain.destroy
+#=> true
+```
+
+### Mailboxes
+
+```ruby
+# Retrieve all mailboxes associated with your account
+Deliverhq::Mailbox.all
+#=> [#<Deliverhq::Mailbox:0x007fc79c2...
+
+# Create a new mailbox
+mailbox = Deliverhq::Mailbox.create(name: 'Incoming Support',
+        check_spam: 0,
+        destination_address: 'http://app.sirportly.com/modules/deliver2/accept',
+        destination_type: 'http',
+        domain_id: 6707,
+        encoding:'post',
+        format: 'full',
+        reply_stripping: false,
+        partial_address: 'support')
+
+# And remove it
+mailbox.destroy
+#=> true
+```
+
+### Messages
+
+```ruby
+# Retrieve messages by page
+page = 1
+Deliverhq::Message.all(page)
+#=> [#<Deliverhq::Message:0x007f88e29...
+page = 2
+Deliverhq::Message.all(page)
+#=> [#<Deliverhq::Message:0x008ef62a9...
+page = 999
+Deliverhq::Message.all(page)
+#=> []
+
+# Show individual message
+Deliverhq::Message.find(226945)
+#=> #<Deliverhq::Message:0x007f88e2998a28 @id=222697445, @envelope_to ...
+```
+
+### Handling Errors
+
+If the API reports an error, the gem will raise the message as an exception of type `Deliverhq::RequestError`. e.g.
+
+```ruby
+domain = Deliverhq::Domain.create(name: 'test.com')
+#=> #<Deliverhq::Domain:0x007fc79c134a78 @id=7970, @account_id=506, @name="test.com", @verification_token="punqv7acjm", @verified_at=nil>
+
+domain.destroy
+#=> true
+
+# Try to remove it after it's been removed
+domain.destroy
+#=> Deliverhq::RequestError: Server responded with 404: {"error":"Not Found"}
+```
+
+## Further Reading
+
+You can learn more about the DeliverHQ API here: [http://deliver.apidoc.io/](http://deliver.apidoc.io/).

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+namespace :test do
+  Rake::TestTask.new("unit") do |t|
+    t.libs << 'test'
+    t.pattern = "#{File.dirname(__FILE__)}/test/all.rb"
+  end
+
+  Rake::TestTask.new("integration") do |t|
+    t.libs << 'test'
+    t.pattern = "#{File.dirname(__FILE__)}/test/integration/*_test.rb"
+  end
+end
+
+desc "Run tests"
+task :test => ["test:integration", "test:unit"]
+
+task :default => :test

data/deliverhq.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |gem|
+  gem.name = 'deliverhq'
+  gem.version = '0.0.1'
+  gem.date = '2015-08-10'
+  gem.summary = 'deliverhq'
+  gem.description = 'DeliverHQ API wrapper'
+  gem.authors = [ 'Sean Handley' ]
+  gem.email = 'sean.handley@gmail.com'
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'https://github.com/datacentred/deliverhq'
+  gem.license = 'BSD-3-Clause'
+  
+  gem.required_ruby_version = '> 2.1.0'
+  
+  # Runtime Dependencies
+  gem.add_runtime_dependency 'faraday', '~> 0.9'
+  
+  # Development Dependencies
+  gem.add_development_dependency 'vcr', '~> 2.8'
+  gem.add_development_dependency 'webmock', '~> 1.8'
+  gem.add_development_dependency 'minitest', '~> 5.3'
+  gem.add_development_dependency 'simplecov', '~> 0.9'
+  gem.add_development_dependency 'yard', '~> 0.8'
+  gem.add_development_dependency 'coveralls', '~> 0.8'
+  gem.add_development_dependency 'rake', '~> 10.4'
+
+end

data/lib/deliverhq.rb

@@ -0,0 +1,33 @@
+require 'faraday'
+require 'json'
+require 'date'
+
+module Deliverhq
+
+  require_relative 'deliverhq/request/base'
+  require_relative 'deliverhq/response'
+
+  require_relative 'deliverhq/request/domain/create'
+  require_relative 'deliverhq/request/domain/delete'
+  require_relative 'deliverhq/request/domain/list'
+
+  require_relative 'deliverhq/request/mailbox/create'
+  require_relative 'deliverhq/request/mailbox/delete'
+  require_relative 'deliverhq/request/mailbox/list'
+
+  require_relative 'deliverhq/request/message/list'
+  require_relative 'deliverhq/request/message/show'
+  
+  require_relative 'deliverhq/models/domain'
+  require_relative 'deliverhq/models/mailbox'
+  require_relative 'deliverhq/models/message'
+  
+
+  class RequestError < StandardError; end
+
+  def self.send(params)
+    response = Request::Base.http_post('send', params.to_json)
+    message_id = response.split(':').last.to_i
+    Message.find(message_id)
+  end
+end

data/lib/deliverhq/models/domain.rb

@@ -0,0 +1,29 @@
+module Deliverhq
+  class Domain
+    
+    attr_reader :id, :account_id, :name, :verification_token, :verified_at
+
+    def initialize(params)
+      @id = params['id']
+      @account_id = params['account_id']
+      @name = params['name']
+      @verification_token = params['verification_token']
+      @verified_at = params['verified_at']
+    end
+
+    def self.create(params)
+      new(Request::Domain.create(params))
+    end
+
+    def self.all
+      Request::Domain.list.collect do |domain|
+        new domain
+      end
+    end
+
+    def destroy
+      Request::Domain.destroy(id)
+    end
+
+  end
+end

data/lib/deliverhq/models/mailbox.rb

@@ -0,0 +1,47 @@
+module Deliverhq
+  class Mailbox
+    
+    attr_reader :id, :name, :check_spam, :destination_address,
+                :destination_type, :domain_id, :encoding, :format,
+                :reply_stripping, :partial_address,
+                :account_id, :server_id, :domain,
+                :address, :created_at, :forwarding_token,
+                :verification_token,:verified_at
+
+    def initialize(params)
+      @id = params['id']
+      @name = params['name']
+      @check_spam = params["check_spam"]
+      @destination_address = params["destination_address"]
+      @destination_type = params["destination_type"]
+      @domain_id = params["domain_id"]
+      @encoding = params["encoding"]
+      @format = params["format"]
+      @reply_stripping = params["reply_stripping"]
+      @partial_address = params["partial_address"]
+      @account_id = params["account_id"]
+      @server_id = params["server_id"]
+      @domain = params["domain"]
+      @address = params["address"]
+      @created_at = params["created_at"]
+      @forwarding_token = params["forwarding_token"]
+      @verification_token = params["verification_token"]
+      @verified_at = params["verified_at"]
+    end
+
+    def self.create(params)
+      new(Request::Mailbox.create(params))
+    end
+
+    def self.all
+      Request::Mailbox.list.collect do |mailbox|
+        new mailbox
+      end
+    end
+
+    def destroy
+      Request::Mailbox.destroy(id)
+    end
+
+  end
+end

data/lib/deliverhq/models/message.rb

@@ -0,0 +1,39 @@
+module Deliverhq
+  class Message
+    
+    attr_reader :id, :envelope_to, :envelope_from,
+                :subject, :status, :error, :server_id,
+                :mailbox_id, :status_code, :body,
+                :bounce_body, :spam, :address_identifier,
+                :body_to, :body_from
+
+    def initialize(params)
+      @id = params["id"]
+      @envelope_to = params["envelope_to"]
+      @envelope_from = params[ "envelope_from"]
+      @subject = params["subject"]
+      @status = params["status"]
+      @error = params["error"]
+      @server_id = params[ "server_id"]
+      @mailbox_id = params[ "mailbox_id"]
+      @status_code = params[ "status_code"]
+      @body = params[ "body"]
+      @bounce_body = params[ "bounce_body"]
+      @spam = params[ "spam"]
+      @address_identifier = params["address_identifier"]
+      @body_to = params[ "body_to"]
+      @body_from = params[ "body_from"]
+    end
+
+    def self.find(id)
+      new(Request::Message.show(id))
+    end
+
+    def self.all(page=1)
+      Request::Message.list(page).collect do |message|
+        new message
+      end
+    end
+
+  end
+end