faraday_api_cache 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
----
-SHA1:
-  metadata.gz: 29f3996cccec51cb7f8d257c5194f2bc4d9af93e
-  data.tar.gz: ea48eaaa543a0bffdcf8482446859cdd0da04eed
-SHA512:
-  metadata.gz: b7ab9be166de1f3a223cecb2a8fdedd493efbf2d702559e2ee34ecc393e06ad365086c41ba30ea3ae03c443667331b8ac57adc45d21f1eaa9cf56a9f774ced1f
-  data.tar.gz: f57693702599b18fe6ea6cf131125455b442dc3bbfba2c8ab3d37aeb96a1d305df63ed68087fe17d927755b8f01c0da8de3c0fb8ba8b4832bd7afeeb759f504f
+--- 
+SHA1: 
+  metadata.gz: a9f6a6340b3bc149aadf515cccc280b84d6a9e79
+  data.tar.gz: 6861ca429409c65a74c8d458cdcff67e7a33d24a
+SHA512: 
+  metadata.gz: a4f64dd8c6d4a4bb2aaab518820135eb6c9e741c6a4ce561eb80a09e6e7150383dfaf773a5c77ba7a898d796370d53a13de2367e1243a9a402695e68c795dd17
+  data.tar.gz: 249c213aab1079bac16474e2b31c6deb4dc33a6044a3297bf3221729714cf6bb709ee30562a5c58b1be7bfd16bbffb9f61ea599e92c754940a9b7ace24864d03

data/README.md

@@ -1,29 +1,36 @@
-# FaradayApiCache
+# Faraday API Cache
 
-TODO: Write a gem description
+This is a [faraday](https://github.com/lostisland/faraday) middleware that integrates [API Cache](https://github.com/mloughran/api_cache) into the faraday middleware stack. Using Faraday API Cache, GET requests using Faraday will be cached automatically.
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+Make sure you have required the Faraday API Cache gem, or included it in your Gemfile. Then add Faraday API Cache as a request middleware:
 
-    gem 'faraday_api_cache'
+~~~ruby
+farcon = Faraday.new(url: 'http://example.com') do |c|
+  c.request :api_cache
+  # more config goes here...
+end
+~~~
 
-And then execute:
+That's it!
 
-    $ bundle
+Faraday API Cache passes any hash arguments to API Cache - see the [API Cache documentation](https://github.com/mloughran/api_cache) for more details (but the `cache` parameter especially is useful).
 
-Or install it yourself as:
+Faraday API Cache also provides helper methods to change the logger and cache store used by API Cache:
 
-    $ gem install faraday_api_cache
+~~~ruby
+FaradayAPICache.logger = Rails.logger
+FaradayAPICache.store = Moneta.new(:Memcached)
+~~~
 
-## Usage
+## Why use Faraday API Cache?
+
+There are already good middleware for caching in Faraday:
 
-TODO: Write usage instructions here
+* [faraday-http-cache](https://github.com/plataformatec/faraday-http-cache) takes cache settings from the expiry and modified response headers, whereas Faraday API Cache lets the developer set the cache expiry.
+* The caching middleware in [faraday_middleware](https://github.com/lostisland/faraday_middleware) is equivelent to Faraday API Cache, but if you're already using API Cache then it might make more sense to use Faraday API Cache.
 
-## Contributing
+## Credits
 
-1. Fork it ( https://github.com/[my-github-username]/faraday_api_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 a new Pull Request
+Faraday API Cache was originally written by [Ismael Celis](https://github.com/ismasan), but was open sourced and is now maintained by [Iain Beeston](https://github.com/iainbeeston).

data/lib/faraday_api_cache.rb

@@ -1,4 +1,16 @@
 require 'faraday_api_cache/version'
 require 'faraday_api_cache/middleware'
 
+module FaradayAPICache
+  class << self
+    def logger=(logger)
+      APICache.logger = logger
+    end
+
+    def store=(store)
+      APICache.store = store
+    end
+  end
+end
+
 Faraday::Request.register_middleware api_cache: FaradayAPICache::Middleware

data/lib/faraday_api_cache/middleware.rb

@@ -5,31 +5,17 @@ module FaradayAPICache
   class Middleware < Faraday::Middleware
     def initialize(app, options = {})
       super(app)
-      @options = options.to_hash
+      @options = { period: 0, timeout: 0 }.merge(options.to_hash)
     end
 
     def call(env)
       if env[:method] == :get
         APICache.get(env[:url].to_s, @options) do
-          APICache.logger.debug 'FaradayAPICache cache miss... Caching.'
           @app.call(env)
         end
       else
-        APICache.logger.debug 'FaradayAPICache cache hit.'
         @app.call(env)
       end
     end
-
-    def self.clear
-      self.store = APICache::MemoryStore.new
-    end
-
-    def self.logger=(logger)
-      APICache.logger = logger
-    end
-
-    def self.store=(store)
-      APICache.store = store
-    end
   end
 end

data/lib/faraday_api_cache/version.rb

@@ -1,3 +1,3 @@
 module FaradayAPICache
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,80 +1,65 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: faraday_api_cache
-version: !ruby/object:Gem::Version
-  version: 0.0.2
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
 platform: ruby
-authors:
+authors: 
 - Ismael Celis
 - Iain Beeston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-07-19 00:00:00 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: api_cache
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id002 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: api_cache
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+      - !ruby/object:Gem::Version 
+        version: "1.6"
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :development
+  version_requirements: *id005
 description: 
-email:
+email: 
 - ismaelct@gmail.com
 - iain.beeston@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - LICENSE.txt
@@ -85,27 +70,29 @@ files:
 - lib/faraday_api_cache/middleware.rb
 - lib/faraday_api_cache/version.rb
 homepage: 
-licenses:
+licenses: 
 - MIT
 metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '1.9'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.9"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A faraday middleware that uses API Cache to transparently cache requests
 test_files: []
+