tupper 1.0.0

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
+vendor/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 SHIOYA, Hiromu
+
+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,29 @@
+# Tupper
+
+Tupper is a helper for processing uploaded file via web form.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tupper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tupper
+
+## Usage
+
+[TODO] add sample for Sinatra controller.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+Bundler.setup
+require 'rspec/core/rake_task'
+
+desc "run spec"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["-c", "-fs"]
+end

data/lib/tupper/version.rb

@@ -0,0 +1,3 @@
+class Tupper
+  VERSION = "1.0.0"
+end

data/lib/tupper.rb

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+require "tupper/version"
+require 'json'
+
+class Tupper
+  DEFAULT_TMP_DIR = File.join(%w{ / tmp tupper })
+  SESSION_STORE_KEY = 'tupper_file_info'
+
+  attr_reader :temp_dir, :file_info
+
+  def initialize session
+    @session = session
+    unless ((json = @session.fetch(SESSION_STORE_KEY, '')).empty?)
+      begin
+        @file_info = JSON.parse(json)
+      rescue
+        @session.delete(SESSION_STORE_KEY)
+        raise RuntimeError.new('invalid session data')
+      end
+    end
+  end
+
+  def temp_dir= temp_dir
+    FileUtils.mkdir_p temp_dir
+    @temp_dir = temp_dir
+  end
+
+  def has_uploaded_file?
+    @file_info && File.exists?(@file_info.fetch("uploaded_file", ''))
+  end
+
+  def upload file_info
+    unless @temp_dir
+      self.temp_dir = DEFAULT_TMP_DIR
+    end
+
+    file_hash = "#{Time.now.to_i}_#{Digest::MD5.hexdigest(file_info[:filename]).slice(0, 8)}"
+    uploaded_file = File.join(temp_dir, file_hash + File.extname(file_info[:filename]))
+    FileUtils.copy(file_info[:tempfile], uploaded_file)
+    tupper_file_info = {
+      uploaded_file: uploaded_file,
+      original_file: file_info[:filename],
+    }.to_json
+    @session.store SESSION_STORE_KEY, tupper_file_info
+  end
+
+  def uploaded_file
+    (@file_info || {}).fetch('uploaded_file', nil)
+  end
+
+  def original_file
+    (@file_info || {}).fetch('original_file', nil)
+  end
+
+  def cleanup
+    File.unlink uploaded_file if has_uploaded_file?
+    @session.delete SESSION_STORE_KEY
+    @file_info = nil
+  end
+end

data/spec/tupper_spec.rb

@@ -0,0 +1,95 @@
+# -*- coding: utf-8 -*-
+require 'bundler'
+Bundler.setup(:default, :test)
+require 'fakefs/spec_helpers'
+require 'tupper'
+
+describe Tupper do
+  include FakeFS::SpecHelpers
+
+  let(:collect_json) {
+    "{\"uploaded_file\":\"/tmp/tupper/1341556030_54c89662.txt\",\"original_file\":\"dummy_tsv.txt\"}"
+  }
+
+  describe '#initialize' do
+    context 'without session data' do
+      before do
+        @tupper = Tupper.new({})
+        @tupper.temp_dir = Tupper::DEFAULT_TMP_DIR
+      end
+      it "should create default temporary directory" do
+        Dir.exists?(@tupper.temp_dir).should be_true
+        @tupper.temp_dir.should == '/tmp/tupper'
+      end
+    end
+
+    context 'with invalid session data' do
+      specify { expect { Tupper.new(Tupper::SESSION_STORE_KEY.to_s => 'invalid json') }.to raise_error RuntimeError }
+    end
+
+    context 'with valid session data' do
+      subject { Tupper.new(Tupper::SESSION_STORE_KEY.to_s => collect_json) }
+      its(:file_info) { should be_instance_of Hash }
+    end
+  end
+
+  describe '#temp_dir=' do
+    before do
+      @tupper = Tupper.new({})
+      @tupper.temp_dir = 'hoge'
+    end
+
+    it 'should set property "temp_dir" and create directory' do
+      @tupper.temp_dir.should == 'hoge'
+      Dir.exists?(@tupper.temp_dir).should be_true
+    end
+  end
+
+  describe '#has_uploaded_file?' do
+    context 'before upload' do
+      subject { Tupper.new({}) }
+      it { should_not have_uploaded_file }
+    end
+
+    context 'has collect session' do
+      before do
+        @tupper = Tupper.new(Tupper::SESSION_STORE_KEY.to_s => collect_json)
+        FileUtils.mkdir_p Tupper::DEFAULT_TMP_DIR
+        FileUtils.touch('/tmp/tupper/1341556030_54c89662.txt')
+      end
+      specify { @tupper.should have_uploaded_file }
+    end
+  end
+
+  describe '#uploaded_file' do
+    context 'before upload'do
+      subject { Tupper.new({}) }
+      its(:uploaded_file) { should be_nil }
+    end
+
+    context 'has collect session' do
+      before do
+        @tupper = Tupper.new(Tupper::SESSION_STORE_KEY.to_s => collect_json)
+        FileUtils.mkdir_p Tupper::DEFAULT_TMP_DIR
+        FileUtils.touch('/tmp/tupper/1341556030_54c89662.txt')
+      end
+
+      subject { @tupper.uploaded_file }
+      it { should == '/tmp/tupper/1341556030_54c89662.txt' }
+    end
+  end
+
+  describe '#cleanup' do
+    before do
+      @tupper = Tupper.new(Tupper::SESSION_STORE_KEY.to_s => collect_json)
+      FileUtils.mkdir_p Tupper::DEFAULT_TMP_DIR
+      FileUtils.touch('/tmp/tupper/1341556030_54c89662.txt')
+      @tupper.cleanup
+    end
+
+    it 'should delete uploaded_file and session' do
+      @tupper.instance_variable_get(:@session).should_not be_include Tupper::SESSION_STORE_KEY
+      File.exists?('/tmp/tupper/1341556030_54c89662.txt').should be_false
+    end
+  end
+end

data/tupper.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/tupper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["SHIOYA, Hiromu"]
+  gem.email         = ["kwappa.856@gmail.com"]
+  gem.description   = "Tupper is a helper for processing uploaded file via web form."
+  gem.summary       = "Tupper is a helper for processing uploaded file via web form."
+  gem.homepage      = "https://github.com/kwappa/tupper"
+
+  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.name          = "tupper"
+  gem.require_paths = ["lib"]
+  gem.version       = Tupper::VERSION
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "fakefs"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: tupper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- SHIOYA, Hiromu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tupper is a helper for processing uploaded file via web form.
+email:
+- kwappa.856@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tupper.rb
+- lib/tupper/version.rb
+- spec/tupper_spec.rb
+- tupper.gemspec
+homepage: https://github.com/kwappa/tupper
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -87756479144681564
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -87756479144681564
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Tupper is a helper for processing uploaded file via web form.
+test_files:
+- spec/tupper_spec.rb