paperclip-wav-mp3 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6809f83bc3f0d4ec6054ef15838e69fdb86edce
-  data.tar.gz: d9950d2afe8d89a90bd2323e841fa2e9e5b53146
+  metadata.gz: 2da064bd68c4a179944fa82f40ce9f209f7f1106
+  data.tar.gz: e02f88277385e48ba457ee04917faa425e7b8e9f
 SHA512:
-  metadata.gz: c6c6acf2fe581e39ad80386a5b67b9ec9fe4c01a9a5459166df41c113ee95b6819330554a7666faea00a9803399a1b9d6d17d200e7f8debd34f5285c0eceb8e1
-  data.tar.gz: 158fbe2bdbb5db5954167c357c6aa34d6a6fc7dd4700a2f1f00c924a6fb6b1e4b4272b525077333dd3dd1daf9a69fc71b8f9f100d4afb612681d3d736a321a2e
+  metadata.gz: 238ae23e5cf0dd3cdb44fb5137e65c9b2114de3f1ec9115dc4e5216c951958feaabb8b7544bc65385e8585bde776ddc0733eac29bbdc25541f264db2a0c4a630
+  data.tar.gz: 43b90893c3e0ad6e5198740fe1fda04f2392fd28a887c3feac67597801ed5b113716203ee18c7971a9046f887c2677334029f16bb2a04f3432e5965f6733760b

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -1,4 +1,69 @@
-paperclip-wav-mp3
-=================
+# paperclip-wav-mp3 [![Gem Version](https://badge.fury.io/rb/paperclip-wav-mp3.png)](http://badge.fury.io/rb/paperclip-wav-mp3)
+
+
 
 Paperclip processor to convert .wav files to .mp3 using ffmpeg
+
+## Requirements
+
+### Paperclip
+
+This is a processor written for the quite excellent [Paperclip](https://github.com/thoughtbot/paperclip) gem by [ThoughtBot](https://github.com/thoughtbot). You will need to be using Paperclip to use it.
+
+### FFmpeg
+
+FFmpeg is used to convert WAV audio to MP3. It must be installed within your environment and available on your PATH.
+
+#### OS X
+
+If you're developing on OS X, you can install FFmpeg using homebrew:
+
+```
+brew install ffmpeg
+```
+
+#### Ubuntu Linux
+
+I've not tested on other linux distributions, but you can install FFmpeg and the required codecs with the following:
+
+```
+apt-get install ffmpeg libavcodec-extra-52 libavdevice-extra-52 libavfilter-extra-0 libavformat-extra-52 libavutil-extra-49 libpostproc-extra-51 libswscale-extra-0
+```
+
+## Installation
+
+This processor is distributed as a gem, which is how it should be used in your app.
+
+Include the gem in your Gemfile:
+
+```
+gem 'paperclip-wav-mp3', '~> 0.0'
+```
+
+Once you've installed the gem, update the model which uses Paperclip to attach audio to add the processor:
+
+```
+class Voicemail < ActiveRecord::Base
+  has_attached_file :audio,
+                    styles: { mp3: {} },
+                    processors: [:ffmpeg_wav_to_mp3]
+end
+```
+
+Now, when you attach a new `WAV` audio file, you will also create an `MP3` version.
+
+To generate the missing `MP3` versions for files you've already attached you can use this paperclip rake task:
+
+```
+rake paperclip:refresh:missing_styles
+```
+
+## Contributing
+
+Feel free to raise any issues you have [here](https://github.com/pacso/paperclip-wav-mp3/issues), or if you're feeling generous then just send a [pull request](https://github.com/pacso/paperclip-wav-mp3/compare/) with your new feature/bugfix.
+
+## License
+
+Copyright (c) 2014 Jon Pascoe.
+
+This is free software and may be redistributed under the terms and conditions of The MIT License (MIT). Full details are available in the LICENSE file.

data/lib/paperclip-wav-mp3.rb

@@ -1,34 +1 @@
-require 'paperclip'
-
-module Paperclip
-  class FfmpegWav2Mp3 < Processor
-
-    attr_accessor :file, :params, :format
-
-    def initialize(file, options = {}, attachment = nil)
-      super
-      @file = file
-      @params = options[:params]
-      @current_format = File.extname(@file.path)
-      @basename = File.basename(@file.path, @current_format)
-      @format = options[:format]
-    end
-
-    def make
-      src = @file
-      dst = Tempfile.new([@basename, @format ? ".#{@format}" : '' ])
-
-      begin
-        parameters = []
-        parameters << @params
-        parameters << ":source"
-        parameters << ":dest"
-        parameters = parameters.flatten.compact.join(' ').strip.squeeze(' ')
-        success = Paperclip.run('ffmpeg', parameters, :source => File.expand_path(src.path), :dest => File.expand_path(dst.path))
-      rescue PaperclipCommandLineError => e
-        raise PaperclipError, "There was an error converting #{@basename} to mp3"
-      end
-      dst
-    end
-  end
-end
+require 'paperclip_processors/ffmpeg_wav_to_mp3'

data/lib/paperclip_processors/ffmpeg_wav_to_mp3.rb

@@ -0,0 +1,31 @@
+require 'paperclip'
+
+module Paperclip
+  class FfmpegWavToMp3 < Processor
+
+    attr_accessor :file, :params, :format
+
+    def initialize(file, options = {}, attachment = nil)
+      super
+      @file = file
+      @params = options[:params] || '-y -i'
+      @current_format = File.extname(@file.path)
+      @basename = File.basename(@file.path, @current_format)
+      @format = options[:format] || 'mp3'
+    end
+
+    def make
+      source = @file
+      output = Tempfile.new([@basename, @format ? ".#{@format}" : '' ])
+
+      begin
+        parameters = [@params, ':source', ':dest'].flatten.compact.join(' ').strip.squeeze(' ')
+        Paperclip.run('ffmpeg', parameters, :source => File.expand_path(source.path), :dest => File.expand_path(output.path))
+      rescue PaperclipCommandLineError
+        raise PaperclipError, "There was an error converting #{@basename} to mp3"
+      end
+
+      output
+    end
+  end
+end

data/paperclip-wav-mp3.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'paperclip-wav-mp3'
-  s.version     = '0.0.0'
-  s.authors     = ['Jon Pascoe']
+  s.version     = '0.0.1'
+  s.author      = 'Jon Pascoe'
   s.email       = 'jon.pascoe@me.com'
   s.homepage    = 'https://github.com/pacso/paperclip-wav-mp3'
   s.summary     = 'Paperclip WAV to MP3 Processor'
@@ -12,6 +12,6 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+
   s.license     = 'MIT'
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperclip-wav-mp3
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Jon Pascoe
@@ -30,9 +30,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - LICENSE
 - README.md
 - lib/paperclip-wav-mp3.rb
+- lib/paperclip_processors/ffmpeg_wav_to_mp3.rb
 - paperclip-wav-mp3.gemspec
 homepage: https://github.com/pacso/paperclip-wav-mp3
 licenses: