chimpmunk 0.0.1

data/lib/chimpmunk/email_list.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+module Chimpmunk
+  class EmailList < ::ActiveRecord::Base
+
+    # rails 3
+    attr_accessible :default_from_email, :default_from_name, :default_subject, :mailchimp_id, :name if defined?(ActiveModel::MassAssignmentSecurity)
+
+    # Associations
+    has_many :email_campaigns
+    has_many :email_list_groupings, dependent: :destroy
+    has_many :email_subscribers
+
+    # Validations
+    validates :name, presence: true
+
+    # Nested Attributes
+    accepts_nested_attributes_for :email_list_groupings, allow_destroy: true
+    accepts_nested_attributes_for :email_subscribers, allow_destroy: true
+
+    #
+    # refresh email lists
+    #
+    def self.refresh_email_lists
+      lists = Chimpmunk.mailchimp.lists.list
+      lists['data'].each do |list|
+        next if Chimpmunk::EmailList.where(mailchimp_id: list['id']).first
+
+        Chimpmunk::EmailList.create(
+          mailchimp_id: list['id'],
+          name: list['name'],
+          default_from_name: list['default_from_name'],
+          default_from_email: list['default_from_email'],
+          default_subject: list['default_subject']  
+        )
+      end
+    end
+
+    private
+
+    if defined?(RailsAdmin)
+
+      rails_admin do
+        navigation_label 'Mailchimp'
+
+        edit do
+          field :mailchimp_id do
+            label 'Mailchimp ID'
+            read_only true
+          end
+          field :name do
+            read_only true
+          end
+          field :default_from_name do
+            read_only true
+          end
+          field :default_from_email do
+            read_only true
+          end
+          field :default_subject do
+            read_only true
+          end
+          field :email_list_groupings
+        end
+      end
+
+    end
+
+  end
+end

