grape_cache 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0aff7faeba22650387a9a0f10bdc1fada4349666
+  data.tar.gz: cead8b6f22a977484ecfbd8dae9a9776b50ca5f5
+SHA512:
+  metadata.gz: e07e1a92ed8a8d513dbef1cc678ea871767e03851d12dd2a40ce93c5e96e38344eb5d2926b897f7a0fb04d55837c452e75f961e528b5a7fca3b292198793a017
+  data.tar.gz: 0d678a2010d84859870d6da9995c97b7210aef3753990c1a705c3f8d9b2c39886ba02f4bd431ed40f1a5258bfd7da069686ce8873f04b2bb78f1b80eb943dbe4

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3.0
+script:
+  - bundle exec rspec

data/Dockerfile

@@ -0,0 +1,17 @@
+# Ruby image
+FROM ruby
+
+# Install bundler
+RUN gem install bundler --no-ri --no-rdoc
+
+# Make app folder
+RUN mkdir app/
+
+# Set as workdir
+WORKDIR app/
+
+# Add the full source
+ADD . .
+
+# Install!
+RUN bundle install

data/Gemfile

@@ -0,0 +1,8 @@
+# Source
+source 'https://rubygems.org'
+
+# Some test dependencies
+gem 'rack-test'
+
+# Add the Gem dependencies
+gemspec

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    grape_cache (0.0.0)
+      grape (~> 0.16)
+      multi_json
+      oj
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    enumerable-lazy (0.0.1)
+    equalizer (0.0.11)
+    grape (0.16.2)
+      activesupport
+      builder
+      hashie (>= 2.1.0)
+      multi_json (>= 1.3.2)
+      multi_xml (>= 0.5.2)
+      mustermann19 (~> 0.4.3)
+      rack (>= 1.3.0)
+      rack-accept
+      virtus (>= 1.0.0)
+    hashie (3.4.4)
+    i18n (0.7.0)
+    ice_nine (0.11.2)
+    json (1.8.3)
+    minitest (5.9.0)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    mustermann19 (0.4.3)
+      enumerable-lazy
+    oj (2.15.0)
+    rack (1.6.4)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  grape_cache!
+  rack-test
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.12.4

data/README.md

@@ -0,0 +1,50 @@
+# Grape Cache [![Build Status](https://travis-ci.org/gabrielcorado/grape_cache.svg?branch=develop)](https://travis-ci.org/gabrielcorado/grape_cache) [![Gem Version](https://badge.fury.io/rb/grape_cache.svg)](https://badge.fury.io/rb/grape_cache)
+```
++-----------+     Cached?
+|  Request  +------------------+
++-----------+                  |
+                               |
+                               |
+                               v
++-----------+     No     +-----+-----+
+| API Call  +<-----------+   Cache   |
++-----+-----+            +-----+-----+
+      |                        |
+      |                        |
+      v                        |
++-----+-----+     Yes          |
+| Response  +<-----------------+
++-----------+
+```
+
+## How it works
+The module generates a key based on the Grape Route(METHOD + PATH) and the current params
+(HTTP BODY + QUERY STRINGS) and set the result of the API Call to this key.
+When another request with exacly same attributes that will generate the same key again,
+it does not call the API again, it just return the last response.
+
+## Usage
+```ruby
+# Add the Middleware into your API class
+# In the middleware definition you have to specify the
+# store used by the middleware, also you could pass the
+# params for this store like `:expires_in`
+class Application < Grape::API
+  use GrapeCache, store: Rails.cache, options: { expires_in: 1.hour }
+end
+
+# After this just simply set your routes with a cache flag
+get '/hello/cache', cache: true do
+  { hello: 'From cache' }
+end
+
+# To use it with a shared cache env you could use the flag `:namespace`
+# to define it. In this case I'll use the Apartment as example.
+use GrapeCache, store: Rails.cache, namespace: -> { Apartment::Tenant.current }
+```
+
+## Development
+* Building the docker container: `docker build -t grape-cache .`
+* Running the tests:
+  * With volume: `docker run --rm -it -v (PWD):/app grape-cache bundle exec rspec`
+  * Without volume: `docker run --rm -it grape-cache bundle exec rspec`

data/grape_cache.gemspec

@@ -0,0 +1,32 @@
+#
+require './lib/grape_cache/version'
+
+#
+Gem::Specification.new do |s|
+  #
+  s.name = 'grape_cache'
+  s.version = GrapeCache.version
+
+  #
+  s.summary = ''
+  s.description = ''
+
+  #
+  s.author = 'Gabriel Corado'
+  s.email = 'gabrielcorado@mail.com'
+  s.homepage = 'http://github.com/gabrielcorado/venduitz'
+
+  #
+  s.files = `git ls-files`.strip.split("\n")
+  s.executables = Dir["bin/*"].map { |f| File.basename(f) }
+
+  # Dependencies
+  # s.add_dependency 'concurrent-ruby', '~> 1.0'
+  # s.add_dependency 'docker-api', '~> 1.26'
+  s.add_dependency 'multi_json'
+  s.add_dependency 'oj'
+  s.add_dependency 'grape', '~> 0.16'
+
+  # Development depencies
+  s.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/grape_cache/middleware.rb

@@ -0,0 +1,140 @@
+#
+module GrapeCache
+  # Middleware Class
+  class Middleware < Grape::Middleware::Base
+    # Overwriting the method call! from Grape::Middleware::Base
+    # Reason: Make the :before call to return the whole stack
+		def call!(env)
+			@env = env
+      # Just here is moving!
+      before_res = before
+      return before_res unless before_res.nil?
+      # end the overwrite
+			begin
+				@app_response = @app.call(@env)
+			ensure
+				begin
+					after_response = after
+				rescue StandardError => e
+					warn "caught error of type #{e.class} in after callback inside #{self.class.name} : #{e.message}"
+					raise e
+				end
+			end
+
+			response = after_response || @app_response
+			merge_headers response
+			response
+		end
+
+    #
+    def after
+      # Check if cache is enabled in this route
+      return unless cache?
+
+      # Cache its output
+      store.write key(@params), response, @options.fetch(:options, {}).merge(endpoint.options.fetch(:options, {}))
+
+      # Do not change the return
+      return
+    end
+
+    # Generate the cache if its necessary
+    def before
+      # Check if cache is enabled in this route
+      return unless cache?
+
+      # Generate the cache key
+      k = key(params)
+
+      # Check the current key exists in the cache
+      return unless store.exist?(k)
+
+      # Get to the response it
+      res = MultiJson.load store.read(k)
+
+      # Return in the Rack Formatt
+      [res['status'], res['headers'], res['body']]
+    end
+
+    private
+
+    # Check if the current route has cache
+    def cache?
+      endpoint.options.fetch(:route_options, {}).fetch(:cache, false)
+    end
+
+    # Cache store
+    def store
+      # Check if Store was defined
+      raise 'Cache Store have to be defined' if @options[:store].nil?
+
+      # Return it
+      @options[:store]
+    end
+
+    # Cache key
+    def key(opts)
+      # Get the namespace
+      ns = namespace
+
+      # Default prefix: `grape_cache`
+      res = "grape_cache/#{digest(route)}/#{digest(opts)}"
+
+      # Add the namespace (if its necessary)
+      "#{ns}/#{res}" if ns.nil?
+
+      # Return the result
+      res
+    end
+
+    # Get the namespace
+    def namespace
+      # Check if its nil
+      return nil if @options[:namespace].nil?
+
+      # Call it if it's a Proc
+      @options[:namespace].proc? ? @options[:namespace].call : @options[:namespace]
+    end
+
+    # Route
+    def route
+      "#{endpoint.route.options[:method]} #{endpoint.route.pattern.path}"
+    end
+
+    # Transform the reponse into JSON
+    def response
+      # Dump it to JSON
+      MultiJson.dump({
+        status: @app_response.status,
+        headers: @app_response.headers,
+        body: @app_response.body
+      })
+    end
+
+    # Digest the params
+    def digest(params)
+      # Dump the params
+      dump = Marshal::dump(params)
+
+      # Disgest the params
+      Digest::MD5.hexdigest dump
+    end
+
+    # Endpoint params
+    # Get the input passed and the QueryString
+    def params
+      # endpoint.declared(endpoint.params)
+      @params = "#{env['QUERY_STRING']}_#{env[Grape::Env::RACK_INPUT].read}"
+    end
+
+    # Request
+    def request
+      @request ||= Rack::Request.new(env)
+    end
+
+    # Access the endpoint
+    def endpoint
+      env['api.endpoint']
+    end
+  end
+end

data/lib/grape_cache/version.rb

@@ -0,0 +1,7 @@
+#
+module GrapeCache
+  # Gem version
+  def self.version
+    '0.0.0'.freeze
+  end
+end

data/lib/grape_cache.rb

@@ -0,0 +1,13 @@
+# Initialize the module
+module GrapeCache
+end
+
+# Dependencies
+require 'grape'
+require 'grape/middleware/formatter'
+require 'digest/md5'
+require 'oj'
+require 'multi_json'
+
+# Modules
+require 'grape_cache/middleware'

data/spec/grape_cache/middleware_spec.rb

@@ -0,0 +1,86 @@
+# Helper
+require 'spec_helper'
+
+# Create a Grape API application
+class Application < Grape::API
+  # Add the Middleware
+  # insert_after Grape::Middleware::Formatter, GrapeCache::Middleware, store: CacheStore.new
+  use GrapeCache::Middleware, store: CacheStore.new
+
+  # Set the format
+  format :json
+
+  # Simple Route
+  params do
+    optional :break, default: true
+  end
+  get '/simple', cache: true do
+    { hello: 'Route', time: Time.now }
+  end
+
+  #
+  resource :sub do
+    get '/simple', cache: true do
+      { hello: 'Sub', time: Time.now }
+    end
+  end
+
+  # Post request
+  post '/post', cache: true do
+    { hello: 'Sub', time: Time.now }
+  end
+end
+
+# Class test
+describe GrapeCache::Middleware do
+  # Create a Grape app
+  let(:app) { Application.new }
+
+  #
+  it 'should generate the cache for a simple text view' do
+    # Execute the route
+    get '/simple'
+
+    # Get it infos
+    first = MultiJson.load last_response.body
+    expect(first['time']).to eq(Time.now.to_s)
+
+    # Sleep...
+    sleep 2
+
+    # Sub Route
+    get '/sub/simple', hello: 'Test'
+    expect(MultiJson.load(last_response.body)['time']).to eq(Time.now.to_s)
+
+    # Sleep...
+    sleep 2
+
+    # Cached response
+    get '/simple'
+    expect(MultiJson.load(last_response.body)['time']).to eq(first['time'])
+
+    # Sleep...
+    sleep 2
+
+    # Test a Post request
+    post '/post', {hello: 'Test'}.to_json, 'CONTENT_TYPE' => 'application/json'
+    first_post = MultiJson.load(last_response.body)
+    expect(first_post['time']).to eq(Time.now.to_s)
+
+    # Sleep...
+    sleep 2
+
+    # Test a Post request
+    post '/post', {hello: 'Test'}.to_json, 'CONTENT_TYPE' => 'application/json'
+    expect(MultiJson.load(last_response.body)['time']).to eq(first_post['time'])
+
+    # Sleep...
+    sleep 2
+
+    # Execute the route
+    get '/simple', break: true
+
+    # Get it infos
+    expect(MultiJson.load(last_response.body)['time']).to eq(Time.now.to_s)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+# Spec dependencies
+require 'grape_cache'
+require 'grape'
+require 'rack/test'
+
+# Configure the RSpec
+RSpec.configure do |config|
+  config.order = 'random'
+  config.seed = '12345'
+  config.include Rack::Test::Methods
+end
+
+# Define a Store
+class CacheStore
+  # Storage
+  attr_reader :storage
+
+  # Initialize
+  def initialize
+    @storage = {}
+  end
+
+  #
+  def write(key, value, options)
+    @storage[key] = value
+  end
+
+  #
+  def read(key)
+    @storage[key]
+  end
+
+  # Exist?
+  def exist?(key)
+    @storage.key?(key)
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: grape_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Gabriel Corado
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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: oj
+  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: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email: gabrielcorado@mail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- README.md
+- grape_cache.gemspec
+- lib/grape_cache.rb
+- lib/grape_cache/middleware.rb
+- lib/grape_cache/version.rb
+- spec/grape_cache/middleware_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/gabrielcorado/venduitz
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []