media_gallery 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d443c952fab62c79a265ef111c88f26537f6f79a
-  data.tar.gz: b0663082367eaad50c7ff4dcaff339636d391a56
+  metadata.gz: 238233271366fe9736f4e19fa6f45edc8ee2463e
+  data.tar.gz: ec3de21bec7e82a8a80cc117d0e9f8b915364132
 SHA512:
-  metadata.gz: d9799352c1beaa08a381758d545331d4d5350fd342e3a31bf7edc2c0b0bf6bbe40d8494338e6f4b9756f2048aec0e8d5be0830e8350746072d69b9c6ef145c1b
-  data.tar.gz: bef257b487d175170b64da42448b9cc187b5fb0f2ef69309d836eafdf0c01f2ffc860b2b65e5d3447eec9f70518aeb076aedaa10f9215d574fbb7e53d5990ab0
+  metadata.gz: f88efceb98ad382ba7d5fdd81848266e876a31aff8184e68bd9eb6f3ffadcfe89164746d84f2ad35024290f514528276916377a409db3f372506376741aa2bf0
+  data.tar.gz: abcc22d093e4947a6df4196a414c4e75aa0e5506b15b3d23ac48ace56f6c620be85579f42837510636ec2c4df529c5dbefd4035bf0f5b0d0221a390687a951d0

data/README.md

@@ -1,19 +1,19 @@
 # MediaGallery
-This gem provides a Rails engine allowing for the storage of images on Amazon S3.  Images are organized in galleries.  All interactions are done through a simple REST API.
+This gem provides a Rails engine that allows for the storage of images on Amazon S3.  Images are organized in galleries.  All interactions are done through a simple [REST API](https://github.com/mbeauv/media_gallery/wiki/REST-API).
 
 ## Usage
-As this is a Rails engine, you need to first mount the engine.  This can be done by modifying your config/routes.rb file.  You should add a mount point, something like:
+As this is a Rails engine, you need to mount it in your app. This can be done by modifying your config/routes.rb file.  You can add a line like:
 
 ```ruby
 mount MediaGallery::Engine => "/media_gallery"
 ```
 
-Next, you need to deal with access control. media_gallery uses cancancan for access_control. It does not make any assumptions as to what sign in strategy you use.  It should work fine with Devise if that's what you use.  There are two methods in the MediaGallerythat need to be overridden:
+Next, you need to deal with access control. The media_gallery engine uses [cancancan](https://github.com/CanCanCommunity/cancancan) for access_control. It does not make any assumptions as to what library or method you use for sign in.  It works fine with [Devise](https://github.com/plataformatec/devise) if that is what you are using.  JWT access will also work. You do need to override two methods in the MediaGallery::ApplicationController class.  These methods are:
 
-- current_user:  This method returns the current user
-- create_ability: Returns an Ability class for use in the media_gallery.
+- current_user:  Returns the current user
+- create_ability: Returns an cancan Ability class for use in the media_gallery.  It can be your app's defined ability.
 
-The recommended approach for this is to create an initializer.  You can check out the one in spec/dummy app.  It defines something like:
+The recommended approach for this is to create an initializer.  You can check out the one defined in the [spec/dummy](https://github.com/mbeauv/media_gallery/blob/master/spec/dummy/config/initializers/media_gallery_initializer.rb) test app.  It defines something like:
 
 ```ruby
 MediaGallery::ApplicationController.class_eval do
@@ -27,8 +27,41 @@ MediaGallery::ApplicationController.class_eval do
   end
 end
 ```
+You can also look at an example of how this can be done with Devise [here](https://github.com/mbeauv/media_gallery/wiki/Integration-with-Devise).
 
-You can check some API samples on the wiki page.
+Lastly, media_gallery uses [carrierwave](https://github.com/carrierwaveuploader/carrierwave) to interact with the S3 storage system.  Carrierwave needs to be configured appropriately.  The way we do it is through another initializer file (e.g. config/initializers/carrierwave_s3.rb) which defines something like:
+
+```ruby
+class FogSettings
+
+  def self.S3
+    {
+      :provider               => 'AWS',
+      :aws_access_key_id      => ENV['MEDIA_GALLERY_TEST_AWS_PUBLIC'],
+      :aws_secret_access_key  => ENV['MEDIA_GALLERY_TEST_AWS_SECRET']
+    }
+  end
+
+  def self.directory
+    ENV['MEDIA_GALLERY_TEST_AWS_DIR']
+  end
+
+end
+
+CarrierWave.configure do |config|
+
+  config.fog_credentials = FogSettings.S3
+  config.fog_directory   = FogSettings.directory
+
+  #The following is specifically for Heroku.  Heroku only allows you to save data
+  #in the tmp folder.  We therefore make sure that the tmp files are put there.
+  #See https://github.com/jnicklas/carrierwave/wiki/How-to%3A-Make-Carrierwave-work-on-Heroku
+  config.cache_dir = "#{Rails.root}/tmp/uploads"
+
+end
+```
+
+In the previous block, the MEDIA_GALLERY_TEST_AWS... keys are fed from the environment.  You can use whatever approach you want.  If deploying in Heroku or AWS, it's better to use this approach as your deployed code does not have hardcoded values.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -54,7 +87,25 @@ bin/rails media_gallery:install:migrations
 bin/rails db:migrate SCOPE=media_gallery
 ```
 ## Contributing
-Contribution directions go here.
+
+If you want to help out, no problem. The more, the merrier.  You can fix issues if you want to or look at the list of outstanding features here.
+
+Make sure that you write unit tests. We presently have model and request specs.  The request specs require you to have an AWS account with S3 setup correctly.  You then need to define three environment variables:
+
+- MEDIA_GALLERY_TEST_AWS_PUBLIC
+- MEDIA_GALLERY_TEST_AWS_SECRET
+- MEDIA_GALLERY_TEST_AWS_DIR
+
+The rspecs look for these variables in your environment.  On Linux or Mac, you can add something like this to you .bash_profile
+
+```bash
+export MEDIA_GALLERY_TEST_AWS_PUBLIC=AJEJEKNJE87JS 
+export MEDIA_GALLERY_TEST_AWS_SECRET=Bskljfslkdjflksjflkjslls+sljksjlk
+export MEDIA_GALLERY_TEST_AWS_DIR=gallery2018
+```
+
+(All values provided in the previous block are fake... obviously :-)
+
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/controllers/media_gallery/application_controller.rb

@@ -4,11 +4,27 @@ module MediaGallery
     include CanCan::ControllerAdditions
 
     rescue_from CanCan::AccessDenied do |exception|
-      render json: { message: "Access Denied" }, status: 403
+      render json: { message: "Access Denied." }, status: 403
     end
 
     rescue_from ActiveRecord::RecordInvalid do |exception|
-      render json: { message: exception.to_s }, status: 500
+      render json: { message: exception.to_s }, status: 409
+    end
+
+    rescue_from ActionController::ParameterMissing do |exception|
+      render json: { message: "Invalid content." }, status: 400
+    end
+
+    rescue_from ActiveRecord::RecordNotFound do |exception|
+      render json: { message: "Access Denied." }, status: 403
+    end
+
+    rescue_from MediaGallery::ScratchImageEmpty do |exception|
+      render json: { message: 'No scratch image found.' }, status: 400
+    end
+
+    rescue_from MediaGallery::ImageMissing do |exception|
+      render json: { message: 'Image missing.' }, status: 400
     end
 
     def current_user

data/app/controllers/media_gallery/galleries_controller.rb

@@ -7,6 +7,7 @@ module MediaGallery
 
     # GET /galleries
     def index
+      raise CanCan::AccessDenied.new unless current_user
       @galleries = Gallery.where(ownable: current_user).order(name: :asc)
       authorize! :read, @galleries[0] if @galleries.length > 0
     end

data/app/controllers/media_gallery/image_infos_controller.rb

@@ -17,15 +17,9 @@ module MediaGallery
 
     # POST /galleries/1/image_infos
     def create
-      image_file = MediaGallery::ImageProcessing.create_photo_file(image_info_params['image'], {})
-      @image_info = ImageInfo.new(
-        label: image_info_params[:label],
-        description: image_info_params[:description],
-        gallery: @gallery,
-        image: image_file
-      )
-      authorize! :create, @image_info
-      @image_info.save!
+      @image_info = use_scratch?(params) ?
+                      process_with_scratch(params, @gallery) :
+                      process_with_image(params, @gallery)
     end
 
     # PATCH/PUT /galleries/1/image_infos/1
@@ -41,9 +35,50 @@ module MediaGallery
 
     private
 
+    # Verifies if the image version saved in the user's scratch pad should
+    # be used.
+    def use_scratch?(params)
+      params[:use_scratch] && params[:use_scratch] == 'true'
+    end
+
     # Only allow a trusted parameter "white list" through.
     def image_info_params
-      params.require(:image_info).permit(:label, :description, :image)
+      params.require(:image_info).permit(:name, :description, :image)
+    end
+
+    def process_with_image(params, gallery)
+      raise MediaGallery::ImageMissing unless image_info_params['image'];
+      ActiveRecord::Base.transaction do
+        image_info = ImageInfo.create!(
+          name: image_info_params[:name],
+          description: image_info_params[:description],
+          gallery: gallery
+        )
+        ImageVersion.create!(image: image_info_params['image'], ownable: image_info)
+        authorize! :create, image_info
+        image_info.save!
+        image_info
+      end
+    end
+
+    def process_with_scratch(params, gallery)
+      image_scratch = ImageScratch.where(ownable: current_user).first
+      raise MediaGallery::ScratchImageEmpty unless image_scratch;
+
+      image_info = ImageInfo.new(
+        name: image_info_params[:name],
+        description: image_info_params[:description],
+        gallery: gallery,
+        image_version: image_scratch.image_version
+      )
+
+      ActiveRecord::Base.transaction do
+        image_scratch.update(image_version: nil);
+        image_scratch.destroy
+        authorize! :create, image_info
+        image_info.save!
+        image_info
+      end
     end
   end
 end

data/app/controllers/media_gallery/image_scratches_controller.rb

@@ -0,0 +1,42 @@
+require_dependency "media_gallery/application_controller"
+require "media_gallery/image_processing"
+
+module MediaGallery
+  class ImageScratchesController < ApplicationController
+
+    # GET /image_scratches
+    def index
+      raise CanCan::AccessDenied.new unless current_user
+      @scratches = ImageScratch.where(ownable: current_user).all
+      (authorize! :read, @scratches[0]) unless @scratches.empty?
+    end
+
+    # POST /image_scratches
+    def create
+      ImageScratch.where(ownable: current_user).destroy_all
+
+      # The persistence code that follows is suboptimal.  I'm a bit tired
+      # right now.  Don't see it. Needs to be fixed.  Issue should be raised.
+      # TODO Raise issue here.
+      ActiveRecord::Base.transaction do
+        @scratch = ImageScratch.new(ownable: current_user);
+        authorize! :create, @scratch
+        @scratch.save!
+        @scratch.image_version = ImageVersion.new(image: image_scratch_params[:image], ownable: @scratch);
+        @scratch.save!
+      end
+
+    end
+
+    # DELETE /image_scratches/1
+    def destroy
+      ImageScratch.destroy_all(ownable: current_user)
+    end
+
+    private
+    # Only allow a trusted parameter "white list" through.
+    def image_scratch_params
+      params.require(:image_scratch).permit(:image)
+    end
+  end
+end

data/app/models/media_gallery/image_info.rb

@@ -2,9 +2,9 @@ module MediaGallery
   class ImageInfo < ApplicationRecord
     belongs_to :gallery
 
-    mount_uploader :image, ImageUploader
+    has_one :image_version, as: :ownable, dependent: :destroy
 
-    validates :label, length: { maximum: 256 }, presence: true
+    validates :name, length: { maximum: 256 }, uniqueness: { scope: :gallery }, presence: true
     validates :description, length: { maximum: 1024 }
 
   end

data/app/models/media_gallery/image_scratch.rb

@@ -0,0 +1,6 @@
+module MediaGallery
+  class ImageScratch < ApplicationRecord
+    belongs_to :ownable, polymorphic: true, autosave: true
+    belongs_to :image_version, optional: true, autosave: true
+  end
+end

data/app/models/media_gallery/image_version.rb

@@ -0,0 +1,7 @@
+module MediaGallery
+  class ImageVersion < ApplicationRecord
+    belongs_to :ownable, polymorphic: true
+
+    mount_base64_uploader :image, ImageUploader
+  end
+end

data/app/uploaders/media_gallery/image_uploader.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require 'carrierwave'
+require 'carrierwave/base64'
 require 'fog'
 require 'carrierwave/orm/activerecord'
 
@@ -35,37 +36,6 @@ module MediaGallery
       process :resize_to_fill => [80, 80]
     end
 
-    # Provide a default URL as a default if there hasn't been a file uploaded:
-    # def default_url(*args)
-    #   # For Rails 3.1+ asset pipeline compatibility:
-    #   # ActionController::Base.helpers.asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
-    #
-    #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
-    # end
-
-    # Process files as they are uploaded:
-    # process scale: [200, 300]
-    #
-    # def scale(width, height)
-    #   # do something
-    # end
-
-    # Create different versions of your uploaded files:
-    # version :thumb do
-    #   process resize_to_fit: [50, 50]
-    # end
-
-    # Add a white list of extensions which are allowed to be uploaded.
-    # For images you might use something like this:
-    # def extension_whitelist
-    #   %w(jpg jpeg gif png)
-    # end
-
-    # Override the filename of the uploaded files:
-    # Avoid using model.id or version_name here, see uploader/store.rb for details.
-    # def filename
-    #   "something.jpg" if original_filename
-    # end
   end
 
 end

data/app/views/media_gallery/galleries/_full_gallery.json.jbuilder

@@ -1,5 +1,12 @@
 json.id gallery.id
 json.name gallery.name
 json.description gallery.description
-json.nbImages gallery.image_infos.size
 json.createdAt gallery.created_at
+json.imageInfos do
+  json.array! gallery.image_infos do |image_info|
+    json.id image_info.id
+    json.name image_info.name
+    json.url image_info.image_version.image.url(:thumb_tile)
+    json.createdAt image_info.created_at
+  end
+end

data/app/views/media_gallery/galleries/_partial_gallery.json.jbuilder

@@ -0,0 +1,4 @@
+json.id gallery.id
+json.name gallery.name
+json.description gallery.description
+json.nbImages gallery.image_infos.size

data/app/views/media_gallery/galleries/index.json.jbuilder

@@ -1,5 +1,3 @@
 json.array! @galleries do |gallery|
-  json.id gallery.id
-  json.name gallery.name
-  json.nbImages gallery.image_infos.size
+  json.partial! 'partial_gallery', gallery: gallery
 end

data/app/views/media_gallery/image_infos/_full_image_info.json.jbuilder

@@ -1,7 +1,8 @@
 json.id image_info.id
-json.label image_info.label
+json.name image_info.name
 json.galleryId image_info.gallery.id
 json.galleryName image_info.gallery.name
 json.description image_info.description
 json.createdAt image_info.created_at
-json.partial! 'image_urls', image_info: image_info
+json.originalUrl image_info.image_version.image.url
+json.partial! 'image_versions', image_info: image_info

data/app/views/media_gallery/image_infos/_image_versions.json.jbuilder

@@ -0,0 +1,6 @@
+json.versions do
+  json.array! image_info.image_version.image.versions do |key, version|
+    json.name key
+    json.url version.url
+  end
+end

data/app/views/media_gallery/image_infos/index.json.jbuilder

@@ -1,5 +1,6 @@
-json.array! @gallery.image_infos.order(label: :asc) do |image_info|
+json.array! @gallery.image_infos.order(name: :asc) do |image_info|
   json.id image_info.id
-  json.label image_info.label
-  json.partial! 'image_urls', image_info: image_info
+  json.name image_info.name
+  json.originalUrl image_info.image_version.image.url
+  json.partial! 'image_versions', image_info: image_info
 end

data/app/views/media_gallery/image_scratches/create.json.jbuilder

@@ -0,0 +1,8 @@
+json.id @scratch.id
+json.imageVersionId @scratch.image_version.id
+json.variants do
+  json.array! @scratch.image_version.image.versions do |key, version|
+    json.name key
+    json.url version.url
+  end
+end

data/app/views/media_gallery/image_scratches/index.json.jbuilder

@@ -0,0 +1,9 @@
+json.array! @scratches do |scratch|
+  json.id scratch.id
+  json.versions do
+    json.array! scratch.image_version.image.versions do |key, version|
+      json.name key
+      json.url version.url
+    end
+  end
+end

data/config/routes.rb

@@ -1,4 +1,5 @@
 MediaGallery::Engine.routes.draw do
+  resources :image_scratches, only: [ :create, :index, :destroy ]
   resources :galleries do
     resources :image_infos
   end

data/db/migrate/20180323061055_create_media_gallery_image_versions.rb

@@ -0,0 +1,10 @@
+class CreateMediaGalleryImageVersions < ActiveRecord::Migration[5.1]
+  def change
+    create_table :media_gallery_image_versions do |t|
+      t.references :ownable, polymorphic: true, index: { name: 'image_version_ownable_index' }
+      t.string :image
+      t.timestamps
+    end
+    remove_column :media_gallery_image_infos, :image, :string
+  end
+end

data/db/migrate/20180323075708_create_media_gallery_image_scratches.rb

@@ -0,0 +1,9 @@
+class CreateMediaGalleryImageScratches < ActiveRecord::Migration[5.1]
+  def change
+    create_table :media_gallery_image_scratches do |t|
+      t.references :ownable, polymorphic: true, index: { name: 'image_scratch_ownable_index' }
+      t.belongs_to :image_version, foreign_key: { to_table: :media_gallery_image_versions }
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180327140541_add_name_to_media_gallery_image_infos.rb

@@ -0,0 +1,19 @@
+class AddNameToMediaGalleryImageInfos < ActiveRecord::Migration[5.1]
+
+  class MediaGallery::ImageInfo < ActiveRecord::Base
+  end
+
+  def self.up
+    add_column :media_gallery_image_infos, :name, :string
+    remove_column :media_gallery_image_infos, :label
+    MediaGallery::ImageInfo.find_each do |info|
+      info.name = "name_#{info.id}"
+      info.save!
+    end
+  end
+
+  def self.down
+    remove_column :media_gallery_image_infos, :name
+    add_column :media_gallery_image_infos, :label, :string
+  end
+end

data/lib/media_gallery.rb

@@ -3,4 +3,14 @@ require "carrierwave"
 
 module MediaGallery
 
+  # Exception generated when the user does not have a scratch image
+  # when it is required.
+  class ScratchImageEmpty < StandardError
+  end
+
+  # Exception generated when an image needs to be present in the
+  # params section of the message (e.g. ImageInfoController::create).
+  class ImageMissing < StandardError
+  end
+
 end

data/lib/media_gallery/version.rb

@@ -1,3 +1,3 @@
 module MediaGallery
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: media_gallery
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Martin Beauvais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-03 00:00:00.000000000 Z
+date: 2018-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: carrierwave-base64
+  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: fog
   requirement: !ruby/object:Gem::Requirement
@@ -136,26 +150,35 @@ files:
 - app/controllers/media_gallery/application_controller.rb
 - app/controllers/media_gallery/galleries_controller.rb
 - app/controllers/media_gallery/image_infos_controller.rb
+- app/controllers/media_gallery/image_scratches_controller.rb
 - app/jobs/media_gallery/application_job.rb
 - app/mailers/media_gallery/application_mailer.rb
 - app/models/media_gallery/application_record.rb
 - app/models/media_gallery/gallery.rb
 - app/models/media_gallery/image_info.rb
+- app/models/media_gallery/image_scratch.rb
+- app/models/media_gallery/image_version.rb
 - app/uploaders/media_gallery/image_uploader.rb
 - app/views/media_gallery/galleries/_full_gallery.json.jbuilder
+- app/views/media_gallery/galleries/_partial_gallery.json.jbuilder
 - app/views/media_gallery/galleries/create.json.jbuilder
 - app/views/media_gallery/galleries/index.json.jbuilder
 - app/views/media_gallery/galleries/show.json.jbuilder
 - app/views/media_gallery/galleries/update.json.jbuilder
 - app/views/media_gallery/image_infos/_full_image_info.json.jbuilder
-- app/views/media_gallery/image_infos/_image_urls.json.jbuilder
+- app/views/media_gallery/image_infos/_image_versions.json.jbuilder
 - app/views/media_gallery/image_infos/create.json.jbuilder
 - app/views/media_gallery/image_infos/index.json.jbuilder
 - app/views/media_gallery/image_infos/show.json.jbuilder
 - app/views/media_gallery/image_infos/update.json.jbuilder
+- app/views/media_gallery/image_scratches/create.json.jbuilder
+- app/views/media_gallery/image_scratches/index.json.jbuilder
 - config/routes.rb
 - db/migrate/20180221141600_create_media_gallery_galleries.rb
 - db/migrate/20180221155739_create_media_gallery_image_infos.rb
+- db/migrate/20180323061055_create_media_gallery_image_versions.rb
+- db/migrate/20180323075708_create_media_gallery_image_scratches.rb
+- db/migrate/20180327140541_add_name_to_media_gallery_image_infos.rb
 - lib/media_gallery.rb
 - lib/media_gallery/engine.rb
 - lib/media_gallery/image_processing.rb

data/app/views/media_gallery/image_infos/_image_urls.json.jbuilder

@@ -1,6 +0,0 @@
-json.urls do
-  image = image_info.image
-  image.versions.keys.each do |key|
-    json.set! "#{key}", image.versions[key].url
-  end
-end