content_caching 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f76b31f135b71b97dae7f0b560366afd49d65fe
-  data.tar.gz: 47b2f2a7756927158656355120605006ad701f1b
+  metadata.gz: e0b99af4b7bbf5dec7d6c5fa999226cfcb6ad860
+  data.tar.gz: 24cba441648f98ba6f64ec6cfbc8a7ebeb68fb29
 SHA512:
-  metadata.gz: f49f744dad7212723fd9f42451824ef08e19edbf5ee17b8df29784d998709562322cb923f93cc201fea5e16d32a3b8adc2fcd3bb52fae87fcd8aff090eece266
-  data.tar.gz: d9a7187010d2d3d420b18f58ff0001f6c35f8fe68befeead4507ae4b8fbd8c2f7bb4e3c865e202e4510f58b9a00ebebf11c05e083d3a375cd2585c76ff161e4a
+  metadata.gz: 3c06a7fdf04c7fcb5f4cdfec0b437ee9c444db9d6f1585fa350116c543267d88ce65d6cd65bf891e5e515d72872834049a3d0b06eeda6c6461cc42a16277e369
+  data.tar.gz: 5e72d78eef4c344910b62aa019ae3dd7f43704f976a15423cb19fda681c62d9116b0b962b611083ab5355b7c5407acbd04bdd3345129df4308e5d813529f0688

data/.gitignore

@@ -20,3 +20,5 @@ tmp
 *.o
 *.a
 mkmf.log
+
+spec/setting.yml

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+### VERSION 0.1.0
+
+* bug fix
+  *
+
+* refactoring
+  *
+
+* enhancements
+  *
+
+* backwards incompatible changes
+  * signature of wrapper have been change
+
+* deprecations
+  *
+
+* todos
+  *
+
 ### VERSION 0.0.1
 
 * bug fix

data/Gemfile

@@ -5,4 +5,5 @@ gemspec
 
 group :test do
   gem 'pry'
+  gem 'configatron'
 end

data/README.md

@@ -10,19 +10,89 @@
 
 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
+You can configure content_caching for playing with local storage or aws s3
+
+By befault content_caching provide filesystem configuration like that
+
+```
+    { adapter: :fs, options: { directory: 'tmp' }}
+```
+
+is pretty basic, but you can change these configuration
+
+fs sample
+
+```
+    ContentCaching.configure do |config|
+      config.adapter = { adapter: :fs, options: { directory: 'public/htmls' }}
+    end
+```
+
+AWS s3 sample
+
+```
+    ContentCaching.configure do |config|
+      config.adapter = { adapter: :aws,
+              options: { directory: directory, aws_access_key_id: api_key_id,
+                         aws_secret_access_key: api_key_access }}
+    end
+```
+
+for s3 you need provide extra information, bucket name, api key and secret
+
+ContentCaching implement the following interface
+
+```
+    Query
+      .url()
+
+    Command
+      .store()
+      .delete()
+```
+
+When you initialize an Document you need pass an object who respond to .to_path() contract. content_caching provide an Wrapper for help you.
+
+```
+    wrapper = ContentCaching::Wrapper.new('path of your document')
+    content_caching = ContentCaching::Document.new(wrapper)
+```
+
+You can store any content when you pass an Object respond to .read() contract to method .store()
+
+```
+    content_caching.store StringIO.new('foo')
+```
+
+You can ask for full path
+
+```
+    content_caching.url
+```
+
+And you can delete file
+
+```
+    content_caching.delete
+```
 
 ## Contributing
 

data/lib/content_caching/adapters/aws.rb

@@ -15,7 +15,8 @@ module ContentCaching
       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
+          s3_interface.put self.options[:directory], document_path,
+            (content.respond_to?(:read) ? content.read : content)
         end
       end
 

data/lib/content_caching/adapters/aws_adapter.rb

@@ -25,10 +25,6 @@ module ContentCaching
 
       private
 
-      def document_path
-        @wrapper.document_path
-      end
-
       def adapter
         @adapter ||= Aws::new(@options)
       end

data/lib/content_caching/adapters/fs.rb

@@ -2,16 +2,17 @@ module ContentCaching
   module Adapter
     class Fs
 
-      def store document_path, document_name, content
-        Pathname(url(document_path, document_name)).write content.read
+      def store document_path, content
+        content.rewind if content.respond_to?(:rewind)
+        Pathname(url(document_path)).write content.respond_to?(:read) ? content.read : content
       end
 
-      def url document_path, document_name
-        "#{document_path}/#{document_name}"
+      def url document_url
+        document_url
       end
 
-      def delete document_path, document_name
-        Pathname(url(document_path, document_name)).delete
+      def delete document_path
+        Pathname(url(document_path)).delete
       end
 
     end

data/lib/content_caching/adapters/fs_adapter.rb

@@ -12,22 +12,26 @@ module ContentCaching
       end
 
       def url
-        adapter.url document_path, document_name
+        adapter.url document_url
       end
 
       def store content
-        adapter.store document_path, document_name, content
+        adapter.store document_path, content
       end
 
       def delete
-        adapter.delete document_path, document_name
+        adapter.delete document_path
       end
 
       private
 
