docraptor 0.0.1

data/lib/docraptor/api_error.rb

@@ -0,0 +1,24 @@
+module DocRaptor
+  class ApiError < StandardError
+    attr_reader :code, :response_headers, :response_body
+
+    # Usage examples:
+    #   ApiError.new
+    #   ApiError.new("message")
+    #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
+    #   ApiError.new(:code => 404, :message => "Not Found")
+    def initialize(arg = nil)
+      if arg.is_a? Hash
+        arg.each do |k, v|
+          if k.to_s == 'message'
+            super v
+          else
+            instance_variable_set "@#{k}", v
+          end
+        end
+      else
+        super arg
+      end
+    end
+  end
+end

data/lib/docraptor/configuration.rb

@@ -0,0 +1,173 @@
+require 'uri'
+require 'singleton'
+
+module DocRaptor
+  class Configuration
+
+    include Singleton
+
+    # Default api client
+    attr_accessor :api_client
+
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    ### TLS/SSL
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl
+
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    # Client certificate file (for client certificate)
+    attr_accessor :cert_file
+
+    # Client private key file (for client certificate)
+    attr_accessor :key_file
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+
+    class << self
+      def method_missing(method_name, *args, &block)
+        config = Configuration.instance
+        if config.respond_to?(method_name)
+          config.send(method_name, *args, &block)
+        else
+          super
+        end
+      end
+    end
+
+    def initialize
+      @scheme = 'http'
+      @host = 'localhost:3000'
+      @base_path = '/'
+      @api_key = {}
+      @api_key_prefix = {}
+      @verify_ssl = true
+      @cert_file = nil
+      @key_file = nil
+      @debugging = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    end
+
+    def api_client
+      @api_client ||= ApiClient.new
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = "" if @base_path == "/"
+    end
+
+    def base_url
+      url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+      URI.encode(url)
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name)
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+      else
+        @api_key[param_name]
+      end
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+    end
+
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      {
+        'basicAuth' =>
+          {
+            type: 'basic',
+            in: 'header',
+            key: 'Authorization',
+            value: basic_auth_token
+          },
+      }
+    end
+  end
+end

data/lib/docraptor/models/async_doc.rb

@@ -0,0 +1,37 @@
+module DocRaptor
+  # 
+  class AsyncDoc < BaseObject
+    attr_accessor :status_id
+    # attribute mapping from ruby-style variable name to JSON key
+    def self.attribute_map
+      {
+        
+        # The identifier used to get the status of the document using the status api.
+        :'status_id' => :'status_id'
+        
+      }
+    end
+
+    # attribute type
+    def self.swagger_types
+      {
+        :'status_id' => :'String'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return if !attributes.is_a?(Hash) || attributes.empty?
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'status_id']
+        self.status_id = attributes[:'status_id']
+      end
+      
+    end
+
+  end
+end

data/lib/docraptor/models/async_doc_status.rb

@@ -0,0 +1,77 @@
+module DocRaptor
+  # 
+  class AsyncDocStatus < BaseObject
+    attr_accessor :status, :download_url, :download_id, :message, :number_of_pages, :validation_errors
+    # attribute mapping from ruby-style variable name to JSON key
+    def self.attribute_map
+      {
+        
+        # The present status of the document. Can be queued, working, completed, and failed.
+        :'status' => :'status',
+        
+        # The URL where the document can be retrieved. This URL may only be used a few times.
+        :'download_url' => :'download_url',
+        
+        # The identifier for downloading the document with the download api.
+        :'download_id' => :'download_id',
+        
+        # Additional information.
+        :'message' => :'message',
+        
+        # Number of PDF pages in document.
+        :'number_of_pages' => :'number_of_pages',
+        
+        # Error information.
+        :'validation_errors' => :'validation_errors'
+        
+      }
+    end
+
+    # attribute type
+    def self.swagger_types
+      {
+        :'status' => :'String',
+        :'download_url' => :'String',
+        :'download_id' => :'String',
+        :'message' => :'String',
+        :'number_of_pages' => :'Integer',
+        :'validation_errors' => :'String'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return if !attributes.is_a?(Hash) || attributes.empty?
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'status']
+        self.status = attributes[:'status']
+      end
+      
+      if attributes[:'download_url']
+        self.download_url = attributes[:'download_url']
+      end
+      
+      if attributes[:'download_id']
+        self.download_id = attributes[:'download_id']
+      end
+      
+      if attributes[:'message']
+        self.message = attributes[:'message']
+      end
+      
+      if attributes[:'number_of_pages']
+        self.number_of_pages = attributes[:'number_of_pages']
+      end
+      
+      if attributes[:'validation_errors']
+        self.validation_errors = attributes[:'validation_errors']
+      end
+      
+    end
+
+  end
+end

data/lib/docraptor/models/base_object.rb

@@ -0,0 +1,86 @@
+require 'date'
+
+module DocRaptor
+  # base class containing fundamental method such as to_hash, build_from_hash and more
+  class BaseObject
+
+    # build the object from hash
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      else # model
+        _model = DocRaptor.const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        if value.is_a?(Array)
+          hash[param] = value.compact.map{ |v| _to_hash(v) }
+        else
+          hash[param] = _to_hash(value)
+        end
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/docraptor/models/doc.rb

@@ -0,0 +1,141 @@
+module DocRaptor
+  # 
+  class Doc < BaseObject
+    attr_accessor :name, :document_type, :document_content, :document_url, :test, :strict, :tag, :help, :javascript, :referrer, :callback_url, :prince_options
+    # attribute mapping from ruby-style variable name to JSON key
+    def self.attribute_map
+      {
+        
+        # A name for identifying your document.
+        :'name' => :'name',
+        
+        # The type of document being created.
+        :'document_type' => :'document_type',
+        
+        # The HTML data to be transformed into a document.\nYou must supply content using document_content or document_url.
+        :'document_content' => :'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.
+        :'document_url' => :'document_url',
+        
+        # Enable test mode for this document. Test documents are not charged for but include a watermark.
+        :'test' => :'test',
+        
+        # Force strict HTML validation.
+        :'strict' => :'strict',
+        
+        # A field for storing a small amount of metadata with this document.
+        :'tag' => :'tag',
+        
+        # Request support help with this request if it succeeds.
+        :'help' => :'help',
+        
+        # Enable DocRaptor JavaScript parsing. PrinceXML JavaScript parsing is also available elsewhere.
+        :'javascript' => :'javascript',
+        
+        # Set HTTP referrer when generating this document.
+        :'referrer' => :'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.
+        :'callback_url' => :'callback_url',
+        
+        # 
+        :'prince_options' => :'prince_options'
+        
+      }
+    end
+
+    # attribute type
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'document_type' => :'String',
+        :'document_content' => :'String',
+        :'document_url' => :'String',
+        :'test' => :'BOOLEAN',
+        :'strict' => :'String',
+        :'tag' => :'String',
+        :'help' => :'BOOLEAN',
+        :'javascript' => :'BOOLEAN',
+        :'referrer' => :'String',
+        :'callback_url' => :'String',
+        :'prince_options' => :'PrinceOptions'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return if !attributes.is_a?(Hash) || attributes.empty?
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'name']
+        self.name = attributes[:'name']
+      end
+      
+      if attributes[:'document_type']
+        self.document_type = attributes[:'document_type']
+      end
+      
+      if attributes[:'document_content']
+        self.document_content = attributes[:'document_content']
+      end
+      
+      if attributes[:'document_url']
+        self.document_url = attributes[:'document_url']
+      end
+      
+      if attributes[:'test']
+        self.test = attributes[:'test']
+      end
+      
+      if attributes[:'strict']
+        self.strict = attributes[:'strict']
+      end
+      
+      if attributes[:'tag']
+        self.tag = attributes[:'tag']
+      end
+      
+      if attributes[:'help']
+        self.help = attributes[:'help']
+      end
+      
+      if attributes[:'javascript']
+        self.javascript = attributes[:'javascript']
+      end
+      
+      if attributes[:'referrer']
+        self.referrer = attributes[:'referrer']
+      end
+      
+      if attributes[:'callback_url']
+        self.callback_url = attributes[:'callback_url']
+      end
+      
+      if attributes[:'prince_options']
+        self.prince_options = attributes[:'prince_options']
+      end
+      
+    end
+
+    def document_type=(document_type)
+      allowed_values = ["pdf", "xls", "xlsx"]
+      if document_type && !allowed_values.include?(document_type)
+        fail "invalid value for 'document_type', must be one of #{allowed_values}"
+      end
+      @document_type = document_type
+    end
+
+    def strict=(strict)
+      allowed_values = ["none"]
+      if strict && !allowed_values.include?(strict)
+        fail "invalid value for 'strict', must be one of #{allowed_values}"
+      end
+      @strict = strict
+    end
+
+  end
+end