sr-sinatra-diddies 0.0.1

data/README.markdown

@@ -0,0 +1,74 @@
+Sinatra Diddies
+===============
+
+All those handy tunes in one elegant package.
+
+Sinatra::Mailer
+===============
+
+Adds an `email` method to your email handlers, that receives a hash of values
+to create your email.
+
+For example:
+
+    post "/signup" do
+      # sign up the user, and then:
+      email :to      => @user.email, 
+            :from    => "awesomeness@example.com", 
+            :subject => "Welcome to Awesomeness!",
+            :body    => haml(:some_template)
+    end
+
+Configuration
+=============
+
+This plugin is very dirty yet :) Since it's just a port to Sinatra of
+[Merb::Mailer][merb-mailer]. So the configuration is not Sinatra-y, yet.
+But we'll get to that. 
+
+Using SMTP
+----------
+
+    Sinatra::Mailer.config = {
+      :host   => 'smtp.yourserver.com',
+      :port   => '25',
+      :user   => 'user',
+      :pass   => 'pass',
+      :auth   => :plain # :plain, :login, :cram_md5, the default is no auth
+      :domain => "localhost.localdomain" # the HELO domain provided by the client to the server
+    }
+
+Using Gmail SMTP
+----------------
+
+You need [smtp-tls][], a gem that improves `net/smtp` to add support for secure
+servers such as Gmail.
+
+    require "smtp-tls"
+    
+    Sinatra::Mailer.config = {
+      :host => 'smtp.gmail.com',
+      :port => '587',
+      :user => 'user@gmail.com',
+      :pass => 'pass',
+      :auth => :plain
+    }
+    
+Make sure that when you call your `email` method you pass the `:text` option 
+and not `:body`.
+
+Using sendmail
+--------------
+
+    Sinatra::Mailer.config = {:sendmail_path => '/somewhere/odd'}
+    Sinatra::Mailer.delivery_method = :sendmail
+
+Credits
+=======
+
+This has been blatantly adapted from [Merb::Mailer][merb-mailer], so all credit
+is theirs, I just ported it to [Sinatra][].
+
+[merb-mailer]: http://github.com/wycats/merb-more/tree/master/merb-mailer
+[smtp-tls]: http://github.com/ambethia/smtp-tls/tree/master
+[Sinatra]: http://sinatrarb.com

data/lib/diddies.rb

@@ -0,0 +1,2 @@
+# Let's get all those diddies playing together
+Dir[File.dirname(__FILE__) + "/diddies/*.rb"].each &method(:require)

data/lib/diddies/authorization.rb

@@ -0,0 +1,61 @@
+module Sinatra
+  # HTTP Authorization helpers for Sinatra.
+  #
+  # In your helpers module, include Sinatra::Authorization and then define
+  # a +authorize(user, password)+ method to handle user provided
+  # credentials.
+  # 
+  # Inside your events, call +login_required+ to trigger the HTTP 
+  # Authorization window to pop up in the browser.
+  #
+  # Code adapted from Ryan Tomayko <http://tomayko.com> and Christopher 
+  # Schneid <http://gittr.com>, shared under an MIT License  
+  module Authorization
+    # Redefine this method on your helpers block to actually contain
+    # your authorization logic.
+    def authorize(username, password)
+      false
+    end
+
+    # From you app, call set :authorization_realm, "my app" to set this
+    # or define a `authorization_realm` method in your helpers block.
+    def authorization_realm
+      Sinatra.options.authorization_realm
+    end
+
+    # Call in any event that requires authentication
+    def login_required
+      return if authorized?
+      unauthorized! unless auth.provided?
+      bad_request! unless auth.basic?
+      unauthorized! unless authorize(*auth.credentials)
+      request.env['REMOTE_USER'] = auth.username
+    end
+
+    # Convenience method to determine if a user is logged in
+    def authorized?
+      !!request.env['REMOTE_USER']
+    end
+    alias :logged_in? :authorized?
+
+    # Name provided by the current user to log in
+    def current_user
+      request.env['REMOTE_USER']
+    end
+
+    private
+
+      def auth
+        @auth ||= Rack::Auth::Basic::Request.new(request.env)
+      end
+
+      def unauthorized!(realm=authorization_realm)
+        header 'WWW-Authenticate' => %(Basic realm="#{realm}")
+        throw :halt, [ 401, 'Authorization Required' ]
+      end
+
+      def bad_request!
+        throw :halt, [ 400, 'Bad Request' ]
+      end
+  end
+end

data/lib/diddies/mailer.rb

@@ -0,0 +1,107 @@
+# Shamelssly stolen from Merb::Mailer
+# http://merbivore.com
+
+require 'net/smtp'
+require 'rubygems'
+require 'mailfactory'
+
+class MailFactory
+  attr_reader :html, :text
+end
+
+module Sinatra
+  # You'll need a simple config like this in your configure block if you want
+  # to actually send mail:
+  #
+  #   Sinatra::Mailer.config = {
+  #     :host   => 'smtp.yourserver.com',
+  #     :port   => '25',              
+  #     :user   => 'user',
+  #     :pass   => 'pass',
+  #     :auth   => :plain # :plain, :login, :cram_md5, the default is no auth
+  #     :domain => "localhost.localdomain" # the HELO domain provided by the client to the server 
+  #   }
+  # 
+ 	#   or 
+ 	# 
+ 	#   Sinatra::Mailer.config = {:sendmail_path => '/somewhere/odd'}
+  #   Sinatra::Mailer.delivery_method = :sendmail
+  #
+  # From your event handlers then, you can just call the 'email' method to deliver an email:
+  # 
+  #   email :to => 'foo@bar.com',
+  #         :from => 'bar@foo.com',
+  #         :subject => 'Welcome to whatever!',
+  #         :body => haml(:sometemplate)
+  #
+  module Mailer
+    class << self
+      attr_accessor :config, :delivery_method
+    end
+    
+    def email(mail_options={})
+      Email.new(mail_options).deliver!
+    end
+
+    class Email
+      attr_accessor :mail, :config
+
+      # Sends the mail using sendmail.
+      def sendmail
+        sendmail = IO.popen("#{config[:sendmail_path]} #{@mail.to}", 'w+') 
+        sendmail.puts @mail.to_s
+        sendmail.close
+      end
+
+      # Sends the mail using SMTP.
+      def net_smtp
+        Net::SMTP.start(config[:host], config[:port].to_i, config[:domain], 
+                        config[:user], config[:pass], config[:auth]) { |smtp|
+          smtp.send_message(@mail.to_s, @mail.from.first, @mail.to.to_s.split(/[,;]/))
+        }
+      end
+
+      # Delivers the mail with the specified delivery method, defaulting to
+      # net_smtp.
+      def deliver!
+        send(Mailer.delivery_method || :net_smtp)
+      end
+
+      # ==== Parameters
+      # file_or_files<File, Array[File]>:: File(s) to attach.
+      # filename<String>::
+      # type<~to_s>::
+      #   The attachment MIME type. If left out, it will be determined from
+      #   file_or_files.
+      # headers<String, Array>:: Additional attachment headers.
+      #
+      # ==== Raises
+      # ArgumentError::
+      #   file_or_files was not a File or an Array of File instances.
+      def attach(file_or_files, filename = file_or_files.is_a?(File) ? File.basename(file_or_files.path) : nil, 
+        type = nil, headers = nil)
+        if file_or_files.is_a?(Array)
+          file_or_files.each {|k,v| @mail.add_attachment_as k, *v}
+        else
+          raise ArgumentError, "You did not pass in a file. Instead, you sent a #{file_or_files.class}" if !file_or_files.is_a?(File)
+          @mail.add_attachment_as(file_or_files, filename, type, headers)
+        end
+      end
+
+      # ==== Parameters
+      # o<Hash{~to_s => Object}>:: Configuration commands to send to MailFactory.
+      def initialize(o={})
+        self.config = Mailer.config || {:sendmail_path => '/usr/sbin/sendmail'}
+        o[:rawhtml] = o.delete(:html)
+        m = MailFactory.new()
+        o.each { |k,v| m.send "#{k}=", v }
+        @mail = m
+      end
+
+    end
+  end
+  
+  class EventContext
+    include Mailer
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: sr-sinatra-diddies
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Nicol\xC3\xA1s Sanguinetti"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-09 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mailfactory
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: A series of plugins and useful helpers for the Sinatra web framework
+email: contacto@nicolassanguinetti.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- lib/diddies.rb
+- lib/diddies/authorization.rb
+- lib/diddies/mailer.rb
+has_rdoc: false
+homepage: http://github.com/foca/sinatra-diddies
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A series of plugins and useful helpers for the Sinatra web framework
+test_files: []
+