saxondale 0.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+Saxondale
+
+ETags for assets that are delivered with Rails controllers
+
+#####Purpose
+
+The assets in FedoraCommons are expensive to load.  This gem uses Rails conventions
+to cache and compare the hashes of ETags.
+
+#####Add to your Gemfile
+
+
+```ruby
+  gem 'saxondale'
+```
+
+#####Examples
+
+```ruby
+# app/controllers/image_controller.rb
+etag :thumbnail
+
+def thumbnail
+  @image = Image.find(params[:id])
+  authorize! :read, @image
+  data_stream = @image.datastreams['thumbnail']
+  send_data data_stream.content, 
+    filename: 'thumbnail', 
+    disposition: :inline, 
+    type: ds.mimeType)
+end
+```
+
+
+```ruby
+ # app/models/image.rb
+  expire_etag :thumbnail
+ 
+```

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Saxondale'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/saxondale.rb

@@ -0,0 +1,67 @@
+require 'saxondale/cache'
+require 'saxondale/controller_methods'
+require 'saxondale/model_methods'
+require 'saxondale/engine'
+
+module Saxondale
+end
+
+
+
+# require 'digest/md5'
+
+# module Avalon
+#   module EtagRemoteAsset
+
+#     def self.generate_key( klass, id, type, opts = {})
+#       [ klass, id, type, opts[:extra]].compact.join(':')
+#     end
+
+#     module ControllerMethods
+
+#       def etag_remote_asset
+#         hash = Rails.cache.fetch EtagRemoteAsset.generate_key(self.controller_name.classify.tableize, params[:id], params[:action])
+
+#         if hash && hash == request.headers['If-None-Match']
+#           render(nothing: true, status: 304) and return
+#         else
+#           asset = (yield).try :first
+#           parent = instance_variable_get("@#{self.controller_name.singularize}")
+#           if parent && asset && asset.encoding.name == 'ASCII-8BIT'
+#             hash = Digest::MD5.hexdigest(asset)
+#             controller_name = parent.class.to_s.classify.tableize
+#             Rails.cache.write(EtagRemoteAsset.generate_key(controller_name, parent.id, params[:action]), hash)
+#             response.headers['ETag'] = hash
+#           end
+#         end
+#       end
+#     end
+
+#     module ModelMethods
+
+#       def expire_etags( types )
+#         if self.persisted?
+#           [types].flatten.each do |type|
+#             key = EtagRemoteAsset.generate_key(self.class.to_s.classify.tableize, self.id, type.to_s)
+#             Rails.cache.delete(key)
+#           end
+#         end
+#         true
+#       end
+#     end
+#   end
+# end
+
+  # def thumbnail
+  #   @master_file = MasterFile.find(params[:id])
+  #   authorize! :read, @master_file.mediaobject
+  #   ds = @master_file.datastreams['thumbnail']
+  #   send_data ds.content, :filename => "poster-#{@master_file.pid.split(':')[1]}", :disposition => :inline, :type => ds.mimeType
+  # end
+
+  # def poster
+  #   @master_file = MasterFile.find(params[:id])
+  #   authorize! :read, @master_file.mediaobject
+  #   ds = @master_file.datastreams['poster']
+  #   send_data ds.content, :filename => "poster-#{@master_file.pid.split(':')[1]}", :disposition => :inline, :type => ds.mimeType
+  # end

data/lib/saxondale/cache.rb

@@ -0,0 +1,8 @@
+module Saxondale
+  module Cache
+
+    def self.generate_key( klass, id, type, opts = {})
+      [ 'etag', klass, id, type, opts[:extra]].compact.join(':')
+    end
+  end
+end

data/lib/saxondale/controller_methods.rb

@@ -0,0 +1,40 @@
+require 'digest/md5'
+require 'saxondale/cache'
+
+module Saxondale
+  module ControllerMethods
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.send(:include, InstanceMethods)
+    end
+
+    module ClassMethods 
+      def etag( method_or_methods, opts = {})
+        around_filter :etag_remote_asset, only: [method_or_methods].flatten
+      end
+    end
+
+    module InstanceMethods
+      def etag_remote_asset
+        hash = Rails.cache.fetch(etag_remote_asset_key)
+
+        if hash && hash == request.headers['If-None-Match']
+          render(nothing: true, status: 304) and return
+        else
+          asset       = (yield).try :first
+
+          if asset && asset.encoding.name.in?(['ASCII-8BIT','UTF-8'])
+            hash = Digest::MD5.hexdigest(asset)
+            Rails.cache.write(etag_remote_asset_key, hash)
+            response.headers['ETag'] = hash
+          end
+        end
+      end
+
+      def etag_remote_asset_key
+        Saxondale::Cache.generate_key(self.controller_name.classify.tableize, params[:id], params[:action])
+      end
+    end
+  end
+end

data/lib/saxondale/engine.rb

@@ -0,0 +1,10 @@
+module Saxondale
+  class Engine < Rails::Engine
+
+    ActiveSupport.on_load :action_controller do |app|
+      ActionController::Base.send :include, Saxondale::ControllerMethods
+    end
+
+    ActiveFedora::Base.extend Saxondale::ModelMethods
+  end
+end

data/lib/saxondale/model_methods.rb

@@ -0,0 +1,20 @@
+module Saxondale
+  module ModelMethods
+
+    def expire_etag( type_or_types, opts = {} )
+      callbacks = [opts.delete(:when)].compact
+      callbacks << [:after_save, :before_destroy] if callbacks.empty?
+      
+      clear_cache = Proc.new{ |model|
+        if self.persisted?
+          [type_or_types].flatten.compact.each do |type|
+            key = Saxondale::Cache.generate_key(self.class.to_s.classify.tableize, self.id, type.to_s)
+            Rails.cache.delete(key)
+          end
+        end
+      }
+
+      callbacks.flatten.compact.each{|callback| self.send "#{callback}".to_sym, clear_cache }
+    end
+  end
+end

data/lib/saxondale/version.rb

@@ -0,0 +1,3 @@
+module Saxondale
+  VERSION = '0.0.0'
+end

data/lib/tasks/saxondale_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :saxondale do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: saxondale
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Hallett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+- !ruby/object:Gem::Dependency
+  name: active-fedora
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ETags for ActiveFedora datastreams.
+email:
+- adam.t.hallett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/saxondale/cache.rb
+- lib/saxondale/controller_methods.rb
+- lib/saxondale/engine.rb
+- lib/saxondale/model_methods.rb
+- lib/saxondale/version.rb
+- lib/saxondale.rb
+- lib/tasks/saxondale_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/atomical/saxondale
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ETags for ActiveFedora datastreams.
+test_files: []