disk_cache 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,7 @@
 # DiskCache
 
 [![Build Status](https://secure.travis-ci.org/propertybase/disk_cache.png)](https://travis-ci.org/propertybase/disk_cache)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/propertybase/disk_cache)
 
 What does it do? You give DiskCache the URL of a file and DiskCache makes sure
 that it has the file stored on disk. You can retrieve your files with the same
@@ -61,6 +62,8 @@ DiskCache.del('http://example.com/1234abc.jpg')
 
 - option to set the depth of subfolders
 
+- option to set the Hashing algorithm (e.g. MD5, SHA1, SHA2, etc)
+
 
 ## Contributing
 
@@ -69,3 +72,7 @@ DiskCache.del('http://example.com/1234abc.jpg')
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## License
+
+License is MIT, see [LICENSE.txt](https://github.com/propertybase/disk_cache/blob/master/LICENSE.txt) for details.

data/disk_cache.gemspec

@@ -10,13 +10,14 @@ Gem::Specification.new do |gem|
   gem.email         = ["mxhaack@gmail.com"]
   gem.description   = %q{A simple way to cache your files.}
   gem.summary       = %q{Cache files that you have have to use several times.}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/propertybase/disk_cache"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "rspec"
+  gem.add_development_dependency 'rake', '~> 10.0.0'
+  gem.add_development_dependency 'rspec', '~> 2.12.0'
+  gem.add_development_dependency 'webmock', '~> 1.9.0'
 end

data/lib/disk_cache/version.rb

@@ -1,3 +1,3 @@
 module DiskCache
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/disk_cache.rb

@@ -1,6 +1,6 @@
 require 'disk_cache/version'
 require 'open-uri'
-require 'digest/sha2'
+require 'digest/sha1'
 
 module DiskCache
   extend self
@@ -16,6 +16,7 @@ module DiskCache
   #
   # Returns: nil
   def put(url)
+    url = escape(url)
     file = filepath(url)
     return nil if File.exist?(file)
 
@@ -38,6 +39,7 @@ module DiskCache
   #
   # Returns the File or nil
   def get(url)
+    url = escape(url)
     File.open(filepath(url), "rb")
   rescue Errno::ENOENT
     nil
@@ -54,6 +56,7 @@ module DiskCache
   #
   # Returns a File
   def pget(url)
+    url = escape(url)
     put(url)
     get(url)
   end
@@ -69,9 +72,30 @@ module DiskCache
   #
   # Returns nil
   def del(url)
+    url = escape(url)
     FileUtils.rm filepath(url), force: true
   end
 
+  # Public: calculate the path/filename of a file's URL
+  #
+  # url - the URL of the file
+  #
+  # Example:
+  #
+  #   DiskCache.filepath('http://example.com/test123.jpg')
+  #   # => "cache/9a/e2/74d94c34542ddd1b64667c1d4e392211ff67"
+  #
+  # Returns a Sting with the full path and filename
+  def filepath(url)
+    hsh = hash url
+    path_h(hsh) + filename_h(hsh)
+  end
+
+  # Public: this removes all contents of the cache.
+  def clear!
+    FileUtils.rm_r cache_dir if File.exists? cache_dir
+  end
+
   private
 
   # Internal: Hashes a given piece of data with SHA1
@@ -85,8 +109,7 @@ module DiskCache
   #
   # Returns String with hexdigest
   def hash(datum)
-    @hasher ||= Digest::SHA1.new
-    @hasher.hexdigest(datum)
+    Digest::SHA1.new.hexdigest(datum)
   end
 
   # Internal: Return the directory of the cache as a String
@@ -132,18 +155,17 @@ module DiskCache
     hsh[4..-1]
   end
 
-  # Internal: calculate the path/filename of a file's URL
+  # Internal: escape a given url
   #
-  # url - the URL of the file
+  # url - the URL to escape
   #
   # Example:
   #
-  #   filepath!('http://example.com/test123.jpg')
-  #   # => "cache/9a/e2/74d94c34542ddd1b64667c1d4e392211ff67"
+  #   url_escape('http://example.com/hello world')
+  #   # => "http://example.com/hello%20world"
   #
-  # Returns a Sting with the full path and filename
-  def filepath(url)
-    hsh = hash url
-    path_h(hsh) + filename_h(hsh)
+  # Returns a String with the escaped url
+  def escape(url)
+    URI.escape(url)
   end
 end

data/spec/disk_cache/disk_cache_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe DiskCache do
+  let(:path) { 'spec/asset/Trollface.svg' }
+
+  before(:each) { DiskCache.clear! }
+
+  context "storing and accessing" do
+    it ".put" do
+      DiskCache.put(path)
+      DiskCache.get(path).should_not be_nil
+    end
+
+    it ".get" do
+      DiskCache.put(path)
+      file_from_cache = DiskCache.get(path)
+      FileUtils.compare_file(path, file_from_cache).should be_true
+    end
+
+    it ".pget" do
+      DiskCache.del(path)
+      file_from_cache = DiskCache.pget(path)
+      FileUtils.compare_file(path, file_from_cache).should be_true
+    end
+
+    it ".filepath" do
+      DiskCache.put(path)
+      DiskCache.filepath(path).should include(
+        'cache/fb/2b/228b717ea0a569bc7d12187ff55e5e3a0180')
+    end
+  end
+
+  context "removing data" do
+    before(:each) { DiskCache.put(path) }
+
+    it ".delete" do
+      DiskCache.del(path)
+      DiskCache.get(path).should be_nil
+    end
+
+    it ".clear" do
+      DiskCache.clear!
+      DiskCache.get(path).should be_nil
+    end
+  end
+
+  context "sanity" do
+    let(:web) { 'http://example.com/Troll face.svg' }
+    let(:cto) { File.read(path) }
+
+    before(:each) do
+      stub_request(:get, "http://example.com/Troll face.svg").
+        to_return(body: cto)
+    end
+
+    it "should handle urls with spaces" do
+      DiskCache.put(web)
+      file_from_cache = DiskCache.get(web)
+      FileUtils.compare_file(path, file_from_cache).should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1 +1,2 @@
 require 'disk_cache'
+require 'webmock/rspec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: disk_cache
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,40 +9,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-09 00:00:00.000000000 Z
+date: 2012-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.0
 description: A simple way to cache your files.
 email:
 - mxhaack@gmail.com
@@ -60,9 +76,9 @@ files:
 - lib/disk_cache.rb
 - lib/disk_cache/version.rb
 - spec/asset/Trollface.svg
-- spec/file_cache/file_cache_spec.rb
+- spec/disk_cache/disk_cache_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/propertybase/disk_cache
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -76,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 804760917571637690
+      hash: -1244554166794176728
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 804760917571637690
+      hash: -1244554166794176728
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -94,5 +110,5 @@ specification_version: 3
 summary: Cache files that you have have to use several times.
 test_files:
 - spec/asset/Trollface.svg
-- spec/file_cache/file_cache_spec.rb
+- spec/disk_cache/disk_cache_spec.rb
 - spec/spec_helper.rb

data/spec/file_cache/file_cache_spec.rb

@@ -1,34 +0,0 @@
-require 'spec_helper'
-
-describe DiskCache do
-  let(:path) { 'spec/asset/Trollface.svg' }
-  let(:file) { File.open(path, 'r') }
-
-  context "storing and accessing" do
-    it ".put" do
-      DiskCache.put(path)
-      DiskCache.get(path).should_not be_nil
-    end
-
-    it ".get" do
-      DiskCache.put(path)
-      file_from_cache = DiskCache.get(path)
-      FileUtils.compare_file(file, file_from_cache).should be_true
-    end
-
-    it ".pget" do
-      DiskCache.del(path)
-      file_from_cache = DiskCache.pget(path)
-      FileUtils.compare_file(file, file_from_cache).should be_true
-    end
-  end
-
-  context "removing data" do
-    before(:each) { DiskCache.put(path) }
-
-    it ".delete" do
-      DiskCache.del(path)
-      DiskCache.get(path).should be_nil
-    end
-  end
-end