groupdocs 2.2.0 → 2.3.0

data/lib/groupdocs/document/change.rb

@@ -1,56 +1,56 @@
-module GroupDocs
-  class Document::Change < Api::Entity
-
-    # @attr [Integer] id
-    attr_accessor :id
-    # @attr [Symbol] type
-    attr_accessor :type
-    # @attr [GroupDocs::Document::Rectangle] box
-    attr_accessor :box
-    # @attr [String] text
-    attr_accessor :text
-    # @attr [GroupDocs::Document::Page] page
-    attr_accessor :page
-
-
-    #Added in release 2.1.0
-    # @attr [String] type
-    attr_accessor :type
-    # @attr [String] typeStr
-    attr_accessor :typeStr
-    # @attr [String] action
-    attr_accessor :action
-    # @attr [String] actionStr
-    attr_accessor :actionStr
-
-    #
-    # Returns type as symbol.
-    #
-    # @return [Symbol]
-    #
-    def type
-      @type.to_sym
-    end
-
-    #
-    # Coverts passed hash to GroupDocs::Document::Rectangle object.
-    #
-    # @param [Hash] options
-    # @return [GroupDocs::Document::Rectangle]
-    #
-    def box=(options)
-      @box = GroupDocs::Document::Rectangle.new(options)
-    end
-
-    #
-    # Coverts passed hash to GroupDocs::Document::Page object.
-    #
-    # @param [Hash] options
-    # @return [GroupDocs::Document::Page]
-    #
-    def page=(options)
-      @page = GroupDocs::Document::Page.new(options)
-    end
-
-  end # Document::Change
-end # GroupDocs
+module GroupDocs
+  class Document::Change < Api::Entity
+
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [Symbol] type
+    attr_accessor :type
+    # @attr [GroupDocs::Document::Rectangle] box
+    attr_accessor :box
+    # @attr [String] text
+    attr_accessor :text
+    # @attr [GroupDocs::Document::Page] page
+    attr_accessor :page
+
+
+    #Added in release 2.1.0
+    # @attr [String] type
+    attr_accessor :type
+    # @attr [String] typeStr
+    attr_accessor :typeStr
+    # @attr [String] action
+    attr_accessor :action
+    # @attr [String] actionStr
+    attr_accessor :actionStr
+
+    #
+    # Returns type as symbol.
+    #
+    # @return [Symbol]
+    #
+    def type
+      @type.to_sym
+    end
+
+    #
+    # Coverts passed hash to GroupDocs::Document::Rectangle object.
+    #
+    # @param [Hash] options
+    # @return [GroupDocs::Document::Rectangle]
+    #
+    def box=(options)
+      @box = GroupDocs::Document::Rectangle.new(options)
+    end
+
+    #
+    # Coverts passed hash to GroupDocs::Document::Page object.
+    #
+    # @param [Hash] options
+    # @return [GroupDocs::Document::Page]
+    #
+    def page=(options)
+      @page = GroupDocs::Document::Page.new(options)
+    end
+
+  end # Document::Change
+end # GroupDocs

data/lib/groupdocs/document/field.rb

@@ -1,53 +1,53 @@
-module GroupDocs
-  class Document::Field < Api::Entity
-
-    # @attr [Integer] page
-    attr_accessor :page
-    # @attr [String] name
-    attr_accessor :name
-    # @attr [String] type
-    attr_accessor :type
-    # @attr [GroupDocs::Document::Rectangle] rect
-    attr_accessor :rect
-    # @attr [Int] maxlength
-    attr_accessor :maxlength
-    # @attr [Boolean] mandatory
-    attr_accessor :mandatory
-    # @attr [String] fieldtype
-    attr_accessor :fieldtype
-    # @attr [Array] acceptableValues
-    attr_accessor :acceptableValues
-
-    # added in release 1.7.0
-
-    # @attr [Int] selectionPosition
-    attr_accessor :selectionPosition
-    # @attr [Int] selectionLength
-    attr_accessor :selectionLength
-    # @attr [Boolean] isTableStartMarker
-    attr_accessor :isTableStartMarker
-    # @attr [Boolean] isTableEndMarker
-    attr_accessor :isTableEndMarker
-    # @attr [String] regionName
-    attr_accessor :regionName
-
-
-
-
-    #
-    # Coverts passed hash to GroupDocs::Document::Rectangle object.
-    # @param [Hash] options
-    #
-    def rect=(rectangle)
-      if rectangle.is_a?(Hash)
-        rectangle = GroupDocs::Document::Rectangle.new(rectangle)
-      end
-
-      @rect = rectangle
-    end
-
-    # Human-readable accessors
-    alias_accessor :rectangle, :rect
-
-  end # Document::Field
-end # GroupDocs
+module GroupDocs
+  class Document::Field < Api::Entity
+
+    # @attr [Integer] page
+    attr_accessor :page
+    # @attr [String] name
+    attr_accessor :name
+    # @attr [String] type
+    attr_accessor :type
+    # @attr [GroupDocs::Document::Rectangle] rect
+    attr_accessor :rect
+    # @attr [Int] maxlength
+    attr_accessor :maxlength
+    # @attr [Boolean] mandatory
+    attr_accessor :mandatory
+    # @attr [String] fieldtype
+    attr_accessor :fieldtype
+    # @attr [Array] acceptableValues
+    attr_accessor :acceptableValues
+
+    # added in release 1.7.0
+
+    # @attr [Int] selectionPosition
+    attr_accessor :selectionPosition
+    # @attr [Int] selectionLength
+    attr_accessor :selectionLength
+    # @attr [Boolean] isTableStartMarker
+    attr_accessor :isTableStartMarker
+    # @attr [Boolean] isTableEndMarker
+    attr_accessor :isTableEndMarker
+    # @attr [String] regionName
+    attr_accessor :regionName
+
+
+
+
+    #
+    # Coverts passed hash to GroupDocs::Document::Rectangle object.
+    # @param [Hash] options
+    #
+    def rect=(rectangle)
+      if rectangle.is_a?(Hash)
+        rectangle = GroupDocs::Document::Rectangle.new(rectangle)
+      end
+
+      @rect = rectangle
+    end
+
+    # Human-readable accessors
+    alias_accessor :rectangle, :rect
+
+  end # Document::Field
+end # GroupDocs

data/lib/groupdocs/document/metadata.rb

@@ -1,32 +1,32 @@
-module GroupDocs
-  class Document::MetaData < Api::Entity
-
-    # @attr [Integer] id
-    attr_accessor :id
-    # @attr [String] guid
-    attr_accessor :guid
-    # @attr [Integer] page_count
-    attr_accessor :page_count
-    # @attr [Integer] views_count
-    attr_accessor :views_count
-    # @attr [Hash] last_view
-    attr_accessor :last_view
-
-    # added in release 2.0.0
-    # @attr [String] type
-    attr_accessor :type
-    # @attr [String] url
-    attr_accessor :url
-
-    #
-    # Coverts passed hash to GroupDocs::Document::View object.
-    #
-    # @param [Hash] options
-    # @return [GroupDocs::Document::View]
-    #
-    def last_view=(options)
-      @last_view = GroupDocs::Document::View.new(options)
-    end
-
-  end # Document::Metadata
-end # GroupDocs
+module GroupDocs
+  class Document::MetaData < Api::Entity
+
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [String] guid
+    attr_accessor :guid
+    # @attr [Integer] page_count
+    attr_accessor :page_count
+    # @attr [Integer] views_count
+    attr_accessor :views_count
+    # @attr [Hash] last_view
+    attr_accessor :last_view
+
+    # added in release 2.0.0
+    # @attr [String] type
+    attr_accessor :type
+    # @attr [String] url
+    attr_accessor :url
+
+    #
+    # Coverts passed hash to GroupDocs::Document::View object.
+    #
+    # @param [Hash] options
+    # @return [GroupDocs::Document::View]
+    #
+    def last_view=(options)
+      @last_view = GroupDocs::Document::View.new(options)
+    end
+
+  end # Document::Metadata
+end # GroupDocs

data/lib/groupdocs/document/rectangle.rb

@@ -1,18 +1,18 @@
-module GroupDocs
-  class Document::Rectangle < Api::Entity
-
-    # @attr [Float] x
-    attr_accessor :x
-    # @attr [Float] y
-    attr_accessor :y
-    # @attr [Float] width
-    attr_accessor :width
-    # @attr [Float] height
-    attr_accessor :height
-
-    # Human-readable accessors
-    alias_accessor :w, :width
-    alias_accessor :h, :height
-
-  end # Document::Rectangle
-end # GroupDocs
+module GroupDocs
+  class Document::Rectangle < Api::Entity
+
+    # @attr [Float] x
+    attr_accessor :x
+    # @attr [Float] y
+    attr_accessor :y
+    # @attr [Float] width
+    attr_accessor :width
+    # @attr [Float] height
+    attr_accessor :height
+
+    # Human-readable accessors
+    alias_accessor :w, :width
+    alias_accessor :h, :height
+
+  end # Document::Rectangle
+end # GroupDocs

data/lib/groupdocs/document/view.rb

@@ -1,36 +1,36 @@
-module GroupDocs
-  class Document::View < Api::Entity
-
-    # @attr [GroupDocs::Document] document
-    attr_accessor :document
-    # @attr [String] short_url
-    attr_accessor :short_url
-    # @attr [Time] viewed_on
-    attr_accessor :viewed_on
-
-    #
-    # Converts timestamp which is return by API server to Time object.
-    #
-    # @return [Time]
-    #
-    def viewed_on
-      Time.at(@viewed_on / 1000)
-    end
-
-    #
-    # Converts passed hash to GroupDocs::Document object.
-    #
-    # @param [GroupDocs::Document, Hash] object
-    # @return [GroupDocs::Document]
-    #
-    def document=(object)
-      if object.is_a?(GroupDocs::Document)
-        @document = object
-      else
-        object.merge!(:file => GroupDocs::Storage::File.new(object))
-        @document = GroupDocs::Document.new(object)
-      end
-    end
-
-  end # Document::View
-end # GroupDocs
+module GroupDocs
+  class Document::View < Api::Entity
+
+    # @attr [GroupDocs::Document] document
+    attr_accessor :document
+    # @attr [String] short_url
+    attr_accessor :short_url
+    # @attr [Time] viewed_on
+    attr_accessor :viewed_on
+
+    #
+    # Converts timestamp which is return by API server to Time object.
+    #
+    # @return [Time]
+    #
+    def viewed_on
+      Time.at(@viewed_on / 1000)
+    end
+
+    #
+    # Converts passed hash to GroupDocs::Document object.
+    #
+    # @param [GroupDocs::Document, Hash] object
+    # @return [GroupDocs::Document]
+    #
+    def document=(object)
+      if object.is_a?(GroupDocs::Document)
+        @document = object
+      else
+        object.merge!(:file => GroupDocs::Storage::File.new(object))
+        @document = GroupDocs::Document.new(object)
+      end
+    end
+
+  end # Document::View
+end # GroupDocs

data/lib/groupdocs/errors.rb

@@ -1,8 +1,8 @@
-module GroupDocs
-
-  class NoClientIdError        < StandardError ; end
-  class NoPrivateKeyError      < StandardError ; end
-  class UnsupportedMethodError < StandardError ; end
-  class BadResponseError       < StandardError ; end
-
-end # GroupDocs
+module GroupDocs
+
+  class NoClientIdError        < StandardError ; end
+  class NoPrivateKeyError      < StandardError ; end
+  class UnsupportedMethodError < StandardError ; end
+  class BadResponseError       < StandardError ; end
+
+end # GroupDocs

data/lib/groupdocs/job.rb

@@ -1,468 +1,468 @@
-module GroupDocs
-  class Job < Api::Entity
-
-    ACTIONS = {
-      :none               =>   0,
-      :convert            =>   1,
-      :combine            =>   2,
-      :compress_zip       =>   4,
-      :compress_rar       =>   8,
-      :trace              =>  16,
-      :convert_body       =>  32,
-      :bind_data          =>  64,
-      :print              => 128,
-      :compare            => 256,
-      :import_annotations => 512,
-      # add in release 1.5.8
-      :split => 1024,
-      :view => 2048,
-      :index => 4096,
-      :number_lines => 8192
-    }
-
-    extend Api::Helpers::ByteFlag
-    include Api::Helpers::Status
-
-    #
-    # Returns array of jobs.
-    #
-    # @param [Hash] options Hash of options
-    # @option options [String] :page Page Index
-    # @option options [String] :date Data
-    # @option options [String] :count How many items to list
-    # @option options [String] :statusIds Comma separated status identifiers
-    # @option options [String] :actions Actions
-    # @option options [String] :excluded_actions Excluded actions
-    # @option options [String] :jobName Foltred job name
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array<GroupDocs::Job>]
-    #
-    def self.all!(options = {}, access = {})
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = '/async/{{client_id}}/jobs'
-      end
-      api.add_params(options)
-      json = api.execute!
-
-      json[:jobs].map do |job|
-        Job.new(job)
-      end
-    end
-
-    #
-    # Returns job by its identifier.
-    #
-    # @param [Integer] id
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [GroupDocs::Job]
-    #
-    def self.get!(id, access = {})
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/async/{{client_id}}/jobs/#{id}"
-      end
-      api.add_params(:format => 'json')
-      json = api.execute!
-
-      Job.new(json)
-    end
-
-    #
-    # Returns job by its identifier.
-    #
-    # @param [Integer] id
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [GroupDocs::Job]
-    #
-    def self.get_xml!(id, access = {})
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/async/{{client_id}}/jobs/#{id}"
-      end
-      api.add_params(:format => 'xml')
-      json = api.execute!
-
-      Job.new(json)
-    end
-
-
-    #
-    # Returns job by its identifier.
-    #
-    # @param [Hash] options
-    # @option statusIds [String] :statusIds (required)
-    # @option actions [Integer] :actions
-    # @option excluded_actions [String] :excluded_actions
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [GroupDocs::Job]
-    #
-    def self.get_resources!(options = {} , access = {})
-      options[:actions] = convert_actions_to_byte(options[:actions])
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/async/{{client_id}}/jobs/resources"
-      end
-      api.add_params(options)
-      json = api.execute!
-
-      json[:dates]
-    end
-
-    #
-    # Creates new draft job.
-    #
-    # @param [Hash] options
-    # @option options [Integer] :actions Array of actions to be performed. Required
-    # @option options [Boolean] :email_results
-    # @option options [Array] :out_formats
-    # @option options [Boolean] :url_only
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [GroupDocs::Job]
-    #
-    def self.create!(options, access = {})
-      options[:actions] or raise ArgumentError, 'options[:actions] is required.'
-      options[:actions] = convert_actions_to_byte(options[:actions])
-      #options[:out_formats] = options[:out_formats].join(?;) if options[:out_formats]
-
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :POST
-        request[:path] = '/async/{{client_id}}/jobs'
-        request[:request_body] = options
-      end
-      json = api.execute!
-
-      Job.new(:id => json[:job_id], :guid => json[:job_guid])
-    end
-
-    # @attr [Integer] id
-    attr_accessor :id
-    # @attr [String] guid
-    attr_accessor :guid
-    # @attr [String] name
-    attr_accessor :name
-    # @attr [Integer] priority
-    attr_accessor :priority
-    # @attr [Array<Symbol>] actions
-    attr_accessor :actions
-    # @attr [Boolean] email_results
-    attr_accessor :email_results
-    # @attr [Boolean] url_only
-    attr_accessor :url_only
-    # @attr [Array<GroupDocs::Document] documents
-    attr_accessor :documents
-    # @attr [Time] requested_time
-    attr_accessor :requested_time
-    # @attr [Symbol] status
-    attr_accessor :status
-
-    #
-    # Coverts passed array of attributes hash to array of GroupDocs::Document.
-    #
-    # @param [Array<Hash>] documents Array of document attributes hashes
-    #
-    def documents=(documents)
-      if documents
-        @documents = documents[:inputs].map do |document|
-          document.merge!(:file => GroupDocs::Storage::File.new(document))
-          Document.new(document)
-        end
-      end
-    end
-
-    #
-    # Converts status to human-readable format.
-    #
-    # @return [Symbol]
-    #
-    def status
-      parse_status(@status)
-    end
-
-    #
-    # Converts timestamp which is return by API server to Time object.
-    #
-    # @return [Time]
-    #
-    def requested_time
-      Time.at(@requested_time / 1000)
-    end
-
-    #
-    # Returns job actions in human-readable format.
-    #
-    # @return [Array<Symbol>]
-    #
-    def actions
-      @actions.split(', ').map { |action| action.underscore.to_sym } if @actions
-    end
-
-    #
-    # Returns an hash of input and output documents associated to job.
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Hash]
-    #
-    def documents!(access = {})
-      json = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/async/{{client_id}}/jobs/#{id}/documents"
-      end.execute!
-
-      self.status = json[:job_status]
-      documents = {
-        :inputs =>  [],
-        :outputs => [],
-      }
-
-      # add input documents
-      if json[:inputs]
-        json[:inputs].each do |document|
-          document.merge!(:file => GroupDocs::Storage::File.new(document))
-          documents[:inputs] << Document.new(document)
-        end
-      end
-
-      # add output documents
-      if json[:outputs]
-        json[:outputs].each do |document|
-          document.merge!(:file => GroupDocs::Storage::File.new(document))
-          documents[:outputs] << Document.new(document)
-        end
-      end
-
-      documents
-    end
-
-    #
-    # Returns job actions in human-readable format.
-    #
-    # @return [Array<Symbol>]
-    #
-    def actions
-      @actions.split(', ').map { |action| action.underscore.to_sym } if @actions
-    end
-
-    #
-    # Returns an array of input and output documents associated to jobs.
-    #
-    # @param [Hash] options
-    # @option page [String] Page Index
-    # @option count [String] Page Size
-    # @option actions [String] Actions
-    # @option excluded_actions [String] Excluded actions
-    # @option order_by [String] Order by
-    # @option order_asc [String] Order ask
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Hash]
-    #
-    def self.jobs_documents!(options = {}, access = {})
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/async/{{client_id}}/jobs/documents"
-      end
-      api.add_params(options)
-      api.execute!
-
-    end
-
-    #
-    # Adds document to job.
-    #
-    # @param [GroupDocs::Document] document
-    # @param [Hash] options
-    # @option options [Array] :output_formats Array of output formats to override
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Integer] Document ID
-    #
-    # @raise [ArgumentError] If document is not a GroupDocs::Document object
-    #
-    def add_document!(document, options = {}, access = {})
-      document.is_a?(GroupDocs::Document) or raise ArgumentError,
-        "Document should be GroupDocs::Document object. Received: #{document.inspect}"
-
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/async/{{client_id}}/jobs/#{id}/files/#{document.file.guid}"
-      end
-      api.add_params(options)
-      json = api.execute!
-
-      json[:document_id]
-    end
-
-    #
-    # Deletes document with guid from job.
-    #
-    # @param [String] guid
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def delete_document!(guid, access = {})
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :DELETE
-        request[:path] = "/async/{{client_id}}/jobs/#{id}/documents/#{guid}"
-      end.execute!
-    end
-
-    #
-    # Adds datasource to job document.
-    #
-    # @param [GroupDocs::Document] document
-    # @param [GroupDocs::DataSource] datasource
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    # @raise [ArgumentError] If document is not a GroupDocs::Document object
-    # @raise [ArgumentError] If datasource is not a GroupDocs::DataSource object
-    #
-    def add_datasource!(document, datasource, access = {})
-      document.is_a?(GroupDocs::Document) or raise ArgumentError,
-        "Document should be GroupDocs::Document object. Received: #{document.inspect}"
-      datasource.is_a?(GroupDocs::DataSource) or raise ArgumentError,
-        "Datasource should be GroupDocs::DataSource object. Received: #{datasource.inspect}"
-
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/async/{{client_id}}/jobs/#{id}/files/#{document.file.id}/datasources/#{datasource.id}"
-      end.execute!
-    end
-
-    #
-    # Adds URL of web page or document to be converted.
-    #
-    # @param [String] url Absolute URL
-    # @param [Hash] options
-    # @option options [Array] :output_formats Array of output formats to override
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Integer] Document ID
-    #
-    def add_url!(url, options = {}, access = {})
-      options.merge!(:absolute_url => url)
-
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/async/{{client_id}}/jobs/#{id}/urls"
-      end
-      api.add_params(options)
-      json = api.execute!
-
-      json[:document_id]
-    end
-
-    #
-    # Updates job settings and/or status.
-    #
-    # @param [Hash] options
-    # @option options [Boolean] :email_results
-    # @option options [Symbol] :status
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def update!(options, access = {})
-      options[:status] = parse_status(options[:status]) if options[:status]
-
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/async/{{client_id}}/jobs/#{id}"
-        request[:request_body] = options
-      end.execute!
-    end
-
-    #
-    # Deletes draft job.
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def delete!(access = {})
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :DELETE
-        request[:path] = "/async/{{client_id}}/jobs/#{id}"
-      end.execute!
-    end
-
-    private
-
-    #
-    # Converts actions array to byte flag.
-    #
-    # @param [Array<String, Symbol>] actions
-    # @return [Integer]
-    # @raise [ArgumentError] if actions is not an array
-    # @raise [ArgumentError] if action is unknown
-    # @api private
-    #
-    def self.convert_actions_to_byte(actions)
-      actions.is_a?(Array) or raise ArgumentError, "Actions should be an array, received: #{actions.inspect}"
-      actions = actions.map(&:to_sym)
-
-      possible_actions = ACTIONS.map { |hash| hash.first }
-      actions.each do |action|
-        possible_actions.include?(action) or raise ArgumentError, "Unknown action: #{action.inspect}"
-      end
-
-      byte_from_array(actions, ACTIONS)
-    end
-
-    #added in release 1.7.0
-
-    #
-    # Get Possible Conversions.
-    #
-    # @example
-    #   GroupDocs::Job.get_conversions! "pdf"
-    #
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @param [String] file_ext File extension to check
-    #
-    def self.get_conversions!(access = {}, file_ext)
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/async/{{client_id}}/possibleConversions/#{file_ext}"
-      end
-      json = api.execute!
-      json[:possibleConversions]
-    end
-
-  end # Job
-end # GroupDocs
+module GroupDocs
+  class Job < Api::Entity
+
+    ACTIONS = {
+      :none               =>   0,
+      :convert            =>   1,
+      :combine            =>   2,
+      :compress_zip       =>   4,
+      :compress_rar       =>   8,
+      :trace              =>  16,
+      :convert_body       =>  32,
+      :bind_data          =>  64,
+      :print              => 128,
+      :compare            => 256,
+      :import_annotations => 512,
+      # add in release 1.5.8
+      :split => 1024,
+      :view => 2048,
+      :index => 4096,
+      :number_lines => 8192
+    }
+
+    extend Api::Helpers::ByteFlag
+    include Api::Helpers::Status
+
+    #
+    # Returns array of jobs.
+    #
+    # @param [Hash] options Hash of options
+    # @option options [String] :page Page Index
+    # @option options [String] :date Data
+    # @option options [String] :count How many items to list
+    # @option options [String] :statusIds Comma separated status identifiers
+    # @option options [String] :actions Actions
+    # @option options [String] :excluded_actions Excluded actions
+    # @option options [String] :jobName Foltred job name
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Job>]
+    #
+    def self.all!(options = {}, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/async/{{client_id}}/jobs'
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:jobs].map do |job|
+        Job.new(job)
+      end
+    end
+
+    #
+    # Returns job by its identifier.
+    #
+    # @param [Integer] id
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Job]
+    #
+    def self.get!(id, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/async/{{client_id}}/jobs/#{id}"
+      end
+      api.add_params(:format => 'json')
+      json = api.execute!
+
+      Job.new(json)
+    end
+
+    #
+    # Returns job by its identifier.
+    #
+    # @param [Integer] id
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Job]
+    #
+    def self.get_xml!(id, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/async/{{client_id}}/jobs/#{id}"
+      end
+      api.add_params(:format => 'xml')
+      json = api.execute!
+
+      Job.new(json)
+    end
+
+
+    #
+    # Returns job by its identifier.
+    #
+    # @param [Hash] options
+    # @option statusIds [String] :statusIds (required)
+    # @option actions [Integer] :actions
+    # @option excluded_actions [String] :excluded_actions
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Job]
+    #
+    def self.get_resources!(options = {} , access = {})
+      options[:actions] = convert_actions_to_byte(options[:actions])
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/async/{{client_id}}/jobs/resources"
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:dates]
+    end
+
+    #
+    # Creates new draft job.
+    #
+    # @param [Hash] options
+    # @option options [Integer] :actions Array of actions to be performed. Required
+    # @option options [Boolean] :email_results
+    # @option options [Array] :out_formats
+    # @option options [Boolean] :url_only
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Job]
+    #
+    def self.create!(options, access = {})
+      options[:actions] or raise ArgumentError, 'options[:actions] is required.'
+      options[:actions] = convert_actions_to_byte(options[:actions])
+      #options[:out_formats] = options[:out_formats].join(?;) if options[:out_formats]
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = '/async/{{client_id}}/jobs'
+        request[:request_body] = options
+      end
+      json = api.execute!
+
+      Job.new(:id => json[:job_id], :guid => json[:job_guid])
+    end
+
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [String] guid
+    attr_accessor :guid
+    # @attr [String] name
+    attr_accessor :name
+    # @attr [Integer] priority
+    attr_accessor :priority
+    # @attr [Array<Symbol>] actions
+    attr_accessor :actions
+    # @attr [Boolean] email_results
+    attr_accessor :email_results
+    # @attr [Boolean] url_only
+    attr_accessor :url_only
+    # @attr [Array<GroupDocs::Document] documents
+    attr_accessor :documents
+    # @attr [Time] requested_time
+    attr_accessor :requested_time
+    # @attr [Symbol] status
+    attr_accessor :status
+
+    #
+    # Coverts passed array of attributes hash to array of GroupDocs::Document.
+    #
+    # @param [Array<Hash>] documents Array of document attributes hashes
+    #
+    def documents=(documents)
+      if documents
+        @documents = documents[:inputs].map do |document|
+          document.merge!(:file => GroupDocs::Storage::File.new(document))
+          Document.new(document)
+        end
+      end
+    end
+
+    #
+    # Converts status to human-readable format.
+    #
+    # @return [Symbol]
+    #
+    def status
+      parse_status(@status)
+    end
+
+    #
+    # Converts timestamp which is return by API server to Time object.
+    #
+    # @return [Time]
+    #
+    def requested_time
+      Time.at(@requested_time / 1000)
+    end
+
+    #
+    # Returns job actions in human-readable format.
+    #
+    # @return [Array<Symbol>]
+    #
+    def actions
+      @actions.split(', ').map { |action| action.underscore.to_sym } if @actions
+    end
+
+    #
+    # Returns an hash of input and output documents associated to job.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Hash]
+    #
+    def documents!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/async/{{client_id}}/jobs/#{id}/documents"
+      end.execute!
+
+      self.status = json[:job_status]
+      documents = {
+        :inputs =>  [],
+        :outputs => [],
+      }
+
+      # add input documents
+      if json[:inputs]
+        json[:inputs].each do |document|
+          document.merge!(:file => GroupDocs::Storage::File.new(document))
+          documents[:inputs] << Document.new(document)
+        end
+      end
+
+      # add output documents
+      if json[:outputs]
+        json[:outputs].each do |document|
+          document.merge!(:file => GroupDocs::Storage::File.new(document))
+          documents[:outputs] << Document.new(document)
+        end
+      end
+
+      documents
+    end
+
+    #
+    # Returns job actions in human-readable format.
+    #
+    # @return [Array<Symbol>]
+    #
+    def actions
+      @actions.split(', ').map { |action| action.underscore.to_sym } if @actions
+    end
+
+    #
+    # Returns an array of input and output documents associated to jobs.
+    #
+    # @param [Hash] options
+    # @option page [String] Page Index
+    # @option count [String] Page Size
+    # @option actions [String] Actions
+    # @option excluded_actions [String] Excluded actions
+    # @option order_by [String] Order by
+    # @option order_asc [String] Order ask
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Hash]
+    #
+    def self.jobs_documents!(options = {}, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/async/{{client_id}}/jobs/documents"
+      end
+      api.add_params(options)
+      api.execute!
+
+    end
+
+    #
+    # Adds document to job.
+    #
+    # @param [GroupDocs::Document] document
+    # @param [Hash] options
+    # @option options [Array] :output_formats Array of output formats to override
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Integer] Document ID
+    #
+    # @raise [ArgumentError] If document is not a GroupDocs::Document object
+    #
+    def add_document!(document, options = {}, access = {})
+      document.is_a?(GroupDocs::Document) or raise ArgumentError,
+        "Document should be GroupDocs::Document object. Received: #{document.inspect}"
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/async/{{client_id}}/jobs/#{id}/files/#{document.file.guid}"
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:document_id]
+    end
+
+    #
+    # Deletes document with guid from job.
+    #
+    # @param [String] guid
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def delete_document!(guid, access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/async/{{client_id}}/jobs/#{id}/documents/#{guid}"
+      end.execute!
+    end
+
+    #
+    # Adds datasource to job document.
+    #
+    # @param [GroupDocs::Document] document
+    # @param [GroupDocs::DataSource] datasource
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    # @raise [ArgumentError] If document is not a GroupDocs::Document object
+    # @raise [ArgumentError] If datasource is not a GroupDocs::DataSource object
+    #
+    def add_datasource!(document, datasource, access = {})
+      document.is_a?(GroupDocs::Document) or raise ArgumentError,
+        "Document should be GroupDocs::Document object. Received: #{document.inspect}"
+      datasource.is_a?(GroupDocs::DataSource) or raise ArgumentError,
+        "Datasource should be GroupDocs::DataSource object. Received: #{datasource.inspect}"
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/async/{{client_id}}/jobs/#{id}/files/#{document.file.id}/datasources/#{datasource.id}"
+      end.execute!
+    end
+
+    #
+    # Adds URL of web page or document to be converted.
+    #
+    # @param [String] url Absolute URL
+    # @param [Hash] options
+    # @option options [Array] :output_formats Array of output formats to override
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Integer] Document ID
+    #
+    def add_url!(url, options = {}, access = {})
+      options.merge!(:absolute_url => url)
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/async/{{client_id}}/jobs/#{id}/urls"
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:document_id]
+    end
+
+    #
+    # Updates job settings and/or status.
+    #
+    # @param [Hash] options
+    # @option options [Boolean] :email_results
+    # @option options [Symbol] :status
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def update!(options, access = {})
+      options[:status] = parse_status(options[:status]) if options[:status]
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/async/{{client_id}}/jobs/#{id}"
+        request[:request_body] = options
+      end.execute!
+    end
+
+    #
+    # Deletes draft job.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def delete!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/async/{{client_id}}/jobs/#{id}"
+      end.execute!
+    end
+
+    private
+
+    #
+    # Converts actions array to byte flag.
+    #
+    # @param [Array<String, Symbol>] actions
+    # @return [Integer]
+    # @raise [ArgumentError] if actions is not an array
+    # @raise [ArgumentError] if action is unknown
+    # @api private
+    #
+    def self.convert_actions_to_byte(actions)
+      actions.is_a?(Array) or raise ArgumentError, "Actions should be an array, received: #{actions.inspect}"
+      actions = actions.map(&:to_sym)
+
+      possible_actions = ACTIONS.map { |hash| hash.first }
+      actions.each do |action|
+        possible_actions.include?(action) or raise ArgumentError, "Unknown action: #{action.inspect}"
+      end
+
+      byte_from_array(actions, ACTIONS)
+    end
+
+    #added in release 1.7.0
+
+    #
+    # Get Possible Conversions.
+    #
+    # @example
+    #   GroupDocs::Job.get_conversions! "pdf"
+    #
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @param [String] file_ext File extension to check
+    #
+    def self.get_conversions!(access = {}, file_ext)
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/async/{{client_id}}/possibleConversions/#{file_ext}"
+      end
+      json = api.execute!
+      json[:possibleConversions]
+    end
+
+  end # Job
+end # GroupDocs