chimpmunk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8f65e72ccad48b7480ebab56fc5b64d47db5433
+  data.tar.gz: 65dcf7c040d7b56806733af6230f8b2040000e14
+SHA512:
+  metadata.gz: abb985ee363fead96538780e32aa4279ec985f2d6de6cd6b4dc575ea38402d9bd3de80cd6d406c9c5f71dc2831c225a11499ad125f5c8700cd75124814dceba6
+  data.tar.gz: 2654c63e2b08158f0566d9cd699e2c91cd631289a58241a752e1118441cd21fd3beddc2cacd15b6a0a30eac4ea2f8e961af3cbc9ed64078b68f017aba94fca0a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chimpmunk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nick Franken
+
+MIT License
+
+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.md

@@ -0,0 +1,43 @@
+# Chimpmunk
+
+Mailchimp list administration and Campaign builder. ( in development )
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'chimpmunk'
+
+And then execute:
+
+    $ bundle
+
+Install with (make sure you have followed all rails_admin install steps first)
+
+	$ rails g chimpmunk:install
+
+## Post Installation
+
+Install migrations
+
+    $ rake chimpmunk_engine:install:migrations
+
+Run migrations
+
+    $ rake db:migrate
+
+Set your mailchimp api key:
+
+	Gibbon::API.api_key = "your_api_key"
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/chimpmunk/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/chimpmunk.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chimpmunk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chimpmunk"
+  spec.version       = Chimpmunk::VERSION
+  spec.authors       = ["Nick Franken"]
+  spec.email         = ["nf@the42.com"]
+  spec.summary       = %q{Mailchimp list administration and Campaign builder.}
+  spec.description   = %q{Mailchimp list administration and Campaign builder.}
+  spec.homepage      = "https://bitbucket.org/42dev/chimpmunk"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord',  ['>= 3.2', '< 5']
+  spec.add_dependency 'gibbon', '>= 1.1'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/config/locales/chimpmunk.en.yml

@@ -0,0 +1,53 @@
+en:
+  admin:
+    actions:
+      send_test_email:
+        title: 'Send Test Email'
+        menu: 'Send Test Email'
+        breadcrumb: 'Send Test Email'
+        link: 'Send Test Email'
+      email_management:
+        title: 'Email Management'
+        menu: 'Email Management'
+        breadcrumb: 'Email Management'
+        link: 'Email Management'
+      email_list_new:
+        title: 'New Email List'
+        menu: 'New Email List'
+        breadcrumb: 'New Email List'
+        link: 'New Email List'
+      duplicate_email_campaign:
+        title: 'Duplicate Email Campaign'
+        menu: 'Duplicate Email Campaign'
+        breadcrumb: 'Duplicate Email Campaign'
+        link: 'Duplicate Email Campaign'
+      send_email_campaign:
+        title: 'Send Email Campaign'
+        menu: 'Send Email Campaign'
+        breadcrumb: 'Send Email Campaign'
+        link: 'Send Email Campaign'
+      schedule_email_campaign:
+        title: 'Schedule Email Campaign'
+        menu: 'Schedule Email Campaign'
+        breadcrumb: 'Schedule Email Campaign'
+        link: 'Schedule Email Campaign'
+      un_schedule_email_campaign:
+        title: 'Un-Schedule Email Campaign'
+        menu: 'Un-Schedule Email Campaign'
+        breadcrumb: 'Un-Schedule Email Campaign'
+        link: 'Un-Schedule Email Campaign'
+      refresh_email_campaigns:
+        title: 'Refresh Email Campaigns'
+        menu: 'Refresh Email Campaigns'
+        breadcrumb: 'Refresh Email Campaigns'
+        link: 'Refresh Email Campaigns'
+      refresh_email_campaign_stats:
+        title: 'Refresh Email Campaigns Stats'
+        menu: 'Refresh Email Campaigns Stats'
+        breadcrumb: 'Refresh Email Campaigns Stats'
+        link: 'Refresh Email Campaigns Stats'
+      refresh_email_lists:
+        title: 'Refresh Email Lists'
+        menu: 'Refresh Email Lists'
+        breadcrumb: 'Refresh Email Lists'
+        link: 'Refresh Email Lists'

data/db/migrate/1_chimpmunk_migration.rb

