locaweb-emailmarketing 0.0.1

data/lib/locaweb-emailmarketing/clients/message_client.rb

@@ -0,0 +1,13 @@
+module Locaweb
+  module Emailmarketing
+    class MessageClient < BaseClient
+      def initialize(http_request_adapter, account_id)
+        super
+        resource_name "messages"
+        required_keys = {required: [:domain_id, :html_body, :list_ids, :name, :sender_name, :sender, :subject, :scheduled_to], optional: [:text_body] }
+        required_keys_to_create required_keys
+        required_keys_to_update({required: [], optional: required_keys[:optional] + required_keys[:required] })
+      end
+    end
+  end
+end

data/lib/locaweb-emailmarketing/clients/report_client.rb

@@ -0,0 +1,41 @@
+module Locaweb
+  module Emailmarketing
+    class ReportClient
+      def initialize(http_request_adapter, account_id)
+        @http_request_adapter = http_request_adapter
+        @account_id = account_id
+        @resource_name = "messages"
+      end
+
+      def overview(message_id)
+        do_report_request message_id, "overview"
+      end
+
+      def openings(message_id)
+        do_report_request message_id, "openings"
+      end
+
+      def uniq_openings(message_id)
+        do_report_request message_id, "uniq_openings"
+      end
+
+      def links(message_id)
+        do_report_request message_id, "links"
+      end
+
+      def clicks(message_id)
+        do_report_request message_id, "clicks"
+      end
+
+      def bounces(message_id)
+        do_report_request message_id, "bounces"
+      end
+
+      private
+
+      def do_report_request(message_id, report_name)
+        @http_request_adapter.get "accounts/#{@account_id}/#{@resource_name}/#{message_id}/#{report_name}"
+      end
+    end
+  end
+end

data/lib/locaweb-emailmarketing/clients/sender_client.rb

@@ -0,0 +1,15 @@
+module Locaweb
+  module Emailmarketing
+    class SenderClient < BaseClient
+      def initialize(http_request_adapter, account_id)
+        super
+        resource_name "senders"
+        required_keys_to_create ({ required: [:email], optional: [] })
+      end
+
+      def update(*args)
+        raise(NotImplementedError, "Unavailable action to this resource")
+      end
+    end
+  end
+end

data/lib/locaweb-emailmarketing/clients/template_client.rb

@@ -0,0 +1,12 @@
+module Locaweb
+  module Emailmarketing
+    class TemplateClient < BaseClient
+      def initialize(http_request_adapter, account_id)
+        super
+        resource_name "templates"
+        required_keys_to_create({ required: [:name, :html_body, :text_body], optional: [] })
+        required_keys_to_update({ required: [], optional: [:name, :html_body, :text_body] })
+      end
+    end
+  end
+end

data/lib/locaweb-emailmarketing/clients/unsubscribe_reason_client.rb

@@ -0,0 +1,13 @@
+module Locaweb
+  module Emailmarketing
+    class UnsubscribeReasonClient < BaseClient
+      def initialize(http_request_adapter, account_id)
+        super
+        resource_name "unsubscribe_reasons"
+        required_keys = { required: [:name], optional: [:name] }
+        required_keys_to_create required_keys
+        required_keys_to_update required_keys
+      end
+    end
+  end
+end

data/lib/locaweb-emailmarketing/lib/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  def assert_required_keys(params)
+    params[:required] ||= []
+    params[:optional] ||= []
+    assert_valid_keys params[:required] + params[:optional]
+    pending_keys = params[:required] - keys
+    raise(ArgumentError, "Required key(s) not present: #{pending_keys.join(", ")}") unless pending_keys.empty?
+  end
+end

data/lib/locaweb-emailmarketing/libs.rb

@@ -0,0 +1 @@
+require "locaweb-emailmarketing/lib/hash"

data/lib/locaweb-emailmarketing/version.rb

@@ -0,0 +1,5 @@
+module Locaweb
+  module Emailmarketing
+    VERSION = "0.0.1"
+  end
+end

data/locaweb-emailmarketing.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "locaweb-emailmarketing/version"
+
+Gem::Specification.new do |s|
+  s.name        = "locaweb-emailmarketing"
+  s.version     = Locaweb::Emailmarketing::VERSION
+  s.authors     = ["Fabio Perrella"]
+  s.email       = ["fabio.perrella@gmail.com"]
+  s.homepage    = "https://github.com/fabioperrella/locaweb-emailmarketing"
+  s.summary     = %q{APIs for Locaweb EmailMarketing http://emailmarketing.locaweb.com.br/trial}
+  s.description = %q{APIs for Locaweb EmailMarketing http://emailmarketing.locaweb.com.br/trial}
+
+  s.rubyforge_project = "locaweb-emailmarketing"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-debugger"
+  s.add_development_dependency "webmock", "~> 1.8.11"
+  s.add_development_dependency "vcr"
+  s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency "rest-client"
+  s.add_runtime_dependency "json"
+end

data/spec/fixtures/cassettes/accounts_all.yml

@@ -0,0 +1,74 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://emailmarketing.locaweb.com.br/api/v1/accounts
+    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 |-
+        RnJpLCAxOCBKYW4gMjAxMyAxNzowMDoxNSBHTVQ=
+      !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 |-
+        IjgzNzdkZWIyNjc0YmQ2Yjk5YjNkMzg1NTNjMjIyZWRmIg==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bWF4LWFnZT0wLCBwcml2YXRlLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "WC1SZXF1ZXN0LUlk":
+      - !binary |-
+        YWI0YzgzYTcxMGU2YWFlNzVjY2M5OWE1NjM5MjExNTM=
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC4wMDg5OTE=
+      !binary "WC1SYWNrLUNhY2hl":
+      - !binary |-
+        bWlzcw==
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAAzXKwQqDMBCE4XeZswejSJM8hzcpZWuSEtAocXsoIe/eVXCO
+        3/wFkf16wE4F0cFiaIP2naZ30O5hgumH9pxCAxePfaHfK9HqpeQcaREWS7eN
+        l9WnKH0ECuZvzj4xrGrAG8trVa1/Jl3Hb3cAAAA=
+    http_version: 
+  recorded_at: Fri, 18 Jan 2013 17:00:15 GMT
+recorded_with: VCR 2.3.0

data/spec/fixtures/cassettes/accounts_get.yml

@@ -0,0 +1,77 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://emailmarketing.locaweb.com.br/api/v1/accounts/50f8e28abf8d79f935000001
+    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 |-
+        RnJpLCAxOCBKYW4gMjAxMyAxNzowMDoxNSBHTVQ=
+      !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 |-
+        ImZmNjI4Y2Y0MDI4Yzc0YjEzMDY4ZTBlMmRhY2U3N2M4Ig==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bWF4LWFnZT0wLCBwcml2YXRlLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "WC1SZXF1ZXN0LUlk":
+      - !binary |-
+        MWI2NzFlMmUzNGMyYmM5ZjkxMzAzNzU2MDE0YzgzOTY=
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC4wOTMxNjE=
+      !binary "WC1SYWNrLUNhY2hl":
+      - !binary |-
+        bWlzcw==
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA2WPzY6DMAyEX2WVc4sCCC3ktA/Re2QSI6LNTxVMUVXx7nX6
+        s3toTtbniWfmJpwVSnRy6rHpYZx6+z1MQ9vJ8mpxEBjAeZZYDCkulMFA+vHJ
+        wIZjZVKoxswq65azh6uOEJDFlB14xszim51ezGQEQquBGNbtUdbHuv+Sreqk
+        kg0LMtKaoz4Dzdomto/vixXGi0uc5Jf+rT/l+gK+1LqJ10B5xf3hbB0tZWG4
+        yxo4Bc1u0dyMZqFqDpyRL5U/8iAe2F+FGv5mnTHiBv6ZvpElf8P5xadic+Wm
+        3Pc7GUYuQ2QBAAA=
+    http_version: 
+  recorded_at: Fri, 18 Jan 2013 17:00:15 GMT
+recorded_with: VCR 2.3.0

data/spec/fixtures/cassettes/accounts_update.yml

@@ -0,0 +1,124 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://emailmarketing.locaweb.com.br/api/v1/accounts/50f8e28abf8d79f935000001
+    body:
+      encoding: US-ASCII
+      string: ! '{"account":{"return_path_domain":"trial3.newssender.com.br"}}'
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      X-Auth-Token:
+      - Nt5skc1xXsvKKSsyp3Bsx7ABNdJz9pc1uA9kyTdjnJkr
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '61'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Server:
+      - nginx/1.1.2
+      Date:
+      - Fri, 18 Jan 2013 17:00:15 GMT
+      Connection:
+      - keep-alive
+      Status:
+      - 204 No Content
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Cache-Control:
+      - no-cache
+      X-Request-Id:
+      - b97ff961eb1523281c0cf03ed6d3fd14
+      X-Runtime:
+      - '0.079324'
+      X-Rack-Cache:
+      - invalidate, pass
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Fri, 18 Jan 2013 17:00:16 GMT
+- request:
+    method: get
+    uri: https://emailmarketing.locaweb.com.br/api/v1/accounts/50f8e28abf8d79f935000001
+    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 |-
+        RnJpLCAxOCBKYW4gMjAxMyAxNzowMDoxNiBHTVQ=
+      !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 |-
+        ImEzYjZhZTYyYzFjMGUzYTc0ODE4NjJhYWIyY2I1NzBhIg==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bWF4LWFnZT0wLCBwcml2YXRlLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "WC1SZXF1ZXN0LUlk":
+      - !binary |-
+        MDQ3ZDEzZjRlMTJmN2RlMWU4ZGQ0OTIzMzU1OGI0NGI=
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC4wNDg3NDE=
+      !binary "WC1SYWNrLUNhY2hl":
+      - !binary |-
+        bWlzcw==
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA2WPzWrDMBCEX6XonBjZxtTWqQ+Ru1hLayzQT5DWNSH43btK
+        k/YQnZbZTzszd+GsUGKQy4jdCPMy2s9pmfpB1teKk8AAzjNiMaRYKIOB9OWT
+        gR3nxqTQzJkp68rVw01HCMgwZQeeZdbiS7s8NZMRCK0GYrHtz7I9t+OH7NUg
+        lewYyEhbjvoKtGqb2D6+LvZNxL0UjBbzv/c7r7/B11538Rwob3g8rK2jUheG
+        y2yBY9DqiuZqtArVcuKMfKn+kSfxkP1NqOlv1hk5A/jf+J2sBTouIN6J3dWb
+        8jh+AJ8YrJdlAQAA
+    http_version: 
+  recorded_at: Fri, 18 Jan 2013 17:00:16 GMT
+recorded_with: VCR 2.3.0

data/spec/fixtures/cassettes/custom_field_all.yml

@@ -0,0 +1,150 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://emailmarketing.locaweb.com.br/api/v1/accounts/50f8e28abf8d79f935000001/custom_fields
+    body:
+      encoding: US-ASCII
+      string: ! '{"custom_field":{"name":"Cidadee","type":"string"}}'
+    headers:
+      Accept:
+      - ! '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      X-Auth-Token:
+      - Nt5skc1xXsvKKSsyp3Bsx7ABNdJz9pc1uA9kyTdjnJkr
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '51'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "U2VydmVy":
+      - !binary |-
+        bmdpbngvMS4xLjI=
+      !binary "RGF0ZQ==":
+      - !binary |-
+        RnJpLCAxOCBKYW4gMjAxMyAxNzowMTo0NCBHTVQ=
+      !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 |-
+        ImY1NzRhNGE0MzhmNWQzZDdiYjM0ZmRiNzYwMWRiYWZkIg==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bWF4LWFnZT0wLCBwcml2YXRlLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "WC1SZXF1ZXN0LUlk":
+      - !binary |-
+        MGU1YmVkZjBjOTJhOWYyNDhjYjNjNjA4NjM0ZjdlODU=
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC4wMTUxNzQ=
+      !binary "WC1SYWNrLUNhY2hl":
+      - !binary |-
+        aW52YWxpZGF0ZSwgcGFzcw==
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA6tWykxRslIyNUizNE9LszC2SDS1MEpJMUgxMLAwTDZWqgUA
+        SBs2HiEAAAA=
+    http_version: 
+  recorded_at: Fri, 18 Jan 2013 17:01:44 GMT
+- request:
+    method: get
+    uri: https://emailmarketing.locaweb.com.br/api/v1/accounts/50f8e28abf8d79f935000001/custom_fields
+    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 |-
+        RnJpLCAxOCBKYW4gMjAxMyAxNzowMTo0NCBHTVQ=
+      !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 |-
+        ImVjNjNkMTA3ZDRkODU3OTIwNDQwMzhjMzU5NDI0YmM3Ig==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        bWF4LWFnZT0wLCBwcml2YXRlLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "WC1SZXF1ZXN0LUlk":
+      - !binary |-
+        ODc0NTJkZjc1OTA1NTc2YjZkOTVlNzU2MmYwMThiZDg=
+      !binary "WC1SdW50aW1l":
+      - !binary |-
+        MC4wMTAzMzY=
+      !binary "WC1SYWNrLUNhY2hl":
+      - !binary |-
+        bWlzcw==
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA4XQzQqDMAwH8FeRnD3Uj2L1up33AmOHaFIprFW0HkR891V2
+        UEG2nMKf9EeaBYxnO0L1XMAQVCCFLgutVaZQqpRIkBAqaTKIwaHlMHEzhMQc
+        Aj/3WzD6wbgW1vhEcP4lWG5EwQp3ounItN0uuMnWPJwExanCWisqSl1mUmwl
+        d+GOHiPiyOHYGMvOHzRCz3+t/LCN8fPP31y9Pxzk0dmLa7xi6LENyQLNNAxh
+        RaiSMNV5fIduXT8HSsLtewEAAA==
+    http_version: 
+  recorded_at: Fri, 18 Jan 2013 17:01:44 GMT
+recorded_with: VCR 2.3.0