luggage 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbf6c643e587287b8d3df07c913163c0c9b56c89
-  data.tar.gz: d7bd6e2bf725860cf8392469f2ca1195358f9863
+  metadata.gz: e5b8e6299a00d76b3bc1eb4ed219c2baea76d4c6
+  data.tar.gz: 836c4a9c74f7588a6c561ac1264ce6c568859afc
 SHA512:
-  metadata.gz: c6e39c9d15b0980de7e56c3df266bde5180388b114d145b01b26d66de2b129cde2e019e88dd0bbf3e0557a6b4fb8dce83ddd7fc0759ba88d2733785f68978264
-  data.tar.gz: c070bbb000e6ed0654240cc40c41e015317d6625a07e1c89515ed932770b46b3f74f94c0f29e007087385f940a1d204ceeb5e816a3a2d792c12a726fbf385397
+  metadata.gz: 6659b895e186f99a30049b9daeab543cb0f7b9f060b0ed22d8255bad2fb37234fddc89d4b8039a7d1d5c1a05459bf81154dba66290a69bbd0572ad2d7bd5d544
+  data.tar.gz: d87f9515631498aa341f1c378169e9590fd174fedcc07daadb648e08dd9450869a40ff0329e24d30340f4c026f161e065363c3e4b7b6e1b8b81e58d4b04044e0

data/CHANGES.md

@@ -0,0 +1,9 @@
+#Changes
+
+## 1.1.0
+
+* Added `:login` authentication method to `Luggage.new`. - Ben Hamill
+
+## 1.0.0
+
+* Initial release. - Ryan Michael & Eric Pinzur

data/README.md

@@ -18,8 +18,8 @@ That was easy, right?
 
 ## Before we get started...
 
-Many of the following examples use a DSL/block style syntax.  Most of the object 
-initializers accept a block and do an `instance_eval` on the new object 
+Many of the following examples use a DSL/block style syntax.  Most of the object
+initializers accept a block and do an `instance_eval` on the new object
 if a block is passed.  These three examples are equivalent:
 
 ``` ruby
@@ -61,31 +61,43 @@ f = Luggage.new(:connection => connection)
 
 Keep in mind that the connection needs to be authenticated
 
-### Using an authentication string
+### Using XOauth
 
-`Net::IMAP` natively supports `LOGIN` and `CRAM-MD5` authentication schemes,
-if you want to use either of these you can pass in `:server` and `:authenticate`, 
-the contents of `:authenticate` will be passed to `Net::IMAP#authenticate`.  
+Google has implemented XOauth for their IMAP connections.  To use this pass in
+`:server` as before and a token as `:xoauth`
 
 ``` ruby
-f = Luggage.new(:server => 'imap.aol.com', :authenticate => 'LOGIN user password')
-f = Luggage.new(:server => ['imap.aol.com' 993, true], :authenticate => 'LOGIN user password')
+f = Luggage.new(:server => ['imap.gmail.com', 993, true], :xoauth => token)
 ```
 
-Notice that the value of `:server` will be passed to `Net::IMAP#new`, so the full
-syntax of the initializer is available.  See [the Ruby docs](http://rubydoc.info/stdlib/net/Net/IMAP)
-for more details on auth and intialization
+See the documentation for you service provider for details on generating that token.
 
-### Using XOauth
+### Using LOGIN
 
-Google has implemented XOauth for their IMAP connections.  To use this pass in
-`:server` as before and a token as `:xoauth`
+Many IMAP servers support the `LOGIN` command, which `Net::IMAP` exposes with
+its [`#login`
+method](http://rubydoc.info/stdlib/net/Net/IMAP#login-instance_method). Whatever
+you put in the `:login` key, Luggage will pass to `Net::IMAP#login`.
 
 ``` ruby
-f = Luggage.new(:server => ['imap.gmail.com', 993, true], :xoauth => token)
+f = Luggage.new(:server => 'imap.aol.com', :login => %w(username password))
 ```
 
-See the documentation for you service provider for details on generating that token.
+### Using an authentication string
+
+If you want to do something different, you can pass in `:server` and
+`:authenticate`. The contents of the `:authenticate` key will be passed to along
+`Net::IMAP#authenticate`.
+
+``` ruby
+f = Luggage.new(:server => 'imap.aol.com', :authenticate => %w(COMMAND arg1 arg2))
+f = Luggage.new(:server => ['imap.aol.com' 993, true], :authenticate => %w(COMMAND arg1 arg2))
+```
+
+Notice that the value of `:server` will be passed to `Net::IMAP#new`, so the
+full syntax of the initializer is available.  See [the Net::IMAP
+docs](http://rubydoc.info/stdlib/net/Net/IMAP) for more details on
+authentication and intialization.
 
 
 ## Working with mailboxes
@@ -134,12 +146,12 @@ Luggage.new(:connection => c) do
 end
 ```
 
-Querying works somewhat like ActiveRecord scopes, in that you can chain calls to `where` 
+Querying works somewhat like ActiveRecord scopes, in that you can chain calls to `where`
 to build up a compound query, which is only executed once you attempt to inspect the results.
 Keep in mind that compound queries are generated by appending each key/value pair into
 big string and sending it to the IMAP server - this isn't SQL
 
-Messages are retrieved somewhat lazily.  The `Message-ID` and `uid` fields are always fetched, 
+Messages are retrieved somewhat lazily.  The `Message-ID` and `uid` fields are always fetched,
 but the full body isn't fetched until you try to access a field like `subject` or `body`.
 You can inspect retrieved messages using the same syntax as the [Mail](https://github.com/mikel/mail)
 gem, for instance:
@@ -172,27 +184,27 @@ See the next section for more details on that `Luggage#message` method...
 
 ## Working with messages
 
-`Luggage#message` and `Mailbox#message` provide interfaces for creating messages.  
+`Luggage#message` and `Mailbox#message` provide interfaces for creating messages.
 
 * If you pass in a `:template` argument, the message will be created using the contents
-of the file at that path.  
-* If you pass an array as `:flags`, the passed flags will be set for the message when 
+of the file at that path.
+* If you pass an array as `:flags`, the passed flags will be set for the message when
 it's uploaded to the remote server.
 * A date can be passed as `:date` and will be used as the recieved-at date when the message
-is uploaded.  
-* Any other arguments will be interpreted as properties to be set on the new message.  
+is uploaded.
+* Any other arguments will be interpreted as properties to be set on the new message.
 These will be set after the template is read (if provided), allowing
-you to tweak the templates if needed. 
+you to tweak the templates if needed.
 
 If using the `Luggage` version, a mailbox must be specified as the first argument.
 
 ``` ruby
 Luggage.new(:connection => c) do
   message("INBOX", :template => 'path/to/email.eml').save!
-  
+
   mailboxes "INBOX" do
     message(:template => 'path/to/email.eml').save!
-  
+
     message(:template => 'path/to/email.eml', :subject => "Custom subject").save!
     message do
       subject "Howdy"

data/lib/luggage/factory.rb

@@ -4,31 +4,41 @@ module Luggage
 
     # Factory
     #
-    # Factories require an instance of Net::IMAP.  Serveral methods are supported:
+    # Factories require an instance of Net::IMAP. Serveral methods are supported:
     #
     # Factory.new(:connection => connection)
-    # In this case, `connection` should be an authorized Net::IMAP instance
+    # In this case, `connection` should be an authorized Net::IMAP instance.
     #
-    # Factory.new(:server => "imap.example.com", :authentication => "LOGIN username password")
-    # In this case, we'll build a Net::IMAP instance and attempt to authenticate with the
-    # value of `authentication`.  Net::IMAP supports LOGIN and CRAM-MD5 natively - see below
-    # for xoauth
+    # Factory.new(:server => "imap.gmail.com", :xoauth => [token, string])
+    # In this case we'll build a Net::IMAP instance and attempt to send a raw
+    # XOAUTH authentication request using the supplied token.
     #
-    # Factory.new(:server => "imap.gmail.com", :xoauth => "xoauth token string")
-    # In this case we'll build a Net::IMAP instance and attempt to send a raw XOAUTH authentication
-    # request using the supplied token.
+    # Factory.new(:server => 'imap.example.com', :login => [username, password])
+    # In this case, we'll build a Net::IMAP instance and use the `#login` method
+    # to authenticate. This isn't the same as using 'LOGIN' as the auth method
+    # in the next example.
     #
+    # Factory.new(:server => "imap.example.com", :authentication => [some_auth_method, appropriate, arguments])
+    # In this case, we'll build a Net::IMAP instance and attempt to authenticate
+    # with the value of `:authentication` by calling `Net::IMAP#authenticate`.
     def initialize(args = {}, &block)
       if args.has_key?(:connection)
         @connection = args[:connection]
-      elsif args.has_key?(:server) && args.has_key?(:authenticate)
-        @connection = Net::IMAP.new(*Array(args[:server]))
-        @connection.authenticate(*args[:authenticate])
+
       elsif args.has_key?(:server) && args.has_key?(:xoauth)
         @connection = Net::IMAP.new(*Array(args[:server]))
-        @connection.send(:send_command, "AUTHENTICATE XOAUTH #{args[:xoauth]}")
+        @connection.authenticate('XOAUTH', *Array(args[:xoauth]))
+
+      elsif args.has_key?(:server) && args.has_key?(:login)
+        @connection = Net::IMAP.new(*Array(args[:server]))
+        @connection.login(*Array(args[:login]))
+
+      elsif args.has_key?(:server) && args.has_key?(:authenticate)
+        @connection = Net::IMAP.new(*Array(args[:server]))
+        @connection.authenticate(*Array(args[:authenticate]))
+
       else
-        raise ArgumentError, "Imap Connection required."
+        raise ArgumentError, 'Imap Connection required.'
       end
 
       instance_eval &block if block_given?

data/lib/luggage/version.rb

@@ -1,3 +1,3 @@
 module Luggage
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: luggage
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ryan Michael
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -146,7 +146,7 @@ files:
 - .document
 - .gitignore
 - .rspec
-- ChangeLog.rdoc
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md

data/ChangeLog.rdoc

@@ -1,4 +0,0 @@
-=== 0.1.0 / 2012-12-03
-
-* Initial release:
-