campagne 0.1.0 → 0.1.1

data/README.md

@@ -1,21 +1,62 @@
 Campagne
 ========
 
-A simple Rails 3 engine gem to manage and send newsletters.
+Campagne is a simple Rails 3 engine gem. It adds a admin painel (/campagne) to manage and send newsletters, email marketing campaigns, alerts, etc.
 
+Campagne uses resque-scheduler to schedule deliveries.
 
-    Use this on campaign body:
-    
-    ||WB|| - WebBeacon
-    ||UNSUB|| - Unsubscribe
-    ||LINK|| - Link
 
-    # Add to Gemfile
+1) Install redis and run redis-server
+-------------------------------------
+
+[http://redis.io](http://redis.io)
+
+    $ redis-server
+
+
+2) Rails 3 Gem
+--------------
+
+Include it in your Gemfile.
+
     gem 'campagne'
+
+
+Next install it with Bundler.
+
     $ bundle
+
+
+3) Generator
+------------
+
+Run campagne generator.
+
+    $ rails g campagne
+
+Change __config/initializers/campagne.rb__ configs.
+
+
+4) Migration
+------------
+
+Run migration.
+
+    $ rake db:migrate
+
+
+5) Start
+--------
+
+Start Resque workes and resque-scheduler:
+
+    $ rake resque:start_workers
+    $ rake resque:start_scheduler
+
+Now start your application:
+
+    $ rails s
     
-    $ bundle exec rails g campagne
-    # Change config/initializers/campagne.rb
-    
-    $ bundle exec rake db:migrate
+And open:
+
     http://localhost:3000/campagne

data/app/views/campagne/campagne_campaigns/_form.html.erb

@@ -12,6 +12,17 @@
     <%= f.label :body %><br />
     <%= f.text_area :body %>
   </p>
+  <p>
+    <strong>You can use these:</strong><br /><br />
+
+    <strong>||WB||</strong> - <a href="http://www.webopedia.com/TERM/W/Web_beacon.html" target="_blank">Web Beacon</a><br /><br />
+
+    <strong>||UNSUB||</strong> - Unsubscribe link<br />
+    Ex.: &lt;a href="||UNSUB||"&gt;Click here to unsubscribe&lt;/a&gt;<br /><br />
+    
+    <strong>||LINK||</strong> - Link<br />
+    Ex.: &lt;a href="||LINK||http://www.mysite.com/products/1"&gt;Click to buy&lt;/a&gt;
+  </p>
   <p>    
     <%= hidden_field_tag "campagne_campagne_campaign[campagne_list_ids][]", nil%>
     <% Campagne::CampagneList.all.each do |list| %>

data/campagne.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.summary     = "campagne-#{s.version}"
   s.description = "A simple Rails 3 engine gem to manage and send newsletters."
 
-  s.add_dependency "rails", "~> 3.2.3"
+  s.add_dependency "rails", "~> 3.2.0"
   s.add_dependency "mysql2", "~> 0.3.11"
   s.add_dependency "jquery-rails", "~> 2.0.2"
   s.add_dependency "resque", "~> 1.20.0"

data/lib/campagne/version.rb

@@ -1,3 +1,3 @@
 module Campagne
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: campagne
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-06 00:00:00.000000000 Z
+date: 2012-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70298792953180 !ruby/object:Gem::Requirement
+  requirement: &70328982187480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.3
+        version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70298792953180
+  version_requirements: *70328982187480
 - !ruby/object:Gem::Dependency
   name: mysql2
-  requirement: &70298792952640 !ruby/object:Gem::Requirement
+  requirement: &70328982186900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.3.11
   type: :runtime
   prerelease: false
-  version_requirements: *70298792952640
+  version_requirements: *70328982186900
 - !ruby/object:Gem::Dependency
   name: jquery-rails
-  requirement: &70298792952020 !ruby/object:Gem::Requirement
+  requirement: &70328982186420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *70298792952020
+  version_requirements: *70328982186420
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &70298792951440 !ruby/object:Gem::Requirement
+  requirement: &70328982185920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.20.0
   type: :runtime
   prerelease: false
-  version_requirements: *70298792951440
+  version_requirements: *70328982185920
 - !ruby/object:Gem::Dependency
   name: resque-scheduler
-  requirement: &70298792942940 !ruby/object:Gem::Requirement
+  requirement: &70328982185400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 1.9.9
   type: :runtime
   prerelease: false
-  version_requirements: *70298792942940
+  version_requirements: *70328982185400
 description: A simple Rails 3 engine gem to manage and send newsletters.
 email:
 - arleylobato@gmail.com
@@ -134,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1088526778126216247
+      hash: 1663089407589308832
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -143,11 +143,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1088526778126216247
+      hash: 1663089407589308832
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: campagne-0.1.0
+summary: campagne-0.1.1
 test_files: []