locaweb-emailmarketing 0.0.1

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

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

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

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

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

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

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

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+include Locaweb::Emailmarketing
+
+describe Locaweb::Emailmarketing::MessageClient do
+  it_should_behave_like "a base client", "messages" do
+    let(:requires_keys_to_create) { [:domain_id, :html_body, :list_ids, :name, :sender_name, :sender, :subject, :scheduled_to] }
+    let(:requires_keys_to_update) { [] }
+  end
+end

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

@@ -0,0 +1,70 @@
+require "spec_helper"
+
+include Locaweb::Emailmarketing
+
+describe Locaweb::Emailmarketing::ReportClient do
+  let(:trial_account_id) { "50f8e28abf8d79f935000001" }
+  let(:auth_token) { "Nt5skc1xXsvKKSsyp3Bsx7ABNdJz9pc1uA9kyTdjnJkr" }
+  let(:client) { Client.new auth_token: auth_token, base_url: BASE_URL, account_id: trial_account_id }
+  let(:message_id) { "50f9828436e1d9ce0d000fd5" }
+
+  describe ".overview" do
+    it "returns overview report of a message" do
+      VCR.use_cassette('reports_overview') do
+        data = client.reports.overview(message_id)
+        expected_keys = ["status", "bounces", "clicks", "contacts", "deliveries", "openings", "uniq_openings", "unsubscribes"]
+        (data.keys & expected_keys).should =~ expected_keys
+      end
+    end
+  end
+
+  describe ".openings" do
+    it "returns openings of a message" do
+      VCR.use_cassette('reports_openings') do
+        data = client.reports.openings(message_id).first
+        expected_keys = ["email", "ip", "access_at"]
+        (data.keys & expected_keys).should =~ expected_keys
+      end
+    end
+  end
+
+  describe ".uniq_openings" do
+    it "returns message_id of a message" do
+      VCR.use_cassette('reports_uniq_openings') do
+        data = client.reports.uniq_openings(message_id).first
+        expected_keys = ["email", "ip", "access_at"]
+        (data.keys & expected_keys).should =~ expected_keys
+      end
+    end
+  end
+
+  describe ".links" do
+    it "returns links of a message" do
+      VCR.use_cassette('reports_links') do
+        data = client.reports.links(message_id).first
+        expected_keys = ["href", "name"]
+        (data.keys & expected_keys).should =~ expected_keys
+      end
+    end
+  end
+
+  describe ".clicks" do
+    it "returns clicks of a message" do
+      VCR.use_cassette('reports_clicks') do
+        data = client.reports.clicks(message_id).first
+        expected_keys = ["href", "email", "ip", "access_at"]
+        (data.keys & expected_keys).should =~ expected_keys
+      end
+    end
+  end
+
+  describe ".bounces" do
+    it "returns bounces of a message" do
+      VCR.use_cassette('reports_bounces') do
+        data = client.reports.bounces(message_id).first
+        expected_keys = ["status", "email", "diagnostic", "access_at"]
+        (data.keys & expected_keys).should =~ expected_keys
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+include Locaweb::Emailmarketing
+
+describe Locaweb::Emailmarketing::SenderClient do
+  it_should_behave_like "a base client", "senders", [:update] do
+    let(:requires_keys_to_create) { [:email] }
+  end
+end

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

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

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

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

data/spec/locaweb-emailmarketing/lib/hash_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Hash do
+  describe ".assert_required_keys" do
+    context "when invalid keys" do
+      it "raises exception" do
+        lambda { {aa: 1}.assert_required_keys(optional: [:bb]) }.should raise_exception ArgumentError
+      end
+    end
+
+    context "when missing required keys" do
+      it "raises exception" do
+        lambda { {aa: 1}.assert_required_keys(optional: [:aa], required: [:bb]) }.should raise_exception ArgumentError
+      end
+    end
+
+    context "when keys ok" do
+      it "does not raise exception" do
+        {bb: 1}.assert_required_keys(optional: [:aa], required: [:bb]).should be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rspec'
+require 'locaweb-emailmarketing'
+require 'pry'
+require 'vcr'
+require 'webmock'
+
+AUTH_TOKEN = 'Nt5skc1xXsvKKSsyp3Bsx7ABNdJz9pc1uA9kyTdjnJkr'
+BASE_URL = 'https://emailmarketing.locaweb.com.br/api/v1'
+TRIAL_ACCOUNT_ID = "50f8e28abf8d79f935000001"
+
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+
+VCR.configure do |conf|
+  conf.default_cassette_options = { :match_requests_on => [:uri, :method, :body, :headers] }
+  conf.cassette_library_dir = 'spec/fixtures/cassettes'
+  conf.hook_into :webmock
+end
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/spec/support/base_client_examples.rb

@@ -0,0 +1,100 @@
+shared_examples_for "a base client" do |resource_name, except = []|
+  let(:client) { Client.new auth_token: AUTH_TOKEN, base_url: BASE_URL, account_id: TRIAL_ACCOUNT_ID }
+
+  unless except.include?(:all)
+    describe ".all" do
+      it "calls http GET to #{resource_name} index url" do
+        HttpRequestAdapter.any_instance.should_receive(:get).with("accounts/#{TRIAL_ACCOUNT_ID}/#{resource_name}")
+        client.send(resource_name).all
+      end
+
+      it "returns GET response" do
+        HttpRequestAdapter.any_instance.stub(:get).and_return({})
+        client.send(resource_name).all.should == {}
+      end
+    end
+  end
+
+  unless except.include?(:get)
+    describe ".get" do
+      let(:resource_id) { "lalapopolala" }
+
+      it "calls http GET to #{resource_name} show url" do
+        HttpRequestAdapter.any_instance.should_receive(:get).with("accounts/#{TRIAL_ACCOUNT_ID}/#{resource_name}/#{resource_id}")
+        client.send(resource_name).get(resource_id)
+      end
+
+      it "returns GET response" do
+        HttpRequestAdapter.any_instance.stub(:get).and_return({})
+        client.send(resource_name).get(resource_id).should == {}
+      end
+    end
+  end
+
+  unless except.include?(:create)
+    describe ".create" do
+      let(:attributes) do
+        attrs = {}
+        requires_keys_to_create.each { |key| attrs[key] = "any_value" }
+        attrs
+      end
+
+      context "when invalid attributes" do
+        it "raise ArgumentError exception" do
+          lambda{ client.send(resource_name).create(lalapopo: 1) }.should raise_exception ArgumentError
+        end
+      end
+
+      it "calls http POST to #{resource_name} create url" do
+        HttpRequestAdapter.any_instance.should_receive(:post).with("accounts/#{TRIAL_ACCOUNT_ID}/#{resource_name}", {resource_name.singularize.to_sym => attributes}).and_return(%q|{"id": "12"}|)
+        client.send(resource_name).create(attributes)
+      end
+
+      it "returns created #{resource_name.singularize}'s id" do
+        HttpRequestAdapter.any_instance.stub(:post).and_return(%q|{"id": "12"}|)
+        client.send(resource_name).create(attributes).should == "12"
+      end
+    end
+  end
+
+  unless except.include?(:update)
+    describe ".update" do
+      let(:resource_id) { "12334" }
+      let(:attributes) do
+        attrs = {}
+        requires_keys_to_update.each { |key| attrs[key] = "any_value" }
+        attrs
+      end
+
+      context "when invalid attributes" do
+        it "raise ArgumentError exception" do
+          lambda{ client.send(resource_name).update(resource_id, lalapopo: 1) }.should raise_exception ArgumentError
+        end
+      end
+
+      it "calls http PUT to #{resource_name} update url" do
+        HttpRequestAdapter.any_instance.should_receive(:put).with("accounts/#{TRIAL_ACCOUNT_ID}/#{resource_name}/#{resource_id}", {resource_name.singularize.to_sym => attributes})
+        client.send(resource_name).update(resource_id, attributes)
+      end
+    end
+  end
+
+  unless except.include?(:destroy)
+    describe ".destroy" do
+      let(:resource_id) { "lalapopolala" }
+
+      it "calls http DELETE to #{resource_name} delete url" do
+        HttpRequestAdapter.any_instance.should_receive(:delete).with("accounts/#{TRIAL_ACCOUNT_ID}/#{resource_name}/#{resource_id}")
+        client.send(resource_name).destroy(resource_id)
+      end
+    end
+  end
+
+  except.each do |not_implemented_method|
+    describe ".not_implemented_method" do
+      it "raises not implemented method error" do
+        lambda { client.send(resource_name).send(not_implemented_method) }.should raise_exception NotImplementedError
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: locaweb-emailmarketing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fabio Perrella
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &74293600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *74293600
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &74293330 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *74293330
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: &74292860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *74292860
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &74292390 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.11
+  type: :development
+  prerelease: false
+  version_requirements: *74292390
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &74291990 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *74291990
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &74291620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *74291620
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &74291410 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *74291410
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &74291160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *74291160
+description: APIs for Locaweb EmailMarketing http://emailmarketing.locaweb.com.br/trial
+email:
+- fabio.perrella@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/locaweb-emailmarketing.rb
+- lib/locaweb-emailmarketing/adapters.rb
+- lib/locaweb-emailmarketing/adapters/http_request_adapter.rb
+- lib/locaweb-emailmarketing/client.rb
+- lib/locaweb-emailmarketing/clients.rb
+- lib/locaweb-emailmarketing/clients/account_client.rb
+- lib/locaweb-emailmarketing/clients/base_client.rb
+- lib/locaweb-emailmarketing/clients/campaign_client.rb
+- lib/locaweb-emailmarketing/clients/contact_client.rb
+- lib/locaweb-emailmarketing/clients/contact_import_client.rb
+- lib/locaweb-emailmarketing/clients/custom_field_client.rb
+- lib/locaweb-emailmarketing/clients/domain_client.rb
+- lib/locaweb-emailmarketing/clients/list_client.rb
+- lib/locaweb-emailmarketing/clients/message_client.rb
+- lib/locaweb-emailmarketing/clients/report_client.rb
+- lib/locaweb-emailmarketing/clients/sender_client.rb
+- lib/locaweb-emailmarketing/clients/template_client.rb
+- lib/locaweb-emailmarketing/clients/unsubscribe_reason_client.rb
+- lib/locaweb-emailmarketing/lib/hash.rb
+- lib/locaweb-emailmarketing/libs.rb
+- lib/locaweb-emailmarketing/version.rb
+- locaweb-emailmarketing.gemspec
+- spec/fixtures/cassettes/accounts_all.yml
+- spec/fixtures/cassettes/accounts_get.yml
+- spec/fixtures/cassettes/accounts_update.yml
+- spec/fixtures/cassettes/custom_field_all.yml
+- spec/fixtures/cassettes/custom_field_create.yml
+- spec/fixtures/cassettes/custom_field_destroy.yml
+- spec/fixtures/cassettes/custom_field_get.yml
+- spec/fixtures/cassettes/custom_field_update.yml
+- spec/fixtures/cassettes/reports_bounces.yml
+- spec/fixtures/cassettes/reports_clicks.yml
+- spec/fixtures/cassettes/reports_links.yml
+- spec/fixtures/cassettes/reports_openings.yml
+- spec/fixtures/cassettes/reports_overview.yml
+- spec/fixtures/cassettes/reports_uniq_openings.yml
+- spec/locaweb-emailmarketing/adapters/http_request_adapter_spec.rb
+- spec/locaweb-emailmarketing/client_spec.rb
+- spec/locaweb-emailmarketing/clients/account_client_spec.rb
+- spec/locaweb-emailmarketing/clients/base_client_spec.rb
+- spec/locaweb-emailmarketing/clients/campaign_client_spec.rb
+- spec/locaweb-emailmarketing/clients/contact_client_spec.rb
+- spec/locaweb-emailmarketing/clients/contact_import_client_spec.rb
+- spec/locaweb-emailmarketing/clients/custom_field_client_spec.rb
+- spec/locaweb-emailmarketing/clients/domains_client_spec.rb
+- spec/locaweb-emailmarketing/clients/list_client_spec.rb
+- spec/locaweb-emailmarketing/clients/message_client_spec.rb
+- spec/locaweb-emailmarketing/clients/report_client_spec.rb
+- spec/locaweb-emailmarketing/clients/sender_client_spec.rb
+- spec/locaweb-emailmarketing/clients/template_client_spec.rb
+- spec/locaweb-emailmarketing/clients/unsubscribe_reason_client_spec.rb
+- spec/locaweb-emailmarketing/lib/hash_spec.rb
+- spec/spec_helper.rb
+- spec/support/base_client_examples.rb
+homepage: https://github.com/fabioperrella/locaweb-emailmarketing
+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: locaweb-emailmarketing
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: APIs for Locaweb EmailMarketing http://emailmarketing.locaweb.com.br/trial
+test_files: []
+has_rdoc: