metybur 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8193384592b340b1a3f5fe89ca5c17df23dbabe
-  data.tar.gz: 7ef7c3b8a4eeb9f66ce756a7f7b3dc19e4293f3b
+  metadata.gz: 6cd1e4839ca1350e3e953be00f1428c1fbf31b84
+  data.tar.gz: e344a1a7e9537edd9eeb1f925518880b9f431e17
 SHA512:
-  metadata.gz: 053934c755a3801efb5f502991f73c50335ccd148525c761eef46f007527226c384f9604e69e0b37c181d2e44da7558dce0ae5b2f8a9e826ce7e5a22ac3114d0
-  data.tar.gz: ac70963429fdf3b0136f409508246f5e18f9130fb821b4bbfde614082db19365f4011b11fcf3037944f7564b51625650a784ec09d1d0d2e15efbfa15ef4df8f8
+  metadata.gz: 863a4003723aade726d6a753a15dacb6d5666f7dd5b5453048ed8eb9557f48dfb940d530431d3cc38e358de4fcdd3fd73793bb4f1af8264e85919d12409e062e
+  data.tar.gz: dd9b0fa2281be1a3441d6069c408b1b896e665dd93f5c3c57114ed9ce9fd2756295361cf7afccba14d299e4a019772bfaccbe1c336951ca7f545f535d7c59ca4

data/README.md

@@ -137,6 +137,24 @@ meteor.call('postChatMessage', inRoom: 'General')
 
 Note that you have to choose this syntax, if your Meteor method name collides with a Metybur method (like `collection` or `subscribe`).
 
+#### Results
+
+Since methods are executed asynchronously, they won't return a result immediately:
+
+```ruby
+# Doesn't work!
+messages = meteor.chat_messages(in_room: 'General')
+messages.each { |message| puts message }
+```
+
+Instead, pass a block to the method. The block will get called once the result arrives.
+
+```ruby
+meteor.chat_messages(in_room: 'General') do |messages|
+  messages.each { |message| puts message }
+end
+```
+
 ### Logging
 
 To debug your application, you can lower the log level to see all incoming websocket messages.

data/lib/metybur/client.rb

@@ -1,5 +1,6 @@
 require 'active_support/inflector'
 require_relative 'collection'
+require_relative 'method'
 
 class Metybur::Client
   def initialize(websocket)
@@ -19,17 +20,15 @@ class Metybur::Client
     Metybur::Collection.new(name, @websocket)
   end
 
-  def call(method, params)
-    message = {
-      msg: 'method',
-      id: 'efg',
-      method: method,
-      params: params
-    }.to_json
-    @websocket.send message
+  def method(name)
+    Metybur::Method.new(name, @websocket)
+  end
+
+  def call(method_name, params, &block)
+    method(method_name).call(params, &block)
   end
 
-  def method_missing(method, *params)
+  def method_missing(method, *params, &block)
     method = method.to_s.camelize(:lower)
     params.map! do |param|
       case param
@@ -40,6 +39,6 @@ class Metybur::Client
         param
       end
     end
-    call(method, params)
+    call(method, params, &block)
   end
 end

data/lib/metybur/method.rb

@@ -0,0 +1,33 @@
+class Metybur::Method
+  def initialize(name, websocket)
+    require 'securerandom'
+
+    @name = name
+    @websocket = websocket
+    @callbacks = {}
+
+    @websocket.on(:message) do |event|
+      attributes = JSON.parse(event.data, symbolize_names: true)
+      handle_message(attributes) if attributes[:msg] == 'result'
+    end
+  end
+
+  def call(params, &block)
+    id = SecureRandom.uuid
+    message = {
+      msg: 'method',
+      id: id,
+      method: @name,
+      params: params
+    }.to_json
+    @websocket.send message
+    @callbacks[id] = block
+  end
+
+  private
+
+  def handle_message(attributes)
+    id = attributes[:id]
+    @callbacks[id].call attributes[:result] if @callbacks[id]
+  end
+end

data/lib/metybur/version.rb

@@ -1,3 +1,3 @@
 module Metybur
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/metybur.rb

@@ -31,7 +31,9 @@ module Metybur
     websocket.on(:message) do |event|
       message = JSON.parse(event.data, symbolize_names: true)
       if message[:msg] == 'ping'
-        websocket.send({msg: 'pong'}.to_json)
+        pong = {msg: 'pong'}
+        pong[:id] = message[:id] if message[:id]
+        websocket.send(pong.to_json)
       end
     end
 

data/spec/metybur_spec.rb

@@ -16,8 +16,16 @@ describe Metybur do
     JSON.parse(string_data, symbolize_names: true)
   end
 
+  def wait_for_callback(options = {})
+    calls = options[:calls] || 1 # No keyword arguments in Ruby 1.9.3
+    times_called = 0
+    done = -> { times_called += 1 }
+    yield done
+    fail("Callback only got called #{times_called} time(s).") if times_called < calls
+  end
+
   it 'connects to a Meteor URL' do
-    Metybur.connect url
+    Metybur.connect(url)
 
     expect(websocket.url).to eq url
     connect_message = parse(websocket.sent.first)
@@ -32,7 +40,7 @@ describe Metybur do
       email = FFaker::Internet.email
       password = FFaker::Internet.password
 
-      Metybur.connect url, email: email, password: password
+      Metybur.connect(url, email: email, password: password)
 
       expect(last_sent_message[:msg]).to eq 'method'
       expect(last_sent_message).to have_key :id # we don't care about the value here
@@ -46,7 +54,7 @@ describe Metybur do
       username = FFaker::Internet.user_name
       password = FFaker::Internet.password
 
-      Metybur.connect url, username: username, password: password
+      Metybur.connect(url, username: username, password: password)
 
       expect(last_sent_message[:msg]).to eq 'method'
       expect(last_sent_message).to have_key :id # we don't care about the value here
@@ -60,7 +68,7 @@ describe Metybur do
       userid = FFaker::Guid.guid
       password = FFaker::Internet.password
 
-      Metybur.connect url, id: userid, password: password
+      Metybur.connect(url, id: userid, password: password)
 
       expect(last_sent_message[:msg]).to eq 'method'
       expect(last_sent_message).to have_key :id # we don't care about the value here
@@ -71,7 +79,7 @@ describe Metybur do
     end
 
     it "doesn't log in without credentials" do
-      Metybur.connect url
+      Metybur.connect(url)
 
       expect(last_sent_message[:msg]).to eq 'connect'
     end
@@ -79,20 +87,37 @@ describe Metybur do
 
   context 'ping pong' do
     it 'responds with pong to a ping' do
-      Metybur.connect url
+      Metybur.connect(url)
 
       websocket.receive({msg: 'ping'}.to_json)
 
       expect(last_sent_message[:msg]).to eq 'pong'
     end
-  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)
+
+      expect(last_sent_message[:msg]).to eq 'pong'
+      expect(last_sent_message[:id]).to eq id
+    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
     it "doesn't log any messages by default" do
       output = StringIO.new
       Metybur.log_stream = output
-      Metybur.connect url
+      Metybur.connect(url)
 
       websocket.receive({msg: 'logged_message'}.to_json)
 
@@ -103,7 +128,7 @@ describe Metybur do
       output = StringIO.new
       Metybur.log_level = :debug
       Metybur.log_stream = output
-      Metybur.connect url
+      Metybur.connect(url)
       
       websocket.receive({msg: 'logged_message'}.to_json)
 
@@ -115,7 +140,7 @@ describe Metybur do
     it 'subscribes to a published record set' do
       record_set = FFaker::Internet.user_name
 
-      meteor = Metybur.connect url
+      meteor = Metybur.connect(url)
       meteor.subscribe(record_set)
 
       expect(last_sent_message[:msg]).to eq 'sub'
@@ -125,20 +150,12 @@ describe Metybur do
   end
 
   context 'collections' do
-    def wait_for_callback(options = {})
-      calls = options[:calls] || 1 # No keyword arguments in Ruby 1.9.3
-      times_called = 0
-      done = -> { times_called += 1 }
-      yield done
-      fail("Callback only got called #{times_called} time(s).") if times_called < calls
-    end
-
     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
+      meteor = Metybur.connect(url)
 
       wait_for_callback do |done|
         meteor.collection(collection)
@@ -164,7 +181,7 @@ describe Metybur do
       fields = {city: FFaker::Address.city}
       cleared = [FFaker::Guid.guid]
 
-      meteor = Metybur.connect url
+      meteor = Metybur.connect(url)
 
       wait_for_callback do |done|
         meteor.collection(collection)
@@ -190,7 +207,7 @@ describe Metybur do
       collection = FFaker::Internet.user_name
       id = FFaker::Guid.guid
 
-      meteor = Metybur.connect url
+      meteor = Metybur.connect(url)
 
       wait_for_callback do |done|
         meteor.collection(collection)
@@ -223,7 +240,7 @@ describe Metybur do
       id = FFaker::Guid.guid
       fields = {city: FFaker::Address.city}
 
-      meteor = Metybur.connect url
+      meteor = Metybur.connect(url)
 
       wait_for_callback(calls: 2) do |done|
         meteor.collection(collection)
@@ -299,5 +316,56 @@ describe Metybur do
       expect(last_sent_message).to have_key :id # we don't care about the value here
       expect(last_sent_message[:params]).to eq ['Hans', {userId: 'utrtrvlc', isAdmin: false}]
     end
+
+    it 'passes the result to a block' do
+      meteor = Metybur.connect(url)
+
+      wait_for_callback do |done|
+        meteor.get_product(27) do |product|
+          done.call
+          expect(product[:price]).to eq 99
+        end
+
+        id = last_sent_message[:id]
+        websocket.receive({
+          msg: 'result',
+          id: id,
+          result: {price: 99}
+        }.to_json)
+      end
+    end
+
+    it "doesn't trigger the callback for ping messages" do
+      meteor = Metybur.connect(url)
+
+      meteor.get_product(27) do |product|
+        fail
+      end
+
+      websocket.receive({msg: 'ping'}.to_json)
+    end
+
+    it 'triggers the callback with the right result' do
+      meteor = Metybur.connect(url)
+
+      wait_for_callback do |done|
+        meteor.get_product(27) do |product|
+          done.call
+          expect(product[:price]).to eq 99
+        end
+
+        id = last_sent_message[:id]
+        websocket.receive({
+          msg: 'result',
+          id: 'abc',
+          result: {price: 19}
+        }.to_json)
+        websocket.receive({
+          msg: 'result',
+          id: id,
+          result: {price: 99}
+        }.to_json)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metybur
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Clemens Helm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -128,6 +128,7 @@ files:
 - lib/metybur.rb
 - lib/metybur/client.rb
 - lib/metybur/collection.rb
+- lib/metybur/method.rb
 - lib/metybur/version.rb
 - metybur.gemspec
 - spec/metybur_spec.rb