s3_relay 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f09dca34c033813548f7fd621fd2cb57c8979a7b
-  data.tar.gz: eaacf64ab7bbc521f3899bc345f9df23f57ca06e
+  metadata.gz: 7eb3749db208e34c25730efc1bac3cdaa60cbbca
+  data.tar.gz: 5ab8beaaa957f5abcf41f687d82e2f7c06deea37
 SHA512:
-  metadata.gz: 77466db42281a43c75f81640408528e2ba01e026f04498daef1d0d204e4a551c86bea0d70131a4b7c7f0e39546a5def1f672df8cfa7a648b808f4022f2c100cd
-  data.tar.gz: 66818a2437cbbbd091ff420c7914233dc320358251ad51ea49270aa0a1f271ab95a6e237f16965aa8e0b1fec9acf821d9a642dc107e6f848ca8a1b2ddc2448b6
+  metadata.gz: 4d6166f156b612b5619c355a19b42ede0dc6572505cd301985916c809ac6822729dd30c92a58a25bb92fc14a10d3f2cc01047ad305372abc1b31e3d101a03b22
+  data.tar.gz: 28f2e274966d3a849afaa2ecbaaca004c28f7de45d7fd35b9c95da668c1a0a54cec1e83d6e9253f5c56217357fca44f28e82ebcf4dc575a2dcea2aeda22ba23e

data/README.md

@@ -147,7 +147,9 @@ option like so:
 <%= s3_relay_field @artist, :mp3_uploads, multiple: true, disposition: "attachment" %>
 ```
 
-### Process uploads asynchronously
+### Importing files
+
+#### Processing uploads asynchronously
 
 Use your background job processor of choice to process uploads pending
 ingestion (and image processing) by your app.
@@ -155,25 +157,52 @@ ingestion (and image processing) by your app.
 Say you're using [Resque](https://github.com/resque/resque) and [CarrierWave](https://github.com/carrierwaveuploader/carrierwave), you could define a job class:
 
 ```ruby
-class ProductPhotoImporter
+class ProductPhoto::Import
   @queue = :photo_import
 
-  def self.perform(product_id)
-    @product = Product.find(id)
+  def self.perform(product_id, upload_id)
+    @product = Product.find(product_id)
+    @upload  = S3Relay::Upload.find(upload_id)
 
-    @product.photo_uploads.pending.each do |upload|
-      @product.photos.create(remote_file_url: upload.private_url)
-      upload.mark_imported!
-    end
+    @product.photos.create!(remote_file_url: @upload.private_url)
+    @upload.mark_imported!
   end
 end
 ```
 
-Then, enqueue a job from your controller, callback, service object, etc.
-whenever there may be new uploads to process:
+#### Triggering upload imports for existing parent objects
+
+If you would like to immediately enqueue a job to begin importing an upload
+into its final desination, simply define a method on your parent object
+called `import_upload` and that method will be called after an `S3Relay::Upload`
+is created.
+
+#### Triggering upload imports for new parent objects
+
+If you would like to immediately enqueue a job to begin importing all of the
+uploads for a new parent object following its creation, you might want to setup
+a callback to enqueue those imports.
+
+#### Examples
 
 ```ruby
