file-convert 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ab5545b631ce1b728c55f51238e30c3f55e3459
+  data.tar.gz: 6c0170fd117a7030326857e34124102dbe57fe37
+SHA512:
+  metadata.gz: 94c4e4c7dfec2285946452d565195756dfd761e9ffd3d448d5bf098ac30c667e0bcf17dddf059620f7865687d9a10aa4f44cdc996b508105d7740023feeb20e9
+  data.tar.gz: 33172e266792bd45830551e68d0a6641a350363189b91697d298d9acb48ea37b928beaace5c37a98e33602cb39bfff7e9c00b25e5f920c9fb43b45e8a9270014

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Roman Ernst and tolingo GmbH
+
+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,79 @@
+# file-convert [![Build Status](https://travis-ci.org/tolingo/file-convert.svg?branch=feature%2Ffix-specs-and-refactor)](https://travis-ci.org/tolingo/file-convert) [![Test Coverage](https://codeclimate.com/repos/53f4984b6956807963019c1a/badges/7aef33ebfd86eb320a98/coverage.svg)](https://codeclimate.com/repos/53f4984b6956807963019c1a/feed) [![Code Climate](https://codeclimate.com/repos/53f4984b6956807963019c1a/badges/7aef33ebfd86eb320a98/gpa.svg)](https://codeclimate.com/repos/53f4984b6956807963019c1a/feed) [![Dependency Status](https://gemnasium.com/tolingo/file-convert.svg)](https://gemnasium.com/tolingo/file-convert)
+
+> Use google-api-ruby-client and Google Drive to convert files from one mime-type to another.
+For available formats see [Google Drive API Export Formats](https://developers.google.com/drive/web/integrate-open#open_and_convert_google_docs_in_your_app).
+
+## Installation
+
+Simply add it to your Gemfile:
+
+```ruby
+gem 'file-convert'
+```
+
+## Config
+
+### Via initializer
+
+`FileConvert` exposes `.configure` which accepts a block and passes the config hash.
+*Example*:
+
+```ruby
+FileConvert.configure do |config|
+  config['google_service_account'] = {
+    'email' => '<strange-hash>@developer.gserviceaccount.com',
+    'pkcs12_file_path' => 'config/file_convert_key.p12'
+  }
+end
+```
+
+### Via YAML
+
+You need to add a YAML configuration file to `/config/file_convert.yml` that looks like `config/file_convert.sample.yml`.
+
+In order to communicate with the Google API, `file_convert` requires a google developer email Address (`email`) and `pkcs12_file_path`.
+
+Visit [Google Developers Console](console.developers.google.com) and check **Credentials**.
+Here you can add a *new Client ID*. Select **Service Account** as application type.
+
+You should now be able to download your *P12 key* and see your *developer email address*.
+Place the *P12 key* somewhere accessible for your app and provide the location to the config. The sample config assumes your *P12 key* is located in `/config/file_convert_key.p12`.
+
+Sample config as in `file_convert.samle.yml`:
+```yaml
+file_convert:
+  google_service_account:
+    email: '<strange-hash>@developer.gserviceaccount.com'
+    pkcs12_file_path: 'config/file_convert_key.p12'
+```
+
+## Examples
+
+```ruby
+# converts `path_to_some_file` from <txt> to <pdf>
+conversion = FileConvert.convert('path_to_some_file.txt', 'text/plain', 'application/pdf')
+# converted body is accessible via `#body`
+conversion.body
+# .. or define a path to save the converted document to
+conversion.save('path_to_new_file.pdf')
+```
+
+## Specs
+
+* `$ bundle exec rake` for `rspec` and `rubocop`.
+* `$ bundle exec rake build` to also run the `integration` tests located at `spec/integration/**/*_integration.rb`.
+Note that you need to have a valid `config/file_convert.yml` present for these tests to work,
+since we want to actually test the integration with the Google API here. (Do not worry, TravisCI will run these test as well.)
+
+## Contributing
+
+In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using the ways described [above](#specs).
+
+## Next Steps
+
+* Enable OCR if necessary when uploading files
+* Add CLI
+* Add different adapter than Google?
+
+## License
+file-convert is Copyright © 2014 [Roman Ernst](http://farbenmeer.net) and [tolingo GmbH](http://tolingo.com) and may be redistributed under the terms specified in the [LICENSE](https://github.com/tolingo/file-convert/blob/master/LICENSE) file.

data/lib/file_convert.rb

@@ -0,0 +1,34 @@
+module FileConvert
+  require 'file_convert/version'
+  require 'file_convert/exception'
+  require 'file_convert/configure'
+  require 'file_convert/client'
+  require 'file_convert/file'
+  require 'file_convert/upload'
+  require 'file_convert/conversion'
+
+  extend FileConvert::Configure
+
+  FileConvert::Configure.init_config!
+
+  ###
+  # @param [String] file_path
+  #   Source file for conversions
+  # @param [String]
+  #   Source file mime-type
+  # @param [String]
+  #   Target file mime-type (converion target)
+  #
+  # @return [FileConvert::Conversion]
+  def self.convert(file_path, source_mime_type, target_mime_type)
+    upload = FileConvert::Upload.new(client, file_path, source_mime_type)
+    FileConvert::Conversion.new(client, upload.file, target_mime_type)
+  end
+
+  ###
+  # Initialize a new FileConvert::Client
+  def self.client
+    fail Exception::MissingConfig unless config_present?
+    @client ||= FileConvert::Client.new
+  end
+end

data/lib/file_convert/client.rb

@@ -0,0 +1,40 @@
+module FileConvert
+  require 'google/api_client'
+
+  class Client < Google::APIClient
+    APP_OPTIONS = {
+      application_name: 'file-convert',
+      application_version: FileConvert::Version::STRING
+    }
+
+    attr_reader :drive
+
+    ###
+    # Inherits from Google::APIClient
+    # Basically wraps authentiation for simple configuration
+    #
+    # @return [FileConvert::Client] (inherits from Google::APIClient)
+    def initialize
+      gaccount = FileConvert.config['google_service_account']
+      gaccount['auth_url'] ||= 'https://www.googleapis.com/auth/drive'
+
+      key = load_key gaccount['pkcs12_file_path'], 'notasecret'
+      asserter = get_asserter gaccount['email'], gaccount['auth_url'], key
+
+      super(APP_OPTIONS).tap do |client|
+        client.authorization = asserter.authorize
+        @drive = client.discovered_api('drive', 'v2')
+      end
+    end
+
+    private
+
+    def load_key(path, secret)
+      Google::APIClient::PKCS12.load_key(path, secret)
+    end
+
+    def get_asserter(email, auth_url, key)
+      Google::APIClient::JWTAsserter.new email, auth_url, key
+    end
+  end
+end

data/lib/file_convert/configure.rb

@@ -0,0 +1,41 @@
+module FileConvert
+  module Configure
+    require 'yaml'
+
+    DEFAULT_CONFIG_PATH = 'config/file_convert.yml'
+
+    def self.config_yaml_present?
+      ::File.exist?(DEFAULT_CONFIG_PATH)
+    end
+
+    def self.config_from_yaml
+      ::File.open(DEFAULT_CONFIG_PATH) do |file|
+        YAML.load(file)['file_convert']
+      end
+    end
+
+    def self.config
+      @@config
+    end
+
+    ###
+    # Loads config/file_convert.yml['file_convert'] into Config
+    # Or defaults to empty Hash if config file is not present
+    def self.init_config!
+      @@config = config_yaml_present? ? config_from_yaml : {}
+    end
+
+    def configure
+      yield config
+    end
+
+    def config
+      Configure.config
+    end
+
+    def config_present?
+      provider = 'google_service_account'
+      config.is_a?(Hash) && config.key?(provider)
+    end
+  end
+end

data/lib/file_convert/conversion.rb

@@ -0,0 +1,70 @@
+module FileConvert
+  class Conversion
+    attr_reader :file
+    attr_reader :body
+
+    ##
+    # Downloads remote file from Google Drive with given mime_type
+    #
+    # @param [FileConvert::Client] client
+    # @param [FileConvert::File] remote_file
+    # @param [String] mime_type
+    #   Target mime_type the file gets converted to
+    #
+    # @return [FileConvert::File] remote_file with requested #conversions
+    def initialize(client, remote_file, mime_type)
+      @client = client
+      @remote_file = remote_file
+      @original_file_data = remote_file.data
+      @mime_type = mime_type
+
+      # Raise if requested mime-type is not available
+      fail missing_mime_type_exception unless export_links.key?(mime_type)
+      fail data_error_exception if @original_file_data.to_hash.key?('error')
+
+      @file = fetch_file
+      @body = @file.body
+      @remote_file.add_conversion(mime_type, self)
+    end
+
+    ##
+    # Saves result as file
+    # @param [String] target_path
+    #
+    # @return [FileConvert::Conversion]
+    def save(target_path)
+      ::File.open(target_path, 'w') { |file| file.write(@file.body) }
+    end
+
+    private
+
+    ##
+    # @return [Hash] available mime-type download URIs
+    def export_links
+      @original_file_data['exportLinks'].to_hash
+    end
+
+    ###
+    # Actually downloads the file
+    # Raises if request was not successfull
+    #
+    # @return [Google::APIClient::Result]
+    def fetch_file
+      @client.execute(uri: export_links[@mime_type]).tap do |result|
+        fail connection_error_exception unless result.status == 200
+      end
+    end
+
+    def data_error_exception
+      Exception::UploadedFileDataError.new(@original_file_data)
+    end
+
+    def missing_mime_type_exception
+      Exception::MissingConversionMimeType.new(@mime_type, export_links.keys)
+    end
+
+    def connection_error_exception
+      Exception::DownloadConnectionError.new(@file['error']['message'])
+    end
+  end
+end

data/lib/file_convert/exception.rb

@@ -0,0 +1,55 @@
+module FileConvert
+  module Exception
+    class MissingConversionMimeType < StandardError
+      def initialize(requested_mime_type, available_mime_types)
+        super()
+        @requested_mime_type = requested_mime_type
+        @available_mime_types = available_mime_types
+      end
+
+      def message
+        ''"
+          The requested mime type '#{@requested_mime_type}' is not available.
+          Available mime types: #{@available_mime_types.join(', ')}.
+        "''
+      end
+    end
+
+    class UploadedFileDataError < StandardError
+      def initialize(file_data)
+        super()
+        @file_data = file_data
+      end
+
+      def message
+        ''"
+          An error occured while uploading the file.
+          Data was: #{@file_data}
+        "''
+      end
+    end
+
+    class DownloadConnectionError < StandardError
+      def initialize(error_message)
+        super()
+        @error_message = error_message
+      end
+
+      def message
+        ''"
+          An error occured connection to Google Drive.
+          Error message was: #{@error_message}
+        "''
+      end
+    end
+
+    class MissingConfig < StandardError
+      def message
+        ''"
+          Please define a config for FileConvert.
+          See https://github.com/tolingo/file-convert#config for default.
+        "''
+      end
+    end
+  end
+end

data/lib/file_convert/file.rb

@@ -0,0 +1,30 @@
+module FileConvert
+  class File
+    attr_reader :original_file
+    attr_reader :data
+    attr_reader :conversions
+
+    ##
+    # Hold original and conversion
+    #
+    # @params [File] original_file
+    #
+    # @return [FileConvert::File]
+    def initialize(original_file)
+      @original_file = original_file
+      @data = original_file.data
+      @conversions = {}
+    end
+
+    ##
+    # Adds a new conversion
+    #
+    # @param [String] mime_type
+    # @param [File] converted_file
+    #
+    # @return [FileConvert::File] (self)
+    def add_conversion(mime_type, converted_file)
+      tap { @conversions[mime_type] = converted_file }
+    end
+  end
+end

data/lib/file_convert/upload.rb

@@ -0,0 +1,50 @@
+module FileConvert
+  class Upload
+    DEFAULT_PARAMS = {
+      'uploadType' => 'multipart',
+      'convert' => true,
+      'alt' => 'json'
+    }
+
+    attr_reader :file
+
+    ##
+    # Uploads file to Google Drive
+    #
+    # @param [FileConvert::Client] client
+    # @param [String] file_path
+    #   File to upload
+    # @param [String] mime_type
+    #   Source mime_type of upload-file
+    #
+    # @return [FileConvert::File] New File object without conversions yet
+    def initialize(client, file_path, mime_type)
+      @client = client
+      @file_path = file_path
+      @mime_type = mime_type
+
+      uploaded_file = client.execute(
+        api_method: client.drive.files.insert,
+        body_object: touch_file,
+        media: upload_io,
+        parameters: DEFAULT_PARAMS
+      )
+
+      @file = FileConvert::File.new(uploaded_file)
+    end
+
+    private
+
+    def touch_file
+      @client.drive.files.insert.request_schema.new(
+        'title' => SecureRandom.uuid,
+        'description' => 'FileConvert Conversion-File',
+        'mimeType' => @mime_type
+      )
+    end
+
+    def upload_io
+      Google::APIClient::UploadIO.new(@file_path, @mime_type)
+    end
+  end
+end

data/lib/file_convert/version.rb

@@ -0,0 +1,9 @@
+module FileConvert
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: file-convert
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Roman Ernst
+- Jan Raasch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.25.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.25.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: Uses google-api-ruby-client and Google Drive to convert files from one
+  mime-type to another
+email:
+- rernst@farbenmeer.net
+- jan@janraasch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/file_convert.rb
+- lib/file_convert/client.rb
+- lib/file_convert/configure.rb
+- lib/file_convert/conversion.rb
+- lib/file_convert/exception.rb
+- lib/file_convert/file.rb
+- lib/file_convert/upload.rb
+- lib/file_convert/version.rb
+homepage: https://github.com/tolingo/file-convert
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0.rc.1
+signing_key: 
+specification_version: 4
+summary: Instrumentalize Google Drive to convert files
+test_files: []