maktoub 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 783e746011efeeb2bb7251c621e120a21949f1ec
-  data.tar.gz: 07f9f8420d34a1b405fd64f50741b5988ecc470c
+  metadata.gz: a29b4467d0db21c76ebe395bae4f19b081b31239
+  data.tar.gz: f4c29192246487fc3b94d57fbda1a509c0261565
 SHA512:
-  metadata.gz: 7ce54f7aec552fb1ca32f7613cc532705820efa519eb2b98ac7eb635336a02c78c39ce37d87b2590b79854b0e18a52fad25abc96b6d8ce709045993aa0f7af32
-  data.tar.gz: 740af82b19fba46844d0b65fc82588ab257fb1e0aaaed371b6b4b2bea2ddd50f93887f59fffcebdddd4aad4be2ac5a9e331eb5485bba9200e9bb98e5b7e0a8c0
+  metadata.gz: 54dbbf63368a66cb3594e91634fee4adaa9804c9f95134a08ad3fed46560b12bb8bbc555f2c1f9b3333f54a2563fcdfffb71f521f6408fc6566abadb2b0839a5
+  data.tar.gz: 9a9e74eb7a7575769de42eac177c964dc662d8b9689aa23457941e78c3f401c2e181273434982119747dbc2d438397ae5894e248389f30a347d4601f73fc08c0

data/{README.rdoc → README.md}

@@ -1,62 +1,69 @@
-= Maktoub
+# Maktoub
 
 Maktoub is a Ruby on Rails engine for email newsletters.
 * Write your newsletter as you would write any view (erb partial)
 * Maktoub sends your email in multipart as both html and text
 
 
-== Installation
+## Installation
 
+  ```ruby
   # Add this line to your Gemfile
   gem 'maktoub'
+  ```
 
-Then 'bundle install'
+Then `bundle install`
 
-== Compatibility
+## Compatibility
   
 Compatible with Rails 4+. For Rails 3.1+ use version 0.3.1
 
-== Usage
+## Usage
 
-=== Configuration
+### Configuration
 
-You can run 'rails generate maktoub:config' to generate the configuration file. This task creates a matkoub.rb initializer file (in config/initializer)
+You can run `rails generate maktoub:config` to generate the configuration file. This task creates a `matkoub.rb` initializer file (in config/initializer)
 Follow instructions inside the file to configure it the way you want.
 
-=== Authoring
+### Authoring
 
-Create a newsletter as a normal view partial in app/views/maktoub/newsletters/.
+Create a newsletter as a normal view partial in `app/views/maktoub/newsletters/.`
 The subject of the newsletter will be automatically deduced from the partial's name.
 
-=== Editing Styles
+### Editing Styles
 
-Create a view partial in app/views/layouts/maktoub/_styles.erb. Note that this completely overrides the styles that come with maktoub. 
+Create a view partial in `app/views/layouts/maktoub/_styles.erb`. Note that this completely overrides the styles that come with maktoub. 
 You can copy the built-in styles and override them.
 
-=== Sending messages
+### Sending messages
 Maktoub comes with two rake tasks to allow you to:
 * send a test message to the "from" address of your newsletter.
 
+  ```ruby
   rake maktoub:test['name_of_my_newsletter_partial']
+  ```
 
 * publish the newsletter to all your subscribers. If you have delayed_job installed then it will use it to deliver each email as a background job
 
-  rake maktoub:mail['name_of_my_newsletter_parial']
-
+  ```ruby
+   rake maktoub:mail['name_of_my_newsletter_parial']
+  ```
 
 Alternatively you have access to a Maktoub::NewsletterMailer ActionMailer object with a publish method
-  Maktoub::NewsletterMailer.publish('my_newsletter_partial', :name => 'User name', :email => 'user@example.com')
+  ```ruby
+   Maktoub::NewsletterMailer.publish('my_newsletter_partial', name: 'User name', email: 'user@example.com')
+  ```
 
-=== View in browser
+### View in browser
 To be able to view your newsletter in a browser add it to routes.rb.
-  # mount the engine at a path of your choice.
-  # you would access the newsletter at: http://example.com/newsletter/my_awesome_newletter
-  mount Maktoub::Engine => "/"
+  - mount the engine at a path of your choice. e.g. `mount Maktoub::Engine => '/'`
+  - you would access the newsletter at: `http://example.com/<mounted_path>/newsletter/my_awesome_newletter`
+  
 
-== Contributing
+### Contributing
 Send a pull request including documentation changes and tests. 
 
-== To do
+## TODO
 - integrate with TravisCI
 - create github page for project
 - allow management of multiple lists

data/app/controllers/maktoub/application_controller.rb

@@ -1,4 +1,5 @@
 module Maktoub
   class ApplicationController < ActionController::Base
+    protect_from_forgery
   end
 end

data/lib/maktoub/version.rb

@@ -1,4 +1,4 @@
 module Maktoub
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maktoub
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Zaid Zawaideh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -88,7 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - app/assets/javascripts/maktoub/application.js
 - app/assets/javascripts/maktoub/archives.js