boxview.rb 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0b941ac2af141921f240942901522a950d20990
-  data.tar.gz: dea4cceb7e4b66566476ac3f4167f3cad0ab0690
+  metadata.gz: 27021f62d0bc30f3e7167e0414154a816278e025
+  data.tar.gz: d72b878111414766d2ec5342f3f72e5f22fc7470
 SHA512:
-  metadata.gz: 4baf1da5ad28fc384f6007b60035b370e3cda345579629f03664af8613ee77fb91aaf7d89ce1e882e9f617ee5fb82e539df21f92c8c7801f930345c1dcc462c4
-  data.tar.gz: 53dea99d41a89c8af6fb4ed408c8d0affdfdb385ea5b6db457df48d0e8a4766bba35510fef9db4a055192b74f6efa4b8c475ab00a8037948d1fc6576cdf76c26
+  metadata.gz: 8480a8d2e9a59213d5302d88871c28d06c58cea8809fb68f99ba7fa791a19b68fa6d85a34565820c57e895ad040b4fd3f25287178a92cd8f0cae04e858a4f545
+  data.tar.gz: 7bf174dd6afbd48f330969a44996a5a1e4462732fc01ecd0fda22538f89e8d93cbec4b8cdf7f5082dac2945d89807ff669ef8a2d141edb7ecba7620a6b1e5e65

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 env:
   global:
     # BoxView API Key
-    secure: "cOxF+9whdZHoCAxOPX0xiM7X312pRNoMaxHLDsBPaVLnk2kVKEURvJCoLqwhgsh9PVwa8wAXUk/cwUVN43isM3CdoMM4+5bZg18X/kQGM8zltKJCr/AONaBKV8gadVvmwdAsvzrQ/Mj4Qyb7AGJfNKjGPOZL8A0Pl1NypYz06lI="
+    secure: "QFH/gcuFT6bEXiXpAEIzSc+awrXB23dbhD1RUHneBjzHCAhRnTmyiNuXRt/YubOmt26ttEpQ0nh2D+DbW62ozFiaDaD05ho7Z7YgN1N6wvZD2ST+BiYPKVZWu8sTgQZ9ax8i9uTb3t+Ksu4X5g0cGg9vEdPFKC9PlQhEuwH7ojQ="
 rvm:
   - 2.0.0
   - 2.1.0

data/README.md

@@ -2,14 +2,14 @@
 
 [![Build Status](https://travis-ci.org/getlua/boxviewrb.svg)](https://travis-ci.org/getlua/boxviewrb)
 
-A BoxView API wrapper. Built using the power of HTTParty to communicate with the BoxView API. The BoxView API has added some new features and improved documentation, this lib takes care of all of those new additions for you. You can learn more at the [developer page](http://developers.box.com/view/). Note this product and API are still in beta, and likely to change in the future. Boxviewrb works with all available requests that are documented by BoxView at the time of writing.
+A BoxView API wrapper. Built using the power of HTTParty to communicate with the BoxView API. The BoxView API has added some new features and improved documentation, this lib takes care of all of those new additions for you. You can learn more at the [developer page](https://box-view.readme.io/). Note this product and API are still in beta, and likely to change in the future. Boxviewrb works with all available requests that are documented by BoxView at the time of writing.
 
 ##### Table of Contents
 * [Installation](#installation)
 * [Usage](#usage)
     * [Configuration](#configuration)
     * [Document](#document)
-        * [Create](#create_document)
+        * [Create](#create-document)
         * [MultiPart](#multipart)
         * [List](#list)
         * [Show](#show)
@@ -18,19 +18,18 @@ A BoxView API wrapper. Built using the power of HTTParty to communicate with the
         * [Thumbnail](#thumbnail)
         * [Assets](#assets)
     * [Session](#session)
-        * [Create](#create_session)
-    * [Convenience Methods](#convenience_methods)
-        * [Never Expire](#never_expire)
-        * [View](#create_session)
-        * [ViewerJS URL](#viewerjs_url)
-        * [Viewer URL](#viewer_url)
-        * [Supported MIMETypes](#supported_mimetypes)
-        * [Supported File Extensions](#supported_file_extensions)
+        * [Create](#create-session)
+    * [Convenience Methods](#convenience-methods)
+        * [Never Expire](#never-expire)
+        * [View](#create-session)
+        * [ViewerJS URL](#viewerjs-url)
+        * [Viewer URL](#viewer-url)
+        * [Supported MIMETypes](#supported-mimetypes)
+        * [Supported File Extensions](#supported-file-extensions)
 * [Contributing](#contributing)
 * [Author](#author)
 * [License](#license)
 
-<a name="installation"/>
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -45,10 +44,8 @@ Or install it yourself as:
 
     $ gem install boxview.rb
 
-<a name="usage"/>
 ## Usage
 
-<a name="configuration"/>
 ### Configuration
 
 Defining an api key is the only required configuration. To get your own API Key, visit [Box and get a developer account](https://app.box.com/developers/services). Then create a new Box View application. Scroll to the bottom of the application settings page to find your api key.
@@ -57,10 +54,8 @@ Defining an api key is the only required configuration. To get your own API Key,
 BoxView.api_key = "#{BOXVIEW_APIKEY}" # Example: 'gyheecmm6ckk8jutlowlzfh2tbg72kck'
 ```
 
-<a name="document"/>
 ### Document
 
-<a name="create_document"/>
 #### Create
 
 See below for how to create a document using boxviewrb. Not all the paramaters used are required. The url is the only parameter that will be necessary in order to make a successful call with the BoxView API. Name refers to the name of the document. Non_SVG refers to whether you want to support browsers that cannot support svg. The Height and Width parameters refer to the size of a thumbnail that will give Box an early start to generating your thumbnail for you. You must still make a second request for a thumbnail, but it will be made available sooner upon request.
@@ -80,7 +75,6 @@ BoxView::Document.create
   height: 100
 ```
 
-<a name="multipart"/>
 #### MultiPart
 
 If you have access to the actual file you want to upload to box, you can directly upload it via a multipart upload. This method requires the path to the file to be specified in order for it to send the file to box. If the filepath does not exist, an error will be thrown. The other params (name, thumbnail and non_svg) are the same as the create request params.
@@ -98,7 +92,6 @@ BoxView::Document.multipart
   height: 100
 ```
 
-<a name="list"/>
 #### List
 
 This request will respond with a list of all the documents that are currently tied to the api key that has been supplied. Delete requests will remove documents from this list. This method returns the response untouched.
@@ -107,7 +100,6 @@ This request will respond with a list of all the documents that are currently ti
 BoxView::Document.list
 ```
 
-<a name="show"/>
 #### Show
 
 Returns the metadata for a single document based on a specified document id. If the document has successfully been generated by box, the status of the document will be 'done'. If not the status will be 'error'. The status is returned in the response when calling show.
@@ -118,7 +110,6 @@ Required: `document_id`
 BoxView::Document.show document_id: '937778a1a54b4337a5351a78f7188a24'
 ```
 
-<a name="update"/>
 #### Update
 
 Update the metadata of a single document based on a specified document id. Only the name can be updated at this time.
@@ -131,7 +122,6 @@ BoxView::Document.update
   name: 'recipes'
 ```
 
-<a name="delete"/>
 #### Delete
 
 Removes a previously created document from the Box View servers. This request is destructive.
@@ -142,7 +132,6 @@ Required: `document_id`
 BoxView::Document.delete document_id: '937778a1a54b4337a5351a78f7188a24'
 ```
 
-<a name="thumbnail"/>
 #### Thumbnail
 
 A request to retrieve a thumbnail representation of a document. A document id must be specified in order to make the request. If the server response contains the response code `202` then the retry after attribute will be available when calling `BoxView::Document.retry_after`. This can be useful if Box is rate limiting.
@@ -156,7 +145,6 @@ BoxView::Document.thumbnail
   height: 100
 ```
 
-<a name="assets"/>
 #### Assets
 
 A request to retrieve a pdf or zip of the asset that was uploaded. The document will be retrieved as a pdf or zip. The zip contains compressed css/js/html that make up the converted document. This can be used in junction with viewerjs. This request defaults to zip if no type is specified.
@@ -169,10 +157,8 @@ BoxView::Document.assets
   type: 'pdf'
 ```
 
-<a name="session"/>
 ### Session
 
-<a name="create_session"/>
 #### Create
 
 Generating a document will give you a document id. Next you can create a session using this id. The session will begin the conversion process of the document. When Box is done converting your document it will be available to download through the assets method or the viewer url convenience method. A session expires after a set amount of time. You can set a duration or an expiration date for the session. If left blank, the session is set by box by default to expire in 60 minutes. Duration is marked in minutes. Expiration date is a timestamp. The variable is_downloadable refers to whether or not the box viewer will display a download button or not. If the server response contains the response code `202` then the retry after attribute will be available when calling `BoxView::Session.retry_after`.
@@ -191,10 +177,8 @@ BoxView::Session.create
   is_downloadable: true
 ```
 
-<a name="convenience_methods"/>
 ### Convenience Methods
 
-<a name="never_expire"/>
 #### Never Expire
 
 When generating a session if you want your session to last for a very long time (a thousand years) call this method.
@@ -203,7 +187,6 @@ When generating a session if you want your session to last for a very long time
 BoxView::Session.never_expire
 ```
 
-<a name="view"/>
 #### View
 
 Opens a default browser using the viewer url to view a BoxView converted document. Requires a `session_id`.
@@ -212,7 +195,6 @@ Opens a default browser using the viewer url to view a BoxView converted documen
 BoxView::Session.view
 ```
 
-<a name="viewerjs_url"/>
 #### ViewerJS URL
 
 This url can be used with viewerjs to display the assets without using the Box iframe or downloading the assets yourself. Requires a `session_id`.
@@ -221,7 +203,6 @@ This url can be used with viewerjs to display the assets without using the Box i
 BoxView::Session.viewerjs_url
 ```
 
-<a name="viewer_url"/>
 #### Viewer URL
 
 The url used in the view method. Can be used in an iframe to display the converted document. Requires a `session_id`.
@@ -230,7 +211,6 @@ The url used in the view method. Can be used in an iframe to display the convert
 BoxView::Session.viewer_url
 ```
 
-<a name="supported_mimetypes"/>
 #### Supported MIMETypes
 
 Returns an array containing all the mimetypes that BoxView is known to support.
@@ -239,7 +219,6 @@ Returns an array containing all the mimetypes that BoxView is known to support.
 BoxView::Document.supported_mimetypes
 ```
 
-<a name="supported_file_extensions"/>
 #### Supported File Extensions
 
 Returns an array containing all the extensions of filetypes that BoxView is known to support.
@@ -248,7 +227,6 @@ Returns an array containing all the extensions of filetypes that BoxView is know
 BoxView::Document.supported_file_extensions
 ```
 
-<a name="contributing"/>
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/boxviewrb/fork )
@@ -257,12 +235,10 @@ BoxView::Document.supported_file_extensions
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-<a name="author"/>
 ## Author
 
 Vincent Taverna, vinny@getlua.com, [vinnymac.github.io](http://vinnymac.github.io)
 
-<a name="license"/>
 ## License
 
 boxviewrb is available under the MIT license. See the [LICENSE](LICENSE.txt) file for more information.

data/boxview.rb.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake",     "~> 0"
-  spec.add_development_dependency "rspec",    "~> 0"
-  spec.add_runtime_dependency 'httmultiparty', "~> 0.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency 'httmultiparty', '~> 0.3.14'
 end

data/lib/boxview/document.rb

@@ -7,6 +7,7 @@ module BoxView
     PATH = '/documents'
     ZIP = 'zip' # Constant for generating a zip of assets of a document
     PDF = 'pdf' # Constant for generating a pdf of a document
+    ORIGINAL_FORMAT = '' # Constant for fetching the original uploaded file
 
     class << self
 
@@ -39,7 +40,7 @@ module BoxView
       # Note:
       # => This method only accepts pdf or zip as types.
       def type=(type)
-        raise BoxView::Errors::TypeNotFound if ![ZIP, PDF].include? type.downcase
+        raise BoxView::Errors::TypeNotFound if ![ZIP, PDF, ORIGINAL_FORMAT].include? type.downcase
         @type = type
       end
 
@@ -129,7 +130,7 @@ module BoxView
       # => Type, Document ID
       def assets(options = {})
         BoxView.document_id = options[:document_id] if options[:document_id]
-        type = options[:type] if options[:type]
+        self.type = options[:type] if options[:type]
         response = BoxView.get asset_url, headers: BoxView.headers
         asset_response_handler response
         return response
@@ -187,7 +188,11 @@ module BoxView
       # => A Document ID must be defined.
       def asset_url
         type = if @type then @type else ZIP end # Defaults to ZIP
-        "#{document_path}/#{BoxView.document_id}/content.#{type}"
+        rtn = "#{document_path}/#{BoxView.document_id}/content"
+        unless type == ORIGINAL_FORMAT
+          rtn += ".#{type}"
+        end
+        rtn
       end
 
       # Description: Params for retrieving a thumbnail of a certain size
@@ -241,6 +246,7 @@ module BoxView
       def delete_response_handler(response)
         case response.code
         when 200
+        when 204
         else
           raise BoxView::Errors::DocumentDeletionFailed.new(response)
         end
@@ -254,7 +260,7 @@ module BoxView
         case response.code
         when 200
         else
-          raise BoxView::Errors::AssetGeneratioFailed.new(response)
+          raise BoxView::Errors::AssetGenerationFailed.new(response)
         end
       end
 
@@ -361,4 +367,4 @@ module BoxView
 
     end
   end
-end
+end

data/lib/boxview/session.rb

@@ -37,9 +37,9 @@ module BoxView
       # => document id must be defined.
       def create(options = {})
         BoxView.document_id = options[:document_id] if options[:document_id]
-        duration = options[:duration] if options[:duration]
-        expiration_date = options[:expiration_date] if options[:expiration_date]
-        is_downloadable = options[:is_downloadable] if options[:is_downloadable]
+        @duration = options[:duration] if options[:duration]
+        @expiration_date = options[:expiration_date] if options[:expiration_date]
+        @is_downloadable = options[:is_downloadable] if options[:is_downloadable]
         response = BoxView.post session_path, body: json_data, headers: BoxView.headers
         response_handler response
         return response
@@ -58,7 +58,7 @@ module BoxView
       # => Convenience method to make the session last for a thousand years
       # No Params!
       def never_expire
-        expiration_date Time.now + (365.25 * 24 * 60 * 60 * 1000).to_i
+        @expiration_date = Time.now + (365.25 * 24 * 60 * 60 * 1000).to_i
       end
 
       # Description:
@@ -110,10 +110,10 @@ module BoxView
         case response.code
         when 201 # Done converting
           parsed = JSON.parse response.body
-          session_id = parsed["id"]
-          BoxView.session_id = session_id
+          @session_id = parsed["id"]
+          BoxView.session_id = @session_id
         when 202 # Session not ready yet
-          retry_after response['Retry-After']
+          @retry_after = response.headers['retry-after']
         when 400 # An error occurred while converting the document or the document does not exist
           raise BoxView::Errors::DocumentConversionFailed
         else
@@ -141,4 +141,4 @@ module BoxView
       end
     end
   end
-end
+end

data/lib/boxview/version.rb

@@ -1,3 +1,3 @@
 module BoxView
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/spec/lib/boxview/document_spec.rb

@@ -69,13 +69,23 @@ describe BoxView::Document, '#thumbnail_params' do
   end
 end
 describe BoxView::Document, '#create' do
+  let(:mock_response) { double('202 Response', { :code => 201, :body => '{"id": "123"}'}) }
+
+  before do
+    allow(BoxView).to receive(:post).and_return(mock_response)
+  end
+
   xit 'should raise when receiving a bad request' do
   end
 
-  it 'should raise when receiving a bad api key' do
-    BoxView.api_key = 'somesortofbadapikey'
-    BoxView::Document.url = 'http://imgur.com/cats.jpeg'
-    expect{BoxView::Document.create}.to raise_error(BoxView::Errors::DocumentIdNotGenerated)
+  context 'when receiving a bad api key' do
+    let(:mock_response) { double('401 Response', { :code => 401 }) }
+
+    it 'should raise' do
+      BoxView.api_key = 'somesortofbadapikey'
+      BoxView::Document.url = 'http://imgur.com/cats.jpeg'
+      expect{BoxView::Document.create}.to raise_error(BoxView::Errors::DocumentIdNotGenerated)
+    end
   end
 
   it 'should return the response when sent a good request (200..202)' do
@@ -84,4 +94,16 @@ describe BoxView::Document, '#create' do
     response = BoxView::Document.create
     expect(200..202).to cover(response.code)
   end
-end
+end
+describe BoxView::Document, '#delete' do
+  let(:mock_response) { double('204 Response', { :code => 204, :body => '' }) }
+
+  before do
+    allow(BoxView).to receive(:delete).and_return(mock_response)
+  end
+
+  it 'should return an empty string when sent a good request resulting in a 204 (empty) response' do
+    response = BoxView::Document.delete document_id: "xyz"
+    expect(response.body).to eq ''
+  end
+end

data/spec/lib/boxview/session_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe BoxView::Session, '#expiration_date' do
-
   it 'should raise error when expiration date is nil' do
     BoxView::Session.expiration_date = nil
     expect{BoxView::Session.expiration_date}.to raise_error(BoxView::Errors::ExpirationDateNotFound)
@@ -11,11 +10,9 @@ describe BoxView::Session, '#expiration_date' do
     BoxView::Session.expiration_date = Time.now
     expect(BoxView::Session.expiration_date).not_to be_nil
   end
-
 end
 
 describe BoxView::Session, '#duration' do
-
   it 'should raise error when duration is nil' do
     BoxView::Session.duration = nil
     expect{BoxView::Session.duration}.to raise_error(BoxView::Errors::DurationNotFound)
@@ -25,5 +22,19 @@ describe BoxView::Session, '#duration' do
     BoxView::Session.duration = 100
     expect(BoxView::Session.duration).not_to be_nil
   end
+end
+
+describe BoxView::Session, '#create' do
+  before do
+    allow(BoxView).to receive(:post).and_return(mock_response)
+  end
 
+  context 'when response is 202' do
+    let(:mock_response) { double('202 Response', { :code => 202, :headers => { 'retry-after' => '2' }, }) }
+
+    it 'should set retry_after' do
+      BoxView::Session.create({ :document_id => '123'})
+      expect(BoxView::Session.retry_after).to eql('2')
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'boxview'
 
-API_KEY = ENV["BOXVIEW_APIKEY"]
+API_KEY = ENV["BOXVIEW_APIKEY"] || "123"
 
 # ToDo: Stub HTTParty Responses using https://github.com/bblimke/webmock/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxview.rb
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Vincent Taverna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-08 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,28 +28,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.3.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.3.14
 description: Box View converts PDF and Office documents to HTML thus enabling these
   files to be easily embedded into web and mobile applications.
 email: