docraptor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 520005260c4eb699f6ac0c8b223def5e9624e57d
-  data.tar.gz: 6a976eea99f53053665f0f4995b690e606c3ecc0
+  metadata.gz: f5a1c61577a464a76a8c99838bf03671dacf4868
+  data.tar.gz: fd38c94ea003066f08f23bbecda331d12f3d942e
 SHA512:
-  metadata.gz: eaa8cd06bd4ef88d656e7342941684c38513edeb6c33851aec486b18815c829edd436df1fea2d35adf491cd4a5afb51e04418bc10dbc6caea9b0c990a5c5a75a
-  data.tar.gz: 109acdcb676b246f7124371d8a5b4dcf1bb5bcf2dc2d223862a7135951c546f24ee49e150f9e564f6ab66f11ef216f3ba8c157fd3404e0166bbde90d6d785f9d
+  metadata.gz: cb72fe8bf315cde69177f0277ee357b995cb03f4b26a1e69d9b4f5149bb6a3299ec5106e54c50296cd999f9a1bb9eff8027526e6f18731269e0e623103a9ff60
+  data.tar.gz: a9ad7e0ff6509865334d9294f560130a6011d4e6ac2dd2600f9712fcbdb35f13c5de7d91feefe30ee69c66f2b9a3312cff75c71092ae9c7e5ff8bb1266e60375

data/lib/docraptor.rb

@@ -5,7 +5,6 @@ require 'docraptor/version'
 require 'docraptor/configuration'
 
 # Models
-require 'docraptor/models/base_object'
 require 'docraptor/models/doc'
 require 'docraptor/models/prince_options'
 require 'docraptor/models/async_doc'
@@ -16,17 +15,17 @@ require 'docraptor/api/client_api'
 
 module DocRaptor
   class << self
-    # Configure sdk using block.
-    # DocRaptor.configure do |config|
-    #   config.username = "xxx"
-    #   config.password = "xxx"
-    # end
-    # If no block given, return the configuration singleton instance.
+    # Customize default settings for the SDK using block.
+    #   DocRaptor.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
     def configure
       if block_given?
-        yield Configuration.instance
+        yield(Configuration.default)
       else
-        Configuration.instance
+        Configuration.default
       end
     end
   end

data/lib/docraptor/api/client_api.rb

@@ -4,8 +4,8 @@ module DocRaptor
   class ClientApi
     attr_accessor :api_client
 
-    def initialize(api_client = nil)
-      @api_client = api_client || Configuration.api_client
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
     end
 
     # 
@@ -14,8 +14,18 @@ module DocRaptor
     # @param [Hash] opts the optional parameters
     # @return [AsyncDoc]
     def async_docs_post(doc, opts = {})
-      if Configuration.debugging
-        Configuration.logger.debug "Calling API: ClientApi#async_docs_post ..."
+      data, status_code, headers = async_docs_post_with_http_info(doc, opts)
+      return data
+    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.
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ClientApi#async_docs_post ..."
       end
       
       # verify the required parameter 'doc' is set
@@ -46,17 +56,17 @@ module DocRaptor
       
 
       auth_names = ['basicAuth']
-      result = @api_client.call_api(:POST, path,
+      data, status_code, headers = @api_client.call_api(:POST, path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
         :return_type => 'AsyncDoc')
-      if Configuration.debugging
-        Configuration.logger.debug "API called: ClientApi#async_docs_post. Result: #{result.inspect}"
+      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}"
       end
-      return result
+      return data, status_code, headers
     end
 
     # 
@@ -65,8 +75,18 @@ module DocRaptor
     # @param [Hash] opts the optional parameters
     # @return [File]
     def docs_post(doc, opts = {})
-      if Configuration.debugging
-        Configuration.logger.debug "Calling API: ClientApi#docs_post ..."
+      data, status_code, headers = docs_post_with_http_info(doc, opts)
+      return data
+    end
+
+    # 
+    # Creates a document synchronously.
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ClientApi#docs_post ..."
       end
       
       # verify the required parameter 'doc' is set
@@ -97,17 +117,17 @@ module DocRaptor
       
 
       auth_names = ['basicAuth']
