maileon 0.1.0

data/README.md

@@ -0,0 +1,85 @@
+# Maileon [![Build Status](http://travis-ci.org/interactive-pioneers/maileon.svg?branch=master)](https://travis-ci.org/interactive-pioneers/maileon)
+
+Ruby wrapper for Maileon email marketing software API.
+
+- Supported Ruby versions:
+  - 2.2.1 (strongly recommended)
+  - 2.1.0
+  - 2.0.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'maileon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install maileon
+
+## Usage
+
+Below API requests are currently supported by the gem:
+
+### Ping
+
+``` ruby
+api_key = "e30994fg0fig6t049u42j3gblgsr59043"
+maileon = Maileon::API.new(api_key, true)
+maileon.ping
+```
+
+### Subscribe
+
+``` ruby
+api_key = "e30994fg0fig6t049u42j3gblgsr59043"
+maileon = Maileon::API.new(api_key, true)
+attribs = {
+  :email => "subscriber@email.com"
+}
+body = {
+  :email => "subscriber@email.com",
+  :custom_fields => {
+    :CUSTOM_FIELD_DEFINED_AT_MAILEON => "1"
+  },
+  :standard_fields => {
+    :SALUTATION => "Herr",
+    :GENDER => "m",
+    :FIRSTNAME => "Max",
+    :LASTNAME => "Mustermann",
+    :LOCALE => "de_DE",
+    :CITY => "Hamburg",
+    :COUNTRY => "Germany",
+    :ZIP => "22675",
+    :ADDRESS => "Friedensallee",
+    :HNR => "9"
+  }
+}
+maileon.create_contact(attribs, body)
+```
+
+### Unsubscribe
+
+``` ruby
+api_key = "e30994fg0fig6t049u42j3gblgsr59043"
+maileon = Maileon::API.new(api_key, true)
+attribs = {
+  :email => "subscriber@email.com"
+}
+maileon.delete_contact(attribs)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/maileon/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Develop your feature by concepts of test-driven development. Run `guard` in parallel to automatically run your tests
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec
+task :test => :spec

data/lib/maileon.rb

@@ -0,0 +1,7 @@
+require 'base64'
+require 'excon'
+require 'json'
+
+require "maileon/version"
+require "maileon/errors"
+require "maileon/api"

data/lib/maileon/api.rb

@@ -0,0 +1,61 @@
+module Maileon
+  class API
+
+    attr_accessor :host, :path, :apikey, :debug, :session
+
+    def initialize(apikey=nil, debug=false)
+      @host = 'https://api.maileon.com'
+      @path = '/1.0/'
+
+      unless apikey
+        apikey = ENV['MAILEON_APIKEY']
+      end
+
+      raise 'You must provide Maileon API key' unless apikey
+
+      @apikey = Base64.encode64(apikey).strip
+      @debug = debug
+      @session = Excon.new @host, :debug => debug
+    end
+
+    def ping
+      @session.get(:path => "#{@path}/ping", :headers => get_headers)
+    end
+
+    def create_contact(params, body={})
+      raise ArgumentError.new("No parameters.") if params.empty?
+      raise ArgumentError.new("Email is mandatory.") if params[:email].nil?
+      raise Maileon::Errors::ValidationError.new("Invalid email format.") unless is_valid_email(params[:email])
+      email = URI::escape(params[:email])
+      permission = params[:permission] ||= 1
+      sync_mode = params[:sync_mode] ||= 2
+      doi = params[:doi] ||= true
+      doiplus = params[:doiplus] ||= true
+      url = "contacts/#{email}?permission=#{permission}&sync_mode=#{sync_mode}&doi=#{doi}&doiplus=#{doiplus}"
+      @session.post(:path => "#{@path}#{url}", :headers => get_headers, :body => body.to_json)
+    end
+
+    def delete_contact(params)
+      raise ArgumentError.new("No parameters.") if params.empty?
+      raise ArgumentError.new("Email is mandatory.") if params[:email].nil?
+      raise Maileon::Errors::ValidationError.new("Invalid email format.") unless is_valid_email(params[:email])
+      email = URI::escape(params[:email])
+      url = "contacts/#{email}"
+      @session.delete(:path => "#{@path}#{url}", :headers => get_headers('xml'))
+    end
+
+    private
+
+    def get_headers(type='json')
+      {
+        "Content-Type" => "application/vnd.maileon.api+#{type}; charset=utf-8",
+        "Authorization" => "Basic #{@apikey}"
+      }
+    end
+
+    def is_valid_email(email)
+      !/\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/.match(email).nil?
+    end
+
+  end
+end

data/lib/maileon/errors.rb

@@ -0,0 +1,7 @@
+module Maileon
+  module Errors
+
+    class ValidationError < StandardError; end
+
+  end
+end

data/lib/maileon/version.rb

@@ -0,0 +1,3 @@
+module Maileon
+  VERSION = "0.1.0"
+end

data/maileon.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'maileon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "maileon"
+  spec.version       = Maileon::VERSION
+  spec.authors       = ["Ain Tohvri"]
+  spec.email         = ["at@interactive-pioneers.de"]
+  spec.summary       = %q{Ruby wrapper for Maileon API.}
+  spec.description   = %q{Ruby wrapper for Maileon email marketing software API.}
+  spec.homepage      = "https://github.com/interactive-pioneers/maileon"
+  spec.license       = "GPL-3.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "excon", "~> 0.44.4"
+  spec.add_runtime_dependency "json", "~> 1.8"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rspec-nc", "~> 0.2"
+  spec.add_development_dependency "guard", "~> 2.2"
+  spec.add_development_dependency "guard-rspec", "~> 4.5"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "pry-remote", "~> 0.1"
+  spec.add_development_dependency "pry-nav", "~> 0.2"
+  spec.add_development_dependency "webmock", "~> 1.20"
+  spec.add_development_dependency "sinatra", "~> 1.4"
+end

data/spec/lib/api_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+require 'excon'
+require 'support/mock_maileon'
+
+describe Maileon::API do
+
+  describe '.initialize' do
+    context 'without API key' do
+      it { expect { Maileon::API.new }.to raise_error }
+    end
+    context 'with API key' do
+      it { expect(Maileon::API.new('2iaodsfi4u83943uruqf')).to be_an_instance_of Maileon::API }
+    end
+    context 'with environment-based API key' do
+      it {
+        ENV['MAILEON_APIKEY'] = 'adsfadsi4292r0vajsfdafldkaf'
+        is_expected.to be_an_instance_of Maileon::API
+      }
+    end
+  end
+
+  describe Maileon::API.new('asdfasdfasdfa') do
+    context 'when initiliased' do
+      it { is_expected.to have_attributes(:host => a_string_starting_with("https://")) }
+      it { is_expected.to have_attributes(:path => a_string_starting_with("/")) }
+      it { is_expected.to have_attributes(:apikey => Base64.encode64('asdfasdfasdfa').strip) }
+      it { is_expected.to have_attributes(:debug => false) }
+      it { is_expected.to have_attributes(:session => be) }
+    end
+  end
+
+  describe '.ping' do
+    context 'with invalid API key' do
+      it {
+        @maileon = Maileon::API.new('9320293t90gaksdf5900434')
+        expect(@maileon.ping.status).to eq 401
+      }
+    end
+    context 'with valid API key' do
+      it {
+        @maileon = Maileon::API.new(MockMaileon::API_KEY)
+        expect(@maileon.ping.status).to eq 200
+      }
+    end
+  end
+
+  describe '.create_contact' do
+    before(:all) do
+      @maileon = Maileon::API.new(MockMaileon::API_KEY)
+    end
+    context 'without parameters' do
+      it { expect { @maileon.create_contact() }.to raise_error(ArgumentError) }
+    end
+    context 'with empty parameters' do
+      it { expect { @maileon.create_contact({}) }.to raise_error(ArgumentError, "No parameters.") }
+    end
+    context 'without email' do
+      it { expect { @maileon.create_contact({:permission => 1}) }.to raise_error(ArgumentError, "Email is mandatory.") }
+    end
+    context 'with invalid email' do
+      it { expect { @maileon.create_contact({ :email => 'dummy@email' }) }.to raise_error(Maileon::Errors::ValidationError, "Invalid email format.") }
+      it { expect { @maileon.create_contact({ :email => 'dummy@email.2' }) }.to raise_error(Maileon::Errors::ValidationError, "Invalid email format.") }
+      it { expect { @maileon.create_contact({ :email => 'dummy@.2' }) }.to raise_error(Maileon::Errors::ValidationError, "Invalid email format.") }
+      it { expect { @maileon.create_contact({ :email => '@dummy.de' }) }.to raise_error(Maileon::Errors::ValidationError, "Invalid email format.") }
+    end
+    context 'with valid email' do
+     it { expect { @maileon.create_contact({ :email => 'dummy@email.com' }) }.not_to raise_error }
+     it { expect { @maileon.create_contact({ :email => 'dummy@some.email.de' }) }.not_to raise_error }
+     it { expect { @maileon.create_contact({ :email => 'dummy.some+filter@email.some-tld.de' }) }.not_to raise_error }
+     it { expect(@maileon.create_contact({ :email => 'dummy@tld.de' }).status).to eq 200 }
+    end
+    context 'with invalid API key' do
+     it {
+       @maileon = Maileon::API.new('219049tigadkv9f095t03tk2')
+       expect(@maileon.create_contact({ :email => 'dummy@tld.de' }).status).to eq 401
+     }
+    end
+  end
+
+  describe '.delete_contact' do
+    before(:all) do
+      @maileon = Maileon::API.new(MockMaileon::API_KEY)
+    end
+    context 'without parameters' do
+      it { expect { @maileon.delete_contact() }.to raise_error(ArgumentError) }
+    end
+    context 'with empty parameters' do
+      it { expect { @maileon.delete_contact({}) }.to raise_error(ArgumentError, "No parameters.") }
+    end
+    context 'without email' do
+      it { expect { @maileon.delete_contact({:permission => 1}) }.to raise_error(ArgumentError, "Email is mandatory.") }
+    end
+    context 'with invalid email' do
+      it { expect { @maileon.delete_contact({ :email => 'dummy@email' }) }.to raise_error(Maileon::Errors::ValidationError, "Invalid email format.") }
+      it { expect { @maileon.delete_contact({ :email => 'dummy@email.2' }) }.to raise_error(Maileon::Errors::ValidationError, "Invalid email format.") }
+      it { expect { @maileon.delete_contact({ :email => 'dummy@.2' }) }.to raise_error(Maileon::Errors::ValidationError, "Invalid email format.") }
+      it { expect { @maileon.delete_contact({ :email => '@dummy.de' }) }.to raise_error(Maileon::Errors::ValidationError, "Invalid email format.") }
+    end
+    context 'with valid email' do
+     it { expect { @maileon.delete_contact({ :email => 'dummy@email.com' }) }.not_to raise_error }
+     it { expect { @maileon.delete_contact({ :email => 'dummy@some.email.de' }) }.not_to raise_error }
+     it { expect { @maileon.delete_contact({ :email => 'dummy.some+filter@email.some-tld.de' }) }.not_to raise_error }
+     it { expect(@maileon.delete_contact({ :email => 'dummy@tld.de' }).status).to eq 200 }
+    end
+    context 'with invalid API key' do
+     it {
+       @maileon = Maileon::API.new('219049tigadkv9f095t03tk2')
+       expect(@maileon.delete_contact({ :email => 'dummy@tld.de' }).status).to eq 401
+     }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'pry'
+require 'maileon'
+require 'webmock/rspec'
+require 'support/mock_maileon'
+
+# Do not allow external calls to API
+WebMock.disable_net_connect!(allow_localhost: true)
+
+# Stub all external API calls for WebMock
+RSpec.configure do |config|
+  config.before(:each) do
+    stub_request(:any, /api.maileon.com/).to_rack(MockMaileon)
+  end
+end

data/spec/support/mock_maileon.rb

@@ -0,0 +1,31 @@
+require 'sinatra/base'
+
+class MockMaileon < Sinatra::Base
+
+  API_KEY = 'adsfadsi4292r0vajsfdafldkaf'
+
+  post '/1.0/contacts/:email' do
+    json_response is_valid_api_key? ? 200 : 401, 'create_contact.json'
+  end
+
+  delete '/1.0/contacts/:email' do
+    json_response is_valid_api_key? ? 200 : 401, 'delete_contact.json'
+  end
+
+  get '/1.0/ping' do
+    json_response is_valid_api_key? ? 200 : 401, 'ping.json'
+  end
+
+  private
+
+  def is_valid_api_key?
+    key = request.env['HTTP_AUTHORIZATION'].split(' ').last
+    Base64.encode64(API_KEY).strip == key
+  end
+
+  def json_response(response_code, file_name)
+    content_type :json
+    status response_code
+    File.open(File.dirname(__FILE__) + '/fixtures/' + file_name, 'rb').read
+  end
+end

metadata

@@ -0,0 +1,251 @@
+--- !ruby/object:Gem::Specification
+name: maileon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ain Tohvri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.4
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Ruby wrapper for Maileon email marketing software API.
+email:
+- at@interactive-pioneers.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/maileon.rb
+- lib/maileon/api.rb
+- lib/maileon/errors.rb
+- lib/maileon/version.rb
+- maileon.gemspec
+- spec/lib/api_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures/create_contact.json
+- spec/support/fixtures/delete_contact.json
+- spec/support/fixtures/ping.json
+- spec/support/mock_maileon.rb
+homepage: https://github.com/interactive-pioneers/maileon
+licenses:
+- GPL-3.0
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Maileon API.
+test_files:
+- spec/lib/api_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixtures/create_contact.json
+- spec/support/fixtures/delete_contact.json
+- spec/support/fixtures/ping.json
+- spec/support/mock_maileon.rb