s3_multipart 0.0.9 → 0.0.10.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    s3_multipart (0.0.8)
+    s3_multipart (0.0.10)
       uuid (>= 2.3.6)
       xml-simple (>= 1.1.2)
 

data/README.md

@@ -4,6 +4,12 @@ The S3 Multipart gem brings direct multipart uploading to S3 to Rails. Data is p
 
 Multipart uploading allows files to be split into many chunks and uploaded in parallel or succession (or both). This can result in dramatically increased upload speeds for the client and allows for the pausing and resuming of uploads. For a more complete overview of multipart uploading as it applies to S3, see the documentation [here](http://docs.amazonwebservices.com/AmazonS3/latest/dev/mpuoverview.html). Read more about the philosophy behind the gem on the Bitcast [blog](http://blog.bitcast.io/post/43001057745/direct-multipart-uploads-to-s3-in-rails).
 
+## What's New
+
+**0.0.10.2** - Fixed some bugs. Modifications made to the database table used by the gem are now handled by migrations. If you are upgrading versions, run `rails g s3_multipart:install_new_migrations` followed by `rake db:migrate`. Fresh installs do not require subsequent migrations. The current version must now also be passed in to the gem's configuration function to alert you of breaking changes. This is done by setting a revision yml variable. See the section regarding the aws.yml file in the readme section below (just before "Getting Started").
+
+**0.0.9** - File type and size validations are now specified in the upload controller. Untested support for browsers that lack the FileBlob API
+
 ## Setup
 
 First, assuming that you already have an S3 bucket set up, you will need to paste the following into your CORS configuration file, located under the permissions tab in your S3 console.
@@ -79,13 +85,14 @@ $(function() {
 
 This piece of code does some configuration and provides various callbacks that you can hook into. It will be discussed further at the end of the Getting Started guide below.
 
-Finally, edit the aws.yml that was created in your config folder with the correct credentials for each environment.
+Finally, edit the aws.yml that was created in your config folder with the correct credentials for each environment. Set the revision number to the current version number. If breaking changes are made to the gem in a later version, then you will be notified when the two versions do not match in the log.
 
 ```yaml
 development:
   access_key_id: ""
   secret_access_key: ""
   bucket: ""
+  revision: "#.#.#"
 ```
 
 ## Getting Started
@@ -174,6 +181,7 @@ S3Multipart.configure do |config|
   config.bucket_name   = ''
   config.s3_access_key = ''
   config.s3_secret_key = ''
+  config.revision = S3Multipart::Version
 end
 ```
 
@@ -194,6 +202,7 @@ S3Multipart.configure do |config|
   config.bucket_name   = ''
   config.s3_access_key = ''
   config.s3_secret_key = ''
+  config.revision = S3Multipart::Version
 end
 
 run Combustion::Application
@@ -213,9 +222,6 @@ S3_Multipart is very much a work in progress. If you squash a bug, make enhancem
 
 The library is working on the latest version of IE, Firefox, Safari, and Chrome. Tests for over 100 browsers are currently being conducted.
 
-## What's New
-
-**0.0.9** - File type and size validations are now specified in the upload controller. Untested support for browsers that lack the FileBlob API
 
 ## To Do
 

data/app/models/s3_multipart/upload.rb

@@ -15,9 +15,9 @@ module S3Multipart
       
       case stage
       when :begin
-        controller.on_begin_callback.call(self, session)
+        controller.on_begin_callback.call(self, session) if controller.on_begin_callback
       when :complete
-        controller.on_complete_callback.call(self, session)
+        controller.on_complete_callback.call(self, session) if controller.on_begin_callback
       end
     end
 

data/lib/generators/s3_multipart/install_new_migrations_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+
+module S3Multipart
+  class InstallNewMigrationsGenerator < Rails::Generators::Base
+    desc "Generates the migrations necessary when updating the gem to the latest version"
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    def create_latest_migrations
+      copy_file "add_size_column_to_s3_multipart_uploads.rb", "db/migrate/#{migration_time}_add_size_to_s3_multipart_uploads.rb"
+    end
+
+    private
+
+      def migration_time
+        Time.now.strftime("%Y%m%d%H%M%S")
+      end
+
+  end
+end

data/lib/generators/s3_multipart/templates/add_size_column_to_s3_multipart_uploads.rb

@@ -0,0 +1,5 @@
+class AddSizeToS3MultipartUploads < ActiveRecord::Migration
+  def change
+    add_column :s3_multipart_uploads, :size, :integer
+  end
+end

data/lib/generators/s3_multipart/templates/aws.yml

@@ -1,4 +1,5 @@
 development:
   access_key_id: ""
   secret_access_key: ""
-  bucket: ""
+  bucket: ""
+  revision: "#.#.#"

data/lib/generators/s3_multipart/templates/configuration_initializer.rb

@@ -4,5 +4,6 @@ S3Multipart.configure do |config|
   config.bucket_name   = AWS_Config['bucket']
   config.s3_access_key = AWS_Config['access_key_id']
   config.s3_secret_key = AWS_Config['secret_access_key']
+  config.revision      = AWS_Config['revision']
 end
 

data/lib/s3_multipart.rb

@@ -23,6 +23,7 @@ module S3Multipart
 
 end
 
+require 's3_multipart/version'
 require 's3_multipart/config'
 require 's3_multipart/railtie'
 require 's3_multipart/engine'

data/lib/s3_multipart/config.rb

@@ -3,10 +3,18 @@ require 'singleton'
 module S3Multipart
   class Config
     include Singleton
-    attr_accessor :s3_access_key, :s3_secret_key, :bucket_name
+    attr_accessor :s3_access_key, :s3_secret_key, :bucket_name, :revision
 
     def self.configure(block)
       block.call(self.instance)
+      check_for_breaking_changes
+    end
+
+    def self.check_for_breaking_changes
+      version = S3Multipart::VERSION
+      if self.instance.revision != version
+        raise ArgumentError, "Breaking changes were made to the S3_Multipart gem:\n #{BREAKING_CHANGES[version.to_sym]}\n See the Readme for additional information."
+      end
     end
   end
-end
+end

data/lib/s3_multipart/version.rb

@@ -1,3 +1,6 @@
 module S3Multipart
-  VERSION = "0.0.9"
+  VERSION = "0.0.10.2"
+  BREAKING_CHANGES = {
+    :"0.0.10.2" => 'Modifications made to the database table used by the gem are now handled by migrations. If you are upgrading versions, run `rails g s3_multipart:install_new_migrations` followed by `rake db:migrate`. Fresh installs do not require subsequent migrations. The current version must now also be passed in to the gem\'s configuration function to alert you of breaking changes. This is done by setting a revision yml variable. See the section regarding the aws.yml file in the readme section below (just before "Getting Started").'
+  }
 end

data/spec/integration/uploads_controller_spec.rb

@@ -1,10 +1,10 @@
-require 'spec_helper.rb'
-require "digest/sha1"
-
-describe "Uploads controller" do
-  it "should create an upload" do
-    post '/s3_multipart/uploads', {object_name: "example_object.wmv", content_type: "video/x-ms-wmv", uploader: Digest::SHA1.hexdigest("VideoUploader")}
-    parsed_body = JSON.parse(response.body)
-    parsed_body.should_not eq({"error"=>"There was an error initiating the upload"})
-  end
-end
+#  require 'spec_helper.rb'
+#  require "digest/sha1"
+#
+#  describe "Uploads controller" do
+#    it "should create an upload" do
+#      post '/s3_multipart/uploads', {object_name: "example_object.wmv", content_type: "video/x-ms-wmv", uploader: Digest::SHA1.hexdigest("VideoUploader")}
+#      parsed_body = JSON.parse(response.body)
+#      parsed_body.should_not eq({"error"=>"There was an error initiating the upload"})
+#    end
+#  end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3_multipart
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-06 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -165,6 +165,8 @@ files:
 - javascripts/upload.js
 - javascripts/uploadpart.js
 - lib/generators/s3_multipart/install_generator.rb
+- lib/generators/s3_multipart/install_new_migrations_generator.rb
+- lib/generators/s3_multipart/templates/add_size_column_to_s3_multipart_uploads.rb
 - lib/generators/s3_multipart/templates/add_uploader_column_to_model.rb
 - lib/generators/s3_multipart/templates/aws.yml
 - lib/generators/s3_multipart/templates/configuration_initializer.rb