faraday-cache-advanced 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d8eb1e2bb332beca7a2bfaf2a504257efbb316c
+  data.tar.gz: b00b9aa578854b93cf7b083d99fddc7a50f5c0b1
+SHA512:
+  metadata.gz: ba8a706c3b0cb360a0c31dd86bb2118b4c2a8fcad34c2a44bf30007787811a3973bcc09b4533335f0bc2e1ab0eb565515bbd3d3c1ecfe244c86987164f4fac1c
+  data.tar.gz: c97cf2e015722276f90c78b261cb5210b069b935a00918cfdfdddb0ab504fc6726a93c79e94bad04be0cd6c039a75637669758928abf4b409707360271927581

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faraday-cache-advanced.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 John Stewart
+
+MIT License
+
+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,35 @@
+# Cache-Advanced
+
+A simple mechanism to cache POST requests via a faraday middleware.
+
+Cache Advanced is a tool for when you REALLY, REALLY need to cache POST HTTP requests via Faraday.  
+In general you SHOULD NOT cache POST calls, as they are not supposed to be idempotent, but yeah 
+that doesnt always hold in the real world.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-cache-advanced'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday-cache-advanced
+
+## Usage
+
+CacheAdvanced is designed to drop in to your Faraday middleware stack in the same way you'd use the standard faraday-middleware caching implementation.  The difference being CacheAdvanced doesnt give you opinion about what should/shouldnt be cached, it caches every call that comes thru that returns a :success.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/faraday-cache-advanced/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/faraday-cache-advanced.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday/cache-advanced/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday-cache-advanced"
+  spec.version       = Faraday::CacheAdvanced::VERSION
+  spec.authors       = ["John Stewart"]
+  spec.email         = ["johnsinco@icloud.com"]
+  spec.summary       = %q{Simple caching middleware to cache ALL Requests including POST requests in faraday}
+  spec.description   = %q{Sometimes you gotta cache POST requests.  This gem gives you a Faraday middleware to cache POST requests.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+
+  spec.add_development_dependency "rspec"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/faraday-cache-advanced.rb

@@ -0,0 +1 @@
+require 'faraday/cache-advanced'

data/lib/faraday/cache-advanced/cache-advanced.rb

@@ -0,0 +1,45 @@
+module Faraday
+  class CacheAdvanced < Faraday::Middleware
+
+    attr_accessor :store
+
+    register_middleware :post_cache => CacheAdvanced
+
+    def initialize(app, cache = nil, opts = {})
+      @app = app
+      if(storename = opts.delete(:store))
+        @store = lookup_store(storename)
+      else
+        @store = cache || yield
+      end
+    end
+
+    def call(env)
+      key = cache_key(env)
+      response = store.read(key)
+
+      if(response.nil? || env[:request_headers].delete(:must_revalidate))
+        response = @app.call(env)
+        store.write(key, response) if response.success?
+      end
+
+      env[:response] = response
+      env.update response.env unless env[:response_headers]
+      response.env[:method] = env[:method]
+      response.env[:url] = env[:url]
+
+      response
+    end
+
+    def cache_key(env)
+      body = Hash(env[:body])
+      body_string = body.keys.sort.map {|key| "#{key}=#{body[key]}"}.join("&")
+      "#{env[:url]}/#{body_string}"
+    end
+
+    def lookup_store(name, opts)
+      ActiveSupport::Cache.lookup_store(name.to_sym, opts)
+    end
+
+  end
+end

data/lib/faraday/cache-advanced/version.rb

@@ -0,0 +1,5 @@
+module Faraday
+  module CacheAdvanced
+      VERSION = "0.0.1"
+  end
+end

data/spec/cache_advanced_spec.rb

@@ -0,0 +1,99 @@
+require 'faraday'
+require 'faraday/cache-advanced/cache-advanced'
+
+describe Faraday::CacheAdvanced do
+
+  before do
+    @cache = TestCache.new
+    request_count = 0
+    response = lambda { |env|
+      [200, {'Content-Type' => 'text/plain'}, "request:#{request_count+=1}"]
+    }
+    broken = lambda { |env|
+      [500, {'Content-Type' => 'text/plain'}, "request:#{request_count+=1}"]
+    }
+    @conn = Faraday.new do |b|
+      b.use CachingLint
+      b.use Faraday::CacheAdvanced, @cache, options
+      b.adapter :test do |stub|
+        stub.get('/', &response)
+        stub.get('/?foo=bar', &response)
+        stub.post('/', {foo: 'bar'}, &response)
+        stub.post('/', {foo: 'bar', baz: 'meh'}, &response)
+        stub.get('/other', &response)
+        stub.get('/broken', &broken)
+      end
+    end
+  end
+
+  let(:options) { {} }
+
+  extend Forwardable
+  def_delegators :@conn, :get, :post
+
+  it 'caches get requests' do
+    expect(get('/').body).to eq('request:1')
+    expect(get('/').body).to eq('request:1')
+    expect(get('/other').body).to eq('request:2')
+    expect(get('/other').body).to eq('request:2')
+  end
+
+  it 'includes request params in the response' do
+    get('/') # make cache
+    response = get('/')
+    puts response.to_hash
+    expect(response.env[:method]).to eq(:get)
+    expect(response.env[:url].request_uri).to eq('/')
+  end
+
+  it 'caches requests with query params' do
+    expect(get('/').body).to eq('request:1')
+    expect(get('/?foo=bar').body).to eq('request:2')
+    expect(get('/?foo=bar').body).to eq('request:2')
+    expect(get('/').body).to eq('request:1')
+  end
+
+  it 'caches POST requests by the BODY' do
+    expect(post('/', {foo: 'bar'}).body).to eq('request:1')
+    expect(post('/', {foo: 'bar'}).body).to eq('request:1')
+    expect(post('/', {foo: 'bar'}).body).to eq('request:1')
+  end
+
+  it 'caches posts requests by the alphabatized body params' do
+    expect(post('/', {foo: 'bar', baz: 'meh'}).body).to eq('request:1')
+    expect(post('/', {baz: 'meh', foo: 'bar'}).body).to eq('request:1')
+  end
+
+  it 'does not cache responses with invalid status code' do
+    expect(get('/broken').body).to eq('request:1')
+    expect(get('/broken').body).to eq('request:2')
+  end
+
+  class TestCache < Hash
+    def read(key)
+      if cached = self[key]
+        Marshal.load(cached)
+      end
+    end
+
+    def write(key, data)
+      self[key] = Marshal.dump(data)
+    end
+
+    def fetch(key)
+      read(key) || yield.tap { |data| write(key, data) }
+    end
+  end
+
+  class CachingLint < Struct.new(:app)
+    def call(env)
+      app.call(env).on_complete do
+        raise "no headers" unless env[:response_headers].is_a? Hash
+        raise "no response" unless env[:response].is_a? Faraday::Response
+        # raise "env not identical" unless env[:response].env.object_id == env.object_id
+      end
+    end
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'faraday/cache-advanced'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: faraday-cache-advanced
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Stewart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Sometimes you gotta cache POST requests.  This gem gives you a Faraday
+  middleware to cache POST requests.
+email:
+- johnsinco@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faraday-cache-advanced.gemspec
+- lib/faraday-cache-advanced.rb
+- lib/faraday/cache-advanced/cache-advanced.rb
+- lib/faraday/cache-advanced/version.rb
+- spec/cache_advanced_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Simple caching middleware to cache ALL Requests including POST requests in
+  faraday
+test_files:
+- spec/cache_advanced_spec.rb
+- spec/spec_helper.rb
+has_rdoc: