dragonfly_audio 0.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6a170d383f614e2e631182e1f7b46e83c99ae0d6
-  data.tar.gz: c7ef98a7e4fb7de069928e98a0f87f22da054322
+SHA256:
+  metadata.gz: 7358381b3e93d63f3fcab85483e44f0b05bc0fb6557aa1f47f944e2b092a6f11
+  data.tar.gz: 9e16191e41135220edfb04acf272ff5ca13380bfe5ae354237e44b14c86014b5
 SHA512:
-  metadata.gz: e6ddcbf3f71a510e4ac002ce582a93f477eb5ab5e3cc28b2ab6bf86b457c5360b75d3863c984cc9997985749dd45d5e445db6be7d132fab5f434d8a940516a95
-  data.tar.gz: c822ee6493eab379b2634d52769f3937764e78b7f66163fc705bc3956246e89d00e6d87a152cc1d01e167988040b353f2da92c96a5ce25898e4d757c8ebe1039
+  metadata.gz: 4974325e79c595e391e37fa6ed59756cb01ee684fae7d0ae7b18741cb584988ba3e754c3d795ab310bd784b2ecfb64e0dfd9ff47950141fced5ffd8d65a95ba8
+  data.tar.gz: 1db36d1b74d56dc8bb1453544c28ad3bab6ce80d08a90d69523c958c510f6c00af4ef7a1e372a525fa54bd4722d2461b639263a54037ddc35ce052cb40951f56

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# CHANGELOG
+
+## 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

@@ -1,5 +1,7 @@
 # Dragonfly Audio
 
+[![Build Status](https://travis-ci.org/tomasc/dragonfly_audio.svg)](https://travis-ci.org/tomasc/dragonfly_audio) [![Gem Version](https://badge.fury.io/rb/dragonfly_audio.svg)](http://badge.fury.io/rb/dragonfly_audio) [![Coverage Status](https://img.shields.io/coveralls/tomasc/dragonfly_audio.svg)](https://coveralls.io/r/tomasc/mongoid_recurring)
+
 Wraps common audio-related tasks into [Dragonfly](http://markevans.github.io/dragonfly) analysers and processors.
 
 ## Installation
@@ -18,6 +20,8 @@ Or install it yourself as:
 
 ## Dependencies
 
+This gem uses [taglib-ruby](https://github.com/robinst/taglib-ruby) to read and write meta data and properties of audio files.
+
 ## Usage
 
 Add the `:audio` plugin to your Dragonfly config block:
@@ -28,10 +32,68 @@ Dragonfly.app.configure do
 end
 ```
 
+## Supported Formats
+
+List of supported formats is available as:
+
+```ruby
+DragonflyAudio::SUPPORTED_FORMATS # => ["aif", "aiff", …]
+```
+
 ## Analysers
 
+### audio_properties
+
+Reads properties and tags of an audio file:
+
+```ruby
+audio.audio_properties
+
+# => {
+#   title: 'The Ship Was Sailing',
+#   artist: 'Vito Ricci',
+#   album: 'Music From Memory',
+#   year: '1985',
+#   track: 7
+#   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,
+#   bitrate: 192,
+#   channels: 2,
+#   sample_rate: 44_100
+# }
+```
+
 ## Processors
 
+### tag
+
+Sets the file's meta information:
+
+```ruby
+audio.tag(artist: 'Ariel Kalma', album: 'Le Temps Des Moissons', track: 'Bakafrika')
+```
+
+Permissible properties:
+* album
+* artist
+* comment
+* genre
+* tag
+* title
+* 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,42 +5,23 @@ require 'taglib'
 module DragonflyAudio
   module Analysers
     class AudioProperties
+      TAGS = %w[title artist album year track genre comment].freeze
+      AUDIO_PROPS = %w[length bitrate channels sample_rate].freeze
 
-      def call content
-        taglib_fileref(content)
-      end
-
-      private # =============================================================
+      def call(content)
+        return {} unless content.ext
+        return {} unless SUPPORTED_FORMATS.include?(content.ext.downcase)
 
-      def taglib_fileref temp_object
         res = {}
-        TagLib::FileRef.open(temp_object.path) do |fileref|
-          unless fileref.null?
-
-            # TODO: simplify me!
-            tag = fileref.tag
-            res.merge! title: tag.title
-            res.merge! artist: tag.artist
-            res.merge! album: tag.album
-            res.merge! year: tag.year
-            res.merge! tag: tag.year
-            res.merge! track: tag.track
-            res.merge! genre: tag.genre
-            res.merge! comment: tag.comment
 
-            prop = fileref.audio_properties
-            res.merge! length: prop.length
-            res.merge! bitrate: prop.bitrate
-            res.merge! channels: prop.channels
-            res.merge! sample_rate: prop.sample_rate
-
-            # prop.merge! %w(title artist album year track genre comment).inject({}) { |res, att| { att => fileref.tag.send(att) } }
-            # prop.merge! length: fileref.audio_properties.length
-          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
       end
-
     end
   end
 end

data/lib/dragonfly_audio/plugin.rb

@@ -1,56 +1,24 @@
 require 'dragonfly_audio/analysers/audio_properties'
 
+require 'dragonfly_audio/processors/tag'
+require 'dragonfly_audio/processors/album_art'
+
 module DragonflyAudio
   class Plugin
+    def call(app, options = {})
+      app.add_analyser :audio_properties, Analysers::AudioProperties.new
 
-    def call app, opts={}
-      app.add_analyser :audio_properties, DragonflyAudio::Analysers::AudioProperties.new
-
-      app.add_analyser :title do |content|
-        content.analyse(:audio_properties)[:title]
-      end
-
-      app.add_analyser :artist do |content|
-        content.analyse(:audio_properties)[:artist]
-      end
-
-      app.add_analyser :album do |content|
-        content.analyse(:audio_properties)[:album]
-      end
-
-      app.add_analyser :year do |content|
-        content.analyse(:audio_properties)[:year]
-      end
-
-      app.add_analyser :track do |content|
-        content.analyse(:audio_properties)[:track]
+      Analysers::AudioProperties::TAGS.each do |name|
+        app.add_analyser(name) { |c| c.analyse(:audio_properties)[name] }
       end
 
-      app.add_analyser :genre do |content|
-        content.analyse(:audio_properties)[:genre]
+      Analysers::AudioProperties::AUDIO_PROPS.each do |name|
+        app.add_analyser(name) { |c| c.analyse(:audio_properties)[name] }
       end
 
-      app.add_analyser :comment do |content|
-        content.analyse(:audio_properties)[:comment]
-      end
-
-      app.add_analyser :length do |content|
-        content.analyse(:audio_properties)[:length]
-      end
-
-      app.add_analyser :bitrate do |content|
-        content.analyse(:audio_properties)[:bitrate]
-      end
-
-      app.add_analyser :channels do |content|
-        content.analyse(:audio_properties)[:channels]
-      end
-
-      app.add_analyser :sample_rate do |content|
-        content.analyse(:audio_properties)[:sample_rate]
-      end
+      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

@@ -0,0 +1,30 @@
+require 'taglib'
+
+# IMPORTANT: See http://robinst.github.io/taglib-ruby/
+
+module DragonflyAudio
+  module Processors
+    class Tag
+      PERMISSIBLE_PROPERTIES = Analysers::AudioProperties::TAGS
+
+      def call(content, properties)
+        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|
+          return if file.null?
+          properties.each { |k, v| file.tag.send("#{k}=", v) }
+          file.save
+        end
+
+        content.update(tempfile)
+      end
+    end
+  end
+end

data/lib/dragonfly_audio/version.rb

@@ -1,3 +1,3 @@
 module DragonflyAudio
-  VERSION = "0.0.1"
+  VERSION = '1.0.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dragonfly_audio
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Tomas Celizna
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dragonfly
@@ -29,46 +29,46 @@ dependencies:
   name: taglib-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.1
 - !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: '0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,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:
     - - ">="
@@ -96,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:
     - - ">="
@@ -110,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:
     - - ">="
@@ -131,21 +131,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- 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/plugin_test.rb
-- test/test_helper.rb
 homepage: https://github.com/tomasc/dragonfly_audio
 licenses:
 - MIT
@@ -165,11 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+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/plugin_test.rb
-- test/test_helper.rb
+test_files: []

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -1,70 +0,0 @@
-PATH
-  remote: .
-  specs:
-    dragonfly_audio (0.0.1)
-      dragonfly (~> 1.0)
-      taglib-ruby
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.8)
-    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)
-    mini_portile (0.6.2)
-    minitest (5.8.1)
-    multi_json (1.11.2)
-    nenv (0.2.0)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.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 (1.6.4)
-    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.0)
-    thor (0.19.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.6)
-  dragonfly_audio!
-  guard
-  guard-minitest
-  minitest
-  nokogiri
-  rake

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,29 +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       = %q{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 "nokogiri"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-minitest"
-  spec.add_development_dependency "minitest"
-end

data/test/dragonfly_audio/plugin_test.rb

@@ -1,18 +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
-    end
-
-  end
-end

data/test/test_helper.rb

@@ -1,21 +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