api-response-cache 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42381b180cd364cf42447e4d5a611442a1e89d705203c1d5f778b3f53cf918cc
-  data.tar.gz: 82d5d1b775456abd9e8b50a0d7c70f4d169d34b7ce03d2158a697c0865f52a06
+  metadata.gz: 6a1744cd6108aac753efc5a5cf38079c1788675fafa5bc2c8695c84897fae7c7
+  data.tar.gz: 468fdcb78eaa81ba103631d7f9b0f82117d5eab96cc8aba6997e0f0934bb24f3
 SHA512:
-  metadata.gz: 2a0aa8082523581177755e9b0068a41d178f71741b76cc598969b13a5c5827c4a0801aff021b3bb24b8f6368fea8191cd157e04d940454c549d79224f252f9ca
-  data.tar.gz: a33a843bf730cd690f9a71b0743feeb5b8dacb68882d6ea16937d35cbff8051f75294a0003d5357c46b3e72a8c2cd250cf737ae00d952a65ff7dccaa2f88dc4c
+  metadata.gz: f108f0d65d14a914b21eed34c16d90e94dab98cd156089e9956a22d133179f005f198671eca334d67d3976d8291927b0fa1642abbcc19ba041e8b50c2acd2a43
+  data.tar.gz: 9a9bf54aa694af847138c8eac98f62e39ccf71c0e5077b58c98f2f9daac2f83f514e90a0772b51e0bb49d396357f9c34ed4f8ba9895deab58552ee49114d962d

data/README.md

@@ -1,5 +1,46 @@
-# TO DO
-- Write summary and description
-- Write read me
-- Expire
-- Request Mothods to cache
+# API Response Cache
+Improve rails server api response time by caching your rails api response response data to client side.
+
+## Installation
+Add to Gemfile
+```
+gem 'api-response-cache'
+```
+Then run
+```
+bundle install
+```
+
+## Configuration
+If you want to change config create file at ```config/initializers/api_response_cache.rb```
+```
+ApiResponseCache.configure do |config|
+  config.refresh_by_request_params = false  # true to saperate cache by request params
+end
+```
+
+## Basic Usage
+```
+class ExamplesController < ActionController::API
+  cache_response_for :index
+
+  def index
+    # ... your code here
+  end
+end
+```
+#### Add expire duration
+```
+cache_response_for :index, expires_in: 1.day
+```
+
+#### Clear Cache
+```
+ApiResponseCache.clear
+```
+
+
+
+## TO DO
+- [ ] Clear cache
+- [ ] Expire cache

data/api-response-cache.gemspec

@@ -6,12 +6,13 @@ require "api_response_cache/version"
 Gem::Specification.new do |spec|
   spec.name          = "api-response-cache"
   spec.version       = ApiResponseCache::VERSION
+  spec.summary       = "Cache api render for Ruby On Rails app"
+  spec.description   = "Improve api resonse by cache status, header, and response body"
+  spec.homepage      = "https://github.com/Uysim/api-response-cache"
+
   spec.authors       = ["Uysim Ty"]
   spec.email         = ["uysimty@gmail.com"]
 
-  spec.summary       = "Use for cache api render"
-  spec.description   = "Use for cache api render"
-  spec.homepage      = "http://uysim.com"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -29,6 +30,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.1.0'
+
   spec.add_runtime_dependency 'rainbow', '~> 2'
 
   spec.add_development_dependency "bundler", "~> 1.16"

data/lib/api-response-cache.rb

@@ -16,4 +16,8 @@ module ApiResponseCache
   def self.configuration
     @configuration ||= ApiResponseCache::Config.new
   end
+
+  def self.clear
+     Rails.cache.delete_matched('api-response-cache/*')
+  end
 end

data/lib/api_response_cache/version.rb

@@ -1,3 +1,3 @@
 module ApiResponseCache
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-response-cache
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Uysim Ty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-28 00:00:00.000000000 Z
+date: 2018-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Use for cache api render
+description: Improve api resonse by cache status, header, and response body
 email:
 - uysimty@gmail.com
 executables: []
@@ -74,7 +74,7 @@ files:
 - lib/api_response_cache/config.rb
 - lib/api_response_cache/response_cache.rb
 - lib/api_response_cache/version.rb
-homepage: http://uysim.com
+homepage: https://github.com/Uysim/api-response-cache
 licenses:
 - MIT
 metadata: {}
@@ -86,7 +86,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -97,5 +97,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Use for cache api render
+summary: Cache api render for Ruby On Rails app
 test_files: []