docraptor 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fad9a985e8677d1e169dfe5ff389f8a49c8d1ebd
-  data.tar.gz: 345911f7f165e051bc60a171493524a0cdc169d0
+  metadata.gz: 6a54ab8664324ce2f630ba8a0838b7bd15c99c19
+  data.tar.gz: b24824eb919e02bad8ba05790e1c4423a1158dfb
 SHA512:
-  metadata.gz: f43ad89a0e4bddb075348cbd73b3eefd72398c282b2640e14516e53acbb945a3bf14ba00a1e338066cbbcf6bbb8b22485ad32d9e3749bb0441911a4da196ae49
-  data.tar.gz: e9d1311fe9e602dffbc5429dd266f916c850f9069c3272b7c462280f32363b0f901f6d27bd9a08672e156ebb33664935b2fe43fbd18280699afa0e5206a69564
+  metadata.gz: 08e853b7a0eb1bb0ef8d7b2e390556ff786993e09b9579a397d15a4050f3823cf19e428b657ff87066153150970cfcf28bf7f86fc268f2bc41dd1e379919edff
+  data.tar.gz: 116c4516a5342d4d3f3556c2d0cbf5b6e5717239bf5c5919958b81368dcbff640ad10e8408000eaf90c6c5c4f494ec6c6c1a52c1155e3bc364624265d30da949

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### 0.2.0 [January 29, 2016]
+* **BREAKING CHANGE**: Rename ClientApi to DocApi
+
 ### 0.1.0 [January 27, 2016]
 * **BREAKING CHANGE**: create_doc and get_async_doc responses are now binary strings instead of Tempfiles
 

data/README.md

@@ -1,9 +1,8 @@
 # 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`.
@@ -12,7 +11,12 @@ Add the following to your `Gemfile`.
 gem "docraptor"
 ```
 
-Then run `bundle install`.
+Then run:
+
+```bash
+bundle install
+```
+
 
 ## Usage
 
@@ -24,7 +28,7 @@ DocRaptor.configure do |dr|
   # dr.debugging = true
 end
 
-$docraptor = DocRaptor::ClientApi.new
+$docraptor = DocRaptor::DocApi.new
 
 response = $docraptor.create_doc(
   test:             true,                                         # test documents are free but watermarked
@@ -42,12 +46,13 @@ response = $docraptor.create_doc(
 
 Docs created like this are limited to 60 seconds to render, check out the [async example](examples/async.rb) which allows 10 minutes.
 
-
 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).
@@ -59,18 +64,17 @@ Stuck? We're experts at using DocRaptor so please [email us](mailto:support@docr
 
 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`.
 
-The generated client needed a few fixes
-- binary string response code generated from https://github.com/swagger-api/swagger-codegen/pull/1934
-
 
 ## Release Process
 
 1. `script/test`
 2. Increment version in code:
   - `swagger-config.json`
-  - `docraptor.gemspec`
+  - `lib/docraptor/version.rb`
 3. Update [CHANGELOG.md](CHANGELOG.md)
 4. `rake release`
+5. Update documentation on docraptor.com
+
 
 ## Version Policy
 

data/docraptor.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
 
   s.files         = `git ls-files`.split("\n").uniq.sort.select{|f| !f.empty? }
+  # s.test_files    = `git ls-files spec`.split("\n")
   s.executables   = []
   s.require_paths = ["lib"]
 end

data/docraptor.yaml

@@ -10,7 +10,7 @@ schemes: [https]
 securityDefinitions:
   basicAuth:
     type: basic
-    description: HTTP Basic Authentication. Works over `HTTP` and `HTTPS`
+    description: Use your API key as the username. Password does not need to be set.
 produces:
   - application/json
   - application/xml
@@ -22,8 +22,8 @@ paths:
   /docs:
     post:
       operationId: createDoc
-      tags: [Client]
-      description: |
+      tags: [Doc]
+      description: >
         Creates a document synchronously.
       security:
         - basicAuth: []
@@ -53,10 +53,11 @@ paths:
   /async_docs:
     post:
       operationId: createAsyncDoc
-      tags: [Client]
-      description: |
+      tags: [Doc]
+      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.
+        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:
@@ -85,8 +86,8 @@ paths:
   /status/{id}:
     get:
       operationId: getAsyncDocStatus
-      tags: [Client]
-      description: |
+      tags: [Doc]
+      description: >
         Check on the status of an asynchronously created document.
       security:
         - basicAuth: []
@@ -109,12 +110,11 @@ paths:
         500:
           description: Server Error
 
-
   /download/{id}:
     get:
       operationId: getAsyncDoc
-      tags: [Client]
-      description: |
+      tags: [Doc]
+      description: >
         Downloads a document.
       security:
         - basicAuth: []
@@ -156,12 +156,12 @@ definitions:
           - xlsx
       document_content:
         type: string
-        description: |
+        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: |
+        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:
@@ -195,7 +195,7 @@ definitions:
         description: Set HTTP referrer when generating this document.
       callback_url:
         type: string
-        description: |
+        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.

data/examples/async.rb

@@ -18,7 +18,7 @@ DocRaptor.configure do |dr|
   # dr.debugging = true
 end
 
-$docraptor = DocRaptor::ClientApi.new
+$docraptor = DocRaptor::DocApi.new
 
 begin
 

data/examples/sync.rb

@@ -19,7 +19,7 @@ DocRaptor.configure do |dr|
   # dr.debugging = true
 end
 
-$docraptor = DocRaptor::ClientApi.new
+$docraptor = DocRaptor::DocApi.new
 
 begin
 

data/lib/docraptor.rb

@@ -11,7 +11,7 @@ require 'docraptor/models/async_doc'
 require 'docraptor/models/async_doc_status'
 
 # APIs
-require 'docraptor/api/client_api'
+require 'docraptor/api/doc_api'
 
 module DocRaptor
   class << self

data/lib/docraptor/api/{client_api.rb → doc_api.rb}

@@ -1,7 +1,7 @@
 require "uri"
 
 module DocRaptor
-  class ClientApi
+  class DocApi
     attr_accessor :api_client
 
     def initialize(api_client = ApiClient.default)
@@ -9,7 +9,7 @@ module DocRaptor
     end
 
     # 
-    # Creates a document asynchronously.\nYou 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.
+    # 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.
     # @param doc The document to be created.
     # @param [Hash] opts the optional parameters
     # @return [AsyncDoc]
@@ -19,13 +19,13 @@ module DocRaptor
     end
 
     # 
-    # Creates a document asynchronously.\nYou 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.
+    # 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.
     # @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 create_async_doc_with_http_info(doc, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ClientApi#create_async_doc ..."
+        @api_client.config.logger.debug "Calling API: DocApi#create_async_doc ..."
       end
       
       # verify the required parameter 'doc' is set
@@ -54,7 +54,6 @@ module DocRaptor
       # http body (model)
       post_body = @api_client.object_to_http_body(doc)
       
-
       auth_names = ['basicAuth']
       data, status_code, headers = @api_client.call_api(:POST, path,
         :header_params => header_params,
@@ -64,7 +63,7 @@ module DocRaptor
         :auth_names => auth_names,
         :return_type => 'AsyncDoc')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ClientApi#create_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: DocApi#create_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -86,7 +85,7 @@ module DocRaptor
     # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
     def create_doc_with_http_info(doc, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ClientApi#create_doc ..."
+        @api_client.config.logger.debug "Calling API: DocApi#create_doc ..."
       end
       
       # verify the required parameter 'doc' is set
@@ -115,7 +114,6 @@ module DocRaptor
       # http body (model)
       post_body = @api_client.object_to_http_body(doc)
       
-
       auth_names = ['basicAuth']
       data, status_code, headers = @api_client.call_api(:POST, path,
         :header_params => header_params,
@@ -125,7 +123,7 @@ module DocRaptor
         :auth_names => auth_names,
         :return_type => 'String')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ClientApi#create_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: DocApi#create_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -147,7 +145,7 @@ module DocRaptor
     # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
     def get_async_doc_with_http_info(id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ClientApi#get_async_doc ..."
+        @api_client.config.logger.debug "Calling API: DocApi#get_async_doc ..."
       end
       
       # verify the required parameter 'id' is set
@@ -176,7 +174,6 @@ module DocRaptor
       # http body (model)
       post_body = nil
       
-
       auth_names = ['basicAuth']
       data, status_code, headers = @api_client.call_api(:GET, path,
         :header_params => header_params,
@@ -186,7 +183,7 @@ module DocRaptor
         :auth_names => auth_names,
         :return_type => 'String')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ClientApi#get_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: DocApi#get_async_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -208,7 +205,7 @@ module DocRaptor
     # @return [Array<(AsyncDocStatus, Fixnum, Hash)>] AsyncDocStatus data, response status code and response headers
     def get_async_doc_status_with_http_info(id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: ClientApi#get_async_doc_status ..."
+        @api_client.config.logger.debug "Calling API: DocApi#get_async_doc_status ..."
       end
       
       # verify the required parameter 'id' is set
@@ -237,7 +234,6 @@ module DocRaptor
       # http body (model)
       post_body = nil
       
-
       auth_names = ['basicAuth']
       data, status_code, headers = @api_client.call_api(:GET, path,
         :header_params => header_params,
@@ -247,13 +243,9 @@ module DocRaptor
         :auth_names => auth_names,
         :return_type => 'AsyncDocStatus')
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ClientApi#get_async_doc_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: DocApi#get_async_doc_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
   end
 end
-
-
-
-

data/lib/docraptor/api_client.rb

@@ -75,10 +75,11 @@ module DocRaptor
         :ssl_verifypeer => @config.verify_ssl,
         :sslcert => @config.cert_file,
         :sslkey => @config.key_file,
-        :cainfo => @config.ssl_ca_cert,
         :verbose => @config.debugging
       }
 
+      req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
+
       if [:post, :patch, :put, :delete].include?(http_method)
         req_body = build_request_body(header_params, form_params, opts[:body])
         req_opts.update :body => req_body

data/lib/docraptor/models/doc.rb

@@ -8,10 +8,10 @@ module DocRaptor
     # The type of document being created.
     attr_accessor :document_type
 
-    # The HTML data to be transformed into a document.\nYou must supply content using document_content or document_url.
+    # The HTML data to be transformed into a document. You must supply content using document_content or document_url.
     attr_accessor :document_content
 
-    # The URL to fetch the HTML data to be transformed into a document.\nYou must supply content using document_content or document_url.
+    # The URL to fetch the HTML data to be transformed into a document. You must supply content using document_content or document_url.
     attr_accessor :document_url
 
     # Enable test mode for this document. Test documents are not charged for but include a watermark.
@@ -35,7 +35,7 @@ module DocRaptor
     # Set HTTP referrer when generating this document.
     attr_accessor :referrer
 
-    # A URL that will receive a POST request after successfully completing an asynchronous document.\nThe POST data will include download_url and download_id similar to status api responses.\nWARNING: this only works on asynchronous documents.
+    # 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.
     attr_accessor :callback_url
 
     attr_accessor :prince_options

data/lib/docraptor/version.rb

@@ -1,3 +1,3 @@
 module DocRaptor
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/script/swagger

@@ -8,7 +8,7 @@ fi
 
 cd swagger-codegen
 
-SWAGGER_CODGEN_REVISION="e50dc04418b288dff16686a57eb6d4d540c073d2" # v2.1.5+
+SWAGGER_CODGEN_REVISION="f42f9acf3564264f84b970c894574da1e4c7c053" # v2.1.5+
 if [[ `cat .git/HEAD` != "$SWAGGER_CODGEN_REVISION" ]]; then
   git fetch
   git checkout $SWAGGER_CODGEN_REVISION

data/swagger-config.json

@@ -1,5 +1,5 @@
 {
 	"gemName": "docraptor",
 	"moduleName": "DocRaptor",
-  "gemVersion": "0.1.0"
+  "gemVersion": "0.2.0"
 }

data/test/async.rb

@@ -6,7 +6,7 @@ DocRaptor.configure do |dr|
   # dr.debugging = true
 end
 
-$docraptor = DocRaptor::ClientApi.new
+$docraptor = DocRaptor::DocApi.new
 
 create_response = $docraptor.create_async_doc(
   test:             true,

data/test/invalid_async.rb

@@ -6,7 +6,7 @@ DocRaptor.configure do |dr|
   # dr.debugging = true
 end
 
-$docraptor = DocRaptor::ClientApi.new
+$docraptor = DocRaptor::DocApi.new
 
 create_response = $docraptor.create_async_doc(
   test:             true,

data/test/invalid_sync.rb

@@ -6,7 +6,7 @@ DocRaptor.configure do |dr|
   # dr.debugging = true
 end
 
-$docraptor = DocRaptor::ClientApi.new
+$docraptor = DocRaptor::DocApi.new
 
 begin
   $docraptor.create_doc(

data/test/sync.rb

@@ -6,7 +6,7 @@ DocRaptor.configure do |dr|
   # dr.debugging = true
 end
 
-$docraptor = DocRaptor::ClientApi.new
+$docraptor = DocRaptor::DocApi.new
 
 $docraptor.create_doc(
   test:             true,

data/test/xlsx.rb

@@ -6,7 +6,7 @@ DocRaptor.configure do |dr|
   # dr.debugging = true
 end
 
-$docraptor = DocRaptor::ClientApi.new
+$docraptor = DocRaptor::DocApi.new
 
 $docraptor.create_doc(
   test:             true,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docraptor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Elijah Miller
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-27 00:00:00.000000000 Z
+date: 2016-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -250,7 +250,7 @@ files:
 - examples/async.rb
 - examples/sync.rb
 - lib/docraptor.rb
-- lib/docraptor/api/client_api.rb
+- lib/docraptor/api/doc_api.rb
 - lib/docraptor/api_client.rb
 - lib/docraptor/api_error.rb
 - lib/docraptor/configuration.rb