live_resource 0.0.1 → 0.0.2

data/lib/live_resource/builder.rb

@@ -30,7 +30,7 @@ Registered dependency types are: #{@dependency_types.inspect}
       @identifier_proc = block
 
       @resource_class.class_eval do
-        define_method(:identifier, &block)
+        define_method(:_identifier, &block)
       end
     end
 

data/lib/live_resource/protocol.rb

@@ -1,4 +1,13 @@
 module LiveResource
+
+  # Protocols are used by the Resource class to notify people interested in the resource that something's happened.
+  # This module defines the public behaviour of a protocol, in terms of the internal method #publish_message.
+  #
+  # Protocol classes must implement the #publish_message and #encode_identifier methods.
+  #  - #publish_message(resource_id, message) publishes `message` to the resource matching the identifier (where
+  #    message is a hash)
+  #  - #encode_identifier(resource_id) transforms an identifier string as appropriate for the protocol (e.g.
+  #    sanitizing unsafe characters or obfuscating the actual resource ID)
   module Protocol
 
     def publish_resource_reset(identifier)

data/lib/live_resource/resource.rb

@@ -10,7 +10,9 @@ module LiveResource
     end
 
     def identifier(*context)
-      raise "You must define an identifier method for the resource '#{@name}'"
+      raise "You must define an identifier method for the resource '#{@name}'" unless respond_to?(:_identifier)
+      raw_identifier = _identifier(*context)
+      @protocol.encode_identifier(raw_identifier)
     end
 
     def push(*context)

data/lib/live_resource/version.rb

@@ -1,3 +1,3 @@
 module LiveResource
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/live_resource/builder_spec.rb

@@ -125,7 +125,7 @@ describe LiveResource::Builder do
 
     it "should define a new identifier method on the resource subclass" do
       subject
-      expect(builder.resource.identifier(1, 2)).to eq([1, 2])
+      expect(builder.resource._identifier(1, 2)).to eq([1, 2])
     end
   end
 

data/spec/live_resource/resource_spec.rb

@@ -3,7 +3,8 @@ require "live_resource/resource"
 
 describe LiveResource::Resource do
 
-  let(:resource) { LiveResource::Resource.new(resource_name, protocol) }
+  let(:resource_class) { Class.new(LiveResource::Resource) }
+  let(:resource) { resource_class.new(resource_name, protocol) }
   let(:resource_name) { "some_resource" }
   let(:protocol) { double(LiveResource::Protocol) }
 
@@ -20,9 +21,38 @@ describe LiveResource::Resource do
   describe "#identifier" do
     subject { resource.identifier(:a, :b) }
 
-    it "should raise an exception" do
-      expect(lambda { subject }).to raise_exception
+    context "when #_identifier is undefined" do
+      it "should raise an exception" do
+        expect(lambda { subject }).to raise_exception
+      end
     end
+
+    context "when #_identifier is defined" do
+      let(:raw_identifier) { 'raw_identifier' }
+      let(:encoded_identifier) { 'encoded_identifier' }
+
+      before do
+        _raw_identifier = raw_identifier
+        resource_class.instance_eval do
+          define_method(:_identifier) { |*args| _raw_identifier }
+        end
+        protocol.stub(encode_identifier: encoded_identifier)
+      end
+
+      it "should not raise an exception" do
+        expect(lambda { subject }).to_not raise_exception
+      end
+
+      it "should encode the identifier" do
+        protocol.should_receive(:encode_identifier).with(raw_identifier)
+        subject
+      end
+
+      it "should return the encoded identifier" do
+        expect(subject).to eq encoded_identifier
+      end
+    end
+
   end
 
   describe "#push" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: live_resource
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-08 00:00:00.000000000 Z
+date: 2013-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,12 +118,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3868480263717602722
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3868480263717602722
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25