larva 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3db7d0f91a596e2a801add25f0f555969e3c704
-  data.tar.gz: 8270fb1338c2f139f2664378f76b4ec68a3a23ea
+  metadata.gz: 12c15b7b7bc57f92c91c47d01c62920d97a0be27
+  data.tar.gz: 1b13eb4986a959ddc4a5d70fc9971dd9738505d2
 SHA512:
-  metadata.gz: 140db924c5d9f6bfc88567bb435a77c2aabdff54eaaa5cdf6982fe606c5e5259bb6e483146475cea8ca7f0ba3b265f75a67dd8dd9fad88cf382e64bdd3a77064
-  data.tar.gz: b3968a67fde438970aa85fe768fe9ae158022922107531fa83596d4c4e4a7e4b4ad3c061a3c507a180b1aa3c67b15489c2ee66319a186aed1b305fde98e6249b
+  metadata.gz: b713b7c5e6c851c28a25feaed71e7cfee6ab42e0f6fd1fbf0770f06689c139d0186d77ea735aea71a945655298443130bf8055b6d1d10bf752da06ff2d62e3d3
+  data.tar.gz: 441618eb8034aefe7ece3abaf25a2b3317b75649d01a4ad3884df6bf5daa2dcfeac6202482176a8a3af686216040a1d4f27943da6934d5d19c28b13cf99c757f

data/.gitignore

@@ -1,3 +1,5 @@
 Gemfile.lock
 log/
 pkg/
+foo.log
+Foobar

data/.travis.yml

@@ -5,7 +5,7 @@ rvm:
   - 2.0.0
   - rbx-2.1.1
 script:
-  - bundle exec rake test:local
+  - bundle exec rake test
 #addons:
 #    code_climate:
 #        repo_token: 88dd239bc2e0010742a42a4e0234b4decd19b46d0e9d3408d8b1fe0f96dd8fc1

data/{CHANGELOG → CHANGELOG.md}

@@ -1,5 +1,11 @@
+# 0.5.0 / 2014-02-22
+* [FEATURE] Rely on Propono config for queue suffix.
+* [FEATURE] Add daemon support.
+* [FEATURE] Add mocking support.
+* [FEATURE] Add configuration to inherit from.
+
 # 0.4.1 / 2014-02-22
-* [FEATURE] Remove need for process method
+* [FEATURE] Remove need for process method.
 
 # 0.4.0 / 2014-02-22
 * [FEATURE] Add meta-programming-based processors.

data/larva.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "propono"
-  spec.add_dependency "filum"
+  spec.add_dependency "propono", "~> 1.0"
+  spec.add_dependency "filum", "~> 2.0"
+  spec.add_dependency "activesupport", "~> 3.2"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/larva.rb

@@ -1,11 +1,19 @@
-require 'larva/version'
-
-require 'propono'
+require 'active_support/core_ext'
 require 'filum'
+require 'propono'
 
+require 'larva/configuration'
+require 'larva/mocker'
 require 'larva/listener'
 require 'larva/processor'
 require 'larva/worker_pool'
+require 'larva/daemon'
 
 module Larva
+  class LarvaError < StandardError
+  end
+
+  def self.mock!
+    Mocker.mock!
+  end
 end

data/lib/larva/configuration.rb

@@ -0,0 +1,12 @@
+module Larva
+  class LarvaConfigurationError < StandardError
+  end
+
+  class Configuration
+    attr_accessor :logger
+
+    def initialize
+      @logger = Filum.logger
+    end
+  end
+end

data/lib/larva/daemon.rb

@@ -0,0 +1,62 @@
+module Larva
+  class Daemon
+    def self.start(*args)
+      daemon = new(*args)
+      daemon.configure
+      daemon.start
+      daemon
+    end
+
+    # Allowed Options:
+    #   :env - Defaults to development
+    #   :meducation_sdk_secret_key - Defauls to looking in config file
+    def initialize(processors, options = {})
+      @processors = processors
+      @options = options
+      @config_dir = options.fetch(:config_dir) {raise LarvaError.new("Please provide :config_dir via options")}
+      @logfile = options.fetch(:logfile) {raise LarvaError.new("Please provide :logfile via options")}
+      @env = options[:env] || "development"
+    end
+
+    def start
+      Filum.logger.info "Starting Workerpool"
+      Larva::WorkerPool.start(@processors)
+      Filum.logger.info "Workerpool Finished"
+    end
+
+    def configure
+      Filum.setup(@logfile)
+      Filum.logger.info "Configuring Daemon"
+
+      if meducation_sdk_config = parse_config_file('meducation-sdk.yml')
+        MeducationSDK.config do |config|
+          config.access_id  = meducation_sdk_config[:access_id]
+          config.secret_key = @options[:meducation_sdk_secret_key] || meducation_sdk_config[:secret_key]
+          config.logger     = Filum.logger
+        end
+      end
+
+      if propono_config = parse_config_file('propono.yml')
+        Propono.config do |config|
+          config.use_iam_profile  = propono_config[:use_iam_profile]
+          config.access_key       = propono_config[:access_key]
+          config.secret_key       = propono_config[:secret_key]
+          config.queue_region     = propono_config[:region]
+          config.application_name = propono_config[:application_name]
+          config.queue_suffix     = propono_config[:queue_suffix]
+          config.udp_host         = "pergo.meducation.net"
+          config.udp_port         = "9732"
+          config.logger           = Filum.logger
+        end
+      end
+    end
+
+    def parse_config_file(filename)
+      contents = File.read("#{@config_dir}/#{filename}")
+      hash = YAML::load(contents)
+      hash.stringify_keys[@env].symbolize_keys
+    rescue
+      nil
+    end
+  end
+end

data/lib/larva/listener.rb

@@ -1,20 +1,20 @@
 module Larva
   class Listener
 
-    def self.listen(topic_name, processor, queue_suffix)
-      new(topic_name, processor, queue_suffix).listen
+    def self.listen(topic_name, processor)
+      new(topic_name, processor).listen
     end
 
-    attr_reader :topic_name, :processor, :queue_suffix
-    def initialize(topic_name, processor, queue_suffix)
+    attr_reader :topic_name, :processor
+    def initialize(topic_name, processor)
       @topic_name = topic_name
       @processor = processor
-      @queue_suffix = queue_suffix
     end
 
     def listen
-      Propono.config.logger.info "Starting to listen to queue #{topic_name}#{queue_suffix}"
-      Propono.listen_to_queue("#{topic_name}#{queue_suffix}") do |message, context|
+      queue_name = "#{topic_name}#{Propono.config.queue_suffix}"
+      Propono.config.logger.info "Starting to listen to queue #{queue_name}"
+      Propono.listen_to_queue("#{queue_name}") do |message, context|
         Propono.config.logger.context_id = context[:id]
         Propono.config.logger.info "Received message: #{message}"
         processor.process(message)

data/lib/larva/mocker.rb

@@ -0,0 +1,21 @@
+module Larva
+  class Mocker
+    def self.mock!
+      Filum.setup('./log/test.log')
+      Propono::Publisher.any_instance.stubs(:publish_via_sns)
+
+      if const_defined?("MeducationSDK")
+        MeducationSDK.config do |config|
+          config.endpoint   = "http://localhost:3000/system"
+          config.access_id  = "Daemon"
+          config.secret_key = "foobar"
+          config.logger     = Filum.logger
+        end
+      end
+
+      Propono.config do |config|
+        config.logger = Filum.logger
+      end
+    end
+  end
+end

data/lib/larva/version.rb

@@ -1,3 +1,3 @@
 module Larva
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/lib/larva/worker_pool.rb

@@ -1,13 +1,12 @@
 module Larva
   class WorkerPool
-    def self.start(processors, queue_suffix)
-      new(processors, queue_suffix).start
+    def self.start(processors)
+      new(processors).start
     end
 
-    attr_reader :processors, :queue_suffix, :workers
-    def initialize(processors, queue_suffix)
+    attr_reader :processors, :workers
+    def initialize(processors)
       @processors = processors
