her_cache_unmodified 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed59eaf5b09dbe51aebc2addc6f9981e88dfd5ef
+  data.tar.gz: 9aedc4e34ebcfa4de6485fa9364119833ee1ae18
+SHA512:
+  metadata.gz: 0721716fb987d6eb29636034b3ed57115386ccf226815aadc93214782c0a52a5443a5a74580b1979b0e5e12e7e70296156d88e86970e64f18df62524320f04ed
+  data.tar.gz: 6d2fb771b5ead2d81458886a5e621b11d7ec6d4f5077af4d930ab02925d2572929fe09aee39715308a3c13e6f9323edd33212ad5fee19ebeee70d16e2811ba7d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Kvokka
+
+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,59 @@
+# HerCacheUnmodified
+Easy way to begin support 304 status, so on ther side if data was not changed
+You will load it from local cache. Of course, other side must support
+Of course, other side must support 304 status also.
+
+## Usage
+
+At the very begonning you have to include this middleware to `Her`
+
+
+```
+# config/initilizers/her.rb
+...
+  Her::API.new.setup do |connection|
+    ...
+    connection.use HerCacheUnmodified
+  end
+```  
+
+Here is Rails controller example with this support:
+
+```
+class Post < ApplicationController
+  before_action :check_changes
+
+   private
+
+   def check_changes
+     return unless request.headers['HTTP_IF_MODIFIED_SINCE']
+     return if request.headers['HTTP_IF_MODIFIED_SINCE'].to_datetime > resource.updated_at
+     render body: nil, status: 304
+  end
+end
+```
+
+Feel free to update is as you like
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'her_cache_unmodified'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install her_cache_unmodified
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+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    = 'HerCacheUnmodified'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_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/her_cache_unmodified/version.rb

@@ -0,0 +1,3 @@
+module HerCacheUnmodified
+  VERSION = '0.1.0'
+end

data/lib/her_cache_unmodified.rb

@@ -0,0 +1,74 @@
+# Easy way to begin support 304 status, so on ther side if data was not changed
+# You will load it from local cache. Of course, other side must support
+# Of course, other side must support 304 status also.
+# Here is Rails controller example with this support:
+#
+# class Post < ApplicationController
+#   before_action :check_changes
+#
+#   private
+#
+#   def check_changes
+#     return unless request.headers['HTTP_IF_MODIFIED_SINCE']
+#     return if request.headers['HTTP_IF_MODIFIED_SINCE'].to_datetime > resource.updated_at
+#     render body: nil, status: 304
+#   end
+# end
+class HerCacheUnmodified < Faraday::Middleware
+  SAVE_METHODS = [:get, :head].freeze
+
+  attr_reader :cache, :options
+  attr_accessor :url
+
+  # apply with optinos:
+  # cache                 # default value is Rails.cache if Rails is used
+  # cache_key_prefix      # defauilt is nil
+
+  def initialize(app, options={})
+    @app = app
+    @cache = options[:cache] 
+    @cache ||= Rails.cache if defined?(Rails)
+    @options = options
+  end
+
+  def call(env)
+    return @app.call(env) unless SAVE_METHODS.include?(env[:method])
+    self.url = env.url.to_s
+    env[:request_headers]["If-Modified-Since"] ||= cached_time if cached_time
+
+    @app.call(env).on_complete do
+      if env[:status] == 304
+        if cached_body
+          env[:body] = cached_body
+          # with out this hack Her crushes
+          env[:status] = 200
+        end
+      elsif env[:status] == 200
+        cache.write cache_key_body, env[:body], expires_in: cache_key_ttl
+        cache.write cache_key_time, Time.zone.now.httpdate, expires_in: cache_key_ttl
+      end
+    end
+  end
+
+  private
+
+  def cache_key_time
+    [options[:cache_key_prefix], "time", url].compact.join("/")
+  end
+
+  def cache_key_body
+    [options[:cache_key_prefix], "body", url].compact.join("/")
+  end
+
+  def cached_time
+    cache.read(cache_key_time)
+  end
+
+  def cached_body
+    cache.read(cache_key_body)
+  end
+
+  def cache_key_ttl
+    1.week.freeze
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: her_cache_unmodified
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kvokka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: her
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: ''
+email:
+- root_p@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/her_cache_unmodified.rb
+- lib/her_cache_unmodified/version.rb
+homepage: http://github.com/kvokka/her_cache_unmodified
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Her middleware for 304 request status support
+test_files: []