sr-sinatra-ditties 0.0.2 → 0.0.3

data/README.rdoc

@@ -0,0 +1,28 @@
+= Sinatra Ditties
+
+All those handy tunes in one elegant package.
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2008-2009 {Nicolás Sanguinetti}[http://nicolassanguinetti.info]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/sinatra/ditties.rb

@@ -0,0 +1,12 @@
+require "sinatra/base"
+
+module Sinatra
+  module Ditties
+    def self.version
+      "0.0.2".freeze
+    end
+  end
+
+  autoload :Authorization, File.dirname(__FILE__) + "/ditties/authorization"
+  autoload :Mailer,        File.dirname(__FILE__) + "/ditties/mailer"
+end

data/lib/sinatra/ditties/authorization.rb

@@ -0,0 +1,60 @@
+module Sinatra
+  # HTTP Authorization helpers for Sinatra.
+  #
+  # In your helpers module, include Sinatra::Authorization and then define
+  # an #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/about] 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::Default.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)
+        response["WWW-Authenticate"] = %(Basic realm="#{realm}")
+        throw :halt, [ 401, 'Authorization Required' ]
+      end
+
+      def bad_request!
+        throw :halt, [ 400, 'Bad Request' ]
+      end
+  end
+end

data/lib/sinatra/ditties/mailer.rb

@@ -0,0 +1,145 @@
+# Shamelssly stolen from Merb::Mailer
+# http://merbivore.com
+
+require 'net/smtp'
+require 'mailfactory'
+require 'tlsmail'
+
+Net::SMTP.enable_tls(OpenSSL::SSL::VERIFY_NONE)
+
+class MailFactory
+  attr_reader :html, :text
+end
+
+module Sinatra
+  # = 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[merbivore.com/documentation/1.0/doc/rdoc/merb-mailer-1.0].
+  # 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" # HELO domain provided by the client
+  #  }
+  #
+  # == Using Gmail SMTP
+  #
+  # You need smtp-tls[http://github.com/ambethia/smtp-tls], a gem that improves
+  # Net::HTTP 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[merbivore.com/documentation/1.0/doc/rdoc/merb-mailer-1.0]
+  # so all credit is theirs, I just ported it to Sinatra.
+  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

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: sr-sinatra-ditties
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - "Nicol\xC3\xA1s Sanguinetti"
+- Simon Rozet
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-11-10 00:00:00 -08:00
+date: 2009-02-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,11 +49,11 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README.markdown
-- lib/ditties.rb
-- lib/ditties/authorization.rb
-- lib/ditties/mailer.rb
-has_rdoc: false
+- README.rdoc
+- lib/sinatra/ditties.rb
+- lib/sinatra/ditties/authorization.rb
+- lib/sinatra/ditties/mailer.rb
+has_rdoc: true
 homepage: http://github.com/foca/sinatra-ditties
 post_install_message: 
 rdoc_options: []
@@ -73,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: sinatra-ditties
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2

data/README.markdown

@@ -1,74 +0,0 @@
-Sinatra Ditties
-===============
-
-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