hominid 2.2.0 → 3.0.1

data/lib/hominid/security.rb

@@ -1,43 +1,19 @@
 module Hominid
   module Security
-    
-    # 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.
-    #
-    def add_api_key(username, password)
-      @chimpApi.call("apikeyAdd", username, password, @config[:api_key])
+
+    # Get a list of all API keys
+    def apikeys(username, password, expired = false)
+      @chimpApi.call("apikeys", username, password, @api_key, expired)
     end
     
-    # 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.
-    #
-    def api_keys(username, password, expired = false)
-      @chimpApi.call("apikeys", username, password, @config[:api_key], expired)
+    # Add an API key to your account
+    def apikey_add(username, password)
+      @chimpApi.call("apikeyAdd", username, password, @api_key)
     end
     
-    # Expire a Specific API Key.
-    #
-    # Returns:
-    # True if successful, error code if not.
-    #
-    def expire_api_key(username, password)
-      @chimpApi.call("apikeyExpire", username, password, @config[:api_key])
+    # Expire a specific API key
+    def apikey_expire(username, password, api_key)
+      @chimpApi.call("apikeyExpire", username, password, api_key)
     end
     
   end

data/test/{test_helper.rb → helper.rb}

@@ -1,4 +1,12 @@
 require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
 require 'test/unit'
 require 'shoulda'
 

data/test/test_hominid.rb

@@ -0,0 +1,29 @@
+require 'helper'
+
+class TestHominid < Test::Unit::TestCase
+  
+  VALID_API_KEY = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us1'
+  INVALID_API_KEY = 'not_a_valid_api_key'
+  
+  should "not raise an error if the API key is valid" do
+    assert_nothing_raised do
+      Hominid::API.new(VALID_API_KEY)
+    end
+  end
+  
+  should "raise an error if the API key is not provided" do
+    assert_raise(ArgumentError) do
+      Hominid::API.new()
+    end
+  end
+  
+  should "raise an error if the API key is malformed" do
+    assert_raise(ArgumentError) do
+      Hominid::API.new(INVALID_API_KEY)
+    end
+  end
+  
+  # TODO: Tests that mock API calls so that it is not hitting the actual
+  #       Mailchimp API during testing.
+  
+end

metadata

@@ -1,68 +1,97 @@
 --- !ruby/object:Gem::Specification 
 name: hominid
 version: !ruby/object:Gem::Version 
-  hash: 7
   prerelease: false
   segments: 
-  - 2
-  - 2
+  - 3
   - 0
-  version: 2.2.0
+  - 1
+  version: 3.0.1
 platform: ruby
 authors: 
 - Brian Getting
-- "Michael Str\xC3\xBCder"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-09-28 00:00:00 -07:00
+date: 2010-12-20 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: json
-  prerelease: false
+  name: bundler
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
         segments: 
         - 1
-        - 2
         - 0
-        version: 1.2.0
-  type: :runtime
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
   type: :development
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: shoulda
-  prerelease: false
+  name: mocha
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
-        version: "0"
+        - 9
+        - 10
+        version: 0.9.10
   type: :development
+  prerelease: false
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 9
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 11
+        - 3
+        version: 2.11.3
+  type: :development
+  prerelease: false
+  version_requirements: *id005
 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: []
@@ -70,30 +99,29 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
+- LICENSE.txt
 - README.rdoc
 files: 
-- .gitignore
-- LICENSE
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
 - hominid.gemspec
 - lib/hominid.rb
-- lib/hominid/base.rb
 - lib/hominid/campaign.rb
-- lib/hominid/helper.rb
 - lib/hominid/list.rb
 - lib/hominid/security.rb
-- test/hominid_test.rb
-- test/test_helper.rb
+- test/helper.rb
+- test/test_hominid.rb
 has_rdoc: true
 homepage: http://github.com/bgetting/hominid
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -101,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: -1643748069951244742
       segments: 
       - 0
       version: "0"
@@ -110,7 +138,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -120,7 +147,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Hominid is a Ruby gem for interacting with the Mailchimp API.
+summary: Hominid is a Ruby wrapper for the Mailchimp API
 test_files: 
-- test/hominid_test.rb
-- test/test_helper.rb
+- test/helper.rb
+- test/test_hominid.rb

data/.gitignore

@@ -1,5 +0,0 @@
-.DS_Store
-pkg/*
-pkg/*.*
-.svn
-rdoc

data/lib/hominid/base.rb

@@ -1,122 +0,0 @@
-module Hominid
-  class Base
-    include Hominid::Campaign
-    include Hominid::Helper
-    include Hominid::List
-    include Hominid::Security
-
-    # MailChimp API Documentation: http://www.mailchimp.com/api/1.2/
-    MAILCHIMP_API_VERSION = "1.2"
-    MAILCHIMP_EXPORT_API_VERSION = "1.0"
-    MAILCHIMP_EXPORT_PATH = "/export/#{MAILCHIMP_EXPORT_API_VERSION}/list/"
-
-    def initialize(config = {})
-      raise StandardError.new('Please provide your Mailchimp API key.') unless config[:api_key]
-      raise ArgumentError.new('Your Mailchimp API key is malformatted.') unless config[:api_key].include?('-')
-      dc = config[:api_key].split('-').last
-      defaults = {
-        :double_opt_in      => false,
-        :merge_tags         => {},
-        :replace_interests  => true,
-        :secure             => false,
-        :send_goodbye       => false,
-        :send_notify        => false,
-        :send_welcome       => false,
-        :timeout            => nil,
-        :update_existing    => true
-      }
-      @config = defaults.merge(config).freeze
-      if config[:secure]
-        @chimpApi = XMLRPC::Client.new2("https://#{dc}.api.mailchimp.com/#{MAILCHIMP_API_VERSION}/", nil, config[:timeout])
-        @exportApi = Net::HTTP.new("#{dc}.api.mailchimp.com", 443)
-      else
-        @chimpApi = XMLRPC::Client.new2("http://#{dc}.api.mailchimp.com/#{MAILCHIMP_API_VERSION}/", nil, config[:timeout])
-        @exportApi = Net::HTTP.new("#{dc}.api.mailchimp.com", 80)
-      end
-    end
-
-    def apply_defaults_to(options) # :nodoc:
-      @config.merge(options)
-    end
-
-    def call(method, *args) # :nodoc:
-      @chimpApi.call(method, @config[:api_key], *args)
-    rescue XMLRPC::FaultException => error
-      # Handle common cases for which the Mailchimp API would raise Exceptions
-      case error.faultCode
-      when 100..199
-        raise UserError.new(error)
-      when 200..299
-        raise ListError.new(error)
-      when 300..399
-        raise CampaignError.new(error)
-      when 500..599
-        raise ValidationError.new(error)
-      else
-        raise APIError.new(error)
-      end
-    rescue RuntimeError => error
-      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)
-      else
-        raise error
-      end
-    rescue Exception => error
-      raise CommunicationError.new(error.message)
-    end
-
-    def call_export(list_id, status)
-      uri = "#{MAILCHIMP_EXPORT_PATH}?apikey=#{@config[:api_key]}&id=#{list_id}"
-
-      !status.nil? && uri += "&status=#{status}"
-
-      # Don't parse the whole thing since there could be thousands of records
-      out, keys = [], []
-      body = @exportApi.request_get(uri).body
-      lines = body.send(body.respond_to?(:lines) ? :lines : :to_s).to_a
-
-      lines.each_with_index do |l, i|
-        if i == 0
-          keys = JSON.parse(l).map { |k| k.gsub(" ", "_") }
-        else
-          # Magic! http://snippets.dzone.com/posts/show/302
-          out << Hash[*keys.zip(JSON.parse(l)).flatten]
-        end
-      end
-      out
-    rescue Exception => error
-      raise CommunicationError.new(error.message)
-    end
-
-    def clean_merge_tags(merge_tags) # :nodoc:
-      return {} unless merge_tags.is_a? Hash
-      merge_tags.each do |key, value|
-        if merge_tags[key].is_a? String
-          merge_tags[key] = value.gsub("\v", '')
-        elsif merge_tags[key].nil?
-          merge_tags[key] = ''
-        end
-      end
-    end
-
-    def hash_to_object(object) # :nodoc:
-      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/lib/hominid/helper.rb

@@ -1,129 +0,0 @@
-module Hominid
-  module Helper
-    
-    # Retrieve lots of account information including payments made, plan info,
-    # some account stats, installed modules, contact info, and more. No private
-    # information like Credit Card numbers is available.
-    #
-    # Parameters:
-    # * none 
-    #
-    # Returns:
-    # An array of account details for this API key including:
-    # * username        (String)    = The Account username.
-    # * user_id         (String)    = The Account user unique id (for building some links).
-    # * is_trial        (Boolean)   = Whether the Account is in Trial mode.
-    # * timezone        (String)    = The timezone for the Account.
-    # * plan_type       (String)    = Plan Type - "monthly", "payasyougo", or "free".
-    # * plan_low        (Integer)   = Only for Monthly plans - the lower tier for list size.
-    # * plan_high       (Integer)   = Only for Monthly plans - the upper tier for list size.
-    # * plan_start_date (DateTime)  = Only for Monthly plans - the start date for a monthly plan.
-    # * emails_left     (Integer)   = Only for Free and Pay-as-you-go plans emails credits left for the account.
-    # * pending_monthly (Boolean)   = Whether the account is finishing Pay As You Go credits before switching to a Monthly plan.
-    # * first_payment   (DateTime)  = Date of first payment.
-    # * last_payment    (DateTime)  = Date of most recent payment.
-    # * times_logged_in (Integer)   = Total number of times the account has been logged into via the web.
-    # * last_login      (DateTime)  = Date/time of last login via the web.
-    # * affiliate_link  (String)    = Monkey Rewards link for our Affiliate program.
-    # * contact         (Array)     = Contact details for the account, including: First & Last name, email, company name, address, phone, and url.
-    # * addons          (Array)     = Addons installed in the account and the date they were installed.
-    # * orders          (Array)     = Order details for the account, include order_id, type, cost, date/time, and any credits applied to the order.
-    #
-    def account_details
-      hash_to_object(call("getAccountDetails"))
-    end
-    
-    # Get the current Chimp Chatter messages for an account.
-    #
-    # Returns:
-    # The current Chimp Chatter for an account.
-    #
-    def chatter
-      call("chimpChatter")
-    end
-    
-    # Create a new folder to file campaigns in.
-    #
-    # Parameters:
-    # * name (String) = A unique name for a folder.
-    #
-    # 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.
-    #
-    # Parameters:
-    # * type    (String) = Must be one of: "html", "template", "url", "cid", or "tid".
-    # * content (String) = The content to use. For "html" expects a single string value, "template" expects an array like you send to campaignCreate, "url" expects a valid & public URL to pull from, "cid" expects a valid Campaign Id, and "tid" expects a valid Template Id on your account.
-    #
-    # Returns:
-    # The content passed in converted to text. (String)
-    #
-    def generate_text(type, content)
-      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.
-    #
-    # Returns:
-    # "Everything's Chimpy!"
-    #
-    def ping()
-      call("ping")
-    end
-    
-  end
-end