metybur 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d88b017da86178defe787f323b432f6be6f69884
-  data.tar.gz: ee68c9a15f92b134c61cd0b0ae2eaa59f8da52e3
+  metadata.gz: 2ac162b165fe7dd83047c24e2f4a89be9a0fa28e
+  data.tar.gz: 532cc2a90d625cfab46bff3a96b281e455f3e548
 SHA512:
-  metadata.gz: 1ef952a06c43c9be058194c38d471188e7a67d774b9720c75cca34f74363362884ee6b9808b7556a3b07236582ad108d897dfa6d084243e29375a57480c6047c
-  data.tar.gz: 376901b6f18c5f5f1ccaf4ab4ce26e586c699c77b18ac89da320d458d8d8f176a17a9933a0d647ca19853211a25defe62beae1a5accd7dbe5d06599034646e2a
+  metadata.gz: 00aa652b42b18209f40cdb79ea2a6591742cc7cb8fcebf30df3acdff2e4a9eca80a9ba1f0a3d094e0f456f0598117e36447d91f01a2b68726026c86039702003
+  data.tar.gz: 73f236b005a50ebf862757f1bf11aca5d121c24f5a98e1463ea91e7192298d36c679c414517094a8cb5040d7379080b0e88b04269247e8aff7d8035763be24e7

data/.travis.yml

@@ -1,9 +1,5 @@
 language: ruby
 rvm:
-  - 2.2.0
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
-  - jruby-19mode
+  - 2.3.0
+  - 2.2.2
   - ruby-head
-  - jruby-head

data/README.md

@@ -9,11 +9,11 @@ to subscribe to collections and to receive updates on them.
 You can also call Meteor methods from Ruby.
 
 > ## Caution!
-> 
-> 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.
-> 
+>
+> This gem isn't at version 1 yet 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!
-> 
+>
 > Clemens
 
 ## Installation
@@ -86,6 +86,12 @@ meteor = Metybur.connect('http://my-meteor-app.org:80/websocket')
 meteor.subscribe('my-chat-messages')
 ```
 
+Subscription arguments can be passed right after the collection name:
+
+```ruby
+meteor.subscribe('my-chat-messages', 10, channel: 'random')
+```
+
 ### Collections
 
 Once you've subscribed, you will receive all records that are already in the record set. The record set contains records from one or more collections. You can process these records as they arrive:
@@ -192,6 +198,15 @@ Metybur.log_level = :debug
 
 Make sure to set the log level before calling `Metybur.connect`, as it won't have any effect afterwards.
 
+
+### Reconnecting
+
+When the websocket connection is lost, Metybur will try to reconnect to your Meteor app.
+After the reconnect the `login` method is called and all your subscriptions are subscribed again.
+
+This means in particular that all documents get sent again and therefore all your
+collections' `added` callbacks will get triggered again.
+
 ## Contributing
 
 1. Fork it ( https://github.com/clemenshelm/metybur/fork )

data/lib/metybur/client.rb

@@ -3,21 +3,29 @@ require_relative 'collection'
 require_relative 'method'
 
 class Metybur::Client
-  def initialize(websocket)
-    @websocket = websocket
+  attr_writer :websocket
+
+  def initialize(credentials)
+    @credentials = credentials.freeze
+    @subscription_messages = []
+    @collections = []
   end
 
-  def subscribe(record_set_name)
+  def subscribe(record_set_name, *params)
     message = {
       msg: 'sub',
       id: 'cde',
-      name: record_set_name
+      name: record_set_name,
+      params: params
     }.to_json
+    @subscription_messages << message
     @websocket.send message
   end
 
   def collection(name)
-    Metybur::Collection.new(name, @websocket)
+    Metybur::Collection.new(name, @websocket).tap do |collection|
+      @collections << collection
+    end
   end
 
   def method(name)
@@ -41,4 +49,27 @@ class Metybur::Client
     end
     call(method, params, &block)
   end
+
+  def resubscribe
+    @subscription_messages.each { |message| @websocket.send(message) }
+    @collections.each { |collection| collection.websocket = @websocket }
+  end
+
+  def connect
+    connect_message = {
+      msg: 'connect',
+      version: '1',
+      support: ['1']
+    }
+    @websocket.send(connect_message.to_json)
+
+    credentials = @credentials.dup
+    password = credentials.delete(:password)
+    if password
+      this = self
+      login(user: credentials, password: password) { this.resubscribe }
+    else
+      resubscribe
+    end
+  end
 end

data/lib/metybur/collection.rb

@@ -1,10 +1,14 @@
 class Metybur::Collection
   def initialize(collection_name, websocket)
+    @collection_name = collection_name
     @callbacks = {}
+    self.websocket = websocket
+  end
 
+  def websocket=(websocket)
     websocket.on(:message) do |event|
       attributes = JSON.parse(event.data, symbolize_names: true)
-      handle_message(attributes) if attributes[:collection] == collection_name
+      handle_message(attributes) if attributes[:collection] == @collection_name
     end
   end
 

data/lib/metybur/version.rb

@@ -1,3 +1,3 @@
 module Metybur
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/metybur.rb

@@ -15,43 +15,14 @@ module Metybur
   }
 
   def self.connect(url, credentials = {})
-    websocket = CONFIG[:websocket_client_class].new(url)
-    client = Metybur::Client.new(websocket)
-
-    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|
-      middleware.inject(event) { |e, mw| mw.open(e) }
-    end
-    websocket.on(:message) do |event|
-      middleware.inject(event) { |e, mw| mw.message(e) }
-    end
-    websocket.on(:close) do |event|
-      middleware.inject(event) { |e, mw| mw.close(e) }
-      EM.stop_event_loop
-    end
-
-    connect_message = {
-      msg: 'connect',
-      version: '1',
-      support: ['1']
-    }
-    websocket.send(connect_message.to_json)
-
-    password = credentials.delete(:password)
-    return client unless password
-    client.login(user: credentials, password: password)
-
-    client
+    connection = Connection.new(url, credentials)
+    connection.connect_client
   end
 
   def self.websocket_client_class=(klass)
     CONFIG[:websocket_client_class] = klass
   end
-  
+
   def self.log_level=(level_symbol)
     upcase_symbol = level_symbol.to_s.upcase.to_sym
     CONFIG[:log_level] = Logger.const_get(upcase_symbol)
@@ -60,4 +31,36 @@ module Metybur
   def self.log_stream=(io)
     CONFIG[:log_stream] = io
   end
+
+  class Connection
+    def initialize(url, credentials)
+      @url, @credentials = url, credentials
+    end
+
+    def connect_client(client = Metybur::Client.new(@credentials))
+      websocket = CONFIG[:websocket_client_class].new(@url)
+      client.websocket = websocket
+      client.connect
+
+      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|
+        middleware.inject(event) { |e, mw| mw.open(e) }
+      end
+      websocket.on(:message) do |event|
+        middleware.inject(event) { |e, mw| mw.message(e) }
+      end
+      websocket.on(:close) do |event|
+        middleware.inject(event) { |e, mw| mw.close(e) }
+
+        # Reconnect
+        connect_client(client)
+      end
+
+      client
+    end
+  end
 end

data/metybur.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-collection_matchers"
   spec.add_development_dependency "ffaker"
   spec.add_development_dependency "pry"
 end

data/spec/metybur_spec.rb

@@ -35,6 +35,20 @@ describe Metybur do
              support: ['1']
   end
 
+  it 'reconnects to a Meteor URL' do
+    meteor = Metybur.connect(url)
+
+    # Reconnect
+    new_connection = WebsocketMock.new(websocket.url)
+    meteor.websocket = new_connection
+    meteor.connect
+
+    expect(last_sent_message)
+      .to eq msg: 'connect',
+             version: '1',
+             support: ['1']
+  end
+
   context 'logging in' do
     it 'calls the login method with email and password' do
       email = FFaker::Internet.email
@@ -83,6 +97,25 @@ describe Metybur do
 
       expect(last_sent_message[:msg]).to eq 'connect'
     end
+
+    it "logs in on reconnect" do
+      userid = FFaker::Guid.guid
+      password = FFaker::Internet.password
+
+      meteor = Metybur.connect(url, id: userid, password: password)
+
+      # Reconnect
+      new_connection = WebsocketMock.new(websocket.url)
+      meteor.websocket = new_connection
+      meteor.connect
+
+      expect(last_sent_message[:msg]).to eq 'method'
+      expect(last_sent_message).to have_key :id # we don't care about the value here
+      expect(last_sent_message[:method]).to eq 'login'
+      expect(last_sent_message[:params][0])
+        .to eq user: { id: userid },
+               password: password
+    end
   end
 
   context 'ping pong' do
@@ -126,7 +159,7 @@ describe Metybur do
       Metybur.log_level = :debug
       Metybur.log_stream = output
       Metybur.connect(url)
-      
+
       websocket.receive({msg: 'logged_message'}.to_json)
 
       expect(output.string).not_to be_empty
@@ -144,6 +177,31 @@ describe Metybur do
       expect(last_sent_message).to have_key :id # we don't care about the value here
       expect(last_sent_message[:name]).to eq record_set
     end
+
+    it 'should allow you to pass parameters' do
+      record_set = FFaker::Internet.user_name
+      meteor = Metybur.connect(url)
+      meteor.subscribe(record_set, 'abc', lala: 'foo')
+      expect(last_sent_message[:msg]).to eq 'sub'
+      expect(last_sent_message).to have_key :params
+      expect(last_sent_message[:params]).to eq ['abc', {:lala => 'foo'}]
+    end
+
+    it 'subscribes again on a new connection' do
+      record_set = FFaker::Internet.user_name
+
+      meteor = Metybur.connect(url)
+      meteor.subscribe(record_set, 'abc', lala: 'foo')
+
+      # Reconnect
+      new_connection = WebsocketMock.new(websocket.url)
+      meteor.websocket = new_connection
+      meteor.connect
+
+      expect(last_sent_message[:msg]).to eq 'sub'
+      expect(last_sent_message).to have_key :params
+      expect(last_sent_message[:params]).to eq ['abc', {:lala => 'foo'}]
+    end
   end
 
   context 'collections' do
@@ -238,7 +296,7 @@ describe Metybur do
 
     it 'does nothing if there is no callback for an event' do
       meteor.collection(collection)
-      
+
       message = {
         msg: 'added',
         collection: collection,
@@ -254,7 +312,7 @@ describe Metybur do
 
       websocket.receive({msg: 'ping'}.to_json)
     end
-  
+
     it "doesn't get notified of a record from another collection" do
       meteor.collection('my-collection')
         .on(:added) { fail('Callback got called') }
@@ -267,6 +325,30 @@ describe Metybur do
       }.to_json
       websocket.receive message
     end
+
+    it 'still gets notified when a record is added after reconnect' do
+      wait_for_callback do |done|
+        meteor.collection(collection)
+          .on(:added) do |added_id, added_fields|
+            done.call()
+            expect(added_id).to eq id
+            expect(added_fields).to eq fields
+          end
+
+        # reconnect
+        new_connection = WebsocketMock.new(websocket.url)
+        meteor.websocket = new_connection
+        meteor.connect
+
+        message = {
+          msg: 'added',
+          collection: collection,
+          id: id,
+          fields: fields
+        }.to_json
+        new_connection.receive message
+      end
+    end
   end
 
   context 'methods' do

data/spec/mocks/websocket_mock.rb

@@ -6,7 +6,7 @@ class WebsocketMock
   MessageEvent = Struct.new(:data)
 
   attr_reader :url, :sent
-  
+
   def initialize(url)
     WebsocketMock.instance = self
     @url = url

data/spec/spec_helper.rb

@@ -16,6 +16,8 @@
 # users commonly want.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'rspec/collection_matchers'
+
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metybur
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Clemens Helm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-17 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  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: ffaker
   requirement: !ruby/object:Gem::Requirement
@@ -157,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: DDP client for Ruby to connect to Meteor apps.