odf_thumb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84ab44e70b9805acfa547ee2662de0a5681b1fea
+  data.tar.gz: c133f131d993b0d1e54c52ecae0df20e8711b63d
+SHA512:
+  metadata.gz: e23df1cf76bb9722f8feb82d91d9c351164827e9f01e652737181baa034218013de436e1347b3647333a47bb37e93b981f66c51d16cdebea7d0814429143413d
+  data.tar.gz: 213531b6bad4c864e8761b2c7544ee2e31d58e803ae7ab3aa690d9dc8974d30cebf3e93c14e3ce6897382a8b1f90be3f1ce4e44cfe655d3103798f06451994c6

data/.gitignore

@@ -0,0 +1 @@
+/pkg/

data/CHANGELOG.txt

@@ -0,0 +1,3 @@
+# v0.1.0 - 2016-05-26 - Initial release
+
+Provides initial feature set, extracting thumbnails for OpenDocument files.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at schmidt@nach-vorne.eu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    odf_thumb (0.1.0)
+      rubyzip (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.8.4)
+    rake (10.5.0)
+    rubyzip (1.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  minitest (~> 5.0)
+  odf_thumb!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.12.3

data/README.md

@@ -0,0 +1,106 @@
+# OdfThumb
+
+This gem extracts existing thumbnail files from OpenDocument files, i.e. files
+created with OpenOffice or LibreOffice.
+
+It cannot be guaranteed, that such a file exists. Most desktop applications will
+create and update such a file, while converters, export tools and command line
+utilities might not.
+
+According to
+[Wikipedia](https://en.wikipedia.org/w/index.php?title=OpenDocument_technical_specification&oldid=695208884),
+the thumbnail
+
+> should be a representation of the first page, first sheet, etc. of the
+> document. The required size for the thumbnails is 128x128 pixel. In order to
+> conform to the [Thumbnail Managing
+> Standard](http://standards.freedesktop.org/thumbnail-spec/latest/x142.html#AEN144)
+> (TMS) at www.freedesktop.org, thumbnails must be saved as 8bit, non-interlaced
+> PNG image with full alpha transparency.
+
+
+
+## Alternative approaches
+
+If these properties do not meet your requirements, try creating a thumbnail
+by making use LibreOffice's conversion capabilities. E.g. convert your document
+to a PNG and create a thumbnail based on that. The following command will create
+a PNG called `Example.png` based on the first page of a OpenDocument text file.
+
+    soffice --headless --convert-to png Example.odt
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'odf_thumb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install odf_thumb
+
+
+
+## Command line usage
+
+OdfThumb comes with a command line tool
+
+```
+# Creates a path/to/source.png
+odf_thumb path/to/source.odt
+
+# Creates a path/to/target/thumb.png
+odf_thumb path/to/source.odt -o path/to/target/thumb.png
+
+# Exits with error code 1 if the given file did not contain a thumbnail file
+odf_thumb other_file.txt
+echo $? # => 1
+```
+
+
+
+## API usage
+
+```ruby
+doc = OdfThumb::Document.new("source.odt")
+
+# Returns true if document contains thumbnail file
+doc.has_thumb?
+
+# Returns thumbnail as binary string, nil if has_thumb? == false
+doc.thumbnail
+
+# Write thumbnail to given path, does nothing if has_thumb? == false
+doc.write_thumbnail_to("thumb.odt")
+```
+
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then,
+run `rake test` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/schmidt/odf_thumb. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "odf_thumb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start

data/bin/odf_thumb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'odf_thumb'
+
+options = {}
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: odt_thumb [options] source.odt"
+
+  opts.on("-o", "--outfile target.png", "Write PNG to given path") do |target|
+    options[:target] = target
+  end
+
+  opts.on("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+
+parser.parse!
+
+if ARGV.size != 1
+  puts parser
+  exit
+end
+
+doc = begin
+  OdfThumb::Document.new(ARGV[0])
+rescue ArgumentError
+  warn "File not readable - #{ARGV[0]}"
+  exit 2
+end
+
+unless doc.has_thumb?
+  warn "File does not contain thumbnail."
+  exit 1
+end
+
+target = if options[:target]
+  options[:target]
+else
+  File.join(File.dirname(doc.source), File.basename(doc.source, ".*") + ".png")
+end
+
+doc.write_thumbnail_to(target)
+puts "Thumbnail written to #{target}"

data/lib/odf_thumb.rb

@@ -0,0 +1,7 @@
+require "zip"
+
+module OdfThumb
+end
+
+require "odf_thumb/version"
+require "odf_thumb/document"

data/lib/odf_thumb/document.rb

@@ -0,0 +1,35 @@
+class OdfThumb::Document
+  attr_reader :source
+
+  def initialize(source)
+    unless File.readable? source
+      raise ArgumentError.new "Cannot read source file"
+    end
+
+    @source = source
+  end
+
+  def has_thumb?
+    Zip::File.open(source) do |file|
+      !!file.find_entry("Thumbnails/thumbnail.png")
+    end
+  rescue Zip::Error
+    false
+  end
+
+  def thumbnail
+    Zip::File.open(source) do |file|
+      file.read("Thumbnails/thumbnail.png")
+    end
+  rescue Zip::Error, Errno::ENOENT
+    nil
+  end
+
+  def write_thumbnail_to(target)
+    Zip::File.open(source) do |file|
+      file.extract("Thumbnails/thumbnail.png", target)
+    end
+  rescue Zip::Error, Errno::ENOENT
+    nil
+  end
+end

data/lib/odf_thumb/version.rb

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

data/odf_thumb.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'odf_thumb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "odf_thumb"
+  spec.version       = OdfThumb::VERSION
+  spec.authors       = ["Gregor Schmidt"]
+  spec.email         = ["schmidt@nach-vorne.eu"]
+
+  spec.summary       = %q{odf_thumb extracts existing thumbnail files from OpenDocument files.}
+  spec.homepage      = "https://github.com/schmidt/odf_thumb"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ["odf_thumb"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubyzip", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: odf_thumb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gregor Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- schmidt@nach-vorne.eu
+executables:
+- odf_thumb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.txt
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/odf_thumb
+- lib/odf_thumb.rb
+- lib/odf_thumb/document.rb
+- lib/odf_thumb/version.rb
+- odf_thumb.gemspec
+homepage: https://github.com/schmidt/odf_thumb
+licenses: []
+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: odf_thumb extracts existing thumbnail files from OpenDocument files.
+test_files: []