kanina 0.6.0

data/lib/kanina/railtie.rb

@@ -0,0 +1,29 @@
+require 'kanina'
+require 'rails'
+
+module Kanina
+  # This Railtie starts a connection to RabbitMQ, and eagerly loads messages
+  # and subscriptions so they have time to create the necessary AMQP
+  # structures.
+  class Railtie < Rails::Railtie
+    initializer 'kanina' do
+      Kanina::Server.start
+
+      connection_attempts = 1
+      while Kanina::Server.status != 'started' && connection_attempts <= 5
+        sleep(connection_attempts) # Progressively sleep longer between connection attempts.
+        connection_attempts = connection_attempts + 1
+      end
+
+      eagerloads = []
+      eagerloads.concat(Dir.glob("#{Rails.root}/app/messages/**/*.rb"))
+      eagerloads.concat(Dir.glob("#{Rails.root}/app/subscriptions/**/*.rb"))
+
+      # TODO: I'd love to use `require_dependency` here instead, but it's doing something weird
+      # when reloading subscriptions. We might be able to close and re-open the channel before
+      # every server request, so subscription objects don't collide (or whatever they're doing
+      # that keeps them from receiving messages.)
+      eagerloads.sort.each { |file| require file }
+    end
+  end
+end

data/lib/kanina/server.rb

@@ -0,0 +1,74 @@
+module Kanina
+  # <tt>Kanina::Server</tt> loads configuration, opens a connection to RabbitMQ
+  # and opens a channel so messages can be received and sent. This class is
+  # automatically called and handled by a Railtie, so you shouldn't have to
+  # invoke it by hand.
+  class Server
+    class << self
+      include Kanina::Logger
+
+      attr_reader :connection, :channel
+      attr_accessor :config, :loud
+
+      def status
+        @status || 'off'
+      end
+
+      def start
+        set_status 'starting'
+        load_config unless @config.present?
+        open_connection
+        open_channel
+        set_status 'started'
+      end
+
+      def stop
+        set_status 'stopping'
+        cleanup
+      end
+
+      private
+
+      def set_status(string)
+        @status = string
+        say "Status changed to #{@status}"
+      end
+
+      def cleanup
+        @connection.try(:close)
+        set_status 'off'
+      end
+
+      def config_file_location
+        Rails.root + 'config/amqp.yml'
+      end
+
+      def load_config
+        if Pathname.new(config_file_location).exist?
+          @config = HashWithIndifferentAccess.new(
+            YAML.load_file(config_file_location)
+          )[Rails.env]
+          say 'Loaded config.'
+        else
+          say 'amqp.yml not found! Not loading any configuration'
+        end
+      end
+
+      def open_connection
+        @connection ||= Bunny.new(@config)
+        if @connection.start
+          say "Opened connection: #{@connection}"
+        end
+      end
+
+      def open_channel
+        if @connection.present?
+          @channel = @connection.create_channel
+          say "Opened channel: #{@channel}"
+        else
+          fail 'Connection needs to be opened before opening a channel.'
+        end
+      end
+    end
+  end
+end

data/lib/kanina/subscription.rb

@@ -0,0 +1,80 @@
+module Kanina
+  # `Kanina::Subscription` allows you to automatically receive messages
+  # from RabbitMQ, and run a block of code upon receiving each new message.
+  # Queues and bindings are set up on the fly. Subscriptions are also eagerly
+  # loaded by Rails, so they're defined when the Rails environment is loaded.
+  # Example:
+  #
+  #   # app/messages/user_message.rb
+  #   class UserSubscription < Kanina::Subscription
+  #     subscribe(bind: "user.exchange") do |data|
+  #       puts data
+  #     end
+  #   end
+  #
+  # Messages are depacked from JSON, into plain old Ruby objects. If you use
+  # `Kanina::Message` to send messages, it automatically encapsulates messages
+  # into JSON to make the process easier.
+  class Subscription
+    class << self
+      include Kanina::Logger
+
+      # Helper method to return the channel that Kanina::Server is talking on.
+      # @return [Bunny::Channel]
+      def channel
+        Kanina::Server.channel
+      end
+
+      # Begins subscribing to the specified queue (or binds to an exchange and
+      # sets up an anonymous queue). The block is called for every message
+      # received, and data is passed in as a plain Ruby hash.
+      # @param queue [String] Optional, the queue to watch.
+      # @param bind [String] Optional, the exchange to bind to.
+      # @param durable [Boolean] Optional, whether to make the queue durable.
+      # @yieldparam data [HashWithIndifferentAccess] The payload of the message,
+      #    automatically turned into a hash.
+      def subscribe(queue:'', bind:nil, durable:false, &blk)
+        create_queue(queue, durable: durable)
+        create_binding(bind)
+        @queue.subscribe do |delivery_info, properties, body|
+          yield format_data(body)
+        end
+      end
+
+      # Creates the queue **or** attaches to the existing queue. This will also
+      # create a random queue if the queue supplied is an empty string.
+      # @param name [String] The name of the queue.
+      # @param durable [Boolean] Optional, false by default. Whether the queue
+      #   should be durable or not.
+      # @return [Bunny::Queue]
+      def create_queue(name, durable: false)
+        @queue = channel.queue(name, durable: durable)
+      end
+
+      # Ensures the named exchange exists, and binds the queue to it.
+      # @param name [String] The name of the exchange to bind the queue to.
+      def create_binding(name)
+        if name.present?
+          ensure_exchange_exists(name)
+          @queue.bind(name)
+        end
+      end
+
+    private
+
+      def ensure_exchange_exists(bind)
+        unless Kanina::Server.connection.exchange_exists?(bind)
+          channel.exchange(bind, type: :direct)
+        end
+      end
+
+      def format_data(body)
+        obj = JSON.parse(body)
+        HashWithIndifferentAccess.new(obj)
+      rescue
+        say "JSON data wasn't received, returning plain object"
+        body
+      end
+    end
+  end
+end

data/lib/kanina/version.rb

@@ -0,0 +1,3 @@
+module Kanina
+  VERSION = '0.6.0'
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/amqp.yml

@@ -0,0 +1,11 @@
+# Refer to Bunny's new connection parameters for settings here.
+# http://rubybunny.info/articles/connecting.html
+
+defaults: &defaults
+  host: localhost
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults

data/spec/dummy/config/application.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "kanina"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end