boxview.rb 0.0.9

data/lib/boxview/session.rb

@@ -0,0 +1,144 @@
+module BoxView
+  class Session
+
+    PATH = '/sessions'
+
+    class << self
+
+      attr_accessor :expiration_date, :duration, :retry_after, :is_downloadable
+
+      # Description:
+      # => The getter method for the duration that a session will last.
+      # No Params!
+      # Note:
+      # => Raises an error if the duration is nil when retrieved.
+      def duration
+        raise BoxView::Errors::DurationNotFound if @duration.nil?
+        @duration
+      end
+
+      # Description:
+      # => The getter method for the expiration date that a session will last.
+      # No Params!
+      # Note:
+      # => Raises an error if the expiration date is nil when retrieved.
+      def expiration_date
+        raise BoxView::Errors::ExpirationDateNotFound if @expiration_date.nil?
+        @expiration_date
+      end
+
+      ### BEGIN Session HTTP Request ###
+
+      # Description:
+      # => Creates a session for viewing the HTML ready document
+      # Note:
+      # => No Required Params!
+      # => params can be defined elsewhere.
+      # => 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]
+        response = BoxView.post session_path, body: json_data, headers: BoxView.headers
+        response_handler response
+        return response
+      end
+
+      ### END Session HTTP Request ###
+
+      # Description:
+      # => A path that is used for all session related requests.
+      # No Params!
+      def session_path
+        "#{BoxView::BASE_PATH}#{PATH}"
+      end
+
+      # Description:
+      # => 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
+      end
+
+      # Description:
+      # => A convenience method to return the viewer url that can be used after generating a session.
+      # Note:
+      # => No Required Params!
+      # => Defaults to using a generated session_id.
+      def viewer_url(session_id = nil)
+        unless session_id then session_id = BoxView.session_id end
+        "#{session_path}/#{session_id}/view?theme=light"
+      end
+
+      # Description:
+      # => A convenience method to return the asset url that is used in viewerjs.
+      # Optional Params:
+      # => session_id
+      # Note:
+      # => No Required Params!
+      # => Defaults to using a generated session_id.
+      def viewerjs_url(session_id = nil)
+        unless session_id then session_id = BoxView.session_id end
+        "#{session_path}/#{session_id}/assets"
+      end
+
+      # Description:
+      # => Convenience method to open the viewer url in a default browser.
+      # Optional Params:
+      # => A url to open in a default browser.
+      # Note:
+      # => No Required Params!
+      # => A session must have been generated in order for a url to be generated.
+      def view(link = nil)
+        unless link then link = viewer_url end
+        if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+          system "start #{link}"
+        elsif RbConfig::CONFIG['host_os'] =~ /darwin/
+          system "open #{link}"
+        elsif RbConfig::CONFIG['host_os'] =~ /linux|bsd/
+          system "xdg-open #{link}"
+        end
+      end
+
+      private
+
+      # Description:
+      # => Response handler for the create request of a session.
+      # No Params!
+      def response_handler(response)
+        case response.code
+        when 201 # Done converting
+          parsed = JSON.parse response.body
+          session_id = parsed["id"]
+          BoxView.session_id = session_id
+        when 202 # Session not ready yet
+          retry_after response['Retry-After']
+        when 400 # An error occurred while converting the document or the document does not exist
+          raise BoxView::Errors::DocumentConversionFailed
+        else
+          raise BoxView::Errors::SessionNotGenerated
+        end
+      end
+
+      # Description:
+      # => The JSON data that is sent in the create request of a session.
+      # No Params!
+      def json_data # Does a duration or an expiration date need to exist?
+        data = {}
+        data[:document_id] = BoxView.document_id
+        data[:is_downloadable] = is_downloadable if is_downloadable
+        if !@duration.nil? && @expiration_date.nil? # duration
+          data[:duration] = duration
+        elsif @duration.nil? && !@expiration_date.nil? # expiration
+          data[:expires_at] = expiration_date
+        elsif !@duration.nil? && !@expiration_date.nil? # both, use expiration date
+          data[:expires_at] = expiration_date
+        else
+          # Default will be used
+        end
+        return data.to_json
+      end
+    end
+  end
+end

data/lib/boxview/version.rb

@@ -0,0 +1,3 @@
+module BoxView
+  VERSION = '0.0.9'
+end

