docraptor 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5a1c61577a464a76a8c99838bf03671dacf4868
-  data.tar.gz: fd38c94ea003066f08f23bbecda331d12f3d942e
+  metadata.gz: 849a038e2617f4e9c537a2e8203ed6325d8fe997
+  data.tar.gz: 2f4d476200f471d163df0842b7e03ed808c2ad5c
 SHA512:
-  metadata.gz: cb72fe8bf315cde69177f0277ee357b995cb03f4b26a1e69d9b4f5149bb6a3299ec5106e54c50296cd999f9a1bb9eff8027526e6f18731269e0e623103a9ff60
-  data.tar.gz: a9ad7e0ff6509865334d9294f560130a6011d4e6ac2dd2600f9712fcbdb35f13c5de7d91feefe30ee69c66f2b9a3312cff75c71092ae9c7e5ff8bb1266e60375
+  metadata.gz: b3f25bc6162a31222d20c545fe1927d45b3f0518c78ffea9673d56af26aab81102f5980906036cec905af05a5707f3430feff61103ad4cde45b692270c9677c3
+  data.tar.gz: 6ff94a9cdf1a915b69ff1175cf8dc391d4a359c8b29c035427235f7a289abd8acaaed16ae08d0b5758b8a6bf558abd395efbdbd5c6ff0c7fd43a5d8e5c321f36

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+### 0.0.3 [January 15, 1016]
+* Use better API command names: create_doc, create_async_doc, get_async_doc_status, get_async_doc
+* Fix file encoding issues when used in Rails
+
+### 0.0.2 [January 6, 2016]
+* Regenerate using swagger-codegen v2.1.5
+
+### 0.0.1 [November 1, 2015]
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    docraptor (0.0.3)
+      json (~> 1.4, >= 1.4.6)
+      typhoeus (~> 0.2, >= 0.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.0)
+    addressable (2.4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.11)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    ethon (0.8.1)
+      ffi (>= 1.3.0)
+    ffi (1.9.10)
+    hashdiff (0.2.3)
+    json (1.8.3)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.2)
+      ffi (>= 1.0.0)
+    typhoeus (0.8.0)
+      ethon (>= 0.8.0)
+    vcr (2.9.3)
+    webmock (1.22.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.11)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  docraptor!
+  rake (~> 10.4, >= 10.4.2)
+  rspec (~> 3.2, >= 3.2.0)
+  vcr (~> 2.9, >= 2.9.3)
+  webmock (~> 1.6, >= 1.6.2)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2010- Expected Behavior, LLC (http://expectedbehavior.com)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,70 @@
+# DocRaptor Ruby Native Client Library
+
+**WARNING: This code is not production ready, you should use [doc_raptor_gem](https://github.com/expectedbehavior/doc_raptor_gem).**
+
+This is a Ruby gem for using [DocRaptor API](http://docraptor.com/documentation) to convert HTML to PDF and XLSX.
+
+## Installation
+
+Add the following to your `Gemfile`.
+
+```ruby
+gem "docraptor"
+```
+
+Then run `bundle install`.
+
+## Usage
+
+```ruby
+DocRaptor.configure do |dr|
+  dr.username = "YOUR_API_KEY_HERE" # this key works for test documents
+  # dr.debugging = true
+end
+
+$docraptor = DocRaptor::ClientApi.new
+
+response = $docraptor.docs_post(
+  test:             true,                                         # test documents are free but watermarked
+  document_content: "<html><body>Hello World</body></html>",      # supply content directly
+  # document_url:   "http://docraptor.com/examples/invoice.html", # or use a url
+  name:             "swagger-ruby.pdf",                           # help you find a document later
+  document_type:    "pdf",                                        # pdf or xls or xlsx
+  # javascript:       true,                                       # enable JavaScript processing
+  # prince_options: {
+  #   media: "screen",                                            # use screen styles instead of print styles
+  #   baseurl: "http://hello.com",                                # pretend URL when using document_content
+  # },
+)
+```
+
+If your document will take longer than 60 seconds to render to PDF you will need to use our async api which allows up to 10 minutes, check out the [example](example/async.rb).
+
+
+We have guides for doing some of the common things:
+* [Headers and Footers](https://docraptor.com/documentation/style#pdf-headers-footers) including page skipping
+* [CSS Media Selector](https://docraptor.com/documentation/api#api_basic_pdf) to make the page look exactly as it does in your browser
+* [Protected Content](https://docraptor.com/documentation/api#api_advanced_pdf) to secure your URLs so only DocRaptor can access them
+
+## More Help
+
+DocRaptor has a lot of more [styling](https://docraptor.com/documentation/style) and [implementation options](https://docraptor.com/documentation/api).
+
+Stuck? We're experts at using DocRaptor so please [email us](mailto:support@docraptor.com) if you run into trouble.
+
+
+## Development
+
+The majority of the code in this repo is generated using swagger-codegen on [docraptor.yaml](docraptor.yaml). You can modify this file and regenerate the client using `script/generate_language ruby`.
+
+## Release Process
+
+1. Merge code and run tests
+2. Increment version in code
+3. Update [CHANGELOG.md](CHANGELOG.md)
+4. Push to GitHub
+5. `rake release`
+
+## Version Policy
+
+This library follows [Semantic Versioning 2.0.0](http://semver.org).

data/docraptor.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://docraptor.com"
   s.summary     = %q{A wrapper for the DocRaptor HTML to PDF/XLS service.}
   s.description = %q{A native client library for the DocRaptor HTML to PDF/XLS service.}
-  s.license     = "MIT"
+  s.license     = "Apache-2.0"
 
   s.add_runtime_dependency 'typhoeus', '~> 0.2', '>= 0.2.1'
   s.add_runtime_dependency 'json', '~> 1.4', '>= 1.4.6'
@@ -23,10 +23,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
   s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
   s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
-  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.10'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
 
   s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
-  s.test_files    = `find spec/*`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]
 end

data/docraptor.yaml

@@ -0,0 +1,339 @@
+swagger: '2.0'
+
+info:
+  version: "0.0.1"
+  title: DocRaptor v1
+
+host: docraptor.com
+basePath: /
+schemes: [https]
+securityDefinitions:
+ basicAuth:
+  type: basic
+  description: HTTP Basic Authentication. Works over `HTTP` and `HTTPS`
+produces:
+  - application/json
+  - application/xml
+  - application/pdf
+  - application/vnd.ms-excel
+  - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
+
+paths:
+  /docs:
+    post:
+      operationId: createDoc
+      tags: [Client]
+      description: |
+        Creates a document synchronously.
+      security:
+        - basicAuth: []
+      parameters:
+        - name: doc
+          in: body
+          description: The document to be created.
+          required: true
+          schema:
+            $ref: '#/definitions/Doc'
+      responses:
+        200:
+          description: Successful response
+          schema:
+            type: file
+        400:
+          description: Bad Request
+        401:
+          description: Unauthorized
+        403:
+          description: Forbidden
+        422:
+          description: Unprocessable Entity
+        500:
+          description: Server Error
+  /async_docs:
+    post:
+      operationId: createAsyncDoc
+      tags: [Client]
+      description: |
+        Creates a document asynchronously.
+        You must use a callback url or the the returned status id and the status api to find out when it completes. Then use the download api to get the document.
+      security:
+        - basicAuth: []
+      parameters:
+        - name: doc
+          in: body
+          description: The document to be created.
+          required: true
+          schema:
+            $ref: '#/definitions/Doc'
+      responses:
+        200:
+          description: Successful response
+          schema:
+            $ref: '#/definitions/AsyncDoc'
+        400:
+          description: Bad Request
+        401:
+          description: Unauthorized
+        403:
+          description: Forbidden
+        422:
+          description: Unprocessable Entity
+        500:
+          description: Server Error
+
+  /status/{id}:
+    get:
+      operationId: getAsyncDocStatus
+      tags: [Client]
+      description: |
+        Check on the status of an asynchronously created document.
+      security:
+        - basicAuth: []
+      parameters:
+        - name: id
+          in: path
+          description: The status_id returned when creating an asynchronous document.
+          required: true
+          schema:
+            $ref: '#/definitions/AsyncDocStatus'
+      responses:
+        200:
+          description: Successful response
+          schema:
+            $ref: '#/definitions/AsyncDocStatus'
+        401:
+          description: Unauthorized
+        403:
+          description: Forbidden
+        500:
+          description: Server Error
+
+
+  /download/{id}:
+    get:
+      operationId: getAsyncDoc
+      tags: [Client]
+      description: |
+        Downloads a document.
+      security:
+        - basicAuth: []
+      parameters:
+        - name: id
+          in: path
+          description: The download_id returned from status request or a callback.
+          required: true
+      responses:
+        200:
+          description: Successful response
+          schema:
+            type: file
+        400:
+          description: Bad Request
+        403:
+          description: Forbidden
+        500:
+          description: Server Error
+
+definitions:
+  Doc:
+    type: object
+    required:
+      - name
+      - document_type
+      - document_content
+    properties:
+      name:
+        type: string
+        description: A name for identifying your document.
+      document_type:
+        type: string
+        description: The type of document being created.
+        enum:
+          - pdf
+          - xls
+          - xlsx
+      document_content:
+        type: string
+        description: |
+          The HTML data to be transformed into a document.
+          You must supply content using document_content or document_url.
+      document_url:
+        type: string
+        description: |
+          The URL to fetch the HTML data to be transformed into a document.
+          You must supply content using document_content or document_url.
+      test:
+        type: boolean
+        description: Enable test mode for this document. Test documents are not charged for but include a watermark.
+        default: true
+      strict:
+        type: string
+        description: Force strict HTML validation.
+        default: none
+        enum:
+          - none
+          - true
+      ignore_resource_errors:
+        type: boolean
+        description: Failed loading of images/javascripts/stylesheets/etc. will not cause the rendering to stop.
+        default: true
+      tag:
+        type: string
+        description: A field for storing a small amount of metadata with this document.
+      help:
+        type: boolean
+        description: Request support help with this request if it succeeds.
+        default: false
+      javascript:
+        type: boolean
+        description: Enable DocRaptor JavaScript parsing. PrinceXML JavaScript parsing is also available elsewhere.
+        default: false
+      referrer:
+        type: string
+        description: Set HTTP referrer when generating this document.
+      callback_url:
+        type: string
+        description: |
+          A URL that will receive a POST request after successfully completing an asynchronous document.
+          The POST data will include download_url and download_id similar to status api responses.
+          WARNING: this only works on asynchronous documents.
+      prince_options:
+        $ref: '#/definitions/PrinceOptions'
+
+  PrinceOptions:
+    type: object
+    properties:
+      baseurl:
+        type: string
+        description: Set the baseurl for assets.
+      no_xinclude:
+        type: boolean
+        description: Disable XML inclusion.
+      no_network:
+        type: boolean
+        description: Disable network access.
+      http_user:
+        type: string
+        description: Set the user for HTTP authentication.
+      http_password:
+        type: string
+        description: Set the password for HTTP authentication.
+      http_proxy:
+        type: string
+        description: Set the HTTP proxy server.
+      http_timeout:
+        type: integer
+        description: Set the HTTP request timeout.
+        # default: 10
+      insecure:
+        type: boolean
+        description: Disable SSL verification.
+        # default: false
+      media:
+        type: string
+        description: Specify the CSS media type. Defaults to "print" but you may want to use "screen" for web styles.
+        default: print
+      no_author_style:
+        type: boolean
+        description: Ignore author stylesheets.
+      no_default_style:
+        type: boolean
+        description: Ignore default stylesheets.
+      no_embed_fonts:
+        type: boolean
+        description: Disable font embedding in PDFs.
+      no_subset_fonts:
+        type: boolean
+        description: Disable font subsetting in PDFs.
+      no_compress:
+        type: boolean
+        description: Disable PDF compression.
+      encrypt:
+        type: boolean
+        description: Encrypt PDF output.
+      key_bits:
+        type: integer
+        description: Set encryption key size.
+        enum:
+          - 40
+          - 128
+      user_password:
+        type: string
+        description: Set the PDF user password.
+      owner_password:
+        type: string
+        description: Set the PDF owner password.
+      disallow_print:
+        type: boolean
+        description: Disallow printing of this PDF.
+      disallow_copy:
+        type: boolean
+        description: Disallow copying of this PDF.
+      disallow_annotate:
+        type: boolean
+        description: Disallow annotation of this PDF.
+      disallow_modify:
+        type: boolean
+        description: Disallow modification of this PDF.
+      input:
+        type: string
+        description: Specify the input format.
+        default: html
+        enum:
+          - html
+          - xml
+          - auto
+      version:
+        type: string
+        description: Specify a specific verison of PrinceXML to use.
+        # default: 10
+        # disabled because Java will try to make an enum as 7_1 which fails
+        # enum:
+        #   - 7.1
+        #   - 8.1
+        #   - 9.0
+        #   - 10
+      javascript:
+        type: boolean
+        description: Enable PrinceXML JavaScript. DocRaptor JavaScript parsing is also available elsewhere.
+      css_dpi:
+        type: integer
+        description: Set the DPI when rendering CSS. Defaults to 96 but can be set with Prince 9.0 and up.
+        # default: 96
+      profile:
+        type: string
+        description: In Prince 9.0 and up you can set the PDF profile.
+        # disabled because Java will try to make an enum with PDF/A-1b which fails
+        # enum:
+        #   - PDF/A-1b
+        #   - PDF/X-3:2003
+        #   - PDF/X-4
+
+  AsyncDoc:
+    type: object
+    properties:
+      status_id:
+        type: string
+        description: The identifier used to get the status of the document using the status api.
+
+  AsyncDocStatus:
+    type: object
+    properties:
+      status:
+        type: string
+        description: The present status of the document. Can be queued, working, completed, and failed.
+      download_url:
+        type: string
+        description: The URL where the document can be retrieved. This URL may only be used a few times.
+      download_id:
+        type: string
+        description: The identifier for downloading the document with the download api.
+      message:
+        type: string
+        description: Additional information.
+      number_of_pages:
+        type: integer
+        description: Number of PDF pages in document.
+      validation_errors:
+        type: string
+        description: Error information.

data/lib/docraptor/api/client_api.rb

@@ -13,8 +13,8 @@ module DocRaptor
     # @param doc The document to be created.
     # @param [Hash] opts the optional parameters
     # @return [AsyncDoc]
-    def async_docs_post(doc, opts = {})
-      data, status_code, headers = async_docs_post_with_http_info(doc, opts)
+    def create_async_doc(doc, opts = {})
+      data, status_code, headers = create_async_doc_with_http_info(doc, opts)
       return data
     end
 
@@ -23,13 +23,13 @@ module DocRaptor
     # @param doc The document to be created.
     # @param [Hash] opts the optional parameters
     # @return [Array<(AsyncDoc, Fixnum, Hash)>] AsyncDoc data, response status code and response headers
-    def async_docs_post_with_http_info(doc, opts = {})
+    def create_async_doc_with_http_info(doc, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ClientApi#async_docs_post ..."
+        @api_client.config.logger.debug "Calling API: ClientApi#create_async_doc ..."
       end
       
       # verify the required parameter 'doc' is set
-      fail "Missing the required parameter 'doc' when calling async_docs_post" if doc.nil?
+      fail "Missing the required parameter 'doc' when calling create_async_doc" if doc.nil?
       
       # resource path
       path = "/async_docs".sub('{format}','json')
@@ -64,7 +64,7 @@ module DocRaptor
         :auth_names => auth_names,
         :return_type => 'AsyncDoc')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ClientApi#async_docs_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: ClientApi#create_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -74,8 +74,8 @@ module DocRaptor
     # @param doc The document to be created.
     # @param [Hash] opts the optional parameters
     # @return [File]
-    def docs_post(doc, opts = {})
-      data, status_code, headers = docs_post_with_http_info(doc, opts)
+    def create_doc(doc, opts = {})
+      data, status_code, headers = create_doc_with_http_info(doc, opts)
       return data
     end
 
@@ -84,13 +84,13 @@ module DocRaptor
     # @param doc The document to be created.
     # @param [Hash] opts the optional parameters
     # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
-    def docs_post_with_http_info(doc, opts = {})
+    def create_doc_with_http_info(doc, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ClientApi#docs_post ..."
+        @api_client.config.logger.debug "Calling API: ClientApi#create_doc ..."
       end
       
       # verify the required parameter 'doc' is set
-      fail "Missing the required parameter 'doc' when calling docs_post" if doc.nil?
+      fail "Missing the required parameter 'doc' when calling create_doc" if doc.nil?
       
       # resource path
       path = "/docs".sub('{format}','json')
@@ -125,7 +125,7 @@ module DocRaptor
         :auth_names => auth_names,
         :return_type => 'File')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ClientApi#docs_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: ClientApi#create_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -135,8 +135,8 @@ module DocRaptor
     # @param id The download_id returned from status request or a callback.
     # @param [Hash] opts the optional parameters
     # @return [File]
-    def download_id_get(id, opts = {})
-      data, status_code, headers = download_id_get_with_http_info(id, opts)
+    def get_async_doc(id, opts = {})
+      data, status_code, headers = get_async_doc_with_http_info(id, opts)
       return data
     end
 
@@ -145,13 +145,13 @@ module DocRaptor
     # @param id The download_id returned from status request or a callback.
     # @param [Hash] opts the optional parameters
     # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
-    def download_id_get_with_http_info(id, opts = {})
+    def get_async_doc_with_http_info(id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ClientApi#download_id_get ..."
+        @api_client.config.logger.debug "Calling API: ClientApi#get_async_doc ..."
       end
       
       # verify the required parameter 'id' is set
-      fail "Missing the required parameter 'id' when calling download_id_get" if id.nil?
+      fail "Missing the required parameter 'id' when calling get_async_doc" if id.nil?
       
       # resource path
       path = "/download/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
@@ -186,7 +186,7 @@ module DocRaptor
         :auth_names => auth_names,
         :return_type => 'File')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ClientApi#download_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: ClientApi#get_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -196,8 +196,8 @@ module DocRaptor
     # @param id The status_id returned when creating an asynchronous document.
     # @param [Hash] opts the optional parameters
     # @return [AsyncDocStatus]
-    def status_id_get(id, opts = {})
-      data, status_code, headers = status_id_get_with_http_info(id, opts)
+    def get_async_doc_status(id, opts = {})
+      data, status_code, headers = get_async_doc_status_with_http_info(id, opts)
       return data
     end
 
@@ -206,13 +206,13 @@ module DocRaptor
     # @param id The status_id returned when creating an asynchronous document.
     # @param [Hash] opts the optional parameters
     # @return [Array<(AsyncDocStatus, Fixnum, Hash)>] AsyncDocStatus data, response status code and response headers
-    def status_id_get_with_http_info(id, opts = {})
+    def get_async_doc_status_with_http_info(id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ClientApi#status_id_get ..."
+        @api_client.config.logger.debug "Calling API: ClientApi#get_async_doc_status ..."
       end
       
       # verify the required parameter 'id' is set
-      fail "Missing the required parameter 'id' when calling status_id_get" if id.nil?
+      fail "Missing the required parameter 'id' when calling get_async_doc_status" if id.nil?
       
       # resource path
       path = "/status/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
@@ -247,7 +247,7 @@ module DocRaptor
         :auth_names => auth_names,
         :return_type => 'AsyncDocStatus')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ClientApi#status_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: ClientApi#get_async_doc_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/docraptor/api_client.rb

@@ -170,23 +170,37 @@ module DocRaptor
     # from the "Content-Disposition" header if provided, otherwise a random filename.
     #
     # @see Configuration#temp_folder_path
-    # @return [File] the file downloaded
+    # @return [Tempfile] the file downloaded
     def download_file(response)
-      tmp_file = Tempfile.new '', @config.temp_folder_path
       content_disposition = response.headers['Content-Disposition']
       if content_disposition
         filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-        path = File.join File.dirname(tmp_file), filename
+        prefix = sanitize_filename(filename)
       else
-        path = tmp_file.path
+        prefix = 'download-'
       end
-      # close and delete temp file
-      tmp_file.close!
+      prefix = prefix + '-' unless prefix.end_with?('-')
 
-      File.open(path, 'w') { |file| file.write(response.body) }
-      @config.logger.info "File written to #{path}. Please move the file to a proper folder "\
-                          "for further processing and delete the temp afterwards"
-      File.new(path)
+      tempfile = nil
+      encoding = response.body.encoding
+      Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file|
+        file.write(response.body)
+        tempfile = file
+      end
+      @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                          "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                          "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                          "explicitly with `tempfile.delete`"
+      tempfile
+    end
+
+    # Sanitize filename by removing path.
+    # e.g. ../../sun.gif becomes sun.gif
+    #
+    # @param [String] filename the filename to be sanitized
+    # @return [String] the sanitized filename
+    def sanitize_filename(filename)
+      filename.gsub /.*[\/\\]/, ''
     end
 
     def build_request_url(path)

data/lib/docraptor/models/doc.rb

@@ -20,6 +20,9 @@ module DocRaptor
     # Force strict HTML validation.
     attr_accessor :strict
 
+    # Failed loading of images/javascripts/stylesheets/etc. will not cause the rendering to stop.
+    attr_accessor :ignore_resource_errors
+
     # A field for storing a small amount of metadata with this document.
     attr_accessor :tag
 
@@ -53,6 +56,8 @@ module DocRaptor
         
         :'strict' => :'strict',
         
+        :'ignore_resource_errors' => :'ignore_resource_errors',
+        
         :'tag' => :'tag',
         
         :'help' => :'help',
@@ -77,6 +82,7 @@ module DocRaptor
         :'document_url' => :'String',
         :'test' => :'BOOLEAN',
         :'strict' => :'String',
+        :'ignore_resource_errors' => :'BOOLEAN',
         :'tag' => :'String',
         :'help' => :'BOOLEAN',
         :'javascript' => :'BOOLEAN',
@@ -122,6 +128,12 @@ module DocRaptor
         self.strict = "none"
       end
       
+      if attributes[:'ignore_resource_errors']
+        self.ignore_resource_errors = attributes[:'ignore_resource_errors']
+      else
+        self.ignore_resource_errors = true
+      end
+      
       if attributes[:'tag']
         self.tag = attributes[:'tag']
       end
@@ -180,6 +192,7 @@ module DocRaptor
           document_url == o.document_url &&
           test == o.test &&
           strict == o.strict &&
+          ignore_resource_errors == o.ignore_resource_errors &&
           tag == o.tag &&
           help == o.help &&
           javascript == o.javascript &&
@@ -195,7 +208,7 @@ module DocRaptor
 
     # Calculate hash code according to all attributes.
     def hash
-      [name, document_type, document_content, document_url, test, strict, tag, help, javascript, referrer, callback_url, prince_options].hash
+      [name, document_type, document_content, document_url, test, strict, ignore_resource_errors, tag, help, javascript, referrer, callback_url, prince_options].hash
     end
 
     # build the object from hash

data/lib/docraptor/version.rb

@@ -1,3 +1,3 @@
 module DocRaptor
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/script/clean

@@ -0,0 +1,5 @@
+#!/bin/sh
+set -e
+cd "`dirname \"$0\"`/.."
+
+rm -rf lib/

data/script/generate_language

@@ -0,0 +1,29 @@
+#!/bin/sh
+set -e
+cd "`dirname \"$0\"`/.."
+
+LANGUAGE="$1"
+CONFIG_FILE="swagger-config.json"
+
+if [ "$LANGUAGE" == "" ]; then
+  ./script/swagger # prints languages
+  exit 1
+fi
+
+if [ ! -f "$CONFIG_FILE" ]; then
+  echo "Could not find $CONFIG_FILE"
+  ./script/swagger config-help -l $LANGUAGE
+  exit 1
+fi
+
+./script/clean
+
+./script/swagger generate \
+  -i docraptor.yaml \
+  -l $LANGUAGE \
+  -c $CONFIG_FILE
+
+# call a generator cleanup script
+if [ -f "script/post_generate_language" ]; then
+  ./script/post_generate_language
+fi

data/script/swagger

@@ -0,0 +1,26 @@
+#!/bin/bash
+set -e
+cd "`dirname \"$0\"`/.."
+
+if [ ! -d "swagger-codegen" ]; then
+  git clone https://github.com/swagger-api/swagger-codegen
+fi
+
+cd swagger-codegen
+
+SWAGGER_CODGEN_REVISION="e50dc04418b288dff16686a57eb6d4d540c073d2" # v2.1.5+
+if [[ `cat .git/HEAD` != "$SWAGGER_CODGEN_REVISION" ]]; then
+  git fetch
+  git checkout $SWAGGER_CODGEN_REVISION
+  mvn clean package
+fi
+cd ..
+
+executable="./swagger-codegen/modules/swagger-codegen-cli/target/swagger-codegen-cli.jar"
+
+if [ ! -f "$executable" ]; then
+  mvn clean package
+fi
+
+export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
+java $JAVA_OPTS -jar $executable $*

data/script/test

@@ -0,0 +1,14 @@
+#!/bin/sh
+set -e
+cd "`dirname \"$0\"`/.."
+
+cd test/
+bundle install
+
+if [ "$1" == "" ]; then
+  for test in $(ls *.rb); do
+    ruby $test
+  done
+else
+  ruby $1.rb
+fi

data/script/update_from_upstream

@@ -0,0 +1,43 @@
+#!/bin/bash
+set -e
+cd "`dirname \"$0\"`/.."
+
+if [[ `basename $PWD` == "swagger" ]]; then
+  echo "This command is only used in langauge specific repositories"
+  exit 1
+fi
+
+# Gets content at $1 and puts it into $2, automatically chmod +x if $2 is the
+# script dir.
+get() {
+  curl --fail --silent --show-error $1 > $2
+  if [[ `dirname $2` == "script" ]]; then
+    chmod +x $2
+  fi
+}
+
+# Gets a file $1 from the upstream repo and places it in the same location.
+get_upstream() {
+  get "https://raw.githubusercontent.com/docraptor/docraptor-swagger/master/$1" $1
+}
+
+# Main entry point, wrapped in a function so that bash can handle replacing
+# this file while executing it.
+update() {
+  original=`md5 script/update_from_upstream`
+  get_upstream script/update_from_upstream
+  if [[ `md5 script/update_from_upstream` != "$original" ]]; then
+    echo "Detected updated update_from_upstream command, running again"
+    script/update_from_upstream
+    exit 0 # recursive call above handled everything
+  fi
+
+  get_upstream docraptor.yaml
+
+  get_upstream script/swagger
+  script/swagger # download repo, etc.
+
+  get_upstream script/generate_language
+}
+
+update

data/swagger-config.json

@@ -0,0 +1,5 @@
+{
+	"gemName": "docraptor",
+	"moduleName": "DocRaptor",
+  "gemVersion": "0.0.3"
+}

data/test/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "pry"
+gem "docraptor", path: ".."

data/test/async.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+Bundler.require
+
+DocRaptor.configure do |dr|
+  dr.username = "YOUR_API_KEY_HERE"
+  dr.debugging = true
+end
+
+doc_api = DocRaptor::ClientApi.new
+
+response = doc_api.create_async_doc(test: true, document_content: "<html><body>Swagger Ruby</body></html>", name: "swagger-ruby.pdf", document_type: "pdf")
+
+status_response = nil
+loop do
+  status_response = doc_api.get_async_doc_status(response.status_id)
+  break if status_response.status == "completed"
+  sleep 1
+end
+
+puts doc_api.get_async_doc(status_response.download_id)
+

data/test/invalid_async.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+Bundler.require
+
+DocRaptor.configure do |dr|
+  dr.username = "YOUR_API_KEY_HERE"
+  dr.debugging = true
+end
+
+doc_api = DocRaptor::ClientApi.new
+
+response = doc_api.create_async_doc(test: true, document_content: "<html><body>Swagger Ruby</body></html>", name: "s" * 201, document_type: "pdf")
+
+status_response = nil
+30.times do
+  status_response = doc_api.get_async_doc_status(response.status_id)
+  exit if status_response.status == "failed"
+  sleep 1
+end
+
+abort "Did not receive failed validation within 30 seconds."

data/test/invalid_sync.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+Bundler.require
+
+DocRaptor.configure do |dr|
+  dr.username = "YOUR_API_KEY_HERE"
+  dr.debugging = true
+end
+
+doc_api = DocRaptor::ClientApi.new
+
+
+begin
+  response = doc_api.create_doc(test: true, name: "s" * 201, document_type: "pdf")
+rescue DocRaptor::ApiError
+  exit
+end
+
+abort "Exception expected, but not raised"

data/test/sync.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+Bundler.require
+
+DocRaptor.configure do |dr|
+  dr.username = "YOUR_API_KEY_HERE"
+  dr.debugging = true
+end
+
+doc_api = DocRaptor::ClientApi.new
+
+response = doc_api.create_doc(test: true, document_content: "<html><body>Swagger Ruby</body></html>", name: "swagger-ruby.pdf", document_type: "pdf")

data/test/xlsx.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+Bundler.require
+
+DocRaptor.configure do |dr|
+  dr.username = "YOUR_API_KEY_HERE"
+  dr.debugging = true
+end
+
+dr = DocRaptor::ClientApi.new
+
+response = dr.create_doc(test: true, document_content: "<html><body><table><tr><td>Swagger Ruby</td></tr></table></body></html>", name: "swagger-ruby.xlsx", document_type: "xlsx")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docraptor
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Elijah Miller
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-07 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -200,7 +200,7 @@ dependencies:
         version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.10
+        version: 0.2.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -210,7 +210,7 @@ dependencies:
         version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.10
+        version: 0.2.11
 description: A native client library for the DocRaptor HTML to PDF/XLS service.
 email:
 - elijah@expectedbehavior.com
@@ -219,8 +219,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
 - Rakefile
 - docraptor.gemspec
+- docraptor.yaml
 - lib/docraptor.rb
 - lib/docraptor/api/client_api.rb
 - lib/docraptor/api_client.rb
@@ -231,9 +237,22 @@ files:
 - lib/docraptor/models/doc.rb
 - lib/docraptor/models/prince_options.rb
 - lib/docraptor/version.rb
+- pkg/docraptor-0.0.3.gem
+- script/clean
+- script/generate_language
+- script/swagger
+- script/test
+- script/update_from_upstream
+- swagger-config.json
+- test/Gemfile
+- test/async.rb
+- test/invalid_async.rb
+- test/invalid_sync.rb
+- test/sync.rb
+- test/xlsx.rb
 homepage: https://docraptor.com
 licenses:
-- MIT
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -251,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A wrapper for the DocRaptor HTML to PDF/XLS service.