crocodoc 1.0.0 → 1.0.1

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2013, Crocodoc
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+3. Neither the name of Crocodoc nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -8,7 +8,16 @@ Our API is based on REST principles and generally returns JSON encoded responses
 and in Ruby are converted to hashes unless otherwise noted.
 
 ## Installation
-You can get the library by cloning or downloading the repo.
+
+We suggest installing the library as a gem.
+
+    gem install crocodoc
+
+You can also add the library as a submodule in your git project.
+
+    git submodule add git@github.com:crocodoc/crocodoc-ruby.git
+
+You can also get the library by cloning or downloading.
 
 To clone:
 
@@ -95,7 +104,7 @@ Pass in the UUID of the file or an array of UUIDS you want to check the status o
 This function returns a hash containing a "status" string" and a "viewable" boolean.
 If you passed in an array instead of a string, this function returns an array of hashes containing the status for each file.
 
-    // $status contains status['status'] and status['viewable']
+    // status contains status['status'] and status['viewable']
     status = Crocodoc::Document.status(uuid)
     
     // statuses contains an array of status hashes
@@ -188,7 +197,7 @@ This function returns a session key.
         'is_copyprotected' => false,
         'is_demo' => false,
         'sidebar' => 'visible'
-    ))
+    })
     
 ## Support
 

data/VERSION

@@ -0,0 +1 @@
+1.0.2

data/crocodoc.gemspec

@@ -1,8 +1,10 @@
 $:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 
+require 'crocodoc/version'
+
 spec = Gem::Specification.new do |s|
   s.name = 'crocodoc'
-  s.version = '1.0.0'
+  s.version = Crocodoc::VERSION
   s.summary = 'Ruby wrapper for the Crocodoc API'
   s.description = 'The Crocodoc API lets you upload documents and then generate secure and customized viewing sessions for them. See https://crocodoc.com for details.'
   s.authors = ['Brandon Goldman']
@@ -15,4 +17,4 @@ spec = Gem::Specification.new do |s|
 
   s.files = `git ls-files`.split("\n")
   s.require_paths = ['lib']
-end
+end

data/examples.rb

@@ -324,7 +324,7 @@ session_key = nil
 begin
   user = {'id' => 1,
           'name' => 'John Crocodoc'}
-  session_key = Crocodoc::Session.create(uuid2, {'isEditable' => true,
+  session_key = Crocodoc::Session.create(uuid2, {'is_editable' => true,
                                                  'user' => user,
                                                  'filter' => 'all',
                                                  'is_admin' => true,
@@ -360,4 +360,4 @@ rescue CrocodocError => e
   puts 'failed :('
   puts '  Error Code: ' + e.code
   puts '  Error Message: ' + e.message
-end
+end

data/lib/crocodoc.rb

@@ -76,7 +76,7 @@ module Crocodoc
   def self._error(error, client, method, response)
     message = self.name + ': [' + error + '] ' + client + '.' + String(method) + "\r\n\r\n"
     response = JSON.generate(response) if response.is_a? Hash
-    message += response
+    message += response unless response.nil?
     raise CrocodocError.new(message, error)
   end
   
@@ -128,7 +128,7 @@ module Crocodoc
       
       if result == 'true'
         json_decoded = true
-      elsif result == 'false'
+      elsif result == 'false' or result == ''
         json_decoded = false
       else
         json_decoded = JSON.parse(result)
@@ -136,42 +136,42 @@ module Crocodoc
   
       if json_decoded == false
         return self._error('server_response_not_valid_json', self.name, __method__, {
-          response => result,
-          get_params => get_params,
-          post_params => post_params
+          response: result,
+          get_params: get_params,
+          post_params: post_params
         })
       end
       
       if json_decoded.is_a? Hash and json_decoded.has_key? 'error'
         return self._error(json_decoded['error'], self.name, __method__, {
-          get_params => get_params,
-          post_params => post_params
+          get_params: get_params,
+          post_params: post_params
         })
       end
         
       result = json_decoded
     end
 
-    http_4xx_error_codes = {'400' => 'bad_request',
-                            '401' => 'unauthorized',
-                            '404' => 'not_found',
-                            '405' => 'method_not_allowed'}
+    http_4xx_error_codes = {400 => 'bad_request',
+                            401 => 'unauthorized',
+                            404 => 'not_found',
+                            405 => 'method_not_allowed'}
     
     if http_4xx_error_codes.has_key? http_code
-      error = 'server_error_' + http_code + '_' + http_4xx_error_codes[http_code]
+      error = 'server_error_' + http_code.to_s + '_' + http_4xx_error_codes[http_code]
       return self._error(error, self.name, __method__, {
-        url => url,
-        get_params => get_params,
-        postParams => post_params
+        url: url,
+        get_params: get_params,
+        post_params: post_params
       })
     end
     
     if http_code >= 500 and http_code < 600
-      error = 'server_error_' + http_code + '_unknown'
+      error = 'server_error_' + http_code.to_s + '_unknown'
       return self._error(error, self.name, __method__, {
-        url => url,
-        get_params => get_params,
-        post_params => post_params
+        url: url,
+        get_params: get_params,
+        post_params: post_params
       })
     end
     

data/lib/crocodoc/document.rb

@@ -22,7 +22,7 @@ module Crocodoc
     # @return [Boolean] Was the file deleted?
     # @raise [CrocodocError]
     def self.delete(uuid)
-      post_params = {'uuid' => uuid}
+      post_params = {uuid: uuid}
       Crocodoc._request(self.path, 'delete', nil, post_params)
     end
     
@@ -39,9 +39,9 @@ module Crocodoc
     #   bool, or an array of the uuid and an error
     # @raise [CrocodocError]
     def self.status(uuids)
-      is_single_uuid = uuids.is_a? String
+      is_single_uuid = !(uuids.is_a? Array)
       uuids = [uuids] if is_single_uuid
-      get_params = {'uuids' => uuids.join(',')}
+      get_params = {uuids: uuids.join(',')}
       response = Crocodoc._request(self.path, 'status', get_params, nil)
       is_single_uuid ? response[0] : response
     end
@@ -57,7 +57,7 @@ module Crocodoc
       
       if url_or_file.is_a? String
         post_params['url'] = url_or_file
-      elsif url_or_file.is_a? File
+      elsif url_or_file.respond_to?(:read) && url_or_file.respond_to?(:path)
       	post_params['file'] = url_or_file
       else
       	return Crocodoc::_error('invalid_url_or_file_param', self.name, __method__, nil)

data/lib/crocodoc/download.rb

@@ -30,7 +30,7 @@ module Crocodoc
     # @return [String] The downloaded file contents as a string
     # @raise CrocodocError
     def self.document(uuid, is_pdf=false, is_annotated=false, filter=nil)
-      get_params = {'uuid' => uuid}
+      get_params = {uuid: uuid}
       get_params['pdf'] = 'true' if is_pdf
       get_params['annotated'] = 'true' if is_annotated
       
@@ -49,7 +49,7 @@ module Crocodoc
     # @return [String] The file's extracted text
     # @raise CrocodocError
     def self.text(uuid)
-      get_params = {'uuid' => uuid}
+      get_params = {uuid: uuid}
       Crocodoc._request(self.path, 'text', get_params, nil, false)
     end
   
@@ -62,7 +62,7 @@ module Crocodoc
     # @return [String] The downloaded thumbnail contents
     # @raise CrocodocError
     def self.thumbnail(uuid, width=nil, height=nil)
-      get_params = {'uuid' => uuid}
+      get_params = {uuid: uuid}
     
       if width != nil and height != nil
         get_params['size'] = String(width) + 'x' + String(height)

data/lib/crocodoc/session.rb

@@ -43,7 +43,7 @@ module Crocodoc
     # @return [String] A unique session key for the document
     # @raise [CrocodocError]
     def self.create(uuid, params = {})
-      post_params = {'uuid' => uuid}
+      post_params = {uuid: uuid}
 
       if params.has_key? 'is_editable'
         post_params['editable'] = params['is_editable'] ? 'true' : 'false'

data/lib/crocodoc/version.rb

@@ -0,0 +1,3 @@
+module Crocodoc
+  VERSION = '1.0.1'
+end

data/lib/crocodoc_error.rb

@@ -1,6 +1,6 @@
 # CrocodocError extends the default exception class.
 # It adds a code field.
-class CrocodocError < Exception
+class CrocodocError < StandardError
   # An error code string
   @code = nil
   
@@ -10,7 +10,7 @@ class CrocodocError < Exception
   end
 
   def initialize(message, code)
-    @message = message
+    super message
     @code = code
   end
 end

metadata

@@ -1,65 +1,61 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: crocodoc
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.0.1
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Brandon Goldman
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-19 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rest-client
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 4
-        version: "1.4"
+      - !ruby/object:Gem::Version
+        version: '1.4'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 1
-        - 1
-        version: "1.1"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :runtime
-  version_requirements: *id002
-description: The Crocodoc API lets you upload documents and then generate secure and customized viewing sessions for them. See https://crocodoc.com for details.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: The Crocodoc API lets you upload documents and then generate secure and
+  customized viewing sessions for them. See https://crocodoc.com for details.
+email:
 - brandon.goldman@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
+- LICENSE
 - README.md
+- VERSION
 - crocodoc.gemspec
 - example-files/form-w4.pdf
 - examples.rb
@@ -67,39 +63,30 @@ files:
 - lib/crocodoc/document.rb
 - lib/crocodoc/download.rb
 - lib/crocodoc/session.rb
+- lib/crocodoc/version.rb
 - lib/crocodoc_error.rb
 homepage: https://crocodoc.com/docs/api/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the Crocodoc API
 test_files: []
-