lettr 1.0.1 → 1.0.2

data/README.md

@@ -1,14 +1,47 @@
 # Lettr
 Deliver your Emails inside your application through the lettr.de API.
 
-## Usage
-There are currently 5 ways of using this gem.
+## Installation
+
+    $ gem install lettr
+
+If you want to use lettr inside a Rails 2.x application just drop the following line into you config/environment.rb
+
+    config.gem 'lettr'
+
+For Rails 3.x or if you use Bundler drop the following line into your Gemfile:
+
+    gem 'lettr'
+
+NOTE: In a Rails 3 Application you currently cant use Delivery Method nor Lettr::Mailer.
+
+## Configuration
+There are some configuration options you can provide either inside config/environment.rb or config/environments/$RAILS_ENV.rb or create an initializer in config/initializers.
+At least you have to provide your lettr login credentials:
+
+    config/environment.rb:
+    config.after_initialize do
+      Lettr.credentials = { :user => 'tea_moe', :pass => 'iwonttellyou' }
+    end
+
+    OR
+
+    config/initializers/lettr.rb
+    Lettr.credentials = { :user => 'tea_moe', :pass => 'iwonttellyou' }
+
+Additional configuration options include:
+    Lettr.protocol
+    Lettr.host
+but for most use cases the defaults are fine, so you dont have to provide them.
+
+## Usage (EMail delivery)
+There are currently several ways of using this gem.
 
 ### Delivery Method
 Just set the Delivery Method of ActionMailer to :lettr, and all Mailings from Action Mailer will be delivered through our API.
 
     config.action_mailer.delivery_method = :lettr
-
+### OR
 ### Lettr::Mailer
 Let your mailer class inherit from Lettr::Mailer instead of ActionMailer::Base.
 
@@ -22,10 +55,12 @@ Let your mailer class inherit from Lettr::Mailer instead of ActionMailer::Base.
       end
     end
 
+### OR
 ### Manual Mailing
 
     Lettr.test_mail(:recipient => 'tg@digineo.de', :subject => 'hi', :test => 'some text', :html => 'some html').deliver
 
+### OR
 ### With templates stored at lettr.de
 
 #### and a hash
@@ -33,6 +68,7 @@ Provide a hash containing the variables, that you used in your template.
 
     Lettr.test_mail(:test => { :variable_1 => 'foo', :variable_2 => 'bar' }).deliver
 
+#### OR
 #### and an object, which responds to :to_nb_hash
 
     class TestClass
@@ -45,6 +81,7 @@ Provide a hash containing the variables, that you used in your template.
 
     Lettr.test_mail(:test => test_object ).deliver
 
+#### OR
 #### automagic
 If your provided object does not respond to :to_nb_hash, Lettr will try to automatically serialize it based on the variables you used inside your template.
 Given the following Class Definition:
@@ -91,4 +128,38 @@ It provides a class-level helper method to allow any instance method in your tem
 
 In this example the call to :variable_1 will be ok, but the call to :variable_2 will raise an Exception.
 
+## Usage (Newsletter Administration)
+
+### Subscribe
+In addition to the EMail delivery functionality this gem provides an easy way to sign your users up for your Newsletters.
+To sign a user up, just call Lettr.sign_up and provide an object which at least responds to an :email method.
+
+    class User < ActiveRecord::Base
+    ...
+      after_create do |user|
+        if user.wants_spam?
+          Lettr.subscribe(user) # calls user.email internally
+        end
+      end
+    ...
+    end
+
+This will create a Recipient in lettr.de. If the provided object responds to:
+
+    :gender
+    :firstname
+    :lastname
+    :street
+    :ccode
+    :pcode
+    :city
+
+these attributes will also get transmitted to lettr.de.
+If your object doesnt respond to these methods, but you want the information in your Recipients database, make the object respond (for example by delegating).
+
+### Unsubscribe
+To unsubscribe a Recipient, just call Lettr.unsubscribe and provide an email-address as argument.
+
+    Lettr.unsubscribe('tea_moe@example.com')
+
 Copyright (c) 2010 Digineo GmbH, released under the MIT license

data/Rakefile

@@ -27,3 +27,16 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc 'Generate HTML Readme'
+task :readme do
+  begin
+    require 'rdiscount'
+    markdown = RDiscount.new(File.read('README.md'))
+    File.open('readme.html', 'w') do |f|
+      f.write markdown.to_html
+    end
+  rescue LoadError
+    'You need eht RDiscount gem'
+  end
+end

data/lib/lettr.rb

@@ -19,7 +19,7 @@ module Lettr
   mattr_accessor :api_mailings
 
   self.attributes ||= %w{ gender firstname lastname street ccode pcode city }
-  self.protocol ||= 'https'
+  self.protocol ||= 'http'
   self.host ||= 'www.newsletterboy.de'
   self.api_mailings = {}
 

data/lib/lettr/action_mailer.rb

@@ -8,15 +8,24 @@ module Lettr::ActionMailer
       lettr_request_hash = {}
       lettr_request_hash[:recipient] = recipient
       lettr_request_hash[:subject] = mail.subject
-      mail.parts.each do |part|
-        case part.content_type
+      if mail.parts.empty?
+        case mail.content_type
         when 'text/html'
-          lettr_request_hash[:html] = part.body
+          lettr_request_hash[:html] = mail.body
         when 'text/plain'
-          lettr_request_hash[:text] = part.body
-        else
-          lettr_request_hash[:attachments] ||= []
-          lettr_request_hash[:attachments] << part.body
+          lettr_request_hash[:text] = mail.body
+        end
+      else
+        mail.parts.each do |part|
+          case part.content_type
+          when 'text/html'
+            lettr_request_hash[:html] = part.body
+          when 'text/plain'
+            lettr_request_hash[:text] = part.body
+          else
+            lettr_request_hash[:attachments] ||= []
+            lettr_request_hash[:attachments] << part.body
+          end
         end
       end
       lettr_request_hashes << lettr_request_hash

data/lib/lettr/api_mailing.rb

@@ -47,6 +47,9 @@ Lettr::ApiMailing = Struct.new(:identifier, :subject, :variables) do
         # object liefert variablen
         @hash.merge!( name => object.to_nb_hash)
       when object.is_a?( String )
+        if name.to_s == 'text' || name.to_s == 'html'
+          raise ArgumentError.new 'You cannot use Delivery Method, Lettr::Mailer or Manual Mailing with existing identifiers.'
+        end
         @files.merge!( name => File.new(object, 'rb'))
       else
         # do magic stuff

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lettr
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Digineo GmbH
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-02 00:00:00 +01:00
+date: 2010-11-04 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency