dragonfly_audio 0.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ea5b12c33329b64884570596ad8e06ffd530f830
-  data.tar.gz: a13834b59b263db518b796b8b7765fac83201883
+SHA256:
+  metadata.gz: 1eb56e753d688f9144b32a2d2d217a6c7bed3f434da06686ee5ed85d183903bc
+  data.tar.gz: 0323dccb3b593be0f3762d1113bbf9f882f87afa0f5f323b84b3f329a03b3f21
 SHA512:
-  metadata.gz: 4febcf182f5c3874e6010d52c3a7ec686f30f33a51b1a1469e02a7133ece2ff6766e800755e37fb3f8136b259546353861dd695f056ba04753a802b1fdd9a688
-  data.tar.gz: 3c79cf398b489981b612a87282b1554e5aa24897096d5db35aadd02ef8c93451b50ba1a925cbb556c8e03223c0e211faee0fec301827d8c427789c56680fbf48
+  metadata.gz: ba48651964dce80fe6e5b868e5595b12c02507ddef4875fff176e6691d1425241d097a4ccfebc4c8c3de5e90416a5c4bb98a5a71978072af43704bc0c86e0a9a
+  data.tar.gz: d8a55c4ecff008ed0c1f61cb0e43aba71fceaaa8eead90b0bb2d0542fe5adeec821da9d5b194ae198f2fc87d38bbfd9dead95672f2a84ae17e21e54939ef0c14

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# CHANGELOG
+
+## 1.1.0
+
+- support `taglib-ruby` `1.0` – [@asgerb](https://github.com/asgerb).
+- added `length_in_seconds` and `length_in_milliseconds` to `AudioProperties` – [@asgerb](https://github.com/asgerb).
+
+## 1.0.3
+
+- locked `taglib-ruby` to `~> 0.7.1` – [@asgerb](https://github.com/asgerb).
+
+## 1.0.2
+
+- improved `SUPPORTED_FORMATS` matching that ignores case
+
+## 1.0.0
+
+- add `SUPPORTED_FORMATS` and and raise errors when not matching
+- add more thorough tests for supported formats
+
+## 0.0.3
+
+- `AlbumArt` processor (courtesy of @asgerb)

data/README.md

@@ -32,6 +32,14 @@ Dragonfly.app.configure do
 end
 ```
 
+## Supported Formats
+
+List of supported formats is available as:
+
+```ruby
+DragonflyAudio::SUPPORTED_FORMATS # => ["aif", "aiff", …]
+```
+
 ## Analysers
 
 ### audio_properties
@@ -50,6 +58,8 @@ audio.audio_properties
 #   genre: 'Ambient',
 #   comment: 'This Music was originally composed for "The Memory Theatre of Gulio Camillo" by Matthew Maguire. A Creation production premiered at La Mama Spring 1985 thanks to Bonnie for not laughing to Justin for laughing to Jon Gordron for electronic bondage produced by Jonathan Mann for Pangea Productions recorded 8/85 at Chiens Interdits Studio in a big cover production by Ann Rower cover design by Paul Leone * all compositions by Vito Ricci * play it loud',
 #   length: 345,
+#   length_in_seconds: 345,
+#   length_in_milliseconds: 345000,
 #   bitrate: 192,
 #   channels: 2,
 #   sample_rate: 44_100
@@ -76,6 +86,16 @@ Permissible properties:
 * track
 * year
 
+### album_art
+
+Sets the file's album art:
+
+```ruby
+audio.album_art('path_to_file')
+```
+
+Note that this only works for mp3 files.
+
 ## Contributing
 
 1. Fork it ( https://github.com/tomasc/dragonfly_audio/fork )

data/lib/dragonfly_audio.rb

@@ -2,6 +2,8 @@ require 'dragonfly'
 require 'dragonfly_audio/plugin'
 require 'dragonfly_audio/version'
 
-Dragonfly.app.configure do
-  plugin :audio
+module DragonflyAudio
+  class UnsupportedFormat < RuntimeError; end
+
+  SUPPORTED_FORMATS = %w[aif aiff fla flac m4a mp4 mp4a mp4s mp3 mpga oga ogg ogx wav].freeze
 end

data/lib/dragonfly_audio/analysers/audio_properties.rb

@@ -5,29 +5,23 @@ require 'taglib'
 module DragonflyAudio
   module Analysers
     class AudioProperties
-      TAGS = %i(title artist album year track genre comment).freeze
-      AUDIO_PROPS = %i(length bitrate channels sample_rate).freeze
+      TAGS = %w[title artist album year track genre comment].freeze
+      AUDIO_PROPS = %w[length_in_seconds length_in_milliseconds bitrate channels sample_rate].freeze
 
       def call(content)
-        taglib_fileref(content)
-      end
-
-      private # =============================================================
+        return {} unless content.ext
+        return {} unless SUPPORTED_FORMATS.include?(content.ext.downcase)
 
-      def taglib_fileref(content)
         res = {}
-        TagLib::FileRef.open(content.path) do |fileref|
-          unless fileref.null?
 
-            TAGS.each do |tag_name|
-              res[tag_name] = fileref.tag.send(tag_name)
-            end
-
-            AUDIO_PROPS.each do |prop_name|
-              res[prop_name] = fileref.audio_properties.send(prop_name)
-            end
-          end
+        TagLib::FileRef.open(content.path) do |fileref|
+          return if fileref.null?
+          TAGS.each { |n| res[n] = fileref.tag.send(n) }
+          AUDIO_PROPS.each { |n| res[n] = fileref.audio_properties.send(n) }
         end
+        
+        res["length"] = res["length_in_seconds"]
+
         res
       end
     end

data/lib/dragonfly_audio/plugin.rb

@@ -1,21 +1,23 @@
 require 'dragonfly_audio/analysers/audio_properties'
+
 require 'dragonfly_audio/processors/tag'
+require 'dragonfly_audio/processors/album_art'
 
 module DragonflyAudio
   class Plugin
-    def call(app, _opts = {})
-      app.add_analyser :audio_properties, DragonflyAudio::Analysers::AudioProperties.new
+    def call(app, options = {})
+      app.add_analyser :audio_properties, Analysers::AudioProperties.new
+
+      Analysers::AudioProperties::TAGS.each do |name|
+        app.add_analyser(name) { |c| c.analyse(:audio_properties)[name] }
+      end
 
-      [
-        DragonflyAudio::Analysers::AudioProperties::TAGS,
-        DragonflyAudio::Analysers::AudioProperties::AUDIO_PROPS
-      ].flatten.each do |analyser|
-        app.add_analyser analyser do |content|
-          content.analyse(:audio_properties)[analyser]
-        end
+      Analysers::AudioProperties::AUDIO_PROPS.each do |name|
+        app.add_analyser(name) { |c| c.analyse(:audio_properties)[name] }
       end
 
-      app.add_processor :tag, DragonflyAudio::Processors::Tag.new
+      app.add_processor :tag, Processors::Tag.new
+      app.add_processor :album_art, Processors::AlbumArt.new
     end
   end
 end

data/lib/dragonfly_audio/processors/album_art.rb

@@ -0,0 +1,31 @@
+require 'taglib'
+require 'rack'
+
+# IMPORTANT: See http://robinst.github.io/taglib-ruby/
+
+module DragonflyAudio
+  module Processors
+    class AlbumArt
+      def call(content, album_art_file)
+        raise UnsupportedFormat unless content.ext
+        raise UnsupportedFormat unless SUPPORTED_FORMATS.include?(content.ext.downcase)
+        # raise UnsupportedFormat unless content.mime_type == 'audio/mpeg'
+
+        tempfile = content.temp_object
+
+        TagLib::MPEG::File.open(tempfile.path) do |file|
+          tag = file.id3v2_tag
+          album_art = TagLib::ID3v2::AttachedPictureFrame.new
+          album_art.mime_type = Rack::Mime.mime_type(File.extname(album_art_file))
+          album_art.description = "Cover"
+          album_art.type = TagLib::ID3v2::AttachedPictureFrame::FrontCover
+          album_art.picture = File.open(album_art_file, 'rb') { |f| f.read }
+          tag.add_frame(album_art)
+          file.save
+        end
+
+        content.update(tempfile)
+      end
+    end
+  end
+end

data/lib/dragonfly_audio/processors/tag.rb

@@ -5,21 +5,22 @@ require 'taglib'
 module DragonflyAudio
   module Processors
     class Tag
-      PERMISSIBLE_PROPERTIES = DragonflyAudio::Analysers::AudioProperties::TAGS
+      PERMISSIBLE_PROPERTIES = Analysers::AudioProperties::TAGS
 
       def call(content, properties)
-        clean_properties = properties.delete_if { |key, _| !PERMISSIBLE_PROPERTIES.include?(key) }
+        raise UnsupportedFormat unless content.ext
+        raise UnsupportedFormat unless SUPPORTED_FORMATS.include?(content.ext.downcase)
+
+        # stringify keys
+        properties = properties.each_with_object({}) { |(k, v), memo| memo[k.to_s] = v }
+        properties = properties.select { |key, _| PERMISSIBLE_PROPERTIES.include?(key) }
 
         tempfile = Dragonfly::TempObject.new(content.tempfile)
 
         TagLib::FileRef.open(tempfile.path) do |file|
-          unless file.null?
-            tag = file.tag
-            clean_properties.each do |key, value|
-              tag.send("#{key}=", value)
-            end
-            file.save
-          end
+          return if file.null?
+          properties.each { |k, v| file.tag.send("#{k}=", v) }
+          file.save
         end
 
         content.update(tempfile)

data/lib/dragonfly_audio/version.rb

@@ -1,3 +1,3 @@
 module DragonflyAudio
-  VERSION = '0.0.2'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dragonfly_audio
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Tomas Celizna
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-14 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dragonfly
@@ -29,32 +29,46 @@ dependencies:
   name: taglib-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +96,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,7 +110,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -117,25 +131,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- Gemfile
-- Gemfile.lock
-- Guardfile
-- LICENSE.txt
+- CHANGELOG.md
 - README.md
-- Rakefile
-- dragonfly_audio.gemspec
 - lib/dragonfly_audio.rb
 - lib/dragonfly_audio/analysers/audio_properties.rb
 - lib/dragonfly_audio/plugin.rb
+- lib/dragonfly_audio/processors/album_art.rb
 - lib/dragonfly_audio/processors/tag.rb
 - lib/dragonfly_audio/version.rb
-- samples/BroadmoorSirenTest.mp3
-- test/dragonfly_audio/analysers/audio_properties_test.rb
-- test/dragonfly_audio/plugin_test.rb
-- test/dragonfly_audio/processors/tag_test.rb
-- test/test_helper.rb
 homepage: https://github.com/tomasc/dragonfly_audio
 licenses:
 - MIT
@@ -155,13 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Wraps common audio-related tasks into Dragonfly analysers and processors.
-test_files:
-- test/dragonfly_audio/analysers/audio_properties_test.rb
-- test/dragonfly_audio/plugin_test.rb
-- test/dragonfly_audio/processors/tag_test.rb
-- test/test_helper.rb
+test_files: []

data/.gitignore

@@ -1,2 +0,0 @@
-.DS_Store
-pkg

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-cache: bundler
-script: 'bundle exec rake'
-rvm:
-  - 2.2.5
-before_install:
-  - sudo apt-get update
-  - sudo apt-get install -y libtag1-dev
-
-notifications:
-  email:
-    recipients:
-      - tomas.celizna@gmail.com
-    on_failure: change
-    on_success: never

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in dragonfly_audio.gemspec
-gemspec

data/Gemfile.lock

@@ -1,69 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dragonfly_audio (0.0.2)
-      dragonfly (~> 1.0)
-      taglib-ruby
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.4.0)
-    coderay (1.1.0)
-    dragonfly (1.0.12)
-      addressable (~> 2.3)
-      multi_json (~> 1.0)
-      rack (>= 1.3.0)
-    ffi (1.9.10)
-    formatador (0.2.5)
-    guard (2.13.0)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, <= 4.0)
-      lumberjack (~> 1.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-minitest (2.4.4)
-      guard-compat (~> 1.2)
-      minitest (>= 3.0)
-    listen (3.0.3)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.9)
-    method_source (0.8.2)
-    minitest (5.8.1)
-    multi_json (1.12.1)
-    nenv (0.2.0)
-    notiffany (0.0.8)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    pry (0.10.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rack (2.0.1)
-    rake (10.4.2)
-    rb-fsevent (0.9.6)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
-    shellany (0.0.1)
-    slop (3.6.0)
-    taglib-ruby (0.7.1)
-    thor (0.19.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.6)
-  dragonfly_audio!
-  guard
-  guard-minitest
-  minitest
-  rake
-
-BUNDLED WITH
-   1.12.5

data/Guardfile

@@ -1,8 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard :minitest do
-  watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
-  watch(%r{^test/.+_test\.rb$})
-  watch(%r{^test/test_helper\.rb$}) { 'test' }
-end

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 Tomas Celizna
-
-MIT License
-
-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/Rakefile

@@ -1,9 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
- 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-end
-
-task :default => :test

data/dragonfly_audio.gemspec

@@ -1,28 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'dragonfly_audio/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'dragonfly_audio'
-  spec.version       = DragonflyAudio::VERSION
-  spec.authors       = ['Tomas Celizna', 'Asger Behncke Jacobsen']
-  spec.email         = ['tomas.celizna@gmail.com', 'asger@8kilo.com']
-  spec.summary       = 'Wraps common audio-related tasks into Dragonfly analysers and processors.'
-  spec.homepage      = 'https://github.com/tomasc/dragonfly_audio'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'dragonfly', '~> 1.0'
-  spec.add_dependency 'taglib-ruby'
-
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'guard'
-  spec.add_development_dependency 'guard-minitest'
-  spec.add_development_dependency 'minitest'
-end

data/test/dragonfly_audio/analysers/audio_properties_test.rb

@@ -1,50 +0,0 @@
-require 'test_helper'
-
-describe DragonflyAudio::Analysers::AudioProperties do
-  let(:app) { test_app.configure_with(:audio) }
-  let(:audio) { app.fetch_file(SAMPLES_DIR.join('BroadmoorSirenTest.mp3')) }
-
-  it 'analyses "album" property' do
-    audio.audio_properties[:album].must_equal 'Album XYZ'
-  end
-
-  it 'analyses "artist" property' do
-    audio.audio_properties[:artist].must_equal 'Artist'
-  end
-
-  it 'analyses "bitrate" property' do
-    audio.audio_properties[:bitrate].must_equal 192
-  end
-
-  it 'analyses "channels" property' do
-    audio.audio_properties[:channels].must_equal 2
-  end
-
-  it 'analyses "comment" property' do
-    audio.audio_properties[:comment].must_equal '   Comment    '
-  end
-
-  it 'analyses "genre" property' do
-    audio.audio_properties[:genre].must_equal 'Dance'
-  end
-
-  it 'analyses "length" property' do
-    audio.audio_properties[:length].must_equal 156
-  end
-
-  it 'analyses "sample_rate" property' do
-    audio.audio_properties[:sample_rate].must_equal 44_100
-  end
-
-  it 'analyses "title" property' do
-    audio.audio_properties[:title].must_equal 'SongTitle'
-  end
-
-  it 'analyses "track" property' do
-    audio.audio_properties[:track].must_equal 0
-  end
-
-  it 'analyses "year" property' do
-    audio.audio_properties[:year].must_equal 0
-  end
-end

data/test/dragonfly_audio/plugin_test.rb

@@ -1,29 +0,0 @@
-require 'test_helper'
-
-module DragonflyAudio
-  describe Plugin do
-    let(:app) { test_app.configure_with(:audio) }
-    let(:audio) { app.fetch_file(SAMPLES_DIR.join('BroadmoorSirenTest.mp3')) }
-
-    describe 'analysers' do
-      it 'adds #audio_properties' do
-        audio.must_respond_to :audio_properties
-      end
-
-      [
-        DragonflyAudio::Analysers::AudioProperties::TAGS,
-        DragonflyAudio::Analysers::AudioProperties::AUDIO_PROPS
-      ].flatten.each do |analyser|
-        it "adds ##{analyser}" do
-          audio.must_respond_to analyser
-        end
-      end
-    end
-
-    describe 'processors' do
-      it 'adds #tag' do
-        audio.must_respond_to :tag
-      end
-    end
-  end
-end

data/test/dragonfly_audio/processors/tag_test.rb

@@ -1,23 +0,0 @@
-require 'test_helper'
-
-describe DragonflyAudio::Processors::Tag do
-  let(:app) { test_app.configure_with(:audio) }
-  let(:processor) { DragonflyAudio::Processors::Tag.new }
-  let(:analyser) { DragonflyAudio::Analysers::AudioProperties.new }
-  let(:audio) { Dragonfly::Content.new(app, SAMPLES_DIR.join('BroadmoorSirenTest.mp3')) }
-
-  let(:artist) { 'Elvis Presley' }
-  let(:title) { 'Hound Dawg' }
-
-  before { processor.call(audio, artist: artist, title: title) }
-
-  describe 'properties' do
-    it 'sets the artist tag property' do
-      analyser.call(audio)[:artist].must_equal artist
-    end
-
-    it 'sets the title tag property' do
-      analyser.call(audio)[:title].must_equal title
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,17 +0,0 @@
-require 'bundler/setup'
-
-require 'minitest'
-require 'minitest/autorun'
-require 'minitest/spec'
-
-require 'dragonfly'
-require 'dragonfly_audio'
-
-SAMPLES_DIR = Pathname.new(File.expand_path('../../samples', __FILE__))
-
-def test_app(name = nil)
-  app = Dragonfly::App.instance(name)
-  app.datastore = Dragonfly::MemoryDataStore.new
-  app.secret = 'test secret'
-  app
-end