faraday-manual-cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 72ed2d3a4eb4bacc4e2f682d7d2f0621aecfc2ae
+  data.tar.gz: 1ff4fcf690ae465b312fa324152d40bd4bc1910a
+SHA512:
+  metadata.gz: 781465c3431f1167f6dea2df07b617b1a4b8de965dbfd890e6a018ea50792a2b84d7a630760d67bafa611d82c061fc68bc6b6393ef4849225670f42719469d24
+  data.tar.gz: 5dd8050ea269687ce3ccf5137d42ae20001382f11763ddf5cb4088deeb43be7575e4e6513d9e5a7c2f9d89e43c8f10fb744ccb8332aa8c37af7d98e064fcbce0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rubocop.yml

@@ -0,0 +1,3 @@
+FileName:
+  Description: 'Use snake_case for source file names.'
+  Enabled: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel O'Brien
+
+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,69 @@
+# Faraday::ManualCache
+
+A super simple Faraday cache implementation.
+
+Unlike [`faraday-http-cache`](https://github.com/plataformatec/faraday-http-cache), `faraday-manual-cache` ignores cache headers in favor of a manually-specified `expires_in`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'faraday-manual-cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday-manual-cache
+
+## Usage
+
+Super simple example that caches using the default store (`MemoryStore`) for the default expires_in (30 seconds): 
+
+```ruby
+require 'faraday'
+require 'faraday-manual-cache'
+
+connection = Faraday.new(url: 'http://example.com') do |builder|
+  builder.use :manual_cache
+  builder.adapter Faraday.default_adapter
+end
+```
+The middleware currently takes several options:
+
+  * `expires_in`: Cache expiry, in seconds (default 30).
+  * `store`: The `ActiveSupport::Cache`-compatible store to use (default `ActiveSupport::Cache::MemoryStore`).
+  * `store_options`: Options passed to the store if created by lookup (e.g. when specifying `:memory_store`, `:redis_store`, etc).
+
+So a more complicated example would be:
+
+```ruby
+require 'faraday'
+require 'faraday-manual-cache'
+require 'redis-rails'
+
+connection = Faraday.new(url: 'http://example.com') do |builder|
+  builder.use :manual_cache, expires_in: 10, store: :redis_store, store_options: { host: 'my-redis-server', port: '1234' }
+  builder.adapter Faraday.default_adapter
+end
+```
+
+As with `faraday-http-cache` it's recommended that `faraday-manual-cache` be fairly low in the middleware stack.
+
+## Contributing
+
+1. Fork it ( http://github.com/dobs/faraday-manual-cache/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 new Pull Request
+
+## Attribution
+
+Some implementation details taken from [`faraday-http-cache`](https://github.com/plataformatec/faraday-http-cache).
+
+## Contributors
+
+  * Maintainer: [Daniel O'Brien](http://github.com/dobs)

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/faraday-manual-cache.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = 'faraday-manual-cache'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Daniel O\'Brien']
+  spec.email         = ['dan@dobs.org']
+  spec.summary       = %q(A super simple Faraday cache implementation.)
+  spec.description   = %q(A super simple Faraday cache implementation.)
+  spec.homepage      = 'https://github.com/dobs/faraday-manual-cache'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 3.0.0'
+  spec.add_dependency 'faraday', '~> 0.9'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+end

data/lib/faraday/manual_cache.rb

@@ -0,0 +1,74 @@
+require 'faraday'
+
+module Faraday
+  # Middleware for caching Faraday responses based on a specified expiry.
+  #
+  # As with faraday-http-cache, it's recommended that this middleware be added
+  # fairly low in the middleware stack.
+  #
+  # Currently accepts four arguments:
+  #
+  #   :expires_in    - Cache expiry, in seconds (default: 30).
+  #   :store         - An object (or lookup symbol) for an
+  #                    ActiveSupport::Cache::Store instance. (default:
+  #                    MemoryStore).
+  #   :store_options - Options to pass to the store when generated based on a
+  #                    lookup symvol (default: {}).
+  class ManualCache < Faraday::Middleware
+    def initialize(app, *args)
+      super(app)
+      options = args.first || {}
+      @expires_in    = options.fetch(:expires_in, 30)
+      @store         = options.fetch(:store, :memory_store)
+      @store_options = options.fetch(:store_options, {})
+
+      initialize_store
+    end
+
+    def call(env)
+      dup.call!(env)
+    end
+
+    protected
+
+    def call!(env)
+      return to_response(cached_response(env)) if cacheable?(env) &&
+        cached_response(env)
+
+      @app.call(env).on_complete do |response_env|
+        cache_response(response_env) if cacheable?(env)
+      end
+    end
+
+    # Cache the env to the store.
+    def cache_response(env)
+      @store.write(env.url, env, expires_in: @expires_in)
+    end
+
+    # Whether or not the env is cacheable.
+    def cacheable?(env)
+      env.method == :get || env.method == :head
+    end
+
+    # Retrieve (and memoize) cached response matching current env.
+    def cached_response(env)
+      @cached_response ||= @store.fetch(env.url)
+    end
+
+    # Checks whether the specified store is a symbol, and if so attempts to
+    # do a lookup against ActiveSupport::Cache.
+    def initialize_store
+      return unless @store.is_a? Symbol
+
+      require 'active_support/cache'
+      @store = ActiveSupport::Cache.lookup_store(@store, @store_options)
+    end
+
+    # Massage env into a Response object.
+    def to_response(env)
+      response = Response.new
+      response.finish(env) unless env.parallel?
+      env.response = response
+    end
+  end
+end

data/lib/faraday-manual-cache.rb

@@ -0,0 +1,7 @@
+require 'faraday/manual_cache'
+
+if Faraday.respond_to?(:register_middleware)
+  Faraday.register_middleware manual_cache: Faraday::ManualCache
+elsif Faraday::Middleware.respond_to?(:register_middleware)
+  Faraday::Middleware.register_middleware manual_cache: Faraday::ManualCache
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: faraday-manual-cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel O'Brien
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: A super simple Faraday cache implementation.
+email:
+- dan@dobs.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rubocop.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faraday-manual-cache.gemspec
+- lib/faraday-manual-cache.rb
+- lib/faraday/manual_cache.rb
+homepage: https://github.com/dobs/faraday-manual-cache
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A super simple Faraday cache implementation.
+test_files: []
+has_rdoc: