pinch 0.0.6 → 0.0.7

data/lib/pinch.rb

@@ -2,30 +2,66 @@
 require 'net/http'
 require 'zlib'
 
+# @author Peter Hellberg
+# @author Edward Patel
 class Pinch
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 
   attr_reader :uri
-  attr_reader :file_name
 
+  ##
+  # Retrieve a file from inside a zip file, over the network!
+  #
+  # @param    [String] url        Full URL to the ZIP file
+  # @param    [String] file_name  Name of the file inside the ZIP archive
+  # @return   [String]            File data, ready to be displayed/saved
+  # @example
+  #
+  #  puts Pinch.get('http://peterhellberg.github.com/pinch/test.zip', 'data.json')
+  #
   def self.get(url, file_name)
-    new(url).data(file_name)
+    new(url).get(file_name)
   end
 
+  ##
+  # List of files inside the zip file
+  #
+  # @param    [String] url        Full URL to the ZIP file
+  # @return   [Array]             List of all the files in the ZIP archive
+  # @example
+  #
+  #  Pinch.file_list('http://peterhellberg.github.com/pinch/test.zip').first #=> "data.json"
+  #
   def self.file_list(url)
     new(url).file_list
   end
 
+  ##
+  # Initializes a new Pinch object
+  #
+  # @param    [String] url        Full URL to the ZIP file
+  # @note You might want to use Pinch#get instead.
+  #
   def initialize(url)
     @uri    = URI.parse(url)
     @files  = {}
   end
 
+  ##
+  # @note You might want to use Pinch#file_list instead.
+  #
   def file_list
     file_headers.keys
   end
 
-  def data(file_name)
+  ##
+  # @example
+  #
+  #  puts Pinch.new('http://peterhellberg.github.com/pinch/test.zip').get('data.json')
+  #
+  # @note You might want to use Pinch#get instead
+  #
+  def get(file_name)
     local_file(file_name)
   end
 
@@ -77,6 +113,7 @@ private
     end
   end
 
+
   def file_headers
     @file_headers ||= begin
       raise RuntimeError, "Couldn’t find the central directory." if central_directory.nil?

metadata

@@ -1,40 +1,38 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pinch
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.7
   prerelease: 
-  version: 0.0.6
 platform: ruby
-authors: 
+authors:
 - Peter Hellberg
 - Edward Patel
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-05 00:00:00 +02:00
+date: 2011-07-05 00:00:00.000000000 +02:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: minitest
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152860800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: Pinch makes it possible to download a specific file from within a ZIP file over HTTP 1.1.
+  prerelease: false
+  version_requirements: *2152860800
+description: Pinch makes it possible to download a specific file from within a ZIP
+  file over HTTP 1.1.
 email: peter@c7.se
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
 - MIT-LICENSE
-files: 
+files:
 - lib/pinch.rb
 - MIT-LICENSE
 - README.rdoc
@@ -43,34 +41,33 @@ files:
 - spec/pinch_spec.rb
 has_rdoc: true
 homepage: https://github.com/peterhellberg/pinch
-licenses: 
+licenses:
 - MIT-LICENSE
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.rdoc
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Retrieve a file from inside a zip file, over the network!
-test_files: 
+test_files:
 - spec/pinch_spec.rb