chasqui 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7dc418405a5b23f20b67dc597c78926ee37f2f97
+  data.tar.gz: 8dbef72f6a1fe7546c3fa770d461d931ee396312
+SHA512:
+  metadata.gz: 6619038c7980b5bdb191014f3e14a3753c5a0256eeaa844035895fc23422736a3584772c8c77dd6b6eb4437ac5bbad019c79138ce0fdab9e8120f8069f03278d
+  data.tar.gz: f6b7da7f471ce28f665f44cfcd82edcf1702bb2de0d29dcebfc83baf4662ccfa5cbbbff5aed883b550b554a0d4702026ec42b7f65e713bfc022ecb2cc376b8fa

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chasqui.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jordan Bach
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,123 @@
+# Chasqui
+
+Chasqui is a simple, lightweight, persistent implementation of the publish-subscribe (pub/sub)
+messaging pattern for service oriented architectures.
+
+Chasqui delivers messages to subscribers in a Resque-compatible format. If you are already
+using Resque and/or Sidekiq, Chasqui will make a wonderful companion to your architecture.
+
+## Why do you need Chasqui?
+
+* To reduce coupling between applications
+* To process, monitor, and retry messages idependent of request cycles
+
+## Design
+
+Chasqui is designed with reliability in mind.
+Failure is expected and planned for in the design.
+
+Chasqui uses Redis to create persistent queues. Chasqui does not use the Redis Pub/Sub feature
+because it cannot ensure delivery of messages, especially when subscribers are not running.
+
+Chasqui consists of two components, a client and a server.
+The client provides a simple interface for publishing messages. The client places messages
+on a persistent queue, called an inbox, where they wait for further processing.
+The server reads messages from the inbox and places them on the queues of each subscriber.
+The server will create queues for subscribers if the queues do not exist.
+
+The advantage of this design is that messages are not lost when the chasqui server or the
+chasqui subscribers are not running.
+
+## Is Chasqui the best choice for you?
+
+Chasqui is perfect for you if your current architecture meets all of the following criteria
+listed below.
+
+1. You have a service oriented architecture of some kind.
+2. You primarily use resque and/or sidekiq to process jobs already.
+3. You want a simple Pub/Sub solution with minimal setup and maintenance.
+4. Your organization or traffic volume is not high enough to warrant a more complex solution.
+
+If any of the above are not true for you, you may want to consider other available solutions.
+This website maintains a list of alternatives for you to consider: http://queues.io/
+
+If Chasqui is not right for you, then please use another solution. I designed Chasqui to
+solve a specific problem for a particular scale and company size.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chasqui'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chasqui
+
+## Publishing events
+
+Publishing events is simple.
+
+```rb
+Chasqui.publish 'user.sign-up', user_id
+```
+
+To prevent conflicts with other applications, you can choose a unique namespace for your events.
+
+```rb
+# config/initializers/chasqui.rb
+Chasqui.configure do |config|
+  config.namespace = 'com.example.myapp'
+end
+```
+
+Now when you call `Chasqui.publish 'event.name', data, ...`, Chasqui will publish the event
+`com.example.myapp.user.sign-up`.
+
+## Subscribing to events
+
+__NOT IMPLMENTED YET__
+
+```rb
+# file: otherapp/app/subscribers/user_events.rb
+Chasqui.subscribe queue: 'unique_queue_name_for_app', namespace: 'com.example.myapp' do
+
+  on 'user.sign-up' do |user_id|
+    user = User.find user_id
+    UserMailer.signup(user).deliver
+  end
+
+  on 'user.cancel' do |user_id, reason|
+    user = User.find user_id
+    AdminMailer.user_cancelled(user, reason).deliver
+    user.archive!
+  end
+
+end
+```
+
+## Configure Chasqui
+
+```rb
+Chasqui.configure do |config|
+  config.namespace = 'com.example.transcoder'
+  config.redis = ENV.fetch('REDIS_URL')
+  config.workers = :sidekiq # or :resque
+  ...
+end
+```
+
+## Contributing
+
+1. Fork it (https://github.com/[my-github-username]/chasqui/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/chasqui.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chasqui/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chasqui"
+  spec.version       = Chasqui::VERSION
+  spec.authors       = ["Jordan Bach"]
+  spec.email         = ["jordan@opensolitude.com"]
+  spec.summary       = %q{Chasqui is a simple, lightweight, persistent implementation of the publish-subscribe (pub/sub) messaging pattern for service oriented architectures.}
+  spec.homepage      = "https://github.com/jbgo/chasqui"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/examples/full.rb

@@ -0,0 +1,56 @@
+# file: admin/config/initializers/chasqui.rb
+Chasqui.configure do |config|
+  config.namespace = 'com.example.admin'
+  config.redis = ENV.fetch('REDIS_URL')
+end
+
+# file: admin/app/controllers/video_controller.rb
+class VideosController < ApplicationController
+
+  def upload
+    video = Video.find params[:id]
+
+    if video.upload params[:file]
+      Chasqui.publish 'video.upload', video.id
+      redirect_to upload_complete_url,
+    else
+      redirect_to video_url, alert: "Upload failed."
+    end
+  end
+
+end
+
+# file: transcoder/config/initializers/chasqui.rb
+Chasqui.configure do |config|
+  config.publish 'com.example.transcoder'
+  config.redis ENV.fetch('REDIS_URL')
+  config.workers :sidekiq # or :resque
+end
+
+# file: transcoder/app/subscribers/video_subscriber.rb
+Chasqui.subscribe queue: 'transcoder.video', namespace: 'com.example.admin' do
+  on 'video.upload' do |video_id|
+    begin
+      Transcorder.transcode video_url(video_id)
+      Chasqui.publish 'video.complete', video_id
+    rescue => ex
+      Chasqui.publish 'video.error', video_id, ex.message
+      raise
+    end
+  end
+end
+
+# file: admin/app/subscribers/video_subscriber.rb
+Chasqui.subscribe queue: 'admin.events', namespace: 'com.example.transcoder' do
+
+  on 'transcoder.video.complete' do |video_id|
+    video = Video.find video_id
+    VideoMailer.transcode_complete(video).deliver
+  end
+
+  on 'transcoder.video.complete' do |video_id, error|
+    video = Video.find video_id
+    VideoMailer.transcode_error(video, error).deliver
+  end
+
+end

data/lib/chasqui/version.rb

@@ -0,0 +1,3 @@
+module Chasqui
+  VERSION = "0.0.1"
+end

data/lib/chasqui.rb

@@ -0,0 +1,39 @@
+require 'ostruct'
+require 'json'
+require "chasqui/version"
+
+module Chasqui
+
+  Config = Struct.new :namespace, :redis
+
+  Defaults = {
+    publish_queue: 'chasqui.inbox'
+  }.freeze
+
+  module ClassMethods
+    def namespace
+      @config.namespace unless @config.nil?
+    end
+
+    def redis
+      @config.redis unless @config.nil?
+    end
+
+    def publish_queue
+      Defaults[:publish_queue]
+    end
+
+    def configure(&block)
+      @config ||= Config.new
+      yield @config
+    end
+
+    def publish(event, *args)
+      name = namespace ? "#{namespace}.#{event}" : event
+      redis.rpush publish_queue, { name: name, data: args }.to_json
+    end
+  end
+
+end
+
+Chasqui.extend Chasqui::ClassMethods

data/spec/chasqui_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Chasqui do
+  it 'has a version number' do
+    expect(Chasqui::VERSION).not_to be nil
+  end
+
+  describe '.configure' do
+    before { reset_config }
+
+    context 'defaults' do
+      it { expect(Chasqui.namespace).to be_nil }
+      it { expect(Chasqui.publish_queue).to eq('chasqui.inbox') }
+    end
+
+    it 'configures the namespace' do
+      Chasqui.configure { |config| config.namespace = 'com.example.test' }
+      expect(Chasqui.namespace).to eq('com.example.test')
+    end
+
+    it 'configures redis' do
+      redis = FakeRedis.new
+      Chasqui.configure { |config| config.redis = redis }
+      expect(Chasqui.redis).to eq(redis)
+    end
+  end
+
+  describe '.publish' do
+    before do
+      reset_config
+      Chasqui.configure { |config| config.redis = FakeRedis.new }
+    end
+
+    it 'publishes an event without a namespace' do
+      Chasqui.publish 'test.event', 1, 2, foo: 'bar'
+      event = JSON.load Chasqui.redis.lpop('chasqui.inbox')
+      expect(event['name']).to eq('test.event')
+      expect(event['data']).to eq([1, 2, {'foo'=>'bar'}])
+    end
+
+    it 'publishes an event with a namespace' do
+      Chasqui.configure { |config| config.namespace = 'my.app' }
+      p Chasqui.namespace
+      Chasqui.publish 'test.event', :foo
+      event = JSON.load Chasqui.redis.lpop('chasqui.inbox')
+      expect(event['name']).to eq('my.app.test.event')
+      expect(event['data']).to eq(['foo'])
+    end
+  end
+
+  private
+
+  def reset_config
+    Chasqui.instance_variable_set(:@config, nil)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'chasqui'
+
+class FakeRedis
+  def initialize
+    @queues = {}
+  end
+
+  def rpush(key, value)
+    queue(key) << value
+  end
+
+  def lpop(key)
+    queue(key).shift
+  end
+
+  private
+
+  def queue(key)
+    @queues[key] ||= []
+    @queues[key]
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: chasqui
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jordan Bach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jordan@opensolitude.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- chasqui.gemspec
+- examples/full.rb
+- lib/chasqui.rb
+- lib/chasqui/version.rb
+- spec/chasqui_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jbgo/chasqui
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Chasqui is a simple, lightweight, persistent implementation of the publish-subscribe
+  (pub/sub) messaging pattern for service oriented architectures.
+test_files:
+- spec/chasqui_spec.rb
+- spec/spec_helper.rb