-Resque.enqueue(ProductPhotoImporter, product.id)
+class Product
+
+  # Called by s3_relay when an associated S3Relay::Upload object is created
+  def import_upload(upload_id)
+    Resque.enqueue(ProductPhoto::Import, id, upload_id)
+  end
+
+  after_commit :import_uploads, on: :create
+
+  # Called via after_commit to enqueue imports of S3Relay::Upload objects
+  def import_uploads
+    photo_uploads.pending.each do |upload|
+      Resque.enqueue(ProductPhoto::Import, id, upload.id)
+    end
+  end
+
+end
 ```
 
 ### Restricting the objects uploads can be associated with

data/app/assets/javascripts/s3_relay.coffee

@@ -4,6 +4,11 @@ displayFailedUpload = (progressColumn=null) ->
   else
     alert("File could not be uploaded")
 
+publishEvent = (name, detail) ->
+  ev = document.createEvent "CustomEvent"
+  ev.initCustomEvent name, true, false, detail
+  document.dispatchEvent ev
+
 saveUrl = (container, uuid, filename, contentType, publicUrl) ->
   privateUrl = null
 
@@ -21,6 +26,7 @@ saveUrl = (container, uuid, filename, contentType, publicUrl) ->
       public_url: publicUrl
     success: (data, status, xhr) ->
       privateUrl = data.private_url
+      publishEvent "upload:success", { uuid: uuid }
     error: (xhr) ->
       console.log xhr.responseText
 

data/lib/s3_relay/version.rb

@@ -1,3 +1,3 @@
 module S3Relay
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3_relay
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kenny Johnston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2016-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -212,8 +212,6 @@ files:
 - test/dummy/config/secrets.yml
 - test/dummy/db/migrate/20141021002149_create_products.rb
 - test/dummy/db/schema.rb
-- test/dummy/log/development.log
-- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -247,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Direct uploads to S3 and ingestion by your Rails app.
@@ -283,8 +281,6 @@ test_files:
 - test/dummy/config.ru
 - test/dummy/db/migrate/20141021002149_create_products.rb
 - test/dummy/db/schema.rb
-- test/dummy/log/development.log
-- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html

data/test/dummy/log/development.log

@@ -1,53 +0,0 @@
-   (6.8ms)  CREATE TABLE "schema_migrations" ("version" character varying(255) NOT NULL) 
-   (3.9ms)  CREATE UNIQUE INDEX  "unique_schema_migrations" ON "schema_migrations"  ("version")
-  ActiveRecord::SchemaMigration Load (0.3ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-Migrating to CreateS3RelayUploads (20141009000804)
-   (0.1ms)  BEGIN
-   (5.3ms)  CREATE TABLE "s3_relay_uploads" ("id" serial primary key, "parent_type" character varying(255), "parent_id" integer, "uuid" bytea, "filename" text, "content_type" character varying(255), "state" character varying(255), "data" json DEFAULT '{}', "uploaded_at" timestamp, "imported_at" timestamp, "created_at" timestamp, "updated_at" timestamp) 
-  SQL (0.6ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1)  [["version", "20141009000804"]]
-   (0.5ms)  COMMIT
-  ActiveRecord::SchemaMigration Load (0.2ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-   (5.7ms)  CREATE TABLE "schema_migrations" ("version" character varying(255) NOT NULL) 
-   (1.6ms)  CREATE UNIQUE INDEX  "unique_schema_migrations" ON "schema_migrations"  ("version")
-  ActiveRecord::SchemaMigration Load (0.4ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-Migrating to CreateS3RelayUploads (20141009000804)
-   (0.1ms)  BEGIN
-   (3.8ms)  CREATE TABLE "s3_relay_uploads" ("id" serial primary key, "parent_type" character varying(255), "parent_id" integer, "uuid" bytea, "filename" text, "content_type" character varying(255), "state" character varying(255), "data" json DEFAULT '{}', "pending_at" timestamp, "imported_at" timestamp, "created_at" timestamp, "updated_at" timestamp) 
-  SQL (0.5ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1)  [["version", "20141009000804"]]
-   (0.6ms)  COMMIT
-  ActiveRecord::SchemaMigration Load (0.2ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-  ActiveRecord::SchemaMigration Load (25.7ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-Migrating to CreateProducts (20141021002149)
-   (0.2ms)  BEGIN
-   (69.1ms)  CREATE TABLE "products" ("id" serial primary key, "name" character varying(255), "created_at" timestamp, "updated_at" timestamp) 
-  SQL (4.9ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1)  [["version", "20141021002149"]]
-   (5.7ms)  COMMIT
-  ActiveRecord::SchemaMigration Load (0.2ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-   (6.1ms)  CREATE TABLE "schema_migrations" ("version" character varying(255) NOT NULL) 
-   (1.9ms)  CREATE UNIQUE INDEX  "unique_schema_migrations" ON "schema_migrations"  ("version")
-  ActiveRecord::SchemaMigration Load (0.4ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-Migrating to CreateS3RelayUploads (20141009000804)
-   (0.1ms)  BEGIN
-   (4.7ms)  CREATE TABLE "s3_relay_uploads" ("id" serial primary key, "uuid" bytea, "parent_type" character varying(255), "parent_id" integer, "upload_type" character varying(255), "filename" text, "content_type" character varying(255), "state" character varying(255), "data" json DEFAULT '{}', "pending_at" timestamp, "imported_at" timestamp, "created_at" timestamp, "updated_at" timestamp) 
-  SQL (0.8ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1)  [["version", "20141009000804"]]
-   (0.8ms)  COMMIT
-Migrating to CreateProducts (20141021002149)
-   (0.3ms)  BEGIN
-   (5.1ms)  CREATE TABLE "products" ("id" serial primary key, "name" character varying(255), "created_at" timestamp, "updated_at" timestamp) 
-  SQL (0.2ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1)  [["version", "20141021002149"]]
-   (0.6ms)  COMMIT
-  ActiveRecord::SchemaMigration Load (0.4ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-   (20.7ms)  CREATE TABLE "schema_migrations" ("version" character varying(255) NOT NULL) 
-   (9.3ms)  CREATE UNIQUE INDEX  "unique_schema_migrations" ON "schema_migrations"  ("version")
-  ActiveRecord::SchemaMigration Load (0.4ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-Migrating to CreateS3RelayUploads (20141009000804)
-   (0.1ms)  BEGIN
-   (24.8ms)  CREATE TABLE "s3_relay_uploads" ("id" serial primary key, "uuid" bytea, "user_id" integer, "parent_type" character varying(255), "parent_id" integer, "upload_type" character varying(255), "filename" text, "content_type" character varying(255), "state" character varying(255), "data" json DEFAULT '{}', "pending_at" timestamp, "imported_at" timestamp, "created_at" timestamp, "updated_at" timestamp) 
-  SQL (6.2ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1)  [["version", "20141009000804"]]
-   (6.0ms)  COMMIT
-Migrating to CreateProducts (20141021002149)
-   (11.0ms)  BEGIN
-   (9.0ms)  CREATE TABLE "products" ("id" serial primary key, "name" character varying(255), "created_at" timestamp, "updated_at" timestamp) 
-  SQL (1.3ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1)  [["version", "20141021002149"]]
-   (0.9ms)  COMMIT
-  ActiveRecord::SchemaMigration Load (0.3ms)  SELECT "schema_migrations".* FROM "schema_migrations"