hominid 2.0.3 → 2.0.4

data/VERSION

@@ -1 +1 @@
-2.0.3
+2.0.4

data/hominid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hominid}
-  s.version = "2.0.3"
+  s.version = "2.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Getting", "Michael Str\303\274der"]
-  s.date = %q{2010-02-06}
+  s.date = %q{2010-02-17}
   s.description = %q{Hominid is a Ruby gem that provides a wrapper for interacting with the Mailchimp email marketing service API.}
   s.email = %q{brian@terra-firma-design.com}
   s.extra_rdoc_files = [

data/lib/hominid/base.rb

@@ -50,7 +50,7 @@ module Hominid
         raise APIError.new(error)
       end
     rescue RuntimeError => error
-      if error.message =~ /Wrong type NilClass\. Not allowed!/
+      if error.message =~ /Wrong type!/
         hashes = args.select{|a| a.is_a? Hash}
         errors = hashes.select{|k, v| v.nil? }.collect{ |k, v| "#{k} is Nil." }.join(' ')
         raise CommunicationError.new(errors)

data/lib/hominid/campaign.rb

@@ -164,9 +164,10 @@ module Hominid
     # Returns:
     # An array of abuse reports for this list in the format:
     #
-    def campaign_abuse_reports(campaign_id, start = 0, limit = 500, since = "2000-01-01 00:00:00") 
+    def abuse_reports(campaign_id, start = 0, limit = 500, since = "2000-01-01 00:00:00") 
       call("campaignAbuseReports", campaign_id, start, limit, since)
     end
+    alias :campaign_abuse_reports :abuse_reports
     
     # Retrieve the text presented in our app for how a campaign performed and any advice we may have for you - best
     # suited for display in customized reports pages. Note: some messages will contain HTML - clean tags as necessary.
@@ -182,6 +183,7 @@ module Hominid
     def advice(campaign_id)
       call("campaignAdvice", campaign_id)
     end
+    alias :campaign_advice :advice
     
     # Attach Ecommerce Order Information to a Campaign.
     #
@@ -212,7 +214,7 @@ module Hominid
       order = order.merge(:campaign_id => campaign_id)
       call("campaignEcommAddOrder", order)
     end
-    alias :ecomm_add_order :add_order
+    alias :campaign_ecomm_add_order :add_order
     
     # Retrieve the Google Analytics data we've collected for this campaign. Note, requires Google
     # Analytics Add-on to be installed and configured.
@@ -321,6 +323,18 @@ module Hominid
     end
     alias :delete_campaign :delete
     
+    # Retrieve the tracked eepurl mentions on Twitter
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    #
+    # Returns:
+    # An array of containing tweets and retweets that include this campaign's eepurl
+    def eep_url_stats(campaign_id)
+      call("campaignEepUrlStats", campaign_id)
+    end
+    alias :campaign_eep_url_stats :eep_url_stats
+    
     # Get the top 5 performing email domains for this campaign.
     #
     # Parameters:
@@ -385,6 +399,40 @@ module Hominid
     end
     alias :email_stats_aim_all :email_stats_all
     
+    # Retrieve the countries and number of opens tracked for each.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    #
+    # Returns:
+    # An array of countries where the campaign was opened:
+    # * code          (String)  = The ISO3166 2 digit country code.
+    # * name          (String)  = The country name (if available).
+    # * opens         (Integer) = The total number of opens that occurred in the country.
+    # * region_detail (Boolean) = Whether or not a subsequent call to campaignGeoOpensByCountry() will return anything
+    #
+    def geo_opens(campaign_id)
+      call("campaignGeoOpens", campaign_id)
+    end
+    alias :campaign_geo_opens :geo_opens
+    
+    # Retrieve the regions and number of opens tracked for a certain country. Email address are not returned.
+    #
+    # Parameters:
+    # * campaign_id (String) = The ID of the campaign.
+    # * code        (String) = An ISO3166 2 digit country code.
+    #
+    # Returns:
+    # An array of regions within the provided country where opens occurred:
+    # * code          (String)  = An internal code for the region. (can be blank)
+    # * name          (String)  = The name of the region (if available).
+    # * opens         (Integer) = The total number of opens that occurred in that region.
+    #
+    def geo_opens_for_country(campaign_id, code)
+      call("campaignGeoOpensForCountry", campaign_id, code)
+    end
+    alias :campaign_geo_opens_for_country :geo_opens_for_country
+    
     # Get all email addresses with Hard Bounces for a given campaign.
     #
     # Parameters:

data/lib/hominid/helper.rb

@@ -32,20 +32,15 @@ module Hominid
     def account_details
       hash_to_object(call("getAccountDetails"))
     end
-
-    # Send your HTML content to have the CSS inlined and optionally remove the original styles.
-    #
-    # Paramters:
-    # * html       (String)  = Your HTML content.
-    # * strip_css  (Boolean) = Whether you want the CSS <style> tags stripped from the returned document. Defaults to false.
+    
+    # Get the current Chimp Chatter messages for an account.
     #
     # Returns:
-    # Your HTML content with all CSS inlined, just like if we sent it. (String)
+    # The current Chimp Chatter for an account.
     #
-    def inline_css(html, strip_css = false)
-      call("inlineCss", html, strip_css)
+    def chatter
+      call("chimpChatter")
     end
-    alias :convert_css_to_inline :inline_css
     
     # Create a new folder to file campaigns in.
     #
@@ -54,10 +49,42 @@ module Hominid
     #
     # Returns:
     # The folder_id of the newly created folder. (Integer)
+    #
     def create_folder(name)
       call("createFolder", name)
     end
     
+    # Import Ecommerce Order Information to be used for Segmentation.
+    #
+    # Parameters:
+    # * order (Hash) = A hash of order information including:
+    #   * id          (String)  = The order id.
+    #   * email_id    (String)  = Email id of the subscriber. (mc_eid query string) (Required if no email)
+    #   * email       (String)  = Email id of the subscriber. (Required if no email_id)
+    #   * total       (Double)  = Show only campaigns with this from_name.
+    #   * order_date  (String)  = The date of the order. (optional)
+    #   * shipping    (String)  = The total paid for shipping fees. (optional)
+    #   * tax         (String)  = The total tax paid. (optional)
+    #   * store_id    (String)  = A unique id for the store sending the order in
+    #   * store_name  (String)  = A readable name for the store, typicaly the hostname. (optional)
+    #   * plugin_id   (String)  = The MailChimp-assigned Plugin Id. Using 1214 for the moment.
+    #   * campaign_id (String)  = The campaign ID for this order. (mc_cid query string) (optional)
+    #   * items       (Array)   = The individual line items for an order, using the following keys:
+    #   * line_num       (Integer) = The line number of the item on the order. (optional)
+    #   * product_id     (Integer) = Internal product id.
+    #   * product_name   (String)  = The name for the product_id associated with the item.
+    #   * category_id    (Integer) = Internal id for the (main) category associated with product.
+    #   * category_name  (String)  = The category name for the category id.
+    #   * qty            (Double)  = The quantity of items ordered.
+    #   * cost           (Double)  = The cost of a single item (Ex. Not the extended cost of the line).
+    #
+    # Returns:
+    # True if successful, error code if not.
+    #
+    def ecomm_add_order(order)
+      call("ecommAddOrder", order)
+    end
+    
     # Have HTML content auto-converted to a text-only format. You can send: plain HTML, an array of Template content,
     # an existing Campaign Id, or an existing Template Id. Note that this will not save anything to or update any of
     # your lists, campaigns, or templates.
@@ -73,6 +100,20 @@ module Hominid
       call("generateText", type, content)
     end
     
+    # Send your HTML content to have the CSS inlined and optionally remove the original styles.
+    #
+    # Parameters:
+    # * html       (String)  = Your HTML content.
+    # * strip_css  (Boolean) = Whether you want the CSS <style> tags stripped from the returned document. Defaults to false.
+    #
+    # Returns:
+    # Your HTML content with all CSS inlined, just like if we sent it. (String)
+    #
+    def inline_css(html, strip_css = false)
+      call("inlineCss", html, strip_css)
+    end
+    alias :convert_css_to_inline :inline_css
+    
     # "Ping" the MailChimp API - a simple method you can call that will return a constant value as long as everything
     # is good. Note than unlike most all of our methods, we don't throw an Exception if we are having issues. You will
     # simply receive a different string back that will explain our view on what is going on.
@@ -80,7 +121,7 @@ module Hominid
     # Returns:
     # "Everything's Chimpy!"
     #
-    def ping(options = {})
+    def ping()
       call("ping")
     end
     

data/lib/hominid/list.rb

@@ -30,6 +30,11 @@ module Hominid
     def find_list_id_by_web_id(list_web_id)
       call("lists").find {|list| list["web_id"] == list_web_id}["id"]
     end
+    
+    # Find all the mailing lists IDs that an email address is subscribed to
+    def find_list_ids_by_email(email)
+      call("listForEmail", email)
+    end
 
     # Get all email addresses that complained about a given list.
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hominid
 version: !ruby/object:Gem::Version 
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors: 
 - Brian Getting
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-06 00:00:00 -08:00
+date: 2010-02-17 00:00:00 -08:00
 default_executable: 
 dependencies: []