pod4 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8a9606d06dd2634ff0382a7985c25e65c1dd21e0
-  data.tar.gz: 8a4dd824c41d8fc213dd1ebd3d29f53f2f2912d0
+SHA256:
+  metadata.gz: 2136af8ee4ba964aecab03dc618b2573e3b2d13883d3ab6965db115922a6ed67
+  data.tar.gz: 485443950826a519387cf740a0e6b7d8ebd3b3fa747e9fb8202f31e95f991362
 SHA512:
-  metadata.gz: c8cf85e89a6f2135e51712a6d5b06c1c233dfdc31c03852d9f4bfaf4ea3dbe7116bf1d0e81c425bdc2c91361a9811c0dee127092086c57fbf89f236e854bec34
-  data.tar.gz: 192f0df1a101076226c8574d53eb9dd5db353422e8f279f2e575f87e00df8c47e7a8f323cae8b226e6694a4acd5e23db33cb41074b2473e0ffe3573218b5c61d
+  metadata.gz: aa2d550a2c50e9ec82a77e786b00b3f4250356964f946eb3a5235aecd0e76bc464f17176669baf40054db788fb81347c545ce2ce014d5459fadb9aceac1822b0
+  data.tar.gz: cb2081a8903ffd66c2d67e98162875101da19480390ffb795042099f7352d5a3ef7b847ac59bc439113cf369d5ef0dc22269be38a481b92fd6e69e95824b2112

data/.hgtags

@@ -23,3 +23,4 @@ ccb4a8711560725e358f7fb87c76f4787eac5ed5 0.8.0
 8dff4cc52ea1e16536ad0677d8d62f52f4201366 0.8.1
 1c06f5b53ea3f3ff235f6e54fe412ec4396cd4b1 0.8.3
 9a241db13da0e043aae02cee2ed463beca38ed9a 0.9.0
+f1b3a814e7a8c7d818b57f6d35ce7ed749573d76 0.9.1

data/lib/pod4/nebulous_interface.rb

@@ -50,9 +50,25 @@ module Pod4
   # success verb. If that's not true, then you will have to override #create and sort this out
   # yourself.
   #
-  # Finally, note that all values are returned as strings; there is no typecasting. This is a given
+  # Note that all values are returned as strings; there is no typecasting. This is a given
   # limitation for Nebulous as a whole.
   #
+  # Calls to create, update and delete avoid (for obvious reasons) Nebulous' Redis cache if
+  # present. read and list use it. The interface methods take an extra options hash to control
+  # this, which, of course, Pod4::Model does not know about. If you want to enable a non-cached
+  # read in your model, it will need a method something like this:
+  #
+  #     def read_no_cache
+  #       r = interface.read(@model_id, caching: false)
+  #
+  #       if r.empty?
+  #         add_alert(:error, "Record ID '#@model_id' not found on the data source")
+  #       else
+  #         map_to_model(r)
+  #         run_validation(:read)
+  #         @model_status = :okay if @model_status == :empty
+  #     end
+  #
   class NebulousInterface < Interface
 
     attr_reader :id_fld
@@ -176,14 +192,20 @@ module Pod4
     # Returns an array of Octothorpes, or an empty array if the responder could not make any
     # records out of our message.
     #
-    def list(selection=nil)
+    # Note that the `opts` hash is not part of the protocol supported by Pod4::Model. If you want
+    # to make use of it, you will have to write your own method for that. Supported keys:
+    #
+    # * caching: true if you want to use redis caching (defaults to true)
+    #
+    def list(selection=nil, opts={})
       sel = 
         case selection
           when Array, Hash, Octothorpe then param_string(:list, selection)
           else selection
         end
 
-      send_message( verb_for(:list), sel )
+      caching = opts[:caching].nil? ? true : !!opts[:caching]
+      send_message( verb_for(:list), sel, caching )
       @response.body.is_a?(Array) ? @response.body.map{|e| Octothorpe.new e} : []
 
     rescue => e
@@ -192,14 +214,14 @@ module Pod4
 
 
     ##
-    # Pass a parameter string or an array as the record. returns the ID.# We assume that the
+    # Pass a parameter string or an array as the record. returns the ID. We assume that the
     # response to the create message returns the ID as the parameter part of the success verb. If
     # that's not true, then you will have to override #create and sort this out yourself.
     #
     def create(record)
       raise ArgumentError, 'create takes a Hash or an Octothorpe' unless hashy?(record)
 
-      send_message( verb_for(:create), param_string(:create, record) )
+      send_message( verb_for(:create), param_string(:create, record), false )
       @response.params
 
     rescue => e
@@ -212,10 +234,18 @@ module Pod4
     #
     # The actual parameters passed to nebulous depend on how you #set_verb
     #
-    def read(id)
+    # Note that the `opts` hash is not part of the protocol supported by Pod4::Model. If you want
+    # to make use of it, you will have to write your own method for that. Supported keys:
+    #
+    # * caching: true if you want to use redis caching (defaults to true)
+    #
+    def read(id, opts={})
       raise ArgumentError, 'You must pass an ID to read' unless id
 
-      send_message( verb_for(:read), param_string(:read, nil, id) )
+      caching = opts[:caching].nil? ? true : !!opts[:caching]
+      send_message( verb_for(:read), 
+                    param_string(:read, nil, id), 
+                    caching )
 
       Octothorpe.new( @response.body.is_a?(Hash) ? @response.body : {} )
     end
@@ -258,12 +288,16 @@ module Pod4
     #
     #     @interface.clearing_cache.read(14)
     #
+    # Note that there is no guarantee that the request that clears the cache is actually the one
+    # you chain after (if multiple model instances are running against the same interface instance)
+    # but for the instance that calls `clearing_cache`, this is not important.
+    #
     def clearing_cache
       @clear_cache = true
       self
     end
 
-
+    
     ##
     # Bonus method: send an arbitrary Nebulous message to the target and return the response object.
     #

data/lib/pod4/version.rb

@@ -1,3 +1,3 @@
 module Pod4 
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

data/spec/common/nebulous_interface_spec.rb

@@ -21,6 +21,13 @@ require_relative 'shared_examples_for_interface'
 #
 class FakeRequester
 
+  # Helper to record the first message sent to us.
+  class << self
+    def clear_method;   @@method = nil;  end
+    def set_method(x);  @@method ||= x;  end 
+    def method;         @@method;        end
+  end
+
   def initialize(data={}); @data = data; end
 
   ##
@@ -35,6 +42,13 @@ class FakeRequester
     request = NebulousStomp::Request.new(target, requestmsg)
     request.stomp_handler = stomphandler
 
+    # We need to know which send method was called. Note that #send calls #send_no_cache, so we
+    # record the first method called.
+    class << request
+      def send(*args);          FakeRequester.set_method :send;          super; end
+      def send_no_cache(*args); FakeRequester.set_method :send_no_cache; super; end
+    end
+
     hash[:inReplyTo] = request.message.reply_id
     responsemsg  = NebulousStomp::Message.new hash
     stomphandler.insert_fake(responsemsg)
@@ -162,9 +176,11 @@ describe "NebulousInterface" do
       3 => {id: 3, name: 'Betty',  price: 3.33} }
   end
 
+  let(:fake) { FakeRequester.new(data) }
+
   let(:interface) do
     init_nebulous
-    nebulous_interface_class.new( FakeRequester.new(data) )
+    nebulous_interface_class.new(fake)
   end
 
 
@@ -197,6 +213,12 @@ describe "NebulousInterface" do
       expect( interface.read(id).to_h ).to include ot.to_h
     end
 
+    it 'creates a non-caching request' do 
+      FakeRequester.clear_method
+      id = interface.create(ot)
+      expect( FakeRequester.method ).to eq :send_no_cache
+    end
+
   end
   ##
 
@@ -216,11 +238,22 @@ describe "NebulousInterface" do
       expect( interface.read(99) ).to be_empty
     end
 
+    it 'creates a caching request' do 
+      FakeRequester.clear_method
+      id = interface.read(1)
+      expect( FakeRequester.method ).to eq :send
+    end
+
+    it "creates a non-caching request when passed an option" do
+      FakeRequester.clear_method
+      id = interface.read(1, caching: false)
+      expect( FakeRequester.method ).to eq :send_no_cache
+    end
+
   end
   ##
 
 
-
   describe '#list' do
 
     it 'has an optional selection parameter, a hash' do
@@ -250,6 +283,19 @@ describe "NebulousInterface" do
       expect( interface.list ).to eq([])
     end
 
+    it 'creates a caching request' do 
+      FakeRequester.clear_method
+      interface.list(name: 'Fred')
+      expect( FakeRequester.method ).to eq :send
+    end
+
+    it "creates a non-caching request when passed an option" do
+      FakeRequester.clear_method
+      interface.list({name: 'Fred'}, caching: false)
+      expect( FakeRequester.method ).to eq :send_no_cache
+    end
+
+
   end
   ##
   
@@ -265,6 +311,15 @@ describe "NebulousInterface" do
       expect( interface.read(id).to_h ).to include(rec)
     end
 
+    it 'creates a non-caching request' do 
+      i   = id # creates a request, so get it done now
+      rec = {price: 99.99}
+
+      FakeRequester.clear_method
+      interface.update(i, rec)
+      expect( FakeRequester.method ).to eq :send_no_cache
+    end
+
   end
   ##
 
@@ -288,6 +343,14 @@ describe "NebulousInterface" do
       expect( list_contains(id) ).to be_falsy
     end
 
+    it 'creates a non-caching request' do 
+      i   = id # creates a request, so get it done now
+
+      FakeRequester.clear_method
+      interface.delete(i)
+      expect( FakeRequester.method ).to eq :send_no_cache
+    end
+
   end
   ##
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pod4
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Andy Jones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-15 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devnull
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Totally not an ORM