media_gallery 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e55a087df0efcf0155fd1e4739413002f234b5ca
+  data.tar.gz: 72114fd4cdf5c04c1067825088c2b17c285d3356
+SHA512:
+  metadata.gz: ab487ca5d535874a64b366fc4f105ee64289d11b4c33fff6a48e703b1f55b43db196a14d86c0e28dbb243dadd97c7cea4ca2262de40002947153d37e4d73b004
+  data.tar.gz: 42bddb31cdf59a6a1e6ad747cee3525bf365fa6831cf158610970a06264bad41520dabcbc82d55d1bf85884974da36539fdf24feb1d02953fe3d5a609d895bf4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Martin Beauvais
+
+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,107 @@
+# 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.
+
+## Usage
+This section goes over the internals of the engine (i.e. how to integrate it) and the REST API itself (io.e. how to interact with the gallery).  It also describes how to run the unit and integration tests (if you so desire).
+
+### Internals
+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:
+
+```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:
+
+- current_user:  This method returns the current user
+- create_ability: Returns an Ability class for use in the media_gallery.
+
+The recommended approach for this is to create an initializer.  You can check out the one in spec/dummy app.  It defines something like:
+
+```ruby
+MediaGallery::ApplicationController.class_eval do
+
+  def current_user
+    User.find_by_token(request.headers['token'])
+  end
+
+  def create_ability(user)
+    Ability.new(user)
+  end
+end
+```
+### REST API
+The media_gallery uses a straightforward REST mechanism.  Here are a few samples:
+
+#### Creating gallery
+
+```json
+Request -> POST .../media_gallery/galleries
+{
+	"gallery": {
+		"description": "an updated text for description."		
+	}
+}
+
+Response ->
+{
+    "id": 1,
+    "name": "jdoe_gallery",
+    "description": "stores images for joe doe",
+    "nbImages": 0,
+    "createdAt": "2018-03-02T14:13:19.805Z"
+}
+```
+
+#### Updating a gallery
+
+```json
+Request -> PUT .../media_gallery/galleries/1
+{
+  "name": "jdoe_gallery",
+  "description": "stores images for joe doe"
+}
+
+Response ->
+{
+    "id": 1,
+    "ownable_id": 1,
+    "ownable_type": "User",
+    "description": "an updated text for description.",
+    "name": "jdoe_gallery",
+    "created_at": "2018-03-01T14:20:48.117Z",
+    "updated_at": "2018-03-01T14:21:38.612Z"
+}
+```
+
+#### Deleting a gallery
+
+```json
+Request -> DELETE .../media_gallery/galleries/1
+Response -> (Standard HTTP code, basically 200 or something equivalent)
+```
+
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'media_gallery'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install media_gallery
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MediaGallery'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/media_gallery/application_controller.rb

@@ -0,0 +1,28 @@
+module MediaGallery
+  class ApplicationController < ActionController::API
+
+    include CanCan::ControllerAdditions
+
+    rescue_from CanCan::AccessDenied do |exception|
+      render json: { message: "Access Denied" }, status: 403
+    end
+
+    rescue_from ActiveRecord::RecordInvalid do |exception|
+      render json: { message: exception.to_s }, status: 500
+    end
+
+    def current_user
+      raise 'You need to override the current_user.'
+    end
+
+    def create_ability(user)
+      raise 'You need to override the create_ability method.'
+    end
+
+    def current_ability
+      @current_ability ||= create_ability(current_user)
+    end
+
+  end
+
+end

data/app/controllers/media_gallery/galleries_controller.rb

@@ -0,0 +1,49 @@
+require_dependency "media_gallery/application_controller"
+
+module MediaGallery
+  class GalleriesController < ApplicationController
+
+    load_and_authorize_resource except: [ :index, :create ]
+
+    # GET /galleries
+    def index
+      @galleries = Gallery.where(ownable: current_user).order(name: :asc)
+      authorize! :read, @galleries[0] if @galleries.length > 0
+    end
+
+    # POST /galleries
+    def create
+      @gallery = Gallery.new(
+        name: gallery_params[:name],
+        ownable: current_user,
+        description: gallery_params[:description]
+      )
+      authorize! :create, @gallery
+      @gallery.save!
+    end
+
+    # GET /galleries/1
+    def show
+      authorize! :read, @gallery
+    end
+
+    # PATCH/PUT /galleries/1
+    def update
+      authorize! :update, @gallery
+      @gallery.update_attributes!(gallery_params)
+    end
+
+    # DELETE /galleries/1
+    def destroy
+      @gallery.destroy
+    end
+
+    private
+
+    # Only allow a trusted parameter "white list" through.
+    def gallery_params
+      params.require(:gallery).permit(:name, :description)
+    end
+
+  end
+end

data/app/controllers/media_gallery/image_infos_controller.rb

@@ -0,0 +1,49 @@
+require_dependency "media_gallery/application_controller"
+require "media_gallery/image_processing"
+
+module MediaGallery
+  class ImageInfosController < ApplicationController
+
+    load_and_authorize_resource :gallery
+    load_and_authorize_resource :image_info, through: :gallery, except: [ :index, :create ]
+
+    # GET /galleries/1/image_infos
+    def index
+    end
+
+    # GET /galleries/1/image_infos/1
+    def show
+    end
+
+    # 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!
+    end
+
+    # PATCH/PUT /galleries/1/image_infos/1
+    def update
+      authorize! :update, @image_info
+      @image_info.update_attributes!(image_info_params)
+    end
+
+    # DELETE /galleries/1/image_infos/1
+    def destroy
+      @image_info.destroy
+    end
+
+    private
+
+    # Only allow a trusted parameter "white list" through.
+    def image_info_params
+      params.require(:image_info).permit(:label, :description, :image)
+    end
+  end
+end

data/app/jobs/media_gallery/application_job.rb

@@ -0,0 +1,4 @@
+module MediaGallery
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/media_gallery/application_mailer.rb

@@ -0,0 +1,6 @@
+module MediaGallery
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/media_gallery/application_record.rb

@@ -0,0 +1,5 @@
+module MediaGallery
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/media_gallery/gallery.rb

@@ -0,0 +1,10 @@
+module MediaGallery
+  class Gallery < ApplicationRecord
+    belongs_to :ownable, polymorphic: true
+    has_many :image_infos, dependent: :destroy
+
+    validates_presence_of :name
+    validates :description, length: { maximum: 1024 }
+    validates_uniqueness_of :name, scope: :ownable, message: 'Gallery with this name already exists.'
+  end
+end

data/app/models/media_gallery/image_info.rb

@@ -0,0 +1,11 @@
+module MediaGallery
+  class ImageInfo < ApplicationRecord
+    belongs_to :gallery
+
+    mount_uploader :image, ImageUploader
+
+    validates :label, length: { maximum: 256 }, presence: true
+    validates :description, length: { maximum: 1024 }
+
+  end
+end

data/app/uploaders/media_gallery/image_uploader.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+require 'carrierwave'
+require 'fog'
+require 'carrierwave/orm/activerecord'
+
+module MediaGallery
+  class ImageUploader < CarrierWave::Uploader::Base
+    include CarrierWave::MiniMagick
+
+    storage :fog
+
+    # Override the directory where uploaded files will be stored.
+    # This is a sensible default for uploaders that are meant to be mounted:
+    def store_dir
+      "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+    end
+
+    version :thumb do
+      process :resize_to_fill => [300, 180]
+    end
+
+    version :thumb_high do
+      process :resize_to_fill => [180, 300]
+    end
+
+    version :banner_square do
+      process :resize_to_fill => [500, 500]
+    end
+
+    version :banner_main do
+      process :resize_to_fill => [850, 425]
+    end
+
+    version :thumb_tile do
+      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

@@ -0,0 +1,5 @@
+json.id gallery.id
+json.name gallery.name
+json.description gallery.description
+json.nbImages gallery.image_infos.size
+json.createdAt gallery.created_at

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

@@ -0,0 +1 @@
+json.partial! 'full_gallery', gallery: @gallery

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

@@ -0,0 +1,5 @@
+json.array! @galleries do |gallery|
+  json.id gallery.id
+  json.name gallery.name
+  json.nbImages gallery.image_infos.size
+end

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

@@ -0,0 +1 @@
+json.partial! 'full_gallery', gallery: @gallery

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

@@ -0,0 +1 @@
+json.partial! 'full_gallery', gallery: @gallery

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

@@ -0,0 +1,7 @@
+json.id image_info.id
+json.label image_info.label
+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

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

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

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

@@ -0,0 +1 @@
+json.partial! 'full_image_info', image_info: @image_info

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

@@ -0,0 +1,5 @@
+json.array! @gallery.image_infos.order(label: :asc) do |image_info|
+  json.id image_info.id
+  json.label image_info.label
+  json.partial! 'image_urls', image_info: image_info
+end

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

@@ -0,0 +1 @@
+json.partial! 'full_image_info', image_info: @image_info

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

@@ -0,0 +1 @@
+json.partial! 'full_image_info', image_info: @image_info

data/config/routes.rb

@@ -0,0 +1,5 @@
+MediaGallery::Engine.routes.draw do
+  resources :galleries do
+    resources :image_infos
+  end
+end

data/db/migrate/20180221141600_create_media_gallery_galleries.rb

@@ -0,0 +1,10 @@
+class CreateMediaGalleryGalleries < ActiveRecord::Migration[5.1]
+  def change
+    create_table :media_gallery_galleries do |t|
+      t.string :name, null: false
+      t.string :description, limit: 1024
+      t.references :ownable, polymorphic: true, index: true
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20180221155739_create_media_gallery_image_infos.rb

@@ -0,0 +1,11 @@
+class CreateMediaGalleryImageInfos < ActiveRecord::Migration[5.1]
+  def change
+    create_table :media_gallery_image_infos do |t|
+      t.string :label, null: false
+      t.string :description, limit: 1024
+      t.string :image
+      t.references :gallery, index: true
+      t.timestamps
+    end
+  end
+end

data/lib/media_gallery/engine.rb

@@ -0,0 +1,8 @@
+require 'cancancan'
+
+module MediaGallery
+  class Engine < ::Rails::Engine
+    isolate_namespace MediaGallery
+    config.generators.api_only = true
+  end
+end

data/lib/media_gallery/image_processing.rb

@@ -0,0 +1,20 @@
+module MediaGallery
+
+  module ImageProcessing
+
+    # Helper method that processes a b64 encoded image and returns
+    # the equivalent binary object.
+    def self.create_photo_file data, photo_params
+      imageContent = Base64.decode64(data)
+      tempfile = Tempfile.new("photoupload")
+      tempfile.binmode
+      tempfile << imageContent
+      tempfile.rewind
+      photo_params = photo_params.merge(:tempfile => tempfile)
+      photo = ActionDispatch::Http::UploadedFile.new(photo_params)
+      photo.original_filename = "photofile"
+      photo
+    end
+
+  end
+end

data/lib/media_gallery/version.rb

@@ -0,0 +1,3 @@
+module MediaGallery
+  VERSION = '1.0.0'
+end

data/lib/media_gallery.rb

@@ -0,0 +1,6 @@
+require "media_gallery/engine"
+require "carrierwave"
+
+module MediaGallery
+
+end

data/lib/tasks/media_gallery_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :media_gallery do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: media_gallery
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Martin Beauvais
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.3
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  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
+    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: 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: cancancan
+  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: rspec-rails
+  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: factory_bot_rails
+  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: pg
+  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: Offers a REST interface allowing the management of S3 images on a gallery
+  basis.
+email:
+- mbeauv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/media_gallery/application_controller.rb
+- app/controllers/media_gallery/galleries_controller.rb
+- app/controllers/media_gallery/image_infos_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/uploaders/media_gallery/image_uploader.rb
+- app/views/media_gallery/galleries/_full_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/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
+- config/routes.rb
+- db/migrate/20180221141600_create_media_gallery_galleries.rb
+- db/migrate/20180221155739_create_media_gallery_image_infos.rb
+- lib/media_gallery.rb
+- lib/media_gallery/engine.rb
+- lib/media_gallery/image_processing.rb
+- lib/media_gallery/version.rb
+- lib/tasks/media_gallery_tasks.rake
+homepage: https://github.com/mbeauv/media_gallery
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Allows for the storage of images on S3 on a gallery basis.
+test_files: []