micro_exiftool 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3392b6294a746659c23c9a0781fdce1e5cf4e52d
+  data.tar.gz: effe61579e027b82a6ac94678664522ccccea3fa
+SHA512:
+  metadata.gz: cb967bc6f82725dc338e8a8ddca858f068cf77190cbb9cf54aae56eacf0671e6e9ed660394b5cdb93f74d4fc024a3d9b80bca6ef5eccd9eb488001ae12d5f33c
+  data.tar.gz: 459a170ef73c7f6d52c43c64de69fccd203caadd63aa2d78b1605e39e079089614934385e7ccb7ab2f397208998efa88d87aad81dc01b445a9e545bb7531d406

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+before_install:
+  - wget http://www.sno.phy.queensu.ca/~phil/exiftool/Image-ExifTool-9.99.tar.gz
+  - tar -xzf Image-ExifTool-9.99.tar.gz
+  - cd Image-ExifTool-9.99
+  - perl Makefile.PL
+  - make
+  - export PATH=$PATH:$PWD
+  - cd ..
+  - exiftool -ver
+rvm:
+  - 1.9.3
+  - 2.1.2
+  - 2.2.1
+script: bundle exec rspec
+notifications:
+  email:
+    - fail@makandra.de
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    micro_exiftool (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  micro_exiftool!
+  rake (~> 10.0)
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tobias Kraze
+
+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/README.md

@@ -0,0 +1,68 @@
+# micro_exiftool [![Build Status](https://travis-ci.org/makandra/micro_exiftool.svg?branch=master)](https://travis-ci.org/makandra/micro_exiftool)
+
+micro_exiftool is an extremely basic ruby wrapper for the [ExifTool](http://www.sno.phy.queensu.ca/~phil/exiftool/) command line tool.
+
+It allows to read and write metadata for all files supported by ExifTools, such as JPG or MP3.
+
+This was the simplest tool that fit my own needs and deliberately tries to do as little as possible.
+
+If you need a more complete implementation, you might want to take a look at [mini_exiftool](https://github.com/janfri/mini_exiftool).
+
+
+## Installation
+
+You need to have exiftool installed and on your PATH.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'micro_exiftool'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install micro_exiftool
+
+## Usage
+
+All attributes are plain strings.
+
+
+### Read attributes
+
+```
+file = MicroExiftool::File.new(path_to_file)
+
+file.attributes               # hash including all attributes returned by exiftool
+file['EXIF:Copyright']        # the EXIF copyright field
+file['IPTC:CopyrightNotice']  # the IPTC copyright field
+```
+
+### Update attributes
+
+```
+file = MicroExiftool::File.new(path_to_file)
+
+file.update!(
+  'EXIF:Copyright' => 'new EXIF copyright',
+  'IPTC:CopyrightNotice' => 'new IPTC copyright',
+)
+```
+
+This will update the attributes of the file in place.
+
+Note that there is (currently) no validation that the fields are actually valid metadata fields. If you set an unknown field, it will be silently ignored.
+
+
+## Author
+
+Tobias Kraze from [makandra](http://makandra.com/)
+
+
+## License
+
+Licensed under the MIT license.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/micro_exiftool.rb

@@ -0,0 +1,6 @@
+require 'micro_exiftool/file'
+require 'micro_exiftool/version'
+
+module MicroExiftool
+
+end

data/lib/micro_exiftool/file.rb

@@ -0,0 +1,64 @@
+require 'open3'
+require 'json'
+
+module MicroExiftool
+
+  class NoSuchFile < StandardError; end
+  class ExifToolError < StandardError; end
+
+
+  class File
+
+    def initialize(path)
+      @path = path.to_s
+      unless ::File.exist?(@path)
+        raise NoSuchFile.new("No such file: #{@path}")
+      end
+    end
+
+    def [](key)
+      file_attributes[key]
+    end
+
+    def attributes
+      file_attributes.dup
+    end
+
+    def update!(new_attributes)
+      update_json = [new_attributes.merge('SourceFile' => @path)].to_json
+
+      run_exiftool(
+        '-P',                     # dont change timestamp of file
+        '-G0',                    # prefix all attributes with "EXIF:", "ITCP:" etc
+        '-overwrite_original',    # dont make a backup copy
+        '-j=-',                   # read new attributes from stdin as json
+        stdin_data: update_json
+      )
+
+      @file_attributes.merge!(new_attributes) if defined? @file_attributes
+      true
+    end
+
+
+    private
+
+    def file_attributes
+      @file_attributes ||= load_attributes
+    end
+
+    def load_attributes
+      result = run_exiftool('-G0', '-j')
+      JSON.parse(result).first
+    end
+
+    def run_exiftool(*arguments)
+      options = arguments.last.is_a?(Hash) ? arguments.pop : {}
+      stdout_string, stderr_string, status = Open3.capture3('exiftool', @path, *arguments, options)
+      unless status.exitstatus == 0
+        raise ExifToolError.new("Error running exiftool:\n#{stderr_string}")
+      end
+      stdout_string
+    end
+
+  end
+end

data/lib/micro_exiftool/version.rb

@@ -0,0 +1,3 @@
+module MicroExiftool
+  VERSION = "0.1.0"
+end

data/micro_exiftool.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'micro_exiftool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "micro_exiftool"
+  spec.version       = MicroExiftool::VERSION
+  spec.authors       = ["Tobias Kraze"]
+  spec.email         = ["tobias.kraze@makandra.de"]
+  spec.summary       = %q{Minimal ruby wrapper around exiftool..}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/spec/file_spec.rb

@@ -0,0 +1,138 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'tempfile'
+
+describe MicroExiftool::File do
+
+  let(:sample_file_path) { File.join(File.dirname(__FILE__), 'assets', 'image.jpg') }
+
+  subject { described_class.new(sample_file_path) }
+
+  describe '.new' do
+
+    it 'complains about missing files' do
+      proc {
+        described_class.new('does/not/exist')
+      }.should raise_error(MicroExiftool::NoSuchFile)
+    end
+
+  end
+
+
+  describe '#attributes' do
+
+    it 'returns prefixed file attributes as a hash' do
+      subject.attributes.should include(
+        'IPTC:ObjectName' => 'The IPTC Title',
+        'IPTC:CopyrightNotice' => 'The IPTC Copyright',
+        'EXIF:Copyright' => 'The EXIF Copyright'
+      )
+    end
+
+  end
+
+
+  describe '#[]' do
+
+    it 'returns single attributes' do
+      subject['IPTC:ObjectName'].should == 'The IPTC Title'
+    end
+
+  end
+
+  describe 'update!' do
+
+    let(:sample_file_copy) { Tempfile.new(['sample_file_copy', '.jpg']) }
+    let(:sample_file_copy_path) { sample_file_copy.path }
+
+    before do
+      sample_file_copy.write(File.read(sample_file_path))
+      sample_file_copy.close
+    end
+
+    subject { described_class.new(sample_file_copy_path) }
+    let(:duplicate_subject) { described_class.new(sample_file_copy_path) }
+
+
+    it 'modifies the given attributes in the file' do
+      subject.update!(
+        'IPTC:CopyrightNotice' => 'The new IPTC Copyright',
+        'EXIF:Copyright' => 'The new EXIF Copyright',
+      )
+
+      duplicate_subject.attributes.should include(
+        'IPTC:CopyrightNotice' => 'The new IPTC Copyright',
+        'EXIF:Copyright' => 'The new EXIF Copyright',
+      )
+    end
+
+    it 'does not touch other metadata' do
+      attributes_before = subject.attributes
+
+      subject.update!(
+        'EXIF:Copyright' => 'The new EXIF Copyright',
+      )
+
+      attributes_after = duplicate_subject.attributes
+      %w[EXIF:Copyright File:FileAccessDate File:FileInodeChangeDate].each do |key|
+        attributes_before.delete(key)
+        attributes_after.delete(key)
+      end
+      attributes_after.should == attributes_before
+    end
+
+    it 'modifies the given attributes on the current instance' do
+      attributes_before = subject.attributes
+
+      subject.update!(
+        'EXIF:Copyright' => 'The new EXIF Copyright',
+      )
+
+      attributes_before['EXIF:Copyright'].should eq 'The EXIF Copyright'
+      subject.attributes['EXIF:Copyright'].should eq 'The new EXIF Copyright'
+    end
+
+    it 'modifies files in place' do
+      subject.update!(
+        'EXIF:Copyright' => 'The new EXIF Copyright',
+      )
+
+      File.exist?(sample_file_copy_path + '_original').should eq false
+    end
+
+    it 'can assign characters that might need escaping' do
+      new_copyright = %{'"& ;\/{}<>}
+      subject.update!(
+        'EXIF:Copyright' => new_copyright,
+        'IPTC:CopyrightNotice' => new_copyright,
+      )
+
+      duplicate_subject['EXIF:Copyright'].should eq new_copyright
+      duplicate_subject['IPTC:CopyrightNotice'].should eq new_copyright
+    end
+
+    it 'can assign non-ASCII characters' do
+      new_copyright = '版权所有'
+      subject.update!(
+        'EXIF:Copyright' => new_copyright,
+        'IPTC:CopyrightNotice' => new_copyright,
+      )
+
+      duplicate_subject['EXIF:Copyright'].should eq new_copyright
+      duplicate_subject['IPTC:CopyrightNotice'].should eq new_copyright
+    end
+
+    it 'complains about exiftool errors' do
+      Open3.stub(:capture3).and_return(['', 'some error', double('status', exitstatus: 1)])
+
+      proc {
+        subject.update!(
+          'EXIF:Copyright' => 'The new EXIF Copyright',
+        )
+      }.should raise_error(MicroExiftool::ExifToolError, "Error running exiftool:\nsome error")
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+require 'bundler/setup'
+require 'micro_exiftool'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    expectations.syntax = [:should, :expect]
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+    mocks.syntax = [:should, :expect]
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: micro_exiftool
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tobias Kraze
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tobias.kraze@makandra.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/micro_exiftool.rb
+- lib/micro_exiftool/file.rb
+- lib/micro_exiftool/version.rb
+- micro_exiftool.gemspec
+- spec/assets/image.jpg
+- spec/file_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Minimal ruby wrapper around exiftool..
+test_files:
+- spec/assets/image.jpg
+- spec/file_spec.rb
+- spec/spec_helper.rb