-      @queue_suffix = queue_suffix
     end
 
     def start
@@ -25,13 +24,13 @@ module Larva
     end
 
     def start_worker(topic, processor)
-      Larva::Listener.listen(topic, processor, queue_suffix)
+      Larva::Listener.listen(topic, processor)
     rescue => e
       logger.error "Unexpected listener termination: #{e} #{e.backtrace}"
     end
 
     def keep_workers_alive
-      sleep(1) while workers.all? { |t| t.alive?  }
+      sleep(5) while workers.all? { |t| t.alive?  }
       logger.error "Some threads have died"
     end
 

data/test/configuration_test.rb

@@ -0,0 +1,17 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Larva
+  class ConfigurationTest < Minitest::Test
+    def test_configuration_sets_logger_correctly
+      assert_equal Filum.logger, Configuration.new.logger
+    end
+
+    def test_configuration_sets_logger_correctly
+      logger = mock
+      config = Configuration.new
+      config.logger = logger
+      assert_equal logger, config.logger
+    end
+  end
+end
+

data/test/daemon_test.rb

@@ -0,0 +1,74 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Larva
+  class DaemonTest < Minitest::Test
+    def config_dir
+      File.expand_path('../sample_config', __FILE__)
+    end
+
+    def logfile
+      "log/test.log"
+    end
+
+    def test_workerpool_is_started
+      processors = {foo: 'bar'}
+      Larva::WorkerPool.expects(:start).with(processors)
+      Daemon.start(processors, logfile: "./log/foo.log", config_dir: config_dir)
+    end
+
+    def test_logfile_is_compulsary
+      assert_raises(LarvaError, "Please provide :logfile via options") do
+        Daemon.start({}, config_dir: config_dir)
+      end
+    end
+
+    def test_config_dir_is_compulsary
+      assert_raises(LarvaError, "Please provide :config_dir via options") do
+        Daemon.start({}, logfile: logfile)
+      end
+    end
+
+    def test_filum_gets_config
+      Daemon.start({}, logfile: logfile, config_dir: config_dir)
+      assert_equal logfile, Filum.logger.logfile
+    end
+
+    def test_meducation_sdk_gets_config
+      Daemon.start({}, config_dir: config_dir, logfile: logfile)
+      assert_equal "Daemon", MeducationSDK.config.access_id
+      assert_equal "foobar", MeducationSDK.config.secret_key
+      assert_equal Filum.logger, MeducationSDK.config.logger
+    end
+
+    def test_meducation_sdk_gets_config_with_env
+      Daemon.start({}, config_dir: config_dir, logfile: logfile, env: 'production')
+      assert_equal "Daemon", MeducationSDK.config.access_id
+      assert_equal nil, MeducationSDK.config.secret_key
+      assert_equal Filum.logger, MeducationSDK.config.logger
+    end
+
+    def test_propono_gets_config
+      Daemon.start({}, config_dir: config_dir, logfile: logfile)
+      assert_equal "BADASSDEVKEY", Propono.config.access_key
+      assert_equal "SCARYDEVSECRET", Propono.config.secret_key
+      assert_equal "eu-west-1", Propono.config.queue_region
+      assert_equal "development_daemon", Propono.config.application_name
+      assert_equal "-dev", Propono.config.queue_suffix
+      assert_equal "pergo.meducation.net", Propono.config.udp_host
+      assert_equal "9732", Propono.config.udp_port
+      assert_equal Filum.logger, Propono.config.logger
+    end
+
+    def test_propono_gets_config_with_env
+      Daemon.start({}, config_dir: config_dir, logfile: logfile, env: 'production')
+      assert_equal "BADASSPRODUCTIONKEY", Propono.config.access_key
+      assert_equal "SCARYPRODUCTIONSECRET", Propono.config.secret_key
+      assert_equal "eu-west-1", Propono.config.queue_region
+      assert_equal "daemon", Propono.config.application_name
+      assert_equal nil, Propono.config.queue_suffix
+      assert_equal "pergo.meducation.net", Propono.config.udp_host
+      assert_equal "9732", Propono.config.udp_port
+      assert_equal Filum.logger, Propono.config.logger
+    end
+  end
+end

