t_bird 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 165550328a315a0ceb17e4176ec881efbc24c091
-  data.tar.gz: 0f66fcca8da662fb05d55a3575ac8608e49f82b4
+  metadata.gz: 133ff6c9059ab7d0d5b3752c1bfbcdfcf7b2df3e
+  data.tar.gz: 37421c6e9a79f1f40f3e6eef1028ddb1ebaf4ca5
 SHA512:
-  metadata.gz: 38fa5f3ff9c0d32d372d837d8fe9619d9e59216caa75b8085e2d8f2e541963067ace76a422af46cdf18427fdf12b09ab6df727f0b94c7aab04131eb59b912ecb
-  data.tar.gz: 17fa255fbc9856f9d653e040ba860de76a3064e19d57b0cc0a3123407c14ce2014b3dd8cf6369a681252538df98d074664aeab527743d28a03f50a177bce88b5
+  metadata.gz: 7493c8a2691ac3033a2887193a58b15ed268d7dd7dd82be6bef6069ce81cba0200ec9e997082de2026d052eb48bad63cd89bab0e5a749c390d5aef985e7bc373
+  data.tar.gz: c368763040e81bf9155e79a4011309e21113d71fbe9fbcbd64bc31ea89236ba90b41e7f475cf9c58a95a6ecd00ecbb934c0d4384a2b5f72acf04f28e158d861e

data/README.md

@@ -1,10 +1,12 @@
 # t_bird
 
-Uploading is... fun, fun, fun, until daddy takes the `t_bird` away.
+Straight forward uploads for your Ruby apps.
 
+_Uploading is... fun, fun, fun, until daddy takes the `t_bird` away._
 
 ## Project Status
 
+- Version: [![Gem Version](https://badge.fury.io/rb/t_bird.png)](http://badge.fury.io/rb/t_bird)
 - Build: [![Build Status](https://secure.travis-ci.org/xentek/t_bird.png)](http://travis-ci.org/xentek/t_bird)
 - Dependencies: [![Dependency Status](https://gemnasium.com/xentek/t_bird.png)](https://gemnasium.com/xentek/t_bird)
 - Code Quality: [![Code Climate](https://d3s6mut3hikguw.cloudfront.net/github/xentek/t_bird.png)](https://codeclimate.com/github/xentek/t_bird)
@@ -13,7 +15,7 @@ Uploading is... fun, fun, fun, until daddy takes the `t_bird` away.
 
 Add this line to your application's Gemfile:
 
-    gem 't_bird'
+    gem 't_bird', require: false
 
 And then execute:
 
@@ -22,20 +24,20 @@ And then execute:
 ## Why?
 
 I became frustrated by the very coupled design of the leading ruby
-upload libraries and wanted something that was a more modular (to
-allow for flexibility), wasn't glued to a `model`, and fulfilled my
-most common use case out of the box: 
+upload libraries and wanted something that was more modular (to
+allow for flexibility), wasn't glued to a `Model` (or any other 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.
+ - and upload the file(s) to S3 for storage.
 
 ## Usage
 
 First, configure `t_bird` with a few settings:
 
 ````ruby
+require 't_bird'
 TBird::Configuration.configure |config|
   config.aws_key 'amazon access key id'
   config.aws_secret 'amazon secret access key'
@@ -45,8 +47,8 @@ end
 ````
 Place this code so that it runs when your app boots.
 
-- If you're using Sinatra or Rack, `config.ru` is probably a good spot.
-- If you're using Rails, put the configuration in an initializer, e.g. `config/initializers/t_bird.rb`.
+  - If you're using Sinatra or Rack, `config.ru` is probably a good spot.
+  - If you're using Rails, put the configuration in an initializer, e.g. `config/initializers/t_bird.rb`.
 
 Then, assuming you have a multipart form like this:
 
@@ -60,12 +62,19 @@ _Example is using [slim](http://slim-lang.com) for clarity and terseness, but th
 In the action the form posts to, grab the uploaded file and upload it with `t_bird`:
 
 ````ruby
-uploader = TBird::Uploader.new(params[:brand][:image])
+# prepended to your filename and enables you
+# to create a path to your file on S3
+options = { identifier: "images/brands" }
 
-uploader.upload! # return value is same as uploader.uploads
+# instantiate your uploader, pass it your file
+uploader = TBird::Uploader.new(params[:brand][:image], options)
 
-uploader.uploads # returns a hash of urls pointing to your image versions
-                 # store this in the way that makes the most sense for your app
+# return value is the same as uploader.uploads
+uploader.upload!
+
+# returns a hash of the URL(s) to your uploads on S3
+# store this in the way that makes the most sense for your app
+brand.images = uploader.uploads
 ````
 
 - By default, there are two `versions` defined: `:thumbnail` and `:original`.
@@ -78,25 +87,26 @@ uploader.uploads # returns a hash of urls pointing to your image versions
 There are three options you can pass into your `TBird::Uploader` instance:
 
   - `:identifer`
-    - app specific identifer for his upload, e.g. your model's databae ID, timestamp, whatever
+    - app specific identifer for his upload, e.g. your model's databae ID, the date or timestamp, whatever
     - used as the folder this file's uploads are stored in on s3
       - you can pass a path fragment here to create a folder heirarchy, e.g. 'uploads/images'
       - don't want any folders?, just pass an empty string, e.g. `''`
     - defaults to a `SHA1` digest of the `original_filename`
     - value should be URL safe, no encoding is done for you by `t_bird`
   - `:token`
-    - needs to be a unique value per upload, to help avoid name collisions and writing over existing files
+    - needs to be a unique value per upload, to help avoid name collisions and writing over any existing files
     - used as part of the filename, version and extension are
       automatically appended on to the end.
-    - defaults to a [UUID](http://en.wikipedia.org/wiki/Universally_unique_identifier), think hard before straying from this strategy
+    - defaults to a [UUID](http://en.wikipedia.org/wiki/Universally_unique_identifier)
+      - think hard before straying from this strategy, UUIDs are generated quickly and
+        are nearly immune to collision (there is a higher probablity of you personally being
+        struck by a metorite than generating two UUIDs that have the same value.)
     - value should be URL safe, no encoding is done for you by `t_bird`
   - `:metadata`
-    - value must be a hash, as it will be merged in when your uploader is instantiated
-    - the file's `content_type` is automatically added to this hash
-    - values in this hash will be stored, with your file, on S3 as metadata.
-      - this could be used for versioning your files, e.g. `version: 2` , marking them with
-        the name/title of the model it's associated with, etc.
-      - `t_bird` doesn't provide any read access to this metadata, once it's stored on S3, so it's up to you to use S3's API to do anything with it.
+    - value must be a hash
+    - values in this hash will be stored, with your file, on S3
+      - this could be used for tagging your files, e.g. `tags: brands, images`, or anything else you might think of
+      - `t_bird` doesn't provide any read access to this metadata, once it's stored on S3. It's up to you to use S3's API to do anything with it.
 
 ## Custom Uploaders
 
@@ -110,12 +120,10 @@ class FileUploader < TBird::Uploader
 end
 ````
 
-- In this simple example we have created a subclass and defined a single
-version, `:original`, that skips processing the file, making `FileUploader` suitable
-for handling non-image uploads.
+- In this simple example we have created a subclass and defined a single version, `:original`
 - No other versions were defined, so only `:original` will be created.
-  - In other words, if you create a subclass without any `versions`
-    defined, your uploader won't upload anything.
+  - In other words, if you create a subclass without any `versions` defined, your uploader
+    won't upload anything.
 
 Here's a more complex example that defines several custom `versions`:
 
@@ -137,14 +145,16 @@ class ComplexUploader < TBird::Uploader
     ->(img) { img.resize '500x300' }
   end
 
-  # custom thumbnail size, allowing your to ignore TBird::Configuration.thumbnail_size
+  # custom thumbnail size, allowing your to ignore
+  # the value of TBird::Configuration.thumbnail_size
   # on an uploader by uploader basis
   version :thumbnail do
     ->(img) { img.thumbnail 200 }
   end
 
   # want MOAR power?
-  # use process, which gets you inside a MiniMagick::Image#combine_options block
+  # use process, which gets you inside a
+  # MiniMagick::Image#combine_options block
   version :complex do
     lambda do |img|
       img.process do |magick|
@@ -158,21 +168,22 @@ end
 ````
 For more information on `MiniMagick::Image#combine_options`, refer to the [mini_magick docs](https://github.com/minimagick/minimagick/blob/master/README.md).
 
-:skull: `TBird::Processor#process` can be a _very sharp stick_, so carefully test your processing code with a variety of files in a non-production environment, and as usual be wary of using values from outside of your class as input for your processing routines.
+:skull: `TBird::Processor#process` can be a _very sharp stick_, so carefully test your processing code with a variety of files in a non-production environment, and as usual, be wary of using values from outside of your class as input for your processing routines.
 
 ## More customization options
 
-- Redefine the `namer` method in your subclass to switch out the object that's responsible for generating the name used on S3.
-  - Your object must respond to `new_name`, and take the `version`, which will be a symbol, as input.
-- Redefine the `processor` method in your subclass to switch out the processing library.
-  - Blocks defined by the `version` macro will be passed an instance of your `processor`,
-    so be sure that your `processor` will respond to any methods the code inside your blocks call on it. 
-- Redefine the `upload!` to remix the whole show!
-  - really the sky's the limit here, but at some point you might be
-    better of just writing your own uploader class.
-  - Currently this is the only way to swith out S3 for another storage provider.
-    - Better support changing the storage mechanism will likely come out in a future version.
-    - Talk to me before working on a patch for this, so we can agree on implementation.
+  - Redefine the `namer` method in your subclass to switch out the object that's responsible for generating the name used on S3.
+    - Your object must respond to `new_name`, and take the `version`, which will be a symbol, as input.
+  - Redefine the `processor` method in your subclass to switch out the processing library.
+    - Blocks defined by the `version` macro will be passed an instance of your `processor`,
+      so be sure that your `processor` will respond to any methods the code inside your blocks call on it. 
+  - Redefine the `upload!` method to remix the whole flow!
+    - really the sky's the limit here, but at some point you might be
+      better of just writing your own uploader class that doesn't sit on
+      top of `t_bird`
+    - Currently this is the only way to swith out S3 for another storage provider.
+      - Better support for changing the storage mechanism will likely come out in a future version.
+      - Talk to me __before working on a patch__ for this, so we can agree on implementation.
 
 ## Contributing
 
@@ -186,5 +197,5 @@ For more information on `MiniMagick::Image#combine_options`, refer to the [mini_
 
 #### Colophon
 
-  - This project was not named after the Thunderbird model of car. Ford Motor Company does not have any connection to, or responsibility for this project, and does not endorse it in any way (or even know it exists).
+  - This project was not named after the Thunderbird model of car. Ford Motor Company does not have any connection to, or responsibility for this project, and does not endorse it in any way (or even know it exists. Probably).
   - 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/lib/t_bird/processor.rb

@@ -7,21 +7,23 @@ module TBird
     attr_reader :image
     def initialize(file_blob)
       @image = MiniMagick::Image.read(file_blob)
+      @tempfile = Tempfile.new(SecureRandom.uuid)
     end
 
     def process(&block)
       image.combine_options do |img|
         block.call(img) if block_given?
       end
-      image
+      write_to_file
     end
 
-    def stream
-      image.write StringIO.new
+    def write_to_file
+      image.write @tempfile
+      @tempfile
     end
     
     def original
-      image # noop
+      write_to_file
     end
 
     def resize(size)

data/lib/t_bird/transmitter.rb

@@ -4,37 +4,27 @@ 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)
-      connect!
+    def initialize
+      @s3 = AWS::S3.new(access_key_id: Configuration.aws_key, secret_access_key: Configuration.aws_secret)
     end
 
-    def transmit!
-      if @transmission.nil?
-        @transmission = S3Object.store(name, file, Configuration.aws_bucket, metadata)
-      end
-      @success ||= Service.response.success?
-      @success
-    end
-
-    def url
-      @url ||= S3Object.url_for(name, Configuration.aws_bucket, authenticated: false, use_ssl: true)
+    def transmit!(name, file, options = {})
+      s3object = s3bucket.objects[name]
+      s3object.write(file, default_options.merge(options))
+      s3object.public_url(secure: true)
     end
 
     private
 
-    def connect!
-      Base.establish_connection!(access_key_id: Configuration.aws_key, secret_access_key: Configuration.aws_secret, use_ssl: true)
+    def s3bucket
+      @s3bucket ||= @s3.buckets[Configuration.aws_bucket]
     end
 
-    def default_metadata
-      {
-        access: :public_read,
-        content_type: 'binary/octet-stream'
+    def default_options
+      { 
+        acl: :public_read,
+        content_type: 'binary/octet-stream',
+        metadata: {}
       }
     end
   end

data/lib/t_bird/uploader.rb

@@ -2,14 +2,14 @@
 
 module TBird
   class Uploader
-    attr_reader :file, :options, :uploads, :content_type, :original_filename
+    attr_reader :file, :options, :uploads, :content_type, :original_filename, :metadata
     def initialize(file, options = {})
       @file = file
       @options = default_options.merge(options)
       @uploads = {}
-      @content_type = @file.content_type
-      @original_filename = @file.original_filename
-      @options[:metadata].merge!(content_type: content_type)
+      @content_type = @file[:type]
+      @original_filename = @file[:filename]
+      @metadata = { content_type: content_type, metadata: @options[:metadata] || {} }
     end
 
     def namer
@@ -17,15 +17,16 @@ module TBird
     end
 
     def processor
-      @processor ||= Processor.new(@file)
+      Processor.new(@file[:tempfile])
+    end
+
+    def transmitter
+      @transmitter ||= Transmitter.new
     end
 
     def upload!
       versions.each do |version,block|
-        block.call(processor)
-        transmission = Transmitter.new(namer.new_name(version), processor.stream, options[:metadata])
-        transmission.transmit!
-        @uploads[version] = transmission.url
+        @uploads[version] = transmitter.transmit!(namer.new_name(version), block.call(processor), metadata)
       end
       uploads
     end
@@ -51,8 +52,7 @@ module TBird
     def default_options
       {
         identifier: nil,
-        token: nil,
-        metadata: {}
+        token: nil
       }
     end
   end

data/lib/t_bird/version.rb

@@ -1,3 +1,3 @@
 module TBird
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/spec_helper.rb

@@ -24,10 +24,12 @@ module TBirdSpecData
   end
 
   def upload_file
-    Rack::Test::UploadedFile.new(sample_file, 'image/jpeg')
-  end
+    upload = Rack::Test::UploadedFile.new(sample_file, 'image/jpeg')
 
-  def upload_filedata
-    upload_file.read
+    {
+      filename: upload.original_filename,
+      type: upload.content_type,
+      tempfile: upload.instance_variable_get(:@tempfile)
+    }
   end
 end

data/spec/t_bird/processor_spec.rb

@@ -7,36 +7,36 @@ describe TBird::Processor do
 
   before do
     @custom_process = ->(img) { img.quality 88 }
-    @processor = TBird::Processor.new(upload_file)
+    @processor = TBird::Processor.new(upload_file[:tempfile])
   end
 
   it "can process an image" do
-    image = @processor.process(&@custom_process)
-    image.valid?.must_equal true
-    image.destroy!
+    @processor.process(&@custom_process)
+    @processor.image.valid?.must_equal true
+    @processor.image.destroy!
   end
 
   it "can thumbnail an image" do
-    image = @processor.thumbnail
-    image.valid?.must_equal true
-    image.destroy!
+    @processor.thumbnail
+    @processor.image.valid?.must_equal true
+    @processor.image.destroy!
   end
 
   it "can resize an image" do
-    image = @processor.resize('300')
-    image.valid?.must_equal true
-    image.destroy!
+    @processor.resize('300')
+    @processor.image.valid?.must_equal true
+    @processor.image.destroy!
   end
 
   it "can return the original image" do
-    image = @processor.original
-    image.valid?.must_equal true
-    image.destroy!
+    @processor.original
+    @processor.image.valid?.must_equal true
+    @processor.image.destroy!
   end
 
-  it "can write image to a stream" do
-    image = @processor.resize('x200')
-    @processor.stream.must_be_instance_of StringIO
-    image.destroy!
+  it "can write image" do
+    @processor.resize('x200')
+    @processor.write_to_file.must_be_instance_of File
+    @processor.image.destroy!
   end
 end

data/spec/t_bird/transmitter_spec.rb

@@ -10,27 +10,30 @@ describe TBird::Transmitter do
       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)
-    AWS::S3::Service.stubs(response: stub(:success? => true))
 
     @stored_filename = '1/sample_original.jpg'
     @upload = upload_file
-    @transmitter = TBird::Transmitter.new(@stored_filename, @upload, { content_type: 'image/jpeg' })
+    @opts = { acl: :public_read, content_type: 'image/jpeg', metadata: {} }
+    @aws_config = stub_everything('aws_config')
+    @s3object = stub(public_url: "https://bucket.s3.amazonaws.com/#{@stored_filename}")    
+    @bucket = mock('bucket').responds_like(AWS::S3::Bucket.new(TBird::Configuration.aws_bucket, config: @aws_config))
+    @bucket_collection = { TBird::Configuration.aws_bucket => @bucket }
+  end
+
+  it "can connect to s3" do
+    AWS::S3.expects(:new).with(access_key_id: TBird::Configuration.aws_key, secret_access_key: TBird::Configuration.aws_secret)
+    TBird::Transmitter.new
   end
 
-  it "transmit file to store" do
-    AWS::S3::S3Object.expects(:store).with(@stored_filename, @upload, 'bucket', {:access => :public_read, :content_type => 'image/jpeg'})
-    @transmitter.transmit!
+  it "can select s3 bucket" do
+    AWS::S3::BucketCollection.expects(:new).returns(@bucket_collection)
+    TBird::Transmitter.new.send(:s3bucket)
   end
 
-  it "can return the S3 url for the file uploaded" do
-    AWS::S3::S3Object.expects(:url_for).with(@stored_filename, 'bucket', authenticated: false, use_ssl: true)
-    @transmitter.url
+  it "can transmit file to s3" do
+    @bucket.expects(:objects).returns({ @stored_filename => @s3object })
+    @s3object.expects(:write).with(@upload, { acl: :public_read, content_type: 'image/jpeg', metadata: {} }).returns(@s3object)
+    AWS::S3.stubs(:new).returns(stub(buckets: @bucket_collection))
+    TBird::Transmitter.new.transmit!(@stored_filename, @upload, { content_type: 'image/jpeg' }).must_equal "https://bucket.s3.amazonaws.com/1/sample_original.jpg"
   end
 end

data/spec/t_bird/uploader_spec.rb

@@ -16,9 +16,14 @@ describe TBird::Uploader do
   end
 
   it "can return the options" do
-    @uploader.options.must_equal({ identifier: nil, token: nil, metadata: { content_type: "image/jpeg" } })
+    @uploader.options.must_equal({ identifier: nil, token: nil })
   end
 
+  it "can return the metadata" do
+    @uploader.metadata.must_equal({ content_type: 'image/jpeg', metadata: {} })
+  end
+  
+
   it "can return the content type" do
     @uploader.content_type.must_equal 'image/jpeg'
   end
@@ -35,21 +40,22 @@ describe TBird::Uploader do
     @uploader.namer.must_be_instance_of TBird::Namer
   end
 
+  it "can return an instance of Transmitter" do
+    @uploader.transmitter.must_be_instance_of TBird::Transmitter
+  end
+
   it "can return the registered versions" do
     @uploader.versions.must_equal TBird::Uploader.versions
   end
 
   it "can upload all versions" do
-    TBird::Transmitter.any_instance.stubs(:transmit!)
-    TBird::Transmitter.any_instance.stubs(:url).returns(*@urls)
-
+    TBird::Transmitter.any_instance.stubs(:transmit!).returns(*@urls)
     @uploader.upload!.must_equal({ thumbnail: @urls.first, original: @urls.last })
   end
 
   it "can return the upload urls" do
-    TBird::Transmitter.any_instance.stubs(:transmit!)
-    TBird::Transmitter.any_instance.stubs(:url).returns(*@urls)
-
+    TBird::Transmitter.any_instance.stubs(:transmit!).returns(*@urls)
+    
     @uploader.upload!
     @uploader.uploads.must_equal({ thumbnail: @urls.first, original: @urls.last })
   end

data/t_bird.gemspec

@@ -8,9 +8,12 @@ Gem::Specification.new do |gem|
   gem.version       = TBird::VERSION
   gem.authors       = ['Eric Marden']
   gem.email         = ['eric@xentek.net']
-  gem.description   = %q{Straight forward file uploads for Ruby Apps.}
+  gem.description   = %q{Straight forward file uploads for Ruby Apps. Decouple your uploads from your model.}
   gem.summary       = %q{Straight forward file uploads for Ruby Apps.}
-  gem.homepage      = 'https://github.com/xentek/t_bird'
+  gem.homepage      = 'http://xentek.github.io/t_bird'
+  gem.metadata      = { 'Github' => 'https://github.com/xentek/t_bird',
+                        'README' => 'https://github.com/xentek/t_bird/blob/master/README.md',
+                        'Issues' => 'https://github.com/xentek/t_bird/issues' }
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
@@ -19,7 +22,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'mini_magick'
-  gem.add_dependency 'aws-s3'
+  gem.add_dependency 'aws-sdk'
   gem.add_development_dependency 'bundler', '~> 1.3'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'gem-release'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: t_bird
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Eric Marden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws-s3
+  name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -80,7 +80,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Straight forward file uploads for Ruby Apps.
+description: Straight forward file uploads for Ruby Apps. Decouple your uploads from
+  your model.
 email:
 - eric@xentek.net
 executables: []
@@ -108,10 +109,13 @@ files:
 - spec/t_bird/transmitter_spec.rb
 - spec/t_bird/uploader_spec.rb
 - t_bird.gemspec
-homepage: https://github.com/xentek/t_bird
+homepage: http://xentek.github.io/t_bird
 licenses:
 - MIT
-metadata: {}
+metadata:
+  Github: https://github.com/xentek/t_bird
+  README: https://github.com/xentek/t_bird/blob/master/README.md
+  Issues: https://github.com/xentek/t_bird/issues
 post_install_message: 
 rdoc_options: []
 require_paths: