chimpactions 0.0.0 → 0.0.4

data/Gemfile

@@ -1,4 +1,16 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in chimpactions.gemspec
-gemspec
+gem "rails", "3.0.7"
+gem "capybara", ">= 0.4.0"
+gem "sqlite3"
+gem "gibbon", ">= 0.1.5"
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'
+
+group :test do
+gem "factory_girl"
+gem "shoulda"
+gem 'simplecov'
+gem 'mocha'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Peter Bonnell / CIRCUIT LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,134 @@
+h1. Chimpactions
+
+Easily move contacts between MailChimp lists in your Rails 3 application.
+
+h2. Requirements
+
+A MailChimp account and "API key":http://admin.mailchimp.com/account/api.
+
+h2. Installation
+
+h3. Base
+
+# *_Gemfile_* -> <code>gem "chimpactions", "~> 0.0.1"</code>
+# <code>rails generate chimpactions:install</code>
+# _Edit config/chimpactions.yml_ with your information.
+# add <code>include Chimpactions::Subscriber</code> to your model.
+# add <code>after_save :chimpactions </code> (if that's what you want) to your model.
+
+The YourModel.chimpactions method fires the actions to move subscribers as specified.
+
+Generates: 
+* config/chimpactions.yml config file
+
+h3. ActiveRecord store
+
+<code>rails generate chimpactions:migration </code>
+
+<code> rake db:migrate </code>
+
+Generates:
+* chimpactions ActiveRecord migration
+
+h3. Customizing Admin
+
+Chimpactions provides a basic scaffold for managing ActiveRecord Actions @ http:yourapp/chimpactions.
+To override the gem views :
+
+<code>rails generate chimpactions:customize </code>
+
+Generates: 
+
+* chimpactions view files for administrative interface
+* yourapp/app/views/chimpactions
+
+h2. Configuration
+
+_See installed config/chimpactions.yml for configuration options_
+
+h2. Usage
+
+h3. What's available
+
+Once defined (in chimpactions.yml) the local Rails model inherits the following methods from the Chimpactions gem :
+* add_to(List)
+* move_to(List)
+* remove_from(List)
+
+h3. A Chimpaction :
+
+*WHENN (A model method/attribute) IS (<,>,=) VALUE, ACTION (Chimpactions method) LIST (One of your MailChimp Lists)*
+
+ex.
+
+ 'When a user has more than 50 posts, move them to the Power Poster list'
+
+*_in chimpactions.yml_*
+<pre><code>  action:
+    -
+    action: :move_to,
+    list: Power Posters,
+    whenn: posts.count,
+    is: >,
+    value: 50
+    -
+</code></pre>
+
+*_for ActiveRecord store_* 
+ The admin interface should be a straightforward representation. 
+
+h3. Administrative Interface
+
+Direct your browser to http://yourapp.chimpactions for a simple CRUD to build and manage Actions.
+Available values are set in the forms where applicable, validations will tell you if a value won't work.
+
+h3. Manual access
+
+You can move subscribers around arbitrarily as well:
+
+<pre><code>user = User.find(123)
+user.remove_from("Power Posters") 
+</code></pre>
+
+h3. Chimpactions Module
+
+All your lists with a ton of info: 
+<pre><code>@lists = Chimpactions.available_lists
+...view
+<%= var_dump(@lists) ->
+</code></pre>
+
+Calling the MailChimp API directly: 
+
+Direct access to the "gibbon":http://rubygems.org/gems/gibbon/ socket :
+<pre><code>api_result = Chimpactions.socket.campaigns({:start => 0, :limit => 100})
+</code></pre>
+
+
+h3. Webhooks
+
+To register your application with your MailChimp List direct your browser to : http://yourapp/chimpactions/webhooks
+
+The links next to each list will add/delete the webhook http://yourapp/chimpactions/receive to that list.
+
+You must handle the post itself in <pre><code> receive_webhook(mc_post_data) </code> </pre> in your mix-in model for it have an effect.
+
+
+h2. TODO
+
+* implement VCR for tests so we don't have to use a real API key
+* get loading don't so we don't have to add <code>include Chimpactions::Subscriber</code> in the model
+
+h2. License
+
+This project released under the MIT-LICENSE.
+
+h2. Thanks
+
+p. Made possible by the generous support of the "MailChimp Integration Fund":http://www.mailchimp.com/about/integration-fund/ .
+
+h2. Copyrights
+
+(c) circuitllc & "imgenius":http://imgeni.us 2011 - Released under the MIT license.
+
+

