heathen-client 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 IFAD
+
+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,87 @@
+<pre>
+    )                          )          )
+ ( /(        (       *   )  ( /(       ( /(
+ )\()) (     )\    ` )  /(  )\()) (    )\())
+((_)\  )\ ((((_)(   ( )(_))((_)\  )\  ((_)\
+ _((_)((_) )\ _ )\ (_(_())  _((_)((_)  _((_)
+| || || __|(_)_\(_)|_   _| | || || __|| \| |
+| __ || _|  / _ \    | |   | __ || _| | .` |
+|_||_||___|/_/ \_\   |_|   |_||_||___||_|\_|
+</pre>
+# Convert the heathens. 
+***
+
+# Heathen::Client
+
+A Ruby client for the [Heathen](https://github.com/ifad/heathen) service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'heathen-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heathen-client
+
+## Usage
+
+### Set the Base URI
+
+Before anything, you will need to set the url of the running Heathen service.
+`Heathen::Client.client = Heathen::Client.new(base_uri: "http://<heathen url>")`
+
+Without the above line, the client will attempt to make API calls against `http://localhost:9292`.
+
+Heathen::Client::pdf takes an options hash with a `file` or `url` key. The `file` key can map to a filesystem path string, or an instance of `IO`. The method returns an instance of `Heathen::Client::Response`.
+
+### Convert a Word document to PDF
+
+In one shot:
+
+```
+Heathen::Client.pdf(file: "/path/to/word.doc").get do |data|
+  File.open("/path/to/saved.pdf", "wb") do |dest|
+    dest.write(data)
+  end
+end
+```
+
+For the lazy:
+
+`response = Heathen::Client.pdf(file: "/path/to/word.doc")`
+
+A little later:
+
+```
+File.open("/path/to/saved.pdf", "wb") do |dest|
+  response.get { |data| dest.write(data) }
+end
+```
+
+### Get the original
+
+```
+File.open("/path/to/saved_original.doc", "wb") do |dest|
+  response.get(:original) { |data| dest.write(data) }
+end
+```
+
+### Converting an image to PDF with searching/selection
+
+`response = Heathen::Client.ocr(file: "/path/to/text_image.tiff")`
+
+Downloading/saving is the same as shown above.
+
+# License
+
+MIT
+
+# Copyright
+
+&copy; IFAD 2013

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+
+desc 'Launch the console'
+task :console do
+  sh "irb -I lib -r heathen-client"
+end

data/heathen-client.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heathen/client/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "heathen-client"
+  gem.version       = Heathen::Client::VERSION
+  gem.authors       = [ "Peter Brindisi" ]
+  gem.email         = [ "p.brindisi@ifad.org" ]
+  gem.description   = %q{ A client for the Heathen server. Convert & download. }
+  gem.summary       = %q{ A client for the Heathen server. }
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = [ "lib" ]
+
+  gem.add_dependency('yajl-ruby',   '~> 1.1.0')
+  gem.add_dependency('rest-client', '~> 1.6.7')
+end

data/lib/heathen-client.rb

@@ -0,0 +1,82 @@
+require 'heathen/client/version'
+require 'heathen/client/interface'
+require 'heathen/client/response'
+
+require 'uri'
+require 'yajl'
+require 'rest_client'
+require 'pathname'
+
+module Heathen
+  class Client
+
+    extend Interface
+
+    DEFAULT_BASE_URI = 'http://localhost:9292'
+
+    class << self
+      def client
+        @client ||= new
+      end
+
+      def client=(c)
+        @client = c
+      end
+    end
+
+    def initialize(options = { })
+      @base_uri = URI.parse(options.fetch(:base_uri, DEFAULT_BASE_URI))
+    end
+
+    def convert(action, options)
+
+      options.merge!(action: action)
+      headers = {
+        content_type: :json,
+        accept: :json
+      }
+
+      # in Rails, Hash has a read method, but this makes
+      # RestClient think that the hash is a File.
+      #
+      # this fixes compatitbility with Rails without
+      # needing to patch RestClient
+      class << options
+        def respond_to?(*args)
+          args.first.to_s == 'read' ? false : super
+        end
+      end
+
+      RestClient.post(@base_uri.to_s + '/convert', options, headers) do |response|
+        Response.new(self, response.body)
+      end
+    end
+
+    def download(url, options)
+      file = options.fetch(:file, nil)
+      dir  = file ? nil : Pathname(options.fetch(:dir))
+
+      if dir && !dir.directory?
+        raise "Not a directory: #{dir}"
+
+      elsif !file || (file && !file.respond_to?(:write))
+        raise 'File or directory must be given.'
+      end
+
+      RestClient.get((@base_uri + URI.parse(url).path).to_s) do |response|
+        disposition = response.headers[:content_disposition]
+        filename    = URI.decode(disposition.match(/filename\=\"(.+?)\"/)[1])
+
+        if dir
+          File.open(dir + filename, "wb") { |f| f.write(response.body) }
+        else
+          file.write(response.body)
+        end
+
+        if file
+          file.close
+        end
+      end
+    end
+  end
+end

data/lib/heathen/client/interface.rb

@@ -0,0 +1,35 @@
+module Heathen
+  class Client
+    module Interface
+
+      def pdf(args = { })
+        convert(:pdf, shared_args(args))
+      end
+
+      def ocr(args = { })
+        convert(:ocr, shared_args(args).merge(language: args.fetch(:language)))
+      end
+
+      def convert(action, options)
+        client.convert(action, options)
+      end
+
+      private
+
+        def shared_args(args)
+
+          shared = { }
+
+          if file = args[:file]
+            shared[:file]      = file.is_a?(IO) ? file : File.new(file, "rb")
+            shared[:multipart] = true
+
+          elsif url = args[:url]
+            shared[:url] = URL.parse(url).to_s
+          end
+
+          shared
+        end
+    end
+  end
+end

data/lib/heathen/client/response.rb

@@ -0,0 +1,65 @@
+module Heathen
+  class Client
+    class Response
+
+      attr_reader :data
+
+      def initialize(client, response)
+        @client = client
+        @status = response.code
+        begin
+          @data = Yajl::Parser.parse(response.body)
+        rescue Exception
+          @data = { 'error' => 'Internal Server Error' }
+        end
+      end
+
+      def original(file = nil)
+        url('original', file)
+      end
+
+      def converted(file = nil)
+        url('converted', file)
+      end
+
+      def error
+        data['error']
+      end
+
+      def success?
+        error.nil?
+      end
+
+      def error?
+        !error.nil?
+      end
+
+      # yields data to block
+      def get(which = :converted, &block)
+        unless error?
+          RestClient.get(send(which), &block)
+        end
+      end
+
+      # convenience method
+      def download(args = { })
+        File.open(args[:path], "wb") do |dest|
+          get(args.fetch(:which, :converted)) do |data|
+            dest.write(data)
+          end
+          dest.path
+        end
+      end
+
+      protected
+
+        def url(which, file = nil)
+          data[which.to_s].tap do |u|
+            if u && file
+              @client.download(u, file: file)
+            end
+          end
+        end
+    end
+  end
+end

data/lib/heathen/client/version.rb

@@ -0,0 +1,5 @@
+module Heathen
+  class Client
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: heathen-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Peter Brindisi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+description: ! ' A client for the Heathen server. Convert & download. '
+email:
+- p.brindisi@ifad.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- heathen-client.gemspec
+- lib/heathen-client.rb
+- lib/heathen/client/interface.rb
+- lib/heathen/client/response.rb
+- lib/heathen/client/version.rb
+homepage: ''
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A client for the Heathen server.
+test_files: []
+has_rdoc: