redimap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6246dc5776ca68c0c6585efab3b2d773159282c
+  data.tar.gz: 14115fac7c4380e57dab45124e5d0ba86f253748
+SHA512:
+  metadata.gz: 3a5733f0bc7464b380e4af69a11da7ed2f8566447d8cfafe504a90a0c5af682471c5d45512b72579958be2acfdbe892693b3156639426479af145be5bec84992
+  data.tar.gz: b419f72c2753d896a335bbc6cb1130aec81c655df347733c59a5d146f8e81fdba52a2b318c8ae2014cef3eded26158e1368a1753910f1fed04187f49b89b8ec2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+redimap

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redimap.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 tiredpixel
+
+MIT License
+
+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/README.md

@@ -0,0 +1,55 @@
+# Redimap
+
+Redimap provides a simple executable for polling mailboxes
+within an IMAP account. It keeps track of what it's seen using Redis. For new
+messages, the mailbox and uid are queued in Redis. The format used should be
+compatible with Resque.
+
+More sleep lost by [tiredpixel](http://www.tiredpixel.com).
+
+
+## Installation
+
+Install using:
+
+    $ gem install redimap
+
+
+## Usage
+
+Ensure that you are setting the required environment variables, perhaps using
+Foreman. You'll probably want to at least set:
+
+    IMAP_HOST=imap.gmail.com
+    IMAP_USERNAME=username@example.com
+    IMAP_PASSWORD=ssssshhhhhhh
+    IMAP_MAILBOXES=["INBOX","Sent"]
+
+Check and queue new messages and quit:
+
+    $ bundle exec redimap
+
+Check and queue new messages but run for eternity using crude polling:
+
+    $ bundle exec redimap 1
+
+
+## Contributions
+
+Contributions are embraced with much love and affection! Please fork the
+repository and wizard your magic, ensuring that any tests are not broken by the
+changes. Then send a pull request. Simples! If you'd like to discuss what you're
+doing or planning to do, or if you get stuck on something, then just wave. :)
+
+Do whatever makes you happy. We'll probably still like you. :)
+
+## Blessing
+
+May you find peace, and help others to do likewise.
+
+
+## Licence
+
+© [tiredpixel](http://www.tiredpixel.com) 2013. It is free software, released
+under the MIT License, and may be redistributed under the terms specified in
+`LICENSE`.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/redimap

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/redimap')
+
+
+running = true
+
+while running
+  Redimap.read_mailboxes
+  
+  if ARGV[0].to_i == 1 # Oh so crude.
+    sleep Redimap.config.polling_interval # Sleep awhile.
+  else
+    running = false
+  end
+end

data/lib/redimap/config.rb

@@ -0,0 +1,36 @@
+require 'json'
+
+
+module Redimap
+  class Config
+    
+    attr_reader :imap_host
+    attr_reader :imap_port
+    attr_reader :imap_username
+    attr_reader :imap_password
+    
+    attr_reader :imap_mailboxes
+    
+    attr_reader :redis_url
+    attr_reader :redis_ns_redimap
+    attr_reader :redis_ns_queue
+    
+    attr_reader :polling_interval
+    
+    def initialize
+      @imap_host     = ENV['IMAP_HOST']
+      @imap_port     = ENV['IMAP_PORT']     || 993
+      @imap_username = ENV['IMAP_USERNAME']
+      @imap_password = ENV['IMAP_PASSWORD']
+      
+      @imap_mailboxes = JSON.parse(ENV['IMAP_MAILBOXES'] || '["INBOX"]')
+      
+      @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"
+      
+      @polling_interval = ENV['POLLING_INTERVAL'].to_i || 60
+    end
+    
+  end
+end

data/lib/redimap/core.rb

@@ -0,0 +1,29 @@
+module Redimap
+  
+  def self.config
+    @config ||= Redimap::Config.new
+  end
+  
+  def self.configure
+    yield config if block_given?
+  end
+  
+  def self.read_mailboxes
+    Redimap::ImapConn.new do |imap|
+      Redimap::RedisConn.new do |redis|
+        Redimap.config.imap_mailboxes.each do |mailbox|
+          last_seen_uid = redis.get_mailbox_uid(mailbox)
+          
+          unseen_uids = imap.read_mailbox(mailbox, last_seen_uid)
+          
+          unseen_uids.each do |uid|
+            redis.queue_mailbox_uid(mailbox, uid)
+            
+            redis.set_mailbox_uid(mailbox, uid)
+          end
+        end
+      end
+    end
+  end
+  
+end

data/lib/redimap/imap_conn.rb

@@ -0,0 +1,43 @@
+require 'net/imap'
+
+
+module Redimap
+  class ImapConn
+    
+    attr_accessor :imap
+    
+    def initialize
+      @imap = Net::IMAP.new(Redimap.config.imap_host, {
+        :port => Redimap.config.imap_port,
+        :ssl  => true
+      })
+      
+      if @imap
+        @imap.login(Redimap.config.imap_username, Redimap.config.imap_password)
+      end
+      
+      if block_given?
+        yield self
+        
+        close
+      end
+    end
+    
+    def close
+      if @imap
+        @imap.logout
+        
+        @imap.disconnect
+      end
+    end
+    
+    def read_mailbox(mailbox = "INBOX", last_seen_uid = 0)
+      @imap.select(mailbox)
+      
+      uids = @imap.uid_search("#{last_seen_uid + 1}:*")
+      
+      uids.find_all { |uid| uid > last_seen_uid } # IMAP search gets fun with edge cases.
+    end
+    
+  end
+end

data/lib/redimap/redis_conn.rb

@@ -0,0 +1,62 @@
+require 'redis'
+require 'json'
+
+
+module Redimap
+  class RedisConn
+    
+    QUEUE_QUEUE = 'redimap'
+    QUEUE_CLASS = 'RedimapJob'
+    
+    attr_accessor :redis
+    
+    def initialize
+      @redis = Redis.connect(:url => Redimap.config.redis_url)
+      
+      if block_given?
+        yield self
+        
+        close
+      end
+    end
+    
+    def close
+      if @redis
+        @redis.quit
+      end
+    end
+    
+    def get_mailbox_uid(mailbox)
+      @redis.hget(
+        "#{Redimap.config.redis_ns_redimap}:mailboxes",
+        mailbox
+      ).to_i # Also handles nil.
+    end
+    
+    def set_mailbox_uid(mailbox, uid)
+      @redis.hset(
+        "#{Redimap.config.redis_ns_redimap}:mailboxes",
+        mailbox,
+        uid
+      )
+    end
+    
+    def queue_mailbox_uid(mailbox, uid)
+      @redis.sadd(
+        "#{Redimap.config.redis_ns_queue}:queues",
+        QUEUE_QUEUE
+      )
+      
+      payload = {
+        :class => QUEUE_CLASS,
+        :args  => [mailbox, uid]
+      }.to_json
+      
+      @redis.rpush(
+        "#{Redimap.config.redis_ns_queue}:queue:#{QUEUE_QUEUE}",
+        payload
+      )
+    end
+    
+  end
+end

data/lib/redimap/version.rb

@@ -0,0 +1,5 @@
+module Redimap
+  
+  VERSION = "0.1.0"
+  
+end

data/lib/redimap.rb

@@ -0,0 +1,4 @@
+require_relative 'redimap/config'
+require_relative 'redimap/core'
+require_relative 'redimap/imap_conn'
+require_relative 'redimap/redis_conn'

data/redimap.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require './lib/redimap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redimap"
+  spec.version       = Redimap::VERSION
+  spec.authors       = ["tiredpixel"]
+  spec.email         = ["tp@tiredpixel.com"]
+  spec.description   = %q{Redimap provides a simple executable for polling mailboxes
+    within an IMAP account. It keeps track of what it's seen using Redis. For new
+    messages, the mailbox and uid are queued in Redis. The format used should be
+    compatible with Resque.}
+  spec.summary       = %q{Redimap polls IMAP account mailboxes and queues in Redis.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+  
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "redis", "~> 3.0.3"
+  
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/lib/redimap/config_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Redimap::Config do
+  
+  context "Defaults" do
+    before(:each) do
+      ENV.stub(:[])
+      
+      @config = Redimap::Config.new
+    end
+    
+    it "imap_port should default to 993" do
+      @config.imap_port.should == 993
+    end
+    
+    it "imap_mailboxes should default to [INBOX]" do
+      @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"
+    end
+    
+    it "redis_ns_redimap should default to redimap" do
+      @config.redis_ns_redimap.should == "redimap"
+    end
+    
+    it "redis_ns_queue should default to resque" do
+      @config.redis_ns_queue.should == "resque"
+    end
+    
+    it "redis_ns_queue should default to 60 seconds" do
+      @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
+    end
+    
+    it "imap_host should get set from IMAP_HOST" do
+      @config.imap_host.should == "imap.carrot.localhost"
+    end
+    
+    it "imap_port should get set from IMAP_PORT" do
+      @config.imap_port.should == 666
+    end
+    
+    it "imap_username should get set from IMAP_USERNAME" do
+      @config.imap_username.should == "Pachelbel"
+    end
+    
+    it "imap_password should get set from IMAP_PASSWORD" do
+      @config.imap_password.should == "Canon"
+    end
+    
+    it "imap_mailboxes should get set from IMAP_MAILBOXES" do
+      @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"
+    end
+    
+    it "redis_ns_redimap should get set from REDIS_NS_REDIMAP" do
+      @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"
+    end
+    
+    it "polling_interval should get set from POLLING_INTERVAL" do
+      @config.polling_interval.should == 300
+    end
+  end
+  
+end

data/spec/lib/redimap/core_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Redimap do
+  
+  context "Constants" do
+    it "VERSION should be like major.minor.patch" do
+      Redimap::VERSION.should =~ /\A\d+\.\d+\.\d+\z/
+    end
+  end
+  
+end

data/spec/lib/redimap/imap_conn_spec.rb

@@ -0,0 +1,49 @@
+require 'net/imap'
+
+require 'spec_helper'
+
+describe Redimap::ImapConn do
+  
+  before(:each) do
+    @fake_net_imap = double(Net::IMAP)
+    
+    Net::IMAP.stub(:new).and_return(@fake_net_imap)
+    
+    @fake_net_imap.stub(:login)
+  end
+  
+  context "#initialize" do
+    it "should set imap as Net::IMAP" do
+      Redimap::ImapConn.new.imap.should == @fake_net_imap
+    end
+    
+    it "should #close when block" do
+      Redimap::ImapConn.new do |imap|
+        imap.should_receive(:close)
+      end
+    end
+  end
+  
+  context "#close" do
+    before(:each) do
+      @imap = Redimap::ImapConn.new
+    end
+    
+    it "should disconnect from IMAP" do
+      @imap.imap.stub(:logout)
+      
+      @imap.imap.should_receive(:disconnect)
+      
+      @imap.close
+    end
+    
+    it "should logout from IMAP" do
+      @imap.imap.stub(:disconnect)
+      
+      @imap.imap.should_receive(:logout)
+      
+      @imap.close
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec/autorun'
+
+require File.expand_path("../../lib/redimap.rb", __FILE__)
+
+Dir[File.join("../../spec/support/**/*.rb")].each { |f| require f }
+
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: redimap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tiredpixel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Redimap provides a simple executable for polling mailboxes
+      within an IMAP account. It keeps track of what it's seen using Redis. For new
+      messages, the mailbox and uid are queued in Redis. The format used should be
+      compatible with Resque.
+email:
+- tp@tiredpixel.com
+executables:
+- redimap
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/redimap
+- lib/redimap.rb
+- lib/redimap/config.rb
+- lib/redimap/core.rb
+- lib/redimap/imap_conn.rb
+- lib/redimap/redis_conn.rb
+- lib/redimap/version.rb
+- redimap.gemspec
+- spec/lib/redimap/config_spec.rb
+- spec/lib/redimap/core_spec.rb
+- spec/lib/redimap/imap_conn_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Redimap polls IMAP account mailboxes and queues in Redis.
+test_files:
+- spec/lib/redimap/config_spec.rb
+- spec/lib/redimap/core_spec.rb
+- spec/lib/redimap/imap_conn_spec.rb
+- spec/spec_helper.rb