file_to_download 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 909b5b4243071fd43026e9bdc433783a99803245
+  data.tar.gz: adde27bec047e507f5e090d3909e7d821de1bb1f
+SHA512:
+  metadata.gz: 5b2e5d91d33eca1628549287b0c4bd21870b2f0508d62a0e42061760015fa6e3f5c9a0abdc19bae7ccd18c7f53ef8fbc9606b858f10bb00eee5ebfdd8073b3d0
+  data.tar.gz: de3e4ece4076556d1984de2ebb1c3e91d6e3745834d47620747d1cea7bf50b9f6e9be6fd9836341f017d5a34acae78d86b802e63d882e19a5b17498817ececb0

data/.gitignore

@@ -0,0 +1,25 @@
+*.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
+
+spec/write/brkb.html
+.DS_Store

data/.rvmrc

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 2.0.0" > .rvmrc
+environment_id="ruby-2.0.0-p451@file_to_download"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.25.20 (master)" # 1.10.1 seems like a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | __rvm_awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 2 )) # display only when forced
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then printf "%b" "Using: $(tput setaf 2 2>/dev/null)$GEM_HOME$(tput sgr0 2>/dev/null)
+" # show the user the ruby and gemset they are using in green
+    else printf "%b" "Using: $GEM_HOME
+" # don't use colors in non-interactive shells
+    fi
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS="" \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS="" \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+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,55 @@
+# FileToDownload
+
+## Purpose
+This Ruby Gem is used for the process of downloading a file and saving it on the local drive.
+
+This gem can obtain the age and size of a file.
+
+You can conditionally download a remote file and save a local copy.  
+
+## Commands for development
+1. git clone https://github.com/jhsu802701/file_to_download.git
+2. cd file_to_download
+3. gem install rspec
+4. rake # runs tests
+5. rake install # installs this gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'file_to_download'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install file_to_download
+
+## Usage
+
+ftd = Filetodownload.new("file_path") # Initialize path name of file
+
+ftd.size # Gets size of file in bytes
+
+ftd.age # Gets age of file in hours
+
+# Download web page and save it to the above file path
+
+# Give up after 4 failed attempts
+
+# Keep the existing file if it's no more than 1.0 hours old
+
+# Pause for up to 0.5 seconds after the download
+
+ftd.get("http://finance.yahoo.com/q/pr?s=BRK-B+Profile", 4, 1.0, 0.5)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/file_to_download/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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/file_to_download.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'file_to_download/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "file_to_download"
+  spec.version       = FileToDownload::VERSION
+  spec.authors       = ["Jason Hsu"]
+  spec.email         = ["rubyist@jasonhsu.com"]
+  spec.summary       = %q{Gem for managing the process of downloading files}
+  spec.description   = %q{Gets the size and age of a file and whether to replace an existing file}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.rubyforge_project = "periodic_table"
+
+  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"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'open-uri'
+
+end

data/lib/file_to_download.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+require "file_to_download/version"
+
+class Filetodownload
+
+  attr :path
+
+  def initialize (path)
+    @path = path
+  end
+
+  # Get size of file in bytes (0 if it does not exist)
+  def size # in bytes
+    begin
+      output = File.stat(path).size
+      return output
+    rescue
+      return 0
+    end
+  end
+
+  # Get the age of a given file (in hours)
+  # If the file is not found, return 4 billion (over 100,000 years).
+  def age # In hours
+    begin
+      age_seconds = Time.now - File.mtime(path)
+      age_hours = age_seconds/3600
+      return age_hours
+    rescue
+      return 4E9
+    end
+  end
+
+  # This condition determines whether to keep downloading
+  # n_fail: current number of failed download attempts
+  # n_fail_max: maximum number of failed download attempts to make before giving up
+  # age_max_hrs: skip the downloaded unless the age of the file in hours exceeds this
+  def conditionDownload (n_fail, n_fail_max, age_max_hrs)
+    return false if n_fail >= n_fail_max
+    return true if size == 0
+    return true if age > age_max_hrs
+    return false
+  end
+
+  # PURPOSE: downloads file from url, saves locally as filename
+  # age_max: skip download unless existing file named filename has
+  # reached the maximum age (hours)
+  # t_delay: maximum delay in seconds following download, needed to 
+  # minimize the impact on the upstream server
+  
+  # url: web address of the page to be downloaded
+  # delay_max_sec: time delay before making the download (in seconds)
+  def get (url, n_fail_max, age_max_hrs, delay_max_sec)
+    require "open-uri"
+    # Number of failures to download file
+    n_fail = 0
+    # Download new file ONLY if the file size is 0 or is too old
+    # and ONLY if there have been fewer than 4 failures
+    while conditionDownload(n_fail, n_fail_max, age_max_hrs) == true
+      begin
+        open(path, 'w') do |fo|
+          fo.write open(url).read
+        end
+        # Delay of .5*delay_max_sec to 1*delay_max_sex
+        t = rand (delay_max_sec/2 .. delay_max_sec)
+        sleep (t) 
+      rescue
+        n_fail += 1
+        puts ("Failure #{n_fail}/#{n_fail_max} #{url}")
+        puts ("Download failed, giving up") if n_fail > n_fail_max
+      end
+    end
+  end
+  
+  def delete
+    system ("rm #{path}")
+  end
+
+end

data/lib/file_to_download/version.rb

@@ -0,0 +1,3 @@
+module FileToDownload
+  VERSION = "0.0.0"
+end

data/spec/features/file_spec.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+# GENERAL DIRECTORIES
+ENV["DIR_MAIN"] = File.expand_path("../../../", __FILE__)
+ENV["DIR_MAIN_SCRIPTS"] = "#{ENV["DIR_MAIN"]}/lib"
+
+# TEST MODE
+ENV["DIR_SPEC"] = "#{ENV["DIR_MAIN"]}/spec"
+ENV["DIR_SPEC_WRITE"] = "#{ENV["DIR_SPEC"]}/write"
+ENV["DIR_SPEC_READ"] = "#{ENV["DIR_SPEC"]}/read"
+
+puts "Main directory: #{ENV["DIR_MAIN"]}"
+
+puts "Test directory: #{ENV["DIR_SPEC"]}"
+puts "Test write directory: #{ENV["DIR_SPEC_WRITE"]}"
+puts "Test read directory: #{ENV["DIR_SPEC_READ"]}"
+
+require "#{ENV['DIR_MAIN_SCRIPTS']}/file_to_download"
+
+describe Filetodownload do
+  file_to_read = Filetodownload.new ("#{ENV["DIR_SPEC_READ"]}/test.txt")
+  file_to_read.size.should == 50
+
+  file_to_read = Filetodownload.new ("#{ENV["DIR_SPEC_READ"]}/doesnotexist.txt")
+  file_to_read.size.should == 0
+  file_to_read.age.should == 4E9
+
+  
+  file_to_write = Filetodownload.new ("#{ENV["DIR_SPEC_WRITE"]}/brkb.html")
+  file_to_write.delete
+  url_brkb = "http://finance.yahoo.com/q/pr?s=BRK-B+Profile"
+  file_to_write.get(url_brkb, 4, 1.0, 0.5)
+  file_to_write.age.should > 0.2/3600.0
+  file_to_write.age.should < 10.0/3600.0
+  file_to_write.size.should > 1E4
+
+end

data/spec/read/test.txt

@@ -0,0 +1 @@
+TESTING, TESTING, 1 billion, 2 billion, 3 billion!

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'file_to_download'

data/spec/write/README.txt

@@ -0,0 +1,7 @@
+{\rtf1\ansi\ansicpg1252\cocoartf1265\cocoasubrtf190
+{\fonttbl\f0\fswiss\fcharset0 Helvetica;}
+{\colortbl;\red255\green255\blue255;}
+\margl1440\margr1440\vieww10800\viewh8400\viewkind0
+\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural
+
+\f0\fs24 \cf0 This directory is used for files downloaded during the test script.}

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: file_to_download
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Jason Hsu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-24 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: '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: open-uri
+  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: Gets the size and age of a file and whether to replace an existing file
+email:
+- rubyist@jasonhsu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- file_to_download.gemspec
+- lib/file_to_download.rb
+- lib/file_to_download/.DS_Store
+- lib/file_to_download/version.rb
+- spec/features/.DS_Store
+- spec/features/file_spec.rb
+- spec/read/test.txt
+- spec/spec_helper.rb
+- spec/write/README.txt
+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: periodic_table
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Gem for managing the process of downloading files
+test_files:
+- spec/features/.DS_Store
+- spec/features/file_spec.rb
+- spec/read/test.txt
+- spec/spec_helper.rb
+- spec/write/README.txt