hominid 2.0.1 → 2.0.2

data/lib/hominid/security.rb

@@ -0,0 +1,46 @@
+module Hominid
+  module Security
+    
+    # SECURITY RELATED METHODS
+    
+    def add_api_key(username, password)
+      # Add an API Key to your account. We will generate a new key for you and return it.
+      #
+      # Parameters:
+      # username (String) = Your Mailchimp account username.
+      # password (String) = Your Mailchimp account password.
+      #
+      # Returns:
+      # A new API Key that can be immediately used.
+      #
+      @chimpApi.call("apikeyAdd", username, password, @config[:api_key])
+    end
+    
+    def api_keys(username, password, expired = false)
+      # Retrieve a list of all MailChimp API Keys for this User.
+      #
+      # Parameters:
+      # username (String)   = Your Mailchimp account username.
+      # password (String)   = Your Mailchimp account password.
+      # expired  (Boolean)  = Whether or not to include expired keys, defaults to false.
+      #
+      # Returns:
+      # An array of API keys including:
+      #   apikey      (String) = The api key that can be used.
+      #   created_at  (String) = The date the key was created.
+      #   expired_at  (String) = The date the key was expired.
+      #
+      @chimpApi.call("apikeys", username, password, @config[:api_key], expired)
+    end
+    
+    def expire_api_key(username, password)
+      # Expire a Specific API Key.
+      #
+      # Returns:
+      # True if successful, error code if not.
+      #
+      @chimpApi.call("apikeyExpire", username, password, @config[:api_key])
+    end
+    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hominid
 version: !ruby/object:Gem::Version 
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors: 
 - Brian Getting
@@ -10,19 +10,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-11 00:00:00 -08:00
+date: 2009-12-17 00:00:00 -08:00
 default_executable: 
-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: 
+dependencies: []
+
 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: []
@@ -39,14 +30,12 @@ files:
 - Rakefile
 - VERSION
 - hominid.gemspec
-- hominid.yml.tpl
 - lib/hominid.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
+- lib/hominid/security.rb
 - test/hominid_test.rb
 - test/test_helper.rb
 has_rdoc: true

data/hominid.yml.tpl

@@ -1,25 +0,0 @@
-# Get your API key at http://admin.mailchimp.com/account/api/
-
-development:
-  username:
-  password: 
-  api_key: 
-  send_goodbye: false
-  send_notify: false
-  double_opt_in: false
-
-test:
-  username:
-  password:
-  api_key: 
-  send_goodbye: false
-  send_notify: false
-  double_opt_in: false
-
-production:
-  username:
-  password:
-  api_key: 
-  send_goodbye: false
-  send_notify: false
-  double_opt_in: false

data/lib/hominid/webhook.rb

@@ -1,131 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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
-