has_media 0.2.1 → 0.2.2

data/README.rdoc

@@ -70,8 +70,13 @@ Configuration take place in config/initializers/has_media.rb
   # Set custom error messages
   HasMedia.errors_messages = {:type_error => I18n.t('has_media.errors.type_error')}
 
-  # Set the allowed medium types for your application (used if no :only option given)
-  HasMedia.medium_types = [Image, Video, Audio]
+  # Set the allowed medium types (used if no :only option given) for you application
+  # Set the allowed mime types for each medium type
+  HasMedia.medium_types = {
+    "Image" => ["image/jpeg", "image/png"],
+    "Video" => ["video/mp4"],
+    "Audio" => ["audio/mp3"]
+  }
 
   # Set the extension of encoded files to use for each medium types (used in file_uri and file_path)
   HasMedia.encoded_extensions = {
@@ -85,6 +90,53 @@ Configuration take place in config/initializers/has_media.rb
     require uploader
   end
 
+== Encode with resque
+
+Just add a callback on media class you want to encode via resque.
+
+Example :
+
+file : app/models/my_model_with_media.rb
+
+  class MyModelWithMedia < ActiveRecord::Base
+    has_one_medium  :avatar, :only => :my_media
+  end
+
+file : app/models/my_media.rb
+
+  class MyMedia < Medium
+    mount_uploader :file, MyMediaUploader
+    after_save :enqueue_encoding
+
+    def enqueue_encoding
+      Resque.enqueue(EncodeMyMedia, File.join(Rails.root, self.original_file_path))
+    end
+  end
+
+file : resque/tasks/encode_my_media.rb
+
+  class EncodeMyMedia
+    @queue = :my_media
+    include Magick
+  
+    def self.perform(file)
+      img = Image.read(file).first
+      img.thumbnail(50, 50).write(file.gsub(/\.[^.]+$/, "") + "_thumb.png")
+    end 
+  end
+
+Then you can manage your media like this : 
+
+  @model = MyModelWithMedia.new
+  @model.avatar = File.open("my_file.jpg")
+  @model.save
+  @model.avatar.original_file_uri 	=> "/media/my_media/:id/my_file.jpg"
+  @model.avatar.file_uri('thumb') 	=> "/media/my_media/:id/my_file_thumb.jpg"
+
+== Example application
+
+https://github.com/klacointe/has_media_example
+
 == Testing
 
 Factory example using factory_girl :
@@ -100,9 +152,7 @@ Factory example using factory_girl :
 
 == Todo
 - Doc for testing (ActionController::TestUploadedFile is now obsolete in rails 3), add HasMediaTestHelper with stub_temp_file method
-- Generator for initializer
 - Add controller and views examples with overload system (form fields, display, ...)
-- Fix problem with migrations generator timestamps
 - Generator for models and uploaders (Type in Image, Video, Audio, Pdf) : rails generate has_media_model Type Name
 - Document code
 - add example app on github

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/examples/models/audio.rb

@@ -1,9 +1,4 @@
 class Audio < Medium
   set_table_name 'media'
-
   mount_uploader :file, AudioUploader
-
-  def self.handle_content_type?(content_type)
-    content_type.starts_with? 'audio/'
-  end
 end

data/examples/models/image.rb

@@ -1,9 +1,4 @@
 class Image < Medium
   set_table_name 'media'
-
   mount_uploader :file, ImageUploader
-
-  def self.handle_content_type?(content_type)
-    content_type.starts_with? 'image/'
-  end
 end

data/examples/models/pdf.rb

@@ -1,9 +1,4 @@
 class Pdf < Medium
   set_table_name 'media'
-
   mount_uploader :file, PdfUploader
-
-  def self.handle_content_type?(content_type)
-    content_type.include?('pdf')
-  end
 end

data/examples/models/video.rb

@@ -1,9 +1,4 @@
 class Video < Medium
   set_table_name 'media'
-
   mount_uploader :file, VideoUploader
-
-  def self.handle_content_type?(content_type)
-    content_type.starts_with? 'audio/'
-  end
 end

data/has_media.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{has_media}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["klacointe", "spk"]
-  s.date = %q{2010-11-02}
+  s.date = %q{2010-11-05}
   s.description = %q{Media Managment Library for ActiveRecord and Carrierwave}
   s.email = %q{kevinlacointe@gmail.com}
   s.extra_rdoc_files = [

data/lib/generators/active_record/has_media_generator.rb

@@ -9,7 +9,7 @@ module ActiveRecord
       source_root File.expand_path("../templates", __FILE__)
 
       def copy_has_media_migration
-        migration_template "migration.rb", "db/migrate/has_media"
+        migration_template "migration.rb", "db/migrate/create_has_media"
       end
 
       # Implement the required interface for Rails::Generators::Migration.

data/lib/generators/active_record/templates/migration.rb

@@ -1,4 +1,4 @@
-class HasMedia < ActiveRecord::Migration
+class CreateHasMedia < ActiveRecord::Migration
   def self.up
     create_table :media do |t|
       t.integer  :width
@@ -12,6 +12,7 @@ class HasMedia < ActiveRecord::Migration
       t.string   :type          # required
       t.string   :status
       t.string   :context       # required
+      t.string   :file          # used by carrierwave
       t.timestamps
     end
     add_index :media, :encode_status

data/lib/generators/templates/has_media.rb

@@ -4,10 +4,16 @@ HasMedia.directory_path = "media"
 # Set the base uri to access media
 HasMedia.directory_uri = "/media"
 
-# Set the allowed medium types for your application (used if no :only option given)
-#HasMedia.medium_types = [Image, Video, Audio]
+# Set the allowed medium types for you application
+# Set the allowed mime types for each medium type
+#HasMedia.medium_types = {
+#  "Image" => ["image/jpeg", "image/png"],
+#  "Video" => ["video/mp4"],
+#  "Audio" => ["audio/mp3"]
+#}
 
-# Set the extension of encoded files to use for each medium types (used in file_uri and file_path)
+# Set the extension of encoded files to use for each medium types 
+# This is used in file_uri and file_path
 #HasMedia.encoded_extensions = {
 #  :image => 'png',
 #  :audio => 'ogg',

data/lib/has_media/models/medium.rb

@@ -15,22 +15,9 @@ class Medium < ActiveRecord::Base
   ENCODE_NOT_READY = 4
   NO_ENCODING      = 5
 
-  # Allowed MIME types for upload
-  # need custom configuration
-  # TODO: add errors if not type of file
-  @@mime_types = {
-    :video => HasMedia.videos_content_types,
-    :image => HasMedia.images_content_types,
-    :audio => ['audio/mpeg', 'audio/x-ms-wma', 'audio/x-wav'],
-    :flash => ['application/x-shockwave-flash'],
-    :pdf   => ['application/pdf'],
-  }
-
-  # TODO : check that carrierwave destroy files on after detroy hook
   after_destroy :remove_file_from_fs
   after_initialize  :set_default_encoding_status
 
-
   scope :with_context, lambda {|context|
     { :conditions => { :context => context.to_s} }
   }
@@ -51,14 +38,12 @@ class Medium < ActiveRecord::Base
       mime_type = MIME::Types.type_for(value.path).first.content_type
     end
     only ||= ""
-    medium_types = HasMedia.medium_types
+    medium_types = HasMedia.medium_types.keys.collect{|c| Kernel.const_get(c)}
     if only != "" and klass = Kernel.const_get(only.camelize)
       medium_types = [klass]
     end
     klass = medium_types.find do |k|
-      if k.respond_to?(:handle_content_type?)
-        k.handle_content_type?(mime_type)
-      end
+      HasMedia.medium_types[k.to_s].include?(mime_type)
     end
     if klass.nil?
       object.media_errors = [HasMedia.errors_messages[:type_error]]

data/lib/has_media/uploaders/medium_uploader.rb

@@ -2,9 +2,7 @@
 
 class MediumUploader < CarrierWave::Uploader::Base
 
-  # Choose what kind of storage to use for this uploader
   storage :file
-  #     storage :s3
 
   # Override the directory where uploaded files will be stored
   # This is a sensible default for uploaders that are meant to be mounted:
@@ -12,4 +10,10 @@ class MediumUploader < CarrierWave::Uploader::Base
     type = ActiveSupport::Inflector.underscore(model.class.to_s)
     "#{HasMedia.directory_path}/#{type}/#{model.id}"
   end
+
+  # see https://gist.github.com/519484
+  def root
+    CarrierWave.root
+  end
+
 end

data/lib/has_media.rb

@@ -8,50 +8,10 @@ module HasMedia
 
   VERSION = "0.0.1"
 
-  @@medium_types = []
+  @@medium_types = {}
   @@store_dir = '/tmp'
   @@directory_uri = ''
-  @@custom_models_path = nil
   @@errors_messages = {:type_error => 'Wrong type'}
-  @@images_content_types = [
-    'image/jpeg',
-    'image/pjpeg',
-    'image/jpg',
-    'image/gif',
-    'image/png',
-    'image/x-png',
-    'image/jpg',
-    'image/x-ms-bmp',
-    'image/bmp',
-    'image/x-bmp',
-    'image/x-bitmap',
-    'image/x-xbitmap',
-    'image/x-win-bitmap',
-    'image/x-windows-bmp',
-    'image/ms-bmp',
-    'application/bmp',
-    'application/x-bmp',
-    'application/x-win-bitmap',
-    'application/preview',
-    'image/jp_',
-    'application/jpg',
-    'application/x-jpg',
-    'image/pipeg',
-    'image/vnd.swiftview-jpeg',
-    'image/x-xbitmap',
-    'application/png',
-    'application/x-png',
-    'image/gi_',
-    'image/x-citrix-pjpeg'
-  ]
-  @@videos_content_types = [
-    'video/mpeg',
-    'video/mp4',
-    'video/quicktime',
-    'video/x-ms-wmv',
-    'video/x-flv',
-    'video/x-msvideo'
-  ]
   @@encoded_extensions = {
     :image => 'png',
     :audio => 'mp3',
@@ -83,24 +43,6 @@ module HasMedia
   def self.directory_uri
     @@directory_uri
   end
-  def self.custom_models_path
-    @@custom_models_path
-  end
-  def self.custom_models_path=(value)
-    unless value.blank?
-      @@custom_models_path = value
-      Dir.glob(self.custom_models_path + '/*.rb').each do |model|
-        require model
-      end
-    end
-  end
-  # taken from http://github.com/technoweenie/attachment_fu/blob/master/lib/technoweenie/attachment_fu.rb
-  def self.images_content_types
-    @@images_content_types
-  end
-  def self.videos_content_types
-    @@videos_content_types
-  end
   def self.errors_messages
     @@errors_messages
   end

data/spec/has_media_spec.rb

@@ -24,12 +24,17 @@ describe "HasMedia" do
   before :all do
     HasMedia.directory_path = 'tmp'
     HasMedia.directory_uri = '/media'
+    HasMedia.medium_types = {
+      "Image" => ["image/jpeg"],
+      "Audio" => ["audio/wav"],
+      "Pdf"   => ["application/pdf"],
+      "Video" => ["video/mp4"]
+    }
   end
 
   describe "fonctionalities" do
 
     before :each do
-      HasMedia.medium_types = [Image, Video, Pdf, Audio]
       @medium = MediumRelatedTest.new
       @image = stub_temp_file('image.jpg', 'image/jpeg')
       @audio = stub_temp_file('audio.wav', 'audio/wav')
@@ -180,7 +185,21 @@ describe "HasMedia" do
 
   describe "Configuration" do
     it "should check allowed medium types if no :only option given" do
-      HasMedia.medium_types = [Image]
+      HasMedia.medium_types = {
+        "Image" => ["image/jpeg"],
+      }
+      @pdf = stub_temp_file('Conversational_Capital _Explained.pdf', 'application/pdf')
+      @medium = MediumRelatedTest.new
+      @medium.pdf = @pdf
+      @medium.valid?
+      @medium.should_not be_valid
+      @medium.save.should be_false
+      @medium.errors.full_messages.include?(HasMedia.errors_messages[:type_error])
+    end
+    it "should check allowed mime type" do
+      HasMedia.medium_types = {
+        "Pdf" => ["image/jpeg"],
+      }
       @pdf = stub_temp_file('Conversational_Capital _Explained.pdf', 'application/pdf')
       @medium = MediumRelatedTest.new
       @medium.pdf = @pdf
@@ -189,8 +208,6 @@ describe "HasMedia" do
       @medium.save.should be_false
       @medium.errors.full_messages.include?(HasMedia.errors_messages[:type_error])
     end
-
-
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_media
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - klacointe
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-02 00:00:00 +01:00
+date: 2010-11-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency