docraptor 0.0.1

checksums.yaml

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

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'

data/docraptor.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "docraptor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "docraptor"
+  s.version     = DocRaptor::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Elijah Miller", "Matthew Gordon"]
+  s.email       = ["elijah@expectedbehavior.com", "matt@expectedbehavior.com"]
+  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.add_runtime_dependency 'typhoeus', '~> 0.2', '>= 0.2.1'
+  s.add_runtime_dependency 'json', '~> 1.4', '>= 1.4.6'
+
+  s.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
+  s.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+  s.add_development_dependency 'vcr', '~> 2.9', '>= 2.9.3'
+  s.add_development_dependency 'webmock', '~> 1.6', '>= 1.6.2'
+  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.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/lib/docraptor.rb

@@ -0,0 +1,33 @@
+# Common files
+require 'docraptor/api_client'
+require 'docraptor/api_error'
+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'
+require 'docraptor/models/async_doc_status'
+
+# APIs
+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.
+    def configure
+      if block_given?
+        yield Configuration.instance
+      else
+        Configuration.instance
+      end
+    end
+  end
+end

data/lib/docraptor/api/client_api.rb

@@ -0,0 +1,219 @@
+require "uri"
+
+module DocRaptor
+  class ClientApi
+    attr_accessor :api_client
+
+    def initialize(api_client = nil)
+      @api_client = api_client || Configuration.api_client
+    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 [AsyncDoc]
+    def async_docs_post(doc, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: ClientApi#async_docs_post ..."
+      end
+      
+      # verify the required parameter 'doc' is set
+      fail "Missing the required parameter 'doc' when calling async_docs_post" if doc.nil?
+      
+      # resource path
+      path = "/async_docs".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(doc)
+      
+
+      auth_names = ['basicAuth']
+      result = @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}"
+      end
+      return result
+    end
+
+    # 
+    # Creates a document synchronously.
+    # @param doc The document to be created.
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def docs_post(doc, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: ClientApi#docs_post ..."
+      end
+      
+      # verify the required parameter 'doc' is set
+      fail "Missing the required parameter 'doc' when calling docs_post" if doc.nil?
+      
+      # resource path
+      path = "/docs".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(doc)
+      
+
+      auth_names = ['basicAuth']
+      result = @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}"
+      end
+      return result
+    end
+
+    # 
+    # Downloads a document.
+    # @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 = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: ClientApi#download_id_get ..."
+      end
+      
+      # verify the required parameter 'id' is set
+      fail "Missing the required parameter 'id' when calling download_id_get" if id.nil?
+      
+      # resource path
+      path = "/download/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['basicAuth']
+      result = @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}"
+      end
+      return result
+    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 [AsyncDocStatus]
+    def status_id_get(id, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: ClientApi#status_id_get ..."
+      end
+      
+      # verify the required parameter 'id' is set
+      fail "Missing the required parameter 'id' when calling status_id_get" if id.nil?
+      
+      # resource path
+      path = "/status/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json', 'application/xml', 'application/pdf', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['basicAuth']
+      result = @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}"
+      end
+      return result
+    end
+  end
+end
+
+
+
+

data/lib/docraptor/api_client.rb

@@ -0,0 +1,273 @@
+require 'date'
+require 'json'
+require 'logger'
+require 'tempfile'
+require 'typhoeus'
+require 'uri'
+
+module DocRaptor
+  class ApiClient
+
+    attr_accessor :host
+
+    # 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'
+      @user_agent = "ruby-swagger-#{VERSION}"
+      @default_headers = {
+        'Content-Type' => "application/#{@format.downcase}",
+        'User-Agent' => @user_agent
+      }
+    end
+
+    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"
+      end
+
+      unless response.success?
+        fail ApiError.new(:code => response.code,
+                          :response_headers => response.headers,
+                          :response_body => response.body),
+             response.status_message
+      end
+
+      if opts[:return_type]
+        deserialize(response, opts[:return_type])
+      else
+        nil
+      end
+    end
+
+    def build_request(http_method, path, opts = {})
+      url = build_request_url(path)
+      http_method = http_method.to_sym.downcase
+
+      header_params = @default_headers.merge(opts[:header_params] || {})
+      query_params = opts[:query_params] || {}
+      form_params = opts[:form_params] || {}
+
+      
+      update_params_for_auth! header_params, query_params, opts[:auth_names]
+      
+
+      req_opts = {
+        :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
+      }
+
+      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"
+        end
+      end
+
+      Typhoeus::Request.new(url, req_opts)
+    end
+
+    # Deserialize the response to the given return type.
+    #
+    # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
+    def deserialize(response, return_type)
+      body = response.body
+      return nil if body.nil? || body.empty?
+
+      # handle file downloading - save response body into a tmp file and return the File instance
+      return download_file(response) if return_type == 'File'
+
+      # 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
+
+      begin
+        data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+      rescue JSON::ParserError => e
+        if %w(String Date DateTime).include?(return_type)
+          data = body
+        else
+          raise e
+        end
+      end
+
+      convert_to_type data, return_type
+    end
+
+    # Convert data to the given return type.
+    def convert_to_type(data, return_type)
+      return nil if data.nil?
+      case return_type
+      when 'String'
+        data.to_s
+      when 'Integer'
+        data.to_i
+      when 'Float'
+        data.to_f
+      when 'BOOLEAN'
+        data == true
+      when 'DateTime'
+        # parse date time (expecting ISO 8601 format)
+        DateTime.parse data
+      when 'Date'
+        # parse date time (expecting ISO 8601 format)
+        Date.parse data
+      when 'Object'
+        # generic object, return directly
+        data
+      when /\AArray<(.+)>\z/
+        # e.g. Array<Pet>
+        sub_type = $1
+        data.map {|item| convert_to_type(item, sub_type) }
+      when /\AHash\<String, (.+)\>\z/
+        # e.g. Hash<String, Integer>
+        sub_type = $1
+        {}.tap do |hash|
+          data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
+        end
+      else
+        # models, e.g. Pet
+        DocRaptor.const_get(return_type).new.tap do |model|
+          model.build_from_hash data
+        end
+      end
+    end
+
+    # Save response body into a file in (the defined) temporary folder, using the filename
+    # from the "Content-Disposition" header if provided, otherwise a random filename.
+    #
+    # @see Configuration#temp_folder_path
+    # @return [File] the file downloaded
+    def download_file(response)
+      tmp_file = Tempfile.new '', Configuration.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
+      else
+        path = tmp_file.path
+      end
+      # close and delete temp file
+      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"
+      File.new(path)
+    end
+
+    def build_request_url(path)
+      # Add leading and trailing slashes to path
+      path = "/#{path}".gsub(/\/+/, '/')
+      URI.encode(host + 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)
+        end
+      elsif body
+        data = body.is_a?(String) ? body : body.to_json
+      else
+        data = nil
+      end
+      data
+    end
+
+    # 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]
+        next unless auth_setting
+        case auth_setting[:in]
+        when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
+        when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
+        else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+        end
+      end
+    end
+
+    def user_agent=(user_agent)
+      @user_agent = user_agent
+      @default_headers['User-Agent'] = @user_agent
+    end
+
+    # Return Accept header based on an array of accepts provided.
+    # @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
+    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
+    end
+
+    # Convert object (array, hash, object, etc) to JSON string.
+    # @param [Object] model object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_http_body(model)
+      return if model.nil?
+      _body = nil
+      if model.is_a?(Array)
+        _body = model.map{|m| object_to_hash(m) }
+      else
+        _body = object_to_hash(model)
+      end
+      _body.to_json
+    end
+
+    # Convert object(non-array) to hash.
+    # @param [Object] obj object to be converted into JSON string
+    # @return [String] JSON string representation of the object
+    def object_to_hash(obj)
+      if obj.respond_to?(:to_hash)
+        obj.to_hash
+      else
+        obj
+      end
+    end
+  end
+end