litmus-reseller 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1040ff1b127f0ac7395be7d68f6a8e8f5cd11d5e
+  data.tar.gz: d230ac21cf7d7b3bae7d9f56aa37353dbd51570e
+SHA512:
+  metadata.gz: eee90d58af2d456ed9609de17bb2ece2838be1a40224e57291ce1d664cf3d2fd1d6123387dc1ec988afb4161d5bfa2f1083c25e094375657a6b3d762c2fae918
+  data.tar.gz: 5f25922c29cea06ac1d0538ebf3740842f14bd3fbd0dcdf61af2a55fc13647a263c7ae4f89f8a4656d42586069864b9c66d38d8778aa9a7f6555ba3956336232

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in litmus-reseller.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Damien Brzoska
+
+MIT License
+
+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,118 @@
+# Litmus::Reseller
+
+Reseller Apis are only for use with a reseller account. They do not work with a regular Litmus account.
+
+## Installation
+
+To get started, add 'listmus-reseller' to your `Gemfile`, run `bundle install`, and run the generator:
+
+```ruby
+rails generate litmus_reseller:install
+```
+
+The generator will create an initializer to allow configuration
+
+## Configuration
+
+Override any of these defaults in `config/initializers/litmus-reseller.rb`:
+
+```ruby
+LitmusReseller.configure do |config|
+  config.username = nil
+  config.password = nil
+end
+```
+
+## Usage
+
+### Create a test
+
+Create an EmailTest and get a result back:
+
+```ruby
+# All applications
+response = LitmusReseller::EmailTest.create([])
+# Custom applications
+response = LitmusReseller::EmailTest.create(['ol2010', 'iphone5s'])
+# Custom guid
+response = LitmusReseller::EmailTest.create([], 'custom-guid')
+```
+
+The response will look like this:
+
+```ruby
+{ "TestingApplications" :
+  [
+    {
+      "ApplicationLongName" : "Outlook 2010",
+      "ApplicationName" : "ol2010",
+      "AverageTimeToProcess" : 0,
+      "BusinessOrPopular" : true,
+      "Completed" : null,
+      "DesktopClient" : true,
+      "FoundInSpam" : null,
+      "FullpageImage" : null,
+      "FullpageImageContentBlocking" : null,
+      "FullpageImageNoContentBlocking" : null,
+      "FullpageImageThumb" : null,
+      "FullpageImageThumbContentBlocking" : null,
+      "FullpageImageThumbNoContentBlocking" : null,
+      "Id" : 0,
+      "PlatformLongName" : "",
+      "PlatformName" : "",
+      "RenderedHtmlUrl" : null,
+      "ResultType" : 0,
+      "SpamHeaders" : null,
+      "SpamScore" : 0,
+      "State" : null,
+      "Status" : 0,
+      "SupportsContentBlocking" : false,
+      "SupportsSpamScoring" : null,
+      "WindowImage" : null,
+      "WindowImageContentBlocking" : null,
+      "WindowImageNoContentBlocking" : null,
+      "WindowImageThumb" : null,
+      "WindowImageThumbContentBlocking" : null,
+      "WindowImageThumbNoContentBlocking" : null
+    },
+    {...}
+  ],
+  "State" : "waiting",
+  "InboxGuid" : "test12345",
+  "Id" : 19498721,
+  "Source" : "https://s3.amazonaws.com/sitevista/",
+  "Subject" : "",
+  "Html" : "https://html.litmus.com/email/?url=/sitevista/",
+  "ZipFile" : "http://zip.litmus.com/resellers/?guid=e03c3e66-ba5b-4ed5-916a-c58c2b763d40",
+  "TestType" : 0,
+  "Sandbox" : false,
+  "UserGuid" : nil,
+  "Error" : false,
+  "ErrorMessage" : nil
+}
+```
+
+Send your email to a unique email address you get from the `emai_test`:
+
+```ruby
+to_address = "#{response["InboxGuid"]@emailtests.com}"
+mail(to: to_address, subject: "Subject line")
+```
+
+Poll the api periodically to see if your previews are complete
+
+```ruby
+results = LitmusReseller::Result.show(response["id"])
+while results["status"] != "complete" do
+  results = LitmusReseller::Result.show(response["id"])
+  wait 60
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/litmus-reseller/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/lib/generators/litmus_reseller/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/base'
+require 'rails/generators/active_record'
+
+module LitmusReseller
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Generate initializers file"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_litmus_reseller_initializer
+        copy_file 'litmus-reseller.rb', 'config/initializers/litmus-reseller.rb'
+      end
+    end
+  end
+end

data/lib/generators/litmus_reseller/templates/litmus-reseller.rb

@@ -0,0 +1,4 @@
+LitmusReseller.configure do |config|
+  config.username = "YOUR_USERNAME"
+  config.password = "YOUR_PASSWORD"
+end

data/lib/litmus-reseller.rb

@@ -0,0 +1,9 @@
+require 'httparty'
+require "litmus-reseller/version"
+require "litmus-reseller/configuration"
+require "litmus-reseller/email_test"
+require "litmus-reseller/result"
+
+module LitmusReseller
+  require 'litmus-reseller/engine' if defined?(Rails)
+end

data/lib/litmus-reseller/configuration.rb

@@ -0,0 +1,19 @@
+module LitmusReseller
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :username, :password
+
+    def initialize
+      @username = nil
+      @password = nil
+    end
+  end
+end

data/lib/litmus-reseller/email_test.rb

@@ -0,0 +1,23 @@
+module LitmusReseller
+  class EmailTest
+    include HTTParty
+    base_uri "https://previews-api.litmus.com"
+
+    def self.create(applications = [], guid = nil)
+      raise "Missing configuration" unless LitmusReseller.configuration.username && LitmusReseller.configuration.password
+
+      basic_auth(LitmusReseller.configuration.username, LitmusReseller.configuration.password)
+      response = post('/api/v1/EmailTests', body: build_params(applications, guid), headers: { "Content-type" => "application/json" })
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def self.build_params(applications, guid)
+      testing_applications = { "TestingApplications" => []}
+      applications.each { |app| testing_applications["TestingApplications"] << { "ApplicationName" => app } }
+      testing_applications["UserGuid"] = guid if guid
+      testing_applications.to_json
+    end
+  end
+end

data/lib/litmus-reseller/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+module LitmusReseller
+  class Engine < Rails::Engine
+  end
+end

data/lib/litmus-reseller/result.rb

@@ -0,0 +1,14 @@
+module LitmusReseller
+  class Result
+    include HTTParty
+    base_uri "https://previews-api.litmus.com"
+
+    def self.show(id)
+      raise "Missing configuration" unless LitmusReseller.configuration.username && LitmusReseller.configuration.password
+
+      basic_auth(LitmusReseller.configuration.username, LitmusReseller.configuration.password)
+      response = get("/api/v1/EmailTests/#{id}", headers: { "Content-type" => "application/json" })
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/litmus-reseller/version.rb

@@ -0,0 +1,3 @@
+module LitmusReseller
+  VERSION = "0.0.2"
+end

data/litmus-reseller.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'litmus-reseller/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "litmus-reseller"
+  spec.version       = LitmusReseller::VERSION
+  spec.authors       = ["Damien Brzoska"]
+  spec.email         = ["damien.brz@gmail.com"]
+  spec.description   = "A simple wrapper around the Litmus reseller API."
+  spec.summary       = ""
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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_dependency "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe LitmusReseller::Configuration do
+  after { restore_default_config }
+
+  describe "when a username" do
+    context "is specified" do
+      before do
+        LitmusReseller.configure do |config|
+          config.username = 'damienbrz'
+        end
+      end
+
+      it "should use the new username" do
+        expect(LitmusReseller.configuration.username).to eq 'damienbrz'
+      end
+    end
+  end
+
+  describe "when a password" do
+    context "is specified" do
+      before do
+        LitmusReseller.configure do |config|
+          config.password = 'T3st12&34'
+        end
+      end
+
+      it "should use the new password" do
+        expect(LitmusReseller.configuration.password).to eq 'T3st12&34'
+      end
+    end
+  end
+
+  describe "default configuration" do
+    it "should use default values" do
+      expect(LitmusReseller.configuration.username).to be_nil
+      expect(LitmusReseller.configuration.password).to be_nil
+    end
+  end
+end

data/spec/email_test_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe LitmusReseller::EmailTest do
+  after { restore_default_config }
+
+  describe "when configuration (username and password) is set" do
+    before do
+      LitmusReseller.configure do |config|
+        config.username = 'username'
+        config.password = 'password'
+      end
+    end
+
+    context "without params" do
+      it "should return the email address InboxGuid@emailtests.com" do
+        response = LitmusReseller::EmailTest.create()
+        expect(response["InboxGuid"]).to eq("test12345")
+      end
+    end
+
+    context "with applications" do
+      it "should return the email address InboxGuid@emailtests.com" do
+        response = LitmusReseller::EmailTest.create(['ol2010'])
+        expect(response["InboxGuid"]).to eq("test12345")
+      end
+    end
+
+    context "with guid" do
+      it "should return the email address InboxGuid@emailtests.com" do
+        response = LitmusReseller::EmailTest.create([], "custom-guid")
+        expect(response["InboxGuid"]).to eq("custom-guid")
+      end
+    end
+  end
+
+  describe "when configuration (username and password) is not set" do
+    context "username missing" do
+      before do
+        LitmusReseller.configure do |config|
+          config.password = 'password'
+        end
+      end
+
+      it "should raise an error" do
+        expect { LitmusReseller::EmailTest.create() }.to raise_error(RuntimeError, "Missing configuration")
+      end
+    end
+
+    context "password missing" do
+      LitmusReseller.configure do |config|
+        config.username = 'damienbrz'
+      end
+
+      it "should raise an error" do
+        expect { LitmusReseller::EmailTest.create() }.to raise_error(RuntimeError, "Missing configuration")
+      end
+    end
+  end
+end

data/spec/result_spec.rb

@@ -0,0 +1,18 @@
+# results = LitmusReseller::Results.get(email_test.guid)
+require 'spec_helper'
+
+describe LitmusReseller::Result do
+  after { restore_default_config }
+
+  before do
+    LitmusReseller.configure do |config|
+      config.username = 'username'
+      config.password = 'password'
+    end
+  end
+
+  it "should return with an array of TestingApplications" do
+    response = LitmusReseller::Result.show(19498721)
+    expect(response["State"]).to eq("completed")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+require 'litmus-reseller'
+require 'webmock/rspec'
+
+def restore_default_config
+  LitmusReseller.configuration = nil
+  LitmusReseller.configure {}
+end
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+RSpec.configure do |config|
+  config.before(:each) do
+
+    valid_post_response = "{\"TestingApplications\":[{\"State\":\"pending\",\"WindowImageContentBlocking\":\"s3.amazonaws.com\",\"FullpageImageThumb\":\"s3.amazonaws.com\",\"BusinessOrPopular\":true,\"WindowImageThumbNoContentBlocking\":\"s3.amazonaws.com\",\"Completed\":false,\"FullpageImage\":\"s3.amazonaws.com\",\"FoundInSpam\":false,\"SupportsSpamScoring\":null,\"Status\":0,\"WindowImageNoContentBlocking\":\"s3.amazonaws.com\",\"PlatformName\":\"Windows\",\"AverageTimeToProcess\":489,\"SpamHeaders\":[],\"WindowImageThumb\":\"s3.amazonaws.com\",\"RenderedHtmlUrl\":null,\"PlatformLongName\":\"Microsoft Windows\",\"FullpageImageThumbContentBlocking\":\"s3.amazonaws.com\",\"WindowImage\":\"s3.amazonaws.com\",\"FullpageImageContentBlocking\":\"s3.amazonaws.com\",\"SupportsContentBlocking\":true,\"ApplicationName\":\"OL2010\",\"FullpageImageThumbNoContentBlocking\":\"s3.amazonaws.com\",\"SpamScore\":0.0,\"DesktopClient\":true,\"WindowImageThumbContentBlocking\":\"s3.amazonaws.com\",\"Id\":560265637,\"ResultType\":0,\"FullpageImageNoContentBlocking\":\"s3.amazonaws.com\",\"ApplicationLongName\":\"Outlook 2010\"}],\"State\":\"waiting\",\"InboxGuid\":\"test12345\",\"Id\":19498721,\"Source\":\"https://s3.amazonaws.com/sitevista/\",\"Subject\":\"\",\"Html\":\"https://html.litmus.com/email/?url=/sitevista/\",\"ZipFile\":\"http://zip.litmus.com/resellers/?guid=e03c3e66-ba5b-4ed5-916a-c58c2b763d40\",\"TestType\":0,\"Sandbox\":false,\"UserGuid\":null,\"Error\":false,\"ErrorMessage\":null}"
+
+    custom_response = "{\"InboxGuid\":\"custom-guid\"}"
+
+    valid_get_response = "{\"TestingApplications\":[{\"State\":\"completed\",\"WindowImageContentBlocking\":\"s3.amazonaws.com\",\"FullpageImageThumb\":\"s3.amazonaws.com\",\"BusinessOrPopular\":true,\"WindowImageThumbNoContentBlocking\":\"s3.amazonaws.com\",\"Completed\":false,\"FullpageImage\":\"s3.amazonaws.com\",\"FoundInSpam\":false,\"SupportsSpamScoring\":null,\"Status\":0,\"WindowImageNoContentBlocking\":\"s3.amazonaws.com\",\"PlatformName\":\"Windows\",\"AverageTimeToProcess\":489,\"SpamHeaders\":[],\"WindowImageThumb\":\"s3.amazonaws.com\",\"RenderedHtmlUrl\":null,\"PlatformLongName\":\"Microsoft Windows\",\"FullpageImageThumbContentBlocking\":\"s3.amazonaws.com\",\"WindowImage\":\"s3.amazonaws.com\",\"FullpageImageContentBlocking\":\"s3.amazonaws.com\",\"SupportsContentBlocking\":true,\"ApplicationName\":\"OL2010\",\"FullpageImageThumbNoContentBlocking\":\"s3.amazonaws.com\",\"SpamScore\":0.0,\"DesktopClient\":true,\"WindowImageThumbContentBlocking\":\"s3.amazonaws.com\",\"Id\":560265637,\"ResultType\":0,\"FullpageImageNoContentBlocking\":\"s3.amazonaws.com\",\"ApplicationLongName\":\"Outlook 2010\"}],\"State\":\"completed\",\"InboxGuid\":\"test12345\",\"Id\":19498721,\"Source\":\"https://s3.amazonaws.com/sitevista/\",\"Subject\":\"\",\"Html\":\"https://html.litmus.com/email/?url=/sitevista/\",\"ZipFile\":\"http://zip.litmus.com/resellers/?guid=e03c3e66-ba5b-4ed5-916a-c58c2b763d40\",\"TestType\":0,\"Sandbox\":false,\"UserGuid\":null,\"Error\":false,\"ErrorMessage\":null}"
+
+    stub_request(:post, "https://username:password@previews-api.litmus.com/api/v1/EmailTests").
+         with(:body => "{\"TestingApplications\":[]}",
+              :headers => {'Content-Type'=>'application/json'}).
+         to_return(:status => 200, :body => valid_post_response, :headers => {})
+
+    stub_request(:post, "https://username:password@previews-api.litmus.com/api/v1/EmailTests").
+         with(:body => "{\"TestingApplications\":[{\"ApplicationName\":\"ol2010\"}]}",
+              :headers => {'Content-Type'=>'application/json'}).
+         to_return(:status => 200, :body => valid_post_response, :headers => {})
+
+    stub_request(:post, "https://username:password@previews-api.litmus.com/api/v1/EmailTests").
+         with(:body => "{\"TestingApplications\":[],\"UserGuid\":\"custom-guid\"}",
+              :headers => {'Content-Type'=>'application/json'}).
+         to_return(:status => 200, :body => custom_response, :headers => {})
+
+    stub_request(:get, "https://username:password@previews-api.litmus.com/api/v1/EmailTests/19498721").
+         with(:body => "", :headers => {'Content-Type'=>'application/json'}).
+         to_return(:status => 200, :body => valid_get_response, :headers => {})
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: litmus-reseller
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Damien Brzoska
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple wrapper around the Litmus reseller API.
+email:
+- damien.brz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/litmus_reseller/install_generator.rb
+- lib/generators/litmus_reseller/templates/litmus-reseller.rb
+- lib/litmus-reseller.rb
+- lib/litmus-reseller/configuration.rb
+- lib/litmus-reseller/email_test.rb
+- lib/litmus-reseller/engine.rb
+- lib/litmus-reseller/result.rb
+- lib/litmus-reseller/version.rb
+- litmus-reseller.gemspec
+- spec/configuration_spec.rb
+- spec/email_test_spec.rb
+- spec/result_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: ''
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/configuration_spec.rb
+- spec/email_test_spec.rb
+- spec/result_spec.rb
+- spec/spec_helper.rb