fileturn 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDM5ODQ3OTRjNzQ1YTczNDViZDIzNTJjNjkzZWQ0MjUyMmU3NDQxNw==
+  data.tar.gz: !binary |-
+    NmU0OGY3MTg4ZDQyMmUxMmY0ZTMwNGZkNDc3ZTA4NTRjN2FhYzY3ZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MzBkYmNlOGY1MDY4ZTk5ZmRlNjVlZGU5M2M0NWI0YzMxNTk2OWJkYmRkZjAw
+    OGM0MDIzNjYxNzE3MTQ0ODJhMjJmMzJiODVlOWE2NDJhMDdmNzc3MWM4OGNj
+    MTQyOWNjZjJmM2NmOTRkMTFiNjIwN2RiOTJhYWFjNWQ5MTU0NTY=
+  data.tar.gz: !binary |-
+    MzIzYWYyOGViYTExOTFjZjI4MmQ2YzAxMDViYWY3MjkwNmUxNDVhMzk0NTYw
+    MjU5OGI5NmI5ZGQ0MGRkYTBkMjkzMmIzZDI2ZTE0NzBiODkzNWNlMmMwOGQ0
+    MzdhMWJiY2RlMzAxMzExYTJmNWNiMDgwMGEyZGQ5N2ZkODQ1ZGM=

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 fileturn.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nisarg Shah
+
+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,107 @@
+# Fileturn
+
+Ruby Gem Support for [FileTurn](http://fileturn.net/) Api. FileTurn converts your files to different formats. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fileturn'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fileturn
+
+## Configuration
+
+Retrieve your API Key from [Dashboard](http://fileturn.net/dashboard/api_token).
+
+	FileTurn.configure(:api_key => "[YOUR KEY]")
+	
+Thats it - now you are ready to use FileTurn.
+
+## Usage
+
+### Converting your files
+
+There are multiple ways to convert a file. If your file is public, we can fetch the file and you just need to specify the url. 
+
+	file = FileTurn::File.convert(
+		:url => "http://crypto.stanford.edu/DRM2002/darknet5.doc",
+		:convert_to => :pdf
+	)
+	
+	unless file.errors
+		# Woot done!
+	end
+
+If your file is stored locally, you can use
+
+	file = FileTurn::File.convert(
+		:file => File.open("localfile.doc"),
+		:convert_to => :txt
+	)
+
+Thats all you have to do to convert files. Upon calling that, your file will be queued for converting. 
+
+### How will i know when my file is done?
+
+#### File Object
+
+There are few ways to check if your file is done. You can repeatedly call one of these:
+
+	file.reload.queued? 
+	file.reload.success?
+	file.reload.failed?
+
+When your file is done, the file object will store a download link
+
+	while(file.reload.queued?)
+		sleep(5000)
+	end
+	
+	if file.success?
+		download_url = file.download_url
+		time_taken_for_conversion = file.time_taken
+	end
+
+In the case you get a failure, you can retrieve the details using
+
+	if(file.reload.failed?)
+		file.notifications.last.details
+	end
+
+#### Notifications
+
+You can also request notification to be sent to you whenver the status of a file changes. Go into your [Dashboard](http://fileturn.net/dashboard/notifications) and specify a notification url. 
+
+We will hit this notification url with the new status of the file and the file_id. 
+
+
+## Other File Options
+
+You can fetch information of a single file using the file_id.
+
+	FileTurn::File.find(file_id)
+
+Or all the files
+	
+	FileTurn::File.all
+
+
+## Account Details
+
+You can also fetch account details like how much credit you have. 
+
+	FileTurn::Account.load # fetch data from server
+	FileTurn::Account.credits
+
+Or you can use
+
+	FileTurn::Account.load.credits
+
+Thanks!

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fileturn.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fileturn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fileturn"
+  spec.version       = Fileturn::VERSION
+  spec.authors       = ["Nisarg Shah"]
+  spec.email         = ["nisargshah100@gmail.com"]
+  spec.description   = %q{FileTurn Client}
+  spec.summary       = %q{FileTurn Client}
+  spec.homepage      = ""
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "faraday"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

data/lib/fileturn/exceptions.rb

@@ -0,0 +1,30 @@
+module FileTurn
+  
+  class FileTurnException < Exception
+    attr_reader :resp
+    def initialize(resp)
+      @resp = resp
+    end
+
+    def to_s
+      resp
+    end
+  end
+
+  class UnauthorizedException < FileTurnException; end;
+  class InternalServerException < FileTurnException; end;
+
+  class UnprocessableEntityException < FileTurnException
+    attr_reader :parsed_response
+    
+    def initialize(resp)
+      super(resp)
+      @parsed_response = OpenStruct.new(JSON.parse(resp.body))
+    end
+
+    def to_s
+      @parsed_response.to_s
+    end
+  end
+
+end

data/lib/fileturn/http_client.rb

@@ -0,0 +1,49 @@
+require 'faraday'
+require 'json'
+require 'ostruct'
+
+module FileTurn
+  class HttpClient
+
+    def self.conn
+      @conn ||= Faraday.new(:url => 'http://fileturn.net/')
+    end
+
+    def self.get(url, params, status_codes, &block)
+      make_call(:get, url, params, status_codes, &block)
+    end
+
+    def self.post(url, params, status_codes, &block)
+      make_call(:post , url, params, status_codes, &block)
+    end
+
+
+    def self.make_call(type, url, params, status_codes, &block)
+      params = setup_params(params)
+      resp = conn.send(type, "api/#{url}") { |req| req.params = params }
+      if Array(status_codes).include?(resp.status)
+        block.call(JSON.parse(resp.body))
+      else
+        handle_error(resp)
+      end
+    end
+
+    def self.setup_params(params)
+      params['token'] = FileTurn.api_key
+      params
+    end
+
+    def self.handle_error(resp)
+      case resp.status
+      when 401
+        raise FileTurn::UnauthorizedException.new(resp)
+      when 500
+        raise FileTurn::InternalServerException.new(resp)
+      when 422
+        OpenStruct.new(JSON.parse(resp.body))
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/fileturn/resources/account.rb

@@ -0,0 +1,46 @@
+module FileTurn
+  class Account < Resource
+   
+    class << self
+      @account = OpenStruct.new()
+
+      def load
+        conn.get("/users.json", {}, 200) do |params|
+          params['created_at'] = DateTime.parse(params['created_at'])
+          @account = OpenStruct.new(params)
+          self
+        end
+      end
+
+      def load_only_if_not_loaded
+        load if @account.nil? || @account.id.nil?
+        self
+      end
+
+      def id
+        @account.id
+      end
+
+      def credits
+        @account.credits
+      end
+
+      def created_at
+        @account.created_at
+      end
+
+      def notification_url
+        @account.notification_url
+      end
+
+      def time_zone
+        @account.time_zone
+      end
+
+      def max_file_size_in_bytes
+        @account.max_file_size_in_bytes
+      end
+    end
+
+  end
+end

data/lib/fileturn/resources/file.rb

@@ -0,0 +1,112 @@
+module FileTurn
+  class File < Resource
+   
+    # class
+    class << self
+      
+      def find(id, &block)
+        conn.get("/files/#{id}.json", {}, 200) do |params|
+          block ? block.call(params) : File.new(params)
+        end
+      end
+
+      def all
+        conn.get("files.json", {}, 200) do |params|
+          files = Array(params['files']).map { |p| File.new(p) }
+          OpenStruct.new(
+            :files => files, 
+            :total_files => params['total_files'],
+            :current_page => params['current_page'],
+            :per_page => params['per_page'],
+            :total_pages => params['total_pages']
+          )
+        end
+      end
+
+      def convert(params)
+        file = params['file'] || params[:file]
+        return upload_file(file, params) unless file.nil?
+
+        conn.post("files.json", params, 201) do |params|
+          File.new(params)
+        end
+      end
+
+    private
+
+      def upload_file(file, params)
+        evaluate_file_size = FileTurn::Upload.send(:evaluate_file_size, file)
+        return evaluate_file_size unless evaluate_file_size.nil?
+
+        signed_params = FileTurn::Upload.send(:signed_upload_url, file)
+        return signed_params if signed_params.errors
+
+        faraday = Faraday.new(:url => signed_params.url) do |conn| 
+          conn.request :multipart
+          conn.adapter :net_http
+        end
+
+        response = faraday.post '/', {
+          :policy => signed_params.policy,
+          :signature => signed_params.signature,
+          'AWSAccessKeyId' => signed_params.aws_access_key_id,
+          :key => signed_params.key,
+          :file => Faraday::UploadIO.new(file.path, '')
+        }
+
+        if response.status == 204
+          params[:file] = params['file'] = nil
+          params['url'] = "#{signed_params.url}/#{signed_params.key}"
+          params['file_type'] = signed_params.file_type
+          params['upload_id'] = signed_params.id
+          convert(params)
+        end
+      end
+
+    end
+
+    #vars
+    attr_accessor :id, :url, :convert_to, :created_at, :status,
+                  :download_url, :notifications, :params
+
+    # instance
+    def initialize(params={})
+      parse_json_params(params)
+    end
+
+    def success?
+      status == 'processed'
+    end
+
+    def failed?
+      status == 'failed'
+    end
+
+    def queued?
+      status == 'queued'
+    end
+
+    def reload
+      File.find(id) { |params| parse_json_params(params) }
+      self
+    end
+
+    def time_taken
+      notifications.last && notifications.last.time_taken
+    end
+
+private
+
+    def parse_json_params(params)
+      @params = params
+      @id = params['id']
+      @url = params['url']
+      @convert_to = params['convert_to']
+      @created_at = DateTime.parse(params['created_at'])
+      @status = params['status']
+      @download_url = params['download_url']
+      @notifications = Array(params['notifications']).map { |p| Notification.new(p) }
+    end
+
+  end
+end

data/lib/fileturn/resources/notification.rb

@@ -0,0 +1,16 @@
+module FileTurn
+  class Notification < Resource
+    attr_reader :id, :details, :parsed_time, :status, :time_taken,
+                :file_id, :params
+
+    def initialize(params)
+      @params = params
+      @id = params['id']
+      @details = params['details']
+      @parsed_time = DateTime.parse(params['parsed_time']) if params['parsed_time']
+      @status = params['status']
+      @time_taken = params['time_taken'].to_f if params['time_taken']
+      @file_id = params['doc_id']
+    end
+  end
+end

data/lib/fileturn/resources/resource.rb

@@ -0,0 +1,17 @@
+module FileTurn
+  class Resource
+    
+    # class
+    class << self
+      def conn
+        FileTurn::HttpClient
+      end
+    end
+
+    # instance
+    def errors
+      false
+    end
+
+  end
+end

data/lib/fileturn/resources/upload.rb

@@ -0,0 +1,77 @@
+module FileTurn
+  class Upload < Resource
+   
+    # class
+    class << self
+      
+      def find(id, &block)
+        conn.get("/uploads/#{id}.json", {}, 200) do |params|
+          block ? block.call(params) : Upload.new(params)
+        end
+      end
+
+      def all
+        conn.get("uploads.json", {}, 200) do |params|
+          uploads = Array(params['uploads']).map { |p| Upload.new(p) }
+          OpenStruct.new(
+            :uploads => uploads, 
+            :total_uploads => params['total_uploads'],
+            :current_page => params['current_page'],
+            :per_page => params['per_page'],
+            :total_pages => params['total_pages']
+          )
+        end
+      end
+
+    private
+
+      def signed_upload_url(file)
+        file_type = file.class.extname(file.path).gsub('.', '')
+        file_type = 'unknown' if file_type == ''
+        file_size = file.class.size(file.path)
+
+        conn.post('files/upload.json', { content_type: file_type, content_length: file_size }, 201) do |params|
+          params['file_type'] = file_type
+          params['file_size'] = file_size
+          OpenStruct.new(params)
+        end
+      end
+
+      def evaluate_file_size(file)
+        max_size = Account.load_only_if_not_loaded.max_file_size_in_bytes
+        if file.size > max_size
+          OpenStruct.new(:errors => {"file_size"=>["is too big"]})
+        end
+      end
+
+    end
+
+    #vars
+    attr_accessor :id, :url, :policy, :signature, :aws_access_key_id, :key,
+                  :params
+
+    # instance
+    def initialize(params={})
+      parse_json_params(params)
+    end
+
+    def reload
+      Upload.find(id) { |params| parse_json_params(params) }
+      self
+    end
+
+private
+
+    def parse_json_params(params)
+      @params = params
+      @id = params['id']
+      @url = params['url']
+      @policy = params['policy']
+      @signature = params['signature']
+      @aws_access_key_id = params['aws_access_key_id']
+      @key = params['key']
+      @url = params['url']
+    end
+
+  end
+end

data/lib/fileturn/version.rb

@@ -0,0 +1,3 @@
+module Fileturn
+  VERSION = "0.0.2"
+end

data/lib/fileturn.rb

@@ -0,0 +1,19 @@
+module FileTurn
+  extend self
+
+  attr_reader :api_key
+
+  def configure(params={})
+    raise ArgumentError, "missing params (api_key)" if params[:api_key].nil?
+    @api_key = params[:api_key]
+  end
+end
+
+require 'date'
+require "fileturn/exceptions"
+require "fileturn/http_client"
+require "fileturn/resources/resource"
+require "fileturn/resources/account"
+require "fileturn/resources/upload"
+require "fileturn/resources/notification"
+require "fileturn/resources/file"

data/spec/fileturn_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe FileTurn do
+
+  describe '#configure' do
+    it 'sets up api key' do
+      FileTurn.configure(:api_key => "123")
+      FileTurn.api_key.should == "123"
+    end
+
+    it 'raises exception if not api key is passed' do
+      expect { FileTurn.configure({}) }.to raise_error
+    end
+  end
+
+end

data/spec/fixtures/vcr_cassettes/account_info.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3000/api/users.json?token=67sFfjudMpXxJeioQcPSppYkoVdQD1oetqPWzMAh
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.7
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: ! 'OK '
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - ! '"108135fed6135342e058ab4865b5301f"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 3f36878be082fdb201b2015c688aa367
+      X-Runtime:
+      - '0.112629'
+      Server:
+      - WEBrick/1.3.1 (Ruby/1.9.3/2012-11-10)
+      Date:
+      - Sun, 07 Jul 2013 22:46:58 GMT
+      Content-Length:
+      - '177'
+      Connection:
+      - Keep-Alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"id":8,"created_at":"2013-07-05T22:14:10Z","credits":27836,"notification_url":"http://localhost:3000","time_zone":"Eastern
+        Time (US & Canada)","max_file_size_in_bytes":1048576}'
+    http_version: 
+  recorded_at: Sun, 07 Jul 2013 22:46:58 GMT
+recorded_with: VCR 2.4.0