emailvision4rails 0.1.0 → 0.1.1

data/Gemfile

@@ -3,12 +3,15 @@ source "http://rubygems.org"
 gem "rails", "3.2.8"
 gem "capybara", ">= 0.4.0"
 gem "sqlite3"
+
 gem "emailvision", "~> 2.1"
 gem "premailer", "~> 1.7"
 gem "hpricot", "~> 0.8"
 
-gem "pry", :group => :development
+group :test do
+  gem "rake" # Required by Travis
+end
 
-# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
-# gem 'ruby-debug'
-# gem 'ruby-debug19'
+group :development do
+  gem "pry"
+end

data/README.markdown

@@ -3,7 +3,7 @@ Emailvision ruby on rails library
 
 Emailvision4rails is a library used to manage messages and campaigns or more simply newsletters from your rails application.
 
-/!\ Not released yet /!\
+[![Build Status](https://secure.travis-ci.org/basgys/emailvision4rails.png)](http://travis-ci.org/basgys/emailvision4rails)
 
 Install
 -------
@@ -29,11 +29,11 @@ Setup
 $ rails generate emailvision4rails:setup
 ```
 
+This will create the following config file : **config/emailvision.yml**
+
 Generator
 ---------
 
-Emailvision4rails is bundled with a newsletter generator.
-
 ```shell
 $ rails generate newsletter standard daily weekly
 	create  app/newsletters/standard_newsletter.rb
@@ -43,156 +43,31 @@ $ rails generate newsletter standard daily weekly
 	create  app/views/standard_newsletter/weekly.text.emv
 ```
 
-Models
-------
-
-Models are ActiveModel compliant
-
-**Campaign**
-
-Attributes
-
-*   **name**
-*   **mailinglist_id**
-*   **message_id**
-*   **send_date**
-*   description
-*   emaildedupflg 
-*   format 
-*   delivery_speed 
-*   notification
-*   post_click_tracking
-*   strategy
-*   target
-*   url_end_campaign
-*   url_host
-*   analytics
-
-*Bold attributes must be present*
-
-Example
-
-```ruby
-campaign = Emailvision4rails::Campaign.new(
-	:name => 'Campaign',
-	:mailinglist_id => 123,
-	:message_id => 123,
-	:send_date => Time.now+30.minutes
-)
-
-if campaign.create
-	# Campaign created
-else
-	campaign.errors
-end
-```
-
-**Message**
-
-Attributes
-
-*   **name**
-*   **subject**
-*   **from**
-*   **from_email**
-*   **body**
-*   **reply_to**
-*   **reply_to_email**
-*   id
-*   create_date
-*   to 
-*   description
-*   encoding
-*   hotmail_unsub_url
-*   type
-*   hotmail_unsub_flg
-*   is_bounceback
-
-*Bold attributes must be present*
+Publication
 
 ```ruby
-message = Emailvision4rails::Message.new(
-	message_content,
-	:name => 'My message',
-	:subject => 'Hello',
-	:from => 'Bastien Gysler', 
-	:from_email => 'basgys@gmail.com',
-	:reply_to => 'Bastien Gysler',
-	:reply_to_email => 'basgys@gmail.com'
-)
-
-if message.create
-	# Message created
-else
-	message.errors
-end
+StandardNewsletter.daily.publish
 ```
 
-Newsletter (Controller)
------------------------
-
-Newsletters work like mailers. These are stored in the *newsletters* directory (/app/newsletters)
-
-**Example**
-
-```shell
-$ rails generate newsletter standard
-```
+Preview
 
 ```ruby
-class StandardNewsletter < Emailvision4rails::AbstractNewsletter
-
-	def daily_fr(params = {})
-		newsletter(
-			:message => default_message_params,
-			:campaign => default_campaign_params.merge(:send_date => Time.now+1.day, :mailinglist_id => 123)
-		)
-	end
-
-	private
-
-	def default_message_params
-		{
-			:name => 'My message',
-			:subject => 'Hello',
-			:from => 'Bastien Gysler', 
-			:from_email => 'basgys@gmail.com',
-			:body => my_body,
-			:reply_to => 'Bastien Gysler',
-			:reply_to_email => 'basgys@gmail.com'
-		}
-	end
-
-	def default_campaign_params
-		{
-			:name => 'Campaign campaign'
-		}
-	end
-
-end
+StandardNewsletter.daily.to_html # or to_text
 ```
 
-```ruby
-StandardNewsletter.daily_fr.publish
-```
+More infos
+----------
 
-Views
------
-
-Views are stored in app/views and are suffixed by _newsletter.
-
-Two formats are available which are html and text and both must be present. Otherwise and ActionView::MissingTemplate error will be raised.
+If you want to dig deeper, Go see our wiki pages.
 
-Template engine that should be used is emv, but others work too.
+Meta
+----
 
-EMV template engine
--------------------
-
-EMV is an engine built on top of ERB, but it also adds CSS inlining for HTML files.
-
-It means you can create your views just like others and EMV will do the dirty work to be "email ready".
+This project uses [Semantic Versioning](http://semver.org/).
 
 Author
 ------
 
-Bastien Gysler :: [bastiengysler.com](http://www.bastiengysler.com/) :: @basgys
+Bastien Gysler :: [bastiengysler.com](http://www.bastiengysler.com/) :: @basgys
+
+[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/29de0b7cb36b0eb1bdd31740b3056f71 "githalytics.com")](http://githalytics.com/basgys/emailvision4rails)

data/Rakefile

@@ -7,7 +7,7 @@ rescue LoadError
 end
 
 require 'rake'
-require 'rake/rdoctask'
+require 'rdoc/task'
 
 require 'rake/testtask'
 

data/lib/emailvision4rails/models/campaign.rb

@@ -25,9 +25,16 @@ class Emailvision4rails::Campaign < Emailvision4rails::Base
 		:send_date
 	)
 
-	validate :send_date_must_be_in_the_future, :message => "must be more than 5 minutes in the future"
+	validates_numericality_of(
+		:mailinglist_id,
+		:message_id
+	)
 
-	# Validate format of email address
+	validate do
+		if send_date.blank? or (send_date < Time.now+5.minutes)
+			errors.add(:send_date, "must be more than 5 minutes in the future")
+		end
+	end	
 
 	def initialize(payload = {})
 		payload.each do |attr, val|
@@ -45,11 +52,4 @@ class Emailvision4rails::Campaign < Emailvision4rails::Base
 			false
 		end
 	end
-
-	private
-
-	def send_date_must_be_in_the_future
-		# Adds 5 minutes to ensure futurness of send date between validation and publication
-		send_date.present? ? (send_date > Time.now+5.minutes) : false
-	end
 end

data/lib/emailvision4rails/premailer.rb

@@ -3,7 +3,7 @@ module Emailvision4rails
     def initialize(html)
       ::Premailer.send(:include, Adapter.find(Adapter.use))
 
-      encoding = Configuration.encoding.upcase
+      encoding = Configuration.encoding.try(:upcase)
       options = {
         :adapter => :hpricot,
         :warn_level => Premailer::Warnings::SAFE,

data/lib/emailvision4rails/version.rb

@@ -1,3 +1,3 @@
 module Emailvision4rails
-  Version = VERSION = '0.1.0'
+  Version = VERSION = '0.1.1'
 end

data/lib/generators/emailvision4rails/setup_generator.rb

@@ -1,5 +1,5 @@
 module Emailvision4rails
-	class Setup < Rails::Generators::Base
+	class SetupGenerator < Rails::Generators::Base
 
 		source_root File.expand_path('../templates', __FILE__)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emailvision4rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-22 00:00:00.000000000 Z
+date: 2012-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails