fileturn 0.0.3 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NmM2NzU5ZGFhMjI1MDA2Yjg0MjRkNjdiZDY4ODBkYThiZmEwZDU3Ng==
-  data.tar.gz: !binary |-
-    MDhiNWJjNmY2NDEyNGE4NzFiYjNiMTQyMmI4NGI3NGE4OGI1NjNiZQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    N2NlNTViYzY3NDM0NzEzZTgxNjY5NzhlNTc0MDViNDc1YmI3MzgyM2VlMjBl
-    ZWI2MzQ5MzY2MDMzY2EwYzdhMzY3NmFlMTY1Yzk1YTI4NmJiM2YxODBmYjZk
-    N2RlZmVjOGU4OTNlYjY1YTY4MjQ1MTBkMzlkMzYwNTRjOTFiZDM=
-  data.tar.gz: !binary |-
-    Y2I4NTM4OTc1NDYwZmIwYTI4OTczNjQ5YzU1ZjhiNzJhYWYyODRkMTQ2NjRl
-    MGQ0ZjAxNGUwMGVkMzUyNWIzZDhjOTMzMTljZTAyZDJmNDNiNTliZTBmMWIx
-    ZGJmNDA4ZTRhZDZjYzg2NjgyYmVhZjY2MGJjNzFhMzljYzU1YTg=
+SHA1:
+  metadata.gz: b1e266a662ba0d15012786458ba4c998e666c3bd
+  data.tar.gz: 0ef5ef52edf12544be1eab58c62503ff4ebea28c
+SHA512:
+  metadata.gz: cf51f11c32f8b4b681ba3ab16a34be19fa7d29c1a389511862e92cd5652fbe35839b90f4211aba2aab29d1292c202df69bd06007c4a755af8662d2596120bbd4
+  data.tar.gz: f54833ad9c3a13e2ad375fa3191c1e817a662f6ceaa3cb4dfdfb42b0d37d40655035240e0c3fe5fa01b6d367c9790d8a810c182cf3b477ff3581e14375d9432c

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/README.md

@@ -1,6 +1,6 @@
 # Fileturn
 
-Ruby Gem Support for [FileTurn](http://fileturn.net/) Api. FileTurn converts your files to different formats. 
+Ruby Gem Support for [FileTurn](https://fileturn.net/) Api. FileTurn converts your files to different formats. 
 
 ## Installation
 
@@ -18,9 +18,9 @@ Or install it yourself as:
 
 ## Configuration
 
-Retrieve your API Key from [Dashboard](http://fileturn.net/dashboard/api_token).
+Retrieve your API Token from [Dashboard](https://fileturn.net/dashboard/api_token).
 
-	FileTurn.configure(:api_key => "[YOUR KEY]")
+	FileTurn.configure(:api_token => "[YOUR KEY]")
 	
 Thats it - now you are ready to use FileTurn.
 
@@ -30,78 +30,83 @@ Thats it - now you are ready to use FileTurn.
 
 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(
+	conversion = FileTurn::Conversion.process!(
 		:url => "http://crypto.stanford.edu/DRM2002/darknet5.doc",
-		:convert_to => :pdf
+		:type => "WordToPdf"
 	)
-	
-	unless file.errors
-		# Woot done!
-	end
 
 If your file is stored locally, you can use
 
-	file = FileTurn::File.convert(
+	file = FileTurn::Conversion.process!(
 		:file => File.open("localfile.doc"),
-		:convert_to => :txt
+		:type => "WordToPdf"
 	)
 
-Thats all you have to do to convert files. Upon calling that, your file will be queued for converting. 
+Thats all you have to do to convert files. Upon calling that, your file will be queued for converting. If there is an error queuing your file, an exception with base class of `FileTurn::FileTurnError` will be thrown. 
+
+Working with errors:
 
-### How will i know when my file is done?
+	begin
+		file = FileTurn::Conversion.process!(
+			:file => File.open("localfile.doc"),
+			:type => "WordToPdf"
+		)
+	rescue FileTurn::FileTurnError => ex
+		# conversion queueing failed 
+	end
+
+### How will i know when my conversion is done?
 
-#### File Object
+#### Conversion 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?
+	conversion.reload!.completed? 
+	conversion.reload!.failed?
+	conversion.reload!.processing?
+	conversion.reload!.created?
 
-When your file is done, the file object will store a download link
+When your conversion is done, the conversion object will have temporary download urls.
 
-	while(file.reload.queued?)
-		sleep(5000)
-	end
-	
-	if file.success?
-		download_url = file.download_url
-		time_taken_for_conversion = file.time_taken
+	if conversion.completed?
+		download_url = conversion.temporary_download_urls
+		time_taken_for_conversion = conversion.processing_time_in_seconds
 	end
 
 In the case you get a failure, you can retrieve the details using
 
-	if(file.reload.failed?)
-		file.notifications.last.details
-	end
+	conversion.error_type
+	conversion.error_details
 
 #### 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. 
+You can also request notification to be sent to you whenever the status of a conversion changes via webhooks. Go into your [Dashboard](https://fileturn.net/dashboard/notifications) and specify a webhook url. 
 
+## Fetching Conversion(s)
 
-## Other File Options
+You can fetch information of a single conversion using an id.
 
-You can fetch information of a single file using the file_id.
+	FileTurn::Conversion.find(id)
 
-	FileTurn::File.find(file_id)
-
-Or all the files
+Or all the conversions
 	
-	FileTurn::File.all
-
+	FileTurn::Conversion.all
 
 ## Account Details
 
-You can also fetch account details like how much credit you have. 
+You can fetch account details 
 
-	FileTurn::Account.load # fetch data from server
-	FileTurn::Account.credits
+	account = FileTurn::Account.load # fetch data from server
 
-Or you can use
+	# plan details
+	account.plan.name
+	account.plan.max_file_size_in_mb
+	account.plan.conversions_per_month
+	account.plan.max_requests_per_second
 
-	FileTurn::Account.load.credits
+	# stats for account (for current billing cycle)
+	account.subscription.stats.conversions_left
+	account.subscription.stats.successful_conversions
+	account.subscription.stats.failed_conversions
+	account.subscription.stats.processing_conversions
 
-Thanks!

data/fileturn.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "faraday"
+  spec.add_dependency "recursive-open-struct"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/fileturn/errors.rb

@@ -0,0 +1,14 @@
+module FileTurn
+  class FileTurnError < Exception; end
+  class NotFoundError < FileTurnError; end;
+  class UnauthorizedError < FileTurnError; end;
+  class UnknownError < FileTurnError; end;
+
+  class BadRequestError < FileTurnError
+    attr_reader :errors
+
+    def initialize(resp)
+      @errors = resp['errors']
+    end
+  end
+end

data/lib/fileturn/http_client.rb

@@ -6,7 +6,7 @@ module FileTurn
   class HttpClient
 
     def self.conn
-      @conn ||= Faraday.new(:url => 'http://fileturn.net/')
+      @conn ||= Faraday.new(:url => 'https://fileturn.net/')
     end
 
     def self.get(url, params, status_codes, &block)
@@ -29,20 +29,22 @@ module FileTurn
     end
 
     def self.setup_params(params)
-      params['token'] = FileTurn.api_key
+      params['api_token'] = FileTurn.api_token
       params
     end
 
     def self.handle_error(resp)
       case resp.status
+      when 200..399
+        nil
+      when 400
+        raise FileTurn::BadRequestError.new(JSON.parse(resp.body))
       when 401
-        raise FileTurn::UnauthorizedException.new(resp)
-      when 500
-        raise FileTurn::InternalServerException.new(resp)
-      when 422
-        OpenStruct.new(JSON.parse(resp.body))
+        raise FileTurn::UnauthorizedError.new(resp)
+      when 404
+        raise FileTurn::NotFoundError.new(resp)
       else
-        nil
+        raise FileTurn::UnknownError.new(resp)
       end
     end
   end

data/lib/fileturn/resources/account.rb

@@ -1,46 +1,22 @@
 module FileTurn
   class Account < Resource
+
+    def initialize(params)
+      @params = RecursiveOpenStruct.new(params, recurse_over_arrays: true)
+    end
+
+    def method_missing(m, *args, &block)
+      @params.send(m)
+      self
+    end
    
     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
+          FileTurn::Account.new(params)
         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
+end

data/lib/fileturn/resources/conversion.rb

@@ -0,0 +1,80 @@
+module FileTurn
+  class Conversion < Resource
+    attr_reader :params
+
+    def initialize(params)
+      @params = RecursiveOpenStruct.new(params, recurse_over_arrays: true)
+    end
+
+    def method_missing(m, *args, &block)
+      @params.send(m)
+    end
+
+    def reload!
+      @params = FileTurn::Conversion.find(id).params
+      self
+    end
+
+    ['created', 'processing', 'failed', 'completed'].each do |s|
+      define_method("#{s}?") do
+        s == status
+      end
+    end
+
+    # class
+    class << self
+      
+      def find(id, &block)
+        conn.get("/conversions/#{id}.json", {}, 200) do |params|
+          FileTurn::Conversion.new(params)
+        end
+      end
+
+      def all(per: 20, page: 1)
+        conn.get("conversions.json", { per: per, page: page }, 200) do |params|
+          params['conversions'].map! { |conv| FileTurn::Conversion.new(conv) }
+          RecursiveOpenStruct.new(params, recurse_over_arrays: true)
+        end
+      end
+
+      def process!(params)
+        conn.post("conversions.json", params, 200) do |params|
+          FileTurn::Conversion.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
+
+  end
+end

data/lib/fileturn/resources/resource.rb

@@ -8,10 +8,5 @@ module FileTurn
       end
     end
 
-    # instance
-    def errors
-      false
-    end
-
   end
 end

data/lib/fileturn/version.rb

@@ -1,3 +1,3 @@
 module Fileturn
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/fileturn.rb

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

data/spec/fileturn_spec.rb

@@ -3,13 +3,13 @@ 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"
+    it 'sets up api token' do
+      FileTurn.configure(api_token: "123")
+      expect(FileTurn.api_token).to eq("123")
     end
 
-    it 'raises exception if not api key is passed' do
-      expect { FileTurn.configure({}) }.to raise_error
+    it 'raises exception if not api token is passed' do
+      expect { FileTurn.configure({}) }.to raise_error(ArgumentError)
     end
   end
 

data/spec/fixtures/vcr_cassettes/account_info.yml

@@ -2,89 +2,50 @@
 http_interactions:
 - request:
     method: get
-    uri: http://localhost:3000/api/users.json?token=67sFfjudMpXxJeioQcPSppYkoVdQD1oetqPWzMAh
+    uri: http://localhost:5000/api/users.json?api_token=51d5fc191b2b95f9278becf6b51fa347
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - Faraday v0.8.7
+      - Faraday v0.15.2
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
-      - ! '*/*'
+      - "*/*"
   response:
     status:
       code: 200
-      message: ! 'OK '
+      message: OK
     headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Download-Options:
+      - noopen
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
       Content-Type:
       - application/json; charset=utf-8
-      X-Ua-Compatible:
-      - IE=Edge
       Etag:
-      - ! '"108135fed6135342e058ab4865b5301f"'
+      - W/"0d66b13e67af61ea36799ae5e7c780f1"
       Cache-Control:
       - max-age=0, private, must-revalidate
       X-Request-Id:
-      - 3f36878be082fdb201b2015c688aa367
+      - 8d6cd7e4-5ab9-414e-a35b-bc52a27ad8f2
       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
-- request:
-    method: get
-    uri: http://fileturn.net/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: 401
-      message: Unauthorized
-    headers:
-      Cache-Control:
-      - no-cache
-      Content-Type:
-      - application/json; charset=utf-8
-      Date:
-      - Wed, 10 Jul 2013 02:23:45 GMT
-      Status:
-      - 401 Unauthorized
-      X-Rack-Cache:
-      - miss
-      X-Request-Id:
-      - ba809a4faf572e1c93137e8dec3e5ed4
-      X-Runtime:
-      - '0.011111'
-      X-Ua-Compatible:
-      - IE=Edge,chrome=1
+      - '0.031059'
       Transfer-Encoding:
       - chunked
-      Connection:
-      - keep-alive
     body:
-      encoding: US-ASCII
-      string: ! '{"error":"Your token is invalid","status":401}'
+      encoding: UTF-8
+      string: '{"id":"3d96a094-dde5-4319-b5fb-bb87aabc7b0e","email":"test@test.com","plan":{"name":"free","max_file_size_in_mb":3,"conversions_per_month":50,"max_requests_per_second":1},"time_zone":"Eastern
+        Time (US \u0026 Canada)","subscription":{"billing_cycle_started":"2018-07-09T21:21:55.000+00:00","billing_cycle_ends":"2018-08-09T21:21:55.000+00:00","stats":{"conversions_left":0,"successful_conversions":50,"failed_conversions":0,"processing_conversions":0}}}'
     http_version: 
-  recorded_at: Wed, 10 Jul 2013 02:26:15 GMT
-recorded_with: VCR 2.4.0
+  recorded_at: Tue, 10 Jul 2018 00:48:08 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr_cassettes/conversion_all_not_authorized.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:5000/api/conversions.json?api_token=123&page=1&per=20
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.15.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Download-Options:
+      - noopen
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      Content-Type:
+      - application/json; charset=utf-8
+      Cache-Control:
+      - no-cache
+      X-Request-Id:
+      - 6f8608e9-c3ee-4991-9d1f-69b6c377cb6d
+      X-Runtime:
+      - '0.005255'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"errors":["unauthorized"]}'
+    http_version: 
+  recorded_at: Tue, 10 Jul 2018 01:34:00 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr_cassettes/conversion_not_authorized.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:5000/api/conversions/b120b954-82b2-41c6-bef2-c83b3462463b.json?api_token=123
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.15.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Download-Options:
+      - noopen
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      Content-Type:
+      - application/json; charset=utf-8
+      Cache-Control:
+      - no-cache
+      X-Request-Id:
+      - 612be496-1127-4844-9093-597a64c1e505
+      X-Runtime:
+      - '0.012557'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"errors":["not found"]}'
+    http_version: 
+  recorded_at: Tue, 10 Jul 2018 01:22:35 GMT
+recorded_with: VCR 4.0.0