api-response-cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3729234136079bb72a8a77f7a8a6671b1a621cff2191e6d4152facbd001dea72
+  data.tar.gz: 8c32a9cbd838ab1c2e5e81a5126d8a31a4ae4d43649cd86ccea6eb3e60adb4e2
+SHA512:
+  metadata.gz: ad57264c6515cb3bf3b6abccd6dfb74d9bbeddcfded3eacd746431adffedfae80245e0d392bf4cdf45661147ae923028f155410388243b914dc07ee29f3ae338
+  data.tar.gz: e46d9768a179ee0e7ec10269dc0cb05d60a217cf0868620a18f958827ca14d86e914fac46a04a19b26cb6814a1a173938e247ec9967493b0e6dea11e32288140

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at uysimty@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+gem 'rainbow'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Uysim Ty
+
+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 @@
+# TO DO : Write Read Me

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/api-response-cache.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "api_response_cache/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "api-response-cache"
+  spec.version       = ApiResponseCache::VERSION
+  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'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "api_response_cache"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/api-response-cache.rb

@@ -0,0 +1,6 @@
+require "api_response_cache/version"
+require "api_response_cache/actions"
+require "api_response_cache/api_cache_handler"
+require "api_response_cache/response_cache"
+
+ActionController::API.send(:include, ApiResponseCache::Actions)

data/lib/api_response_cache/actions.rb

@@ -0,0 +1,12 @@
+module ApiResponseCache
+  module Actions
+    extend ActiveSupport::Concern
+    module ClassMethods
+      def cache_response_for(*actions)
+        options = actions.extract_options!
+        filter_options = options.extract!(:if, :unless).merge(only: actions)
+        around_action  ApiCacheHandler.new(options), filter_options
+      end
+    end
+  end
+end

data/lib/api_response_cache/api_cache_handler.rb

@@ -0,0 +1,50 @@
+module ApiResponseCache
+  module Actions
+    class ApiCacheHandler
+      def initialize(options)
+        @options       = options
+        @expires_in    = @options[:expires_in]
+      end
+
+
+      def around(controller)
+        init(controller)
+        if @response_cache.present?
+          log_info
+          render_cached_response
+        else
+          yield
+          @response_cache.write_cache(controller.response)
+        end
+      end
+
+      protected
+
+      def log_info
+        processor     = Rainbow("#{@controller.class.name}##{@controller.action_name}").blue
+        responder     = Rainbow('API Response Cache').green
+        Rails.logger.info "=== #{processor} response by #{responder} ==="
+      end
+
+      def init(controller)
+        @controller         = controller
+        @request            = controller.request
+        @cache_path       ||= "api-response-cache/#{@options[:cache_path] || @request.fullpath}"
+
+        @response_cache     = ResponseCache.new(@cache_path, @expires_in)
+      end
+
+      def render_cached_response
+        body    = @response_cache.body
+        status  = @response_cache.status
+        headers = @response_cache.headers
+
+        headers.each do |key, value|
+          @controller.response.headers[key] = value
+        end
+
+        @controller.render plain: body, status: status
+      end
+    end
+  end
+end

data/lib/api_response_cache/response_cache.rb

@@ -0,0 +1,40 @@
+module ApiResponseCache
+  module Actions
+    class ResponseCache
+      def initialize(cache_path, expires_in)
+        @cache_path = cache_path
+        @expires_in = expires_in || 1.hour
+      end
+
+      def present?
+        cached_response.present?
+      end
+
+      def body
+        cached_response['body']
+      end
+
+      def status
+        cached_response['status']
+      end
+
+      def headers
+        cached_response['headers']
+      end
+
+      def cached_response
+        @cached_response ||= Rails.cache.read(@cache_path)
+      end
+
+      def write_cache(response)
+        cache_object = {
+          body: response.body,
+          status: response.status,
+          headers: response.headers
+        }.as_json
+        Rails.cache.write(@cache_path, cache_object, expires_in: @expires_in)
+      end
+
+    end
+  end
+end

data/lib/api_response_cache/version.rb

@@ -0,0 +1,3 @@
+module ApiResponseCache
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: api-response-cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Uysim Ty
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: Use for cache api render
+email:
+- uysimty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api-response-cache.gemspec
+- bin/console
+- bin/setup
+- lib/api-response-cache.rb
+- lib/api_response_cache/actions.rb
+- lib/api_response_cache/api_cache_handler.rb
+- lib/api_response_cache/response_cache.rb
+- lib/api_response_cache/version.rb
+homepage: http://uysim.com
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Use for cache api render
+test_files: []