message_bus-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 081e7cf743bcaaeaec287c69ea3e1788bc74a100
+  data.tar.gz: 3faec5f183ce24c022714bb0777d09146e8e3f72
+SHA512:
+  metadata.gz: b47054d7731d6287cf42bdcd04bce993ff8cad3b6906473c76c5ab6e2a09993b497beff9592d2f857632d18ef1da9acc64e16711e377f0c4eeca2ec9edfd1a7f
+  data.tar.gz: 5f476af55289c22304c970081c1c22e285fbdcc9e420dace673f807cb5b7282982ff65dfc753db66a0c369b57114547c996b1a2754f1176b3bbef7066460f0f5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.idea/message_bus-client.iml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.unhound.yml

@@ -0,0 +1,244 @@
+AccessorMethodName:
+  Enabled: true
+
+ActionFilter:
+  Enabled: true
+
+Alias:
+  Enabled: true
+
+ArrayJoin:
+  Enabled: true
+
+AsciiComments:
+  Enabled: true
+
+AsciiIdentifiers:
+  Enabled: true
+
+Attr:
+  Enabled: true
+
+BlockNesting:
+  Enabled: true
+
+CaseEquality:
+  Enabled: true
+
+CharacterLiteral:
+  Enabled: true
+
+ClassAndModuleChildren:
+  Enabled: true
+  EnforcedStyle: compact
+
+ClassLength:
+  Enabled: true
+
+ClassVars:
+  Enabled: true
+
+CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    reduce:
+    inject: 'reduce'
+    find:
+    detect: 'find'
+
+ColonMethodCall:
+  Enabled: true
+
+CommentAnnotation:
+  Enabled: true
+
+CyclomaticComplexity:
+  Enabled: true
+
+Delegate:
+  Enabled: true
+
+DeprecatedHashMethods:
+  Enabled: true
+
+DoubleNegation:
+  Enabled: true
+
+EachWithObject:
+  Enabled: true
+
+EmptyLiteral:
+  Enabled: true
+
+Encoding:
+  Enabled: false
+
+EvenOdd:
+  Enabled: true
+
+ExtraSpacing:
+  Enabled: false
+
+FileName:
+  Enabled: true
+
+FlipFlop:
+  Enabled: true
+
+FormatString:
+  Enabled: true
+
+GlobalVars:
+  Enabled: true
+
+GuardClause:
+  Enabled: true
+
+IfUnlessModifier:
+  Enabled: true
+
+IfWithSemicolon:
+  Enabled: true
+
+InlineComment:
+  Enabled: false
+
+Lambda:
+  Enabled: true
+
+LambdaCall:
+  Enabled: true
+
+LineEndConcatenation:
+  Enabled: true
+
+MethodLength:
+  Enabled: true
+
+ModuleFunction:
+  Enabled: true
+
+NegatedIf:
+  Enabled: true
+
+NegatedWhile:
+  Enabled: true
+
+Next:
+  Enabled: true
+
+NilComparison:
+  Enabled: true
+
+Not:
+  Enabled: true
+
+NumericLiterals:
+  Enabled: true
+
+OneLineConditional:
+  Enabled: true
+
+OpMethod:
+  Enabled: true
+
+ParameterLists:
+  Enabled: true
+
+PercentLiteralDelimiters:
+  Enabled: true
+
+PerlBackrefs:
+  Enabled: true
+
+PredicateName:
+  NamePrefixBlacklist: []
+
+Proc:
+  Enabled: true
+
+RaiseArgs:
+  Enabled: true
+
+RegexpLiteral:
+  Enabled: true
+
+SelfAssignment:
+  Enabled: true
+
+SingleLineBlockParams:
+  Enabled: true
+
+SingleLineMethods:
+  Enabled: true
+
+SignalException:
+  Enabled: true
+
+SpecialGlobalVars:
+  Enabled: true
+
+VariableInterpolation:
+  Enabled: true
+
+TrailingComma:
+  Enabled: true
+
+TrivialAccessors:
+  Enabled: true
+
+VariableInterpolation:
+  Enabled: true
+
+WhenThen:
+  Enabled: true
+
+WhileUntilModifier:
+  Enabled: true
+
+# Lint
+
+AmbiguousOperator:
+  Enabled: true
+
+AmbiguousRegexpLiteral:
+  Enabled: true
+
+AssignmentInCondition:
+  Enabled: true
+
+ConditionPosition:
+  Enabled: true
+
+DeprecatedClassMethods:
+  Enabled: true
+
+ElseLayout:
+  Enabled: true
+
+HandleExceptions:
+  Enabled: true
+
+InvalidCharacterLiteral:
+  Enabled: true
+
+LiteralInCondition:
+  Enabled: true
+
+LiteralInInterpolation:
+  Enabled: true
+
+Loop:
+  Enabled: true
+
+ParenthesesAsGroupedExpression:
+  Enabled: true
+
+RequireParentheses:
+  Enabled: true
+
+UnderscorePrefixedVariableName:
+  Enabled: true
+
+Void:
+  Enabled: true

data/.rubocop.yml

@@ -0,0 +1,26 @@
+inherit_from:
+  - .rubocop.unhound.yml
+
+Metrics/LineLength:
+  Max: 100
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/Documentation:
+  Enabled: false
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/WordArray:
+  Enabled: false
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: true
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.7
+  - 2.2.4
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,55 @@
+# MessageBus::Client
+[![Build Status](https://travis-ci.org/lowjoel/message_bus-client.svg?branch=master)](https://travis-ci.org/lowjoel/message_bus-client)[![Coverage Status](https://coveralls.io/repos/github/lowjoel/message_bus-client/badge.svg?branch=master)](https://coveralls.io/github/lowjoel/message_bus-client?branch=master)[![Code Climate](https://codeclimate.com/github/lowjoel/message_bus-client/badges/gpa.svg)](https://codeclimate.com/github/lowjoel/message_bus-client)[![security](https://hakiri.io/github/lowjoel/message_bus-client/master.svg)](https://hakiri.io/github/lowjoel/message_bus-client/master)[![Inline docs](http://inch-ci.org/github/lowjoel/message_bus-client.svg?branch=master)](http://inch-ci.org/github/lowjoel/message_bus-client)
+
+This is a Ruby implementation of the client for
+[message_bus](https://github.com/samsaffron/message_bus).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'message_bus-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install message_bus-client
+
+## Usage
+
+The API is mostly equivalent with the JavaScript client:
+
+```ruby
+client = MessageBus::Client.new('http://chat.samsaffron.com/')
+subject.subscribe('/message') do |payload|
+  # Do stuff
+end
+
+client.start
+client.pause
+client.resume
+client.stop
+```
+
+Both Long Polling and normal polling are supported:
+
+```ruby
+MessageBus::Client.long_polling = true # false to disable
+MessageBus::Client.poll_interval = 15 # seconds
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to
+run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/lowjoel/message_bus-client.
+

data/Rakefile

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

data/lib/message_bus/client.rb

@@ -0,0 +1,18 @@
+require 'excon'
+require 'json'
+
+require 'message_bus/client/version'
+require 'message_bus/client/configuration'
+require 'message_bus/client/connection'
+require 'message_bus/client/message_handler'
+
+class MessageBus::Client
+  include MessageBus::Client::Configuration
+  include MessageBus::Client::Connection
+  include MessageBus::Client::MessageHandler
+
+  def initialize(base_url)
+    super
+    @client_id = SecureRandom.uuid
+  end
+end

data/lib/message_bus/client/configuration.rb

@@ -0,0 +1,15 @@
+module MessageBus::Client::Configuration
+  def self.included(module_)
+    module_.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    attr_accessor :long_polling
+    attr_accessor :poll_interval
+
+    def self.extended(module_)
+      module_.long_polling = true
+      module_.poll_interval = 15
+    end
+  end
+end

data/lib/message_bus/client/connection.rb

@@ -0,0 +1,120 @@
+module MessageBus::Client::Connection
+  # The connection is in the initialised state.
+  INITIALISED = 0
+
+  # The connection is in the started state.
+  STARTED = 1
+
+  # The connection is in the paused state.
+  PAUSED = 2
+
+  # The connection is in the stopping state.
+  STOPPING = 3
+
+  # The connection is in the stopped state.
+  STOPPED = 4
+
+  def initialize(base_url)
+    @connection = nil
+    @runner = nil
+    @base_url = base_url
+    @state = INITIALISED
+
+    @statistics = { total_calls: 0, failed_calls: 0 }
+  end
+
+  def diagnostics
+  end
+
+  def start
+    return unless @state == INITIALISED || stopped?
+    @state = STARTED
+
+    @connection = Excon.new(server_endpoint, persistent: true)
+    @runner = Thread.new { runner }
+    @runner.abort_on_exception = true
+  end
+
+  def pause
+    return unless @state == STARTED
+
+    @state = PAUSED
+  end
+
+  def paused?
+    @state == PAUSED
+  end
+
+  def resume
+    return unless @state == PAUSED
+
+    @state = STARTED
+    handle_messages
+  end
+
+  def stop
+    return unless @state == STARTED || @state == PAUSED
+
+    @state = STOPPING
+    @connection.reset
+    @runner.join
+  end
+
+  def stopped?
+    @state == STOPPED
+  end
+
+  private
+
+  # The runner handling polling over the connection.
+  def runner
+    poll until @state == STOPPING
+  rescue Excon::Errors::Error
+    @statistics[:failed_calls] += 1
+    retry
+  ensure
+    @state = STOPPED
+  end
+
+  # Polls the server for messages.
+  def poll
+    @statistics[:total_calls] += 1
+
+    response = @connection.post(request_parameters)
+    handle_connection_response(response) unless self.class.long_polling
+  end
+
+  # The request parameters when connecting to the server with Excon.
+  def request_parameters
+    request_body = URI.encode_www_form(subscribed_channel_indices.
+                                       merge(__seq: @statistics[:total_calls]))
+    request_parameters = { body: request_body, headers: headers, read_timeout: 360 }
+    request_parameters[:response_block] = method(:handle_chunk).to_proc if self.class.long_polling
+
+    request_parameters
+  end
+
+  # The headers to send when polling
+  def headers
+    headers = {}
+    headers['Content-Type'] = 'application/x-www-form-urlencoded'
+    headers['X-SILENCE-LOGGER'] = 'true'
+    headers['Dont-Chunk'] = 'true' unless self.class.long_polling
+
+    headers
+  end
+
+  # Gets the URI to poll the server with
+  def server_endpoint
+    endpoint = "#{@base_url}/message-bus/#{@client_id}/poll"
+    endpoint << "?dlp=t" unless self.class.long_polling
+
+    endpoint
+  end
+
+  # Handles the response from the connection.
+  def handle_connection_response(response)
+    handle_response(response.body)
+    sleep(self.class.poll_interval)
+  end
+end

data/lib/message_bus/client/message_handler.rb

@@ -0,0 +1,94 @@
+module MessageBus::Client::MessageHandler
+  SubscribedChannel = Struct.new(:callbacks, :last_id) do
+    def initialize(last_id = -1)
+      self.callbacks = []
+      self.last_id = last_id
+    end
+
+    def callback(payload)
+      callbacks.each do |callback|
+        callback.call(payload)
+      end
+    end
+  end
+
+  # The chunk separator for chunked messages.
+  CHUNK_SEPARATOR = "\r\n|\r\n"
+
+  def initialize(base_url)
+    super
+
+    @pending_messages = []
+    @subscribed_channels = {}
+    @subscribed_channels.default_proc = proc do |hash, key|
+      hash[key] = SubscribedChannel.new
+    end
+    @payload = String.new
+  end
+
+  def subscribe(channel, &callback)
+    @subscribed_channels[channel].callbacks << callback
+  end
+
+  def unsubscribe
+  end
+
+  private
+
+  def subscribed_channel_indices
+    result = {}
+    @subscribed_channels.each do |channel, subscription|
+      result[channel] = subscription.last_id
+    end
+
+    result
+  end
+
+  def handle_chunk(chunk, _remaining_bytes, _total_bytes)
+    @payload << chunk
+    try_consume_message
+  end
+
+  def handle_response(body)
+    handle_messages(JSON.parse(body))
+  end
+
+  def try_consume_message
+    index = @payload.index(CHUNK_SEPARATOR)
+    return unless index
+
+    message = @payload[0..index]
+    @payload = @payload[(index + CHUNK_SEPARATOR.length)..-1]
+
+    handle_response(message)
+  end
+
+  def handle_messages(messages = nil)
+    if paused?
+      @pending_messages.concat(messages)
+    else
+      handle_message_method = method(:handle_message)
+      @pending_messages.each(&handle_message_method)
+      messages.each(&handle_message_method) if messages
+    end
+
+  end
+
+  def handle_message(message)
+    return handle_status_message(message) if message['channel'] == '/__status'
+
+    subscription = @subscribed_channels[message['channel']]
+    return unless subscription
+
+    subscription.last_id = message['message_id']
+    subscription.callback(message['data'])
+  end
+
+  def handle_status_message(message)
+    message['data'].each do |channel, last_id|
+      next unless @subscribed_channels.key?(channel)
+
+      @subscribed_channels[channel].last_id = last_id
+    end
+  end
+end

data/lib/message_bus/client/version.rb

@@ -0,0 +1,5 @@
+module MessageBus
+  class Client
+    VERSION = '0.1.0'
+  end
+end

data/message_bus-client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'message_bus/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'message_bus-client'
+  spec.version       = MessageBus::Client::VERSION
+  spec.authors       = ['Joel Low']
+  spec.email         = ['joel@joelsplace.sg']
+
+  spec.summary       = 'Ruby client for Message Bus'
+  spec.description   = 'Implements a client for Message Bus, with communication over HTTP'
+  spec.homepage      = 'https://github.com/lowjoel/message_bus-client'
+
+  spec.files         = `git ls-files -z`.split("\x0").
+                       reject { |f| f.match(/^(test|spec|features)\//) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+
+  spec.add_dependency 'excon', '~> 0.45'
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: message_bus-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Low
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+description: Implements a client for Message Bus, with communication over HTTP
+email:
+- joel@joelsplace.sg
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".idea/message_bus-client.iml"
+- ".rspec"
+- ".rubocop.unhound.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/message_bus/client.rb
+- lib/message_bus/client/configuration.rb
+- lib/message_bus/client/connection.rb
+- lib/message_bus/client/message_handler.rb
+- lib/message_bus/client/version.rb
+- message_bus-client.gemspec
+homepage: https://github.com/lowjoel/message_bus-client
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby client for Message Bus
+test_files: []