chimpmunk 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d386eba35aefc48e80041d30e14d09a76405b46
-  data.tar.gz: 4666331e2c9a3af08a8dad237f88795ca8004359
+  metadata.gz: f3cdedd77cb163a90c5a283b3c8bb07d24ef9c9c
+  data.tar.gz: 338e3a9c77dddf0fe3b8b0170102fc014e988266
 SHA512:
-  metadata.gz: 9af58d721920b15da3585335185bff6ba724eb2c99ded5204b7d7d55ffaec316cdac28c7957b91c00629c16b692e46f4788fceb0f205db78a042ddf530251645
-  data.tar.gz: 333c516acc181af90045ef63d2a054eb9e64b2cf8037b10eeebaf4d61a122cedcbaaf39162e548e39b2bfb71dcaf491895afb9d36fda92360709f122325a10f4
+  metadata.gz: bf04cb13c4be53c944ce7726bbf5781d9cee7a1e7c82074e907abd8c9490c50de89ae0b4ce493f05c0e79e8daaf2cc644be70e8c9a6b5631195704d16cc44c10
+  data.tar.gz: da88388e5fb6b2b483480c7cb69c0109f838b4802bf5e6721008e0c24d865d3d3c3581da8cf82b12bb9af55c297e10d6feebca592b600ecf053d325e48c6ea2e

data/README.md

@@ -36,28 +36,43 @@ Set your mailchimp api key:
 
 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.
+```
+	headers :hero_header, :bottom_header
+	texts :top_body, :info_body
+	images :hero_image, :logo, :footer_image
+```
 
-4. override the content method, details coming soon
+3. If you need assocations with the email campaign, generate the association models and add the `associated` definition in the campaign.
 
+```
+	associated :many, :posts, :comments
+	associated :one, :user
+```
 
-example:
+4. Create editable_area definitions. These will be the same name as the MC:EDIT areas in your template.  Create the partials for then in `app/viaews/chimpmunk/_posts.html.haml` All chimpmunk partials will have access to a `campaign` local variable.
+
+```
+	editable_areas :posts
+```
 
+example usage:
 
 ```
 	rails g model EmailCampaignPost email_campaign:references post:references
 	rails g model EmailCampaignComment email_campaign:references post:references
+	rails g model EmailCampaignUser email_campaign:references user:references
 ```
 
-
+in `app/models` :
 
 ```
     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
+        associated :many, :posts, :comments 	# will have many :email_campaign_posts
+        associated :one, :user		# will have one :email_campaign_comment
+        editable_areas :posts
         
         #
         # 	must have a content method 	
@@ -67,7 +82,7 @@ example:
 			{sections: sections}
         end
         
-        rails_admin down
+        rails_admin do
         	edit do
         		field :title
         		field :email_list
@@ -88,6 +103,16 @@ example:
         end
     end
 ```
+
+in `app/views/chimpmunk/_posts.html.haml`, you should have an `mc:edit` somewhere in your template called 'posts'
+
+```
+	- campaign.email_campaign_posts.map(&:post).each do |post|
+		.post.span-6
+			%h1= post.name
+			%p= post.body
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/chimpmunk/fork )

data/lib/chimpmunk/email_campaign.rb

@@ -3,6 +3,9 @@ module Chimpmunk
   class EmailCampaign < ::ActiveRecord::Base
     attr_accessor :skip_update_callbacks, :skip_create_callbacks
 
+    # MC:EDIT tags used in email template sections
+    @@mc_edit_tags = []
+
     # 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, 
@@ -62,6 +65,17 @@ module Chimpmunk
       end
     end
 
+    #
+    #   store mc:edit tag names
+    #
+    def self.editable_areas(*mc_edit_tags)
+      @@mc_edit_tags = mc_edit_tags
+    end
+
+    def self.mc_edit_tags
+      @@mc_edit_tags
+    end
+
     #
     #   create has_many associations
     #
@@ -169,14 +183,24 @@ module Chimpmunk
       end
     end
 
-    ##
-    # TODO: figure out how to do this
-    # returns the html content for the new campaign
+    private
+
+    #
+    #   content for campaign
+    #
     def content
-      raise "Content must be overriden"
-    end
+      sections = {}
 
-    private
+      @@tags.each do |tag|
+        directory = "chimpmunk"
+
+        if File.directory?("app/views/#{directory}") && !Dir["app/views/#{directory}/_#{tag}**"].empty?
+          sections[tag] = action_view.render "#{directory}/#{tag}", campaign: self
+        end
+      end
+
+      {sections: sections}
+    end
 
     def action_view
       @action_view ||= ActionView::Base.new(Rails.configuration.paths["app/views"])

data/lib/chimpmunk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chimpmunk
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nick Franken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord