chimpmunk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8f65e72ccad48b7480ebab56fc5b64d47db5433
-  data.tar.gz: 65dcf7c040d7b56806733af6230f8b2040000e14
+  metadata.gz: 8d386eba35aefc48e80041d30e14d09a76405b46
+  data.tar.gz: 4666331e2c9a3af08a8dad237f88795ca8004359
 SHA512:
-  metadata.gz: abb985ee363fead96538780e32aa4279ec985f2d6de6cd6b4dc575ea38402d9bd3de80cd6d406c9c5f71dc2831c225a11499ad125f5c8700cd75124814dceba6
-  data.tar.gz: 2654c63e2b08158f0566d9cd699e2c91cd631289a58241a752e1118441cd21fd3beddc2cacd15b6a0a30eac4ea2f8e961af3cbc9ed64078b68f017aba94fca0a
+  metadata.gz: 9af58d721920b15da3585335185bff6ba724eb2c99ded5204b7d7d55ffaec316cdac28c7957b91c00629c16b692e46f4788fceb0f205db78a042ddf530251645
+  data.tar.gz: 333c516acc181af90045ef63d2a054eb9e64b2cf8037b10eeebaf4d61a122cedcbaaf39162e548e39b2bfb71dcaf491895afb9d36fda92360709f122325a10f4

data/README.md

@@ -32,8 +32,62 @@ Set your mailchimp api key:
 
 ## Usage
 
-TODO: Write usage instructions here
-
+1. create a new model for your campaign `app/models/test_email_campaign.rb` that extends `Chimpmunk::EmailCampaign`
+
+2. create headers, texts and images definitions for any strings, text or images needed in the campaign.
+
+3. If you need assocations with the email campaign, generate the association models and add the `associated` definition in the email campaign subclass.
+
+4. override the content method, details coming soon
+
+
+example:
+
+
+```
+	rails g model EmailCampaignPost email_campaign:references post:references
+	rails g model EmailCampaignComment email_campaign:references post:references
+```
+
+
+
+```
+    class TestEmailCampaign < Chimpmunk::EmailCampaign
+        headers :hero_header, :bottom_header
+        texts :top_body, :info_body
+        images :hero_image, :logo, :test_image
+        associated :many, :posts 		# will have many :email_campaign_posts
+        associated :one, :comment		# will have one :email_campaign_comment
+        
+        #
+        # 	must have a content method 	
+        #
+        def content
+			sections = {}
+			{sections: sections}
+        end
+        
+        rails_admin down
+        	edit do
+        		field :title
+        		field :email_list
+        		field :email_list_group
+        		field :email_template
+        		field :subject
+        		field :from_name
+        		field :from_email
+        		field :send_date
+        		field :hero_header
+        		field :bottom_header
+        		field :top_body
+        		field :info_body
+        		field :hero_image
+        		field :logo
+        		field :test_image
+        	end
+        end
+    end
+```
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/chimpmunk/fork )

data/chimpmunk.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activerecord',  ['>= 3.2', '< 5']
   spec.add_dependency 'gibbon', '>= 1.1'
+  spec.add_dependency 'paperclip', '>= 4.1'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/db/migrate/1_chimpmunk_migration.rb

@@ -90,6 +90,31 @@ class ChimpmunkMigration < ActiveRecord::Migration
       t.integer :email_list_group_id
       t.integer :email_subscriber_id
     end
+
+    create_table :email_campaign_headers do |t|
+      t.references :email_campaign, index: true
+      t.string :text
+      t.string :name
+
+      t.timestamps
+    end
+
+    create_table :email_campaign_texts do |t|
+      t.references :email_campaign, index: true
+      t.text :text
+      t.string :name
+
+      t.timestamps
+    end
+
+    create_table :email_campaign_images do |t|
+      t.references :email_campaign, index: true
+      t.string :name
+
+      t.timestamps
+    end
+
+    add_attachment :email_campaign_images, :image
   end
 
   def self.down
@@ -98,5 +123,10 @@ class ChimpmunkMigration < ActiveRecord::Migration
     drop_table :email_list_groups
     drop_table :email_templates
     drop_table :email_list_groupings
+    drop_table :email_subscribers
+    drop_table :email_list_groups_subscribers
+    drop_table :email_campaign_headers
+    drop_table :email_campaign_texts
+    drop_table :email_campaign_images
   end
 end

data/lib/chimpmunk.rb

@@ -13,6 +13,9 @@ module Chimpmunk
   autoload :EmailListGrouping
   autoload :EmailSubscriber
   autoload :EmailTemplate
+  autoload :EmailCampaignHeader
+  autoload :EmailCampaignText
+  autoload :EmailCampaignImage
   autoload :VERSION
 
   def self.mailchimp

data/lib/chimpmunk/email_campaign.rb

@@ -28,18 +28,51 @@ module Chimpmunk
     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
     ##
 
+    #
+    #   create header associations
+    #
+    def self.headers(*headers)
+      headers.each do |header|
+        has_one header.to_sym, -> { where(name: header.to_s) }, class_name: 'Chimpmunk::EmailCampaignHeader', foreign_key: :email_campaign_id
+        accepts_nested_attributes_for header.to_sym, allow_destroy: true
+      end
+    end
+
+    #
+    #   create text associations
+    #
+    def self.texts(*texts)
+      texts.each do |text|
+        has_one text.to_sym, -> { where(name: text.to_s) }, class_name: 'Chimpmunk::EmailCampaignText', foreign_key: :email_campaign_id
+        accepts_nested_attributes_for text.to_sym, allow_destroy: true
+      end
+    end
+
+    #
+    #   create image associations
+    #
+    def self.images(*images)
+      images.each do |image|
+        has_one image.to_sym, -> { where(name: image.to_s) }, class_name: 'Chimpmunk::EmailCampaignImage', foreign_key: :email_campaign_id
+        accepts_nested_attributes_for image.to_sym, allow_destroy: true
+      end
+    end
+
+    #
+    #   create has_many associations
+    #
+    def self.associated(association_type = :many, *associations)
+      associations.each do |association|
+        association_name = "email_campaign_#{association}".to_sym
+        send("has_#{association_type}", association_name, foreign_key: 'email_campaign_id')
+        accepts_nested_attributes_for association_name, allow_destroy: true
+      end
+    end
+
     ##
     # Refreshes the list of email campaigns
     def self.refresh_email_campaigns
@@ -136,6 +169,13 @@ module Chimpmunk
       end
     end
 
+    ##
+    # TODO: figure out how to do this
+    # returns the html content for the new campaign
+    def content
+      raise "Content must be overriden"
+    end
+
     private
 
     def action_view
@@ -168,7 +208,7 @@ module Chimpmunk
       response = Chimpmunk.mailchimp.campaigns.update(
         cid: self.mailchimp_campaign_id,
         name: "content",
-        value: get_content
+        value: content
       )
 
       !response['errors'].any?
@@ -225,7 +265,7 @@ module Chimpmunk
           template_id: self.email_template.try(:mailchimp_id),
           inline_css: true
         },
-        content: get_content
+        content: content
       }
 
       # list or segment(group)
@@ -254,61 +294,10 @@ module Chimpmunk
       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

data/lib/chimpmunk/email_campaign_header.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module Chimpmunk
+  class EmailCampaignHeader < ::ActiveRecord::Base
+    belongs_to :email_campaign
+
+    private
+
+    rails_admin do
+      visible false
+      edit do
+        field :text do
+          label do
+            bindings[:object].name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chimpmunk/email_campaign_image.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module Chimpmunk
+  class EmailCampaignImage < ::ActiveRecord::Base
+    belongs_to :email_campaign
+    has_attached_file :image, styles: {original: '1000x1000>'}
+    validates_attachment_content_type :image, :content_type => /\Aimage\/.*\Z/
+
+    rails_admin do
+      visible false
+      edit do
+        field :image
+      end
+    end
+  end
+end

data/lib/chimpmunk/email_campaign_text.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module Chimpmunk
+  class EmailCampaignText < ::ActiveRecord::Base
+    belongs_to :email_campaign
+
+    rails_admin do
+      visible false
+      edit do
+        field :text do
+          label do
+            bindings[:object].name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chimpmunk/engine.rb

@@ -1,6 +1,7 @@
 require 'rails'
 require 'rails/engine'
 require 'chimpmunk'
+require 'paperclip'
 
 module Chimpmunk
   class Engine < Rails::Engine

data/lib/chimpmunk/version.rb

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

data/lib/generators/chimpmunk/install_generator.rb

@@ -11,7 +11,9 @@ module Chimpmunk
   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']
+  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', 'Chimpmunk::EmailCampaignHeader', 'Chimpmunk::EmailCampaignText', 'Chimpmunk::EmailCampaignImage']
 
           TEMPLATE
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chimpmunk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nick Franken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -44,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +103,9 @@ files:
 - db/migrate/1_chimpmunk_migration.rb
 - lib/chimpmunk.rb
 - lib/chimpmunk/email_campaign.rb
+- lib/chimpmunk/email_campaign_header.rb
+- lib/chimpmunk/email_campaign_image.rb
+- lib/chimpmunk/email_campaign_text.rb
 - lib/chimpmunk/email_list.rb
 - lib/chimpmunk/email_list_group.rb
 - lib/chimpmunk/email_list_grouping.rb