s3cache 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a51920e30cb54e8c38d56b3cc78c3133a42174b
-  data.tar.gz: c593b0eeb21e7af37f19a3d0a4e09de1d632da9c
+  metadata.gz: 2864f8ce4c8dcfeff913d831aa3f9b1b9e3adbb8
+  data.tar.gz: 448bb973a9b930f59cc79e67f9d935e49fe1e6a6
 SHA512:
-  metadata.gz: fa94435ad8f2fce4aba9e1bcf474339fd4360c4d4214c0ee9a7bafa8bb4534d429d7ccb1c851365b47b076937f5deb6ee3361c0f9d861519f1df9e95390da1e4
-  data.tar.gz: 9b3f3764f0476666a7278498c65faeda42129bf955c7cb288859ba6ad2926aaaf8065186bca44f96bcea593042d3631a75247d00206f6c63cf82fbf4cd118634
+  metadata.gz: 29dff18cf4bdf462a3b2e7763b37d675df6314b5b90b0b9fc7499942c90d0e409ce1a596c0dd83c07231791e49ecfa88f91204f0c349444565b617cf19ec280d
+  data.tar.gz: 7135a8ec19821db2a4544476f32e6063faf3ca62e9a5bc70edd4405865af81baf1b546539020606e828253b2301d20e9a40f1366907241cd2935b701d534af4b

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    s3cache (0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-sdk (2.2.24)
+      aws-sdk-resources (= 2.2.24)
+    aws-sdk-core (2.2.24)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.2.24)
+      aws-sdk-core (= 2.2.24)
+    diff-lcs (1.2.5)
+    jmespath (1.1.3)
+    rake (10.4.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-sdk (~> 2)
+  rake (~> 10.x)
+  rspec (~> 3.x)
+  s3cache!
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,27 @@
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    (1) Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer. 
+
+    (2) Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.  
+    
+    (3)The name of the author may not be used to
+    endorse or promote products derived from this software without
+    specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,22 @@
+#S3Cache
+A simple caching library that serializes objects to the filesystem and is compatible with the Rails.cache API
+
+#Installation
+    gem install s3cache
+
+Or add the following to your Gemfile (do this for now):
+    
+    gem 's3cache', :git => 'git://github.com/eddietejeda/s3cache.git'
+
+#Usage examples
+
+    require 's3cache'
+    cache = S3Cache.new({:bucket_name => "aws-bucket-name"})
+
+    cache.write("cache_name", "cache_contents")
+
+    contents = filecache.read("cache_name")
+
+    filecache.fetch("cache_name") do
+        "cache_contents"
+    end

data/lib/s3cache.rb

@@ -0,0 +1,119 @@
+require 'digest'
+require 'fileutils'
+require 'pathname'
+require 'yaml'
+
+class S3Cache
+
+  VERSION = "0.9.1"
+
+  def initialize(**params)
+
+    if not params.to_h[:bucket_name]
+      puts "requires {:bucket_name => String, (optional) :expires => Integer, (optional) :debug => Boolean }"
+    end
+
+    @bucket_name = params.to_h[:bucket_name]
+    @expires = params.to_h[:expires] ? params.to_h[:expires] : 32.days
+    @debug = params.to_h[:debug] ? params.to_h[:debug] : false
+    
+    if ENV['AWS_ACCESS_KEY_ID'].nil? || ENV['AWS_SECRET_ACCESS_KEY'].nil?
+      puts 'Enviroment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY must be defined. Learn more http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html#config-settings-and-precedence'  
+    else
+      @s3 = Aws::S3::Client.new
+      if not bucket_exist?
+        puts "creating bucket #{@bucket_name}" if @debug
+        bucket_create
+      end
+    end
+  end
+
+  def read(key, **params)
+    key_name = cache_key( key )
+    puts "read #{key_name}" if @debug
+    if exist?(key_name)
+      Marshal.load(@s3.get_object({ bucket: @bucket_name, key: key_name }).body.read)
+    else
+      return false
+    end    
+  end
+
+  def write(key, contents, **params) 
+    key_name = cache_key( key )
+    puts "write #{key_name}" if @debug
+    @s3.put_object({ 
+      bucket: @bucket_name, 
+      key: key_name, 
+      expires: Time.now + @expires.days,
+      body: Marshal.dump(contents),
+    })
+  end
+
+  def fetch(key, **params)
+    key_name = cache_key( key )
+
+    if(exist?(key_name) )
+      puts "fetch->read #{key_name}" if @debug
+      read (key_name)
+    else
+      puts "fetch->write #{key_name}" if @debug
+      value = yield
+      write(key_name, value)  
+      read (key_name)    
+    end    
+  end
+
+  def exist?(key)   
+    key_name = cache_key( key )
+    begin
+      response =  @s3.get_object({:bucket => @bucket_name, :key => key_name})
+    rescue 
+      response = nil
+    end
+    puts "exists? #{response} #{key_name}" if @debug
+    return !response.nil?
+  end
+  
+  def clear
+    cache_keys.each do |key|
+      puts "deleting key #{key}" if @debug
+      @s3.delete_object({:bucket => @bucket_name, :key => key})
+    end
+  end  
+
+  # --------- private --------- 
+  private
+
+    def cache_keys
+      @s3.list_objects({:bucket => @bucket_name}).first[:contents].collect{|e|e.key}
+    end
+
+    def cache_valid(key)
+      exist?(key)
+    end
+
+    def cache_key(key)      
+      if(key.is_a?(String) && key.downcase.match(/^[a-f0-9]{64}$/) )
+        key
+      else
+        Digest::SHA256.hexdigest(key.to_s).to_s        
+      end      
+    end
+    
+    def bucket_create
+      @s3.create_bucket({
+        acl: "private", # accepts private, public-read, public-read-write, authenticated-read
+        bucket: @bucket_name, # required
+      })      
+    end
+    
+    def bucket_exist?
+      begin
+        response = @s3.head_bucket({ bucket: @bucket_name })
+      rescue 
+        response = nil
+      end
+      return !response.nil?
+    end   
+end
+

data/s3cache.gemspec

@@ -0,0 +1,25 @@
+#encoding: utf-8
+require File.expand_path('../lib/s3cache.rb', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 's3cache'
+  gem.version     = S3Cache::VERSION
+  gem.description = %q(A simple caching library that serializes objects to the filesystem and is compatible with the Rails.cache API)
+  gem.summary     = gem.description
+  
+  gem.files       = `git ls-files`.split("\n")
+  gem.require_paths = ['lib']  
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  # gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.homepage    = "https://github.com/eddietejeda/s3cache"
+
+  gem.license     = 'BSD-3-Clause'
+  gem.authors     = ['Eddie A Tejeda']
+  gem.email       = ['eddie@codeforamerica.org']
+
+  gem.add_development_dependency 'rake','~> 10.x'
+  gem.add_development_dependency 'rspec','~> 3.x'
+  gem.add_development_dependency 'aws-sdk','~> 2'
+end
+

data/spec/s3cache_spec.rb

@@ -0,0 +1,46 @@
+# I can't figure out how to test s3 modules without requiring a bunch of new gems.
+# Should look into fake-s3 gem
+require 'aws-sdk'
+
+# require 'spec_helper'
+require_relative '../lib/s3cache'
+
+describe S3Cache do
+
+  before do
+    # @s3 = Aws::S3::Client.new(stub_responses: true)
+    # @s3cache = S3Cache.new({:bucket_name => 'test-s3-cache'})
+    # @cache_name = ['spec', 'test']
+    # @cached_contents = 'Hello World'
+  end
+
+  describe "test methods" do
+    
+    it "S3Cache#write should save serialized object to tmp" do
+      # @s3cache.write(@cache_name, @cached_contents)
+      # expect(@s3cache.exist?(@cache_name)).to be_truthy
+    end
+
+    it "S3Cache#read should be able to read serialized objects" do
+      # @s3cache.read(@cache_name).eql?( @cached_contents)
+    end
+    
+    it "S3Cache#fetch should be able to read serialized objects" do
+      # cache_name_fetch = "#{@cache_name}-fetch"
+      # cache_contents_fetch = "Hello World Fetch"
+      #
+      # response = @s3cache.fetch( cache_name_fetch) do
+      #   cache_contents_fetch
+      # end
+      #
+      # cache_name_fetch.eql?( response)
+      # @s3cache.read(cache_name_fetch).eql?( response)
+    end
+
+    it "S3Cache#clear should clear cache" do
+      # @s3cache.clear
+      # expect(@s3cache.exist?(@cache_name)).to be_falsey
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3cache
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Eddie A Tejeda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -59,7 +59,15 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- lib/s3cache.rb
+- s3cache.gemspec
+- spec/s3cache_spec.rb
 homepage: https://github.com/eddietejeda/s3cache
 licenses:
 - BSD-3-Clause
@@ -86,3 +94,4 @@ specification_version: 4
 summary: A simple caching library that serializes objects to the filesystem and is
   compatible with the Rails.cache API
 test_files: []
+has_rdoc: