logical_model 0.5.12 → 0.5.13

data/VERSION

@@ -1 +1 @@
-0.5.12
+0.5.13

data/lib/logical_model.rb

@@ -12,6 +12,7 @@ require 'logical_model/safe_log'
 require 'logical_model/associations'
 require 'logical_model/api_key'
 require 'logical_model/attributes'
+require 'logical_model/cache'
 
 # Logical Model, not persistant on DB, works through API. (replaces ActiveResource)
 #
@@ -50,6 +51,8 @@ require 'logical_model/attributes'
 #  RemoteResource.delete(params[:id])
 #  RemoteResource#destroy
 class LogicalModel
+  extend ActiveModel::Callbacks
+  define_model_callbacks :create, :save, :update, :destroy, :initialize
 
   include LogicalModel::Hydra
   include LogicalModel::ResponsesConfiguration
@@ -59,6 +62,7 @@ class LogicalModel
   include LogicalModel::ApiKey
   include LogicalModel::SafeLog
   include LogicalModel::Associations
+  include LogicalModel::Cache
 
   # include ActiveModel Modules that are usefull
   extend ActiveModel::Naming
@@ -67,8 +71,6 @@ class LogicalModel
   include ActiveModel::Validations
   include ActiveModel::MassAssignmentSecurity
 
-  extend ActiveModel::Callbacks
-  define_model_callbacks :create, :save, :update, :destroy
 
   self.include_root_in_json = false
 
@@ -81,6 +83,13 @@ class LogicalModel
     self.attributes = attributes
   end
 
+  def initialize_with_callback(attributes = {})
+    run_callbacks :initialize do
+      initialize_without_callback(attributes)
+    end
+  end
+  alias_method_chain :initialize, :callback
+
   class << self
     attr_accessor :timeout, :retries,
                   :json_root

data/lib/logical_model/cache.rb

@@ -0,0 +1,132 @@
+class LogicalModel
+  module Cache
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+      base.send(:include, InstanceMethods)
+      base.send(:after_initialize, :initialize_loaded_at)
+    end
+
+    module InstanceMethods
+      attr_accessor :loaded_at
+
+      def initialize_loaded_at
+        self.loaded_at = Time.now
+      end
+
+      def _save
+        super
+      end
+
+      def _save_with_cache
+        model_name = self.class.to_s.pluralize.underscore
+        self.class.logger.debug "LogicalModel Log CACHE: Delete cache for #{model_name}\/#{self.id}-.*"
+        self.class.cache_store.delete_matched(/#{model_name}\/#{self.id}-.*/)
+        _save_without_cache
+      end
+      alias_method_chain :_save, :cache
+
+      def _update(params={})
+        super
+      end
+
+      def _update_with_cache(params={})
+        model_name = self.class.to_s.pluralize.underscore
+        self.class.logger.debug "LogicalModel Log CACHE: Delete cache for #{model_name}\/#{self.id}-.*"
+        self.class.cache_store.delete_matched(/#{model_name}\/#{self.id}-.*/)
+        _update_without_cache params
+      end
+      alias_method_chain :_update, :cache
+
+      def _destroy(params={})
+        super
+      end
+
+      def _destroy_with_cache(params={})
+        model_name = self.class.to_s.pluralize.underscore
+        self.class.logger.debug "LogicalModel Log CACHE: Delete cache for #{model_name}\/#{self.id}-.*"
+        self.class.cache_store.delete_matched(/#{model_name}\/#{self.id}-.*/)
+        _destroy_without_cache
+      end
+      alias_method_chain :_destroy, :cache      
+    end
+
+    module ClassMethods
+      attr_accessor :expires_in
+
+      def cache_store
+        @cache_store ||= Rails.cache
+      end
+
+      # Will return key for cache
+      # @param id [String] (nil)
+      # @param params [Hash]
+      def cache_key(id, params = {})
+        model_name = self.to_s.pluralize.underscore
+        params_hash = Digest::MD5.hexdigest(params.to_s)
+        
+        cache_key = "#{model_name}/#{id}-#{params_hash}"
+      end
+
+      def async_find(id, params={})
+        super(id, params)
+      end
+
+      def async_find_with_cache(id, params = {}, &block)
+        # Generate key based on params
+        cache_key = self.cache_key(id, params)
+        # If there is a cached value return it
+        self.logger.debug "LogicalModel Log CACHE: Reading cache key=#{cache_key}"
+        cached_result = self.cache_store.read(cache_key)
+        if cached_result
+          yield cached_result
+        else
+          self.logger.debug 'LogicalModel Log CACHE: Cache not present. Calling find_async without cache'
+          async_find_without_cache(id, params, &block)
+        end
+      end
+      alias_method_chain :async_find, :cache
+
+      def async_find_response(id, params={}, body)
+        super(id, params, body)
+      end
+
+      def async_find_response_with_cache(id, params={}, body)
+        # remove params not used in cache_key
+        %w(app_key token).each {|k| params.delete(k) }
+        cache_value = async_find_response_without_cache(id, params, body)
+        # Generate key based on params
+        cache_key = self.cache_key(id, params)
+        self.logger.debug "LogicalModel Log CACHE: Writing cache key=#{cache_key}"
+        self.cache_store.write(cache_key, cache_value, :expires_in => self.expires_in || 10.minutes)
+        cache_value
+      end
+      alias_method_chain :async_find_response, :cache
+
+      def delete(id, params={})
+        super(id, params)
+      end
+
+      def delete_with_cache(id, params = {})
+        model_name = self.to_s.pluralize.underscore
+        self.logger.debug "LogicalModel Log CACHE: Delete cache for #{model_name}\/#{id}-.*"
+        self.cache_store.delete_matched(/#{model_name}\/#{id}-.*/)
+        delete_without_cache(id, params)
+      end
+      alias_method_chain :delete, :cache
+
+      def delete_multiple(ids, params={})
+        super(ids, params)
+      end
+
+      def delete_multiple_with_cache(ids, params = {})
+        model_name = self.to_s.pluralize.underscore
+        self.logger.debug "LogicalModel Log CACHE: Delete cache for #{model_name}\/(#{ids.join('|')})-.*"
+        self.cache_store.delete_matched(/#{model_name}\/(#{ids.join('|')})-.*/)
+        delete_multiple_without_cache(ids, params)
+      end
+      alias_method_chain :delete_multiple, :cache
+    end
+
+  end
+end

data/lib/logical_model/rest_actions.rb

@@ -352,7 +352,7 @@ class LogicalModel
         request.on_complete do |response|
           if response.code >= 200 && response.code < 400
             log_ok(response)
-            yield self.new.from_json(response.body) # this from_json is defined in ActiveModel::Serializers::JSON
+            yield async_find_response(id, params, response.body)
           else
             log_failed(response)
           end
@@ -361,6 +361,10 @@ class LogicalModel
         self.hydra.queue(request)
       end
 
+      def async_find_response(id, params, body)
+        self.new.from_json(body) # this from_json is defined in ActiveModel::Serializers::JSON
+      end
+
       # synchronic find
       def find(id, params = {})
         result = nil

data/logical_model.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "logical_model"
-  s.version = "0.5.12"
+  s.version = "0.5.13"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dwayne Macgowan"]
-  s.date = "2014-04-20"
+  s.date = "2014-06-13"
   s.description = "LogicalModel allows to use a resource as a model. It is based on web presentation http://www.slideshare.net/ihower/serviceoriented-design-and-implement-with-rails3"
   s.email = "dwaynemac@gmail.com"
   s.extra_rdoc_files = [
@@ -38,6 +38,7 @@ Gem::Specification.new do |s|
     "lib/logical_model/associations/belongs_to.rb",
     "lib/logical_model/associations/has_many_keys.rb",
     "lib/logical_model/attributes.rb",
+    "lib/logical_model/cache.rb",
     "lib/logical_model/hydra.rb",
     "lib/logical_model/responses_configuration.rb",
     "lib/logical_model/rest_actions.rb",
@@ -50,6 +51,7 @@ Gem::Specification.new do |s|
     "models/user.rb",
     "spec/client_spec.rb",
     "spec/lib/logical_model/associations/has_many_keys_spec.rb",
+    "spec/lib/logical_model/cache_spec.rb",
     "test/helper.rb",
     "test/test_logical_model.rb",
     "test/typhoeus_mocks.rb"

data/spec/lib/logical_model/cache_spec.rb

@@ -0,0 +1,136 @@
+require './lib/logical_model'
+
+describe LogicalModel::Cache do
+  describe "when included" do
+    before do
+      class Example < LogicalModel
+        
+        attribute :id
+        attribute :name
+        
+        self.hydra = Typhoeus::Hydra.new
+
+        self.enable_delete_multiple = true
+      end
+    end
+
+    it "adds expires_in class method" do
+      Example.should respond_to :expires_in
+    end
+
+    it "adds loaded_at as instance method" do
+      Example.new.should respond_to :loaded_at
+    end
+
+    it "initializes loaded_at" do
+      model = Example.new
+      model.run_callbacks :initialize
+      model.loaded_at.should_not be_nil
+    end
+
+    it "should use params to build cache_key" do
+      cache_key = Example.cache_key('id', {})
+      cache_key2 = Example.cache_key('id', {:param => true})
+      cache_key.should_not == cache_key2
+    end
+
+    it "should chain find_async" do
+      Example.should respond_to :async_find_with_cache
+      Example.should respond_to :async_find_without_cache
+    end
+
+    describe "cached value present" do
+      before do
+        Example.stub_chain(:cache_store, :read).and_return("test")
+      end
+
+      it "#async_find should return the cached value" do
+        Example.async_find("id") { |r| @result = r}
+        @result.should == "test"
+      end
+    end
+
+    describe "cached value not present" do
+      before do
+        Example.stub_chain(:cache_store, :read).and_return(nil)
+        Example.stub_chain(:cache_store, :write).and_return(nil)
+      end
+
+      it "#async_find should look for the value" do
+        Example.should_receive(:async_find_without_cache)
+        Example.async_find("id") {|r| @result = r}
+      end
+
+      it "#async_find_response should store the value in the cache" do
+        Example.should_receive(:async_find_response_without_cache)
+        Example.async_find_response("id", {}, "test")
+      end
+    end
+
+    describe "save" do
+      before do
+        Example.stub_chain(:cache_store, :read).and_return(Example.new)
+        Example.stub_chain(:cache_store, :delete_matched).and_return(nil)
+        Example.async_find("id") {|r| @result = r}
+      end
+
+      it "should clear cache" do
+        Example.cache_store.should_receive(:delete_matched)
+        @result.save
+      end
+    end
+
+    describe "update" do
+      before do
+        Example.stub_chain(:cache_store, :read).and_return(Example.new)
+        Example.stub_chain(:cache_store, :delete_matched).and_return(nil)
+        Example.any_instance.stub(:_update_without_cache).and_return(true)
+        Example.async_find("id") {|r| @result = r}
+      end
+
+      it "should clear cache" do
+        @result.should_receive(:_update_without_cache)
+        @result.update({:name => "test"}) 
+      end
+    end
+
+    describe "destroy" do
+      before do
+        Example.stub_chain(:cache_store, :read).and_return(Example.new)
+        Example.stub_chain(:cache_store, :delete_matched).and_return(nil)
+        Example.async_find("id") {|r| @result = r}
+      end
+
+      it "should clear cache" do
+        Example.cache_store.should_receive(:delete_matched)
+        @result.destroy
+      end
+    end
+
+    describe "delete" do
+      before do
+        Example.stub_chain(:cache_store, :read).and_return(Example.new)
+        Example.stub_chain(:cache_store, :delete_matched).and_return(nil)
+        Example.async_find("id") {|r| @result = r}
+      end
+
+      it "should clear cache" do
+        Example.cache_store.should_receive(:delete_matched)
+        Example.delete("id")
+      end
+    end
+
+    describe "delete_multiple" do
+      before do
+        Example.stub_chain(:cache_store, :read).and_return(Example.new)
+        Example.stub_chain(:cache_store, :delete_matched).and_return(nil)
+        Example.async_find("id") {|r| @result = r}
+      end
+
+      it "should clear cache" do
+        Example.cache_store.should_receive(:delete_matched)
+        Example.delete_multiple(["id1","id2"])
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logical_model
 version: !ruby/object:Gem::Version
-  version: 0.5.12
+  version: 0.5.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-20 00:00:00.000000000 Z
+date: 2014-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -361,6 +361,7 @@ files:
 - lib/logical_model/associations/belongs_to.rb
 - lib/logical_model/associations/has_many_keys.rb
 - lib/logical_model/attributes.rb
+- lib/logical_model/cache.rb
 - lib/logical_model/hydra.rb
 - lib/logical_model/responses_configuration.rb
 - lib/logical_model/rest_actions.rb
@@ -373,6 +374,7 @@ files:
 - models/user.rb
 - spec/client_spec.rb
 - spec/lib/logical_model/associations/has_many_keys_spec.rb
+- spec/lib/logical_model/cache_spec.rb
 - test/helper.rb
 - test/test_logical_model.rb
 - test/typhoeus_mocks.rb
@@ -391,7 +393,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 474828961
+      hash: -822604947
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: