entangled 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 494cf5b44c0dfd9bcab9e70540e048f5673ece7d
-  data.tar.gz: db4d77e01e589148f03dac03fac802f515bfecfd
+  metadata.gz: 9c1338c6837e0167bc7fab4bf7f0ca67a2e572ba
+  data.tar.gz: 27dc18b0cb3570ae172c603baca469a8958ead45
 SHA512:
-  metadata.gz: 39587a9ec99d12235f0bfc1d32d67a360358183cbecf7d6247a935c02ef6fb46624a7fc221f01d759bc40b383383bf26f2fce6fe38f0e93837afe647c7d7e9f3
-  data.tar.gz: cb264b51a9afc3de28478ab4ebb3c5c676e49e2126ed8a4c8dbc845dd3c288fdef89b07bb6448c84867bfcaedb43b86453a3ab227b88f0f50856619cfbc9305f
+  metadata.gz: 89baa6f21fd914f7e8f6664a5712ac6af91891bb210b28be642c0b5acd36f6bf287e70a7a39888f2cf8e17397ed0bd3d1de06b66ea8bded1982d08946c7273e9
+  data.tar.gz: edcafa59d08bfedb94741745f7a6fb8365ff87a68fd8a83ac2409876bdd8601e0fd0bc9a9be40730a1a3ee5f035a173c2fc1d6eb4f8b4ae82e5d919c096d0a38

data/README.md

@@ -192,7 +192,7 @@ app.factory('Message', function(Entangled) {
 });
 ```
 
-In the above example, first you inject Entangled into your service, then instantiate a new Entangled service passing it the socket to the index action of that resource in your backend (in this case, `/messages`), and then add helper methods to your service.
+In the above example, first we inject Entangled into our service, then instantiate a new Entangled object. The Entangled object takes one argument when instantiated: the URL of your resource's index route (in this case, `/messages`). Then we add helper methods to our service. Note that the socket URL looks just like a standard restful URL with http, except that the protocol part has been switched with `ws` to use the websocket protocol. Also note that you need to use `wss` instead if you want to use SSL.
 
 In your controller, you could then inject that `Message` service and use it like so:
 
@@ -236,11 +236,16 @@ This gem is best used for Rails apps that serve as APIs only and are not concern
 The gem rely's heavily on convention over configuration and currently only works with restful style controllers as shown above. More customization will be available soon.
 
 ## Contributing
-1. Fork it ( https://github.com/dchacke/entangled/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
+1. [Fork it](https://github.com/dchacke/entangled/fork) - you will notice that the repo comes with a back end and a front end part to test both parts of the gem
+2. Run `$ bundle install` in the root of the repo
+3. Run `$ bower install` and `$ npm install` in spec/dummy/public
+4. The back end example app resides in spec/dummy; you can run `rails` and `rake` commands in there if you prefix them with `bin/`, i.e. `$ bin/rails s` or `$ bin/rake db:schema:load`; run your tests in the root of the repo by running `$ rspec`
+5. The front end example app resides in spec/dummy/public. To look at it in your browser, cd into spec/dummy/public and run `$ bin/rails s`. Tests for this part of the app can be located under spec/dummy/public/test and are written with Jasmine. To run the tests, first run `$ bin/rails -e test` to start up the server in test mode, and then run `$ grunt test` in a new terminal tab. It's important to remember that changes you make to the server will not take effect until you restart the server since you're running it in the test environment!
+6. Write your tests
+7. Write your feature to make the tests pass
+8. Stage and commit your changes
+9. Push to a new feature branch in your repo
+10. Send me a pull request!
 
 ## Credits
 Thanks to [Ilias Tsangaris](https://github.com/iliastsangaris) for inspiring the name "Entanglement" based on [Quantum Entanglement](http://en.wikipedia.org/wiki/Quantum_entanglement) where pairs or groups of particles always react to changes as a whole, i.e. changes to one particle will result in immediate change of all particles in the group.

data/lib/entangled/controller.rb

@@ -144,16 +144,35 @@ module Entangled
             tubesock.onmessage do |m|
               params[resource_name.to_sym] = JSON.parse(m)
               yield
+
+              # Send resource that was just created back to client. The resource
+              # on the client will be overridden with this one. This is important
+              # so that the id, created_at and updated_at and possibly other
+              # attributes arrive on the client
+              if member
+                tubesock.send_data({
+                  resource: member
+                }.to_json)
+              end
             end
 
           # If the controller's action name is 'update', a record should be
           # updated. Before yielding, the params hash has to be prepared
-          # with attributes sent to the socket. The default attributes
-          # id, created_at, and updated_at should not be included in params.
+          # with attributes sent to the socket
           when 'update'
             tubesock.onmessage do |m|
               params[resource_name.to_sym] = JSON.parse(m)
               yield
+
+              # Send resource that was just updated back to client. The resource
+              # on the client will be overridden with this one. This is important
+              # so that the new updated_at and possibly other attributes arrive
+              # on the client
+              if member
+                tubesock.send_data({
+                  resource: member
+                }.to_json)
+              end
             end
 
           # For every other controller action, simply wrap whatever is

data/lib/entangled/model.rb

@@ -70,6 +70,15 @@ module Entangled
     module InstanceMethods
       include Entangled::Helpers
 
+      # Override the as_json method so that the
+      # JSON representation of the resource includes
+      # its errors. This is necessary so that errors
+      # are sent back to the client along with the
+      # resource on create and update
+      def as_json(options = {})
+        attributes.merge(errors: errors).as_json
+      end
+
       private
 
       # Publishes to client. Whoever is subscribed

data/lib/entangled/version.rb

@@ -1,3 +1,3 @@
 module Entangled
-  VERSION = "0.0.15"
+  VERSION = "0.0.16"
 end

data/spec/dummy/app/controllers/messages_controller.rb

@@ -2,7 +2,6 @@
 # controller with all five actions
 class MessagesController < ApplicationController
   include Entangled::Controller
-  # before_action :destroy_all, only: :create, if: -> { Rails.env.test? }
 
   def index
     broadcast do
@@ -18,13 +17,14 @@ class MessagesController < ApplicationController
 
   def create
     broadcast do
-      Message.create(message_params)
+      @message = Message.create(message_params)
     end
   end
 
   def update
     broadcast do
-      Message.find(params[:id]).update(message_params)
+      @message = Message.find(params[:id])
+      @message.update(message_params)
     end
   end
 
@@ -38,9 +38,4 @@ private
   def message_params
     params.require(:message).permit(:body)
   end
-
-  # For test purposes
-  def destroy_all
-    Message.destroy_all
-  end
 end

data/spec/dummy/app/models/message.rb

@@ -1,4 +1,6 @@
 class Message < ActiveRecord::Base
   include Entangled::Model
   entangle
+
+  validates :body, presence: true
 end

data/spec/dummy/config/environments/test.rb

@@ -51,7 +51,11 @@ Rails.application.configure do
       Message.destroy_all
 
       # Create one dummy message that the JS tests depend on
-      Message.create body: 'foo'
+      Message.create! body: 'foo'
     end
   end
+
+  # Configure log because the server won't log anything otherwise
+  # config.logger = Logger.new(STDOUT)
+  # config.logger.level = Logger::ERROR
 end

data/spec/dummy/public/app/entangled/entangled.js

@@ -36,15 +36,45 @@ angular.module('entangled', [])
 
         if (callback) callback();
       };
+
+      // Receive updated resource from server
+      socket.onmessage = function(event) {
+        if (event.data) {
+          var data = JSON.parse(event.data);
+
+          // Assign/override new data (such as updated_at, etc)
+          if (data.resource) {
+            for (key in data.resource) {
+              that[key] = data.resource[key];
+            }
+          }
+        }
+      };
     } else {
       // Create
       var socket = new WebSocket(that.webSocketUrl + '/create');
 
+      // Send attributes to server
       socket.onopen = function() {
         socket.send(JSON.stringify(that));
 
         if (callback) callback();
       };
+
+      // Receive saved resource from server
+      socket.onmessage = function(event) {
+        if (event.data) {
+          var data = JSON.parse(event.data);
+
+          // Assign/override new data (such as id, created_at,
+          // updated_at, etc)
+          if (data.resource) {
+            for (key in data.resource) {
+              that[key] = data.resource[key];
+            }
+          }
+        }
+      };
     }
   };
 

data/spec/dummy/public/test/controllers/messages_test.js

@@ -49,10 +49,26 @@ describe('MessagesCtrl', function () {
     setTimeout(function() {
       var oldLength = scope.messages.length;
 
+      // Assert it's a new message
+      expect(scope.message.id).not.toBeDefined();
+
+      // Be sure to pass validations in the back end
+      scope.message.body = 'foo';
+
+      // Save it
       scope.message.$save(function() {
         setTimeout(function() {
+          // Make sure that the message was added to the collection
           expect(scope.messages.length).toBe(oldLength + 1);
-          done();
+
+          // Make sure that it has been persisted and new attributes
+          // were sent over from the back end and updated here
+          setTimeout(function() {
+            expect(scope.message.id).toBeDefined();
+            expect(scope.message.created_at).toBeDefined();
+            expect(scope.message.updated_at).toBeDefined();
+            done();
+          }, 100);
         }, 100);
       });      
     }, 100);
@@ -66,12 +82,49 @@ describe('MessagesCtrl', function () {
       // Assert that message has been persisted before
       expect(message.id).toBeDefined();
 
+      // Remember old updated_at
+      var oldUpdatedAt = message.updated_at;
+
       // Update it
       message.body = 'new body';
       message.$save(function() {
         setTimeout(function() {
           // Assert that message was updated across collection
-          expect(scope.messages[0].body).toEqual('new body');
+          expect(scope.messages[0].body).toBe('new body');
+
+          // Assert that message was actually updated in back end
+          // and attributes have been updated here
+          expect(scope.message.updated_at).not.toBe(oldUpdatedAt);
+          done();
+        }, 100);
+      });
+    }, 100);
+  });
+
+  it('gets validation errors', function(done) {
+    setTimeout(function() {
+      // Pick first message
+      var message = scope.messages[0];
+
+      // Assert that message has been persisted before
+      expect(message.id).toBeDefined();
+
+      // Update it so it won't pass validations in the back end
+      message.body = '';
+
+      // Remember old updated_at
+      var oldUpdatedAt = message.updated_at;
+
+      // Save it
+      message.$save(function() {
+        setTimeout(function() {
+          // Assert that message was not updated on server
+          expect(message.updated_at).toBe(oldUpdatedAt);
+
+          // Assert that the message has error messages attached
+          // to it
+          expect(message.errors.body).toEqual(["can't be blank"])
+
           done();
         }, 100);
       });

data/spec/models/message_spec.rb

@@ -106,5 +106,19 @@ RSpec.describe Message, type: :model do
         end
       end
     end
+
+    describe '#as_json' do
+      it 'includes errors' do
+        message = Message.create
+        expect(message.as_json["errors"][:body]).to include "can't be blank"
+      end
+    end
+  end
+
+  describe 'Validations' do
+    it 'validates presence of the body' do
+      message = Message.create
+      expect(message.errors[:body]).to include "can't be blank"
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: entangled
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Dennis Charles Hackethal
@@ -9831,6 +9831,7 @@ files:
 - spec/dummy/public/test/controllers/messages_test.js
 - spec/dummy/public/views/messages/index.html
 - spec/dummy/public/views/messages/show.html
+- spec/dummy/tmp/pids/server.pid
 - spec/models/inclusion_exclusion_spec.rb
 - spec/models/message_spec.rb
 - spec/routing/inclusion_exclusion_routing_spec.rb
@@ -19516,6 +19517,7 @@ test_files:
 - spec/dummy/public/views/messages/show.html
 - spec/dummy/Rakefile
 - spec/dummy/README.rdoc
+- spec/dummy/tmp/pids/server.pid
 - spec/models/inclusion_exclusion_spec.rb
 - spec/models/message_spec.rb
 - spec/routing/inclusion_exclusion_routing_spec.rb