clacks 1.0.8 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cae5d5384bf905e8ca6db28a491f9153dbd3e727
-  data.tar.gz: 7b880a7fb41ec635cb6d5b274b58cf838d63775f
+  metadata.gz: 4c26bb094d7008dbb5094d22439e3fc55c75a375
+  data.tar.gz: b6f54e2f8b485168c67b41b1fc0f5689c9e1e046
 SHA512:
-  metadata.gz: 2bfa18bc65bea84f77e8a7796a98b6ce050b397d41d1868c13e425f869b106d38b75d618cd947a90c0c7f837a4c95da9231fa2bb35e74fe4ff3b6c8bf64653f8
-  data.tar.gz: cf42e7f1c182a824c16351a5a33fc818e89209d6b16db4015a93fa9c58cf5c50649476ccca20d54067c60d8f05e9b36b0afdf44d6d66cce42f5ed5369b0822eb
+  metadata.gz: d8c93393c43b4a7d19e0829efc1d83e1feecb478e1c34884d178c7bf02a304fa8bb60b3596b2cb7ca35f3d055eb4056763d874ccaca3d7a02f5e24c14e7c62ac
+  data.tar.gz: 9b102599520b751e9be9093f0ba6c61d2647e6ef3c90a67c95175b9c7c6db6401dfd7c5798ddda0a3894aa2a50f65bf1fe9f5950963668159c09fe2a9a912a16

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 ITRP (http://developer.itrp.com)
+Copyright (c) 2013-2016 ITRP (http://developer.itrp.com)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,4 +1,4 @@
-# Clacks 
+# Clacks
 
 [![Build Status](https://secure.travis-ci.org/itrp/clacks.png)](http://travis-ci.org/itrp/clacks?branch=master)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/itrp/clacks)
@@ -21,7 +21,6 @@ If you use Rails, add this to your Gemfile:
 Then create a configuration file, using ruby syntax, such as:
 
 ``` ruby
-# -*- encoding: binary -*-
 # Configuration of clacks
 # See Clacks::Configurator for documentation on options
 #
@@ -85,20 +84,14 @@ See the [contrib](https://github.com/itrp/clacks/tree/master/contrib/) directory
 Signals
 -------
 
-* INT/TERM - quick shutdown, kills the process immediately.
+* KILL - quick shutdown, kills the process immediately.
 
-* QUIT - graceful shutdown, waits for the worker process to finish processing an email.
+* TERM/QUIT/INT - graceful shutdown, waits for the worker process to finish processing an email.
 
 * USR1 - reopen logs
 
 
-Author
-----------
-
-ITRP, mathijs.sterk@itrp.com, [developer.itrp.com](http://developer.itrp.com)
-
-
 Copyright
 -----------
 
-Copyright (c) 2013 ITRP. See MIT-LICENSE for details.
+Copyright (c) 2013-2016 ITRP. See MIT-LICENSE for details.

data/clacks.gemspec

@@ -1,31 +1,30 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "clacks/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'clacks/version'
 
 Gem::Specification.new do |s|
   s.name = %q{clacks}
   s.version = Clacks::VERSION
   s.platform = Gem::Platform::RUBY
-  s.authors = ["ITRP"]
-  s.email = %q{mathijs.sterk@itrp.com}
+  s.authors = ['ITRP']
+  s.email = %q{developer@itrp.com}
   s.license = 'MIT'
-  s.homepage = %q{http://github.com/itrp/clacks}
+  s.homepage = %q{https://github.com/itrp/clacks}
   s.summary = %q{Clacks system for receiving emails}
   s.description = %q{Clacks system for receiving emails to be processed in ruby}
-  s.date = Time.now.utc.strftime("%Y-%m-%d")
-  s.files = Dir.glob("lib/**/*") + [
-     "MIT-LICENSE",
-     "README.md",
-     "Gemfile",
-     "clacks.gemspec"
+  s.date = Time.now.utc.strftime('%Y-%m-%d')
+  s.files = Dir.glob('lib/**/*') + [
+     'MIT-LICENSE',
+     'README.md',
+     'Gemfile',
+     'clacks.gemspec'
   ]
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ['lib']
+  s.rdoc_options = ['--charset=UTF-8']
   s.add_dependency('mail')
-  s.add_development_dependency "rake"
-  # s.add_development_dependency "rcov"
-  s.add_development_dependency "rspec"
+  s.add_development_dependency 'rake'
+  # s.add_development_dependency 'rcov'
+  s.add_development_dependency 'rspec'
 end
 

data/lib/clacks/command.rb

@@ -1,4 +1,3 @@
-# -*- encoding: binary -*-
 module Clacks
   class Command
     require 'optparse'
@@ -7,7 +6,7 @@ module Clacks
     PROC_ARGV = ARGV.map { |a| a.dup }
 
     def initialize(args)
-      @options = { :config_file => "config/clacks.rb" }
+      @options = { config_file: 'config/clacks.rb' }
 
       opts = OptionParser.new do |opts|
         opts.banner = "Usage: #{PROC_NAME} [options]"
@@ -73,7 +72,7 @@ module Clacks
       reopen_io($stderr, config[:stderr_path])
 
       unless config[:pid]
-        config.pid(@options[:pid] || (defined?(Rails) && Rails.version =~ /^2/ ? 'tmp/pids/clacks.pid' : 'clacks.pid'))
+        config.pid(@options[:pid] || 'clacks.pid')
       end
       pid = config[:pid]
       if wpid = running?(pid)
@@ -152,11 +151,11 @@ module Clacks
     end
 
     def setup_signal_handling
-      stop_signal = (Signal.list.keys & ['QUIT', 'INT']).first
-      Signal.trap(stop_signal) do
-        Thread.new { Clacks.logger.info 'QUIT signal received. Shutting down gracefully.' }
+      graceful_exit_signal = (Signal.list.keys & ['INT', 'QUIT', 'TERM']).sort.last
+      Signal.trap(graceful_exit_signal) do
+        Thread.new { Clacks.logger.info 'Exiting...' }
         @service.stop if @service
-      end unless stop_signal.nil?
+      end unless graceful_exit_signal.nil?
 
       Signal.trap('USR1') do
         Thread.new { Clacks.logger.info 'USR1 signal received. Rotating logs.' }

data/lib/clacks/configurator.rb

@@ -1,4 +1,3 @@
-# -*- encoding: binary -*-
 module Clacks
   class Configurator
     require 'logger'

data/lib/clacks/service.rb

@@ -1,4 +1,3 @@
-# -*- encoding: binary -*-
 module Clacks
   class Service
     # TODO: find the root cause and remove workaround below, @see http://stackoverflow.com/a/16007377/3774613

data/lib/clacks/version.rb

@@ -1,4 +1,3 @@
-# -*- encoding: binary -*-
 module Clacks
-  VERSION = '1.0.8'
+  VERSION = '1.1.0'
 end

data/lib/clacks.rb

@@ -1,4 +1,3 @@
-# -*- encoding: binary -*-
 module Clacks
   require 'clacks/version'
   require 'clacks/configurator'

data/spec/command_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Clacks::Command do
+
+end

data/spec/configurator_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe Clacks::Configurator do
+
+  it "has defaults" do
+    config = Clacks::Configurator.new
+    expect(config[:poll_interval]).to eq(60)
+    expect(config[:pid]).to be_nil
+    expect(config[:stdout_path]).to be_nil
+    expect(config[:stderr_path]).to be_nil
+    config[:on_mail].call(Mail.new(from: 'foo@example.com', subject: 'foo'))
+    last_log_line = `tail -n 1 /tmp/clacks.log`
+    expect(last_log_line).to include('Mail from foo@example.com, subject: foo')
+  end
+
+  it "has invalid config" do
+    tmp = Tempfile.new('clacks.config')
+    tmp.syswrite(%[foo "hello-world"])
+    expect { Clacks::Configurator.new(tmp.path) }.to raise_error(NoMethodError)
+  end
+
+  it "has non-existent config" do
+    tmp = Tempfile.new('clacks.config')
+    path = tmp.path
+    tmp.close!
+    expect { Clacks::Configurator.new(path) }.to raise_error(Errno::ENOENT)
+  end
+
+  context 'on_mail proc' do
+    it "should test for arity of the on_mail proc" do
+      tmp = Tempfile.new('clacks.config')
+      tmp.syswrite(%[on_mail{|x,y|x+y}])
+      expect { Clacks::Configurator.new(tmp.path) }.to raise_error(ArgumentError, /on_mail=.* has invalid arity: 2 \(need 1\)/)
+    end
+
+    it "should configure the on_mail hook" do
+      tmp = Tempfile.new('clacks.config')
+      tmp.syswrite(%[on_mail{|mail|mail+1}])
+      expect(Clacks::Configurator.new(tmp.path)[:on_mail].call(5)).to eq(6)
+    end
+  end
+
+  context 'after_initialize proc' do
+    it "should test for arity of the after_initialize proc" do
+      tmp = Tempfile.new('clacks.config')
+      tmp.syswrite(%[after_initialize{|x,y|x+y}])
+      expect { Clacks::Configurator.new(tmp.path) }.to raise_error(ArgumentError, /after_initialize=.* has invalid arity: 2 \(need 0\)/)
+    end
+
+    it "should configure the after_initialize hook" do
+      tmp = Tempfile.new('clacks.config')
+      tmp.syswrite(%[after_initialize { 42 }])
+      expect(Clacks::Configurator.new(tmp.path)[:after_initialize].call).to eq(42)
+    end
+  end
+
+end

data/spec/service_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Clacks::Service do
+
+  it "should ensure utf7 conversion for mailbox names" do
+    Mail::IMAP.new({})
+    allow(Net::IMAP).to receive(:encode_utf7).with('INBOX').and_return('UTF7_INBOX')
+    allow(Net::IMAP).to receive(:encode_utf7).with('ARCHIVE').and_return('ARCHIVE_INBOX')
+    options = Clacks::Service.new.send(:imap_validate_options, {
+      :mailbox => 'INBOX',
+      :archivebox => 'ARCHIVE'
+    })
+    expect(options[:mailbox]).to eq('UTF7_INBOX')
+    expect(options[:archivebox]).to eq('ARCHIVE_INBOX')
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+STDERR.puts("Running Specs under Ruby Version #{RUBY_VERSION}")
+
+require 'rspec'
+require 'clacks'
+
+require 'logger'
+Clacks.config.logger(Logger.new('/tmp/clacks.log'))
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clacks
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.1.0
 platform: ruby
 authors:
 - ITRP
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-20 00:00:00.000000000 Z
+date: 2016-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Clacks system for receiving emails to be processed in ruby
-email: mathijs.sterk@itrp.com
+email: developer@itrp.com
 executables:
 - clacks
 extensions: []
@@ -68,9 +68,12 @@ files:
 - lib/clacks/command.rb
 - lib/clacks/configurator.rb
 - lib/clacks/service.rb
-- lib/clacks/stdlib_extensions/ruby_1_8.rb
 - lib/clacks/version.rb
-homepage: http://github.com/itrp/clacks
+- spec/command_spec.rb
+- spec/configurator_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/itrp/clacks
 licenses:
 - MIT
 metadata: {}
@@ -95,4 +98,8 @@ rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Clacks system for receiving emails
-test_files: []
+test_files:
+- spec/command_spec.rb
+- spec/configurator_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb

data/lib/clacks/stdlib_extensions/ruby_1_8.rb

@@ -1,41 +0,0 @@
-# -*- encoding: binary -*-
-# Backport from ruby 1.9.3 source to ruby 1.8.7
-class Net::IMAP
-  def idle(&response_handler)
-    raise LocalJumpError, "no block given" unless response_handler
-
-    response = nil
-
-    synchronize do
-      tag = Thread.current[:net_imap_tag] = generate_tag
-      put_string("#{tag} IDLE#{CRLF}")
-
-      begin
-        add_response_handler(response_handler)
-        @idle_done_cond = new_cond
-        @idle_done_cond.wait
-        @idle_done_cond = nil
-        if @receiver_thread_terminating
-          raise Net::IMAP::Error, "connection closed"
-        end
-      ensure
-        unless @receiver_thread_terminating
-          remove_response_handler(response_handler)
-          put_string("DONE#{CRLF}")
-          response = get_tagged_response(tag)  #, "IDLE")
-        end
-      end
-    end
-
-    return response
-  end
-
-  def idle_done
-    synchronize do
-      if @idle_done_cond.nil?
-        raise Net::IMAP::Error, "not during IDLE"
-      end
-      @idle_done_cond.signal
-    end
-  end
-end