data/spec/lib/boxview/document_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe BoxView::Document, '#document_id' do
+
+  it 'should raise error when document id is nil' do
+    expect{BoxView.document_id}.to raise_error(BoxView::Errors::DocumentIdNotFound)
+  end
+
+end
+
+describe BoxView::Document, '#url' do
+  it 'should raise error when url is nil' do
+    BoxView::Document.url = nil
+    expect{BoxView::Document.url}.to raise_error(BoxView::Errors::UrlNotFound)
+  end
+
+  it 'should return url when defined' do
+    BoxView::Document.url = 'http://imgur.com/cats.jpeg'
+    expect(BoxView::Document.url).not_to be_nil
+  end
+end
+
+describe BoxView::Document, '#type' do
+  it 'should raise error when setting with invalid type' do
+    expect{BoxView::Document.type = 'jpeg'}.to raise_error(BoxView::Errors::TypeNotFound)
+  end
+
+  it 'should return when type is valid' do
+    expect(BoxView::Document.type = 'pdf').not_to be_nil
+  end
+end
+
+describe BoxView::Document, '#dimensions' do
+
+  it 'should raise error when dimensions are nil' do
+    expect{BoxView::Document.dimensions}.to raise_error(BoxView::Errors::DimensionsNotFound)
+  end
+
+  it 'should raise error when height is nil, but width is defined' do
+    BoxView::Document.width = 100
+    BoxView::Document.height = nil
+    expect{BoxView::Document.dimensions}.to raise_error(BoxView::Errors::DimensionsNotFound)
+  end
+
+  it 'should raise error when width is nil, but height is defined' do
+    BoxView::Document.width = nil
+    BoxView::Document.height = 100
+    expect{BoxView::Document.dimensions}.to raise_error(BoxView::Errors::DimensionsNotFound)
+  end
+
+end
+
+describe BoxView::Document, '#thumbnail_params' do
+
+  it 'should raise when dimensions are nil' do
+    expect{BoxView::Document.thumbnail_params}.to raise_error(BoxView::Errors::DimensionsNotFound)
+  end
+
+  it 'should raise when height is nil, but width is defined' do
+    BoxView::Document.width = 100
+    BoxView::Document.height = nil
+    expect{BoxView::Document.thumbnail_params}.to raise_error(BoxView::Errors::DimensionsNotFound)
+  end
+
+  it 'should raise when width is nil, but height is defined' do
+    BoxView::Document.width = nil
+    BoxView::Document.height = 100
+    expect{BoxView::Document.thumbnail_params}.to raise_error(BoxView::Errors::DimensionsNotFound)
+  end
+end
+describe BoxView::Document, '#create' do
+  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)
+  end
+
+  it 'should return the response when sent a good request (200..202)' do
+    BoxView.api_key = API_KEY
+    BoxView::Document.url = 'http://i.imgur.com/4RZkFbE.png'
+    response = BoxView::Document.create
+    expect(200..202).to cover(response.code)
+  end
+end

data/spec/lib/boxview/errors_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe BoxView::Errors do
+
+end

data/spec/lib/boxview/session_spec.rb

@@ -0,0 +1,29 @@
+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)
+  end
+
+  it 'should return when expiration date is defined' 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)
+  end
+
+  it 'should return when duration is defined' do
+    BoxView::Session.duration = 100
+    expect(BoxView::Session.duration).not_to be_nil
+  end
+
+end

data/spec/lib/boxview/version_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe BoxView::VERSION do
+  it 'should not be nil' do
+    expect(BoxView::VERSION).to_not be_nil
+  end
+
+  it 'should be a string' do
+    expect(BoxView::VERSION).to be_an_instance_of(String)
+  end
+end

data/spec/lib/boxview_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe BoxView, "#headers" do
+  it 'should raise error when api key is nil' do
+    BoxView.api_key = nil
+    expect{BoxView.headers}.to raise_error(BoxView::Errors::ApiKeyNotFound)
+  end
+  it 'should return headers when api key is defined' do
+    BoxView.api_key = "a1s2d9d3dg7d7s7"
+    expect(BoxView.headers).not_to be_nil
+  end
+  it 'should return when document id is defined' do
+    BoxView.document_id = "slkslkdf234234"
+    expect(BoxView.document_id).not_to be_nil
+  end
+  it 'should raise error when document id is nil' do
+    BoxView.document_id = nil
+    expect{BoxView.document_id}.to raise_error(BoxView::Errors::DocumentIdNotFound)
+  end
+  it 'should return when session id is defined' do
+    BoxView.session_id = "sfsdf23242332"
+    expect(BoxView.session_id).not_to be_nil
+  end
+  it 'should raise error when session id is nil' do
+    BoxView.session_id = nil
+    expect{BoxView.session_id}.to raise_error(BoxView::Errors::SessionIdNotFound)
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: boxview.rb
+version: !ruby/object:Gem::Version
+  version: 0.0.9
+platform: ruby
+authors:
+- Vincent Taverna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  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
+  name: httmultiparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        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:
+- vinnymac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- boxview.rb.gemspec
+- lib/boxview.rb
+- lib/boxview/document.rb
+- lib/boxview/errors.rb
+- lib/boxview/session.rb
+- lib/boxview/version.rb
+- spec/lib/boxview/document_spec.rb
+- spec/lib/boxview/errors_spec.rb
+- spec/lib/boxview/session_spec.rb
+- spec/lib/boxview/version_spec.rb
+- spec/lib/boxview_spec.rb
+- spec/spec_helper.rb
+homepage: http://developers.box.com/view/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Wrapper for the BoxView API
+test_files:
+- spec/lib/boxview/document_spec.rb
+- spec/lib/boxview/errors_spec.rb
+- spec/lib/boxview/session_spec.rb
+- spec/lib/boxview/version_spec.rb
+- spec/lib/boxview_spec.rb
+- spec/spec_helper.rb