metybur 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f69ccd216fe6e46fe9472a0975e31de3c15a9c14
-  data.tar.gz: 91fdac926fc0e44432c67da5e27a072e7e027ab8
+  metadata.gz: 864d272f4639c0789e198773313fcad042332ad5
+  data.tar.gz: d840163bb51fd06be5af41af567a638d8528ee53
 SHA512:
-  metadata.gz: 020974269a114c7ed5edba2b2d8a7168931d7dd61ea81064a8a1df0a18464a564b703eb9fcae536e8d3ec1526ee2affab60cab47e1f1b7443e11cc41cdb127b2
-  data.tar.gz: 9682e9bcd748d3aa069fab63548672a522dda50eae8dafe4beadea581641b95b095a7f35e6bae4720b176d2bea1357594eec7a818fd8ce68338d692d857d1122
+  metadata.gz: 5e39ffccc52cdc71c27e4f27750b86352f96f24251ca7eb49a966f00956d41b3a0ecdfc3f558073b63f53f8a0ca879e989f6de6ff700b9680fecc002b80b2385
+  data.tar.gz: 441ecdfcbd89231ccea2b0c608b2a354c73c15bbb1ef2beadcf949844bfdb0cafd1f1678c5290b9f29dd600c4fa08ff953a32b6469f7e274443562c09b279c08

data/README.md

@@ -1,5 +1,6 @@
 # Metybur
 [![Build Status](https://travis-ci.org/clemenshelm/metybur.svg?branch=master)](https://travis-ci.org/clemenshelm/metybur)
+[![Gem Version](https://badge.fury.io/rb/metybur.svg)](http://badge.fury.io/rb/metybur)
 
 A DDP client for Ruby to connect to Meteor apps.
 
@@ -9,7 +10,7 @@ You can also call Meteor methods from Ruby.
 
 > ## Caution!
 > 
-> This gem is just a few days old so far and doesn't include basic features like proper error handling. Also only a subset of the DDP protocol is implemented so far. Everything described in this README should work, though.
+> This gem is just a few weeks old so far and doesn't include basic features like proper error handling. Also only a subset of the DDP protocol is implemented so far. Everything described in this README should work, though.
 > 
 > I'll keep working on it constantly, so I suppose there will be a complete and stable version soon. Stay tuned!
 > 

data/lib/metybur/collection.rb

@@ -9,8 +9,7 @@ class Metybur::Collection
   end
 
   def on(event, &block)
-    @callbacks[event] ||= []
-    @callbacks[event] << block
+    callback_for(event: event) << block
     self
   end
 
@@ -19,6 +18,10 @@ class Metybur::Collection
   def handle_message(attributes)
     event = attributes[:msg].to_sym
     arguments = attributes.slice(:id, :fields, :cleared).values
-    @callbacks[event].each { |callback| callback.call(*arguments) }
+    callback_for(event: event).each { |callback| callback.call(*arguments) }
+  end
+
+  def callback_for(event:)
+    @callbacks[event] ||= []
   end
 end

data/lib/metybur/middleware/json_middleware.rb

@@ -0,0 +1,13 @@
+class Metybur::JSONMiddleware
+  def open(event)
+    event
+  end
+
+  def message(event)
+    JSON.parse(event.data, symbolize_names: true)
+  end
+
+  def close(event)
+    event
+  end
+end

data/lib/metybur/middleware/logging_middleware.rb

@@ -0,0 +1,21 @@
+class Metybur::LoggingMiddleware
+  def initialize
+    @logger = Logger.new(Metybur::CONFIG[:log_stream])
+    @logger.level = Metybur::CONFIG[:log_level]
+  end
+
+  def open(event)
+    @logger.debug 'connection open'
+    event
+  end
+
+  def message(event)
+    @logger.debug "received message #{event.data}"
+    event
+  end
+
+  def close(event)
+    @logger.debug "connection closed (code #{event.code}). #{event.reason}"
+    event
+  end
+end

data/lib/metybur/middleware/ping_pong_middleware.rb

@@ -0,0 +1,22 @@
+class Metybur::PingPongMiddleware
+  def initialize(websocket)
+    # TODO: This dependency is dowdy. Get rid of it.
+    @websocket = websocket
+  end
+
+  def open(event)
+    event
+  end
+
+  def message(message)
+    return message unless message[:msg] == 'ping'
+    pong = {msg: 'pong'}
+    pong[:id] = message[:id] if message[:id]
+    @websocket.send(pong.to_json)
+    message
+  end
+
+  def close(event)
+    event
+  end
+end

data/lib/metybur/version.rb

@@ -1,3 +1,3 @@
 module Metybur
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/metybur.rb

@@ -3,6 +3,9 @@ require 'faye/websocket'
 require 'json'
 require 'logger'
 require_relative 'metybur/client'
+require_relative 'metybur/middleware/logging_middleware'
+require_relative 'metybur/middleware/json_middleware'
+require_relative 'metybur/middleware/ping_pong_middleware'
 
 module Metybur
   CONFIG = {
@@ -15,28 +18,22 @@ module Metybur
     websocket = CONFIG[:websocket_client_class].new(url)
     client = Metybur::Client.new(websocket)
 
-    logger = Logger.new(CONFIG[:log_stream])
-    logger.level = CONFIG[:log_level]
+    logging_middleware = Metybur::LoggingMiddleware.new
+    json_middleware = Metybur::JSONMiddleware.new
+    ping_pong_middleware = Metybur::PingPongMiddleware.new(websocket)
+    middleware = [logging_middleware, json_middleware, ping_pong_middleware]
+
     websocket.on(:open) do |event|
-      logger.debug 'connection open'
+      middleware.inject(event) { |e, mw| mw.open(e) }
     end
-    websocket.on(:message) do |message|
-      logger.debug "received message #{message.data}"
+    websocket.on(:message) do |event|
+      middleware.inject(event) { |e, mw| mw.message(e) }
     end
     websocket.on(:close) do |event|
-      logger.debug "connection closed (code #{event.code}). #{event.reason}"
+      middleware.inject(event) { |e, mw| mw.close(e) }
       EM.stop_event_loop
     end
 
-    websocket.on(:message) do |event|
-      message = JSON.parse(event.data, symbolize_names: true)
-      if message[:msg] == 'ping'
-        pong = {msg: 'pong'}
-        pong[:id] = message[:id] if message[:id]
-        websocket.send(pong.to_json)
-      end
-    end
-
     connect_message = {
       msg: 'connect',
       version: '1',

data/spec/metybur_spec.rb

@@ -86,17 +86,17 @@ describe Metybur do
   end
 
   context 'ping pong' do
-    it 'responds with pong to a ping' do
+    before :each do
       Metybur.connect(url)
+    end
 
+    it 'responds with pong to a ping' do
       websocket.receive({msg: 'ping'}.to_json)
-
       expect(last_sent_message[:msg]).to eq 'pong'
     end
 
     it 'includes the same id in the pong message' do
       id = FFaker::Guid.guid
-      Metybur.connect(url)
 
       websocket.receive({msg: 'ping', id: id}.to_json)
 
@@ -105,17 +105,15 @@ describe Metybur do
     end
 
     it "doesn't include an id if the ping message contained none" do
-      Metybur.connect(url)
-
       websocket.receive({msg: 'ping'}.to_json)
-
       expect(last_sent_message).not_to have_key :id
     end
   end
 
   context 'logging' do
+    let(:output) { StringIO.new }
+
     it "doesn't log any messages by default" do
-      output = StringIO.new
       Metybur.log_stream = output
       Metybur.connect(url)
 
@@ -125,7 +123,6 @@ describe Metybur do
     end
 
     it 'logs a message when the log level is set to debug' do
-      output = StringIO.new
       Metybur.log_level = :debug
       Metybur.log_stream = output
       Metybur.connect(url)
@@ -150,13 +147,12 @@ describe Metybur do
   end
 
   context 'collections' do
-    it 'gets notified when a record is added' do
-      collection = FFaker::Internet.user_name
-      id = FFaker::Guid.guid
-      fields = {city: FFaker::Address.city}
-
-      meteor = Metybur.connect(url)
+    let(:collection) { FFaker::Lorem.word }
+    let(:id) { FFaker::Guid.guid }
+    let!(:meteor) { Metybur.connect(url) }
+    let(:fields) { {city: FFaker::Address.city} }
 
+    it 'gets notified when a record is added' do
       wait_for_callback do |done|
         meteor.collection(collection)
           .on(:added) do |added_id, added_fields|
@@ -176,13 +172,8 @@ describe Metybur do
     end
 
     it 'gets notified when a record is changed' do
-      collection = FFaker::Internet.user_name
-      id = FFaker::Guid.guid
-      fields = {city: FFaker::Address.city}
       cleared = [FFaker::Guid.guid]
 
-      meteor = Metybur.connect(url)
-
       wait_for_callback do |done|
         meteor.collection(collection)
           .on(:changed) do |changed_id, changed_fields, cleared_fields|
@@ -204,11 +195,6 @@ describe Metybur do
     end
 
     it 'gets notified when a record is removed' do
-      collection = FFaker::Internet.user_name
-      id = FFaker::Guid.guid
-
-      meteor = Metybur.connect(url)
-
       wait_for_callback do |done|
         meteor.collection(collection)
           .on(:removed) do |removed_id|
@@ -226,7 +212,6 @@ describe Metybur do
     end
 
     it 'lets the `on` method be chainable' do
-      meteor = Metybur.connect(url)
       meteor.collection('my-collection')
         .on(:added) { anything }
         .on(:changed) { anything }
@@ -236,12 +221,6 @@ describe Metybur do
     end
 
     it 'registers multiple added callbacks' do
-      collection = FFaker::Internet.user_name
-      id = FFaker::Guid.guid
-      fields = {city: FFaker::Address.city}
-
-      meteor = Metybur.connect(url)
-
       wait_for_callback(calls: 2) do |done|
         meteor.collection(collection)
           .on(:added) { |added_id, added_fields| done.call() }
@@ -257,8 +236,19 @@ describe Metybur do
       end
     end
 
+    it 'does nothing if there is no callback for an event' do
+      meteor.collection(collection)
+      
+      message = {
+        msg: 'added',
+        collection: collection,
+        id: id,
+        fields: fields
+      }.to_json
+      websocket.receive message
+    end
+
     it "doesn't get notified of a ping message" do
-      meteor = Metybur.connect(url)
       meteor.collection('my-collection')
         .on(:added) { fail('Callback got called') }
 
@@ -266,7 +256,6 @@ describe Metybur do
     end
   
     it "doesn't get notified of a record from another collection" do
-      meteor = Metybur.connect(url)
       meteor.collection('my-collection')
         .on(:added) { fail('Callback got called') }
 
@@ -281,6 +270,8 @@ describe Metybur do
   end
 
   context 'methods' do
+    let!(:meteor) { Metybur.connect(url) }
+
     it 'calls a method through the call method' do
       method = %w(postChatMessage sendEmail submitOrder).sample
       params = %w(35 Vienna true).sample(2)
@@ -288,7 +279,6 @@ describe Metybur do
         .to_a.sample(2)
       params << Hash[hashParams]
 
-      meteor = Metybur.connect(url)
       meteor.call(method, params)
 
       expect(last_sent_message[:msg]).to eq 'method'
@@ -298,7 +288,6 @@ describe Metybur do
     end
 
     it 'calls a method called on the client directly' do
-      meteor = Metybur.connect(url)
       meteor.activate('user', id: 'utrtrvlc')
 
       expect(last_sent_message[:msg]).to eq 'method'
@@ -308,7 +297,6 @@ describe Metybur do
     end
 
     it 'camel-cases methods and parameters called on the client directly' do
-      meteor = Metybur.connect(url)
       meteor.activate_user('Hans', user_id: 'utrtrvlc', is_admin: false)
 
       expect(last_sent_message[:msg]).to eq 'method'
@@ -318,7 +306,6 @@ describe Metybur do
     end
 
     it 'passes the result to a block' do
-      meteor = Metybur.connect(url)
       expectation = proc { |result| expect(result[:price]).to eq 99 }
 
       wait_for_callback do |done|
@@ -337,17 +324,11 @@ describe Metybur do
     end
 
     it "doesn't trigger the callback for ping messages" do
-      meteor = Metybur.connect(url)
-
-      meteor.get_product(27) do
-        fail
-      end
-
+      meteor.get_product(27) { fail }
       websocket.receive({msg: 'ping'}.to_json)
     end
 
     it 'triggers the callback with the right result' do
-      meteor = Metybur.connect(url)
       expectation = proc { |result| expect(result[:price]).to eq 99 }
 
       wait_for_callback do |done|
@@ -371,7 +352,6 @@ describe Metybur do
     end
 
     it 'raises an error if an exception occurs in the method' do
-      meteor = Metybur.connect(url)
       error = FFaker::Lorem.word
       reason = FFaker::Lorem.sentence
       details = FFaker::Lorem.paragraph
@@ -402,7 +382,6 @@ describe Metybur do
     end
 
     it 'raises an error if an exception occurs in the method' do
-      meteor = Metybur.connect(url)
       error = FFaker::Lorem.word
       reason = FFaker::Lorem.sentence
       details = FFaker::Lorem.paragraph

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metybur
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Clemens Helm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -129,6 +129,9 @@ files:
 - lib/metybur/client.rb
 - lib/metybur/collection.rb
 - lib/metybur/method.rb
+- lib/metybur/middleware/json_middleware.rb
+- lib/metybur/middleware/logging_middleware.rb
+- lib/metybur/middleware/ping_pong_middleware.rb
 - lib/metybur/version.rb
 - metybur.gemspec
 - spec/metybur_spec.rb
@@ -154,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: DDP client for Ruby to connect to Meteor apps.