quickmail 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35118afcf14f6b0d12429305f1befbf9d636fc339ac6428797e8e69b628b5c49
+  data.tar.gz: '08cb795c83fcc712514371a73ca44d67fb015af680b734d30f1160798d104768'
+SHA512:
+  metadata.gz: e869398ab8d318089d7fc5ba0b2ef74b9f6bb9ced895fd08dd7198ed7b704a3bc25df7d6ce255ca143b68f9345bf8a841c8ebaf56e4cf5404248ca2ebb100a71
+  data.tar.gz: 72c211e74e91a6e3bf5bd390e809e7a96f4c4f39d0eeae61d4854a00f0426c656ac84e3878e337ac1eac079e4084a22e6d5a6e46792957c19a896404f379b82e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Tom Dallimore
+
+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/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'Quickmail'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/quickmail.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+
+require 'quickmail/authentication'
+require 'quickmail/order'
+require 'quickmail/tracking'
+
+module Quickmail
+
+  API_BASE = Quickmail.test_mode ? "https://quickmailonline.com.au/api/test"  : "https://quickmailonline.com.au/api/"
+
+  class QuickmailError < StandardError
+  end
+
+  class AuthenticationError < QuickmailError;
+  end
+  class ConfigurationError < QuickmailError;
+  end
+  class ApiRequestError < QuickmailError
+    attr_reader :response_code, :response_headers, :response_body
+
+    def initialize(response_code:, response_headers:, response_body:)
+      @response_code = response_code
+      @response_headers = response_headers
+      @response_body = response_body
+    end
+  end
+
+  class << self
+    def access_token
+      defined? @access_token and @access_token or raise(
+        ConfigurationError, "Quickmail access token not configured"
+      )
+    end
+
+    def api_version
+      defined? @api_version and @api_version or raise(
+        ConfigurationError, "Quickmail api version not configured"
+      )
+    end
+
+    def test_mode
+      @test_mode
+    end
+
+    attr_writer :access_token, :api_version, :test_mode
+
+    def request(method, resource, params = {})
+      ss_access_token = Quickmail.access_token
+      ss_api_version = Quickmail.api_version
+
+      defined? method or raise(
+        ArgumentError, "Request method has not been specified"
+      )
+      defined? resource or raise(
+        ArgumentError, "Request resource has not been specified"
+      )
+      if method == :get
+        headers = {accept: :json, content_type: :json, access_token: ss_access_token}.merge({params: params})
+        payload = nil
+      else
+        headers = {accept: :json, content_type: :json, access_token: ss_access_token}
+        payload = params
+      end
+      RestClient::Request.new({
+                                method: method,
+                                url: API_BASE + ss_api_version + '/' + resource,
+                                payload: payload ? payload.to_json : nil,
+                                headers: headers
+                              }).execute do |response, request, result|
+        if response.code != 200
+          raise ApiRequestError.new(
+            response_code: response.code,
+            response_headers: response.headers,
+            response_body: response.to_str
+          )
+        end
+        str_response = response.to_str
+        str_response.blank? ? '' : JSON.parse(str_response)
+      end
+    end
+
+    def datetime_format(datetime)
+      datetime.strftime("%Y-%m-%d %T")
+    end
+  end
+end

data/lib/quickmail/authentication.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Quickmail
+  class Authentication
+
+    class << self
+      def oauth(payload = {})
+        RestClient::Request.new({
+            method: :post,
+            url: API_BASE + '/token',
+            payload: payload ? payload.to_json : nil,
+            headers: {content_type: "application/x-www-form-urlencoded"}
+          }).execute do |response, request, result|
+          if response.code != 201
+            raise ApiRequestError.new(
+              response_code: response.code,
+              response_headers: response.headers,
+              response_body: response.to_str
+            )
+          end
+          response
+        end
+      end
+    end
+  end
+end

data/lib/quickmail/order.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Quickmail
+  class Order
+
+    class << self
+      def create(params = {})
+        response = Quickmail.request(:post, 'orders', params)
+
+        response
+      end
+    end
+  end
+end

data/lib/quickmail/tracking.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Quickmail
+  class Tracking
+
+    class << self
+      def poll(params = {})
+        response = Quickmail.request(:get, 'tracking', params)
+
+        response
+      end
+    end
+  end
+end

