content_caching 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f76b31f135b71b97dae7f0b560366afd49d65fe
+  data.tar.gz: 47b2f2a7756927158656355120605006ad701f1b
+SHA512:
+  metadata.gz: f49f744dad7212723fd9f42451824ef08e19edbf5ee17b8df29784d998709562322cb923f93cc201fea5e16d32a3b8adc2fcd3bb52fae87fcd8aff090eece266
+  data.tar.gz: d9a7187010d2d3d420b18f58ff0001f6c35f8fe68befeead4507ae4b8fbd8c2f7bb4e3c865e202e4510f58b9a00ebebf11c05e083d3a375cd2585c76ff161e4a

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format=doc
+--color
+--backtrace

data/.ruby-gemset

@@ -0,0 +1 @@
+content_caching

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+### VERSION 0.0.1
+
+* bug fix
+  *
+
+* refactoring
+  *
+
+* enhancements
+  *
+
+* backwards incompatible changes
+  *
+
+* deprecations
+  *
+
+* todos
+  *

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in content_caching.gemspec
+gemspec
+
+group :test do
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joel AZEMAR
+
+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,33 @@
+# ContentCaching
+
+[![Gem Version](https://badge.fury.io/rb/content_caching.svg)](http://badge.fury.io/rb/content_caching)
+[![Code Climate](https://codeclimate.com/github/joel/content_caching.png)](https://codeclimate.com/github/joel/content_caching)
+[![Dependency Status](https://gemnasium.com/joel/content_caching.png)](https://gemnasium.com/joel/content_caching)
+[![Build Status](https://travis-ci.org/joel/content_caching.svg?branch=master)](https://travis-ci.org/joel/content_caching)
+[![Coverage Status](https://coveralls.io/repos/joel/content_caching/badge.png)](https://coveralls.io/r/joel/content_caching)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'content_caching'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install content_caching
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/content_caching/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

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'
+
+require 'rake'
+require 'rspec'
+
+require_relative 'lib/content_caching'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task default: :spec

data/content_caching.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/content_caching/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'content_caching'
+  spec.version       = ContentCaching::VERSION
+  spec.authors       = ['Joel AZEMAR']
+  spec.email         = ['joel.azemar@gmail.com']
+  spec.summary       = %q{Library for help and speed up views render manipulation}
+  spec.description   = %q{Library for help and speed up views render manipulation based on aws and local storage}
+  spec.homepage      = 'https://github.com/joel/content_caching'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake',    '~> 10.3'
+  spec.add_development_dependency 'rspec',   '~> 2.14'
+  spec.add_development_dependency 'webmock', '~> 1.18'
+  spec.add_development_dependency 'vcr',     '~> 2.9'
+  spec.add_development_dependency 'right_http_connection', '~> 1.4'
+
+  spec.add_dependency 'aws', '~> 2.10'
+
+  spec.required_ruby_version = '~> 2.1'
+end

data/lib/content_caching/adapters/abstract.rb

@@ -0,0 +1,24 @@
+module ContentCaching
+  module Adapter
+    class Abstract
+
+      def initialize wrapper, options
+        @wrapper = wrapper
+        @options = options
+      end
+
+      def store content
+        raise NotImplementedError
+      end
+
+      def url
+        raise NotImplementedError
+      end
+
+      def delete
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/content_caching/adapters/aws.rb

@@ -0,0 +1,50 @@
+require 'aws'
+
+module ContentCaching
+  module Adapter
+    class Aws
+
+      T_1_DAY = 86400.freeze
+
+      attr_reader :options
+
+      def initialize options
+        @options = options
+      end
+
+      def store document_path, content
+        retry_3_times do
+          content.rewind if content.respond_to?(:rewind)
+          s3_interface.put self.options[:directory], document_path, content.read
+        end
+      end
+
+      def url document_path
+        s3_interface.get_link self.options[:directory], document_path, T_1_DAY
+      end
+
+      def delete document_path
+        retry_3_times do
+          s3_interface.delete self.options[:directory], document_path
+        end
+      end
+
+      private
+
+      def s3_interface
+        @s3_interface ||= ::Aws::S3Interface.new self.options[:aws_access_key_id],
+                                                 self.options[:aws_secret_access_key]
+      end
+
+      def retry_3_times
+        tries = 0
+        begin
+          yield
+        rescue
+          (tries += 1) <3 ? retry : raise
+        end
+      end
+
+    end
+  end
+end

data/lib/content_caching/adapters/aws_adapter.rb

@@ -0,0 +1,38 @@
+require_relative 'abstract'
+require_relative 'implementation'
+require_relative 'aws'
+
+module ContentCaching
+  module Adapter
+    class AwsAdapter < Abstract
+      include Implementation
+
+      def initialize(wrapper, options)
+        super
+      end
+
+      def url
+        adapter.url document_path
+      end
+
+      def store content
+        adapter.store document_path, content
+      end
+
+      def delete
+        adapter.delete document_path
+      end
+
+      private
+
+      def document_path
+        @wrapper.document_path
+      end
+
+      def adapter
+        @adapter ||= Aws::new(@options)
+      end
+
+    end
+  end
+end

data/lib/content_caching/adapters/base.rb

@@ -0,0 +1,27 @@
+module ContentCaching
+  module Adapter
+    class Base
+
+      class UnsupportedAdapter < StandardError ; end
+
+      def self.create(adapter_infos, wrapper)
+        adapter_type = adapter_infos[:adapter]
+        options = adapter_infos[:options]
+
+        load "content_caching/adapters/#{adapter_type}_adapter.rb"
+        ContentCaching::Adapter.const_get(klass_adapter(adapter_type)).new(wrapper, options)
+      end
+
+      private
+
+      def self.klass_adapter adapter_symbol
+        case adapter_symbol
+        when :fs then :FsAdapter
+        when :aws then :AwsAdapter
+        else raise UnsupportedAdapter.new
+        end
+      end
+
+    end
+  end
+end

data/lib/content_caching/adapters/fs.rb

@@ -0,0 +1,19 @@
+module ContentCaching
+  module Adapter
+    class Fs
+
+      def store document_path, document_name, content
+        Pathname(url(document_path, document_name)).write content.read
+      end
+
+      def url document_path, document_name
+        "#{document_path}/#{document_name}"
+      end
+
+      def delete document_path, document_name
+        Pathname(url(document_path, document_name)).delete
+      end
+
+    end
+  end
+end

data/lib/content_caching/adapters/fs_adapter.rb

@@ -0,0 +1,39 @@
+require_relative 'abstract'
+require_relative 'implementation'
+require_relative 'fs'
+
+module ContentCaching
+  module Adapter
+    class FsAdapter < Abstract
+      include Implementation
+
+      def initialize(wrapper, options)
+        super
+      end
+
+      def url
+        adapter.url document_path, document_name
+      end
+
+      def store content
+        adapter.store document_path, document_name, content
+      end
+
+      def delete
+        adapter.delete document_path, document_name
+      end
+
+      private
+
+      def document_path
+        return @wrapper.document_path unless @options[:directory]
+        Pathname([@options[:directory], @wrapper.document_path].join('/')).cleanpath.to_path
+      end
+
+      def adapter
+        @adapter ||= Fs::new
+      end
+
+    end
+  end
+end

data/lib/content_caching/adapters/implementation.rb

@@ -0,0 +1,30 @@
+module ContentCaching
+  module Adapter
+    module Implementation
+
+      def store content
+        adapter.store content
+      end
+
+      def url
+        adapter.url
+      end
+
+      def delete
+        adapter.delete
+      end
+
+      private
+
+      def document_name
+        @wrapper.document_name
+      end
+
+      def document_path
+        return @wrapper.document_path unless @options[:directory]
+        Pathname([@options[:directory], @wrapper.document_path].join('/')).cleanpath.to_path
+      end
+
+    end
+  end
+end

data/lib/content_caching/configuration.rb

@@ -0,0 +1,9 @@
+module ContentCaching
+  class Configuration
+    attr_accessor :adapter
+
+    def initialize
+      @adapter = { adapter: :fs, options: { directory: 'tmp' }}
+    end
+  end
+end

data/lib/content_caching/version.rb

@@ -0,0 +1,3 @@
+module ContentCaching
+  VERSION = "0.0.1"
+end

data/lib/content_caching.rb

@@ -0,0 +1,39 @@
+require_relative 'content_caching/version'
+require_relative 'content_caching/configuration'
+require_relative 'content_caching/adapters/base'
+
+begin
+  require 'pry'
+rescue LoadError
+end
+
+require 'forwardable'
+
+module ContentCaching
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Document
+    extend Forwardable
+
+    def_delegators :adapter, :store, :url, :delete
+    attr_accessor :adapter
+
+    def initialize wrapper
+      self.adapter = ContentCaching::Adapter::Base.create(ContentCaching.configuration.adapter, wrapper)
+    end
+  end
+end

data/spec/content_caching/configuration_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module ContentCaching
+  describe Configuration do
+    let(:configuration) { Configuration.new }
+
+    describe '#adapter' do
+      let(:adapter) {{ adapter: :fs, options: { directory: 'tmp' }}}
+      it 'the default is fs' do
+        expect(configuration.adapter).to eq(adapter)
+      end
+    end
+
+  end
+end

data/spec/content_caching_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+require 'pathname'
+
+module ContentCaching
+  describe Document do
+
+    context 'fs' do
+      let(:wrapper)         { OpenStruct.new(options) }
+      let(:content_caching) { Document.new(wrapper) }
+
+      context 'options' do
+
+        context 'without document path' do
+          let(:options) {{ document_name: 'page.html', document_path: nil }}
+          specify do
+            expect(content_caching.url).to eq('tmp/page.html')
+          end
+        end
+
+        context 'with document path' do
+          let(:options) {{ document_name: 'page.html', document_path: 'pages' }}
+          specify do
+            expect(content_caching.url).to eq('tmp/pages/page.html')
+          end
+        end
+      end
+
+      describe '#store' do
+        let(:options) {{ document_name: 'page.html', document_path: 'public/pages' }}
+
+        before do
+          content_caching.store Pathname('spec/fixtures/page.html')
+        end
+
+        specify do
+          expect(Pathname('tmp/public/pages/page.html')).to be_exist
+        end
+
+        describe '#delete' do
+          before do content_caching.delete end
+          specify do
+            expect(Pathname('tmp/public/pages/page.html')).to_not be_exist
+          end
+        end
+      end
+    end
+
+    context 'aws', pending: true do
+      let(:wrapper)         { OpenStruct.new(options) }
+      let(:options)         {{ document_name: nil, document_path: 'test/page.html' }}
+      let(:content_caching) { Document.new(wrapper) }
+      let(:adapter) do
+        { adapter: :aws,
+          options: { directory: 'bucket-name', aws_access_key_id: 'aws_access_key_id',
+                     aws_secret_access_key: 'aws_secret_access_key' }
+        }
+      end
+
+      before do
+        ContentCaching.configure do |config|
+          config.adapter = adapter
+        end
+      end
+
+      describe '#url' do
+
+        let(:url) { 'https://bucket-name.s3.amazonaws.com:443/test/page.html' }
+
+        specify do
+          expect(content_caching.url).to match(url)
+        end
+      end
+
+      describe '#store' do
+        let(:s3) do
+          Aws::S3.new(
+            adapter[:options][:aws_access_key_id],
+            adapter[:options][:aws_secret_access_key])
+        end
+
+        let(:bucket) { Aws::S3::Bucket.new(s3, adapter[:options][:directory]) }
+
+        before do
+          # VCR.use_cassette('store') do
+            content_caching.store Pathname('spec/fixtures/page.html')
+          # end
+        end
+
+        specify do
+          expect(
+            Aws::S3::Key.new(bucket, options[:document_path])
+          ).to be_exists
+        end
+
+        describe '#delete' do
+          before do content_caching.delete end
+          specify do
+            expect(
+              Aws::S3::Key.new(bucket, options[:document_path])
+            ).to_not be_exists
+          end
+        end
+      end
+    end
+
+  end
+end

data/spec/fixtures/page.html

@@ -0,0 +1,9 @@
+<!doctype html>
+<html>
+  <head>
+    <title>Title</title>
+  </head>
+  <body>
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin luctus tortor eu hendrerit scelerisque. Cras sed tellus quis ipsum fringilla vulputate pulvinar vitae risus. Aenean dapibus mi enim, nec volutpat ante lacinia nec. Morbi facilisis mi vel nibh pulvinar, eu auctor lacus rutrum. Praesent in tristique tortor. Quisque sed pharetra leo, vitae accumsan metus. Ut convallis elementum nibh ut egestas.
+  </body>
+</html>

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'bundler/setup'
+
+begin
+  require 'pry'
+rescue LoadError
+end
+
+# require 'right_http_connection'
+# require 'webmock'
+# require 'webmock/rspec'
+# require 'vcr'
+#
+# VCR.configure do |c|
+#   c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+#   c.hook_into :webmock
+# end
+
+require_relative '../lib/content_caching'
+
+RSpec.configure do |config|
+  config.filter_run focused: true
+  config.run_all_when_everything_filtered = true
+  # config.before { }
+  # config.after  { }
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: content_caching
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joel AZEMAR
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-22 00:00:00.000000000 Z
+dependencies:
+- !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:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: right_http_connection
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: aws
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: Library for help and speed up views render manipulation based on aws
+  and local storage
+email:
+- joel.azemar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- content_caching.gemspec
+- lib/content_caching.rb
+- lib/content_caching/adapters/abstract.rb
+- lib/content_caching/adapters/aws.rb
+- lib/content_caching/adapters/aws_adapter.rb
+- lib/content_caching/adapters/base.rb
+- lib/content_caching/adapters/fs.rb
+- lib/content_caching/adapters/fs_adapter.rb
+- lib/content_caching/adapters/implementation.rb
+- lib/content_caching/configuration.rb
+- lib/content_caching/version.rb
+- spec/content_caching/adapters/fs_adapter_spec.rb
+- spec/content_caching/configuration_spec.rb
+- spec/content_caching_spec.rb
+- spec/fixtures/page.html
+- spec/spec_helper.rb
+homepage: https://github.com/joel/content_caching
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Library for help and speed up views render manipulation
+test_files:
+- spec/content_caching/adapters/fs_adapter_spec.rb
+- spec/content_caching/configuration_spec.rb
+- spec/content_caching_spec.rb
+- spec/fixtures/page.html
+- spec/spec_helper.rb