@@ -0,0 +1,102 @@
+class ChimpmunkMigration < ActiveRecord::Migration
+  def self.up
+
+    # create email lists
+    create_table :email_lists do |t|
+      t.string :default_from_email
+      t.string :default_from_name
+      t.string :default_subject
+      t.string :mailchimp_id
+      t.string :name
+
+      t.timestamps
+    end
+
+    # create email campaigns
+    create_table :email_campaigns do |t|
+      t.string :title
+      t.string :from_email
+      t.string :from_name
+      t.references :email_list, index: true
+      t.string :subject
+      t.references :email_template, index: true
+      t.string :mailchimp_list_id
+      t.datetime :send_date
+      t.string :mailchimp_campaign_id
+      t.string :mailchimp_list_id
+      t.integer :emails_sent
+      t.integer :clicked
+      t.integer :opened
+      t.string :status
+      t.integer :hard_bounces
+      t.integer :soft_bounces
+      t.integer :unsubscribes
+      t.integer :forwards
+      t.integer :forwards_opens
+      t.integer :opens
+      t.datetime :last_open
+      t.integer :unique_opens
+      t.integer :non_unique_clicks
+      t.integer :users_who_clicked
+      t.integer :unique_likes
+      t.integer :facebook_likes
+      t.string :campaign_kind
+      t.integer :template_id
+
+      t.timestamps
+    end
+
+    # create email list groups
+    create_table :email_list_groups do |t|
+      t.string :name
+      t.references :grouping, index: true
+
+      t.timestamps
+    end
+
+    # create email templates
+    create_table :email_templates do |t|
+      t.string :mailchimp_id
+      t.string :name
+      t.string :layout
+      t.string :preview_image
+
+      t.timestamps
+    end
+
+    # create email list groupings
+    create_table :email_list_groupings do |t|
+      t.string :name
+      t.references :email_list, index: true
+      t.integer :mailchimp_grouping_id
+
+      t.timestamps
+    end
+
+    # ceate email subscribers
+    create_table :email_subscribers do |t|
+      t.string :mailchimp_id
+      t.string :first_name
+      t.string :last_name
+      t.string :email
+      t.boolean :subscribed
+      t.references :email_list, index: true
+
+      t.timestamps
+    end
+
+    # create email list group subscribers join table
+    create_table :email_list_groups_subscribers, id: false do |t|
+      t.integer :email_list_group_id
+      t.integer :email_subscriber_id
+    end
+  end
+
+  def self.down
+    drop_table :email_lists
+    drop_table :email_campaigns
+    drop_table :email_list_groups
+    drop_table :email_templates
+    drop_table :email_list_groupings
+  end
+end

data/lib/chimpmunk.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+require 'rails_admin'
+require 'gibbon'
+require 'chimpmunk/engine'
+require 'rails_admin/chimpmunk_custom_actions.rb'
+
+module Chimpmunk
+  extend ActiveSupport::Autoload
+
+  autoload :EmailCampaign
+  autoload :EmailList
+  autoload :EmailListGroup
+  autoload :EmailListGrouping
+  autoload :EmailSubscriber
+  autoload :EmailTemplate
+  autoload :VERSION
+
+  def self.mailchimp
+    @mailchimp ||= ::Gibbon::API.new
+  end
+end

data/lib/chimpmunk/email_campaign.rb

@@ -0,0 +1,352 @@
+# encoding: utf-8
+module Chimpmunk
+  class EmailCampaign < ::ActiveRecord::Base
+    attr_accessor :skip_update_callbacks, :skip_create_callbacks
+
+    # rails 3
+    attr_accessible :title, :from_email, :from_name, :email_list_id, :subject, :email_template_id, :mailchimp_list_id, :send_date, 
+      :mailchimp_campaign_id, :emails_sent, :clicked, :opened, :status, :hard_bounces, :soft_bounces, :unsubscribes, :forwards, 
+      :forwards_opens, :opens, :last_open, :unique_opens, :non_unique_clicks, :users_who_clicked, :unique_likes, :facebook_likes,
+      :created_at, :updated_at, :campaign_kind, :template_id, :email_list_group_id if defined?(ActiveModel::MassAssignmentSecurity)
+
+    # Associations
+    belongs_to :email_list
+    belongs_to :email_template
+    belongs_to :email_list_group
+    belongs_to :email_template
+
+    # Validations
+    validates :subject, presence: true
+    validates :from_email, presence: true
+    validates :from_name, presence: true
+    validates :email_list, presence: true
+    validates :email_template, presence: true
+
+    # Callbacks
+    after_create :create_campaign, unless: Proc.new { |campaign| campaign.skip_create_callbacks }
+    before_update :update_campaign, unless: Proc.new{ |campaign| campaign.skip_update_callbacks }
+    before_update :update_content, if: Proc.new{|campaign| campaign.email_template_id_changed? && !campaign.skip_update_callbacks }
+    before_destroy :destroy_mailchimp_campaign
+
+    # TODO: figure out attachments, example below
+    # has_attached_file :intro_image
+    # validates_attachment_content_type :intro_image, :content_type => /\Aimage\/.*\Z/
+
+    # TODO: figure out association, example below
+    # has_many :email_campaign_trending_posts, dependent: :destroy
+    # has_many :trending_posts, source: :post, through: :email_campaign_trending_posts
+
+    ##
+    #   CLASS METHODS
+    ##
+
+    ##
+    # Refreshes the list of email campaigns
+    def self.refresh_email_campaigns
+      Chimpmunk.mailchimp.campaigns.list()["data"].each do |campaign|
+        campaign_attributes = {
+          title: campaign["title"],
+          campaign_kind: campaign["type"],
+          mailchimp_list_id: campaign["list_id"],
+          email_list_id: Chimpmunk::EmailList.find_by_mailchimp_id(campaign["list_id"]),
+          subject: campaign["subject"],
+          from_email: campaign["from_email"],
+          from_name: campaign["from_name"],
+          template_id: campaign["template_id"],
+          mailchimp_campaign_id: campaign["id"]
+        }
+        unless self.where(campaign_attributes).any?
+          new_campaign = self.new(campaign_attributes)
+          new_campaign.skip_create_callbacks = true
+          new_campaign.save
+        end
+      end
+    end
+
+    ##
+    # Refreshes all of the email campaign stats
+    def self.refresh_email_campaign_stats
+      Chimpmunk.mailchimp.campaigns.list({status:"sent"})["data"].each do |campaign|
+        email_campaign = Chimpmunk::EmailCampaign.find_by_mailchimp_campaign_id(campaign["id"])
+        if email_campaign and campaign["summary"].any?
+          email_campaign.skip_update_callbacks = true
+          email_campaign.update_attributes(
+            status: "sent",
+            emails_sent: campaign["summary"]["emails_sent"],
+            opened: campaign["summary"]["unique_opens"],
+            clicked: campaign["summary"]["unique_clicks"],
+            hard_bounces: campaign["summary"]["hard_bounces"],
+            soft_bounces: campaign["summary"]["soft_bounces"],
+            unsubscribes: campaign["summary"]["unsubscribes"],
+            forwards: campaign["summary"]["forwards"],
+            forwards_opens: campaign["summary"]["forwards_opens"],
+            opens: campaign["summary"]["opens"],
+            last_open: campaign["summary"]["last_open"],
+            unique_opens: campaign["summary"]["unique_opens"],
+            non_unique_clicks: campaign["summary"]["non_unique_clicks"],
+            users_who_clicked: campaign["summary"]["users_who_clicked"],
+            unique_likes: campaign["summary"]["unique_likes"],
+            facebook_likes: campaign["summary"]["facebook_likes"]
+          )
+        end
+      end
+    end
+
+    ##
+    # INSTANCE METHODS
+    ##
+
+    ##
+    # send a mailchimp campaign
+    def send_campaign
+      response = Chimpmunk.mailchimp.campaigns.send({cid: self.mailchimp_campaign_id})
+      response['errors'].nil?
+    end
+
+    ##
+    # schedule a mailchimp campaign
+    def schedule_campaign
+      response = Chimpmunk.mailchimp.campaigns.schedule({
+        cid: self.mailchimp_campaign_id,
+        schedule_time: self.send_date.to_time.to_s.gsub(' UTC', '')
+      })
+      response['errors'].nil? && self.update_attribute(:scheduled, true)
+    end
+
+    ##
+    # un-schedule email campaign that has been scheduled
+    def unschedule_campaign
+      response = Chimpmunk.mailchimp.campaigns.unschedule({cid: self.mailchimp_campaign_id})
+      response['errors'].nil? && self.update_attribute(:scheduled, false)
+    end
+
+    ##
+    # opened percentage display as float
+    def opened_percentage
+      if opened and emails_sent
+        "%2.1f %" % (opened.to_f / emails_sent.to_f * 100)
+      end
+    end
+
+    ##
+    # clicked percentage display as float
+    def clicked_percentage
+      if clicked and emails_sent
+        "%2.1f %" % (clicked.to_f / emails_sent.to_f * 100)
+      end
+    end
+
+    private
+
+    def action_view
+      @action_view ||= ActionView::Base.new(Rails.configuration.paths["app/views"])
+      @action_view.class_eval do 
+          include Rails.application.routes.url_helpers
+          include ApplicationHelper
+
+          def protect_against_forgery?
+            false
+          end
+      end
+      @action_view
+    end
+
+    ##
+    # destroy mailchimp campaign before db destroy
+    def destroy_mailchimp_campaign
+      # don't care if it fails (probably was deleted from mailchimp web before deleted here)
+      begin
+        Chimpmunk.mailchimp.campaigns.delete({cid: self.mailchimp_campaign_id})
+      rescue Gibbon::MailChimpError
+        true
+      end
+    end
+
+    ##
+    # updates the campaign content on mailchimp before db update
+    def update_content
+      response = Chimpmunk.mailchimp.campaigns.update(
+        cid: self.mailchimp_campaign_id,
+        name: "content",
+        value: get_content
+      )
+
+      !response['errors'].any?
+    end
+
+    ##
+    # updates the campaign on mailchimp before db update
+    def update_campaign
+      begin
+        response = Chimpmunk.mailchimp.campaigns.update({
+          cid: self.mailchimp_campaign_id,
+          name: "options",
+          value: campaign_update_hash
+        })
+      rescue Gibbon::MailChimpError => e
+        self.errors.add(:base, e.message)
+        return false
+      end
+
+      if response["errors"].empty?
+        data = response["data"]
+        self.mailchimp_list_id = data["list_id"]
+        self.title = data["title"]
+        self.subject = data["subject"]
+        self.from_name = data["from_name"]
+        self.from_email = data["from_email"]
+        true
+      else
+        false
+      end
+    end
+
+    ##
+    # returns the update hash needed for the mailchimp request
+    def campaign_update_hash
+      {
+        list_id: email_list.mailchimp_id,
+        title: title,
+        subject: subject,
+        from_name: from_name,
+        from_email: from_email
+      }.reject{|k, v| v.nil?}
+    end
+
+    ##
+    #   create campaign on mailchimp before db creation
+    def create_campaign
+      opts = {
+        type: "regular",
+        options: {
+          subject: self.subject,
+          from_email: self.from_email,
+          from_name: self.from_name,
+          template_id: self.email_template.try(:mailchimp_id),
+          inline_css: true
+        },
+        content: get_content
+      }
+
+      # list or segment(group)
+      if group = self.email_list_group
+        opts[:segment_opts] = {
+            match: "all",
+            conditions: [
+              {
+                field: "interests-#{group.email_list_grouping.mailchimp_grouping_id}",
+                value: group.name,
+                op: 'one'
+              }
+            ]
+        }
+        opts[:options][:list_id] = group.email_list_grouping.email_list.mailchimp_id
+      else
+        opts[:options][:list_id] = self.email_list.try(:mailchimp_id)
+      end
+      
+      response = Chimpmunk.mailchimp.campaigns.create(opts)
+      if response["errors"].nil?
+        self.skip_update_callbacks = true
+        self.update_attribute(:mailchimp_campaign_id, response["id"])
+      else
+        false
+      end
+    end
+
+    ##
+    # TODO: figure out how to do this
+    # returns the html content for the new campaign
+    def get_content
+      content = {sections: {}}
+
+      # insert intro section if it exists
+      unless intro_section_blank?
+        content[:sections][:intro_section] = action_view.render 'eflyers/newsletter/intro', email_campaign: self
+      end
+
+      # insert divider if both intro sections and featured post exist
+      unless intro_section_blank? || featured_post.nil?
+        content[:sections][:divider] = action_view.render 'eflyers/newsletter/divider'
+      end
+
+      # insert featured post if it exists
+      unless featured_post.nil?
+        content[:sections][:featured_article] = action_view.render 'eflyers/newsletter/featured_article', email_campaign: self
+      end
+
+      # insert tending posts
+      content[:sections][:trending_section] = ''
+      trending_posts.in_groups_of(2) do |first_post, second_post|
+        content[:sections][:trending_section] += action_view.render 'eflyers/newsletter/trending', first_post: first_post, second_post: second_post
+      end
+
+      # insert sponsored section if it exsists
+      unless sponsored_section_blank?
+        content[:sections][:sponsored_section] = action_view.render 'eflyers/newsletter/sponsored', email_campaign: self
+      end
+
+      content[:sections][:directory_section] = action_view.render 'eflyers/newsletter/directory', 
+        teacher_1: self.directory_teachers.first,
+        teacher_2: self.directory_teachers.second,
+        event_1: self.directory_events.first,
+        event_2: self.directory_events.second,
+        studio_1: self.directory_studios.first,
+        studio_2: self.directory_studios.second
+
+      unless teacher_tip_post.nil?
+        content[:sections][:teacher_tip] = action_view.render 'eflyers/newsletter/teacher_tip', email_campaign: self
+      end
+
+      content
+    end
+
+    if defined?(RailsAdmin)
+
+      rails_admin do
+        navigation_label 'Mailchimp'
+        
+        configure :background_color, :color
+        configure :foreground_color, :color
+        configure :send_date, :datetime
+
+        list do
+          field :title
+          field :email_list
+          field :status
+          field :emails_sent
+          field :opened_percentage do
+            label "Opened"
+          end
+          field :clicked_percentage do
+            label "Clicked"
+          end
+          field :subject
+          field :from_email
+          field :from_name
+        end
+
+        edit do
+          field :title
+          field :email_list do
+            inline_add false
+            inline_edit false
+          end
+          field :email_list_group
+          field :email_template do
+            inline_add false
+            inline_edit false
+          end
+          field :subject
+          field :from_name do
+            default_value 'FIXME'
+          end
+          field :from_email do
+            default_value 'FIXME'
+          end
+          field :send_date
+        end
+      end
+    end
+  end
+end