-      result = @api_client.call_api(:POST, path,
+      data, status_code, headers = @api_client.call_api(:POST, path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
         :return_type => 'File')
-      if Configuration.debugging
-        Configuration.logger.debug "API called: ClientApi#docs_post. Result: #{result.inspect}"
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ClientApi#docs_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
-      return result
+      return data, status_code, headers
     end
 
     # 
@@ -116,8 +136,18 @@ module DocRaptor
     # @param [Hash] opts the optional parameters
     # @return [File]
     def download_id_get(id, opts = {})
-      if Configuration.debugging
-        Configuration.logger.debug "Calling API: ClientApi#download_id_get ..."
+      data, status_code, headers = download_id_get_with_http_info(id, opts)
+      return data
+    end
+
+    # 
+    # Downloads a document.
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ClientApi#download_id_get ..."
       end
       
       # verify the required parameter 'id' is set
@@ -148,17 +178,17 @@ module DocRaptor
       
 
       auth_names = ['basicAuth']
-      result = @api_client.call_api(:GET, path,
+      data, status_code, headers = @api_client.call_api(:GET, path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
         :return_type => 'File')
-      if Configuration.debugging
-        Configuration.logger.debug "API called: ClientApi#download_id_get. Result: #{result.inspect}"
+      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}"
       end
-      return result
+      return data, status_code, headers
     end
 
     # 
@@ -167,8 +197,18 @@ module DocRaptor
     # @param [Hash] opts the optional parameters
     # @return [AsyncDocStatus]
     def status_id_get(id, opts = {})
-      if Configuration.debugging
-        Configuration.logger.debug "Calling API: ClientApi#status_id_get ..."
+      data, status_code, headers = status_id_get_with_http_info(id, opts)
+      return data
+    end
+
+    # 
+    # Check on the status of an asynchronously created document.
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ClientApi#status_id_get ..."
       end
       
       # verify the required parameter 'id' is set
@@ -199,17 +239,17 @@ module DocRaptor
       
 
       auth_names = ['basicAuth']
-      result = @api_client.call_api(:GET, path,
+      data, status_code, headers = @api_client.call_api(:GET, path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
         :return_type => 'AsyncDocStatus')
-      if Configuration.debugging
-        Configuration.logger.debug "API called: ClientApi#status_id_get. Result: #{result.inspect}"
+      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}"
       end
-      return result
+      return data, status_code, headers
     end
   end
 end

data/lib/docraptor/api_client.rb

@@ -7,36 +7,37 @@ require 'uri'
 
 module DocRaptor
   class ApiClient
-
-    attr_accessor :host
+    # The Configuration object holding settings to be used in the API client.
+    attr_accessor :config
 
     # Defines the headers to be used in HTTP requests of all API calls by default.
     #
     # @return [Hash]
     attr_accessor :default_headers
 
-    # Stores the HTTP response from the last API call using this API client.
-    attr_accessor :last_response
-
-    def initialize(host = nil)
-      @host = host || Configuration.base_url
-      @format = 'json'
+    def initialize(config = Configuration.default)
+      @config = config
       @user_agent = "ruby-swagger-#{VERSION}"
       @default_headers = {
-        'Content-Type' => "application/#{@format.downcase}",
+        'Content-Type' => "application/json",
         'User-Agent' => @user_agent
       }
     end
 
+    def self.default
+      @@default ||= ApiClient.new
+    end
+
+    # Call an API with given options.
+    #
+    # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
+    #   the data deserialized from response body (could be nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
       response = request.run
 
-      # record as last response
-      @last_response = response
-
-      if Configuration.debugging
-        Configuration.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      if @config.debugging
+        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
       end
 
       unless response.success?
@@ -47,10 +48,11 @@ module DocRaptor
       end
 
       if opts[:return_type]
-        deserialize(response, opts[:return_type])
+        data = deserialize(response, opts[:return_type])
       else
-        nil
+        data = nil
       end
+      return data, response.code, response.headers
     end
 
     def build_request(http_method, path, opts = {})
@@ -69,24 +71,34 @@ module DocRaptor
         :method => http_method,
         :headers => header_params,
         :params => query_params,
-        :ssl_verifypeer => Configuration.verify_ssl,
-        :sslcert => Configuration.cert_file,
-        :sslkey => Configuration.key_file,
-        :cainfo => Configuration.ssl_ca_cert,
-        :verbose => Configuration.debugging
+        :timeout => @config.timeout,
+        :ssl_verifypeer => @config.verify_ssl,
+        :sslcert => @config.cert_file,
+        :sslkey => @config.key_file,
+        :cainfo => @config.ssl_ca_cert,
+        :verbose => @config.debugging
       }
 
       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
-        if Configuration.debugging
-          Configuration.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+        if @config.debugging
+          @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
         end
       end
 
       Typhoeus::Request.new(url, req_opts)
     end
 
+    # Check if the given MIME is a JSON MIME.
+    # JSON MIME examples:
+    #   application/json
+    #   application/json; charset=UTF8
+    #   APPLICATION/JSON
+    def json_mime?(mime)
+       !!(mime =~ /\Aapplication\/json(;.*)?\z/i)
+    end
+
     # Deserialize the response to the given return type.
     #
     # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
@@ -100,9 +112,7 @@ module DocRaptor
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
 
-      unless content_type.start_with?('application/json')
-        fail "Content-Type is not supported: #{content_type}"
-      end
+      fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
 
       begin
         data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
@@ -162,7 +172,7 @@ module DocRaptor
     # @see Configuration#temp_folder_path
     # @return [File] the file downloaded
     def download_file(response)
-      tmp_file = Tempfile.new '', Configuration.temp_folder_path
+      tmp_file = Tempfile.new '', @config.temp_folder_path
       content_disposition = response.headers['Content-Disposition']
       if content_disposition
         filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
@@ -174,24 +184,30 @@ module DocRaptor
       tmp_file.close!
 
       File.open(path, 'w') { |file| file.write(response.body) }
-      Configuration.logger.info "File written to #{path}. Please move the file to a proper "\
-                                "folder for further processing and delete the temp afterwards"
+      @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)
     end
 
     def build_request_url(path)
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      URI.encode(host + path)
+      URI.encode(@config.base_url + path)
     end
 
     def build_request_body(header_params, form_params, body)
       # http form
       if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
           header_params['Content-Type'] == 'multipart/form-data'
-        data = form_params.dup
-        data.each do |key, value|
-          data[key] = value.to_s if value && !value.is_a?(File)
+        data = {}
+        form_params.each do |key, value|
+          case value
+          when File, Array, nil
+            # let typhoeus handle File, Array and nil parameters
+            data[key] = value
+          else
+            data[key] = value.to_s
+          end
         end
       elsif body
         data = body.is_a?(String) ? body : body.to_json
@@ -204,7 +220,7 @@ module DocRaptor
     # Update hearder and query params based on authentication settings.
     def update_params_for_auth!(header_params, query_params, auth_names)
       Array(auth_names).each do |auth_name|
-        auth_setting = Configuration.auth_settings[auth_name]
+        auth_setting = @config.auth_settings[auth_name]
         next unless auth_setting
         case auth_setting[:in]
         when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
@@ -223,26 +239,21 @@ module DocRaptor
     # @param [Array] accepts array for Accept
     # @return [String] the Accept header (e.g. application/json)
     def select_header_accept(accepts)
-      if accepts.empty?
-        return
-      elsif accepts.any?{ |s| s.casecmp('application/json') == 0 }
-        'application/json' # look for json data by default
-      else
-        accepts.join(',')
-      end
+      return nil if accepts.nil? || accepts.empty?
+      # use JSON when present, otherwise use all of the provided
+      json_accept = accepts.find { |s| json_mime?(s) }
+      return json_accept || accepts.join(',')
     end
 
     # Return Content-Type header based on an array of content types provided.
     # @param [Array] content_types array for Content-Type
     # @return [String] the Content-Type header  (e.g. application/json)
     def select_header_content_type(content_types)
-      if content_types.empty?
-        'application/json' # use application/json by default
-      elsif content_types.any?{ |s| s.casecmp('application/json')==0 }
-        'application/json' # use application/json if it's included
-      else
-        content_types[0] # otherwise, use the first one
-      end
+      # use application/json by default
+      return 'application/json' if content_types.nil? || content_types.empty?
+      # use JSON when present, otherwise use the first one
+      json_content_type = content_types.find { |s| json_mime?(s) }
+      return json_content_type || content_types.first
     end
 
     # Convert object (array, hash, object, etc) to JSON string.
@@ -269,5 +280,25 @@ module DocRaptor
         obj
       end
     end
+
+    # Build parameter value according to the given collection format.
+    # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
+    def build_collection_param(param, collection_format)
+      case collection_format
+      when :csv
+        param.join(',')
+      when :ssv
+        param.join(' ')
+      when :tsv
+        param.join("\t")
+      when :pipes
+        param.join('|')
+      when :multi
+        # return the array directly as typhoeus will handle it as expected
+        param
+      else
+        fail "unknown collection format: #{collection_format.inspect}"
+      end
+    end
   end
 end