chimpactions 0.0.0 → 0.0.4

data/lib/chimpactions/notifier.rb

@@ -0,0 +1,9 @@
+module Chimpactions
+# Notifier for telling the List objects that Chimpactions is using a new connection.
+class ListNotifier
+  # Notify the List class that we havea new connection to MailChimp
+   def update(chimpactions)
+     chimpactions::List.new_socket
+   end
+end
+end

data/lib/chimpactions/setup.rb

@@ -0,0 +1,42 @@
+module Chimpactions
+  #Utility class for ensuring everythign is ready for Chimpactions to do its work
+  module Setup
+    mattr_accessor :message
+    mattr_reader :errors
+    @@errors = ActiveSupport::OrderedHash.new
+    
+    # Make sure we have the right info to proceed.
+    def self.ensure_initialization
+      @@errors = ActiveSupport::OrderedHash.new
+      self.error(:api_key, "Is not set!") if Chimpactions.mailchimp_api_key == "your_mailchimp_api_key" || Chimpactions.mailchimp_api_key.nil?
+      self.error(:ses_key, "Is not set!") if Chimpactions.mailchimp_ses_key == "your_mailchimp_ses_key" || Chimpactions.mailchimp_ses_key.nil?
+     # self.verify_api_key
+      @@message = "Chimpactions::Setup.initialize"
+    end
+    
+    # Were there errors in the setup ?
+    def self.ok?
+      errors.empty?
+    end
+    
+    # Check the gibbon connection to MailChimp
+    # Verify that the API key is good.
+    def self.verify
+      begin
+        Chimpactions.socket.chimpChatter()
+      rescue Exception => e
+        self.error(:api_key,"BAD API KEY::" << e.message)
+        false
+      end
+    end
+    
+    private
+    # Register an error in the setup.
+    def self.error(parameter,message)
+      errors[parameter] = message
+    end
+    
+
+    
+  end
+end

data/lib/chimpactions/subscriber.rb

@@ -0,0 +1,125 @@
+module Chimpactions
+#The Chimpactions Subscriber is the mix-in module for a 
+# local model.
+#Once initialized, the local model inherits all Subscriber methods.
+#ex.
+#<pre>
+# see chimpaction.yml for initializtaion options
+#</pre>
+  module Subscriber
+    
+    attr_accessor :merge_vars
+
+  # override for mix-in goodeness
+   def self.included(mod)
+     mod.send(:include, ClassMethods)
+   end
+
+# listSubscribe(string apikey, string id, string email_address, array merge_vars, string email_type, bool double_optin, bool update_existing, bool replace_interests, bool send_welcome)
+# 
+# Subscribe the provided email to a list.
+# 
+# listUnsubscribe(string apikey, string id, string email_address, boolean delete_member, boolean send_goodbye, boolean send_notify)
+# 
+# Unsubscribe the given email address from the list
+  module ClassMethods
+      def chimpactions
+        Chimpactions.actions.each{|action| action.execute(self)}
+      end
+    
+        # Add the Subscriber to the specified list.
+        # @param [String, Fixnum, Chimpactions::List] list
+        def add_to(list, opts={})
+          list = validate_list(list)
+          list.socket.listSubscribe({:id => list.id, :email_address => self.email, 
+            :merge_vars => self.merge_vars, :send_welcome => Chimpactions.default_send_welcome,
+            :double_optin => Chimpactions.default_double_optin,
+            :update_existing => Chimpactions.default_update_existing}.merge opts) == "true"
+        end
+    
+        # Remove Subscriber from all lists in the account and add to the specified List
+        # @param [String, Fixnum, Chimpactions::List] list
+        def move_to(list)
+          list = validate_list(list)
+          # add to the specified list
+          if add_to(list) == true
+            #remove from all the others
+            Chimpactions.available_lists.each do |l|
+              remove_from(l) if l != list 
+            end
+            true
+          else
+            false
+          end
+        end
+  
+        # Remove the Subscriber from the specified list.
+        # @param [String, Fixnum, Chimpactions::List] list
+        def remove_from(list, opts={})
+          list = validate_list(list)
+          list.socket.listUnsubscribe({:id => list.id, :email_address => self.email}.merge opts) == "true"
+        end
+    
+        # Send the specified MailChimp pre-defined "Response Email" to this Subscriber
+        # @param [String, Fixnum, Chimpactions::List] list
+        def send_response_email(list, title)
+          list = validate_list(list)
+          false # stub for test failure
+        end
+  
+        # Check if this Subscriber is on the specified list.
+        # @param [String, Fixnum, Chimpactions::List] list
+        # @return [Boolean]
+        def on_list?(list, opts={})
+          list = validate_list(list)
+          answer = list.socket.listMemberInfo({:id => list.id, :email_address => self.email}.merge opts)
+          answer['success'] == 1 && answer['errors'] == 0
+        end
+    
+        # Check if this Subscriber is 'subscribed' to the list.
+        # @param [String, Fixnum, Chimpactions::List] list
+        # @return [Boolean]
+        def subscribed?(list,opts={})
+          list = validate_list(list)
+          answer = list.socket.listMemberInfo({:id => list.id, :email_address => self.email}.merge opts)
+          answer['success'] == 1 && answer['data'][0]['status'] == 'subscribed'
+        end
+    
+        # @param [Hash] hash The Chimpactions mergemap 
+        def merge_vars(hash = Chimpactions.merge_map)
+          collect_merge_vars(hash)
+        end
+
+    private
+
+      # Sync this Subscriber's info to the MailChimp list.
+      # @return [boolean] *true* or *false*
+       def sync_to_chimp
+         Chimpactions.available_lists.each do |l|
+           add_to(l)
+         end
+       end
+
+
+       # Calls the specified method/attribute on the mix-in target
+       # @param [Hash] {'MAILCHIMP_MERGE_VAR' => 'model_attribute_or_method'}
+       # @return [Hash]
+       def collect_merge_vars(merge_hash)
+         merge_vars = Hash.new
+         merge_hash.each_pair do |key,val|
+          if self.respond_to?(val)
+            method_object = self.method(val.to_sym) 
+            merge_vars[key] = method_object.call
+          end
+        end
+        merge_vars
+       end
+       
+      # Wrapper for Chimpactions module list method
+      # @see Chimpactions.list(list)
+      def validate_list(list)
+        Chimpactions.list(list)
+      end
+    end
+  end #Module
+end #Module

data/lib/chimpactions/utility.rb

@@ -0,0 +1,13 @@
+module Chimpactions
+  # Utility mix-in module
+  # Defines method_missing for accessing raw MC data as 
+  # Object attributes.
+  module Utility
+    # Convenience method for accessing MailChimp data arrays
+    # as class attributes.
+    # ex. => List.id instead of List['id']
+    def method_missing(m, *args)
+      @raw.keys.include?(m.to_s) ? @raw[m.to_s] : super
+    end
+  end
+end

data/lib/chimpactions/version.rb

@@ -1,3 +1,3 @@
 module Chimpactions
-  VERSION = "0.0.0"
+  VERSION = "0.0.4"
 end

data/lib/generators/chimpactions/customize/customize_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+module Chimpactions
+  module Generators
+    class CustomizeGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates/views', __FILE__)
+      def copy_views
+        # Views template 
+          copy_file "index.html.erb", "app/views/chimpactions/index.html.erb"
+          copy_file "edit.html.erb", "app/views/chimpactions/edit.html.erb"
+          copy_file "new.html.erb", "app/views/chimpactions/new.html.erb"
+          copy_file "_form.html.erb", "app/views/chimpactions/_form.html.erb"
+          copy_file "_errors.html.erb", "app/views/chimpactions/_errors.html.erb"
+          copy_file "webhooks.html.erb", "app/views/chimpactions/webhooks.html.erb"
+      end
+    end
+  end
+end

data/lib/generators/chimpactions/customize/templates/views/_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/lib/generators/chimpactions/customize/templates/views/_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/lib/generators/chimpactions/customize/templates/views/_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/lib/generators/chimpactions/customize/templates/views/edit.html.erb

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

data/lib/generators/chimpactions/customize/templates/views/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>

data/lib/generators/chimpactions/customize/templates/views/new.html.erb

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

data/lib/generators/chimpactions/customize/templates/views/webhooks.html.erb

@@ -0,0 +1,26 @@
+<style>
+.ca_list {list-style:none;padding:0px;}
+</style>
+<div style="font-size:1.2em; color:green;"><%= flash[:notice] if flash[:notice] %></div>
+<ul class="ca_list">
+  <% @lists.each do |list|%>
+  <li><%= list.name%> ( ID : <%= list.id %> )
+    <% if list.webhook? == false %> 
+      <%=link_to "Add Webhook", {:action => 'add_webhook', :id => list.web_id }%>
+    <% else %>
+      <%=link_to "REMOVE Webhook", {:action => 'delete_webhook', :id => list.web_id }%>
+    <%end%>
+  </li>
+  <%end%>
+</ul>
+
+<div style="margin-top:25px;"> Remember !  : in order to do something here, your <%= Chimpactions.registered_class_name %> class must define :
+  <pre> 
+    ...
+    def receive_webhook(post_from_mailchimp)
+      // do something with the MailChimp POST data here
+    end
+    ...
+  </pre>
+  
+</div>

data/lib/generators/chimpactions/install/install_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+module Chimpactions
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Creates a Chimpactions initializer and copy locale files to your application."
+      def copy_config_yml
+        copy_file "chimpactions.yml", "config/chimpactions.yml"
+      end
+      
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/chimpactions/install/templates/README

@@ -0,0 +1,10 @@
+===============================================================================
+Chimpactions is almost ready...
+
+  - Edit config/chimpactions.yml accordingly
+  - To use ActiveRecord data store for Actions:
+    - rails generate chimpactions:migration
+  - you can then visit the admin interface at http:yourapp/chimpactions
+  - To customize the Admin section above:
+   - rails generate chimpactions:customize 
+===============================================================================

data/lib/generators/chimpactions/install/templates/chimpactions.yml

@@ -0,0 +1,39 @@
+mailchimp_api_key: your_mailchimp_api_key
+mailchimp_ses_key: your_mailchimp_ses_key
+# Mappings of YOUR MailChimp Merge Variables
+# => This list should include ANY merge variables throughout your MailChimp
+#    account from any and all lists.
+# => Chimpactions will fail gracefully (i.e. not try to send) on any varibles
+#    either not set by your model, or not in the particular list.
+# => If your model does not respond_to?('your_models_attribute_or_method')
+#    the merge variable will be skipped (not sent).
+# @format :: MAILCHIMP_MERGE_VAR: 'model_attribute_or_method'
+merge_map:
+  FNAME: first_name
+  LNAME: last_name
+  EMAIL: email
+  FAV_COL: favorite_color
+# The local model to target for mix-in of the Chimpactions gem.
+# This effectively makes the defined model as a Chimpactions::Subscriber
+local_model: YourLocalModel
+default_double_optin: false #default false Require the user to reply to the MailChimp system before adding to list.
+default_send_welcome: true #default true Have MailChimp send the "Welcome" email for the list immediately.
+default_email_type:  html # 'nuff said... html ot text
+# Storage method for Chimpactions persistence
+# => :active_record OR :yml
+# :active_record => ActiveRecord DB model (see migration)
+# :yml => manually defined in this file with :
+# actions:
+#   -
+#     action: :move_to
+#     list: "A MailChimp List Name"
+#     whenn: "your_method_or_attribute_1" 
+#     is: '='
+#     value: 'the_value_1'
+#   -
+#     action: :remove_from
+#     list: "Another MailChimp List Name"
+#     whenn: "your_method_or_attribute_2" 
+#     is: '='
+#     value: 'the_value_2'  
+action_store: :yml

data/lib/generators/chimpactions/install/templates/chimpactions_initializer.rb

@@ -0,0 +1 @@
+ChimpactionsController.send(:before_filter, 'require_admin')

data/lib/generators/chimpactions/migration/migration_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+module Chimpactions
+  module Generators
+    class MigrationGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      
+      desc "add the migrations"
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+      
+      desc "Add the Chimpactions migration to  Rails db/migrate"
+      def copy_migrations
+        migration_template "create_chimpactions.rb", "db/migrate/create_chimpactions.rb"
+      end
+      
+    end
+  end
+end

data/lib/generators/chimpactions/migration/templates/create_chimpactions.rb

@@ -0,0 +1,16 @@
+class CreateChimpactions < ActiveRecord::Migration
+  def self.up
+    create_table :chimpactions, :force => true do |t|
+      t.text :action
+      t.text :list
+      t.string :whenn
+      t.string :is
+      t.string :value
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :chimpactions
+  end
+end