data/lib/quickmail/version.rb

@@ -0,0 +1,3 @@
+module Quickmail
+  VERSION = "0.4.0"
+end

data/lib/tasks/quickmail_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :quickmail do
+#   # Task goes here
+# end

data/test/dummy/Gemfile

@@ -0,0 +1,54 @@
+source 'http://rubygems.org'
+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.2.7'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 5.0'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .coffee assets and views
+gem 'coffee-rails', '~> 4.1.0'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.0'
+# bundle exec rake doc:rails generates the API under doc/api.
+gem 'sdoc', '~> 0.4.0', group: :doc
+
+gem 'ffi', '~> 1.9.24'
+gem 'sprockets', '~> 3.7.2'
+
+gem 'rest-client'
+gem 'Quickmail'
+
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug'
+end
+
+group :development do
+  # Access an IRB console on exception pages or by using <%= console %> in views
+  gem 'web-console', '~> 2.0'
+
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+end
+

data/test/dummy/Gemfile.lock

@@ -0,0 +1,191 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    Quickmail (0.1.0)
+      rest-client (~> 2)
+    actionmailer (4.2.7)
+      actionpack (= 4.2.7)
+      actionview (= 4.2.7)
+      activejob (= 4.2.7)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.7)
+      actionview (= 4.2.7)
+      activesupport (= 4.2.7)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.7)
+      activesupport (= 4.2.7)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.7)
+      activesupport (= 4.2.7)
+      globalid (>= 0.3.0)
+    activemodel (4.2.7)
+      activesupport (= 4.2.7)
+      builder (~> 3.1)
+    activerecord (4.2.7)
+      activemodel (= 4.2.7)
+      activesupport (= 4.2.7)
+      arel (~> 6.0)
+    activesupport (4.2.7)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.4)
+    binding_of_caller (0.8.0)
+      debug_inspector (>= 0.0.1)
+    builder (3.2.3)
+    byebug (10.0.2)
+    coffee-rails (4.1.1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.1.x)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.12.2)
+    concurrent-ruby (1.0.5)
+    crass (1.0.6)
+    debug_inspector (0.0.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    erubis (2.7.0)
+    execjs (2.7.0)
+    ffi (1.9.25)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jbuilder (2.7.0)
+      activesupport (>= 4.2.0)
+      multi_json (>= 1.2)
+    jquery-rails (4.3.3)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.6)
+    loofah (2.5.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    netrc (0.11.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    rack (1.6.13)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.7)
+      actionmailer (= 4.2.7)
+      actionpack (= 4.2.7)
+      actionview (= 4.2.7)
+      activejob (= 4.2.7)
+      activemodel (= 4.2.7)
+      activerecord (= 4.2.7)
+      activesupport (= 4.2.7)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.7)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.9)
+      activesupport (>= 4.2.0, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (4.2.7)
+      actionpack (= 4.2.7)
+      activesupport (= 4.2.7)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (13.0.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rdoc (4.3.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    sass (3.5.7)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    sass-rails (5.0.7)
+      railties (>= 4.0.0, < 6)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (>= 1.1, < 3)
+    sdoc (0.4.2)
+      json (~> 1.7, >= 1.7.7)
+      rdoc (~> 4.0)
+    spring (2.0.2)
+      activesupport (>= 4.2)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    turbolinks (5.2.0)
+      turbolinks-source (~> 5.2)
+    turbolinks-source (5.2.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    uglifier (4.1.18)
+      execjs (>= 0.3.0, < 3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    web-console (2.3.0)
+      activemodel (>= 4.0)
+      binding_of_caller (>= 0.7.2)
+      railties (>= 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  Quickmail
+  byebug
+  coffee-rails (~> 4.1.0)
+  ffi (~> 1.9.24)
+  jbuilder (~> 2.0)
+  jquery-rails
+  rails (= 4.2.7)
+  rest-client
+  sass-rails (~> 5.0)
+  sdoc (~> 0.4.0)
+  spring
+  sprockets (~> 3.7.2)
+  sqlite3
+  turbolinks
+  uglifier (>= 1.3.0)
+  web-console (~> 2.0)
+
+BUNDLED WITH
+   1.14.6