better_opener 0.0.1 → 0.1.0

data/README.md

@@ -0,0 +1,90 @@
+BetterOpener
+=============
+
+Preview mails and other notifications in your browser instead of actually
+sending them out. Inspired by and similar in terms of functionality to the
+[LetterOpener][1] and the [MailView][2] gem BetterOpener tries to be *better*
+by:
+
+- providing support for outgoing notifications in general (email, sms so far)
+- supporting pre- and on-demand rendering
+- allowing remote access to notifications (helpful on staging servers and remote development machines)
+- displaying desktop notifications (with the accompanying chrome plugin)
+
+
+Setup
+-----
+
+Add the gem to your development environment and run the `bundle install` command to install it.
+
+    gem "better_opener", :group => :development
+
+Then in Rails3 mount the bundled Sinatra app inline in your `routes.rb`:
+
+    if Rails.env == "development"
+      mount BetterOpener::Server => "/notifications"
+    end
+
+To prevent messages from actually being sent you need to set up email and/or sms interception.
+
+### Email
+
+Set the delivery method in `config/environments/development.rb`
+
+    config.action_mailer.delivery_method = :better_opener
+
+The design of the email interface is taken from the [mail_view][2] plugin.
+
+
+### SMS
+
+SMS message support is provided for the [sms_gateway][3] gem.
+Edit your `sms_gateway.yml` file:
+
+    development:
+      adapter: better_opener
+      from: your_app
+
+SMS interface:
+
+![SMS as displayed by the sinatra app](https://github.com/learnjin/better-opener/raw/master/sms.jpg)
+
+
+On-request Rendering
+-------------------
+
+The messages that are being sent with one of the above delivery methods are
+static (pre-rendered at time of delivery). To preview your changes without
+going through all the steps to redeliver the message use the
+`add_delayed_notification` method like that:
+
+    class Emailer < ActionMailer::Base
+    
+     # ....
+
+      def self.deliver_later(method, *params)
+        if Rails.env == "development"
+          BetterOpener.add_delayed_notification("email", Emailer, method, params)
+        else
+          Resque.enqueue(EmailJob, method, *params)
+        end
+      end
+
+    end
+
+
+Chrome Plugin
+-------------
+
+To get actual desktop notifications, you will want to install the accompanying
+[chrome-plugin][4].  Point it to the (full) notification path that you mounted
+this gem on.
+
+![Chrome Notifications](https://github.com/learnjin/better-opener/raw/master/notifications.png)
+
+[1]: https://github.com/ryanb/letter_opener
+[2]: https://github.com/37signals/mail_view
+[3]: https://github.com/learnjin/sms-gateway 
+[4]: https://github.com/learnjin/better-opener-chrome
+
+

data/better_opener.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = BetterOpener::VERSION
   s.authors     = ["Kai Rubarth"]
   s.email       = ["kai@doxter.de"]
-  s.homepage    = "http://github.com/learnjin/better_opener"
+  s.homepage    = "https://github.com/learnjin/better-opener"
   s.summary     = %q{A better way of Previewing mail in your browser instead of sending it.}
   s.description = %q{When mails or messages are sent from your application, Better Opener lets you preview the rendered messages in your browser instead of delivering them.}
 
@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_dependency "dm-sqlite-adapter"
   s.add_dependency "tilt"
   s.add_dependency "haml"
-
+  s.add_dependency "multi_json"
 end
 
 

data/lib/better_opener.rb

@@ -10,12 +10,21 @@ module BetterOpener
   class Notification
     include DataMapper::Resource
     property :id, Serial
-    property :subject, String
-    property :body, Text
     property :created_at, DateTime 
-    property :category, String
+    property :subject, String, :length => 255
+    property :summary, String
+
+    property :category, String # influences rendering
+
+    property :klass, String
+    property :method, String
+    property :params, String
+
+    property :rendered, Boolean, :default => false
+    property :body, Text
   end
 
+
   extend self
 
   def db=(server)
@@ -40,7 +49,23 @@ module BetterOpener
 
   def add_notification(category, subject, body)
     db
-    n = BetterOpener::Notification.new :category => category, :subject => subject, :body => body, :created_at => Time.now
+    n = BetterOpener::Notification.new(:category => category,
+                                       :subject => subject,
+                                       :body => body,
+                                       :created_at => Time.now,
+                                       :rendered => true)
+    n.save
+  end
+
+  def add_delayed_notification(category, klass, method, params)
+    db
+
+    n = BetterOpener::Notification.new(:category => category,
+                                       :subject => method,
+                                       :klass => klass.name,
+                                       :method => method,
+                                       :params => BetterOpener.encode(params),
+                                       :created_at => Time.now)
     n.save
   end
 
@@ -77,6 +102,27 @@ module BetterOpener
   end
 
 
+  def encode(params)
+    MultiJson.encode(params)
+  end
+
+  def decode(params)
+    MultiJson.decode(params)
+  end
+
+  def render_notification(n, format = nil)
+    return n.body if n.rendered 
+    klass = Kernel.const_get(n.klass.classify)
+    if n.category == "email"
+      m = klass.send(n.method, *BetterOpener.decode(n.params))
+      BetterOpener.render_email(n.id, m, format)
+    elsif n.category == "sms"
+      m = klass.send(n.method, *BetterOpener.decode(n.params))
+      BetterOpener.render_sms(n.id, m)
+    end
+  end
+
+
 end
 
 require 'better_opener/delivery_method'

data/lib/better_opener/email.html.erb

@@ -79,6 +79,7 @@
       <% end %>
     </p>
   <% end %>
+
 </div>
 
 <% if body_part.content_type && body_part.content_type.match(/text\/html/) %>

data/lib/better_opener/server.rb

@@ -44,9 +44,13 @@ module BetterOpener
       redirect u('/') 
     end
 
-    get "/:id" do
-      @message = BetterOpener.get_notification(params[:id])
-      @message.body 
+    get %r{/(\d+)(.*)} do
+      #@message = BetterOpener.get_notification(params[:id])
+      #@message.body 
+      id = params[:captures].first
+      format = params[:captures].second
+      @message = BetterOpener.get_notification(id)
+      BetterOpener.render_notification(@message, format)
     end
 
     get "/feed/atom", :provides => [:atom] do

data/lib/better_opener/server/views/index.haml

@@ -5,7 +5,7 @@
 %ul
   - for m in @messages
     %li
-      = m.category + ": "
+      = (m.rendered ? "pre. ": "enq. ") + m.category + ": "
       %em
         %a{:href => u("/#{m.id}") }= m.subject
 

data/lib/better_opener/sms.html.erb

@@ -86,6 +86,9 @@ div.outcome {
     <dt>Date:</dt>
     <dd><%= Time.now.strftime("%b %e, %Y %I:%M:%S %p %Z") %></dd>
 
+    <dt>Length:</dt>
+    <dd><%= sms.text.length %></dd>
+
   </dl>
 
 </div>

data/lib/better_opener/version.rb

@@ -1,3 +1,3 @@
 module BetterOpener
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: better_opener
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kai Rubarth
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-02 00:00:00 Z
+date: 2012-03-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sinatra-contrib
@@ -88,6 +88,20 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
 description: When mails or messages are sent from your application, Better Opener lets you preview the rendered messages in your browser instead of delivering them.
 email: 
 - kai@doxter.de
@@ -100,7 +114,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - better_opener.gemspec
 - config.ru
@@ -111,12 +125,13 @@ files:
 - lib/better_opener/server.rb
 - lib/better_opener/server/views/atom.haml
 - lib/better_opener/server/views/index.haml
-- lib/better_opener/server/views/show.haml
 - lib/better_opener/sms.html.erb
 - lib/better_opener/sms_gateway_adapter.rb
 - lib/better_opener/version.rb
 - lib/test.ru
-homepage: http://github.com/learnjin/better_opener
+- notifications.png
+- sms.jpg
+homepage: https://github.com/learnjin/better-opener
 licenses: []
 
 post_install_message: 

data/README.rdoc

@@ -1,34 +0,0 @@
-= Better Opener
-
-Preview mails and other notifications (sms for instance) in your browser
-instead of actually sending them out. Inspired and almost similar to the 
-Letter Opener by Ryan Bates Better Opener this gem tries to be *better* by being 
-more universal and displaying desktop notifications (with the chrome plugin).
-
-== Setup
-
-Add the gem to your development environment and run the <tt>bundle install</tt> command to install it.
-
-    gem "better_opener", :group => :development
-
-Set the delivery method in <tt>config/environments/development.rb</tt>
-
-    config.action_mailer.delivery_method = :letter_opener
-
-Finally install the bundled Sinatra app as a subdirectory of your app by editing your <tt>config.ru</tt>:
-
-    map "/notification" do
-      run BetterOpener::Server
-    end
-
-
-
-==  Chrome Plugin
-
-To take full advantage and get actual notifications, you will want to install
-the accompanying chrome plugin.  Just point it to the notification address you
-set up above.
-
-
-
-

data/lib/better_opener/server/views/show.haml

@@ -1,4 +0,0 @@
-%h1= @message.subject
-%h2= @message.category
-%p= @message.body
-