rhcf-utils 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d1a0ea6f99f15f7e81b21291239462daf312138
+  data.tar.gz: 965d1184ecf122ebd6f1202bdb10de4aa4c08ecf
+SHA512:
+  metadata.gz: 18cb8e28818558e63942cdd47faa4faec1b5d45641535235ce63adad59a31148ad497ad349a1aa92930956e65fb43a5d9738c8f61e5f9aab84ca50b46db39d60
+  data.tar.gz: d32f42f65b794238cbd6234e72a66896c80b521902cd5e21d81008975af5e2a885c09a31fac151c4c8146fe221ac655fed3ed5839cf6940f8ef467d0133d28bd

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rhcf-utils.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Romeu Fonseca
+
+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,35 @@
+# Rhcf::Utils
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rhcf-utils'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rhcf-utils (not yet)
+
+## Usage
+### Rhcf::Utils::DownloadCache
+
+```ruby
+require 'rhcf/utils/download_cache'
+cache =  Rhcf::Utils::DownloadCache.new('a_cache_id', ttl=30)
+cache.get("http://example.com/a_image.png") # -> "/tmp/.../a_image.png"
+```
+If you try to download in less then 30 seconds, you will hit the cache
+
+## Contributing
+
+1. Fork it ( http://github.com/romeuhcf/rhcf-utils/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rhcf/utils.rb

@@ -0,0 +1,7 @@
+require "rhcf/utils/version"
+
+module Rhcf
+  module Utils
+    # Your code goes here...
+  end
+end

data/lib/rhcf/utils/download_cache.rb

@@ -0,0 +1,66 @@
+require 'uri'
+require 'open-uri'
+require 'fileutils'
+require 'digest/md5'
+
+module Rhcf
+  module Utils
+    class DownloadCache
+      include FileUtils
+      def initialize(cache_id= 'default', ttl = nil, root_path = nil)
+        @cache_id = cache_id
+        @ttl = ttl
+        @root_path ||= "/tmp/#{self.class.name}"
+      end
+  
+  
+      def get(url)
+        outfile = filename_for(url)
+        return outfile if self.class.hit_fname?(outfile, @ttl) # here goes the cache
+        download!(url, outfile)
+      rescue 
+        File.unkink(outfile) if File.exist?(outfile)
+        raise
+      end
+ 
+
+      def download!(url, outfile)
+        mkdir_p(File.dirname(outfile))
+        File.open(outfile, 'w') do |fd|
+          open(url, "r") do |down|
+            fd.write(down.read)
+          end
+        end
+        outfile
+      end 
+
+      def hit?(url)
+        outfile = filename_for(url)
+        self.class.hit_fname?(outfile, @ttl) # here goes the cache
+      end
+  
+      def self.hit_fname?(fname, ttl)
+        
+        if File.exist?(fname) 
+          if ttl
+            File::Stat.new(fname).ctime > Time.now - ttl
+          else 
+            true
+          end
+        else
+          false
+        end
+      end
+  
+      def filename_for(url)
+        hash =  Digest::MD5.hexdigest(url)
+        uri = URI(url)
+        basename = File.basename(uri.path)
+        File.join(@root_path, @cache_id, hash, basename) 
+      end
+
+    end
+  end
+end
+
+

data/lib/rhcf/utils/version.rb

@@ -0,0 +1,5 @@
+module Rhcf
+  module Utils
+    VERSION = "0.0.1"
+  end
+end

data/rhcf-utils.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rhcf/utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rhcf-utils"
+  spec.version       = Rhcf::Utils::VERSION
+  spec.authors       = ["Romeu Fonseca"]
+  spec.email         = ["romeu.hcf@gmail.com"]
+  spec.summary       = %q{Personal Ruby Utility Tools.}
+  spec.description   = %q{Personal set of ruby recurrent utility tools.}
+  spec.homepage      = ""
+  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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "pry-debugger"
+end

data/spec/lib/rhcf/utils/download_cache_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+require 'rhcf/utils/download_cache'
+require 'fileutils'
+require 'timecop'
+
+describe Rhcf::Utils::DownloadCache do
+  let(:img_url){"http://www.sunnyvision.com/images/cloud_cdn_icon.jpg"}
+  let(:cache_of_30s){Rhcf::Utils::DownloadCache.new('cache_of_30s', 30)}
+  let(:foo_cache_of_30s){Rhcf::Utils::DownloadCache.new('cache_of_30s', 30, '/tmp/foo')}
+  it "should be a class" do
+    Rhcf::Utils::DownloadCache.should be_instance_of(Class)
+  end
+
+
+  describe "#hit_fname?" do
+    it "should return true if file exists and ttl is null" do
+      Rhcf::Utils::DownloadCache.hit_fname?("/etc/passwd", nil).should be_true
+    end 
+    it "should return true if file exists and newer then ttl" do
+      Rhcf::Utils::DownloadCache.hit_fname?("/etc/passwd", 20 * 365 * 24 * 3600 ).should be_true
+    end 
+    it "should return false if file exists and older then ttl" do
+      Rhcf::Utils::DownloadCache.hit_fname?("/etc/passwd",30 ).should be_false
+    end 
+    it "should return false if doesn't exist" do
+      Rhcf::Utils::DownloadCache.hit_fname?("/dfasd/asd/as/das/d/sada", nil).should be_false
+    end 
+  end
+
+
+  describe "#hit?" do
+    before(:each) do
+      FileUtils.rm_rf "/tmp/Rhcf::Utils::DownloadCache/cache_of_30s/aea455b4b37a2d4240a6b054ca0b0d5f8"
+      FileUtils.mkdir_p "/tmp/Rhcf::Utils::DownloadCache/cache_of_30s/aea455b4b37a2d4240a6b054a0b0d5f8"
+      FileUtils.touch "/tmp/Rhcf::Utils::DownloadCache/cache_of_30s/aea455b4b37a2d4240a6b054a0b0d5f8/cloud_cdn_icon.jpg"
+    end
+    it "should return true if file downloaded and ttl is null" do
+      cache_of_30s.filename_for(img_url).should == '/tmp/Rhcf::Utils::DownloadCache/cache_of_30s/aea455b4b37a2d4240a6b054a0b0d5f8/cloud_cdn_icon.jpg'
+      cache_of_30s.hit?(img_url).should be_true
+    end 
+    it "should return true if file downloaded and newer then ttl" do
+      cache_of_30s.hit?(img_url).should be_true
+    end 
+    it "should return false if file downloaded and older then ttl" do
+      Timecop.travel(Time.now + 3600) do
+        cache_of_30s.hit?(img_url).should be_false
+      end
+    end 
+    it "should return false if doesn't exist" do
+      FileUtils.rm "/tmp/Rhcf::Utils::DownloadCache/cache_of_30s/aea455b4b37a2d4240a6b054a0b0d5f8/cloud_cdn_icon.jpg"
+      cache_of_30s.hit?(img_url).should be_false
+    end 
+
+    
+  end
+
+  describe "#filename_for" do
+    it "should return a path with cache id , file name hash and file hash component" do
+      subject.filename_for(img_url).should == '/tmp/Rhcf::Utils::DownloadCache/default/aea455b4b37a2d4240a6b054a0b0d5f8/cloud_cdn_icon.jpg'
+    end
+  end
+
+  describe "#download!" do
+    it "should return the given file path" do
+      expect do  
+        out = subject.download!(img_url, "/tmp/b/c/d/a.jpg")  
+        out.should == "/tmp/b/c/d/a.jpg"
+      end.to_not raise_error
+    end
+
+    it "should create necessary directories and download to the given path" do
+      File.unlink("/tmp/b/c/d/a.jpg")
+      File.exist?("/tmp/b/c/d/a.jpg").should be_false
+      expect{ subject.download!(img_url, "/tmp/b/c/d/a.jpg") }.to_not raise_error
+      File.exist?("/tmp/b/c/d/a.jpg").should be_true
+    end
+  end
+
+  describe "#get" do
+    let(:expected_path){ '/tmp/Rhcf::Utils::DownloadCache/default/aea455b4b37a2d4240a6b054a0b0d5f8/cloud_cdn_icon.jpg' }
+    let(:expected_30s_path){ '/tmp/Rhcf::Utils::DownloadCache/cache_of_30s/aea455b4b37a2d4240a6b054a0b0d5f8/cloud_cdn_icon.jpg' }
+    before(:each) do
+      File.unlink(expected_path) rescue nil
+    end
+
+    it "should download when not exist"do
+      subject.get(img_url).should == expected_path
+      File.exist?(expected_path).should be_true
+    end
+    
+
+    it "should download on different directory per cache_id" do
+      cache_of_30s.get(img_url).should_not == expected_path
+      File.exist?(expected_path).should be_false
+    end
+    
+
+    it "should download on given root path" do
+      foo_cache_of_30s.get(img_url).should == expected_30s_path
+    end
+    
+
+    it "should redownload files older then ttl" do
+      File.open(expected_30s_path, "w") {|fd| fd.write("oldycontent")}
+      File.exist?(expected_30s_path).should be_true
+      Timecop.travel(3600) do
+        cache_of_30s.get(img_url).should == expected_30s_path
+      end
+      IO.read(expected_30s_path).should_not == "oldycontent"
+    end
+    
+
+    it "should not redownload files newer then ttl" do
+      File.open(expected_30s_path, "w") {|fd| fd.write("oldycontent")}
+      File.exist?(expected_30s_path).should be_true
+      Timecop.travel(Time.now + 3) do
+        cache_of_30s.get(img_url).should == expected_30s_path
+      end
+      IO.read(expected_30s_path).should == "oldycontent"
+    end
+    
+
+    it "should return absolute path to downloaded or cache file" do
+      cache_of_30s.get(img_url).should == expected_30s_path
+    end
+
+    it "should raise when download problem" do
+      expect{ cache_of_30s.get("hftp://3423c434v234xd")}.to raise_error
+    end
+  
+    describe "when ttl is null" do
+      it "should cache forever if ttl is null" do
+      end 
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'simplecov'
+SimpleCov.start
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: rhcf-utils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Romeu Fonseca
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Personal set of ruby recurrent utility tools.
+email:
+- romeu.hcf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rhcf/utils.rb
+- lib/rhcf/utils/download_cache.rb
+- lib/rhcf/utils/version.rb
+- rhcf-utils.gemspec
+- spec/lib/rhcf/utils/.download_cache_spec.rb.swp
+- spec/lib/rhcf/utils/download_cache_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Personal Ruby Utility Tools.
+test_files:
+- spec/lib/rhcf/utils/.download_cache_spec.rb.swp
+- spec/lib/rhcf/utils/download_cache_spec.rb
+- spec/spec_helper.rb