tmp_file 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 700139ffe9e157afec5bc9154441e54b22afeb5d
+  data.tar.gz: 234380a9e5a67efc74237ff9651681c6e1bb97da
+SHA512:
+  metadata.gz: c1256ea2963d949f64a5735e0dec52296940adc5f3c8416746cd1bc1940a84e3b38161ef7742b97d3857e6cdb2e711e17df9b741feda2a41cb26a062ac22dc17
+  data.tar.gz: 27f8c09dd1acf7a249d697cce9a80621d54f306ae55bd0758899718f000bde06f119a1c290fcc59b025f9b49d43b0927bc66cf8635524fbaf4e61766ad63b63a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Topspin Media Inc.
+
+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,38 @@
+What is TmpFile
+================
+
+A ruby gem to temporarily store data in a file with an appropriate extension
+
+Why TmpFile was born
+=====================
+
+At [Topspin](http://topspinmedia.com) we provide [ArtistLink](http://artistlink.com), a platform for musician to upload and share their songs.
+When a song contains cover art in the ID3 tag, we extract it to an image and process it to create a nice page background.
+We use TmpFile to temporarily extract the cover art data from the song into a file store its processed version.
+
+Requirements
+============
+
+TmpFile has been tested on Ruby 1.8.7, 1.9.2, 1.9.3 and 2.0.0.
+No external libraries are required.
+
+How to use from other programs
+==============================
+
+* Include `tmp_file` in the Gemfile of your bundled project and `bundle install`
+* To store data in a temporary file and yield the file handle, run:
+
+        TmpFile.open(data, mime_type) do |tmp_file|
+          # do something with tmp_file
+        end
+    
+
+For more details, check the [specs](http://github.com/topspin/tmp_file/tree/master/spec/lib).
+
+
+How to contribute
+=================
+
+Make sure tests pass with `rake spec`, then submit a Pull Request.
+
+A list of [nice TODOs](http://github.com/topspin/tmp_file/tree/master/TODO.md) is provided.

data/lib/tmp_file.rb

@@ -0,0 +1,50 @@
+require 'tmpdir'
+require 'securerandom'
+
+# Provides a method to store data in a temporary file and access that file
+module TmpFile
+
+  # Stores +data+ in a temporary file and yields the file.
+  # The file is destroyed after the yielded block ends.
+  # The extension of the temporary file matches the passed +mime_type+.
+  #
+  # @param [String] data Data to store in the temporary file
+  # @param [String] mime_type MIME type of the temporary file
+  # @yield [File] handle of an open read-only file with the given +data+
+  #
+  # @example Yield a temporary PNG file with the .png extension
+  # ==== Examples
+  #
+  #    TmpFile.open("\x89PNG\r\n\x1A[...]", 'image/png') do |tmp_file|
+  #      # do something with tmp_file
+  #    end
+  def self.open(data, mime_type)
+    path = self.unique_path_for_temporary_file mime_type
+    File.open(path, 'wb') {|file| file.write data}
+    File.open(path, 'rb') {|file| yield file}
+  ensure
+    FileUtils.rm_f path
+  end
+
+private
+
+  # Returns a unique temporary path to store a file of the given +mime_type+.
+  #
+  # @param [String] mime_type MIME type of the temporary file
+  # @return [String] local path that can be opened for writing
+  #
+  # @example Find a unique path to store a temporary PNG file
+  #   TmpFile.unique_path_for_temporary_file('image/png')
+  #
+  #   # => '/var/folders/zs/xtcy1d/T/517bf6608c1314441285d4797ebcb3c2.png'
+  def self.unique_path_for_temporary_file(mime_type)
+    extension = case mime_type
+      when 'image/jpg'  then '.jpg'
+      when 'image/jpeg' then '.jpg'
+      when 'image/png'  then '.png'
+      when 'image/gif'  then '.gif'
+      else '.unknown'
+    end
+    File.join Dir.tmpdir, (SecureRandom.hex + extension)
+  end
+end

data/lib/tmp_file/version.rb

@@ -0,0 +1,3 @@
+module TmpFile
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: tmp_file
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Claudio Baccigalupo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: redcarpet
+  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: yard
+  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: Yields a temporary file with given data and MIME type
+email:
+- claudio@topspinmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tmp_file/version.rb
+- lib/tmp_file.rb
+- MIT-LICENSE
+- README.md
+homepage: https://github.com/topspin/tmp_file
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: ! 'TmpFile provides one method: * open, which creates a temporary file with
+  the provided data and the appropriate extension for the MIME type, yields the file
+  handler to a block, and deletes the file once the block is completed'
+test_files: []
+has_rdoc: