redimap 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f66ce4ef01d017b2f398fd4c5dea85f590623675
-  data.tar.gz: c78b41faf48bf785ee65264d26863cc86416a439
+  metadata.gz: 8ba76df09385c366a60e9b398d4b4609a26aa651
+  data.tar.gz: 7c513536095b241ea1614e84efb333c26845bc4f
 SHA512:
-  metadata.gz: 55bb403a6af33ac2c787a41724b8f4d3a03e766d0a8026ee0785a7df3a647337bf52a3fd2d05414a36f318fe249044018cea80dc58b49b135f2730721ad0e823
-  data.tar.gz: 547e2b9b42784d7f5055ee7ebf578ed90bf24ddb05c99e21389e47cb7355184236d0b3347db58cf83df8996ed74fa81da30ee590bbd30a1eacdb04d1fb67ea9b
+  metadata.gz: e9d01fb5a28bba8e1df681f42708550e7af1d76ff1ebafd15a8ee77f4af14220e149e8427f5f0b29f9d183023fa95caf259d9d475fbf0c182817a0c2ee478583
+  data.tar.gz: 0da97e1f2f3328fdbec7d8cb4b678c3ef01a25a5249fc289dc5d5cd0ffc72ecc19d34935f2ff7f76742a15e969412aec33ba1b28c95b8ea323b43b541406f399

data/README.md

@@ -18,21 +18,17 @@ Install using:
 
 ## Usage
 
-Ensure that you are setting the required environment variables, perhaps using
-Foreman. You'll probably want to at least set:
+View the available options:
 
-    IMAP_HOST=imap.gmail.com
-    IMAP_USERNAME=username@example.com
-    IMAP_PASSWORD=ssssshhhhhhh
-    IMAP_MAILBOXES=["INBOX","Sent"]
+    $ bundle exec redimap --help
 
-Check and queue new messages and quit:
+Most settings have defaults, but it is necessary to at least set up IMAP.
 
-    $ bundle exec redimap
+Check and queue new messages and quit:
 
-Check and queue new messages but run for eternity:
+    $ bundle exec redimap --host mail.example.com --user a@example.com --password helpimacarrot
 
-    $ bundle exec redimap --eternal
+Use `--eternal` to run eternally.
 
 
 ## Contributions

data/bin/redimap

@@ -6,8 +6,6 @@ require 'optparse'
 
 require File.expand_path(File.dirname(__FILE__) + '/../lib/redimap')
 
-@logger = Redimap.logger
-
 
 # = Parse opts
 
@@ -16,12 +14,96 @@ options = {}
 OptionParser.new do |opts|
   opts.banner = "Usage: redimap [options]"
   
-  opts.on("-e", "--eternal", "Run eternally") do |e|
-    options[:eternal] = true
+  opts.separator ""
+  opts.separator "Polling:"
+  
+  opts.on("-e", "--[no-]eternal", "Run eternally") do |o|
+    options[:eternal] = o
+  end
+  
+  opts.on("--polling-interval [N]", "Poll every N seconds when --eternal") do |o|
+    options[:polling_interval] = o
+  end
+  
+  opts.separator ""
+  opts.separator "IMAP:"
+  
+  opts.on("-h", "--imap-host HOST", "Connect IMAP with HOST") do |o|
+    options[:imap_host] = o
+  end
+  
+  opts.on("--imap-port [PORT]", Integer, "Connect IMAP with PORT") do |o|
+    options[:imap_port] = o
+  end
+  
+  opts.on("-u", "--imap-username USERNAME", "Connect IMAP with USERNAME") do |o|
+    options[:imap_username] = o
+  end
+  
+  opts.on("-p", "--imap-password PASSWORD", "Connect IMAP with PASSWORD") do |o|
+    options[:imap_password] = o
+  end
+  
+  opts.on("--imap-mailboxes [INBOX,IN]", Array, "Read IMAP MAILBOXES") do |o|
+    options[:imap_mailboxes] = o
+  end
+  
+  opts.separator ""
+  opts.separator "Redis:"
+  
+  opts.on("--redis-url [URL]", "Connect Redis to URL") do |o|
+    options[:redis_url] = o
+  end
+  
+  opts.on("--redis-ns-redimap [NS]", "Namespace Redis 'redimap:' as NS") do |o|
+    options[:redis_ns_redimap] = o
+  end
+  
+  opts.on("--redis-ns-queue [NS]", "Namespace Redis 'resque:' as NS") do |o|
+    options[:redis_ns_queue] = o
+  end
+  
+  opts.separator ""
+  opts.separator "Other:"
+  
+  opts.on("-v", "--[no-]verbose", "Be somewhat verbose") do |o|
+    options[:verbose] = o
+  end
+  
+  opts.on_tail("--help", "Show this message") do
+    puts opts
+    exit
+  end
+  
+  opts.on_tail("--version", "Show version") do
+    puts "Redimap version:#{Redimap::VERSION}"
+    exit
   end
 end.parse!
 
 
+# = Configure
+
+Redimap.configure do |c|
+  c.log_level = 'DEBUG' if options[:verbose]
+  
+  c.imap_host     = options[:imap_host]     if options[:imap_host]
+  c.imap_port     = options[:imap_port]     if options[:imap_port]
+  c.imap_username = options[:imap_username] if options[:imap_username]
+  c.imap_password = options[:imap_password] if options[:imap_password]
+  
+  c.imap_mailboxes = options[:imap_mailboxes] if options[:imap_mailboxes]
+  
+  c.redis_url        = options[:redis_url]        if options[:redis_url]
+  c.redis_ns_redimap = options[:redis_ns_redimap] if options[:redis_ns_redimap]
+  c.redis_ns_queue   = options[:redis_ns_queue]   if options[:redis_ns_queue]
+  
+  c.polling_interval = options[:polling_interval] if options[:polling_interval]
+end
+
+@logger = Redimap.logger
+
+
 # = Main loop
 
 loop do

data/lib/redimap/base.rb

@@ -9,13 +9,15 @@ module Redimap
   
   def self.configure
     yield self.config
+    
+    Redimap.logger.debug { "Configured #{Redimap.config.to_s}" }
   end
   
   def self.logger
     unless @logger
       @logger = Logger.new($stdout)
       
-      @logger.level    = Logger.const_get(ENV['LOG_LEVEL'] || 'INFO')
+      @logger.level    = Logger.const_get(Redimap.config.log_level)
       @logger.progname = :Redimap
     end
     

data/lib/redimap/config.rb

@@ -4,6 +4,8 @@ require 'json'
 module Redimap
   class Config
     
+    attr_accessor :log_level
+    
     attr_accessor :imap_host
     attr_accessor :imap_port
     attr_accessor :imap_username
@@ -18,26 +20,23 @@ module Redimap
     attr_accessor :polling_interval
     
     def initialize
-      @logger = Redimap.logger
-      
-      @imap_host     = ENV['IMAP_HOST']
-      @imap_port     = ENV['IMAP_PORT']     || 993
-      @imap_username = ENV['IMAP_USERNAME']
-      @imap_password = ENV['IMAP_PASSWORD']
+      @log_level = 'INFO'
       
-      @imap_mailboxes = JSON.parse(ENV['IMAP_MAILBOXES'] || '["INBOX"]')
+      @imap_port = 993
       
-      @redis_url        = ENV['REDIS_URL']        || "redis://127.0.0.1:6379/0"
-      @redis_ns_redimap = ENV['REDIS_NS_REDIMAP'] || "redimap"
-      @redis_ns_queue   = ENV['REDIS_NS_QUEUE']   || "resque"
+      @imap_mailboxes = ['INBOX']
       
-      @polling_interval = (ENV['POLLING_INTERVAL'] || 60).to_i
+      @redis_url        = 'redis://127.0.0.1:6379/0'
+      @redis_ns_redimap = 'redimap'
+      @redis_ns_queue   = 'resque'
       
-      @logger.debug { "Initialized #{to_s}" }
+      @polling_interval = 60
     end
     
     def to_s
       {
+        :log_level => @log_level,
+        
         :imap_host     => @imap_host,
         :imap_port     => @imap_port,
         :imap_username => @imap_username,

data/lib/redimap/version.rb

@@ -1,5 +1,5 @@
 module Redimap
   
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
   
 end

data/lib/redimap.rb

@@ -1,3 +1,4 @@
+require_relative 'redimap/version'
 require_relative 'redimap/config'
 require_relative 'redimap/base'
 require_relative 'redimap/imap_conn'

data/spec/lib/redimap/config_spec.rb

@@ -4,86 +4,93 @@ require 'spec_helper'
 describe Redimap::Config do
   
   context "Defaults" do
-    before(:each) do
-      ENV.stub(:[])
-      
-      @config = Redimap::Config.new
+    it "log_level should default to INFO" do
+      Redimap.config.log_level.should == "INFO"
     end
     
     it "imap_port should default to 993" do
-      @config.imap_port.should == 993
+      Redimap.config.imap_port.should == 993
     end
     
     it "imap_mailboxes should default to [INBOX]" do
-      @config.imap_mailboxes.should == ['INBOX']
+      Redimap.config.imap_mailboxes.should == ['INBOX']
     end
     
     it "redis_url should default to redis://127.0.0.1:6379/0" do
-      @config.redis_url.should == "redis://127.0.0.1:6379/0"
+      Redimap.config.redis_url.should == "redis://127.0.0.1:6379/0"
     end
     
     it "redis_ns_redimap should default to redimap" do
-      @config.redis_ns_redimap.should == "redimap"
+      Redimap.config.redis_ns_redimap.should == "redimap"
     end
     
     it "redis_ns_queue should default to resque" do
-      @config.redis_ns_queue.should == "resque"
+      Redimap.config.redis_ns_queue.should == "resque"
     end
     
     it "polling_interval should default to 60 seconds" do
-      @config.polling_interval.should == 60
+      Redimap.config.polling_interval.should == 60
     end
   end
   
   context "Non-defaults" do
     before(:each) do
-      ENV.stub(:[]).with("IMAP_HOST").and_return("imap.carrot.localhost")
-      ENV.stub(:[]).with("IMAP_PORT").and_return(666)
-      ENV.stub(:[]).with("IMAP_USERNAME").and_return("Pachelbel")
-      ENV.stub(:[]).with("IMAP_PASSWORD").and_return("Canon")
-      ENV.stub(:[]).with("IMAP_MAILBOXES").and_return('["INBOX","SENT"]')
-      ENV.stub(:[]).with("REDIS_URL").and_return("redis://127.0.0.1:6379/1")
-      ENV.stub(:[]).with("REDIS_NS_REDIMAP").and_return("brekyread")
-      ENV.stub(:[]).with("REDIS_NS_QUEUE").and_return("sidekiq")
-      ENV.stub(:[]).with("POLLING_INTERVAL").and_return(300)
-      
-      @config = Redimap::Config.new
+      Redimap.configure do |c|
+        c.log_level = "WARN"
+        
+        c.imap_host     = "imap.carrot.localhost"
+        c.imap_port     = 666
+        c.imap_username = "Pachelbel"
+        c.imap_password = "Canon"
+        
+        c.imap_mailboxes = ['INBOX', 'SENT']
+        
+        c.redis_url        = "redis://127.0.0.1:6379/1"
+        c.redis_ns_redimap = "brekyread"
+        c.redis_ns_queue   = "sidekiq"
+        
+        c.polling_interval = 300
+      end
+    end
+    
+    it "log_level should get set" do
+      Redimap.config.log_level.should == "WARN"
     end
     
-    it "imap_host should get set from IMAP_HOST" do
-      @config.imap_host.should == "imap.carrot.localhost"
+    it "imap_host should get set" do
+      Redimap.config.imap_host.should == "imap.carrot.localhost"
     end
     
-    it "imap_port should get set from IMAP_PORT" do
-      @config.imap_port.should == 666
+    it "imap_port should get set" do
+      Redimap.config.imap_port.should == 666
     end
     
-    it "imap_username should get set from IMAP_USERNAME" do
-      @config.imap_username.should == "Pachelbel"
+    it "imap_username should get set" do
+      Redimap.config.imap_username.should == "Pachelbel"
     end
     
-    it "imap_password should get set from IMAP_PASSWORD" do
-      @config.imap_password.should == "Canon"
+    it "imap_password should get set" do
+      Redimap.config.imap_password.should == "Canon"
     end
     
-    it "imap_mailboxes should get set from IMAP_MAILBOXES" do
-      @config.imap_mailboxes.should == ['INBOX', 'SENT']
+    it "imap_mailboxes should get set" do
+      Redimap.config.imap_mailboxes.should == ['INBOX', 'SENT']
     end
     
-    it "redis_url should get set from REDIS_URL" do
-      @config.redis_url.should == "redis://127.0.0.1:6379/1"
+    it "redis_url should get set" do
+      Redimap.config.redis_url.should == "redis://127.0.0.1:6379/1"
     end
     
-    it "redis_ns_redimap should get set from REDIS_NS_REDIMAP" do
-      @config.redis_ns_redimap.should == "brekyread"
+    it "redis_ns_redimap should get set" do
+      Redimap.config.redis_ns_redimap.should == "brekyread"
     end
     
-    it "redis_ns_queue should get set from REDIS_NS_QUEUE" do
-      @config.redis_ns_queue.should == "sidekiq"
+    it "redis_ns_queue should get set" do
+      Redimap.config.redis_ns_queue.should == "sidekiq"
     end
     
-    it "polling_interval should get set from POLLING_INTERVAL" do
-      @config.polling_interval.should == 300
+    it "polling_interval should get set" do
+      Redimap.config.polling_interval.should == 300
     end
   end
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redimap
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - tiredpixel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-22 00:00:00.000000000 Z
+date: 2013-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis