maktoub 0.5.2 → 0.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/{README.rdoc → README.md} +28 -21
- data/app/controllers/maktoub/application_controller.rb +1 -0
- data/lib/maktoub/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a29b4467d0db21c76ebe395bae4f19b081b31239
|
|
4
|
+
data.tar.gz: f4c29192246487fc3b94d57fbda1a509c0261565
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 54dbbf63368a66cb3594e91634fee4adaa9804c9f95134a08ad3fed46560b12bb8bbc555f2c1f9b3333f54a2563fcdfffb71f521f6408fc6566abadb2b0839a5
|
|
7
|
+
data.tar.gz: 9a9e74eb7a7575769de42eac177c964dc662d8b9689aa23457941e78c3f401c2e181273434982119747dbc2d438397ae5894e248389f30a347d4601f73fc08c0
|
data/{README.rdoc → README.md}
RENAMED
|
@@ -1,62 +1,69 @@
|
|
|
1
|
-
|
|
1
|
+
# Maktoub
|
|
2
2
|
|
|
3
3
|
Maktoub is a Ruby on Rails engine for email newsletters.
|
|
4
4
|
* Write your newsletter as you would write any view (erb partial)
|
|
5
5
|
* Maktoub sends your email in multipart as both html and text
|
|
6
6
|
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
## Installation
|
|
9
9
|
|
|
10
|
+
```ruby
|
|
10
11
|
# Add this line to your Gemfile
|
|
11
12
|
gem 'maktoub'
|
|
13
|
+
```
|
|
12
14
|
|
|
13
|
-
Then
|
|
15
|
+
Then `bundle install`
|
|
14
16
|
|
|
15
|
-
|
|
17
|
+
## Compatibility
|
|
16
18
|
|
|
17
19
|
Compatible with Rails 4+. For Rails 3.1+ use version 0.3.1
|
|
18
20
|
|
|
19
|
-
|
|
21
|
+
## Usage
|
|
20
22
|
|
|
21
|
-
|
|
23
|
+
### Configuration
|
|
22
24
|
|
|
23
|
-
You can run
|
|
25
|
+
You can run `rails generate maktoub:config` to generate the configuration file. This task creates a `matkoub.rb` initializer file (in config/initializer)
|
|
24
26
|
Follow instructions inside the file to configure it the way you want.
|
|
25
27
|
|
|
26
|
-
|
|
28
|
+
### Authoring
|
|
27
29
|
|
|
28
|
-
Create a newsletter as a normal view partial in app/views/maktoub/newsletters
|
|
30
|
+
Create a newsletter as a normal view partial in `app/views/maktoub/newsletters/.`
|
|
29
31
|
The subject of the newsletter will be automatically deduced from the partial's name.
|
|
30
32
|
|
|
31
|
-
|
|
33
|
+
### Editing Styles
|
|
32
34
|
|
|
33
|
-
Create a view partial in app/views/layouts/maktoub/_styles.erb
|
|
35
|
+
Create a view partial in `app/views/layouts/maktoub/_styles.erb`. Note that this completely overrides the styles that come with maktoub.
|
|
34
36
|
You can copy the built-in styles and override them.
|
|
35
37
|
|
|
36
|
-
|
|
38
|
+
### Sending messages
|
|
37
39
|
Maktoub comes with two rake tasks to allow you to:
|
|
38
40
|
* send a test message to the "from" address of your newsletter.
|
|
39
41
|
|
|
42
|
+
```ruby
|
|
40
43
|
rake maktoub:test['name_of_my_newsletter_partial']
|
|
44
|
+
```
|
|
41
45
|
|
|
42
46
|
* 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
|
|
43
47
|
|
|
44
|
-
|
|
45
|
-
|
|
48
|
+
```ruby
|
|
49
|
+
rake maktoub:mail['name_of_my_newsletter_parial']
|
|
50
|
+
```
|
|
46
51
|
|
|
47
52
|
Alternatively you have access to a Maktoub::NewsletterMailer ActionMailer object with a publish method
|
|
48
|
-
|
|
53
|
+
```ruby
|
|
54
|
+
Maktoub::NewsletterMailer.publish('my_newsletter_partial', name: 'User name', email: 'user@example.com')
|
|
55
|
+
```
|
|
49
56
|
|
|
50
|
-
|
|
57
|
+
### View in browser
|
|
51
58
|
To be able to view your newsletter in a browser add it to routes.rb.
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
59
|
+
- mount the engine at a path of your choice. e.g. `mount Maktoub::Engine => '/'`
|
|
60
|
+
- you would access the newsletter at: `http://example.com/<mounted_path>/newsletter/my_awesome_newletter`
|
|
61
|
+
|
|
55
62
|
|
|
56
|
-
|
|
63
|
+
### Contributing
|
|
57
64
|
Send a pull request including documentation changes and tests.
|
|
58
65
|
|
|
59
|
-
|
|
66
|
+
## TODO
|
|
60
67
|
- integrate with TravisCI
|
|
61
68
|
- create github page for project
|
|
62
69
|
- allow management of multiple lists
|
data/lib/maktoub/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: maktoub
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.5.
|
|
4
|
+
version: 0.5.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Zaid Zawaideh
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2015-
|
|
12
|
+
date: 2015-07-31 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: rails
|
|
@@ -88,7 +88,7 @@ extensions: []
|
|
|
88
88
|
extra_rdoc_files: []
|
|
89
89
|
files:
|
|
90
90
|
- MIT-LICENSE
|
|
91
|
-
- README.
|
|
91
|
+
- README.md
|
|
92
92
|
- Rakefile
|
|
93
93
|
- app/assets/javascripts/maktoub/application.js
|
|
94
94
|
- app/assets/javascripts/maktoub/archives.js
|