data/test/larva_test.rb

@@ -2,10 +2,9 @@ require File.expand_path('../test_helper', __FILE__)
 
 module Larva
   class LarvaTest < Minitest::Test
-    def test_shit_happens
-      topic, message = "Foo", "Bar"
-      Propono::Publisher.expects(:publish).with(topic, message, {})
-      Propono.publish(topic, message)
+    def test_mock_proxies_to_mocker
+      Larva::Mocker.expects(:mock!)
+      Larva.mock!
     end
   end
 end

data/test/listener_test.rb

@@ -5,25 +5,27 @@ module Larva
     def test_listen_to_queue_is_called
       topic_name = "Foo"
       queue_suffix = "bar"
+      Propono.config.queue_suffix = queue_suffix
       Propono.expects(:listen_to_queue).with("#{topic_name}#{queue_suffix}")
-      Larva::Listener.listen(topic_name, nil, queue_suffix)
+      Larva::Listener.listen(topic_name, nil)
     end
 
     def test_listener_logs_listening_message
       topic_name = "Foo"
       queue_suffix = "bar"
+      Propono.config.queue_suffix = queue_suffix
 
       message = "Starting to listen to queue #{topic_name}#{queue_suffix}"
       Propono.config.logger.expects(:info).with(message)
       Propono.stubs(:listen_to_queue)
-      Larva::Listener.listen(topic_name, nil, queue_suffix)
+      Larva::Listener.listen(topic_name, nil)
     end
 
     def test_listener_changes_context
       context = {id: "34sdf"}
       Propono.config.logger.expects(:context_id=).with(context[:id])
       Propono.stubs(:listen_to_queue).yields(nil, context)
-      Larva::Listener.listen("foobar", mock(process: nil), nil)
+      Larva::Listener.listen("foobar", mock(process: nil))
     end
 
     def test_listener_logs_message
@@ -32,7 +34,7 @@ module Larva
       Propono.config.logger.stubs(:info)
       Propono.config.logger.expects(:info).with("Received message: #{message}")
       Propono.stubs(:listen_to_queue).yields(message, context)
-      Larva::Listener.listen("foobar", mock(process: nil), nil)
+      Larva::Listener.listen("foobar", mock(process: nil))
     end
 
     def test_processor_is_called_with_message
@@ -40,7 +42,7 @@ module Larva
       message = {foo: 'bar'}
       processor.expects(:process).with(message)
       Propono.expects(:listen_to_queue).yields(message, {})
-      Larva::Listener.listen("foobar", processor, "")
+      Larva::Listener.listen("foobar", processor)
     end
   end
 end

data/test/mocker_test.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../test_helper', __FILE__)
+
+module Larva
+  class MockerTest < Minitest::Test
+    def test_filum_is_setup
+      Filum.expects(:setup).with('./log/test.log')
+      Mocker.mock!
+    end
+
+    def test_propono_publisher_is_stubbed
+      any_instance = mock()
+      any_instance.expects(:stubs).with(:publish_via_sns)
+      Propono::Publisher.expects(:any_instance).returns(any_instance)
+      Mocker.mock!
+    end
+
+    def test_loquor_is_setup
+      Mocker.mock!
+      assert_equal "http://localhost:3000/system", MeducationSDK.config.endpoint
+      assert_equal "Daemon", MeducationSDK.config.access_id
+      assert_equal "foobar", MeducationSDK.config.secret_key
+      assert_equal Filum.logger, MeducationSDK.config.logger
+    end
+
+    def test_propono_is_configured
+      Mocker.mock!
+      assert_equal Filum.logger, Propono.config.logger
+    end
+  end
+end

data/test/sample_config/meducation-sdk.yml

@@ -0,0 +1,6 @@
+development:
+  access_id: Daemon
+  secret_key: 'foobar'
+
+production:
+  access_id: Daemon

data/test/sample_config/propono.yml

@@ -0,0 +1,13 @@
+development:
+  access_key: BADASSDEVKEY
+  secret_key: SCARYDEVSECRET
+  region: eu-west-1
+  application_name: development_daemon
+  queue_suffix: -dev
+
+production:
+  access_key: BADASSPRODUCTIONKEY
+  secret_key: SCARYPRODUCTIONSECRET
+  region: eu-west-1
+  application_name: daemon
+  queue_suffix:

data/test/test_helper.rb

@@ -9,15 +9,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "larva"
 
+module MeducationSDK
+  def self.config
+    @config ||= Struct.new(:access_id, :secret_key, :endpoint, :logger).new
+    if block_given?
+      yield @config
+    else
+      @config
+    end
+  end
+end
+
 class Minitest::Test
+
   def setup
     Fog.mock!
-    Filum.config.logfile = 'log/test.log'
+    Filum.setup('log/test.log')
     Propono.config do |config|
       config.access_key = "test-access-key"
       config.secret_key = "test-secret-key"
       config.queue_region = "us-east-1"
       config.application_name = "MyApp"
+      config.queue_suffix = nil
 
       config.logger = Filum.logger
     end

data/test/worker_pool_test.rb

@@ -3,19 +3,19 @@ require File.expand_path('../test_helper', __FILE__)
 module Larva
   class WorkerPoolTest < Minitest::Test
     def test_should_complete_for_no_processors
-      WorkerPool.start({}, "")
+      WorkerPool.start({})
     end
 
     def test_process_logs_start_message
       Propono.config.logger.stubs(:info)
       Propono.config.logger.expects(:info).with("Starting threads.")
-      WorkerPool.start({}, "")
+      WorkerPool.start({})
     end
 
     def test_process_logs_end_message
       Propono.config.logger.stubs(:info)
       Propono.config.logger.expects(:info).with("Threads Started.")
-      WorkerPool.start({}, "")
+      WorkerPool.start({})
     end
 
     def test_start_worker_logs_exception
@@ -24,15 +24,14 @@ module Larva
         error.start_with?("Unexpected listener termination:")
       end
       Propono.config.logger.expects(:error).with('Some threads have died')
-      WorkerPool.start({nil => nil}, "")
+      WorkerPool.start({nil => nil})
     end
 
     def test_listen_is_called_correctly
       topic_name = "Foo"
       processor = mock
-      queue_suffix = "Bar"
-      Larva::Listener.expects(:listen).with(topic_name, processor, queue_suffix)
-      WorkerPool.start({topic_name => processor}, queue_suffix)
+      Larva::Listener.expects(:listen).with(topic_name, processor)
+      WorkerPool.start({topic_name => processor})
     end
   end
 end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: larva
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - iHiD
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-22 00:00:00.000000000 Z
+date: 2014-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: propono
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: filum
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -103,7 +117,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
-- CHANGELOG
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENCE.md
@@ -111,13 +125,21 @@ files:
 - README.md
 - larva.gemspec
 - lib/larva.rb
+- lib/larva/configuration.rb
+- lib/larva/daemon.rb
 - lib/larva/listener.rb
+- lib/larva/mocker.rb
 - lib/larva/processor.rb
 - lib/larva/version.rb
 - lib/larva/worker_pool.rb
+- test/configuration_test.rb
+- test/daemon_test.rb
 - test/larva_test.rb
 - test/listener_test.rb
+- test/mocker_test.rb
 - test/processor_test.rb
+- test/sample_config/meducation-sdk.yml
+- test/sample_config/propono.yml
 - test/test_helper.rb
 - test/worker_pool_test.rb
 homepage: https://github.com/meducation/larva
@@ -145,9 +167,14 @@ signing_key:
 specification_version: 4
 summary: Some Meducation specific helper files for ur pub/sub network
 test_files:
+- test/configuration_test.rb
+- test/daemon_test.rb
 - test/larva_test.rb
 - test/listener_test.rb
+- test/mocker_test.rb
 - test/processor_test.rb
+- test/sample_config/meducation-sdk.yml
+- test/sample_config/propono.yml
 - test/test_helper.rb
 - test/worker_pool_test.rb
 has_rdoc: