mad_mimi 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.rvmrc
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    mad_mimi (0.0.1)
+      faraday (= 0.5.4)
+      faraday_middleware (= 0.3.1)
+      multi_xml (= 0.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.3)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    faraday (0.5.4)
+      addressable (~> 2.2.2)
+      multipart-post (~> 1.1.0)
+      rack (>= 1.1.0, < 2)
+    faraday_middleware (0.3.1)
+      faraday (~> 0.5.3)
+    multi_xml (0.2.0)
+    multipart-post (1.1.0)
+    rack (1.2.1)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    webmock (1.6.2)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mad_mimi!
+  rspec (~> 2.4.0)
+  webmock (~> 1.6.2)

data/License.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2011 Ozéias Sant'ana
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,2 @@
+Rakefile
+Manifest

data/README.rdoc

@@ -0,0 +1,8 @@
+= MadMimi
+
+Manage your MadMimi audience
+
+== Copyright
+
+Copyright (c) 2011 Ozéias Sant'ana. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,22 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require 'bundler'
+require 'rake'
+begin
+  Bundler::GemHelper.install_tasks
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rspec'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec
+
+desc 'Open an irb session preloaded with this library'
+task :console do
+  sh 'irb -rubygems -I lib -r mad_mimi.rb'
+end

data/lib/mad_mimi.rb

@@ -0,0 +1,44 @@
+require "singleton"
+
+require "mad_mimi/audience"
+require "mad_mimi/config"
+
+module MadMimi #:nodoc
+  class << self
+    # Sets the MadMimi configuration options. Best used by passing a block.
+    #
+    # Example:
+    #
+    #   MadMimi.configure do |config|
+    #     config.username = "emailaddress"
+    #     config.api_key  = "api_key"
+    #   end
+    #
+    # Returns:
+    #
+    # The MadMimi +Config+ singleton instance.
+    def configure
+      config = MadMimi::Config.instance
+      block_given? ? yield(config) : config
+    end
+    alias :config :configure
+
+    # Authentication hash
+    #
+    # return [Hash]
+    def authentication
+      {
+        :username => configure.username,
+        :api_key => configure.api_key
+      }
+    end
+
+    def api_url
+      'http://api.madmimi.com'
+    end
+
+    def audience
+      MadMimi::Audience.new
+    end
+  end
+end

data/lib/mad_mimi/audience.rb

@@ -0,0 +1,64 @@
+require File.expand_path('../request', __FILE__)
+module MadMimi #:nodoc
+  class Audience #:nodoc
+    include Request
+
+    # Get Audience Members
+    #
+    # Returns audience members paged in XML format.
+    #
+    # == Optional parameters are:
+    # * <tt>:page</tt> -- the current page to fetch
+    # * <tt>:per_page</tt> -- the number of audience members returned per page. Must be between 1 and 100
+    # * <tt>:order</tt> -- the ordering. Must be one of email, first_name, last_name and created_at
+    #
+    # See {Get Audience Members}[http://madmimi.com/developer/lists]
+    def members(options = {})
+      members = get('/audience_members')
+      members ? members["audience"]["member"] : members
+    end
+
+    # Get all Audience Lists
+    #
+    # Returns all audience lists
+    #
+    # See {Get all Audience Lists}[http://madmimi.com/developer/lists/get-all-audience-lists]
+    def lists
+      lists = get('/audience_lists/lists.xml')
+      lists ? lists["lists"]["list"] : lists
+    end
+
+    # Add Audience List Membership
+    #
+    # This will add an existing member to a list or create a new audience member with that
+    # email address and add that member to the list. Any additional parameters passed (such as
+    # first_name and last_name) will be +added+ or +updated+ on the audience member.
+    #
+    # See {Add Audience List Membership}[http://madmimi.com/developer/lists/add-membership]
+    def add_to_list(list, options = {})
+      post("/audience_lists/#{list}/add", options, true)
+    end
+
+    # Remove Audience List Membership
+    #
+    # Removes an existing email address from an audience list. The member is not deleted
+    # and will remain on any other lists. The email address is simply removed from that
+    # audience list.
+    #
+    # See {Remove Audience List Membership}[http://madmimi.com/developer/lists/remove-membership]
+    def remove_from_list(list, email)
+      post("/audience_lists/#{list}/remove", {:email => email})
+    end
+
+    # Suppress an Audience Member
+    #
+    # This adds the audience member to your suppression list, effectively preventing sending
+    # newsletters to that member (unsubscribing them). Audience members on your suppression
+    # list do not count towards your total active audience.
+    #
+    # See {Suppress an Audience Member}[http://madmimi.com/developer/lists/suppress-email]
+    def suppress(email)
+      post("/audience_members/#{email}/suppress_email")
+    end
+  end
+end

data/lib/mad_mimi/config.rb

@@ -0,0 +1,8 @@
+module MadMimi #:nodoc
+  class Config #:nodoc
+    include Singleton
+    attr_accessor :username, :api_key
+
+    def initialize;end
+  end
+end

data/lib/mad_mimi/request.rb

@@ -0,0 +1,45 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module MadMimi
+  # Defines HTTP request methods
+  module Request
+    def get(path, options={}, raw = false)
+      request(:get, path, options, raw)
+    end
+
+    def post(path, options={}, raw = false)
+      request(:post, path, options, raw)
+    end
+
+    private
+      def request(method, path, options, raw = false)
+        response = connection(raw).send(method) do |request|
+          options = options.merge(MadMimi.authentication)
+          case method
+          when :get
+            request.url(path, options)
+          when :post
+            request.path = path
+            request.body = options unless options.empty?
+          end
+        end
+        raw ? response : response.body
+      end
+
+      def connection(raw = false)
+        options = {
+          :headers => {'Accept' => "application/xml", 'User-Agent' => 'MadMimi Gem'},
+          :ssl => { :verify => false },
+          :url => MadMimi.api_url
+        }
+
+        Faraday::Connection.new(options) do |builder|
+          builder.adapter Faraday.default_adapter
+          unless raw
+            builder.use Faraday::Response::ParseXml
+          end
+        end
+      end
+  end
+end

data/lib/mad_mimi/version.rb

@@ -0,0 +1,3 @@
+module MadMimi
+  VERSION = "0.0.1" unless defined?(::MadMimi::VERSION)
+end

data/mad_mimi.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'mad_mimi/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'mad_mimi'
+  s.version     = MadMimi::VERSION
+
+  s.authors     = "Ozéias Sant'ana"
+  s.email       = 'oz.santana@gmail.com'
+  s.homepage    = 'http://railsbox.org'
+
+  s.summary     = %q{Manage your MadMimi audience}
+
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.7') if s.respond_to? :required_rubygems_version=
+
+  s.add_runtime_dependency 'faraday',     '0.5.4'
+
+  s.add_dependency 'faraday_middleware',  '0.3.1'
+  s.add_dependency 'multi_xml',           '0.2.0'
+
+  s.add_development_dependency 'rspec',   '~> 2.4.0'
+  s.add_development_dependency 'webmock', '~> 1.6.2'
+
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths      = ['lib']
+end

data/spec/fixtures/audience_lists.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<lists>
+  <list display_name="" subscriber_count="1" name="Friends" id="102938"/>
+  <list display_name="" subscriber_count="1" name="Clients" id="102939"/>
+</lists>

data/spec/fixtures/audience_members.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<audience count="1" page="1" total_pages="1" per_page="30">
+  <member suppressed="false">
+    <first_name>Ozéias</first_name>
+    <last_name>Sant'ana</last_name>
+    <email>oz.santana@gmail.com</email>
+    <created_at>Fri Dec 10 18:09:50 -0500 2010</created_at>
+    <city></city>
+    <lists></lists>
+  </member>
+</audience>

data/spec/mad_mimi/audience_spec.rb

@@ -0,0 +1,92 @@
+require 'spec/spec_helper'
+
+describe MadMimi::Audience do
+  before (:all) do
+    MadMimi.configure do |config|
+      config.username = "email@example.com"
+      config.api_key  = "api_key"
+    end
+  end
+
+  it "should connect using the api_url configuration" do
+    audience    = MadMimi::Audience.new
+    connection  = audience.send(:connection).build_url(nil).to_s
+    connection.should == "http://api.madmimi.com/"
+  end
+
+  describe ".members" do
+    before do
+      stub_get('/audience_members').
+        with(:headers => {'Accept'=>'application/xml', 'User-Agent'=>'MadMimi Gem'}).
+        to_return(:status => 200, :body => fixture("audience_members.xml"), :headers => {:content_type => "application/xml; charset=utf-8"})
+    end
+
+    it "should get the audience members" do
+      MadMimi.audience.members.should == {"city"=>nil, "created_at"=>"Fri Dec 10 18:09:50 -0500 2010", "suppressed"=>"false", "lists"=>nil, "last_name"=>"Sant'ana", "email"=>"oz.santana@gmail.com", "first_name"=>"Ozéias"}
+    end
+  end
+
+  describe ".lists" do
+    before do
+      stub_get('/audience_lists/lists.xml').
+        with(:headers => {'Accept'=>'application/xml', 'User-Agent'=>'MadMimi Gem'}).
+        to_return(:status => 200, :body => fixture("audience_lists.xml"), :headers => {:content_type => "application/xml; charset=utf-8"})
+    end
+
+    it "should get the audience members" do
+      MadMimi.audience.lists.should == [{"name"=>"Friends", "subscriber_count"=>"1", "id"=>"102938", "display_name"=>""}, {"name"=>"Clients", "subscriber_count"=>"1", "id"=>"102939", "display_name"=>""}]
+    end
+  end
+
+  describe ".add_to_list" do
+    before do
+      stub_post('/audience_lists/Clients/add').
+        with(:headers => {'Accept'=>'application/xml', 'User-Agent'=>'MadMimi Gem'}).
+        to_return(:status => 200, :body => " ", :headers => {:content_type => "text/html; charset=utf-8"})
+    end
+
+    it "should add audience list membership" do
+      client = {:first_name => 'Denise', :last_name => 'T. Guillen', :email => 'denise.t@example.com'}
+      MadMimi.audience.add_to_list('Clients', client)
+
+      a_post('/audience_lists/Clients/add').
+        with(:body => client.merge(MadMimi.authentication)).
+        with(:headers => {'Accept'=>'application/xml', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'MadMimi Gem'}).
+        should have_been_made
+    end
+  end
+
+  describe ".remove_from_list" do
+    before do
+      stub_post('/audience_lists/Clients/remove').
+        with(:headers => {'Accept'=>'application/xml', 'User-Agent'=>'MadMimi Gem'}).
+        to_return(:status => 200, :body => " ", :headers => {:content_type => "text/html; charset=utf-8"})
+    end
+
+    it "should remove audience list membership" do
+      MadMimi.audience.remove_from_list('Clients', 'denise.t@example.com')
+
+      a_post('/audience_lists/Clients/remove').
+        with(:body => {:email => 'denise.t@example.com'}.merge(MadMimi.authentication)).
+        with(:headers => {'Accept'=>'application/xml', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'MadMimi Gem'}).
+        should have_been_made
+    end
+  end
+
+  describe ".suppress" do
+    before do
+      stub_post('/audience_members/denise.t@example.com/suppress_email').
+        with(:headers => {'Accept'=>'application/xml', 'User-Agent'=>'MadMimi Gem'}).
+        to_return(:status => 200, :body => " ", :headers => {:content_type => "text/html; charset=utf-8"})
+    end
+
+    it "should suppress an audience member" do
+      MadMimi.audience.suppress('denise.t@example.com')
+
+      a_post('/audience_members/denise.t@example.com/suppress_email').
+        with(:body => MadMimi.authentication).
+        with(:headers => {'Accept'=>'application/xml', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'MadMimi Gem'}).
+        should have_been_made
+    end
+  end
+end

data/spec/mad_mimi_spec.rb

@@ -0,0 +1,39 @@
+require 'spec/spec_helper'
+
+describe MadMimi do
+  describe ".configure" do
+    ['username', 'api_key'].each do |key|
+      it "should set the #{key}" do
+        MadMimi.configure do |config|
+          config.send("#{key}=", key)
+          MadMimi.configure.send(key).should == key
+        end
+      end
+    end
+  end
+
+  describe ".authentication" do
+    before do
+      MadMimi.configure do |config|
+        config.username = "email@example.com"
+        config.api_key  = "api_key"
+      end
+    end
+
+    it "should return the authentication hash" do
+      MadMimi.authentication.should == { :api_key => "api_key", :username => "email@example.com" }
+    end
+  end
+
+  describe ".api_url" do
+    it "should return the default api_url" do
+      MadMimi.api_url.should == 'http://api.madmimi.com'
+    end
+  end
+
+  describe ".audience" do
+    it "should be a MadMimi::Audience" do
+      MadMimi.audience.should be_a MadMimi::Audience
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../../lib/mad_mimi', __FILE__)
+
+require 'rspec'
+require 'webmock/rspec'
+include WebMock::API
+
+def a_post(path)
+  a_request(:post, MadMimi.api_url + path)
+end
+
+def stub_get(path)
+  path = path + '?' + parameterize(MadMimi.authentication)
+  stub_request(:get, MadMimi.api_url + path)
+end
+
+def stub_post(path)
+  stub_request(:post, MadMimi.api_url + path)
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+def parameterize(params)
+  URI.escape(params.collect{|k,v| "#{k}=#{v}"}.join('&'))
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification 
+name: mad_mimi
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Oz\xC3\xA9ias Sant'ana"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-23 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 5
+        - 4
+        version: 0.5.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: faraday_middleware
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 3
+        - 1
+        version: 0.3.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: multi_xml
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  type: :development
+  version_requirements: *id005
+description: 
+email: oz.santana@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- License.txt
+- Manifest
+- README.rdoc
+- Rakefile
+- lib/mad_mimi.rb
+- lib/mad_mimi/audience.rb
+- lib/mad_mimi/config.rb
+- lib/mad_mimi/request.rb
+- lib/mad_mimi/version.rb
+- mad_mimi.gemspec
+- spec/fixtures/audience_lists.xml
+- spec/fixtures/audience_members.xml
+- spec/mad_mimi/audience_spec.rb
+- spec/mad_mimi_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://railsbox.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 21
+      segments: 
+      - 1
+      - 3
+      - 7
+      version: 1.3.7
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Manage your MadMimi audience
+test_files: 
+- spec/fixtures/audience_lists.xml
+- spec/fixtures/audience_members.xml
+- spec/mad_mimi/audience_spec.rb
+- spec/mad_mimi_spec.rb
+- spec/spec_helper.rb