cardiac 0.2.0.pre2 → 0.2.0.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffcee4b9c9da2df77d5d3530d5562848b497fdab
-  data.tar.gz: d0dc3f4297ef67ddc38f139be6b64b00b7ff4dc9
+  metadata.gz: faafad3cb935e5bb55d912bce4253d8a87167355
+  data.tar.gz: 176df035bb2ab9e4e84d78b85a7608f1d9e7f857
 SHA512:
-  metadata.gz: d01919339fec4e2519bc8b92479383d7c259247fcae5055e1a2722baceca9f91e070398660c04103a6fb0ffdb70c55faf23a9d04973e0faf24f8fdbf45cc9715
-  data.tar.gz: 55c38c5f11b07b8d92fc6d314d6c3a674bf8bfed80a936ab54b755042d185745d6fa76d217551d851772a00a418b664f24f24293f8df95fc0cb048df1b77f767
+  metadata.gz: ef4123ec8f187b9bf88850845a01d0678aabd2d5780795948a3fb02c8c03012686f3c67d48ef791b4b3f14af371606a805a6e4de9d99e31b4196b00185965651
+  data.tar.gz: 5ee48420e2b3053599dc737913f1c2aa43a2a2197c07e411ff884be131f4b290c379d1b7b5e1054a521d9954cf858eef49dcf42967d2d261bdef4ed41d9fc994

data/lib/cardiac.rb

@@ -21,14 +21,15 @@ module Cardiac
   # Resources and builder DSL.
   autoload :Resource
   autoload_under 'resource' do
-    autoload :Subresource
-    autoload :UriMethods
-    autoload :RequestMethods
     autoload :CodecMethods
-    autoload :ExtensionMethods
     autoload :ConfigMethods
-    autoload :ResourceBuilder, 'cardiac/resource/builder'
+    autoload :ExtensionMethods
+    autoload :RequestMethods
     autoload :ResourceAdapter, 'cardiac/resource/adapter'
+    autoload :ResourceBuilder, 'cardiac/resource/builder'
+    autoload :ResourceCache, 'cardiac/resource/cache'
+    autoload :Subresource
+    autoload :UriMethods
   end
   autoload :Representation
   autoload_at 'cardiac/declarations' do
@@ -38,6 +39,7 @@ module Cardiac
   end
   
   # Operations and execution.
+  autoload :Client
   autoload :OperationHandler
   autoload :OperationResult, 'cardiac/operation_handler'
   autoload :OperationBuilder

data/lib/cardiac/client.rb

@@ -0,0 +1,58 @@
+require 'rack'
+require 'rack/client'
+require 'rack/cache'
+require 'stringio'
+
+module Cardiac
+  
+  class Client < Rack::Client::Simple
+    
+    # :nodoc:
+    class ErrorLogger
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @app.call(env)
+      ensure
+        if message = env['rack.errors'].to_s.presence
+          Cardiac::Model::Base.logger.error message
+        end
+      end
+    end
+    
+    # :nodoc:
+    class SwitchHeaders
+      def initialize(app,match,switch)
+        @app, @match, @switch = app, match, switch
+      end
+
+      def call(env)
+        status, headers, body = @app.call(env)
+        [status, Hash[ headers.to_a.map{|k,v| [@match===k ? @switch+$' : k, v] }], body]
+      end
+    end
+    
+    def build_env(*)
+      env = super
+    end
+
+    def http_user_agent
+      "cardiac #{Cardiac::VERSION} (rack-client #{Rack::Client::VERSION})"
+    end
+
+    def self.new
+      super Rack::Client::Handler::NetHTTP
+    end
+
+    def self.request(*args)
+      @instance ||= new
+      @instance.request(*args)
+    end
+    
+    def self.build_mock_response body, code, headers={}
+      Rack::Client::Simple::CollapsedResponse.new code, headers, StringIO.new(body)
+    end
+  end
+end

data/lib/cardiac/log_subscriber.rb

@@ -12,12 +12,12 @@ module Cardiac
     def operation(event)
       return unless logger.debug?
 
-      payload = event.payload
-      
-      url   = payload[:url]
+      payload   = event.payload
+      name, url = payload[:name], payload[:url]
+        
       stats = "#{event.duration.round(1)}ms"
-      stats = "CACHED #{stats}" if /fresh/ === payload[:response_headers].try(:[],'X-Rack-Client-Cache')
-      name  = "#{payload[:name]} #{payload[:verb]} (#{stats})"
+      stats = "CACHED #{stats}" if name!='CACHE' && /fresh/ === payload[:response_headers].try(:[],'X-Rack-Client-Cache')
+      name  = "#{name} #{payload[:verb]} (#{stats})"
 
       if extra = payload.except(:name, :verb, :url, :response_headers).presence
         extra = "  " + extra.map{|key,value|

data/lib/cardiac/model/base.rb

@@ -4,6 +4,8 @@ require 'active_attr'
 module Cardiac
   module Model
     class Base
+      extend Cardiac::ResourceCache::ClassMethods
+      
       include ActiveAttr::Model
       include Cardiac::Model::Attributes
       include Cardiac::Model::Querying
@@ -155,7 +157,7 @@ module Cardiac
       end
     end
     
-    ActiveSupport.run_load_hooks(:cardiac, Base)
+    ActiveSupport.run_load_hooks(:cardiac_model, Base)
   end
 
 end

data/lib/cardiac/model/dirty.rb

@@ -19,8 +19,6 @@ module Cardiac
         if status = super
           @previously_changed = changes
           @changed_attributes.clear
-        #elsif IdentityMap.enabled?
-        #  IdentityMap.remove(self)
         end
         status
       end
@@ -33,9 +31,6 @@ module Cardiac
           @previously_changed = changes
           @changed_attributes.clear
         end
-      #rescue
-      #  IdentityMap.remove(self) if IdentityMap.enabled?
-      #  raise
       end
 
       # <tt>reload</tt> the record and clears changed attributes.

data/lib/cardiac/model/persistence.rb

@@ -70,10 +70,8 @@ module Cardiac
       # Reloads the attributes of this object from the remote.
       # Any (optional) arguments are passed to find when reloading.
       def reload(*args)
-        #IdentityMap.without do
-          fresh_object = self.class.find(self.id, *args)
-          @attributes.update(fresh_object.instance_variable_get('@attributes'))
-        #end
+        fresh_object = self.class.find(self.id, *args)
+        @attributes.update(fresh_object.instance_variable_get('@attributes'))
         self
       end
       

data/lib/cardiac/operation_handler.rb

@@ -1,10 +1,6 @@
 require 'active_support/configurable'
 require 'active_support/rescuable'
 require 'active_support/callbacks'
-require 'rack'
-require 'rack/client'
-require 'rack/cache'
-require 'stringio'
 
 module Cardiac
   
@@ -44,40 +40,6 @@ module Cardiac
       response
     end
     
-    class Client < Rack::Client::Simple
-      class SwitchHeaders
-        def initialize(app,match,switch)
-          @app, @match, @switch = app, match, switch
-        end
-        def call(env)
-          status, headers, body = @app.call(env)
-          [status, Hash[ headers.to_a.map{|k,v| [@match===k ? @switch+$' : k, v] }], body]
-        end
-      end
-
-      use SwitchHeaders, /^X-HideRack-/, 'X-Rack-'
-      use SwitchHeaders, /^X-Rack-/, 'X-Rack-Client-'
-      use Rack::Cache,
-        'rack-cache.ignore_headers' => ['Set-Cookie','X-Content-Digest']
-      use Rack::Head
-      use Rack::ConditionalGet
-      use Rack::ETag
-      use SwitchHeaders, /^X-Rack-/, 'X-HideRack-'
-      
-      def self.new
-        super Rack::Client::Handler::NetHTTP
-      end
-      
-      def self.request(*args)
-        @instance ||= new
-        @instance.request(*args)
-      end
-      
-      def http_user_agent
-        "cardiac #{Cardiac::VERSION} (rack-client #{Rack::Client::VERSION})"
-      end
-    end
-    
     attr_accessor :verb, :url, :headers, :payload, :options, :response_handler, :result
     
     def initialize client_options, payload=nil, &response_handler
@@ -204,12 +166,7 @@ module Cardiac
     # Optionally, these conditions could also be made to provide a mock response on a connection error.
     # This would prevent the operation from aborting but still show that the response was not transmitted.
     def service_unavailable e
-      self.result = build_mock_response e, '503' if mock_response_on_connection_error
-    end
-  
-    # Internal method.
-    def build_mock_response body, code, version='1.0', headers={}
-      Rack::Client::Simple::CollapsedResponse.new code, headers, StringIO.new(body)
+      self.result = Client.build_mock_response e, '503' if mock_response_on_connection_error
     end
   end
 end

data/lib/cardiac/railtie.rb

@@ -1,14 +1,10 @@
 require 'active_attr/railtie'
-require "cardiac/model/base"
+require 'cardiac/model'
 require 'cardiac/log_subscriber'
 
 module Cardiac
   class Railtie < Rails::Railtie
 
-    initializer "cardiac.logger" do
-      ActiveSupport.on_load(:cardiac) { self.logger ||= ::Rails.logger }
-    end
-
     # Make the console output logging to STDERR (unless AR already did it).
     console do |app|
       unless defined? ::ActiveRecord::Base
@@ -16,5 +12,74 @@ module Cardiac
         Rails.logger.extend ActiveSupport::Logger.broadcast(console)
       end
     end
+
+    # Rails 4.0+
+    if config.respond_to? :eager_load_namespaces
+      config.eager_load_namespaces << Cardiac << Cardiac::Model
+    end
+
+    # Cardiac
+    # ---------------------------------------------------------------------------
+        
+    config.cardiac = ActiveSupport::OrderedOptions.new
+    config.cardiac.client_cache = {}
+    config.cardiac.verbose = false
+      
+    config.app_middleware.insert_after "::ActionDispatch::Callbacks",
+      "Cardiac::ResourceCache::Middleware"
+      
+    initializer 'cardiac.build_client_middleware' do |app|
+      ActiveSupport.on_load(:cardiac) do
+        Cardiac::Client.tap do |client|
+          
+          # Optionally print out the rack errors after the request
+          client.use Cardiac::Client::ErrorLogger if app.config.cardiac.verbose
+          
+          # Restore any headers set by the remote server's Rack.
+          client.use Cardiac::Client::SwitchHeaders, /^X-HideRack-/, 'X-Rack-'
+  
+          # Rename any headers set by the local client's Rack.
+          client.use Cardiac::Client::SwitchHeaders, /^X-Rack-/, 'X-Rack-Client-'
+          
+          # Unless disabled, configure the client's Rack cache.  
+          # NOTE: Certain headers should ALWAYS be ignored by the client.
+          if client_cache = app.config.cardiac.client_cache
+            client_cache = {} unless Hash===client_cache
+              
+            client_cache[:verbose] = app.config.cardiac.verbose unless client_cache.key? :verbose
+              
+            client_cache[:ignore_headers] = Array(client_cache[:ignore_headers]) + ['Set-Cookie','X-Content-Digest']
+              
+            client.use Rack::Cache, Hash[ client_cache.map{|k,v| ["rack-cache.#{k}", v] } ]
+          end
+  
+          # This is the "meat" of our basic middleware.
+          client.use Rack::Head
+          client.use Rack::ConditionalGet
+          client.use Rack::ETag
+  
+          # Hide any headers set by the remote server's Rack.
+          client.use Cardiac::Client::SwitchHeaders, /^X-Rack-/, 'X-HideRack-'
+        
+        end
+      end
+    end
+      
+    
+    # Cardiac::Model
+    # ---------------------------------------------------------------------------
+      
+    config.cardiac_model = ActiveSupport::OrderedOptions.new
+
+    initializer "cardiac_model.logger" do
+      ActiveSupport.on_load(:cardiac_model) do
+        self.logger ||= ::Rails.logger
+      end
+    end
+
+    # Make sure that the model layer is already available when running a script.
+    runner do
+      require 'cardiac/model/base'
+    end
   end
 end

data/lib/cardiac/resource.rb

@@ -74,4 +74,6 @@ module Cardiac
       base.userinfo = base.query = nil
     end
   end
+
+  ActiveSupport.run_load_hooks(:cardiac, Resource)
 end

data/lib/cardiac/resource/adapter.rb

@@ -8,13 +8,14 @@ module Cardiac
   # An adapter for performing operations on a resource.
   class ResourceAdapter
     include ::ActiveSupport::Callbacks
-    include ::Cardiac::Representation::LookupMethods
+    include Representation::LookupMethods
+    include ResourceCache::InstanceMethods
     
     define_callbacks :resolve, :prepare, :encode, :execute, :decode
     
     attr_accessor :klass, :resource, :payload, :result
     
-    delegate :request_has_body?, :response_has_body?, to: :resource
+    delegate :request_has_body?, :response_has_body?, :request_is_safe?, :request_is_idempotent?, to: :resource
     delegate :encoder_reflection, :decoder_reflections, to: '@reflection'
     delegate :transmitted?, :aborted?, :completed?, :response, to: :result, allow_nil: true
 
@@ -24,12 +25,9 @@ module Cardiac
     delegate :logger, to: '::Cardiac::Model::Base'
     
     def initialize(klass,base,payload=nil)
-      @klass = klass
-      @reflection = base.to_reflection if base.respond_to?(:to_reflection)
-      run_callbacks :resolve do
-        @resource = base.to_resource if base.respond_to?(:to_resource)
-      end
-      @reflection ||= @resource.to_reflection if resolved?
+      @klass               = klass
+      @reflection          = base.to_reflection if base.respond_to? :to_reflection
+      resolve! base
     end
     
     def __client_options__
@@ -58,9 +56,7 @@ module Cardiac
     
     # Convenience method to return the current HTTP verb
     def http_verb
-      if defined? @__client_options__
-        @__client_options__[:method].to_s.upcase
-      end
+      @http_verb ||= (defined? @__client_options__ and @__client_options__[:method].to_s.upcase)
     end
     
     # Performs a remote call by performing the remaining phases in the lifecycle of this adapter.
@@ -80,15 +76,26 @@ module Cardiac
     end
     
     def prepared?
-      __client_options__.present?
+      @__client_options__.present?
     end
     
   protected
   
+    def resolve! base
+      run_callbacks :resolve do
+        @resource = base.to_resource if base.respond_to?(:to_resource)
+      end
+      @reflection ||= @resource.to_reflection if resolved?
+    end
+  
     def prepare! verb=nil
       run_callbacks :prepare do
-        self.resource = resource.http_method(verb) if verb
+        if verb
+          self.resource = resource.http_method(verb)
+          @__client_options__ = nil
+        end
       end
+      
       __client_options__.symbolize_keys!
       prepared?
     end
@@ -114,14 +121,20 @@ module Cardiac
     end
     
     def execute!
-      event = event_attributes 
-      instrumenter.instrument "operation.cardiac", event do
-        run_callbacks :execute do
-          handler = __handler__.new(__client_options__, payload, &__client_handler__)
-          self.result = handler.transmit!
+      run_callbacks :execute do
+        clear_resource_cache unless request_is_safe?
+          
+        instrumenter.instrument "operation.cardiac", event=event_attributes do
+          if resource_cache_enabled? http_verb
+            url, headers = __client_options__.slice(:url, :headers)
+            self.result = cache_resource(url.to_s, headers, event) { transmit! }
+          else
+            self.result = transmit!
+          end
           event[:response_headers] = result.response.headers if result && result.response
-          completed?
         end
+            
+        completed?
       end
     rescue => e
       message = "#{e.class.name}: #{e.message}: #{resource.to_url}"
@@ -147,12 +160,16 @@ module Cardiac
 
   private
   
+    def transmit!
+      __handler__.new(__client_options__, payload, &__client_handler__).transmit!
+    end
+   
     def model_name
       __klass_get(:model_name).try(:to_s)
     end
     
-    def event_attributes
-      h = { name: model_name, verb: http_verb, url: resource.to_url, payload: payload }
+    def event_attributes(name=model_name)
+      h = { name: name, verb: http_verb, url: resource.to_url, payload: payload }
       ctx = __klass_get :operation_context
       ctx = { context: ctx } unless ctx.present? && Hash===ctx
       h.reverse_merge! ctx if ctx