mailjet 0.0.1

data/lib/mailjet/template_model.rb

@@ -0,0 +1,13 @@
+require 'mailjet/api'
+
+module Mailjet
+  class TemplateModel < OpenStruct
+    class << self      
+      def all(options = {})
+        (options.delete(:api) || Mailjet::Api.singleton).messageTplmodels(options)["templates"].map do |result_hash|
+          self.new(result_hash)
+        end
+      end
+    end
+  end
+end

data/lib/mailjet/version.rb

@@ -0,0 +1,3 @@
+module Mailjet
+  VERSION = "0.0.1"
+end

data/test/mailjet/api_request_test.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+
+require 'minitest_helper'
+
+describe Mailjet::ApiRequest do
+
+  describe "#request_path" do
+    it "should return the path of the method" do
+      Mailjet::ApiRequest.new('method_name').send(:request_path).must_equal '/0.1/methodName?output=json'
+    end
+
+    it "should respect api_version" do
+      Mailjet.config.expects(:api_version).returns(0.2)
+      Mailjet::ApiRequest.new('method_name').send(:request_path).must_equal '/0.2/methodName?output=json'
+    end
+  end
+
+  describe "#request_port" do
+    it "should return 80 if use_https is false" do
+      Mailjet.config.use_https = false
+      Mailjet::ApiRequest.new('method_name').send(:request_port).must_equal 80
+    end
+
+    it "should return 443 if use_https is true" do
+      Mailjet.config.use_https = true
+      Mailjet::ApiRequest.new('method_name').send(:request_port).must_equal 443
+    end
+  end
+
+  describe "#request" do
+    it "should return an Http request" do
+      request = Mailjet::ApiRequest.new('method_name', {}, 'Post')
+      request.send(:request).must_be_kind_of(Net::HTTP::Post)
+
+      request = Mailjet::ApiRequest.new('method_name', {}, 'Get')
+      request.send(:request).must_be_kind_of(Net::HTTP::Get)
+    end
+  end
+
+  describe "#response" do
+    it "should raise an ApiError if authentication fails" do
+      request = Mailjet::ApiRequest.new('method_name', {}, 'Get')
+      lambda { 
+        request.response
+      }.must_raise(Mailjet::ApiError)
+    end
+
+    it "should return a Hash with response values if request is ok" do
+      request = Mailjet::ApiRequest.new('user_infos', {}, 'Get')
+      response = request.response
+      response.must_be_kind_of(Hash)
+      response['infos']['username'].must_equal 'benoit.benezech@gmail.com'
+    end
+  end
+
+  describe "#guess_request_type" do
+    it "should return 'Post' if method_name contains a special verb" do
+      Mailjet::ApiRequest.new('lists_add_contact').send(:guess_request_type).must_equal 'Post'
+      Mailjet::ApiRequest.new('lists_create').send(:guess_request_type).must_equal 'Post'
+      Mailjet::ApiRequest.new('lists_delete').send(:guess_request_type).must_equal 'Post'
+      Mailjet::ApiRequest.new('lists_remove_contact').send(:guess_request_type).must_equal 'Post'
+      Mailjet::ApiRequest.new('lists_update').send(:guess_request_type).must_equal 'Post'
+    end
+
+    it "should return 'Get' if method_name does not contain a verb" do
+      Mailjet::ApiRequest.new('key_list').send(:guess_request_type).must_equal 'Get'
+      Mailjet::ApiRequest.new('contact_list').send(:guess_request_type).must_equal 'Get'
+      Mailjet::ApiRequest.new('lists_all').send(:guess_request_type).must_equal 'Get'
+      Mailjet::ApiRequest.new('lists_email').send(:guess_request_type).must_equal 'Get'
+    end
+  end
+end

data/test/mailjet/api_test.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+require 'minitest_helper'
+
+describe Mailjet::Api do
+  describe "#method_missing" do
+    it "should create an ApiRequest" do
+      
+      request = mock(:response => true)
+      Mailjet::ApiRequest.expects(:new).with(:user_infos ,{:param1 => 1}, 'Post', Mailjet.config.api_key, Mailjet.config.secret_key).returns(request)
+      Mailjet::Api.new.user_infos({:param1 => 1}, 'Post')
+    end
+  end
+end

data/test/mailjet/campaign_test.rb

@@ -0,0 +1,62 @@
+require 'minitest_helper'
+
+describe Mailjet::Campaign do
+  it 'has an integration suite, tested directly against Mailjet service' do
+
+    # init
+    Mailjet::List.all.each do |list|
+      list.delete
+    end
+    list = Mailjet::List.create(:label => 'My Mailjet list', :name => "mymailjetlist")
+    list.add_contacts("c1@contacts.com", "c2@contacts.com")
+
+    # Mailjet::Campaign.create
+    campaign = Mailjet::Campaign.create(
+      :title => "My Mailjet Campaign",
+      :list_id => list.id,
+      :from => Mailjet.config.default_from, # must be valid
+      :from_name => "Sender Name",
+      :subject => "Our new product",
+      :template_id => Mailjet::TemplateModel.all.first.id,
+      :lang => "en",
+      :footer => "default"
+    )
+    campaign.url.must_match /^https\:\/\/www\.mailjet\.com\/campaigns\/template\/[0-9]+$/
+
+    # Mailjet::Campaign.all
+    campaigns = Mailjet::Campaign.all
+    campaigns.wont_be_empty # we can't empty the whole campaign list...
+    campaigns.first.must_be_instance_of Mailjet::Campaign
+
+    # Mailjet::Campaign.find
+    Mailjet::Campaign.find(campaign.id).must_be_instance_of Mailjet::Campaign
+    Mailjet::Campaign.find(0).must_be_nil
+
+    # Mailjet::Campaign#update
+    campaign.update(:title => "My *new* Mailjet Campaign")
+
+    # Mailjet::Campaign#duplicate
+    dup = campaign.duplicate(:title => "My *new* Mailjet Campaign")
+    dup.must_be_instance_of Mailjet::Campaign
+    dup.id.wont_be_same_as campaign.id
+
+    # Mailjet::Campaign#send!
+    campaign.send!.must_equal 'OK'
+    # TODO does not work, 500 server side.
+
+    # Mailjet::Campaign#test
+    campaign.test('benoit.benezech@gmail.com').must_equal 'OK'
+
+    # Mailjet::Campaign#html
+    campaign.html.must_be_nil
+    # TODO how to get content in the campaign template?
+
+    campaign = Mailjet::Campaign.find(campaign.id)
+
+    # Mailjet::Campaign#contacts
+    campaign.contacts.wont_be_empty
+
+    # Mailjet::Campaign#statistics
+    campaign.statistics.keys.must_include "blocked"
+  end
+end

data/test/mailjet/configuration_test.rb

@@ -0,0 +1,16 @@
+require 'minitest_helper'
+
+describe Mailjet::Configuration do
+  describe "accessors" do
+    it "should memorize values" do
+      Mailjet::Configuration.api_key = '1234'
+      Mailjet::Configuration.api_key.must_equal '1234'
+    end
+  end
+
+  describe "#use_https" do
+    it "should be true by default" do
+      Mailjet::Configuration.use_https.must_equal true
+    end
+  end
+end

data/test/mailjet/contact_test.rb

@@ -0,0 +1,24 @@
+require 'minitest_helper'
+
+describe Mailjet::Contact do
+  it 'has an integration suite, tested directly against Mailjet service' do
+    # init
+    Mailjet::List.all.each do |list|
+      list.delete
+    end
+    list = Mailjet::List.create(:label => 'My Mailjet list', :name => "mymailjetlist")
+    list.add_contacts("c1@contacts.com")
+    
+    # Mailjet::Contact.all
+    contacts = Mailjet::Contact.all
+    contacts.wont_be_empty  # we can't empty the whole contact list...
+    contacts.first.must_be_instance_of Mailjet::Contact
+    
+    # Mailjet::Contact.all(:openers => true)
+    # Mailjet::Contact.all(:openers => true).must_be_empty
+    # TODO :openers does not work, times out
+    
+    # Mailjet::Contact#infos
+    contacts.first.infos["click"].wont_be_nil
+  end
+end

data/test/mailjet/list_test.rb

@@ -0,0 +1,62 @@
+require 'minitest_helper'
+
+describe Mailjet::List do
+  it 'has an integration suite, tested directly against Mailjet service' do
+    # clean-up all existing lists:
+    Mailjet::List.all.each do |list|
+      list.delete
+    end
+    
+    # Mailjet::List.all for no lists
+    Mailjet::List.all.must_be_empty
+    
+    # Mailjet::List#create
+    list = Mailjet::List.create(:label => 'My Mailjet list', :name => "mymailjetlist")
+    list.must_be_instance_of Mailjet::List
+    list.label.must_equal 'My Mailjet list'
+    list.name.must_equal 'mymailjetlist'
+    
+    # Mailjet::List#update.
+    list.update(:label => 'My updated Mailjet list', :name => "myupdatedmailjetlist").must_equal "OK"
+    updated_list = Mailjet::List.all.first
+    updated_list.label.must_equal 'My updated Mailjet list'
+    updated_list.name.must_equal 'myupdatedmailjetlist'
+    updated_list.id.must_equal list.id
+    
+    # Mailjet::List.all
+    lists = Mailjet::List.all
+    lists.count.must_equal 1
+    lists.first.must_be_instance_of Mailjet::List
+    lists.first.id.must_equal updated_list.id
+    
+    # Mailjet::List#add_contacts
+    list.add_contacts.must_equal "NotModified"
+    list.add_contacts("c1@contacts.com").must_equal "OK"
+    list.add_contacts("c1@contacts.com").must_equal "NotModified"
+    list.add_contacts("c2@contacts.com", "c3@contacts.com").must_equal "OK"
+    list.add_contacts("c4@contacts.com", "c5@contacts.com").must_equal "OK"
+    
+    # Mailjet::List#contacts and validate results of add_contacts
+    contacts = list.contacts
+    contacts.first.must_be_instance_of Mailjet::Contact
+    contacts.map(&:email).sort.must_equal ["c1@contacts.com", "c2@contacts.com", "c3@contacts.com", "c4@contacts.com", "c5@contacts.com"]
+    
+    # Mailjet::List#remove_contacts
+    list.remove_contacts.must_equal "NotModified"
+    list.remove_contacts("does-not-exist@nowhere.com").must_equal "NotModified"
+    list.remove_contacts("c1@contacts.com", "c2@contacts.com").must_equal "OK"
+    list.contacts.count.must_equal 3
+    
+    # Mailjet::List#email
+    list.email.must_match /\@lists\.mailjet\.com$/
+    
+    # Mailjet::List#statistics
+    list.statistics["sent"].must_equal "0"
+    
+    # Mailjet::List#delete
+    list.delete.must_equal 'OK'
+    Mailjet::List.all.must_be_empty
+    exception = proc { list.delete }.must_raise(Mailjet::ApiError)
+    exception.to_s.must_match /This ID not appears to be an active list on your account/
+  end
+end

data/test/mailjet/rack/endpoint_test.rb

@@ -0,0 +1,30 @@
+require 'minitest_helper'
+require 'rack/mock'
+
+SAMPLE_MAILJET_PAYLOAD = "{\"event\":\"open\",\"time\":1331581827,\"email\":\"benoit.benezech+1634@gmail.com\",\"mj_campaign_id\":\"105881975\",\"mj_contact_id\":\"116408391\",\"customcampaign\":null,\"ip\":\"88.164.20.58\",\"geo\":\"FR\",\"agent\":\"Mozilla\\/5.0 (Macintosh; Intel Mac OS X 10_7_2) AppleWebKit\\/535.11 (KHTML, like Gecko) Chrome\\/17.0.963.79 Safari\\/535.11\"}"
+SAMPLE_MAILJET_PARAMS = {"event"=>"open", "time"=>1331581827, "email"=>"benoit.benezech+1634@gmail.com", "mj_campaign_id"=>"105881975", "mj_contact_id"=>"116408391", "customcampaign"=>nil, "ip"=>"88.164.20.58", "geo"=>"FR", "agent"=>"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_2) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.79 Safari/535.11"} 
+
+
+describe Mailjet::Rack::Endpoint do
+  it "should decipher Mailjet's posted events and pass them to the block" do
+    # mock should receive :find with "benoit.benezech+1634@gmail.com" and will return true
+    $user_class_mock = MiniTest::Mock.new.expect(:find, true, ["benoit.benezech+1634@gmail.com"]) 
+    
+    app = Rack::Builder.new do
+      use Rack::Lint
+      use Mailjet::Rack::Endpoint, '/callback' do |params|
+        $user_class_mock.find(params['email'])#.do_smtg_with_the_user....
+      end
+      run lambda { |env|
+        [200, {'Content-Type' => 'text/plain'}, ['passed through your endpoint, haha']]
+      }
+    end
+    
+    response = Rack::MockRequest.new(app).get('/not_callback')
+    response.body.must_equal('passed through your endpoint, haha')
+    
+    response = Rack::MockRequest.new(app).post('/callback', :input => SAMPLE_MAILJET_PAYLOAD)
+    response.body.must_equal('')
+    $user_class_mock.verify
+  end
+end

data/test/mailjet/reporting_test.rb

@@ -0,0 +1,26 @@
+require 'minitest_helper'
+
+describe Mailjet::Reporting do
+  it 'has an integration suite, tested directly against Mailjet service' do
+    # Mailjet::Reporting.clicks
+    Mailjet::Reporting.clicks.must_be_instance_of Array
+    
+    # Mailjet::Reporting.domains
+    Mailjet::Reporting.domains.must_be_instance_of Array
+    
+    # Mailjet::Reporting.clients
+    Mailjet::Reporting.clients.must_be_instance_of Array
+    
+    # Mailjet::Reporting.emails
+    Mailjet::Reporting.emails.must_be_instance_of Array
+    
+    # Mailjet::Reporting.statistics
+    Mailjet::Reporting.statistics["cnt_messages"].wont_be_nil
+
+    # Mailjet::Reporting.geolocation
+    Mailjet::Reporting.geolocation.must_be_instance_of Hash
+
+    # Mailjet::Reporting.agents
+    Mailjet::Reporting.agents.must_be_instance_of Array
+  end
+end

data/test/mailjet/template_category_test.rb

@@ -0,0 +1,13 @@
+require 'minitest_helper'
+
+describe Mailjet::TemplateCategory do
+  it 'has an integration suite, tested directly against Mailjet service' do
+    
+    # Mailjet::TemplateCategory.all
+    models = Mailjet::TemplateCategory.all
+    models.wont_be_empty
+    model = models.find{|m| m.id == "2"} # from default Mailjet templates
+    model.must_be_instance_of Mailjet::TemplateCategory
+    model.label.must_equal "basic"
+  end
+end

data/test/mailjet/template_model_test.rb

@@ -0,0 +1,13 @@
+require 'minitest_helper'
+
+describe Mailjet::TemplateModel do
+  it 'has an integration suite, tested directly against Mailjet service' do
+    
+    # Mailjet::TemplateModel.all
+    models = Mailjet::TemplateModel.all
+    models.wont_be_empty
+    model = models.find{|t| t.id == '4'} # from default Mailjet templates
+    model.must_be_instance_of Mailjet::TemplateModel
+    model.name == "Text"
+  end
+end

data/test/mailjet_test.rb

@@ -0,0 +1,19 @@
+require 'minitest_helper'
+
+describe Mailjet do
+  describe "#configure" do
+    it "should permit to set api keys and remember them" do
+      Mailjet.configure do |config|
+        config.api_key = "1234"
+        config.secret_key = "5678"
+        config.domain = "domain_test"
+        config.default_from = "default from test"
+      end
+
+      Mailjet.config.api_key.must_equal "1234"
+      Mailjet.config.secret_key.must_equal "5678"
+      Mailjet.config.domain.must_equal "domain_test"
+      Mailjet.config.default_from = "default from test"
+    end
+  end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,23 @@
+require 'minitest/autorun'
+require 'minitest/matchers'
+require "mocha"
+require 'mailjet'
+require 'turn'
+
+test_account = YAML::load(File.new(File.expand_path("../../config.yml", __FILE__)))['mailjet']
+
+MiniTest::Spec.before do
+  Mailjet.configure do |config|
+    config.api_key = test_account['api_key']
+    config.secret_key = test_account['secret_key']
+    config.domain = test_account['domain']
+    config.default_from = test_account['default_from']
+  end
+end
+
+MiniTest::Spec.after do
+  Object.send(:remove_const, 'Mailjet')
+  Dir["#{File.dirname(__FILE__)}/../lib/**/*.rb"].each {|f| load f}
+end
+
+Turn.config.format = :outline

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification 
+name: mailjet
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Aur\xC3\xA9lien AMILIN"
+- "Benoit B\xC3\xA9n\xC3\xA9zech"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-26 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.9
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionmailer
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.9
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: minitest-matchers
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: turn
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id009
+description: Cloud Emailing for easy delivery.
+email: 
+- benoit.benezech@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mailjet/api.rb
+- lib/mailjet/api_error.rb
+- lib/mailjet/api_request.rb
+- lib/mailjet/campaign.rb
+- lib/mailjet/click.rb
+- lib/mailjet/configuration.rb
+- lib/mailjet/contact.rb
+- lib/mailjet/core_extensions/ostruct.rb
+- lib/mailjet/email.rb
+- lib/mailjet/list.rb
+- lib/mailjet/mailer.rb
+- lib/mailjet/rack/endpoint.rb
+- lib/mailjet/reporting.rb
+- lib/mailjet/template_category.rb
+- lib/mailjet/template_model.rb
+- lib/mailjet/version.rb
+- lib/mailjet.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+- test/mailjet/api_request_test.rb
+- test/mailjet/api_test.rb
+- test/mailjet/campaign_test.rb
+- test/mailjet/configuration_test.rb
+- test/mailjet/contact_test.rb
+- test/mailjet/list_test.rb
+- test/mailjet/rack/endpoint_test.rb
+- test/mailjet/reporting_test.rb
+- test/mailjet/template_category_test.rb
+- test/mailjet/template_model_test.rb
+- test/mailjet_test.rb
+- test/minitest_helper.rb
+has_rdoc: true
+homepage: http://www.mailjet.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Cloud Emailing for easy delivery.
+test_files: 
+- test/mailjet/api_request_test.rb
+- test/mailjet/api_test.rb
+- test/mailjet/campaign_test.rb
+- test/mailjet/configuration_test.rb
+- test/mailjet/contact_test.rb
+- test/mailjet/list_test.rb
+- test/mailjet/rack/endpoint_test.rb
+- test/mailjet/reporting_test.rb
+- test/mailjet/template_category_test.rb
+- test/mailjet/template_model_test.rb
+- test/mailjet_test.rb
+- test/minitest_helper.rb