pollter_geist 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05f056b84468423bb3113a3bc2e844e3c3dabb7e
+  data.tar.gz: 78cc138e11dd795c7cc106c81eff536c98117175
+SHA512:
+  metadata.gz: 8c08c5c6b54cd65e0ab5ebff4013fae453f2cccfdb2552091475744cdc421e6f16764c7b5583784f3b5d5758116f6c2779c764783e28dac6804878cf93f7219d
+  data.tar.gz: a1184580b5972401a0e31e18a31015dd1a56c04bc38b250bd0369195963ea5486ce4443ca4c53f1c272cd21d98fabdd273eda21723a57c6341e91feb450836ff

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 kwando
+
+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,29 @@
+# PollterGeist
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pollter_geist'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pollter_geist
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/pollter_geist/imap_commands.rb

@@ -0,0 +1,47 @@
+module PollterGeist
+  class IMAPCommands
+    def initialize imap, logger
+      @imap   = imap
+      @logger = logger
+
+      @idler = ImapIdler.new(self)
+    end
+
+    def select_mailbox mailbox
+      logger.debug("selecting mailbox #{mailbox}")
+      @imap.select(mailbox)
+    end
+
+    # Issues IDLE command for the imap server, it takes a list of events to listen for and returns once one of
+    # events occured or if there was a timeout.
+    #
+    # @param events [events] a list of events to listen for, EXPUNGE, RECENT
+    # @param timeout [Numeric] a timeout, if no event has ocoured for this time
+    # @return will return an object which responds to #success?, #timeout? and #event
+    def wait_for events, timeout = 29*60
+      @idler.idle(events, timeout)
+    end
+
+    def message_uids
+      @logger.debug('fetching uids')
+      # Searching for all messages where TO include @ is a workaround, since the imap#status method
+      # does not work for some reason.
+      message_ids = @imap.search(['TO', '@'])
+      result      = @imap.fetch(message_ids, ['UID'])
+      result.map { |r| r.attr['UID'].to_i }
+    end
+
+    def fetch uids
+      logger.debug "fetching: #{uids}"
+      @imap.uid_fetch(uids, ['RFC822']).map { |r| r.attr['RFC822'] }
+    end
+
+    def logger
+      @logger
+    end
+
+    def imap
+      @imap
+    end
+  end
+end

data/lib/pollter_geist/imap_idler.rb

@@ -0,0 +1,73 @@
+require 'timeout'
+module PollterGeist
+  class ImapIdler
+    class IdleResult
+      def initialize success, event
+        @success = success
+        @event   = event
+      end
+
+      def success?
+        @success
+      end
+
+      def timeout?
+        @event == 'TIMEOUT'
+      end
+
+      def event
+        @event
+      end
+    end
+
+    def initialize poller
+      @imap   = poller.imap
+      @logger = poller.logger
+    end
+
+    def idle listen_for = ['RECENT'], timeout = false
+      begin
+        Timeout::timeout(timeout) do
+          loop do
+            event = do_idle
+            if listen_for.include? event
+              return IdleResult.new(true, event)
+            else
+              logger.debug "nope, we are not listening for #{event}"
+            end
+          end
+        end
+      rescue Timeout::Error
+        imap.idle_done
+        logger.debug 'idle timed out'
+        return IdleResult.new(false, 'TIMEOUT')
+      end
+    end
+
+    private
+    def imap
+      @imap
+    end
+
+    def logger
+      @logger
+    end
+
+    def do_idle
+      event = ''
+      imap.idle do |message|
+        case message
+          when Net::IMAP::UntaggedResponse
+            logger.debug "event: #{message.name}, data: #{message.data}"
+            event = message.name
+            imap.idle_done
+          when Net::IMAP::ContinuationRequest
+            logger.debug 'IDLE accepted by the server'
+          else
+            logger.warn "Unhandled IDLE response: #{message.class}, #{message.inspect}"
+        end
+      end
+      event
+    end
+  end
+end

data/lib/pollter_geist/poller.rb

@@ -0,0 +1,47 @@
+require 'logger'
+require 'net/imap'
+
+module PollterGeist
+  class Poller
+    LOGGER = Logger.new(STDOUT)
+
+    def initialize options
+      @options = options
+    end
+
+    def session &block
+      start(&block)
+    end
+
+    private
+    def start &block
+      logger.debug "connecting to #{@options[:host]}"
+      imap = Net::IMAP.new(@options[:host])
+      logger.debug 'connected to imap server'
+
+      imap.login(@options[:username], @options[:password])
+      logger.debug 'authenticated to the server'
+
+      begin
+        commands = IMAPCommands.new(imap, logger)
+
+        # preselecting mailbox if present in the options
+        commands.select_mailbox(@options[:mailbox]) unless @options[:mailbox].nil?
+
+        # let client code work their magic
+        yield(commands)
+      rescue Exception => e
+        logger.error "#{e.class} : #{e.message} \n #{e.backtrace}"
+        raise e
+      ensure
+        imap.logout
+        logger.debug 'logoff'
+      end
+    end
+
+    private
+    def logger
+      LOGGER
+    end
+  end
+end

data/lib/pollter_geist/version.rb

@@ -0,0 +1,3 @@
+module PollterGeist
+  VERSION = "0.0.1"
+end

data/lib/pollter_geist.rb

@@ -0,0 +1,8 @@
+require "pollter_geist/version"
+
+module PollterGeist
+end
+
+require_relative 'pollter_geist/imap_commands'
+require_relative 'pollter_geist/imap_idler'
+require_relative 'pollter_geist/poller'

data/pollter_geist.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pollter_geist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pollter_geist"
+  spec.version       = PollterGeist::VERSION
+  spec.authors       = ["kwando"]
+  spec.email         = ["kwando@merciless.me"]
+  spec.description   = %q{A small abstraction layer for polling IMAP servers for changes.}
+  spec.summary       = %q{A small abstraction layer for polling IMAP servers for changes.}
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "minitest", "~> 5.0.6"
+  spec.add_development_dependency "rake"
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'pollter_geist'
+require 'minitest/autorun'
+require 'yaml'
+
+# This little dance is needed in order to symbolize keys in the hash
+config = YAML.load_file('config.yml')
+CONFIG = {}
+config.each { |k, v| CONFIG[k.to_sym] = v }
+CONFIG.freeze

data/test/unit/pollter_geist/poller_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+describe PollterGeist::Poller do
+  describe '#session' do
+    it 'should create a session' do
+      poller = PollterGeist::Poller.new(CONFIG)
+      poller.session do |imap|
+        imap.select_mailbox('INBOX')
+        imap.wait_for('RECENT', 1)
+      end
+    end
+  end
+end

data/test/unit/pollter_geist_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+
+describe PollterGeist do
+  it 'should fail' do
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: pollter_geist
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kwando
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-23 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.6
+- !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'
+description: A small abstraction layer for polling IMAP servers for changes.
+email:
+- kwando@merciless.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pollter_geist.rb
+- lib/pollter_geist/imap_commands.rb
+- lib/pollter_geist/imap_idler.rb
+- lib/pollter_geist/poller.rb
+- lib/pollter_geist/version.rb
+- pollter_geist.gemspec
+- test/test_helper.rb
+- test/unit/pollter_geist/poller_test.rb
+- test/unit/pollter_geist_test.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.4
+signing_key: 
+specification_version: 4
+summary: A small abstraction layer for polling IMAP servers for changes.
+test_files:
+- test/test_helper.rb
+- test/unit/pollter_geist/poller_test.rb
+- test/unit/pollter_geist_test.rb