mc 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bd1c554cd8c091423285cbf144266f33c0a7de0
+  data.tar.gz: 0286850e7e743ad88f8110826db32c6afc409e2d
+SHA512:
+  metadata.gz: 67d67a25c42f884348459c71137266625e8391d1ccec6c1a8e20fb94c3e198850cf225b1ba5d8ed00f616e970806ce36d36b2260655b5c825fce00a3a5b9ba5f
+  data.tar.gz: 61e68457d561413a6d54d73569840c17908ba7993ef02d46c814a3b0e9e431f3825c7b3797a2e5ca889e398f6746eb164ebf67157b2d0d852c9635be7d36527b

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+results.html
+/tmp

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'gli', '>= 2.8'
+gem 'gibbon', '1.0.4'
+gem 'filecache'
+gem 'json'
+
+gem 'awesome_print'
+gem 'table_print'
+gem 'colorize'
+
+gem 'webmock'

data/README.md

@@ -0,0 +1,90 @@
+# mc - MailChimp from the command-line
+With your MailChimp [api key](http://admin.mailchimp.com/account/api) and this gem, you can access a lot of the functionality that you can do through the MailChimp web interface, but all from the command-line. It uses a command/sub-command approach that allows you to quickly find the command you need.
+
+Caching is setup so that you can run the command multiple times without worrying about hitting the MailChimp servers. Caching is based on the api call + parameters used and expires in 24 hours. You can fetch new values by using the --skipcache global option.
+
+## Install
+```sh
+    gem install mc
+```
+
+## Usage
+To see all the commands you can run:
+```
+    mc --help
+```
+or just:
+
+```
+    mc
+```
+
+
+You should see something similar to:
+
+    NAME
+      mc - Command line interface to MailChimp. Eep eep!
+
+    SYNOPSIS
+      mc [global options] command [command options] [arguments...]
+
+    GLOBAL OPTIONS
+      --apikey=apikey     - MailChimp API Key (default: none)
+      --debug             - Turn on debugging
+      --help              - Show this message
+      --list=listID       - List to use (default: none)
+      --output, -o format - formatted, raw, or awesome (default: none)
+      --skipcache         - Do not use cached result
+      --version           - Display the program version
+
+    COMMANDS
+      campaigns  - Campaign related tasks
+      ecomm      - Ecomm related actions
+      export     - Export
+      gallery    - Manage images and documents that are in your account
+      help       - Shows a list of commands or help for one command
+      helper     - Basic admin funtions
+      initconfig - Initialize the config file using current global options
+      lists      - View information about lists and subscribers
+      reports    - Reports
+      search     - Search campaigns and members
+      templates  - Manage templates within your account
+      users      - Users
+      vip        - VIPs
+
+
+You can get details on specific subcommands by:
+
+```
+    mc help list
+```
+
+## With Great Power
+With this tool you'll be able to access your account in ways that will bypass confirmations and limits that you'll find within the regular MailChimp web application. So for example, you can unsubscribe users and send campaigns without any conformation using the correct command and parameters. Caching, as mentioned above, is setup to avoid hitting your account too much, but care still needs to be taken. Lastly, before using this tool it is highly recommended that you read the [MailChimp API faq](http://apidocs.mailchimp.com/api/faq/) and especially note the 'best practices' listed within it.
+
+
+## Config File
+To create a config file at ~/.mailchimp you can run:
+
+	mc initconfig
+
+You can then edit that file and include any defaults you want to set. I would highly recommend at a minimal including the api key and a default list:
+
+	:apikey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-usx
+	:default_list: xxxxxxxxxx
+
+> Note: once you get your api key you can get the list id by running 'mc list lists'.
+
+## Todo
+* Finish supporting all api calls
+* Command-line tab auto-completion
+* Better descriptions and help
+* Complete testing coverage
+
+## License
+See license.txt file.
+
+## Thanks
+ * Amro for the easy to use [gibbon](https://github.com/amro/gibbon) gem
+ * David Copeland's [gli](https://github.com/davetron5000/gli) command-line gem
+ * And of course MailChimp and their sweet API

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('mc.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => [:test,:features]

data/bin/mc

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'mc'
+
+run(ARGV)

data/features/mc.feature

@@ -0,0 +1,28 @@
+Feature: The mc app has a useful user interface
+  As a user of the mc application
+  It should have a nice UI, since it's GLI-powered
+
+  Scenario: App just runs
+    When I get help for "mc"
+    Then the exit status should be 0
+
+  Scenario: Shows default global options
+    When I run `mc`
+    Then the output should contain "--apikey=apikey"
+
+  Scenario: Shows that api key is required if not supplied
+    When I run `mc helper ping` without a key or config file
+    Then the output should contain "Must include MailChimp API key either via --apikey flag or config file."
+
+  Scenario: Shows subcommand help
+    When I run `mc helper`
+    Then the output should contain "Command 'helper' requires a subcommand"
+
+  Scenario: Shows a successful ping
+    When I run `mc helper ping`
+    Then the output should contain "Everything's Chimpy!"   
+
+  Scenario: Shows apikey
+    When I run `mc helper apikey`
+    Then the output should match /\w{32}-us\d.*/
+    Then the exit status should be 0

data/features/step_definitions/mc_steps.rb

@@ -0,0 +1,14 @@
+When /^I get help for "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+  step %(I run `#{app_name} help`)
+end
+
+When /^I run `(.*)` without a key or config file$/ do |app_name|
+  @app_name = app_name
+  config_file_name = ENV['HOME']+ '/.mailchimp'
+  temp_file_name   = config_file_name + '-temp'
+
+  File.rename(config_file_name, temp_file_name)
+  step %(I run `#{app_name}`)
+  File.rename(temp_file_name, config_file_name)
+end

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'aruba/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/lib/mc.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'gli'
+require 'colorize'
+
+require 'mc/version'
+require 'mc/helper'
+require 'mc/commands'
+require 'mc/mailchimp'
+require 'mc/mailchimp_cached'
+require 'mc/report'
+require 'mc/writer'

data/lib/mc/commands.rb

@@ -0,0 +1,62 @@
+include GLI::App
+include Helper
+
+program_desc 'Command line interface to MailChimp. Eep eep!'
+
+version MC::VERSION
+
+config_file '.mailchimp'
+
+desc 'Turn on debugging'
+switch [:debug], :negatable => false
+
+desc 'Do not use cached result'
+switch [:skipcache], :negatable => false
+
+desc 'MailChimp API Key'
+arg_name 'apikey'
+flag [:apikey]
+
+desc 'List to use'
+arg_name 'listID'
+flag [:list]
+
+desc 'formatted, raw, or awesome'
+arg_name 'format'
+flag [:output,:o]
+
+commands_from "mc/commands"
+
+pre do |global,command,options,args|
+  # quit if no api
+  raise "Must include MailChimp API key either via --apikey flag or config file." if global[:apikey].nil?
+
+  # setup mailchimp api
+  @mailchimp = MailChimp.new(global[:apikey], {:debug => global[:debug]})
+  @mailchimp_cached = MailChimpCached.new(global[:apikey], {:debug => global[:debug], :skip_cache => global[:skipcache]})
+
+  # create cli writer
+  @output = ConsoleWriter.new(global)
+
+  # setup debug
+  @debug = true if global[:debug]
+
+  true
+end
+
+post do |global,command,options,args|
+  # put a space after each call
+  puts "\n"
+end
+
+on_error do |exception|
+  puts exception.message
+
+  if @debug then
+    puts "\n"+"-"*20+"[ Backtrace: ]"+"-"*20
+    exception.backtrace.each do |b|
+      puts b
+    end
+  end
+  false
+end

data/lib/mc/commands/campaigns.rb

@@ -0,0 +1,207 @@
+desc 'Campaign related tasks'
+command :campaigns do |c|
+
+  c.desc 'Create Campaign'
+  c.command :create do |s|
+    #TODO: support absplit, rss, auto campaign types
+    s.desc 'Type of campaign to create: regular, plaintext'
+    s.flag :type, :default_value => 'regular'
+
+    s.desc 'List ID'
+    s.flag [:id]
+
+    s.desc 'Subject'
+    s.flag [:subject]
+
+    s.desc 'From email'
+    s.flag ['from-email']
+
+    s.desc 'From name'
+    s.flag ['from-name']
+
+    s.desc 'To name'
+    s.flag ['to-name']
+
+    s.desc 'Template ID'
+    s.flag 'template-id'
+
+    s.desc 'Gallery template ID'
+    s.flag ['gallery-template-id']
+
+    s.desc 'Base template ID'
+    s.flag ['base-template-id']
+
+    s.desc 'Folder ID'
+    s.flag ['folder-id']
+
+    #s.desc 'Tracking'
+    #s.flag [:tracking]
+
+    s.desc 'Title - internal name to use'
+    s.flag [:title]
+
+    s.desc 'authenticate'
+    s.switch :authenticate, :negatable => true
+
+    #s.desc 'Analytics'
+    #s.flag [:analytics]
+
+    s.desc 'Auto footer?'
+    s.switch 'auto-footer'
+
+    s.desc 'Enable inline css?'
+    s.switch 'inline-css', :negatable => false
+
+    s.desc 'Auto tweet?'
+    s.switch :tweet, :negatable => false
+
+    #s.desc 'Auto FB post'
+    #s.flag 'auto-fb-post'
+
+    s.desc 'FB comments?'
+    s.switch 'fb-comments', :negatable => false
+
+    s.desc 'Enable timewarp'
+    s.switch :timewarp, :negatable => false
+
+    s.desc 'HTML filename to load'
+    s.flag 'html-filename'
+
+    s.desc 'TXT filename to load'
+    s.flag 'text-filename'
+
+    s.desc 'segmentation options [NAME,VALUE]'
+    s.flag 'seg-options'
+
+    s.action do |global,options,args|
+      if options[:seg_options]
+        field, value = options[:seg_options].split(",") if options[:seg_options]
+        segment_conditions = [{:field => field, :op => "like", :value => value}]
+      end
+
+      type = options[:type]
+
+      standard_opts = {
+        :list_id => options[:id],
+        :subject => required_option(:subject, options[:subject]),
+        :from_email => required_option('from-email', options['from-email']),
+        :from_name => required_option('from-name', options['from-name']),
+        :to_name => options['to-name'],
+        :template_id => options['template-id'],
+        :gallery_template_id => options['gallery-template-id'],
+        :base_template_id => options['base-template-id'],
+        :folder => options['folder-id'],
+        :inline_css => true,
+        :tracking => {:opens => true, :html_clicks => true, :text_clicks => false},
+        :title => options['title'],
+        :authenticate => options[:authenticate],
+        #:analytics
+        :auto_footer => options['auto-footer'],
+        :inline_css => options['inline-css'],
+        :generate_text => options['generate-text'],
+        :auto_tweet => options['auto-tweet'],
+        :auto_fb_post => options['auto-fb-posts'],
+        :fb_comments => options['fb-comments'],
+        :timewarp => options[:timewarp],
+        :ecomm360 => options[:ecomm360]
+        #:crm_tracking
+      }
+
+      html = File.open(options['html-filename']).read if options['html-filename']
+      text = File.open(options['text-filename']).read if options['text-filename']
+      content = {
+        :html => html,
+        :text => text
+      }
+
+      segment_opts = {:match => "all", :conditions => segment_conditions} unless segment_conditions.nil?
+      type_opts = {}
+
+      campaign = @mailchimp.campaigns_create(:type => type, :options => standard_opts, :content => content, :segment_opts => segment_opts, :type_opts => type_opts)
+      puts "Created new campaign with id = #{campaign['id']}"
+    end
+  end
+
+  c.desc 'Send Campaign Now'
+  c.command :send do |s|
+    s.action do |global,options,args|
+      campaign_id = required_argument("Need to supply a campaign id", args.first)
+      puts @mailchimp.campaigns_send :cid => campaign_id
+    end
+  end
+
+  c.desc 'Schedule Campaign'
+  c.command :schedule do |s|
+    s.desc 'Date to schedule campaign in YYYY-MM-DD format'
+    s.flag :date, :default_value => (Time.now + 86400).strftime("%Y-%m-%d")
+
+    s.desc 'Time to schedule campaign at in HH:MM:SS format'
+    s.flag :time, :default_value => '08:00:00'
+
+    s.action do |global,options,args|
+      campaign_id = options[:cid]
+      puts @mailchimp.campaigns_schedule(:cid => campaign_id, :schedule_time => options[:date] + ' ' + options[:time])
+    end
+  end
+
+  c.desc 'Send Test Campaign'
+  c.command :sendtest do |s|
+    s.action do |global,options,args|
+      campaign_id = required_argument("Need to supply a campaign id", args.first)
+
+      puts "Sending test for campaign #{campaign_id}..."
+      puts @mailchimp.campaign_send_test(:cid=> campaign_id, :test_emails => ["kale.davis@gmail.com", "kale@simplerise.com"])
+    end
+  end
+
+  c.desc 'Delete Campaign'
+  c.command :delete do |s|
+    s.action do |global,options,args|
+      campaign_id = options[:cid] || @mailchimp.cache.get(:campaign_id)
+      throw "Need a valid Campaign ID." if campaign_id.nil?
+
+      campaign_delete(:cid=> campaign_id)
+      puts "Deleted campaign #{campaign_id}."
+    end
+  end
+
+  c.desc 'Get the list of campaigns and their details matching the specified filters'
+  c.command :list do |s|
+    s.switch :first
+    s.flag :start, :default_value => 0
+    s.flag :limit, :default_value => 50
+    s.flag :sort_field, :default_value => 'create_time'
+    s.flag :sort_dir, :default_value => 'DESC'
+    s.action do |global,options,args|
+      @output.standard @mailchimp.campaigns_list(:limit => options[:limit])['data'], :fields => [:id, :title, :status, :send_time, :emails_sent, :archive_url]
+    end
+  end
+
+  c.desc 'Check to see if campaign is ready to send'
+  c.command :ready do |s|
+    s.action do |global,options,args|
+      cid = options[:cid] || get_last_campaign_id
+
+      puts cid
+      @output.standard @mailchimp_cached.campaigns_ready(:cid=> cid)
+    end
+  end
+
+  c.command "segment-test" do |s|
+    s.desc "Use either 'any' or 'all'"
+    s.flag :match, :default_value => 'all'
+
+    s.desc 'Condition in the format field,op,value'
+    s.flag :condition
+    s.action do |global,options,args|
+      id = get_required_argument(:id, options[:id], global[:default_list])
+
+      segment = {}
+      segment['match'] = options[:match]
+      field, op, value = options[:condition].split(',')
+      segment['conditions'] = [{:field => field, :op => op, :value => value}]
+
+      puts @mailchimp.campaigns_segment_test(:list_id => id, :options => segment)
+    end
+  end
+end