kanina 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec8d730195a2d4c6669e0a7a3d6f221622e1d4fe
-  data.tar.gz: 83205977db72d11380b3d41ea71664bd56530c2d
+  metadata.gz: dae9cec347810f3ce75541ae0ea7cf16d6af65eb
+  data.tar.gz: 21449f6b71e1b18e8011f6b2b584ca4ee7a38c09
 SHA512:
-  metadata.gz: 4f8366244d463044be02f10a692ae6a32bb9d6477243e0b726ee1bed2cd883e71cc900ee47d031110c5605884614e31fd60ba5706f5c8f58c135e1b156614d55
-  data.tar.gz: a876042754e17c9b2390a575ce9cdcedd67ec2b1990a98df7af7b57fbf6bdf98587cf3b256b420a20be3eae403d1e174efd5b68f9a9a311fe7e620edf0fcc081
+  metadata.gz: 8f78a97f53c19d54cd40e909d3857e00f1d163ca61e309ab4908a47393aa05a072498b8683ba3cef764e207c992be153df5ce18df6651cd9ebd4d8fa1c3f96b8
+  data.tar.gz: f1d0bfd1aa78393facac5a96f09febcb09f25f015fab7a45425b170a9f91a698fde1507a6618875d3f8077615a3bb8e679a8430342e84c3922eec58bee8a978e

data/.gitignore

@@ -30,6 +30,7 @@ atlassian-ide-plugin.xml
 
 # Ignore, this being a gem.
 Gemfile.lock
+*.gem
 
 # Docs
 .yardoc

data/.ruby-version

@@ -1 +1 @@
-2.1.0
+2.2.0

data/Gemfile

@@ -2,8 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'coveralls', require: nil
-gem 'codeclimate-test-reporter', group: :test, require: nil
+gem 'codeclimate-test-reporter', group: :test, require: false
 
 platforms :rbx do
   gem 'racc'

data/Guardfile

@@ -4,6 +4,8 @@ guard :rspec, cmd: 'bundle exec rspec' do
   watch('spec/spec_helper.rb')  { 'spec' }
 end
 
-guard 'yard', port: '8808' do
-  watch(%r{lib/.+\.rb})
-end
+# # TODO: Uncomment this to regenerate docs locally, AFTER Yardoc is fixed
+# # post-Ruby 2.2.0
+# guard 'yard', port: '8808' do
+#   watch(%r{lib/.+\.rb})
+# end

data/History.md

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+v0.6.1
+------
+- Complete project rename! Once "Hare", now called "Kanina".
+  - "Kanina" means "Bunny" in Icelandic and "a while ago" in Tagalog. More importantly, it was available on Rubygems...
+- Ruby 2.2.0 support.
+- Mark an exchange as durable.
+- More and better documentation.
+- Better coverage.
+- Tweak integration with Inch & Code Climate
+- Stop using Coveralls, since it was conflicting, and I'm now sending coverage to Code Climate anyway.
+- Renamed exchanges and queues in specs, so all Kanina output is namespaced.
+
 v0.6.0
 ------
 - Mark individual messages as persistent or transient.

data/README.md

@@ -3,10 +3,11 @@ Kanina
 
 A Rails plugin that makes it easier for your models to communicate with RabbitMQ.
 
+[![Gem Version](https://badge.fury.io/rb/kanina.svg)](http://badge.fury.io/rb/kanina)
 [![Build Status](https://travis-ci.org/judy/kanina.svg?branch=master)](https://travis-ci.org/judy/kanina)
 [![Code Climate](https://codeclimate.com/github/judy/kanina.png)](https://codeclimate.com/github/judy/kanina)
-[![Coverage Status](https://coveralls.io/repos/judy/kanina/badge.png)](https://coveralls.io/r/judy/kanina)
 [![Inline docs](http://inch-ci.org/github/judy/kanina.png?branch=master)](http://inch-ci.org/github/judy/kanina)
+[![API Documentation](https://www.omniref.com/ruby/gems/kanina.png)](https://www.omniref.com/ruby/gems/kanina)
 
 Kanina abstracts away queue and exchange creation, so you can focus on the message and subscription side of things in Rails.
 

data/lib/generators/kanina/install/install_generator.rb

@@ -1,6 +1,7 @@
 require 'rails/generators'
 
 module Kanina
+  # `Kanina::InstallGenerator` handles installing Kanina into a Rails project.
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
 

data/lib/generators/kanina/message/message_generator.rb

@@ -1,10 +1,13 @@
 require 'rails/generators'
 
 module Kanina
-  # <tt>Kanina::MessageGenerator</tt> generates a template of a message file. Change the
+  # `Kanina::MessageGenerator` generates a template of a message file. Change the
   # resulting file with your intended exchange or routing_key information. For example:
   #
   #   rails generate message user_notification
+  #
+  # Then you'll want to update the generated message class with instructions on
+  # which exchange to send messages, the type of exchange, and so on.
   class MessageGenerator < Rails::Generators::NamedBase
     source_root File.expand_path('../templates', __FILE__)
 

data/lib/generators/kanina/subscription/subscription_generator.rb

@@ -1,7 +1,7 @@
 require 'rails/generators'
 
 module Kanina
-  # <tt>Kanina::SubscriptionGenerator</tt> generates a subscription file, for
+  # `Kanina::SubscriptionGenerator` generates a subscription file, for
   # example:
   #
   #   rails generate subscription user_notification

data/lib/kanina/logger.rb

@@ -1,15 +1,21 @@
 require 'logger'
 
 module Kanina
-  # Simplifies sending messages to standard output and/or the Rails log files.
+  # `Kanina::Logger` simplifies sending messages to standard output and/or the
+  # Rails log files.
   module Logger
     DEFAULT_LOG_LEVEL = ::Logger::INFO
 
+    # Sets up the Rails logger
+    # @return [Rails::Logger] the logger being used
     def logger
       Rails.logger ||= ::Logger.new(STDOUT)
       @logger ||= Rails.logger
     end
 
+    # Sends a message to the log
+    # @param text [String] the message to log
+    # @param level the importance of the logged message. Default is Logger::INFO
     def say(text, level = DEFAULT_LOG_LEVEL)
       puts text if @loud
       logger.add level, "HARE: #{text}"

data/lib/kanina/message.rb

@@ -15,7 +15,8 @@ module Kanina
   # parsed back out of JSON into native Ruby objects.
   class Message
     class << self
-      # Helper method to return the channel opened by `Kanina::Server`.
+      # Helper method to return the channel that Kanina::Server is talking on.
+      # @return [Bunny::Channel]
       def channel
         Kanina::Server.channel or fail 'Kanina::Server.channel is not open'
       end
@@ -25,12 +26,11 @@ module Kanina
       # @overload exchange(name, *opts)
       #   Set the name and type of the exchange messages should be sent to.
       #   @param name [String] the name of the exchange
-      #   @param type [:direct, :fanout, :topic] the type of exchange
       #   @return [String] the exchange
-      def exchange(name = nil, type: :direct)
+      def exchange(name = nil, type: :direct, durable: false)
         if name.present?
           @type = type
-          @exchange = channel.exchange(name, type: type)
+          @exchange = channel.exchange(name, type: type, durable: durable)
         else
           @exchange || channel.default_exchange
         end

data/lib/kanina/server.rb

@@ -1,5 +1,5 @@
 module Kanina
-  # <tt>Kanina::Server</tt> loads configuration, opens a connection to RabbitMQ
+  # `Kanina::Server` 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.
@@ -10,10 +10,16 @@ module Kanina
       attr_reader :connection, :channel
       attr_accessor :config, :loud
 
+      # Returns the current status of the server connection.
+      # @return [String] status, as 'off', 'starting', 'started', or 'stopping'
       def status
         @status || 'off'
       end
 
+      # Loads the configuration, opens a connection, and opens the channel. This
+      # will automatically be run in the railtie when you install Kanina into a
+      # Rails project, so you shouldn't have to run it yourself.
+      # @return [String] status as 'started', unless something went wrong.
       def start
         set_status 'starting'
         load_config unless @config.present?
@@ -22,6 +28,8 @@ module Kanina
         set_status 'started'
       end
 
+      # Closes the connection to RabbitMQ.
+      # @return [String] status as 'stopping'
       def stop
         set_status 'stopping'
         cleanup
@@ -32,6 +40,7 @@ module Kanina
       def set_status(string)
         @status = string
         say "Status changed to #{@status}"
+        @status
       end
 
       def cleanup
@@ -40,7 +49,7 @@ module Kanina
       end
 
       def config_file_location
-        Rails.root + 'config/amqp.yml'
+        (Rails.try(:root) || './') + 'config/amqp.yml'
       end
 
       def load_config

data/lib/kanina/subscription.rb

@@ -22,7 +22,7 @@ module Kanina
       # Helper method to return the channel that Kanina::Server is talking on.
       # @return [Bunny::Channel]
       def channel
-        Kanina::Server.channel
+        Kanina::Server.channel or fail 'Kanina::Server.channel is not open'
       end
 
       # Begins subscribing to the specified queue (or binds to an exchange and

data/lib/kanina/version.rb

@@ -1,3 +1,8 @@
+# Dumb module definition to set VERSION. Kanina uses
+# [Semantic Versioniong](http://semver.org/) religiously; the patch number is
+# bumped for bug fixes, minor number is bumped for new features that don't break
+# backward compatibility, and major numbers are only bumped when introducing
+# major API changes that break backward compatibility.
 module Kanina
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

data/spec/kanina/message_spec.rb

@@ -2,24 +2,33 @@ describe Kanina::Message do
   describe '.exchange' do
     it 'sets and returns the exchange' do
       dummy_class = Class.new(Kanina::Message) do
-        exchange 'test', type: :direct
+        exchange 'kanina.message_spec.exchange', type: :direct
       end
-      expect(dummy_class.exchange.name).to eql 'test'
+      expect(dummy_class.exchange.name).to eql 'kanina.message_spec.exchange'
       expect(dummy_class.exchange.type).to eql :direct
     end
+
     it "returns the default exchange if exchange hasn't been set." do
       dummy_class = Class.new(Kanina::Message)
       expect(dummy_class.exchange.name).to eql ''
       expect(dummy_class.exchange.type).to eql :direct
     end
+
+    it 'makes a durable exchange' do
+      dummy_class = Class.new(Kanina::Message) do
+        exchange 'kanina.message_spec.durable_exchange', durable: :true
+      end
+
+      expect(`rabbitmqctl list_exchanges name durable`).to include("kanina.message_spec.durable_exchange\ttrue")
+    end
   end
 
   describe '.routing_key' do
     it 'sets and returns the routing_key variable' do
       dummy_class = Class.new(Kanina::Message) do
-        routing_key 'test'
+        routing_key 'kanina.message_spec.routing_key'
       end
-      expect(dummy_class.routing_key).to eql 'test'
+      expect(dummy_class.routing_key).to eql 'kanina.message_spec.routing_key'
     end
   end
 
@@ -59,10 +68,10 @@ describe Kanina::Message do
 
     it 'delivers a message to the default exchange' do
       dummy_class = Class.new(Kanina::Message) do
-        routing_key 'testkey'
+        routing_key 'kanina.message_spec.default_exchange_to_queue'
       end
 
-      q = Kanina::Server.channel.queue('testkey')
+      q = Kanina::Server.channel.queue('kanina.message_spec.default_exchange_to_queue')
       message = dummy_class.new('test')
       result = nil
       message.deliver
@@ -77,11 +86,11 @@ describe Kanina::Message do
 
     it 'delivers a message to a fanout exchange' do
       dummy_class = Class.new(Kanina::Message) do
-        fanout 'fanning_out'
+        fanout 'kanina.message_spec.fanout_exchange'
       end
 
       q = Kanina::Server.channel.queue('')
-      q.bind('fanning_out')
+      q.bind('kanina.message_spec.fanout_exchange')
       message = dummy_class.new('data')
       message.deliver
       result = nil
@@ -94,13 +103,13 @@ describe Kanina::Message do
       expect(result).to eql('"data"')
     end
 
-    it 'delivers a message to a named exchange' do
+    it 'delivers a message to a direct exchange' do
       dummy_class = Class.new(Kanina::Message) do
-        exchange 'direct-test-exchange', type: :direct
+        exchange 'kanina.message_spec.direct_exchange', type: :direct
       end
 
       q = Kanina::Server.channel.queue('')
-      q.bind('direct-test-exchange')
+      q.bind('kanina.message_spec.direct_exchange')
       message = dummy_class.new('data')
       message.deliver
       result = nil
@@ -115,8 +124,8 @@ describe Kanina::Message do
     context "with a topic exchange" do
       before(:each) do
         @dummy_class = Class.new(Kanina::Message) do
-          topic "topic_exchange"
-          routing_key "prefix.middle.suffix"
+          topic "kanina.message_spec.topic_exchange"
+          routing_key "kanina.message_spec.topic_exchange.suffix"
         end
         @q = Kanina::Server.channel.queue('')
         @ex = @dummy_class.class_eval{exchange}
@@ -131,24 +140,24 @@ describe Kanina::Message do
       end
 
       it "should match a full topic" do
-        @q.bind @ex, routing_key: "prefix.middle.suffix"
+        @q.bind @ex, routing_key: "kanina.message_spec.topic_exchange.suffix"
       end
 
       it "should match a prefix" do
-        @q.bind @ex, routing_key: "prefix.#"
+        @q.bind @ex, routing_key: "kanina.message_spec.topic_exchange.#"
       end
 
       it "should match a suffix" do
-        @q.bind @ex, routing_key: "#.suffix"
+        @q.bind @ex, routing_key: "#.topic_exchange.suffix"
       end
     end
 
     context 'with persistence turned on' do
       it 'should make messages persistent' do
-        Kanina::Server.channel.queue('persistentqueue', durable: true)
+        Kanina::Server.channel.queue('kanina.message_spec.persistent_messages', durable: true)
 
         dummy_class = Class.new(Kanina::Message) do
-          routing_key 'persistentqueue'
+          routing_key 'kanina.message_spec.persistent_messages'
           persistent
         end
         result = nil
@@ -158,7 +167,7 @@ describe Kanina::Message do
         Kanina::Server.stop
         Kanina::Server.start
 
-        Kanina::Server.channel.queue('persistentqueue', durable: true).subscribe do |_, _, body|
+        Kanina::Server.channel.queue('kanina.message_spec.persistent_messages', durable: true).subscribe do |_, _, body|
           result = body
         end
 
@@ -169,12 +178,13 @@ describe Kanina::Message do
 
     context 'with persistence turned off' do
       it 'should make messages transient' do
-        # TODO: Fix this test so it reliably restarts RabbitMQ across all platforms!
+        # TODO: Fix this test so it reliably restarts RabbitMQ across all
+        # platforms, including TravisCI.
         skip "can fail when restarting RabbitMQ server."
-        Kanina::Server.channel.queue('transientqueue', durable: true)
+        Kanina::Server.channel.queue('kanina.message_spec.transient_messages', durable: true)
 
         dummy_class = Class.new(Kanina::Message) do
-          routing_key 'transientqueue'
+          routing_key 'kanina.message_spec.transient_messages'
           transient
         end
         result = nil
@@ -183,13 +193,14 @@ describe Kanina::Message do
         msg.deliver
 
         Kanina::Server.stop
+        sleep 1
         `rabbitmqctl stop_app`
+        sleep 1
         `rabbitmqctl start_app`
-        # `lunchy restart rabbitmq`
-        # sleep 3
+        sleep 1
         Kanina::Server.start
 
-        Kanina::Server.channel.queue('transientqueue', durable: true).subscribe do |_, _, body|
+        Kanina::Server.channel.queue('kanina.message_spec.transient_messages', durable: true).subscribe do |_, _, body|
           result = body
         end
 

data/spec/kanina/subscription_spec.rb

@@ -2,13 +2,13 @@ describe Kanina::Subscription do
   describe '.subscribe' do
     it 'watches a queue' do
       result = nil
-      Kanina::Subscription.subscribe queue: 'subscription.test.queue' do |data|
+      Kanina::Subscription.subscribe queue: 'kanina.subscription_spec.subscribe' do |data|
         result = data[:string]
       end
 
       Kanina::Server.channel.default_exchange.publish(
         { string: 'success' }.to_json,
-        routing_key: 'subscription.test.queue'
+        routing_key: 'kanina.subscription_spec.subscribe'
       )
 
       sleep(0.1)
@@ -19,19 +19,19 @@ describe Kanina::Subscription do
       result = nil
 
       # The queue must exist first before we send messages to it.
-      Kanina::Subscription.create_queue('subscription.test.durablequeue', durable: true)
+      Kanina::Subscription.create_queue('kanina.subscription_spec.durable_queue', durable: true)
 
       # Push the message
       Kanina::Server.channel.default_exchange.publish(
         { string: 'success' }.to_json,
-        routing_key: 'subscription.test.durablequeue'
+        routing_key: 'kanina.subscription_spec.durable_queue'
       )
 
       Kanina::Server.stop
       Kanina::Server.start
 
       # Re-open the subscription to the queue
-      Kanina::Subscription.subscribe queue: 'subscription.test.durablequeue', durable: true do |data|
+      Kanina::Subscription.subscribe queue: 'kanina.subscription_spec.durable_queue', durable: true do |data|
         result = data[:string]
       end
 
@@ -41,10 +41,10 @@ describe Kanina::Subscription do
 
     it 'sets up a binding to a named exchange' do
       result = nil
-      Kanina::Subscription.subscribe bind: 'named_exchange' do |data|
+      Kanina::Subscription.subscribe bind: 'kanina.subscription_spec.binding_to_named_exchange' do |data|
         result = data[:string]
       end
-      Kanina::Server.channel.direct('named_exchange').publish(
+      Kanina::Server.channel.direct('kanina.subscription_spec.binding_to_named_exchange').publish(
         { string: 'success' }.to_json
       )
 

data/spec/spec_helper.rb

@@ -5,17 +5,13 @@ require 'simplecov'
 original_process = Process.pid
 
 SimpleCov.start do
-  add_filter 'spec/dummy'
+  add_filter 'spec'
 end
 
 SimpleCov.at_exit do
   SimpleCov.result.format! if Process.pid == original_process
 end
 
-# Coveralls for online code coverage generation.
-require 'coveralls'
-Coveralls.wear!
-
 # Send code coverage to Code Climate
 require "codeclimate-test-reporter"
 CodeClimate::TestReporter.start

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanina
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Clinton Judy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -351,7 +351,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Rails plugin for RabbitMQ