mc 0.0.4

data/lib/mc/commands/ecomm.rb

@@ -0,0 +1,37 @@
+desc 'Ecomm related actions'
+
+command :ecomm do |c|
+  c.desc 'Import Ecommerce Order Information to be used for Segmentation'
+  c.command :add do |s|
+    s.flag :order_id
+    s.flag :campaign_id
+    s.flag :email_id
+    s.flag :email
+    s.flag :total
+    s.flag :order_date
+    s.flag :shipping
+    s.flag :tax
+    s.flag :store_id
+    s.flag :stoe_name
+
+    s.action do |global,options,args|
+      order = {}
+      order[:id] = options[:order_id]
+      order[:email_id] = options[:email_id]
+      order[:email] = options[:email]
+      order[:total] = options[:total]
+      order[:order_date] = options[:order_date]
+      order[:shipping] = options[:shipping]
+      order[:tax] = options[:tax]
+      order[:store_id] = options[:store_id]
+      order[:store_name] = options[:store_name]
+      order[:items] = [{:product_id => 500, :product_name => "Freddie Doll", :category_id => 1, :category_name => "Toys"}]
+
+      if @mailchimp.ecomm_order_add :order => order
+        puts "Order added!"
+      else
+        puts "Order not added. :("
+      end
+    end
+  end
+end

data/lib/mc/commands/export.rb

@@ -0,0 +1,69 @@
+desc 'Export'
+command :export do |c|
+  # list ( string apikey, string id, string status array segment, string since )
+  c.desc 'Exports/dumps members of a list and all of their associated details.'
+  c.command :list do |s|
+    c.desc 'List ID'
+    c.flag :id
+
+    c.flag :status
+
+    c.desc "Use either 'any' or 'all'"
+    c.flag :match, :default_value => 'all'
+
+    c.desc 'Condition in the format field,op,value'
+    c.flag :condition
+
+    s.action do |global,options,args|
+      id = get_required_argument(:id, options[:id], global[:default_list])
+
+      if options[:condition]
+        segment = {}
+        segment['match'] = options[:match]
+        field, op, value = options[:condition].split(',')
+        segment['conditions'] = [{:field => field, :op => op, :value => value}]
+      end
+
+      status = options[:status]
+
+      # segment = {}
+      # segment["match"] = "all"
+      # segment["conditions"] = [{:field => 'aim', :op => 'open', :value => 'b55303410e'}]
+
+      @mailchimp.export_list(:id => id, :status => status, :segment => segment).each do |subscriber|
+        puts subscriber
+      end
+    end
+  end
+
+  # ecommOrders ( string since )
+  c.desc 'Dumps all Ecommerce Orders for an account'
+  c.command :ecommm do |s|
+    c.desc 'Ecomm orders since a specific date'
+    c.flag :since
+
+    s.action do |global,options,args|
+      @mailchimp.export_ecomm_orders.each do |order|
+        puts order
+      end
+    end
+  end
+
+  # campaignSubscriberActivity ( string apikey, string id, boolean include_empty, string since )
+  c.command :activity do |s|
+    c.desc 'Campaign ID'
+    c.flag :cid
+
+    c.desc 'Export all subscribers even if they have no activity'
+    c.switch :include_empty, :negatable => false
+
+    s.action do |global,options,args|
+      cid = options[:cid] || get_last_campaign_id
+
+      @mailchimp.export_campaign_subscriber_activity(:id => cid).each do |activity|
+        puts activity
+      end
+    end
+  end
+end
+

data/lib/mc/commands/gallery.rb

@@ -0,0 +1,11 @@
+desc 'Manage images and documents that are in your account'
+
+command :gallery do |c|
+  # list(string apikey, struct opts)
+  c.desc 'Return a section of the image gallery'
+  c.command :list do |s|
+    s.action do |global,options,args|
+      @output.standard @mailchimp_cached.gallery_list['data'], :fields => [{"full path" => {:display_method => :full, :width => 100}}]
+    end
+  end
+end

data/lib/mc/commands/helper.rb

@@ -0,0 +1,63 @@
+desc 'Basic admin funtions'
+command :helper do |c|
+  c.desc 'View API key currently configured'
+  c.command :apikey do |apikey|
+    apikey.action do |global,options,args|
+      puts global[:apikey]
+    end
+  end
+
+  # === Actual MailChimp API Calls below ===
+
+  # helper/account-details (string apikey, array exclude)
+  c.desc 'Retrieve lots of account information'
+  c.command :account do |s|
+    s.action do |global,options,args|
+      @output.as_hash @mailchimp_cached.helper_account_details
+    end
+  end
+
+  # helper/campaigns-for-email (string apikey, struct email, struct options)
+  c.desc 'Retrieve minimal data for all Campaigns a member was sent'
+  c.command 'campaigns-for-email' do |s|
+    s.action do |global,options,args|
+      emails = create_email_struct(required_argument("Need to provide an email address.", args))
+      @output.standard @mailchimp_cached.helper_campaigns_for_email(:email => emails.first), :fields => [:id, {:title => {:width => 50}}, :send_time]
+    end
+  end
+
+  # helper/chimp-chatter (string apikey)
+  c.desc 'See the current Chimp Chatter messages.'
+  c.command :chatter do |s|
+    s.action do |global,options,args|
+      # get rid of all the crap in the chatter msgs so they are useful
+      message = lambda{|m| m['message'].gsub(/ - Nice!.*few/, '').gsub(/ - Bummer.*:/, ':').gsub(/ - People.*:/, ':').gsub(/"/, '')}
+
+      @output.standard @mailchimp_cached.helper_chimp_chatter.reverse, :fields => [:update_time, {:message => {:width => 100, :display_method => message}}]
+    end
+  end
+
+  # helper/lists-for-email (string apikey, struct email)
+  c.desc 'Retrieve minimal List data for all lists a member is subscribed to.'
+  c.command 'lists-for-email' do |s|
+    s.action do |global,options,args|
+      emails = create_email_struct(required_argument("Need to provide an email address.", args))
+      @output.standard @mailchimp_cached.helper_lists_for_email :email => emails.first
+    end
+  end
+
+  c.desc 'Ping MailChimp to make sure all is okay.'
+  c.command :ping do |s|
+    s.action do |global,options,args|
+      puts @mailchimp.helper_ping['msg']
+    end
+  end
+
+  # helper/verified-domains (string apikey)
+  c.desc 'Retrieve all domain verification records for an account'
+  c.command :verified do |s|
+    s.action do |global,options,args|
+      @output.standard @mailchimp_cached.helper_verified_domains
+    end
+  end
+end

data/lib/mc/commands/lists.rb

@@ -0,0 +1,94 @@
+desc 'View information about lists and subscribers'
+arg_name 'Describe arguments to lists here'
+
+command :lists do |c|
+  c.desc 'List ID'
+  c.flag :id
+
+  c.desc 'Email Adress'
+  c.flag :email
+
+  c.desc 'Page number to start at'
+  c.flag :start, :default_value => 0
+
+  c.desc 'Retrieve all of the lists defined for your user account.'
+  c.command :list do |s|
+    s.action do |global,options,args|
+      stats_column = lambda{|l| "#{l['stats']['member_count']} / #{na(l['stats']['open_rate'])} / #{na(l['stats']['click_rate'])}"}
+      @output.standard @mailchimp_cached.lists_list['data'], :fields => [:id, :name, {"count / open % / click %" => stats_column}]
+    end
+  end
+
+  c.desc 'Access up to the previous 180 days of daily detailed aggregated activity stats for a given list.'
+  c.command :activity do |s|
+    s.action do |global,options,args|
+      id = required_argument(:id, options[:id], global[:list])
+      @output.standard @mailchimp_cached.lists_activity(:id => id)
+    end
+  end
+
+  c.desc "Retrieve the clients that the list's subscribers have been tagged as being used based on user agents seen."
+  c.command :clients do |s|
+    s.action do |global,options,args|
+      id = get_required_argument(:id, options[:id], global[:list])
+
+      results = @mailchimp_cached.lists_clients(:id => id)
+      if global[:output]
+        @output.as_hash results
+      else
+        percent = lambda{|i| i['percent'].round(2)}
+        puts "#{'='*14} DESKTOP #{'='*14}"
+        @output.standard results['desktop']['clients'], :fields => [:members, :client, {:percent => {:display_method => percent}}]
+        puts "\n#{'='*14} MOBILE #{'='*14}"
+        @output.standard results['mobile']['clients'], :fields => [:members, :client, {:percent => {:display_method => percent}}]
+      end
+    end
+  end
+
+  c.desc 'Get all of the merge variables for a list.'
+  c.command 'merge-vars' do |s|
+    s.action do |global,options,args|
+      id = get_required_argument(:id, options[:id], global[:list])
+      @output.standard @mailchimp_cached.lists_merge_vars(:id => [id])['data'].first['merge_vars']
+    end
+  end
+
+  c.desc 'Get all of the list members for a list that are of a particular status.'
+  c.command :members do |s|
+    s.flag :limit, :default_value => 25
+
+    s.action do |global,options,args|
+      id = get_required_argument(:id, options[:id], global[:list])
+      @output.standard @mailchimp_cached.lists_members(:id => id, :limit => limit)['data'], :fields => [:email, :member_rating, :status, :is_gmonkey]
+    end
+  end
+
+  c.desc 'Get information about one particular member.'
+  c.command 'member-info' do |s|
+    s.action do |global,options,args|
+      id = get_required_argument(:id, options[:id], global[:list])
+      emails = create_email_struct(required_argument("Need to provide one or more email addresses.", args))
+
+      @output.as_hash @mailchimp_cached.lists_member_info(:id => id, :emails => emails)
+    end
+  end
+
+  c.desc 'Retrieve the locations (countries) that the list\'s subscribers have been tagged to based on geocoding their IP address.'
+  c.command :locations do |s|
+    s.flag :num, :default_value => 25
+
+    s.action do |global,options,args|
+      id = get_required_argument(:id, options[:id], global[:list])
+      @output.standard @mailchimp_cached.lists_locations(:id => id)[0..options[:num].to_i]
+    end
+  end
+
+  c.desc 'Access the Growth History by Month for a given list.'
+  c.command :growth do |s|
+    s.action do |global,options,args|
+      id = get_required_argument(:id, options[:id], global[:list])
+      # @output.standard @mailchimp_cached.lists_growth_history(:id => id), :fields => [:month, :existing, :optins]
+      @output.standard @mailchimp_cached.lists_growth_history(:id => id)
+    end
+  end
+end

data/lib/mc/commands/reports.rb

@@ -0,0 +1,183 @@
+desc 'Reports'
+command :reports do |c|
+
+  # reports/abuse (string apikey, string cid, struct opts)
+  c.desc 'Get all email addresses that complained about a given campaign'
+  c.command :abuse do |s|
+    s.action do |global,options,args|
+      not_implemented
+    end
+  end
+
+  # reports/advice (string apikey, string cid)
+  c.desc 'Retrieve the text presented in our app for how a campaign performed and any advice we may have for you'
+  c.command :advice do |s|
+    s.action do |global,options,args|
+      cid = options[:cid] || get_last_campaign_id
+      #cid = @mailchimp.campaigns_list(:limit => 1, :sort_field => "send_time")["data"].first["id"]
+      @output.as_hash @mailchimp_cached.reports_advice :cid => cid
+    end
+  end
+
+  # reports/bounce-message (string apikey, string cid, struct email)
+  c.desc 'Retrieve the most recent full bounce message for a specific email address on the given campaign. Messages over 30 days old are subject to being removed'
+  c.command :bounce do |s|
+    s.action do |global,options,args|
+      not_implemented
+    end
+  end
+
+  # reports/bounce-messages (string apikey, string cid, struct opts)
+  c.desc 'Retrieve the full bounce messages for the given campaign. Note that this can return very large amounts of data depending on how large the campaign was and how much cruft the bounce provider returned. Also, messages over 30 days old are subject to being removed'
+  c.command :bounces do |s|
+    s.action do |global,options,args|
+      cid = options[:cid] || get_last_campaign_id
+
+      results = @mailchimp_cached.reports_bounce_messages(:cid => cid)
+      if global[:output]
+        @output.standard results
+      else
+        if results['total'].to_i > 0
+          puts "BOUNCE MSGS FOR LAST/SELECTED CAMPAIGN (#{results['total']})"
+          results['data'].each do |bounce|
+            puts "#{'='*50}".red
+            puts "Subscriber: #{bounce['member']['email']}"
+            puts "Date: #{bounce['date']}\n\n"
+            puts bounce['message'].green
+            puts "\n"
+          end
+        else
+          puts "No bounce messages for the last/selected campaign."
+        end
+      end
+    end
+  end
+
+  # reports/click-detail (string apikey, string cid, int tid, struct opts)
+  c.desc 'Return the list of email addresses that clicked on a given url, and how many times they clicked'
+  c.command :clicked do |s|
+    s.action do |global,options,args|
+      not_implemented
+    end
+  end
+
+  # reports/clicks (string apikey, string cid)
+  c.desc 'The urls tracked and their click counts for a given campaign.'
+  c.command :clicks do |s|
+    s.action do |global,options,args|
+      cid = options[:cid] || get_last_campaign_id
+      @output.standard @mailchimp_cached.reports_clicks(:cid => cid)['total'], :fields => [{:url => {:width => 80}}, :clicks, :unique]
+    end
+  end
+
+  # reports/domain-performance (string apikey, string cid)
+  c.desc 'Get the top 5 performing email domains for this campaign.'
+  c.command :domains do |s|
+    s.action do |global,options,args|
+      cid = options[:cid] || get_last_campaign_id
+      @output.standard @mailchimp_cached.reports_domain_performance :cid => cid
+    end
+  end
+
+  # reports/ecomm-orders (string apikey, string cid, struct opts)
+  c.desc 'Retrieve the Ecommerce Orders tracked by campaignEcommOrderAdd()'
+  c.command :ecomm do |s|
+    s.action do |global,options,args|
+      not_implemented
+    end
+  end
+
+  # reports/eepurl (string apikey, string cid)
+  c.desc 'Retrieve the eepurl stats from the web/Twitter mentions for this campaign'
+  c.command :eepurl do |s|
+    s.action do |global,options,args|
+      cid = options[:cid] || get_last_campaign_id
+      @output.standard @mailchimp_cached.reports_eepurl :cid => cid
+    end
+  end
+
+  # reports/geo-opens (string apikey, string cid)
+  c.desc 'Retrieve the countries/regions and number of opens tracked for each. Email address are not returned.'
+  c.command :geo do |s|
+    s.action do |global,options,args|
+      cid = options[:cid] || get_last_campaign_id
+      @output.standard @mailchimp_cached.reports_geo_opens :cid => cid
+    end
+  end
+
+  # reports/google-analytics (string apikey, string cid)
+  c.desc 'Retrieve the Google Analytics data we have collected for this campaign.'
+  c.command :ga do |s|
+    s.action do |global,options,args|
+      cid = options[:cid] || get_last_campaign_id
+      @output.standard @mailchimp_cached.reports_google_analytics :cid => cid
+    end
+  end
+
+  # reports/member-activity (string apikey, string cid, array emails)
+  c.desc 'Given a campaign and email address, return the entire click and open history with timestamps, ordered by time.'
+  c.command :member_activity do |s|
+    s.action do |global,options,args|
+      not_implemented
+    end
+  end
+
+  # reports/not-opened (string apikey, string cid, struct opts)
+  c.desc 'Retrieve the list of email addresses that did not open a given campaign'
+  c.command :not_opened do |s|
+    s.action do |global,options,args|
+      not_implemented
+    end
+  end
+
+  # reports/opened (string apikey, string cid, struct opts)
+  c.desc 'Retrieve the list of email addresses that opened a given campaign with how many times they opened'
+  c.command :opened do |s|
+    s.action do |global,options,args|
+      not_implemented
+    end
+  end
+
+  # reports/sent-to (string apikey, string cid, struct opts)
+  c.desc 'Get email addresses the campaign was sent to'
+  c.command :sent_to do |s|
+    s.action do |global,options,args|
+      not_implemented
+    end
+  end
+
+  # reports/share (string apikey, string cid, array opts)
+  c.desc 'Get the URL to a customized VIP Report for the specified campaign and optionally send an email to someone with links to it.'
+  c.command :share do |s|
+    s.action do |global,options,args|
+      cid = options[:cid] || get_last_campaign_id
+
+      results = @mailchimp_cached.reports_share(:cid => cid)
+      if global[:output]
+        @output.standard results
+      else
+        puts results['title']
+        puts "#{'='*results['title'].size}"
+        puts "URL: #{results['url']}"
+        puts "PASSWORD: #{results['password']}"
+        puts "SECURE URL: #{results['secure_url']}"
+      end
+    end
+  end
+
+  # reports/summary (string apikey, string cid)
+  c.desc 'Retrieve relevant aggregate campaign statistics (opens, bounces, clicks, etc.)'
+  c.command :summary do |s|
+    s.action do |global,options,args|
+      not_implemented
+    end
+  end
+
+  # reports/unsubscribes (string apikey, string cid, struct opts)
+  c.desc 'Get all unsubscribed email addresses for a given campaign'
+  c.command :unsubscribes do |s|
+    s.action do |global,options,args|
+      not_implemented
+    end
+  end
+end