locaweb-emailmarketing 0.0.1

data/spec/fixtures/cassettes/reports_openings.yml

@@ -0,0 +1,74 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://emailmarketing.locaweb.com.br/api/v1/accounts/50f8e28abf8d79f935000001/messages/50f9828436e1d9ce0d000fd5/openings
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      X-Auth-Token:
+      - Nt5skc1xXsvKKSsyp3Bsx7ABNdJz9pc1uA9kyTdjnJkr
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "U2VydmVy":
+      - !binary |-
+        bmdpbngvMS4xLjI=
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAxOCBKYW4gMjAxMyAxNzozMTowMyBHTVQ=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtOA==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        a2VlcC1hbGl2ZQ==
+      !binary "VmFyeQ==":
+      - !binary |-
+        QWNjZXB0LUVuY29kaW5n
+      !binary "U3RhdHVz":
+      - !binary |-
+        MjAwIE9L
+      !binary "WC1VYS1Db21wYXRpYmxl":
+      - !binary |-
+        SUU9RWRnZSxjaHJvbWU9MQ==
+      !binary "RXRhZw==":
+      - !binary |-
+        IjEzZDZmMDY3NTY3NzM5ODczZmM0OGEzOGE0MzcyNDBiIg==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bWF4LWFnZT0wLCBwcml2YXRlLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "WC1SZXF1ZXN0LUlk":
+      - !binary |-
+        OTliNDhlNjQ5MDRiYjY4MGRjYjIzYmFhNjAyYTc4YTU=
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC4wNjc4OTc=
+      !binary "WC1SYWNrLUNhY2hl":
+      - !binary |-
+        bWlzcw==
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA4uuVkrNTczMUbJSSktMyszXK0gtKkrNyUnULs0rLk0qTi7K
+        TEp1SAcp0UvOz1XSUcosAKo1tDDTMzIy0DM0AGJLoGhicnJqcXF8YglI0ljX
+        wFDX0ELB0NTK0MLK1EipVocO1ljgsYYSoy2tDIA+iAUAQ2dq3CoBAAA=
+    http_version: 
+  recorded_at: Fri, 18 Jan 2013 17:31:03 GMT
+recorded_with: VCR 2.3.0

data/spec/fixtures/cassettes/reports_overview.yml

@@ -0,0 +1,75 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://emailmarketing.locaweb.com.br/api/v1/accounts/50f8e28abf8d79f935000001/messages/50f9828436e1d9ce0d000fd5/overview
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      X-Auth-Token:
+      - Nt5skc1xXsvKKSsyp3Bsx7ABNdJz9pc1uA9kyTdjnJkr
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "U2VydmVy":
+      - !binary |-
+        bmdpbngvMS4xLjI=
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAxOCBKYW4gMjAxMyAxNzozMTowMyBHTVQ=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtOA==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        a2VlcC1hbGl2ZQ==
+      !binary "VmFyeQ==":
+      - !binary |-
+        QWNjZXB0LUVuY29kaW5n
+      !binary "U3RhdHVz":
+      - !binary |-
+        MjAwIE9L
+      !binary "WC1VYS1Db21wYXRpYmxl":
+      - !binary |-
+        SUU9RWRnZSxjaHJvbWU9MQ==
+      !binary "RXRhZw==":
+      - !binary |-
+        ImE1NDMxYWFkYTdkY2Q3NzA4ODE5ZWZiMTczNTcyZmVmIg==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bWF4LWFnZT0wLCBwcml2YXRlLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "WC1SZXF1ZXN0LUlk":
+      - !binary |-
+        YmQ0YTZiMGI5OTJhMDM1OGQyMGNmMDQyODI2ZWQ5OWU=
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC4wNzQ3ODY=
+      !binary "WC1SYWNrLUNhY2hl":
+      - !binary |-
+        bWlzcw==
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA0XMMQ7CMAwF0Ksgzx3SlqKWnXMgx3aRRXFKk3RB3J1ABjb7
+        /W+/QBnOMLh5Grvx2J+k5YnEsXNu5gEaMHxIaSSJSQ64aqGYMOVY8GK7ImMh
+        CpaQUsG+AZZFd9lU6upDNvrObQNhFVO71SCbPq9/6cqbRelem9li9pE29b/T
+        9wfnxESFqgAAAA==
+    http_version: 
+  recorded_at: Fri, 18 Jan 2013 17:31:03 GMT
+recorded_with: VCR 2.3.0

data/spec/fixtures/cassettes/reports_uniq_openings.yml

@@ -0,0 +1,74 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://emailmarketing.locaweb.com.br/api/v1/accounts/50f8e28abf8d79f935000001/messages/50f9828436e1d9ce0d000fd5/uniq_openings
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      X-Auth-Token:
+      - Nt5skc1xXsvKKSsyp3Bsx7ABNdJz9pc1uA9kyTdjnJkr
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "U2VydmVy":
+      - !binary |-
+        bmdpbngvMS4xLjI=
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAxOCBKYW4gMjAxMyAxNzozNjo1NiBHTVQ=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtOA==
+      !binary "VHJhbnNmZXItRW5jb2Rpbmc=":
+      - !binary |-
+        Y2h1bmtlZA==
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        a2VlcC1hbGl2ZQ==
+      !binary "VmFyeQ==":
+      - !binary |-
+        QWNjZXB0LUVuY29kaW5n
+      !binary "U3RhdHVz":
+      - !binary |-
+        MjAwIE9L
+      !binary "WC1VYS1Db21wYXRpYmxl":
+      - !binary |-
+        SUU9RWRnZSxjaHJvbWU9MQ==
+      !binary "RXRhZw==":
+      - !binary |-
+        IjRkOGQyOWRlN2E3NDEwZWU4MmI0NGFmMWY4Y2M3MTMxIg==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bWF4LWFnZT0wLCBwcml2YXRlLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "WC1SZXF1ZXN0LUlk":
+      - !binary |-
+        NzlkZGZiNmJjOWZiZDMzMGFlZTgxZGI5NzhjOTY1ZjE=
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC4wMzA2MjY=
+      !binary "WC1SYWNrLUNhY2hl":
+      - !binary |-
+        bWlzcw==
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA4uuVkrNTczMUbJSSktMyszXK0gtKkrNyUnULs0rLk0qTi7K
+        TEp1SAcp0UvOz1XSUcosAKo1tDDTMzIy0DM0AGJLoGhicnJqcXF8YglI0ljX
+        wFDX0ELB0NTK0MLK1EipVgeXNZQYbWllADQ6FgC3MW2IwwAAAA==
+    http_version: 
+  recorded_at: Fri, 18 Jan 2013 17:36:56 GMT
+recorded_with: VCR 2.3.0

data/spec/locaweb-emailmarketing/adapters/http_request_adapter_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+include Locaweb::Emailmarketing
+
+describe Locaweb::Emailmarketing::HttpRequestAdapter do
+  let(:subject) { HttpRequestAdapter.new(auth_token: AUTH_TOKEN, base_url: BASE_URL) }
+
+  describe ".initialize" do
+    context "when valid options" do
+      it "does not raise exception" do
+        http = HttpRequestAdapter.new(auth_token: 'aa', base_url: 'http://lalapoop.com')
+      end
+    end
+
+    context "when invalid options" do
+      it "raises argument error exception" do
+        lambda { http = HttpRequestAdapter.new(lala: 'aa') }.should raise_exception ArgumentError
+      end
+    end
+  end
+
+  describe ".get" do
+    it "calls restclient GET with correct options" do
+      RestClient.should_receive(:get).with("#{BASE_URL}/aaa", "X-Auth-Token" => AUTH_TOKEN, accept: :json).and_return "{}"
+      subject.get "aaa"
+    end
+
+    it "returns JSON of http response body" do
+      RestClient.stub(:get).and_return %q|{"aaaa":"123"}|
+      subject.get("aaa").should == {"aaaa" => "123"}
+    end
+
+    context "when not found" do
+      it "returns nil" do
+        RestClient.stub(:get).and_raise RestClient::ResourceNotFound.new
+        subject.get("aaa").should be_nil
+      end
+    end
+  end
+
+  describe ".put" do
+    it "calls restclient PUT with correct options" do
+      attributes = {aa: 1}
+      RestClient.should_receive(:put).with("#{BASE_URL}/aaa", attributes.to_json, "X-Auth-Token" => AUTH_TOKEN, content_type: :json).and_return "{}"
+      subject.put "aaa", attributes
+    end
+  end
+
+  describe ".post" do
+    it "calls restclient POST with correct options" do
+      attributes = {aa: 1}
+      RestClient.should_receive(:post).with("#{BASE_URL}/aaa", attributes.to_json, "X-Auth-Token" => AUTH_TOKEN, content_type: :json).and_return "{}"
+      subject.post "aaa", attributes
+    end
+  end
+
+  describe ".delete" do
+    it "calls restclient DELETE with correct options" do
+      RestClient.should_receive(:delete).with("#{BASE_URL}/aaa", "X-Auth-Token" => AUTH_TOKEN, accept: :json).and_return "{}"
+      subject.delete "aaa"
+    end
+  end
+end

data/spec/locaweb-emailmarketing/client_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+# include Locaweb::Emailmarketing
+
+describe Locaweb::Emailmarketing::Client do
+  describe ".accounts" do
+    let(:client) { Client.new auth_token: "apikey", base_url: 'http://lalapopo', account_id: TRIAL_ACCOUNT_ID }
+
+    it "calls account method name" do
+      account_client_mock = mock 'AccountClient'
+      AccountClient.stub(:new).and_return account_client_mock
+      client.accounts.should == account_client_mock
+    end
+  end
+end

data/spec/locaweb-emailmarketing/clients/account_client_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+include Locaweb::Emailmarketing
+
+describe Locaweb::Emailmarketing::AccountClient do
+  let(:client) { Client.new auth_token: AUTH_TOKEN, base_url: BASE_URL, account_id: TRIAL_ACCOUNT_ID }
+
+  describe ".all" do
+    it "returns all accounts" do
+      VCR.use_cassette('accounts_all') do
+        client.accounts.all.should == { "items" =>
+          [
+            {"id"=> TRIAL_ACCOUNT_ID , "display_name"=>"trial", "plan_name"=>"Trial"}
+          ],
+          "page" => {"current"=>1, "total"=>1} }
+      end
+    end
+  end
+
+  describe ".get" do
+    it "returns the given account" do
+      VCR.use_cassette('accounts_get') do
+        client.accounts.get(TRIAL_ACCOUNT_ID).should include({
+          "id"=> TRIAL_ACCOUNT_ID , "display_name"=>"trial", "plan_name"=>"Trial"
+        })
+      end
+    end
+  end
+
+  describe ".update" do
+    it "updates given account" do
+      VCR.use_cassette('accounts_update') do
+        client.accounts.update(TRIAL_ACCOUNT_ID, return_path_domain: 'trial3.newssender.com.br')
+        client.accounts.get(TRIAL_ACCOUNT_ID).should include({"return_path_domain" => 'trial3.newssender.com.br'})
+      end
+    end
+  end
+end

data/spec/locaweb-emailmarketing/clients/base_client_spec.rb

@@ -0,0 +1,77 @@
+# I choosed one resource (custom_fields) to test base client completely using VCR.
+# To the other inherited clients, I tested using shared example base client
+require "spec_helper"
+
+include Locaweb::Emailmarketing
+
+describe Locaweb::Emailmarketing::CustomFieldClient do
+  let(:client) { Client.new auth_token: AUTH_TOKEN, base_url: BASE_URL, account_id: TRIAL_ACCOUNT_ID }
+
+  describe ".all" do
+    it "returns all custom_fields" do
+      VCR.use_cassette('custom_field_all') do
+        client.custom_fields.create(name: "Cidadee", type: "string")
+        client.custom_fields.all["items"].find{|c| c["name"] == "Cidadee"}.should include("name"=>"Cidadee", "type"=>"string")
+      end
+    end
+
+    context "when passing page param" do
+      it "returns page required" do
+        HttpRequestAdapter.any_instance.should_receive(:get).with(/page=2/)
+        client.custom_fields.all(2)
+      end
+    end
+  end
+
+  describe ".get" do
+    it "returns a custom_field" do
+      VCR.use_cassette('custom_field_get') do
+        custom_field_id = client.custom_fields.all["items"].find{|c| c["name"] == "Cidade"}["id"]
+        client.custom_fields.get(custom_field_id).should include("name"=>"Cidade", "type"=>"string")
+      end
+    end
+  end
+
+  describe ".create" do
+    it "creates a custom_field and return custom_field_id" do
+      VCR.use_cassette('custom_field_create') do
+        if custom_field = client.custom_fields.all["items"].find{|c| c["name"] == "codigo"}
+          client.custom_fields.destroy custom_field["id"]
+        end
+        custom_field_id = client.custom_fields.create(name: "codigo", type: "number")
+        client.custom_fields.get(custom_field_id).should include({"id"=>custom_field_id, "name"=>"codigo", "type"=>"number"})
+      end
+    end
+  end
+
+  describe ".update" do
+    it "updates a custom_field" do
+      VCR.use_cassette('custom_field_update') do
+        custom_fields = client.custom_fields.all["items"]
+        if custom_field = custom_fields.find{|c| c["name"] == "city"}
+          client.custom_fields.destroy custom_field["id"]
+        end
+
+        custom_field = client.custom_fields.all["items"].find{|c| c["name"] == "Cidade"}
+        custom_field_id = if custom_field
+          custom_field["id"]
+        else
+          client.custom_fields.create(name: "Cidade", type: "string")
+        end
+
+        client.custom_fields.update(custom_field_id, name: "city")
+        client.custom_fields.get(custom_field_id)["name"].should == "city"
+      end
+    end
+  end
+
+  describe ".destroy" do
+    it "destroys a custom_field" do
+      VCR.use_cassette('custom_field_destroy') do
+        custom_field_id = client.custom_fields.create(name: "lalapopo", type: "number")
+        client.custom_fields.destroy(custom_field_id)
+        client.custom_fields.get(custom_field_id).should be_nil
+      end
+    end
+  end
+end

data/spec/locaweb-emailmarketing/clients/campaign_client_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+include Locaweb::Emailmarketing
+
+describe Locaweb::Emailmarketing::CampaignClient do
+  it_should_behave_like "a base client", "campaigns" do
+    let(:requires_keys_to_create) { [:name] }
+    let(:requires_keys_to_update) { [:name] }
+  end
+end

data/spec/locaweb-emailmarketing/clients/contact_client_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+include Locaweb::Emailmarketing
+
+describe Locaweb::Emailmarketing::ContactClient do
+  it_should_behave_like "a base client", "contacts" do
+    let(:requires_keys_to_create) { [:email, :list_ids] }
+    let(:requires_keys_to_update) { [] }
+  end
+end

data/spec/locaweb-emailmarketing/clients/contact_import_client_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+include Locaweb::Emailmarketing
+
+describe Locaweb::Emailmarketing::ContactImportClient do
+  it_should_behave_like "a base client", "contact_imports", [:update, :destroy] do
+    let(:requires_keys_to_create) { [:name, :list_tokens, :url] }
+  end
+end