tochtli 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56acd327a8d04ef8de6ca2ab8a2b677e27e276e4
+  data.tar.gz: c0f076e6906b0ef7a401585be0946ec1b8b0d1f3
+SHA512:
+  metadata.gz: 4653fc71fcd32d2a9a21bb9929d9994564b2b3b5e1a680e04faf414705ad7bf9b9bcc8e12e274d653183f2fec2780adb3d872a93c004123c611820479d95cd97
+  data.tar.gz: 4e799d6d4888f1182772ca63dfdcd534fa2255f50926a98bb2a3df8ba1fd0b5b8b897361227e785dfdb5287269400ecac5cae7be9925f6cd2babf2350889fdb9

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.1.5
+  - 2.2.1
+  - rbx-2
+env:
+  - RAILS_VER=3.2.19
+  - RAILS_VER=4.2.1
+  - NO_RAILS=1
+services:
+  - rabbitmq
+matrix:
+  allow_failures:
+    - rvm: rbx-2

data/Gemfile

@@ -0,0 +1,32 @@
+source 'https://rubygems.org'
+
+gem 'bunny', '~> 1.7.0'
+gem 'uber'
+gem 'virtus'
+gem 'facets', require: false
+gem 'hooks'
+
+group :development do
+  gem 'dalli', '~> 2.6.4'
+  gem 'jeweler', '~> 2.0.1'
+
+  gem 'mini_cache'
+  gem 'yard', '~> 0.8'
+
+  if ENV['RAILS_VER']
+    gem 'sqlite3'
+    rails_ver = ENV['RAILS_VER'] # Setup rails version for tests
+    gem 'rails', rails_ver
+    if rails_ver.to_i < 4
+      gem 'test-unit', '>= 3.0.9'
+    end
+    gem 'tzinfo-data' if RUBY_PLATFORM =~ /mswin|mingw/ && rails_ver >= '4.0' # require tzinfo-data only for Rails 4 on windows
+    gem 'minitest', rails_ver < '4.0' ? '~> 4.7.5' : '~> 5.4.2'
+    gem 'minitest-rails', rails_ver < '4.0' ? '~> 1.0.1' : '~> 2.1.1'
+  else
+    #gem 'rails', '>= 3.2.15'
+    gem 'minitest', '>= 4.7.5'
+    gem 'minitest-reporters', '>= 0.5.0'
+  end
+end
+

data/History.md

@@ -0,0 +1,138 @@
+## 0.5.0 / 2015-08-19
+
+  * Usage examples
+  * Key pattern support for a controller routing (ex. on Message, :action, routing_key: 'my.key.*')
+  * Tochtli::BaseController#rabbit_connection delegation
+  * Tochtli::BaseController callbacks: (before|after)_(setup|start|stop|restart) with `hooks` gem
+  * Tochtli::BaseController#restart supports multiple queues
+  * Tochtli::Message#routing_key as a block
+  * Default Tochtli.logger logs on STDERR with WARN level
+  * Tochtli.cache is not obligatory
+  * Get rid of Tochtli::Test cases - replace with concerns (ex. include Tochtli::Test::Client not inherit from)
+
+## 0.4.0 / 2015-07-10
+
+  * Remove ActiveSupport dependencies (use Facets if Rails not loaded)
+  * Replace ActiveSupport::Cache with MiniCache and fix validation tests
+  * Use RabbitConnection#on_return method with all exchanges
+  * YARD introduced
+  * Tochtli::SimpleValidation for validation error messages
+  * RabbitClient#rabbit_config removed
+  * Removed RabbitClient#publish_and_wait (use SyncMessageHandler
+  * Fix #2: Client error on dropped message
+  * No more automatic routing. All routes have to be defined in the controller. (got rid of the MessageMap)
+  * Message attributes rewritten with Virtus.
+  * Message#bind_topic renamed to route_to
+  * BaseController#subscribe renamed to bind
+  * BaseClient#instance (singleton support) removed
+  * Tochtli::Test::IntegrationHelpers module with methods extracted from Tochtli::Test::Integration
+  * setup and teardown -> before_setup and after_teardown (no need for def setup; super; ... in tests)
+  
+## 0.3.0 / 2015-05-21
+
+### 4 major enhancements:
+
+  * Process each message in a separate controller instance (`BaseController::Dispatcher` introduced)
+  * Use separate channels and work pools per controller
+  * ControllerManager#start selectively starts controllers
+  * BaseController#start accepts queue name. Multiple queues are supported per single controller.
+  
+### 8 minor enhancements:
+
+  * `queue` & `queue_exists?` methods for TestRabbitConnection
+  * Single reply queue per rabbit connection
+  * configuration_store removed from `RabbitClient` (should be used separately)
+  * `RabbitConnection.logger` default set to `Tochtli.logger`
+  * ActiveRecordConnectionCleaner - a middleware for active connection cleanup
+  * Tochtli.application with middlewares introduced
+  * Network failure recovery rewritten (using automatic bunny recovery with additional reply queue binding recovery)
+  * Bunny logger redirected to RabbitConnection logger with level dependent on Tochtli.debug_bunny (by default WARN)
+  
+### 1 bug fix:
+
+  * `RabbitConnection` logger setup with configuration
+
+## 0.2.0 / 2015-05-08
+
+### 1 major enhancement:
+
+  * `RabbitConnection` connection cache. `RabbitConnection.open(configuration_name)` as a standard connection access method.
+
+### 11 minor enhancements:
+
+  * BaseController callbacks around :start and :setup
+  * Public BaseController#setup method (for manual routing control in tests)
+  * Tochtli::BaseClient tests, expect_published helper method
+  * Tochtli::Message required_attributes and optional_attributes declarations
+  * Tochtli::ServiceCache caches the store object with method: Tochtli::ServiceCache.store
+  * Tochtli::BaseClient singleton methods accept any number of arguments (passed to constructor)
+  * Get rid of ClientProxy. Error handling unified in BaseClient.
+  * Default logger for BaseClient (Tochtli.logger)
+  * Tochtli::Message validation callbacks
+  * Tochtli::Message#ignore_excess_attributes for open messages
+  * assert_published accepts block and yields message
+  
+## 0.1.7 / 2015-04-01
+
+### 1 minor enhancement:
+
+  * Tochtli::BaseClient introduced (with MessageHandler and SyncMessageHandler)
+  
+## 0.1.6 / 2015-03-02
+
+### 1 bug fix:
+
+  * Protect RabbitConnection from crash when Rails.root is not set
+  
+## 0.1.5 / 2015-02-06
+
+### 2 minor enhancement:
+
+  * Test fix: timeout raised
+  * Rails 4.2 compatibility fix
+
+## 0.1.4 / 2014-11-17
+
+### 1 minor enhancement:
+
+  * Switched to minitest
+
+### 1 bug fix:
+
+  * Blocking client proxy should not block on immediate reply (refs #13829)
+
+## 0.1.3 / 2014-10-28
+
+### 1 minor enhancement:
+
+  * Remove Rails dependencies
+
+## 0.1.2 / 2014-10-10
+
+### 4 minor enhancements:
+
+  * Update corrupted gemspec
+  * Move add_engine_migrations method to hoe-puzzleflow
+  * User always PuzzleFlow gem server
+  * User always PuzzleFlow gem server
+  * rakefile cleaning
+
+## 0.1.1 / 2014-09-30
+
+### 1 major enhancement:
+
+  * hoe introduced with git and geminabox integration
+
+### 1 minor enhancements:
+
+  * do not show ruby warnings (reset RUBY_FLAGS)
+  * hoe-puzzleflow used to unify hoe spec with other PuzzleFlow gems
+
+## 0.1.0 / 2014-09-29
+
+### 1 major enhancement
+
+  * Birthday!
+
+
+

data/README.md

@@ -0,0 +1,46 @@
+[![Build Status](https://travis-ci.org/PuzzleFlow/tochtli.svg?branch=master)](https://travis-ci.org/PuzzleFlow/tochtli)
+
+# What's Tochtli?
+
+Tochtli is a set of conventions and tools that simplifies the implementation of components communicating over the RabbitMQ broker.
+  Internally it depends on [bunny](https://github.com/ruby-amqp/bunny) gem.
+
+## Idea
+
+![Tochtli Diagram](assets/communication.png)
+
+The communication between application and service looks like on the above picture.
+  The _application_ calls the _client_ (regular object) methods which expose the _service API_. 
+  The _request_ (a message) is created and sent by the _client_ to the _service queue_ (dedicated queue per service controller).
+  _RabbitMQ_ is used as a message broker and delivers the _request_ to the _service controller_.
+  The _controller_ implements the actions that are performed on the _request_ and may result in the _response_.
+  The _response_ message is published on the _reply queue_ (private for a client connection). 
+  The _client_ receives the _response_ and returns the expected result to the _application_.
+  The client methods can be implemented in the blocking and non-blocking (asynchronous) way.
+
+## Layers
+  
+![Tochtli Layers](assets/layers.png)
+
+The stable service interface really helps to reduce costs of a inevitable change that should only affect the internal implementation.
+   In the proposed above layered structure the application interacts only with the public client class methods.
+   It's not very hard to implement client methods in a such way that they will allow for future changes which won't cause compatibility issues.
+   The expected resistance on the service API changes is a reason way application has no access to the messages definition.
+   Only clients and service controllers operate on the message layer (the common layer).
+   The bottom layer contains tools that allow for communication between the client and the server.
+   There is an option for the message broker agnosticism in the future, because client and service implementation should not directly depend on the particular tool (ex. bunny).
+
+# What's next?
+
+Read more about Tochtli and go through the tutorial on [Tochtli homepage](http://puzzleflow.github.io/tochtli).
+
+# Contributing
+
+- Fork the project.
+- Make your feature addition or bug fix.
+- Add tests for it. This is important so I don't break it in a future version unintentionally.
+- Send me a pull request.
+
+# License
+
+Released under the MIT license.

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+#!/usr/bin/env rake
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rake/testtask'
+require 'jeweler'
+require 'yard'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name        = "tochtli"
+  gem.homepage    = "http://github.com/puzzleflow/tochtli"
+  gem.license     = "MIT"
+  gem.summary     = %Q{Tochtli a core components for SOA}
+  gem.description = %Q{Lightweight framework for service oriented applications based on bunny (RabbitMQ)}
+  gem.email       = "rafal.bigaj@puzzleflow.com"
+  gem.authors     = ["Rafal Bigaj"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+YARD::Rake::YardocTask.new do |t|
+  t.files         = ['lib/**/*.rb', 'README*'] # optional
+  t.options       = ['--any', '--extra', '--opts'] # optional
+  t.stats_options = ['--list-undoc'] # optional
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/examples/01-screencap-service/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'screencap'
+gem 'tochtli', github: 'puzzleflow/tochtli'

data/examples/01-screencap-service/README.md

@@ -0,0 +1,5 @@
+# Getting started
+
+The first example is a server that creates website snapshots using [screencap](https://github.com/maxwell/screencap) gem.
+
+See [Getting started tutorial](http://puzzleflow.github.io/tochtli/tutorials/getting-started.html) for details.

data/examples/01-screencap-service/client.rb

@@ -0,0 +1,15 @@
+require_relative 'common'
+
+Tochtli.logger.progname = 'CLIENT'
+
+class ScreenerClient < Tochtli::BaseClient
+	def create_screen(url, file_name)
+		handler = SyncMessageHandler.new
+		message = CreateScreenMessage.new(url: url, file: file_name)
+		rabbit_client.publish message, handler: handler
+		handler.wait!(20)
+		puts "Done in #{handler.reply.time} seconds"
+	end
+end
+
+ScreenerClient.new.create_screen(ARGV[0], ARGV[1])

data/examples/01-screencap-service/common.rb

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler.require
+
+Tochtli.logger = Logger.new('tochtli.log')
+
+class CreateScreenMessage < Tochtli::Message
+	route_to 'screener.create'
+
+	attribute :url, String
+	attribute :file, String
+end
+
+class CreateScreenReplyMessage < Tochtli::Message
+	attribute :time, Float
+end

data/examples/01-screencap-service/server.rb

@@ -0,0 +1,26 @@
+require_relative 'common'
+
+Tochtli.logger.progname = 'SERVER'
+
+class ScreenerController < Tochtli::BaseController
+	bind 'screener.*'
+
+	on CreateScreenMessage, :create
+
+	def create
+		start_time = Time.now
+		f = Screencap::Fetcher.new(message.url)
+		f.fetch output: File.join(__dir__, 'images', message.file)
+		total_time = Time.now - start_time
+		reply CreateScreenReplyMessage.new(time: total_time)
+	end
+end
+
+Tochtli::ControllerManager.setup
+Tochtli::ControllerManager.start
+
+trap('SIGINT') { exit }
+at_exit { Tochtli::ControllerManager.stop }
+
+puts 'Press Ctrl-C to stop worker...'
+sleep

data/examples/02-log-analyzer/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem 'screencap'
+gem 'tochtli', path: '../..' # github: 'puzzleflow/tochtli'

data/examples/02-log-analyzer/README.md

@@ -0,0 +1,5 @@
+# Log Analyzer
+
+The second example is a log analyzer with status monitor and event handler.
+
+See [Client notifications tutorial](http://puzzleflow.github.io/tochtli/tutorials/client-notifications.html) for details.

data/examples/02-log-analyzer/client.rb

@@ -0,0 +1,95 @@
+require_relative 'common'
+
+Tochtli.logger.progname = 'CLIENT'
+
+module LogAnalyzer
+  class Client < Tochtli::BaseClient
+    def send_new_log(path)
+      publish NewLog.new(path: path)
+    end
+
+    def react_on_events(client_id, severities, handler=nil, &block)
+	    handler = block unless handler
+      severities = Array(severities)
+	    routing_keys = severities.map {|severity| "log.events.#{severity}" }
+      Tochtli::ControllerManager.start EventsController,
+                                       queue_name: "log_analyzer/events/#{client_id}", # custom queue name
+                                       routing_keys: routing_keys, # make custom binding (only selected severities)
+                                       env: { handler: handler }
+    end
+
+    def monitor_status(monitor=nil, &block)
+	    monitor = block unless monitor
+      Tochtli::ControllerManager.start MonitorController, env: { monitor: monitor }
+    end
+  end
+
+  protected
+
+  class EventsController < Tochtli::BaseController
+	  on EventOccurred, :handle, routing_key: 'log.events.*'
+
+    def handle
+	    handler.call(message.severity, message.timestamp, message.message)
+    end
+
+		protected
+
+		def handler
+			raise "Internal Error: handler not set for EventsController" unless env.has_key?(:handler)
+			env[:handler]
+		end
+  end
+
+  class MonitorController < Tochtli::BaseController
+    bind 'log.status'
+
+    self.queue_name        = '' # auto generate
+    self.queue_durable     = false
+    self.queue_exclusive   = true
+    self.queue_auto_delete = true
+
+    on CurrentStatus do
+	    monitor.call(message.to_hash)
+    end
+
+    protected
+
+    def monitor
+	    raise "Internal Error: monitor not set for MonitorController" unless env.has_key?(:monitor)
+	    env[:monitor]
+    end
+  end
+end
+
+client = LogAnalyzer::Client.new
+command = ARGV[0]
+
+def hold
+	puts 'Press Ctrl-C to stop...'
+	sleep
+end
+
+
+case command
+	when 's'
+		client.send_new_log ARGV[1]
+	when 'm'
+		client.monitor_status {|status| p status }
+		hold
+	when 'c'
+		client.react_on_events ARGV[1], [:fatal, :error], lambda {|severity, timestamp, message|
+			puts "[#{timestamp}] Got #{severity}: #{message}"
+		}
+		hold
+	else
+		puts "Unknown command: #{command.inspect}"
+		puts
+		puts "Usage: bundle exec ruby client [command] [params]"
+		puts
+		puts "Commands:"
+		puts "  s [path]      - send log from file to server"
+		puts "  m             - start status monitor"
+		puts "  c [client ID] - catch fatal and error events"
+end
+