locaweb-emailmarketing 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in locaweb-emailmarketing.gemspec
+gemspec

data/README.md

@@ -0,0 +1,133 @@
+locaweb-emailmarketing
+======================
+
+# Description
+
+API client for [Locaweb Email Marketing](http://www.locaweb.com.br/produtos/email-marketing/planos.html)
+
+Trial account: [http://emailmarketing.locaweb.com.br/trial](http://emailmarketing.locaweb.com.br/trial)
+
+# How to use
+
+## Client
+<pre>
+client = Locaweb::Emailmarketing::Client.new auth_token: "TOKEN",
+                                             base_url: 'https://emailmarketing.locaweb.com.br/api/v1',
+                                             account_id: 'ID'
+</pre>
+## Accounts
+- list: client.accounts.all
+- get: client.acccounts.get("ID")
+- update: client.accounts.update("ID", hash_options)<br />
+  available options: return_path_domain
+
+## Campaigns
+- list: client.campaigns.all
+- get: client.campaigns.get("ID")
+- create: client.campaigns.create(options)<br />
+  available options: name, description
+- update: client.campaigns.update("ID", options)<br />
+  available options: name, description
+- destroy: client.campaigns.destroy("ID")
+
+## Contact Imports
+- list: client.contact_imports.all
+- get: client.contact_imports.get("ID")
+- create: client.contact_imports.create(options)<br />
+  available options: required: [:name, :list_tokens, :url], optional: [:description]
+
+## Contacts
+- list: client.contacts.all
+- get: client.contacts.get("ID")
+- create: client.contacts.create(options)<br />
+  available options: required: [], optional: [:custom_fields, :list_tokens]
+- update: client.contacts.update("ID", options)<br />
+  available options: required: [:email, :list_ids], optional: [:custom_fields]
+- destroy: client.contacts.destroy("ID")
+
+## Custom Fields
+- list: client.custom_fields.all
+- get: client.custom_fields.get("ID")
+- create: client.custom_fields.create(options)<br />
+  available options: name, type
+- update: client.custom_fields.update("ID", options)<br />
+  available options: name
+- destroy: client.custom_fields.destroy("ID")
+
+## Domains
+- list: client.domains.all
+- get: client.domains.get("ID")
+- create: client.domains.create(options)<br />
+  available options: required: [:name]
+- update: client.domains.update("ID", options)<br />
+  available options: required: [:name, :default]
+- destroy: client.domains.destroy("ID")
+
+## Lists
+- list: client.lists.all
+- get: client.lists.get("ID")
+- create: client.lists.create(options)<br />
+  available options: name
+- update: client.lists.update("ID", options)<br />
+  available options: name
+- destroy: client.lists.destroy("ID")
+
+## Messages
+- list: client.messages.all
+- get: client.messages.get("ID")
+- create: client.messages.create(options)<br />
+  Example:
+<pre>
+    client.messages.create({
+      domain_id: "50f8e28abf8d79f935000002",
+      html_body: "lala popo",
+      list_ids: ["50f95cbd38a582091f002907"],
+      name: "lala",
+      sender_name: "name",
+      sender: "trial@emailmarketing.locaweb.com.br",
+      subject: "teste lala popo",
+      scheduled_to: "2013-01-20"
+    })
+</pre>
+- update: client.messages.update("ID", options)<br />
+  Example:
+<pre>
+    client.messages.update("ID", {subject: "lalapopo2"})
+</pre>
+- destroy: client.messages.destroy("ID")
+
+More info: [http://wiki.locaweb.com.br/pt-br/APIs_Novo_Email_Marketing/Gerenciar_Mensagens](http://wiki.locaweb.com.br/pt-br/APIs_Novo_Email_Marketing/Gerenciar_Mensagens)
+
+## Reports
+- overview: client.messages.overview("ID")
+- openings: client.messages.openings("ID")
+- uniq_openings: client.messages.uniq_openings("ID")
+- links: client.messages.links("ID")
+- clicks: client.messages.clicks("ID")
+- bounces: client.messages.bounces("ID")
+
+More info: [http://wiki.locaweb.com.br/pt-br/APIs_Novo_Email_Marketing/Gerenciar_Relatorios](http://wiki.locaweb.com.br/pt-br/APIs_Novo_Email_Marketing/Gerenciar_Relatorios)
+
+## Senders
+- list: client.senders.all
+- get: client.senders.get("ID")
+- create: client.senders.create(options)<br />
+  available options: email
+- destroy: client.senders.destroy("ID")
+
+## Unsubscribe Reasons
+- list: client.unsubscribe_reasons.all
+- get: client.unsubscribe_reasons.get("ID")
+- create: client.unsubscribe_reasons.create(options)<br />
+  available options: name
+- update: client.unsubscribe_reasons.update("ID", options)<br />
+  available options: name
+- destroy: client.unsubscribe_reasons.destroy("ID")
+
+## Other
+
+### Pagination
+To return a specif page, pass param to method <i>all</i> like this:
+<pre>
+  client.contacts.all(4)
+</pre>

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/locaweb-emailmarketing.rb

@@ -0,0 +1,12 @@
+require 'json'
+require 'active_support/core_ext'
+require "locaweb-emailmarketing/libs"
+require "locaweb-emailmarketing/adapters"
+require "locaweb-emailmarketing/version"
+require "locaweb-emailmarketing/clients"
+
+module Locaweb
+  module Emailmarketing
+    # Your code goes here...
+  end
+end

data/lib/locaweb-emailmarketing/adapters.rb

@@ -0,0 +1 @@
+require "locaweb-emailmarketing/adapters/http_request_adapter"

data/lib/locaweb-emailmarketing/adapters/http_request_adapter.rb

@@ -0,0 +1,38 @@
+require 'rest_client'
+
+module Locaweb
+  module Emailmarketing
+    class HttpRequestAdapter
+      def initialize(options)
+        options.assert_required_keys(required: [:auth_token, :base_url])
+        @options = options
+      end
+
+      def get uri
+        begin
+          JSON RestClient.get "#{@options[:base_url]}/#{uri}",
+                            { "X-Auth-Token" => @options[:auth_token], accept: :json }
+        rescue RestClient::ResourceNotFound
+          nil
+        end
+      end
+
+      def put uri, attributes
+        RestClient.put "#{@options[:base_url]}/#{uri}",
+                            attributes.to_json,
+                            { "X-Auth-Token" => @options[:auth_token], content_type: :json }
+      end
+
+      def post uri, attributes
+        RestClient.post "#{@options[:base_url]}/#{uri}",
+                            attributes.to_json,
+                            { "X-Auth-Token" => @options[:auth_token], content_type: :json }
+      end
+
+      def delete uri
+        RestClient.delete "#{@options[:base_url]}/#{uri}",
+                            { "X-Auth-Token" => @options[:auth_token], accept: :json }
+      end
+    end
+  end
+end

data/lib/locaweb-emailmarketing/client.rb

@@ -0,0 +1,60 @@
+module Locaweb
+  module Emailmarketing
+    class Client
+      def initialize(options = {})
+        options.assert_required_keys(required: [:account_id, :auth_token, :base_url])
+        @account_id = options[:account_id]
+        options.delete(:account_id)
+        @http_request_adapter = HttpRequestAdapter.new options
+      end
+
+      def accounts
+        @account ||= AccountClient.new @http_request_adapter
+      end
+
+      def custom_fields
+        @custom_fields ||= CustomFieldClient.new @http_request_adapter, @account_id
+      end
+
+      def campaigns
+        @campaigns ||= CampaignClient.new @http_request_adapter, @account_id
+      end
+
+      def contact_imports
+        @contact_imports ||= ContactImportClient.new @http_request_adapter, @account_id
+      end
+
+      def lists
+        @lists ||= ListClient.new @http_request_adapter, @account_id
+      end
+
+      def contacts
+        @contacts ||= ContactClient.new @http_request_adapter, @account_id
+      end
+
+      def domains
+        @domains ||= DomainClient.new @http_request_adapter, @account_id
+      end
+
+      def messages
+        @messages ||= MessageClient.new @http_request_adapter, @account_id
+      end
+
+      def reports
+        @reports ||= ReportClient.new @http_request_adapter, @account_id
+      end
+
+      def senders
+        @senders ||= SenderClient.new @http_request_adapter, @account_id
+      end
+
+      def unsubscribe_reasons
+        @unsubscribe_reasons ||= UnsubscribeReasonClient.new @http_request_adapter, @account_id
+      end
+
+      def templates
+        @templates ||= TemplateClient.new @http_request_adapter, @account_id
+      end
+    end
+  end
+end

data/lib/locaweb-emailmarketing/clients.rb

@@ -0,0 +1,14 @@
+require "locaweb-emailmarketing/client"
+require "locaweb-emailmarketing/clients/base_client"
+require 'locaweb-emailmarketing/clients/account_client'
+require 'locaweb-emailmarketing/clients/campaign_client'
+require 'locaweb-emailmarketing/clients/contact_client'
+require 'locaweb-emailmarketing/clients/contact_import_client'
+require 'locaweb-emailmarketing/clients/custom_field_client'
+require 'locaweb-emailmarketing/clients/domain_client'
+require 'locaweb-emailmarketing/clients/list_client'
+require 'locaweb-emailmarketing/clients/message_client'
+require 'locaweb-emailmarketing/clients/report_client'
+require 'locaweb-emailmarketing/clients/sender_client'
+require 'locaweb-emailmarketing/clients/unsubscribe_reason_client'
+require 'locaweb-emailmarketing/clients/template_client'

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

@@ -0,0 +1,22 @@
+module Locaweb
+  module Emailmarketing
+    class AccountClient
+      def initialize(http_request_adapter)
+        @http_request_adapter = http_request_adapter
+      end
+
+      def all
+        @http_request_adapter.get "accounts"
+      end
+
+      def get(id)
+        @http_request_adapter.get "accounts/#{id}"
+      end
+
+      def update(id, attributes = {})
+        attributes.assert_required_keys(optional: [:return_path_domain])
+        @http_request_adapter.put "accounts/#{id}", account: attributes
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Locaweb
+  module Emailmarketing
+    class BaseClient
+      def initialize(http_request_adapter, account_id)
+        @http_request_adapter = http_request_adapter
+        @account_id = account_id
+        @resource_name = nil #in plural form, ex: campaigns
+        @required_keys_to_update = {optional: [], required: []}
+        @required_keys_to_create = {optional: [], required: []}
+      end
+
+      def all(page=1)
+        url = "accounts/#{@account_id}/#{@resource_name}"
+        url = "#{url}?page=#{page}" if page != 1
+        @http_request_adapter.get url
+      end
+
+      def get(id)
+        @http_request_adapter.get "accounts/#{@account_id}/#{@resource_name}/#{id}"
+      end
+
+      def create(attributes)
+        attributes.assert_required_keys(@required_keys_to_create)
+        response_json = JSON @http_request_adapter.post "accounts/#{@account_id}/#{@resource_name}", {@resource_name.singularize.to_sym => attributes}
+        response_json["id"]
+      end
+
+      def update(id, attributes)
+        attributes.assert_required_keys(@required_keys_to_update)
+        @http_request_adapter.put "accounts/#{@account_id}/#{@resource_name}/#{id}", {@resource_name.singularize.to_sym => attributes}
+      end
+
+      def destroy(id)
+        @http_request_adapter.delete "accounts/#{@account_id}/#{@resource_name}/#{id}"
+      end
+
+      private
+
+      def required_keys_to_update(required_keys_to_update)
+        @required_keys_to_update = required_keys_to_update
+      end
+
+      def required_keys_to_create(required_keys_to_create)
+        @required_keys_to_create = required_keys_to_create
+      end
+
+      def resource_name(resource_name)
+        @resource_name = resource_name
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,12 @@
+module Locaweb
+  module Emailmarketing
+    class ContactClient < BaseClient
+      def initialize(http_request_adapter, account_id)
+        super
+        resource_name "contacts"
+        required_keys_to_update({required: [], optional: [:custom_fields, :list_tokens]})
+        required_keys_to_create({required: [:email, :list_ids], optional: [:custom_fields]})
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Locaweb
+  module Emailmarketing
+    class ContactImportClient < BaseClient
+      def initialize(http_request_adapter, account_id)
+        super
+        resource_name "contact_imports"
+        required_keys_to_create ({ required: [:name, :list_tokens, :url], optional: [:description] })
+      end
+
+      def update(*args)
+        raise(NotImplementedError, "Unavailable action to this resource")
+      end
+
+      def destroy(*args)
+        raise(NotImplementedError, "Unavailable action to this resource")
+      end
+    end
+  end
+end

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

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

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

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

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

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