+      def document_url
+        @options[:host] + '/' + Pathname(@wrapper.to_path).cleanpath.to_path
+      end
+
       def document_path
-        return @wrapper.document_path unless @options[:directory]
-        Pathname([@options[:directory], @wrapper.document_path].join('/')).cleanpath.to_path
+        return @wrapper.to_path unless @options[:directory]
+        Pathname([@options[:directory], @wrapper.to_path].join('/')).cleanpath.to_path
       end
 
       def adapter

data/lib/content_caching/adapters/implementation.rb

@@ -16,13 +16,8 @@ module ContentCaching
 
       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
+        @wrapper.to_path
       end
 
     end

data/lib/content_caching/configuration.rb

@@ -3,7 +3,7 @@ module ContentCaching
     attr_accessor :adapter
 
     def initialize
-      @adapter = { adapter: :fs, options: { directory: 'tmp' }}
+      @adapter = { adapter: :fs, options: { host: 'http://0.0.0.0:3000', directory: 'tmp' }}
     end
   end
 end

data/lib/content_caching/version.rb

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

data/lib/content_caching/wrapper.rb

@@ -0,0 +1,7 @@
+module ContentCaching
+  class Wrapper < Struct.new(:path)
+    def to_path
+      self.path
+    end
+  end
+end

data/lib/content_caching.rb

@@ -1,5 +1,6 @@
 require_relative 'content_caching/version'
 require_relative 'content_caching/configuration'
+require_relative 'content_caching/wrapper'
 require_relative 'content_caching/adapters/base'
 
 begin

data/spec/content_caching/configuration_spec.rb

@@ -5,7 +5,7 @@ module ContentCaching
     let(:configuration) { Configuration.new }
 
     describe '#adapter' do
-      let(:adapter) {{ adapter: :fs, options: { directory: 'tmp' }}}
+      let(:adapter) {{ adapter: :fs, options: { host: 'http://0.0.0.0:3000', directory: 'tmp' }}}
       it 'the default is fs' do
         expect(configuration.adapter).to eq(adapter)
       end

data/spec/content_caching_spec.rb

@@ -1,33 +1,23 @@
 require 'spec_helper'
 
 require 'pathname'
+# require 'configatron'
 
 module ContentCaching
   describe Document do
+    let(:wrapper)         { Wrapper.new(path) }
+    let(:content_caching) { Document.new(wrapper) }
 
     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
+      context 'without document path' do
+        let(:path) { 'page.html' }
+        specify do
+          expect(content_caching.url).to eq('http://0.0.0.0:3000/page.html')
         end
       end
 
       describe '#store' do
-        let(:options) {{ document_name: 'page.html', document_path: 'public/pages' }}
+        let(:path) { 'public/pages/page.html' }
 
         before do
           content_caching.store Pathname('spec/fixtures/page.html')
@@ -47,15 +37,16 @@ module ContentCaching
     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(:path)            { 'test/page.html' }
       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' }
+          options: { directory: directory, aws_access_key_id: api_key_id,
+                     aws_secret_access_key: api_key_access }
         }
       end
+      let(:directory)      { configatron.directory }
+      let(:api_key_id)     { configatron.api_key_id }
+      let(:api_key_access) { configatron.api_key_access }
 
       before do
         ContentCaching.configure do |config|
@@ -65,7 +56,7 @@ module ContentCaching
 
       describe '#url' do
 
-        let(:url) { 'https://bucket-name.s3.amazonaws.com:443/test/page.html' }
+        let(:url) { "https://#{directory}.s3.amazonaws.com:443/test/page.html" }
 
         specify do
           expect(content_caching.url).to match(url)
@@ -89,7 +80,7 @@ module ContentCaching
 
         specify do
           expect(
-            Aws::S3::Key.new(bucket, options[:document_path])
+            Aws::S3::Key.new(bucket, path)
           ).to be_exists
         end
 
@@ -97,7 +88,7 @@ module ContentCaching
           before do content_caching.delete end
           specify do
             expect(
-              Aws::S3::Key.new(bucket, options[:document_path])
+              Aws::S3::Key.new(bucket, path)
             ).to_not be_exists
           end
         end

data/spec/spec_helper.rb

@@ -18,6 +18,17 @@ end
 
 require_relative '../lib/content_caching'
 
+require 'configatron'
+
+if File.exist?('spec/setting.yml')
+  require 'yaml'
+  configatron.configure_from_hash(YAML.load_file('spec/setting.yml'))
+else
+  configatron.directory      = 'bucket-name'
+  configatron.api_key_id     = 'api_key_id'
+  configatron.api_key_access = 'api_key_access'
+end
+
 RSpec.configure do |config|
   config.filter_run focused: true
   config.run_all_when_everything_filtered = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: content_caching
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Joel AZEMAR
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,6 +138,7 @@ files:
 - lib/content_caching/adapters/implementation.rb
 - lib/content_caching/configuration.rb
 - lib/content_caching/version.rb
+- lib/content_caching/wrapper.rb
 - spec/content_caching/adapters/fs_adapter_spec.rb
 - spec/content_caching/configuration_spec.rb
 - spec/content_caching_spec.rb