t_bird 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8bed597706b18d287438b31c1a9be55fa0528453
+  data.tar.gz: 09c9333f2f2946f1a1166e221f0f268310eb7a02
+SHA512:
+  metadata.gz: af944ed056e75ff4380f215290d5dd354daeacf9b4db1856495fa1b087d2780c119e1269bdb6353ef02259d1d9f33137daaaf9d42b7927e977379fdf4c7bb409
+  data.tar.gz: 43aa1b46dedb3d0c2d1ed0c3cdfb53ce74fe963ddceee50ade17c376a39bd7322b99a8622b0115e9b1c12f84f0bc3b73cc8966bd33bf379f1f01724fb499907d

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+gemspec
+
+group :test do
+  gem 'sinatra', require: false
+  gem 'minitest', require: false
+  gem 'minitest-spec-context', require: false
+  gem 'minitest-reporters', require: false
+  gem 'mocha', require: false
+  gem 'rack-test', require: false
+  gem 'uuid', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eric Marden
+
+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,41 @@
+# TBird
+
+Straight forward file uploads for Ruby Apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 't_bird'
+
+And then execute:
+
+    $ bundle
+
+## Why?
+
+I became frustrated by the very coupled design of the leading ruby
+upload libraries and wanted something that was a little more modular (to
+allow for flexibility), wasn't glued to a `model` class, and fulfilled my
+most common use case out of the box: 
+
+ - Upload an image, posted from a multi-part form,
+ - process the file into 1 or more versions (resize, crop, etc),
+ - and stream the files to s3 for storage without keeping anything on
+   the local filesystem.
+
+## Usage
+
+_Coming Soon_
+
+## Contributing
+
+1. Fork it
+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
+
+## Shout Outs
+
+Sample image, used in tests, was provided by [cherrylet](http://www.flickr.com/photos/cherrylet/10258332985/sizes/o/in/photostream/), under the Creative Commons 2.0. No endorsement of this library by the photographer is intended or implied.

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+
+require 'rake'
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.pattern = "spec/**/*_spec.rb"
+end
+task :default => [:test]

data/lib/t_bird/configuration.rb

@@ -0,0 +1,18 @@
+# encoding utf-8
+
+module TBird
+  class Configuration
+    
+    class << self
+      attr_accessor :aws_key, :aws_secret, :aws_bucket, :thumbnail_size
+    end
+
+    def self.configure
+      yield self
+    end
+
+    def self.thumbnail_size
+      @thumbnail_size ||= 100
+    end
+  end
+end

data/lib/t_bird/namer.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'digest/sha1'
+require 'pathname'
+
+module TBird
+  class Namer
+    attr_reader :ext, :identifier, :token
+    def initialize(original_filename, identifier = nil, token = SecureRandom.uuid)
+      @ext = Pathname.new(original_filename).extname
+      @identifier = identifier || Digest::SHA1.hexdigest(original_filename)
+      @token = token
+    end
+
+    def new_name(version = 'original')
+      "#{identifier}/#{token}_#{version}#{ext}"
+    end
+  end
+end

data/lib/t_bird/processor.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'mini_magick'
+
+module TBird
+  class Processor
+    attr_reader :image, :thumbnail_size
+    def initialize(file_blob)
+      @image = MiniMagick::Image.read(file_blob)
+      @thumbnail_size = Configuration.thumbnail_size
+    end
+
+    def process(&block)
+      image.combine_options do |magick|
+        block.call(magick) if block_given?
+      end
+      image
+    end
+
+    def resize(size)
+      process do |magick|
+        magick.resize size
+      end
+    end
+
+    def thumbnail
+      process do |magick|
+        magick.auto_orient
+        magick.thumbnail "x#{thumbnail_size*2}"
+        magick.resize "#{thumbnail_size*2}x<"
+        magick.resize "50%"
+        magick.gravity "center"
+        magick.crop "#{thumbnail_size}x#{thumbnail_size}+0+0"
+        magick.quality 92
+      end
+    end
+  end
+end

data/lib/t_bird/transmitter.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'aws/s3'
+
+module TBird
+  class Transmitter
+    include AWS::S3
+    attr_reader :name, :file, :metadata
+    def initialize(name, file, metadata = {})
+      @name = name
+      @file = file
+      @metadata = default_metadata.merge(metadata)
+    end
+
+    def transmit!
+      connect!
+      @tranmission = S3Object.store(name, file, Configuration.aws_bucket, metadata)
+    end
+
+    def url
+      @transmission.url
+    end
+
+    private
+
+    def connect!
+      Base.establish_connection!(access_key_id: Configuration.aws_key, secret_access_key: Configuration.aws_secret, use_ssl: true)
+    end
+
+    def default_metadata
+      {
+        access: :public_read,
+        content_type: 'binary/octet-stream'
+      }
+    end
+  end
+end

data/lib/t_bird/uploader.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+module TBird
+  class Upload
+    attr_reader :options
+    def initialize(file, options = {})
+      @options = default_options.merge(options)
+      @file = file
+    end
+
+    def content_type
+      @file_data ||= @file.content_type
+    end
+
+    def original_filename
+      @file_data ||= @file.original_filename
+    end
+
+    def original_file
+      @file_data ||= @file.read
+    end
+
+    private
+
+    def default_options
+      {}
+    end
+  end
+end

data/lib/t_bird/version.rb

@@ -0,0 +1,3 @@
+module TBird
+  VERSION = "0.0.1"
+end

data/lib/t_bird.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 't_bird/configuration'
+require 't_bird/namer'
+require 't_bird/processor'
+require 't_bird/transmitter'
+require 't_bird/uploader'
+require 't_bird/version'
+
+module TBird
+  module Errors
+    class Unknown < StandardError ; end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+ENV['RACK_ENV'] = 'test'
+
+lib_path = File.expand_path('../../lib', __FILE__)
+($:.unshift lib_path) unless ($:.include? lib_path)
+
+Bundler.setup(:default, ENV['RACK_ENV'])
+
+require 't_bird'
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+
+require 'mocha/setup'
+require 'rack/test'
+#include Rack::Test::Methods
+
+require 'uuid'
+
+module TBirdSpecData
+  def sample_file
+    File.expand_path('../sample.jpg', __FILE__)
+  end
+
+  def upload_file
+    Rack::Test::UploadedFile.new(sample_file, 'image/jpeg')
+  end
+
+  def upload_filedata
+    upload_file.read
+  end
+end

data/spec/t_bird/configuration_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe TBird::Configuration do
+  before do
+    TBird::Configuration.configure do |config|
+      config.aws_key = 'access_key_id'
+      config.aws_secret = 'secret_access_key'
+      config.aws_bucket = 'bucket_name'
+      config.thumbnail_size = 200
+    end
+  end
+
+  it "can configure :aws_key" do
+    TBird::Configuration.aws_key.must_equal 'access_key_id'
+  end
+
+  it "can configure :aws_secret" do
+    TBird::Configuration.aws_secret.must_equal 'secret_access_key'
+  end
+
+  it "can configure :aws_bucket" do
+    TBird::Configuration.aws_bucket.must_equal 'bucket_name'
+  end
+  it "can configure :thumbnail_size" do
+    TBird::Configuration.thumbnail_size.must_equal 200
+  end
+end

data/spec/t_bird/namer_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe TBird::Namer do
+  include TBirdSpecData
+  before do
+    @original_filename = Pathname.new(sample_file).basename.to_s
+    @namer = TBird::Namer
+  end
+
+  it "returns the extension of the original filename" do
+    @namer.new(@original_filename).ext.must_equal '.jpg'
+  end
+
+  it "returns the default identifier" do
+    @namer.new(@original_filename).identifier.must_equal Digest::SHA1.hexdigest(@original_filename)
+  end
+
+  it "returns the specified identifier" do
+    @namer.new(@original_filename, 1).identifier.must_equal 1
+  end
+
+  it "returns the generated token" do
+    UUID.validate(@namer.new(@original_filename).token).must_equal true
+  end
+
+  it "returns the given token" do
+    token = SecureRandom.uuid
+    @namer.new(@original_filename, nil, token).token.must_equal token
+  end
+
+  it "returns the new name for 'original' version" do
+    token = SecureRandom.uuid
+    @namer.new(@original_filename, 1, token).new_name.must_equal "1/#{token}_original.jpg"
+  end
+
+  it "returns the new name for the given version" do
+    token = SecureRandom.uuid
+    @namer.new(@original_filename, 1, token).new_name('thumb').must_equal "1/#{token}_thumb.jpg"
+  end
+end

data/spec/t_bird/processor_spec.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe TBird::Processor do
+  include TBirdSpecData
+
+  before do
+    @custom_process = Proc.new do |magick|
+                        magick.resize '50%'
+                        magick.quality 88
+                      end
+
+    @processor = TBird::Processor.new(upload_file)
+    @versions = {
+                  thumb: '90x90',
+                  medium: '300',
+                  large: 'x300',
+                  custom: @custom_process
+                }
+  end
+
+  it "can process an image" do
+    image = @processor.process(&@custom_process)
+    image.write StringIO.new
+    image.valid?.must_equal true
+    image.destroy!
+  end
+
+  it "can process image into a thubnail" do
+    image = @processor.thumbnail
+    image.write StringIO.new
+    image.valid?.must_equal true
+    image.destroy!
+  end
+
+  it "can resize an image" do
+    image = @processor.resize('300')
+    image.write StringIO.new
+    image.valid?.must_equal true
+    image.destroy!
+  end
+end

data/spec/t_bird/transmitter_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe TBird::Transmitter do
+  include TBirdSpecData
+  before do
+    TBird::Configuration.configure do |config|
+      config.aws_key = 'abc'
+      config.aws_secret = '123'
+      config.aws_bucket = 'bucket'
+    end
+    
+    keys = { access_key_id: TBird::Configuration.aws_key,
+             secret_access_key: TBird::Configuration.aws_secret,
+             use_ssl: true }
+
+    AWS::S3::S3Object.stubs(:connected?).returns(true)
+    AWS::S3::Base.stubs(:establish_connection!).with(keys)
+
+    @stored_filename = '1/sample_original.jpg'
+    @transmitter = TBird::Transmitter.new(@stored_filename, upload_filedata, { content_type: 'image/jpeg' })
+  end
+
+  it "transmit file to store" do
+    AWS::S3::S3Object.expects(:store).with(@stored_filename, upload_filedata, 'bucket', {:access => :public_read, :content_type => 'image/jpeg'})
+    @transmitter.transmit!
+  end
+end

data/spec/t_bird/uploader_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe TBird::Upload do
+  include TBirdSpecData
+
+  before do
+    @tbird_upload = TBird::Upload.new(upload_file)
+  end
+
+  it "can return original filename" do
+    @tbird_upload.original_filename.must_equal 'sample.jpg'
+  end
+
+  it "can return content type" do
+    @tbird_upload.content_type.must_equal 'image/jpeg'
+  end
+
+  it "can return the original file binary data" do
+    @tbird_upload.original_file.wont_be_nil
+  end
+end

data/t_bird.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$:.unshift(lib) unless $:.include?(lib)
+require 't_bird/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 't_bird'
+  gem.version       = TBird::VERSION
+  gem.authors       = ['Eric Marden']
+  gem.email         = ['eric@xentek.net']
+  gem.description   = %q{Straight forward file uploads for Ruby Apps.}
+  gem.summary       = %q{Straight forward file uploads for Ruby Apps.}
+  gem.homepage      = 'https://github.com/xentek/t_bird'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'mini_magick'
+  gem.add_dependency 'aws-s3'
+  gem.add_development_dependency 'bundler', '~> 1.3'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'gem-release'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: t_bird
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Marden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: gem-release
+  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: Straight forward file uploads for Ruby Apps.
+email:
+- eric@xentek.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/t_bird.rb
+- lib/t_bird/configuration.rb
+- lib/t_bird/namer.rb
+- lib/t_bird/processor.rb
+- lib/t_bird/transmitter.rb
+- lib/t_bird/uploader.rb
+- lib/t_bird/version.rb
+- spec/sample.jpg
+- spec/spec_helper.rb
+- spec/t_bird/configuration_spec.rb
+- spec/t_bird/namer_spec.rb
+- spec/t_bird/processor_spec.rb
+- spec/t_bird/transmitter_spec.rb
+- spec/t_bird/uploader_spec.rb
+- t_bird.gemspec
+homepage: https://github.com/xentek/t_bird
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Straight forward file uploads for Ruby Apps.
+test_files:
+- spec/sample.jpg
+- spec/spec_helper.rb
+- spec/t_bird/configuration_spec.rb
+- spec/t_bird/namer_spec.rb
+- spec/t_bird/processor_spec.rb
+- spec/t_bird/transmitter_spec.rb
+- spec/t_bird/uploader_spec.rb