hydra-file_characterization 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2274d4a30e9297d0a50618e43cf37a32b61c636b
-  data.tar.gz: 95f2b5c7c203375348c299ace5ffa8a70dfc8138
+  metadata.gz: 6aa0e27917882868e5356621f163eda7e6ab56a6
+  data.tar.gz: d3114a797679bcd25bc29f19ae31f70659828016
 SHA512:
-  metadata.gz: 46f13a52337a8251753768fbd6de683ebd9d0d61242a3a4e5600d70f388ddf04fb173eadc9489c49799d2836f755e4d92b11e6a0e43b4d0a2bc54a4cbd2b1ce8
-  data.tar.gz: 220e1e5c34ed0cf3286d8e7efa47146306d03ebc3d1cff491e177d5fc31ca48a645995a45c313d0e5d931d5e8bcb15a10688ce60fa1bb4349ce536ef3a7a9a00
+  metadata.gz: 88e44705e2cb908b5732a3f220e90a2544b909834bbe3f96b07ea82c142b31cffaebd38d068493ad84cb0887fe6eec76aeff11e9fd874c116a24fa9295729e3c
+  data.tar.gz: 6932b2860c71bfb3171f0a952021fe0935121b880ea7fcd3aff5b4c5dd47e551143773f154be0e852f5b637f1f22e3a3a1d1949eaea392b38984793017eb7bb2

data/README.md

@@ -6,6 +6,28 @@ Hydra::FileCharacterization as (extracted from Sufia and Hydra::Derivatives)
 
 To provide a wrapper for file characterization
 
+## How To Use
+
+If you are using Rails add the following to an initializer (./config/initializers/hydra-file_characterization_config.rb):
+
+    Hydra::FileCharacterization.configure do |config|
+      config.tool_path(:fits, '/path/to/fits')
+    end
+
+To use the characterizer:
+
+    characterization_xml = Hydra.characterize(file.read, file.basename, :fits)
+
+    # This does not work at this point
+    fits_xml, ffprobe_xml  = Hydra.characterize(file.read, file.basename, :fits, :ffprobe)
+
+* Why `file.read`? To highlight that we want a string. In the case of ActiveFedora, we have a StringIO instead of a file.
+* Why `file.basename`? In the case of Fits, the characterization takes cues from the extension name.
+
+## Registering New Characterizers
+
+This is possible by adding a characterizer to the `Hydra::FileCharacterization::Characterizers`' namespace.
+
 ## To Consider
 
 How others are using the extract_metadata method
@@ -22,11 +44,3 @@ How others are using the extract_metadata method
 - Allow characterization services to be chained together
   - ~~This would involve renaming the Characterizer to something else (i.e. Characterizers::Fits)~~
 - Provide an ActiveFedora Datastream that maps the raw XML stream to a datastructure
-
-## How to configure path to fits tool
-
-If you are using Rails add the following to an initializer (./config/initializers/hydra-file_characterization_config.rb):
-
-    Hydra::FileCharacterization.configure do |config|
-      config.tool_path(:fits, '/path/to/fits')
-    end

data/lib/hydra/file_characterization.rb

@@ -35,23 +35,20 @@ module Hydra
 
   module FileCharacterization
 
-    class Configuration
-      def configure
-        yield(self)
-      end
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
 
+    class Configuration
       def tool_path(tool_name, tool_path)
         Hydra::FileCharacterization.characterizer(tool_name).tool_path = tool_path
       end
     end
 
-    module_function
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    def configure(&block)
-      configuration.configure(&block)
-    end
   end
 end

data/lib/hydra/file_characterization/characterizers.rb

@@ -15,7 +15,7 @@ module Hydra::FileCharacterization
   def characterizer_name_from(tool_name)
     tool_name.to_s.gsub(/(?:^|_)([a-z])/) { $1.upcase }
   end
-  
+
   def characterize_with(tool_name, file_path)
     tool_obj = characterizer(tool_name).new(file_path)
     tool_obj.call
@@ -24,3 +24,4 @@ module Hydra::FileCharacterization
 end
 
 require 'hydra/file_characterization/characterizers/fits'
+require 'hydra/file_characterization/characterizers/ffprobe'

data/lib/hydra/file_characterization/characterizers/ffprobe.rb

@@ -0,0 +1,13 @@
+require 'hydra/file_characterization/exceptions'
+require 'hydra/file_characterization/characterizer'
+
+module Hydra::FileCharacterization::Characterizers
+  class Ffprobe < Hydra::FileCharacterization::Characterizer
+
+    protected
+    def command
+      "#{tool_path} -i \"#{filename}\" -print_format xml -show_streams -v quiet"
+    end
+
+  end
+end

data/lib/hydra/file_characterization/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module FileCharacterization
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
   end
 end

data/spec/lib/hydra/file_characterization/characterizers/ffprobe_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'hydra/file_characterization/characterizers/ffprobe'
+
+module Hydra::FileCharacterization::Characterizers
+
+  describe Ffprobe do
+
+    subject { Ffprobe.new(filename) }
+
+    describe 'invalidFile' do
+      let(:filename) { fixture_file('nofile.pdf') }
+      it "should raise an error if the path does not contain the file" do
+        expect {subject.call}.to raise_error(Hydra::FileCharacterization::FileNotFoundError)
+      end
+    end
+
+  end
+
+end

data/spec/lib/hydra/file_characterization/characterizers_spec.rb

@@ -10,5 +10,10 @@ module Hydra::FileCharacterization
       it { should eq(Characterizers::Fits) }
     end
 
+    describe 'with :ffprobe tool_name' do
+      let(:tool_name) { :ffprobe }
+      it { should eq(Characterizers::Ffprobe) }
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-file_characterization
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - James Treacy
@@ -91,6 +91,7 @@ files:
 - lib/hydra/file_characterization.rb
 - lib/hydra/file_characterization/characterizer.rb
 - lib/hydra/file_characterization/characterizers.rb
+- lib/hydra/file_characterization/characterizers/ffprobe.rb
 - lib/hydra/file_characterization/characterizers/fits.rb
 - lib/hydra/file_characterization/exceptions.rb
 - lib/hydra/file_characterization/to_temp_file.rb
@@ -101,6 +102,7 @@ files:
 - spec/fixtures/brendan_behan.jpeg.fits.xml
 - spec/fixtures/brendan_broken.dxxd
 - spec/fixtures/brendan_broken.dxxd.fits.xml
+- spec/lib/hydra/file_characterization/characterizers/ffprobe_spec.rb
 - spec/lib/hydra/file_characterization/characterizers/fits_spec.rb
 - spec/lib/hydra/file_characterization/characterizers_spec.rb
 - spec/lib/hydra/file_characterization/to_temp_file_spec.rb
@@ -137,6 +139,7 @@ test_files:
 - spec/fixtures/brendan_behan.jpeg.fits.xml
 - spec/fixtures/brendan_broken.dxxd
 - spec/fixtures/brendan_broken.dxxd.fits.xml
+- spec/lib/hydra/file_characterization/characterizers/ffprobe_spec.rb
 - spec/lib/hydra/file_characterization/characterizers/fits_spec.rb
 - spec/lib/hydra/file_characterization/characterizers_spec.rb
 - spec/lib/hydra/file_characterization/to_temp_file_spec.rb