convertible 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jens Krämer
+
+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,50 @@
+# Overview
+
+Simple commandline client written in Ruby for the http://convertible.io/
+online file conversion platform. See the website for more info.
+
+# Basic usage
+
+Usage: convertible [options] [file1 [file2]]
+
+Convert file1 to file2.
+
+# Converting files
+
+Without any file arguments data will be read from STDIN and written to STDOUT.
+If only one filename (file1) is present, data will be read from STDIN and the result will
+be written to file1. Use the -c switch to invert this behaviour so data is
+read from file1 and written to STDOUT.
+
+By default, input and output formats will be guessed from any filenames given. Use -i and -o
+options to override. When using STDIN and/or STDOUT you have to use one or both of these options
+to specify the format of the data. To specify a file format, use the well known file name postfix
+(i.e. pdf for PDF documents) or the official mime type string like application/pdf.
+
+convert pdf to plain text:
+convertible document.pdf document.txt
+
+convert pdf to plain text reading from STDIN:
+convertible -i pdf document.txt < document.pdf
+
+convert pdf to plain text writing to STDOUT:
+convertible -c -o txt document.pdf > document.txt
+
+convert pdf to plain text using both STDIN/STDOUT:
+convertible -i pdf -o txt < document.pdf > document.txt
+
+
+# Querying supported conversions
+
+To query supported conversions or to check wether a given conversion is possible, use the 
+-s switch together with a given input filename or format (-i) and an optional output filename / format:
+
+show all supported conversions:
+convertible -s
+
+show supported output formats for OpenOffice text:
+convertible -s -i odt
+
+check wether doc can be converted to pdf:
+convertible -s -i doc -o pdf
+

data/bin/convertible

@@ -0,0 +1,95 @@
+#!/usr/bin/env/ruby
+
+require 'optparse'
+require 'convertible/cli'
+require 'pp'
+
+@options = { :debug => false }
+@max_file_args = 2
+
+OptionParser.new do |optparser|
+  optparser.banner = <<-HELP
+Usage: convertible [options] [file1 [file2]]
+
+Convert file1 to file2.
+
+Without any file arguments data will be read from STDIN and written to STDOUT.
+If only one filename (file1) is present, data will be read from STDIN and the result will
+be written to file1. Use the -c switch to invert this behaviour so data is
+read from file1 and written to STDOUT.
+
+By default, input and output formats will be guessed from any filenames given. Use -i and -o
+options to override. When using STDIN and/or STDOUT you have to use one or both of these options
+to specify the format of the data. To specify a file format, use the well known file name postfix
+(i.e. pdf for PDF documents) or the official mime type string like application/pdf.
+
+convert pdf to plain text:
+convertible document.pdf document.txt
+
+convert pdf to plain text reading from STDIN:
+convertible -i pdf document.txt < document.pdf
+
+convert pdf to plain text writing to STDOUT:
+convertible -c -o txt document.pdf > document.txt
+
+convert pdf to plain text using both STDIN/STDOUT:
+convertible -i pdf -o txt < document.pdf > document.txt
+
+
+To query supported conversions or to check wether a given conversion is possible, use the 
+-s switch together with a given input filename or format (-i) and an optional output filename / format:
+
+show all supported conversions:
+convertible -s
+
+show supported output formats for OpenOffice text:
+convertible -s -i odt
+
+check wether doc can be converted to pdf:
+convertible -s -i doc -o pdf
+
+Options are:
+HELP
+
+  optparser.on('-h', '--help', "This message") do
+    puts optparser
+    exit
+  end
+
+  optparser.on('-v', '--verbose', "Turn on debug messages") do
+    @options[:debug] = true
+  end
+
+  optparser.on('-s', '--supported', "Show supported conversions.") do
+    @command = :show
+  end
+
+  optparser.on('-i', '--input-format=MIMETYPE', "Specify input format (derived from input filename by default)") do |arg|
+    @options[:input_type] = arg
+  end
+
+  optparser.on('-o', '--output-format=MIMETYPE', "Specify desired output format (derived from output filename by default)") do |arg|
+    @options[:output_type] = arg
+  end
+
+  optparser.on('-c', '--stdout', "Read input from file1 and output to STDOUT") do
+    @out = 'STDOUT'
+    @max_file_args -= 1
+  end
+
+  files = optparser.permute!(ARGV)
+  (puts optparser; exit(1)) unless files.size <= @max_file_args
+  
+  @out ||= files.pop || 'STDOUT'
+  @in = files.pop || 'STDIN'
+  STDERR.puts "#{@in} => #{@out}\n#{@options.inspect}" if @options[:debug]
+
+  @command ||= :convert
+end
+
+begin
+  Convertible::Cli.new(@in, @out, @options).send @command
+rescue ArgumentError
+  STDERR.puts $!
+  exit 1
+end

data/lib/convertible.rb

@@ -0,0 +1,4 @@
+require "convertible/version"
+
+module Convertible
+end

data/lib/convertible/cli.rb

@@ -0,0 +1,80 @@
+require 'convertible/client'
+require 'convertible/mime_types'
+
+module Convertible
+  class Cli
+    def initialize(input, output = nil, options = {})
+      @input = input
+      @output = output
+      @options = options
+    end
+
+    def convert
+      unless @input == 'STDIN' || File.readable?(@input)
+        raise ArgumentError, "cannot open #{@input} for reading"
+      end
+      check_mimetypes
+      $stderr.puts "converting #{@input} to #{@output} with options #{@options.inspect}" if @options[:debug]
+      data = @input == 'STDIN' ? $stdin.read : File.read(@input)
+      response = client.convert data, @input_type, @output_type, @options
+      if @output == 'STDOUT'
+        $stdout << response
+      else
+        (File.open(@output, 'wb') << response).close
+      end
+    end
+
+    def show
+      check_mimetypes false, false
+      if in_t = @input_type
+        if out_t = @output_type
+          if client.supported?(in_t, out_t)
+            puts 'supported'
+          else
+            puts 'not supported' # no worky
+          end
+        else
+          conversions = client.supported_conversions @input_type
+          $stderr.puts "Supported output formats for #{@input_type}:"
+          puts conversions.join(', ')
+        end
+      else
+        conversions = client.supported_conversions
+        $stderr.puts "Supported conversions:"
+        conversions.keys.sort.each do |input|
+          puts "#{input} => " << conversions[input].join(', ')
+        end
+      end
+    end
+
+
+    protected
+
+    def client
+      Client.new
+    end
+
+    def check_mimetypes(need_input = true, need_output = true)
+      if need_input && @input == 'STDIN' && @options[:input_type].nil?
+        raise ArgumentError.new("You need to specify the input mimetype using -i when reading from STDIN!") 
+      end
+      if @input != 'STDIN' || @options[:input_type]
+        unless @input_type = MimeTypes::for(@options[:input_type] || @input)
+          raise ArgumentError.new "Unsupported input file type"
+        end
+      end
+      if need_output && @output == 'STDOUT' && @options[:output_type].nil?
+        raise ArgumentError.new("You need to specify the output mimetype using -o when redirecting to STDOUT!") 
+      end
+      if @output != 'STDOUT' || @options[:output_type]
+        unless @output_type = MimeTypes::for(@options[:output_type] || @output)
+          raise ArgumentError.new "Unsupported output file type"
+        end
+      end
+      if @options[:debug]
+        $stderr.puts "input type: #{@input_type}\noutput type: #{@output_type}"
+      end
+    end
+
+  end
+end

data/lib/convertible/client.rb

@@ -0,0 +1,41 @@
+require 'httparty'
+require 'json'
+
+module Convertible
+  API_ENDPOINT = 'http://api.convertible.io/'
+
+  class Client
+    include HTTParty
+    base_uri API_ENDPOINT
+
+    # content_type and output_content_type must be valid mime types like 'application/pdf' or 'text/plain' 
+    def convert(data, content_type, output_content_type, options = {})
+      response = self.class.post '/convert', :body => data, :headers => { 'Content-Type' => content_type, 'Accept' => output_content_type, 'X-Convert-Options' => option_string(options) }
+      if response.code == 200
+        return response
+      else
+        false
+      end
+    end
+
+    def supported_conversions(input_type = nil)
+      if input_type
+        response = self.class.get '/supported', :query => { :in => input_type }, :format => :json
+        response['out']
+      else
+        response = self.class.get '/supported', :format => :json
+        response['supported']
+      end
+    end
+
+    def supported?(input_type, output_type)
+      response = self.class.get '/supported', :query => { :in => input_type, :out => output_type }, :format => :json
+      response['supported']
+    end
+
+    private
+    def option_string(options = {})
+      options.to_a.map{|opt| opt.join('=')}.join(';')
+    end
+  end
+end

data/lib/convertible/mime_types.rb

@@ -0,0 +1,83 @@
+module Convertible
+  class MimeTypes
+    MIME_TYPES = {
+      'text/plain' => %w(txt),
+      'text/html' => %w(html htm xhtml),
+      'text/xml' => %w(xml xsd mxml),
+      'text/yaml' => %w(yml yaml),
+      'text/csv' => %w(csv),
+      'text/rtf' => %w(rtf),
+      'image/gif' => %w(gif),
+      'image/jpeg' => %w(jpg jpeg jpe),
+      'image/png' => %w(png),
+      'image/tiff' => %w(tiff tif),
+      'image/x-ms-bmp' => %w(bmp),
+      'image/x-xpixmap' => %w(xpm),
+      'application/pdf' => %w(pdf),
+      'application/msword' => %w(doc),
+      'application/vnd.ms-excel' => %w(xls),
+      'application/vnd.ms-powerpoint' => %w(ppt pps),
+      'application/vnd.openxmlformats-officedocument.wordprocessingml.document' => %w(docx),
+      'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' => %w(xlsx),
+      'application/vnd.openxmlformats-officedocument.presentationml.presentation' => %w(pptx),
+      'application/vnd.openxmlformats-officedocument.presentationml.slideshow' => %w(ppsx),
+      'application/vnd.oasis.opendocument.spreadsheet' => %w(ods),
+      'application/vnd.oasis.opendocument.text' => %w(odt),
+      'application/vnd.oasis.opendocument.presentation' => %w(odp),
+      'application/zip' => %w(zip),
+      'application/x-gzip' => %w(gz)
+    }.freeze
+
+    EXTENSIONS = MIME_TYPES.inject({}) do |map, (type, exts)|
+      exts.each {|ext| map[ext] = type}
+      map
+    end
+
+    ALIASES = {
+      'application/pdf' => ['application/x-pdf']
+    }
+
+    ALIAS_LOOKUP = ALIASES.inject({}) do |map, (type, aliases)|
+      aliases.each {|t| map[t] = type}
+      map
+    end
+
+    # input is filename
+    def self.of(name)
+      if name && m = name.to_s.match(/(^|\.)([^\.]+)$/)
+        EXTENSIONS[m[2].downcase]
+      end
+    end
+
+    # input is filename or mime type string (which will be returned as is)
+    def self.for(mimetype)
+      if MIME_TYPES[mimetype]
+        mimetype
+      elsif t = ALIAS_LOOKUP[mimetype]
+        t
+      else
+        of(mimetype)
+      end
+    end
+
+    def self.extension_for(mimetype)
+      if exts = MIME_TYPES[self.for(mimetype)]
+        exts.first
+      end
+    end
+
+    def self.main_mimetype_of(name)
+      mimetype = of(name)
+      mimetype.split('/').first if mimetype
+    end
+
+    def self.image?(mimetype)
+      self.for(mimetype) =~ /^image\/.+/
+    end
+
+    def self.supported?(name_or_mimetype)
+      !self.for(name_or_mimetype).blank?
+    end
+
+  end
+end

data/lib/convertible/version.rb

@@ -0,0 +1,3 @@
+module Convertible
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: convertible
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jens Kraemer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-13 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.7.8
+  type: :runtime
+  version_requirements: *id001
+description: convertible.io is a universal document conversion web service.
+email: 
+- jk@jkraemer.net
+executables: 
+- convertible
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/convertible/cli.rb
+- lib/convertible/client.rb
+- lib/convertible/mime_types.rb
+- lib/convertible/version.rb
+- lib/convertible.rb
+- bin/convertible
+- LICENSE
+- CHANGELOG.md
+- README.md
+- ROADMAP.md
+has_rdoc: true
+homepage: http://github.com/jkraemer/convertible
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: convertible
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: client for the convertible.io online service
+test_files: []
+