data/lib/chimpmunk/email_list_group.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+module Chimpmunk
+  class EmailListGroup < ::ActiveRecord::Base
+
+    # rails 3
+    attr_accessible :name if defined?(ActiveModel::MassAssignmentSecurity)
+
+    # Associations
+    belongs_to :email_list_grouping, foreign_key: :grouping_id, inverse_of: :email_list_groups
+    has_and_belongs_to_many :email_subscribers, before_add: :add_subscriber_grouping, before_remove: :remove_subscriber_grouping
+    has_many :email_campaigns, inverse_of: :email_list_group
+
+    # Valiations
+    validates_uniqueness_of :name, scope: :grouping_id
+
+    # Callbacks
+    before_update :update_name
+
+    private
+
+    ##
+    #   updates the name via the mailchimp api
+    def update_name
+      mailchimp.lists.interest_group_update(
+        id: self.email_list_grouping.email_list.mailchimp_id,
+        old_name: self.name_was,
+        new_name: self.name,
+        grouping_id: self.email_list_grouping.mailchimp_grouping_id
+      )
+    end
+
+    ##
+    # Adds a subscriber grouping via mailcimp api
+    def add_subscriber_grouping(email_subscriber)
+      groups = (email_subscriber.email_list_groups.where(grouping_id: self.grouping_id).pluck(:name) << self.name).uniq
+
+      mailchimp.lists.subscribe(
+        id: self.email_list_grouping.email_list.mailchimp_id,
+        email: { email: email_subscriber.email },
+        merge_vars: {
+          groupings: [
+            {
+              id: self.email_list_grouping.mailchimp_grouping_id,
+              groups: groups
+            }
+          ]
+        },
+        update_existing: true
+      )
+    end
+
+    ##
+    # removes a subscriber grouping via mailchimp api
+    def remove_subscriber_grouping(email_subscriber)
+      groups = email_subscriber.email_list_groups.where(grouping_id: self.grouping_id).pluck(:name).uniq
+      groups.delete(self.name)
+
+      mailchimp.lists.update_member(
+        id: self.email_list_grouping.email_list.mailchimp_id,
+        email: { email: email_subscriber.email },
+        merge_vars: {
+          groupings: [
+            {
+              id: self.email_list_grouping.mailchimp_grouping_id,
+              groups: groups
+            }
+          ]
+        }
+      )
+    end
+
+    if defined?(RailsAdmin)
+      rails_admin do
+        navigation_label 'Mailchimp'
+        visible false
+        edit do
+          field :name
+          field :email_subscribers do
+            column_width 1200
+            associated_collection_scope do
+              form = bindings[:form]
+              binding_object = bindings[:object]
+              list = if form
+                bindings[:form].options[:parent_builder].options[:parent_builder].object
+              elsif binding_object
+                binding_object.email_list_grouping.email_list
+              end
+              
+              Proc.new { |scope|
+                scope = scope.where(email_list_id: list.id, subscribed: true)
+              } if list
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chimpmunk/email_list_grouping.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+module Chimpmunk
+  class EmailListGrouping < ::ActiveRecord::Base
+
+    # rails 3
+    attr_accessible :name if defined?(ActiveModel::MassAssignmentSecurity)
+
+    # Associations
+    belongs_to :email_list, inverse_of: :email_list_groupings
+    has_many :email_list_groups, foreign_key: :grouping_id, dependent: :destroy,
+      before_add: :create_mailchimp_group, before_remove: :remove_mailchimp_group
+
+    # Nested Attribute
+    accepts_nested_attributes_for :email_list_groups, allow_destroy: true, limit: 60
+
+    # Callbacks
+    before_create :create_mailchimp_grouping
+    before_destroy :destroy_mailchimp_grouping
+    before_update :update_mailchimp_grouping, if: Proc.new{|record| record.name_changed? }
+
+    private
+
+    ##
+    #   create the mailchimp grouping before db create
+    def create_mailchimp_grouping
+      return false if email_list_groups.length < 1 # groupings have to have at least one group
+
+      interest_grouping = mailchimp.lists.interest_grouping_add(
+        name: name,
+        type: 'checkboxes',
+        id: email_list.mailchimp_id,
+        groups: email_list_groups.pluck(:name)
+      )
+
+      self.mailchimp_grouping_id = interest_grouping['id']
+    end
+
+    ##
+    #   delete the mailchimp grouping
+    def destroy_mailchimp_grouping
+      # don't care if it fails
+      begin
+      mailchimp.lists.interest_grouping_del(grouping_id: self.mailchimp_grouping_id)
+      rescue
+      end
+    end
+
+    ##
+    #   update the mailchimp groupings name
+    def update_mailchimp_grouping
+      mailchimp.lists.interest_grouping_update(
+        grouping_id: self.mailchimp_grouping_id,
+        name: 'name',
+        value: self.name
+      )
+    end
+
+    ##
+    #   remove grouping only if single grouping being removed and we have more than 1 to remove
+    def remove_mailchimp_group(email_list_group)
+      if !self.marked_for_destruction? && 
+        !self.email_list_groups.count == 1 && 
+        email_list_group.marked_for_destruction?
+
+        mailchimp.lists.interest_group_del(
+          id: self.email_list.mailchimp_id,
+          group_name: email_list_group.name,
+          groupind_id: self.mailchimp_grouping_id
+        )
+      end
+    end
+
+    #
+    #   creates a mailchimp group (only if adding to an existing grouping, not on grouping creation)
+    #
+    def create_mailchimp_group(email_list_group)
+      # if new grouping, groups are created in the grouping api call
+      return if email_list_group.grouping_id.nil?
+
+      if email_list_group.new_record?
+        mailchimp.lists.interest_group_add(
+          id: self.email_list.mailchimp_id,
+          group_name: email_list_group.name,
+          grouping_id: self.mailchimp_grouping_id
+        )
+      end
+    end
+
+    if defined?(RailsAdmin)
+      rails_admin do
+        navigation_label 'Mailchimp'
+        visible false
+
+        edit do
+          field :email_list
+          field :name
+          field :email_list_groups
+        end
+      end
+    end
+  end
+end

data/lib/chimpmunk/email_subscriber.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+module Chimpmunk
+  class EmailSubscriber < ::ActiveRecord::Base
+
+    # rails 3
+    attr_accessible :mailchimp_id, :first_name, :last_name, :email, :subscribed, :email_list_id if defined?(ActiveModel::MassAssignmentSecurity)
+
+    # Validations
+    validates :email, presence: true, uniqueness: true
+    validates :email_list, presence: true
+
+    # Associations
+    has_and_belongs_to_many :email_list_groups
+    belongs_to :email_list
+
+    # Callbacks
+    before_create :create_mailchimp_subscriber
+    before_destroy :destroy_mailchimp_subscriber
+
+    private
+
+    ##
+    #   create the subscription on mailchimp
+    def create_mailchimp_subscriber
+      Chimpmunk.mailchimp.lists.subscribe({
+        id: self.email_list.mailchimp_id,
+        email: { email: self.email }
+      })
+    end
+
+    ##
+    #   do the mailchimp unsubscribe first
+    def destroy_mailchimp_subscriber
+      begin
+        Chimpmunk.mailchimp.lists.unsubscribe({
+          id: self.email_list.mailchimp_id,
+          email: { email: self.email }
+        })
+      rescue  Gibbon::MailChimpError => e
+        # don't care if the user isn't a subscriber to the list, only if there was another error
+        raise Gibbon::MailchimpError unless e.message.include?('is not subscribed to list')
+      end
+    end
+
+    private
+
+    if defined?(RailsAdmin)
+      rails_admin do
+        navigation_label 'Mailchimp'
+        list do
+          field :mailchimp_id
+          field :first_name
+          field :last_name
+          field :email
+          field :subscribed
+          field :email_list
+        end
+        edit do
+          field :email_list do
+            inline_add false
+            inline_edit false 
+          end
+          field :mailchimp_id do
+            label "Mailchimp ID"
+            read_only true
+          end
+          field :first_name
+          field :last_name
+          field :email
+        end
+      end
+    end
+  end
+end

data/lib/chimpmunk/email_template.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Chimpmunk
+  class EmailTemplate < ::ActiveRecord::Base
+
+    # rails 3
+    attr_accessible :mailchimp_id, :name, :layout, :preview_image if defined?(ActiveModel::MassAssignmentSecurity)
+
+    # Assocaitions
+    has_many :email_campaigns
+
+    private 
+
+    if defined?(RailsAdmin)
+      rails_admin do  
+        navigation_label 'Mailchimp'
+        visible false   
+        show do
+          field :name
+          field :layout
+          field :preview_image do
+            pretty_value do
+              "<img src='#{value}' />".html_safe
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chimpmunk/engine.rb

@@ -0,0 +1,8 @@
+require 'rails'
+require 'rails/engine'
+require 'chimpmunk'
+
+module Chimpmunk
+  class Engine < Rails::Engine
+  end
+end

data/lib/chimpmunk/version.rb

@@ -0,0 +1,3 @@
+module Chimpmunk
+  VERSION = "0.0.1"
+end

data/lib/generators/chimpmunk/install_generator.rb

@@ -0,0 +1,50 @@
+require 'rails/generators'
+
+module Chimpmunk
+  class InstallGenerator < Rails::Generators::Base
+    def install
+      rails_admin_initializer = "#{Rails.root}/config/initializers/rails_admin.rb"
+      if File.exist?(rails_admin_initializer)
+        inject_into_file rails_admin_initializer, after: 'RailsAdmin.config do |config|' do <<-'TEMPLATE'
+
+  # include all custom actions from lib/rails_admin
+  Dir["#{Rails.root}/lib/rails_admin/*.rb"].each {|file| require file }
+
+  # include all existing models and Chimpmunk models
+  config.included_models = Dir.glob("#{Rails.root}/app/models/*.rb").map{|x| File.basename(x, ".rb").camelize} + ['Chimpmunk::EmailCampaign', 'Chimpmunk::EmailList', 'Chimpmunk::EmailListGroup', 'Chimpmunk::EmailListGrouping', 'Chimpmunk::EmailSubscriber', 'Chimpmunk::EmailTemplate']
+
+          TEMPLATE
+        end
+
+        inject_into_file rails_admin_initializer, after: 'config.actions do' do <<-'TEMPLATE'
+
+    refresh_email_campaigns do
+      only 'Chimpmunk::EmailCampaign'
+    end
+
+    refresh_email_campaign_stats do
+      only 'Chimpmunk::EmailCampaign'
+    end
+
+    send_email_campaign do
+      only 'Chimpmunk::EmailCampaign'
+    end
+
+    schedule_email_campaign do
+      only 'Chimpmunk::EmailCampaign'
+    end
+
+    un_schedule_email_campaign do
+      only 'Chimpmunk::EmailCampaign'
+    end
+
+    refresh_email_lists do
+      only 'Chimpmunk::EmailList'
+    end
+
+        TEMPLATE
+        end
+      end
+    end
+  end 
+end

data/lib/rails_admin/chimpmunk_custom_actions.rb

@@ -0,0 +1,201 @@
+require 'rails_admin/config/actions'
+require 'rails_admin/config/actions/base'
+
+module RailsAdmin
+  module Config
+    module Actions
+
+      #
+      # Refresh Email Lists
+      #
+      class RefreshEmailLists < RailsAdmin::Config::Actions::Base
+        RailsAdmin::Config::Actions.register(self)
+
+        register_instance_option :collection? do
+          true
+        end
+
+        register_instance_option :link_icon do
+          'icon-refresh'
+        end
+
+        register_instance_option :controller do
+          Proc.new do
+            @abstract_model.model_name.constantize.refresh_email_lists()
+            redirect_to rails_admin.index_path('chimpmunk~email_list')
+          end
+        end
+      end
+
+      #
+      # Refresh Email Campaigns
+      #
+      class RefreshEmailCampaigns < RailsAdmin::Config::Actions::Base
+        RailsAdmin::Config::Actions.register(self)
+
+        register_instance_option :collection? do
+          true
+        end
+ 
+        register_instance_option :link_icon do
+          'icon-refresh'
+        end
+
+        register_instance_option :controller do
+         Proc.new do
+            @abstract_model.model_name.constantize.refresh_email_campaigns()
+            redirect_to rails_admin.index_path("chimpmunk~email_campaign")
+         end
+        end
+      end
+
+      #
+      # Refresh Email Campaigns
+      #
+      class RefreshEmailCampaignStats < RailsAdmin::Config::Actions::Base
+        RailsAdmin::Config::Actions.register(self)
+
+        register_instance_option :collection? do
+          true
+        end
+ 
+        register_instance_option :link_icon do
+          'icon-signal'
+        end
+
+        register_instance_option :controller do
+         Proc.new do
+            @abstract_model.model_name.constantize.refresh_email_campaign_stats()
+            redirect_to rails_admin.index_path("chimpmunk~email_campaign")
+         end
+        end
+      end
+
+      #
+      # Duplicate Email Campaign
+      # => Allows the user to duplicate an email campaign
+      class DuplicateEmailCampaign < RailsAdmin::Config::Actions::Base
+        RailsAdmin::Config::Actions.register(self)
+
+        register_instance_option :member do
+          true
+        end
+ 
+        register_instance_option :link_icon do
+          'icon-copy'
+        end
+
+        register_instance_option :pjax? do
+          false
+        end
+
+        register_instance_option :controller do
+         Proc.new do
+            # Would rather have this method be new instead of edit
+            @new_object = @object.duplicate_campaign
+            if @new_object.save
+              flash[:notice] = "Campaign was duplicated.  Please edit the content now."
+              redirect_to rails_admin.edit_path("email_campaign", @new_object)
+            else
+              flash[:error] = "Campaign could not be duplicated."
+              redirect_to rails_admin.show_path("chimpmunk~email_campaign", @object)
+            end
+         end
+        end
+      end
+
+      #
+      # Immediate Send Email Campaign
+      # => Allows the user to send an email campaign
+      class SendEmailCampaign < RailsAdmin::Config::Actions::Base
+        RailsAdmin::Config::Actions.register(self)
+
+        register_instance_option :member do
+          true
+        end
+ 
+        register_instance_option :link_icon do
+          'icon-envelope'
+        end
+
+        register_instance_option :pjax? do
+          false
+        end
+
+        register_instance_option :controller do
+          Proc.new do
+            if @object.send_campaign
+              flash[:notice] = "Campaign was successfully sent."
+              redirect_to rails_admin.index_path("chimpmunk~email_campaign")
+            else
+              flash[:error] = "Campaign could not be sent."
+              redirect_to rails_admin.show_path("chimpmunk~email_campaign", @object)
+            end
+          end
+        end
+      end
+
+      #
+      # Send Email Campaign on Schedule
+      # => Allows the user to scheduled send an email campaign
+      class ScheduleEmailCampaign < RailsAdmin::Config::Actions::Base
+        RailsAdmin::Config::Actions.register(self)
+
+        register_instance_option :member do
+          true
+        end
+ 
+        register_instance_option :link_icon do
+          'icon-time'
+        end
+
+        register_instance_option :pjax? do
+          false
+        end
+
+        register_instance_option :controller do
+          Proc.new do
+            if @object.schedule_campaign
+              flash[:notice] = "Campaign was successfully scheduled."
+              redirect_to rails_admin.index_path("chimpmunk~email_campaign")
+            else
+              flash[:error] = "Campaign could not be scheduled."
+              redirect_to rails_admin.show_path("chimpmunk~email_campaign", @object)
+            end
+          end
+        end
+      end
+
+      #
+      # Un-Schedule Email Campaign
+      #
+      class UnScheduleEmailCampaign < RailsAdmin::Config::Actions::Base
+        RailsAdmin::Config::Actions.register(self)
+        
+        register_instance_option :member do
+          true
+        end
+ 
+        register_instance_option :link_icon do
+          'icon-remove-sign'
+        end
+
+        register_instance_option :pjax? do
+          false
+        end
+
+        register_instance_option :controller do
+          Proc.new do
+            if @object.unschedule_campaign
+              flash[:notice] = "Campaign was successfully un-scheduled."
+              redirect_to rails_admin.index_path("chimpmunk~email_campaign")
+            else
+              flash[:error] = "Campaign could not be un-scheduled."
+              redirect_to rails_admin.show_path("chimpmunk~email_campaign", @object)
+            end
+          end
+        end
+      end
+    end
+  end
+end