hominid 1.2.1 → 2.0.0

data/lib/hominid/webhook.rb

@@ -0,0 +1,131 @@
+module Hominid
+
+  class Webhook < Base
+    # Expects a hash of POST data generated from Mailchimp:
+    #
+    # "type": "unsubscribe", 
+    # "fired_at": "2009-03-26 21:54:00", 
+    # "data[email]": "sample@emailaddress.com"
+    #
+    # Simple Usage:
+    #
+    # h = Hominid::Webhook.new(params)
+    #
+    # Sample params from Mailchimp webhook:
+    # params => { "type" => "subscribe",
+    #             "fired_at" => "2009-03-26 21:35:57",
+    #             "data" => { "id" => "8a25ff1d98",
+    #                         "list_id" => "8a25ff1d98",
+    #                         "email" => "api@mailchimp.com",
+    #                         "email_type" => "html",
+    #                         "merges" => {"EMAIL" => "api@mailchimp.com",
+    #                                     "FNAME" => "Brian",
+    #                                     "LNAME" => "Getting",
+    #                                     "INTERESTS" => "Group1,Group2"},
+    #                         "ip_opt" => "10.20.10.30",
+    #                         "ip_signup" => "10.20.10.30" }}
+    #
+    # Returns an object with the following methods (NOTE: Not all methods are available
+    # for all event types. Refer to http://www.mailchimp.com/api/webhooks/ for information
+    # on what data will be available for each event):
+    # 
+    # h.event               <= (String)     The event that fired the request. Possible events are:
+    #                                       "subscribe", "unsubscribe", "profile", "upemail", "cleaned"
+    # h.fired_at            <= (Datetime)   When the webhook request was fired.
+    # h.id                  <= (String)     The ID of the webhook request.
+    # h.list_id             <= (String)     The ID of the list that generated the request.
+    # h.email               <= (String)     The email address of the subscriber that generated the request.
+    # h.email_type          <= (String)     The email type of the subscriber that generated the request.
+    # h.first_name          <= (String)     The first name of the subscriber (if available).
+    # h.last_name           <= (String)     The first name of the subscriber (if available).
+    # h.interests           <= (Array)      An array of the interest groups.
+    # h.ip_opt              <= (String)     The opt in IP address.
+    # h.ip_signup           <= (String)     The signup IP address.
+    #
+    
+    attr_reader :request
+    
+    def initialize(*args)
+      post_data = args.last
+      raise HominidError.new('Please provide the POST data from a Mailchimp webhook request.') unless post_data.is_a?(Hash)
+      post_data.merge!({"event" => "#{post_data.delete('type')}"})
+      @request = hash_to_object(post_data)
+    end
+    
+    
+    def email
+      self.request.data.email if self.request.data.email
+    end
+    
+    def email_type
+      self.request.data.email_type if self.request.data.email_type
+    end
+    
+    def event
+      self.request.event if self.request.event
+    end
+    
+    def fired_at
+      self.request.fired_at.to_datetime if self.request.fired_at
+    end
+    
+    def first_name
+      self.request.data.merges.fname if self.request.data.merges.fname
+    end
+    
+    def last_name
+      self.request.data.merges.lname if self.request.data.merges.lname
+    end
+    
+    def id
+      self.request.data.id if self.request.data.id
+    end
+    
+    def interests
+      self.request.data.merges.interests.split(',') if self.request.data.merges.interests
+    end
+    
+    def ip_opt
+      self.request.data.ip_opt if self.request.data.ip_opt
+    end
+    
+    def ip_signup
+      self.request.data.ip_signup if self.request.data.ip_signup
+    end
+    
+    def list_id
+      self.request.data.list_id if self.request.data.list_id
+    end
+    
+    def new_email
+      self.request.data.new_email if self.request.data.new_email
+    end
+    
+    def old_email
+      self.request.data.old_email if self.request.data.old_email
+    end
+    
+    def reason
+      self.request.data.reason if self.request.data.reason
+    end
+    
+    private
+
+    def hash_to_object(object)
+      return case object
+      when Hash
+        object = object.clone
+        object.each do |key, value|
+          object[key.downcase] = hash_to_object(value)
+        end
+        OpenStruct.new(object)
+      when Array
+        object = object.clone
+        object.map! { |i| hash_to_object(i) }
+      else
+        object
+      end
+    end
+
+  end
+end

data/tasks/rails/hominid.rake

@@ -0,0 +1,22 @@
+require 'rake'
+namespace :hominid do
+  # Task to create the config file
+  desc "Generate a Hominid config file"
+  task :config => :environment do |t|
+    require 'fileutils'
+    if defined?(Rails.root)
+      config_file = File.join(Rails.root, 'config', 'hominid.yml')
+      template_file = File.join(File.dirname(__FILE__), '..', '..', 'hominid.yml.tpl')
+      unless File.exists? config_file
+        FileUtils.cp(
+          File.join(File.dirname(__FILE__), '..', '..', 'hominid.yml.tpl'),
+          File.join(Rails.root, 'config', 'hominid.yml')
+        )
+        puts 'Please edit config/hominid.yml to your needs.'
+      else
+        puts 'We left your existing config/hominid.yml untouched.'
+      end
+    end
+  end
+end
+

data/test/hominid_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class HominidTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'hominid'
+
+class Test::Unit::TestCase
+end

metadata

@@ -1,43 +1,56 @@
 --- !ruby/object:Gem::Specification 
 name: hominid
 version: !ruby/object:Gem::Version 
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors: 
 - Brian Getting
+- "Michael Str\xC3\xBCder"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-10-13 00:00:00 -07:00
+date: 2009-10-30 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
-description: Use the hominid gem to easily integrate with the Mailchimp email marketing service API.
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Hominid is a Ruby gem that provides a wrapper for interacting with the Mailchimp email marketing service API.
 email: brian@terra-firma-design.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
+- LICENSE
 - README.textile
 files: 
-- MIT-LICENSE
+- .gitignore
+- LICENSE
 - README.textile
 - Rakefile
-- VERSION.yml
+- VERSION
 - hominid.gemspec
 - hominid.yml.tpl
-- init.rb
-- install.rb
 - lib/hominid.rb
-- pkg/hominid-1.2.1.gem
-- rails/init.rb
-- spec/hominid_spec.rb
-- spec/spec_helper.rb
-- uninstall.rb
+- lib/hominid/base.rb
+- lib/hominid/campaign.rb
+- lib/hominid/helper.rb
+- lib/hominid/list.rb
+- lib/hominid/webhook.rb
+- tasks/rails/hominid.rake
+- test/hominid_test.rb
+- test/test_helper.rb
 has_rdoc: true
-homepage: http://terra-firma-design.com
+homepage: http://github.com/bgetting/hominid
 licenses: []
 
 post_install_message: 
@@ -65,5 +78,5 @@ signing_key:
 specification_version: 3
 summary: Hominid is a Ruby gem for interacting with the Mailchimp API.
 test_files: 
-- spec/hominid_spec.rb
-- spec/spec_helper.rb
+- test/hominid_test.rb
+- test/test_helper.rb

data/VERSION.yml

@@ -1,4 +0,0 @@
---- 
-:major: 1
-:minor: 2
-:patch: 1

data/init.rb

@@ -1 +0,0 @@
-require File.dirname(__FILE__) + "/rails/init"

data/install.rb

@@ -1,4 +0,0 @@
-require 'fileutils'
-monkeyBrains = File.dirname(__FILE__) + '/../../../config/hominid.yml'
-FileUtils.cp File.dirname(__FILE__) + '/hominid.yml.tpl', monkeyBrains unless File.exist?(monkeyBrains)
-puts IO.read(File.join(File.dirname(__FILE__), 'README'))

data/rails/init.rb

@@ -1 +0,0 @@
-require 'hominid'

data/spec/hominid_spec.rb

@@ -1,29 +0,0 @@
-require 'spec/spec_helper'
-
-describe Hominid do
-  before do
-    api_key = ENV['MAIL_CHIMP_API_KEY']
-    raise "You must set the MAIL_CHIMP_API_KEY environment variable to test" if api_key.empty?
-    @hominid = Hominid.new(:api_key => api_key)
-    @list_id = ENV['MAIL_CHIMP_TEST_LIST_ID']
-    raise "You must set the MAIL_CHIMP_TEST_LIST_ID environment variable to test" if @list_id.empty?
-  end
-  
-  describe "#subscribe" do
-    context "when not supplying a double-opt-in argument" do
-      it "should not blow up" do
-        proc {
-          @hominid.subscribe(@list_id, Faker::Internet.email)
-        }.should_not raise_error
-      end
-    end
-  end
-
-  describe "#call" do
-    it "should raise HominidError on failure" do
-      proc {
-        Hominid.new.send(:call, 'bogusApi')
-      }.should raise_error(HominidError)
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,3 +0,0 @@
-require 'rubygems'
-require 'faker'
-require 'lib/hominid'

data/uninstall.rb

@@ -1 +0,0 @@
-# Uninstall hook code here