data/Rakefile

@@ -1,2 +1,46 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+Rake::TestTask.new(:units) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/unit/*_test.rb'
+  t.verbose = false
+end
+
+Rake::TestTask.new(:functionals) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/integration/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Chimpactions'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/controllers/chimpactions_controller.rb

@@ -0,0 +1,123 @@
+class ChimpactionsController < ApplicationController
+  def index
+    @all_actions  = Chimpactions.actions
+    @registered  = Chimpactions.registered_class_name
+    @actions = Chimpaction.all
+    @lists = Chimpactions.available_lists
+  end
+  
+  # GET /chimpactions/new
+  # GET /chimpactions/new.xml
+  def new
+    @chimpaction = Chimpaction.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @chimpaction }
+    end
+  end
+
+  # GET /chimpactions/1/edit
+  def edit
+    @chimpaction = Chimpaction.find(params[:id])
+  end
+
+  # POST /chimpactions
+  # POST /chimpactions.xml
+  def create
+    @chimpaction = Chimpaction.new(params[:chimpaction])
+
+    respond_to do |format|
+      if @chimpaction.save
+        format.html { redirect_to(chimpactions_url, :notice => 'Chimpaction was successfully created.') }
+        format.xml  { render :xml => @chimpaction, :status => :created, :location => @chimpaction }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @chimpaction.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /chimpactions/1
+  # PUT /chimpactions/1.xml
+  def update
+    @chimpaction = Chimpaction.find(params[:id])
+
+    respond_to do |format|
+      if @chimpaction.update_attributes(params[:chimpaction])
+        format.html { redirect_to(chimpactions_url, :notice => 'Chimpaction was successfully updated.') }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @chimpaction.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /chimpactions/1
+  # DELETE /chimpactions/1.xml
+  def destroy
+    @chimpaction = Chimpaction.find(params[:id])
+    @chimpaction.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(chimpactions_url) }
+      format.xml  { head :ok }
+    end
+  end
+  
+  def webhooks
+    @lists = Chimpactions.available_lists
+  end
+  
+  def add_webhook
+    list = Chimpactions.list(params[:id])
+     if list.set_webhook :url => 'http://www.postbin.org/1iwea1s'#webhook_url
+       flash[:notice] = "Added Webhook!"
+     end
+       redirect_to '/chimpactions/webhooks'
+  end
+  
+  def delete_webhook
+    list = Chimpactions.list(params[:id])
+     if list.remove_webhook :url => 'http://www.postbin.org/1iwea1s' #webhook_url
+       flash[:notice] = "Removed Webhook!"
+     end
+       redirect_to '/chimpactions/webhooks'
+  end
+  
+  def receive
+    if params['data']
+      subscriber = Chimpactions.registered_class.find_by_email(params['data']['email'])
+      subscriber.receive_webhook(params) if subscriber.respond_to?(:receive_webhook)
+    end
+      render :nothing => true
+  end
+# data[email] = 'federico@mailchimp.com'
+# 
+# data[email_type] = 'html'
+# 
+# data[id]  = 'da1b07ac4c'
+# 
+# data[ip_opt]='69.12.4.2'
+# 
+# data[list_id]='45a650bc63'
+# 
+# data[merges][EMAIL]='federico@mailchimp.com'
+# 
+# data[merges][FNAME] ='Federico'
+# 
+# data[merges][IP] ='127.0.0.1'
+# 
+# data[merges][LNAME]='Holgado'
+# 
+# data[merges][SIGNUP]=''
+# 
+# data[web_id]='234305517'
+# 
+# fired_at = '2011-06-30 02:34:35'
+# 
+# type ='profile'
+  # end
+  
+end

data/app/models/chimpaction.rb

@@ -0,0 +1,20 @@
+require "chimpactions"
+
+  class ResponseValidator < ActiveModel::Validator
+    def validate(record)
+      # k =  Kernel.const_get(Chimpactions::registered_class.name.to_s.capitalize).new
+       k = Chimpactions.registered_class
+      if k.respond_to?(record.action) != true
+        record.errors[:action] << "- '#{record.action}' is not a method of #{k.class.name} !"
+      end
+      if k.respond_to?(record.whenn) != true
+        record.errors[:whenn] << "- '#{record.whenn}' is not a method of #{k.class.name} !"
+      end
+    end
+  end
+
+# ActiveRecord 'wrapper' for Chimpactions::Action to provide non-yml peristence & customization
+ class Chimpaction < ActiveRecord::Base
+   validates_presence_of :list, :action, :whenn, :is, :value
+   validates_with ResponseValidator
+ end

data/app/views/chimpactions/_errors.html.erb

@@ -0,0 +1,10 @@
+<% if target.errors.any? %>  
+<div id="errorExplanation">  
+  <h2><%= pluralize(target.errors.count, "error") %> prohibited this record from being saved:</h2>  
+  <ul>  
+  <% target.errors.full_messages.each do |msg| %>  
+    <li><%= msg %></li>  
+  <% end %>  
+  </ul>  
+</div>  
+<% end %>  

data/app/views/chimpactions/_form.html.erb

@@ -0,0 +1,26 @@
+<style>
+.ca_action_form {padding-bottom:25px;width:350px;}
+.ca_action_form fieldset {background-color:inherit;padding:0px;margin:0px;}
+.ca_action_form fieldset legend {background-color:inherit;}
+.ca_action_form * {float:none;font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   12px!important;
+  line-height: 14px!important;}
+.ca_action_form label {padding:0 4px;}
+.ca_action_form div {display:inline;}
+.ca_action_form .field_with_errors input {border:1px solid red;}
+.ca_action_form ol {list-style:none;padding:14px;margin: 0px auto;max-width:315px;}
+.ca_action_form ol li{padding:4px;}
+.ca_action_form .bold {font-weight:bold;}
+</style>
+<%= form_for @chimpaction, :html => {:class => 'ca_action_form'} do |c| %>
+<%= render "chimpactions/errors", :target => @chimpaction %>
+<fieldset>
+  <ol>
+    <li><%= c.label :when, {:class => 'bold'} %> <%= Chimpactions.registered_class_name%>.<%= c.text_field :whenn, {:size => '15'} %> </li>
+    <li><%= select(:chimpaction, :is, %w(= < >)) %> <%= c.text_field :value %><%= c.label '(Value)' %></li>
+    <li><%= c.label "THEN", {:class => 'bold'}%></li>
+    <li><%= select(:chimpaction, :action, %w(add_to move_to remove_from).map {|l| [l.gsub('_',' ').titleize , l]}) -%></li>
+    <li><%= collection_select(:chimpaction, :list, Chimpactions.available_lists, :name, :name)%></li>
+    <li><%= submit_tag "submit"%></li>
+</fieldset>
+<% end %>

data/app/views/chimpactions/_list.html.erb

@@ -0,0 +1,6 @@
+<style>
+.ca_list {list-style:none;padding:0px;}
+</style>
+<ul class="ca_list">
+  <li><%= list.name%> ( ID : <%= list.id %> )</li>
+</ul>

data/app/views/chimpactions/edit.html.erb

@@ -0,0 +1,4 @@
+<section>
+<h1>EDIT Chimpaction : </h1>
+<%= render :partial => 'form'%>
+</section>

data/app/views/chimpactions/index.html.erb

@@ -0,0 +1,22 @@
+<section>
+  <% %w(notice warning error).each do |msg| %>
+    <% unless flash[msg.to_sym].blank? %>
+    <div class='message <%=msg-%>'><p><%=flash[msg.to_sym]-%></p></div>
+    <% end %>
+<% end %>
+<h1>Current Chimpactions  : </h1>
+<ul>
+<% @actions.each do |action|%>
+  <li> When a <%= @registered %> <%= action.whenn %> <%= action.is %> <%= action.value %> => <%= @registered%>.<%= action.action %> (<%= action.list %>) 
+  <%= link_to 'Edit', edit_chimpaction_path(action) %> ||
+   <%= link_to 'Destroy', chimpaction_path(action.id), :confirm => 'Are you sure?', :method => :delete %></li>
+<%end%>
+</ul>
+</section>
+<section>
+  <h1> <%= link_to "Add New Chimpaction", new_chimpaction_path %> </h1>
+</section>
+<section>
+  <h1>Your MailChimp lists: </h1>
+  <%= render :partial => 'list', :collection => @lists if @lists.count > 0%>
+</section>