groupdocs 0.1.0

data/lib/groupdocs/document/rectangle.rb

@@ -0,0 +1,24 @@
+module GroupDocs
+  class Document::Rectangle < GroupDocs::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_method :x,  :X
+    alias_method :x=, :X=
+    alias_method :y,  :Y
+    alias_method :y=, :Y=
+    alias_method :w,  :Width
+    alias_method :w=, :Width=
+    alias_method :h,  :Height
+    alias_method :h=, :Height=
+
+  end # Document::Rectangle
+end # GroupDocs

data/lib/groupdocs/document/view.rb

@@ -0,0 +1,36 @@
+module GroupDocs
+  class Document::View < GroupDocs::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)
+    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

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

data/lib/groupdocs/job.rb

@@ -0,0 +1,201 @@
+module GroupDocs
+  class Job < GroupDocs::Api::Entity
+
+    extend GroupDocs::Api::Helpers::Actions
+    include GroupDocs::Api::Helpers::Status
+
+    #
+    # Returns array of recent jobs.
+    #
+    # @param [Hash] options Hash of options
+    # @option options [Integer] :page Page to start with
+    # @option options [Integer] :count How many items to list
+    # @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 = GroupDocs::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|
+        GroupDocs::Job.new(job)
+      end
+    end
+
+    #
+    # Creates new draft job.
+    #
+    # @param [Hash] options
+    # @option options [Integer] :actions Array of actions to be performed. Required
+    # @option options [Boolean] :emails_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(options[:actions])
+      options[:out_formats] = options[:out_formats].join(?;) if options[:out_formats]
+
+      api = GroupDocs::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!
+
+      GroupDocs::Job.new(id: json[:job_id])
+    end
+
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [Array<GroupDocs::Document] documents
+    attr_accessor :documents
+
+    #
+    # Coverts passed array of attributes hash to array of GroupDocs::Document.
+    #
+    # @param [Array<Hash>] documents Array of document attributes hashes
+    #
+    def documents=(documents)
+      @documents = documents.map do |document|
+        document.merge!(file: GroupDocs::Storage::File.new(document))
+        GroupDocs::Document.new(document)
+      end
+    end
+
+    #
+    # Returns an array of documents associated to job.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Document>]
+    #
+    def documents!(access = {})
+      json = GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/async/{{client_id}}/jobs/#{id}/documents"
+      end.execute!
+
+      json[:documents].map do |document|
+        document.merge!(file: GroupDocs::Storage::File.new(document))
+        GroupDocs::Document.new(document)
+      end
+    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 = GroupDocs::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
+
+    #
+    # 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
+    #
+    # @todo returns 404 (http://scotland.groupdocs.com/jira/browse/CORE-384)
+    #
+    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}"
+
+      GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/async/{{client_id}}/jobs/#{id}/files/#{document.file.guid}/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 = GroupDocs::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]
+
+      GroupDocs::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
+
+  end # Job
+end # GroupDocs

data/lib/groupdocs/questionnaire.rb

@@ -0,0 +1,221 @@
+module GroupDocs
+  class Questionnaire < GroupDocs::Api::Entity
+
+    require 'groupdocs/questionnaire/execution'
+    require 'groupdocs/questionnaire/page'
+    require 'groupdocs/questionnaire/question'
+
+    include GroupDocs::Api::Helpers::Access
+
+    #
+    # Returns an array of all questionnaires.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Questionnaire>]
+    #
+    def self.all!(access = {})
+      json = GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/merge/{{client_id}}/questionnaires'
+      end.execute!
+
+      json[:questionnaires].map do |questionnaire|
+        GroupDocs::Questionnaire.new(questionnaire)
+      end
+    end
+
+    #
+    # Returns questionnaire by identifier.
+    #
+    # @param [Integer] id
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Questionnaire, nil]
+    #
+    def self.get!(id, access = {})
+      json = GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/#{id}"
+      end.execute!
+
+      GroupDocs::Questionnaire.new(json[:questionnaire])
+    rescue RestClient::BadRequest
+      nil
+    end
+
+    #
+    # Returns an array of all executions.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Questionnaire::Execution>]
+    #
+    def self.executions!(access = {})
+      json = GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/merge/{{client_id}}/questionnaires/executions'
+      end.execute!
+
+      json[:executions].map do |execution|
+        GroupDocs::Questionnaire::Execution.new(execution)
+      end
+    end
+
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [String] name
+    attr_accessor :name
+    # @attr [String] descr
+    attr_accessor :descr
+    # @attr [Array<GroupDocs::Questionnaire::Page>] pages
+    attr_accessor :pages
+
+    # Human-readable accessors
+    alias_method :description,  :descr
+    alias_method :description=, :descr=
+
+    #
+    # Converts each page to GroupDocs::Questionnaire::Page object.
+    #
+    # @param [Array<GroupDocs::Questionnaire::Page, Hash>] pages
+    #
+    def pages=(pages)
+      if pages
+        @pages = pages.map do |page|
+          if page.is_a?(GroupDocs::Questionnaire::Page)
+            page
+          else
+            GroupDocs::Questionnaire::Page.new(page)
+          end
+        end
+      end
+    end
+
+    #
+    # Adds page to questionnaire.
+    #
+    # @param [GroupDocs::Questionnaire::Page] page
+    # @raise [ArgumentError] if page is not GroupDocs::Questionnaire::Page object
+    #
+    def add_page(page)
+      page.is_a?(GroupDocs::Questionnaire::Page) or raise ArgumentError,
+        "Page should be GroupDocs::Questionnaire::Page object, received: #{page.inspect}"
+
+      @pages ||= Array.new
+      @pages << page
+    end
+
+    #
+    # Creates questionnaire.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def create!(access = {})
+      json = GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = '/merge/{{client_id}}/questionnaires'
+        request[:request_body] = to_hash
+      end.execute!
+
+      self.id = json[:questionnaire_id]
+    end
+
+    #
+    # Updates questionnaire.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def update!(access = {})
+      GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/merge/{{client_id}}/questionnaires/#{id}"
+        request[:request_body] = to_hash
+      end.execute!
+    end
+
+    #
+    # Removes questionnaire.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def remove!(access = {})
+      GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/merge/{{client_id}}/questionnaires/#{id}"
+      end.execute!
+    # TODO: fix this in API
+    rescue RestClient::BadRequest
+      nil
+    end
+
+    #
+    # Returns array of datasources for questionnaire.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::DataSource>]
+    #
+    def datasources!(access = {})
+      json = GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/#{id}/datasources"
+      end.execute!
+
+      json[:datasources].map do |datasource|
+        GroupDocs::DataSource.new(datasource)
+      end
+    end
+
+    #
+    # Creates new questionnaire execution.
+    #
+    # @example
+    #   execution = GroupDocs::Questionnaire::Execution.new
+    #   questionnaire = GroupDocs::Questionnaire.get!(1)
+    #   execution = questionnaire.create_execution!(execution, 'user@email.com')
+    #   #=> #<GroupDocs::Questionnaire::Execution @id=1, @questionnaire_id=1>
+    #
+    # @param [GroupDocs::Questionnaire::Execution] execution
+    # @param [String] email
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Questionnaire::Execution] updated execution
+    #
+    def create_execution!(execution, email, access = {})
+      execution.is_a?(GroupDocs::Questionnaire::Execution) or raise ArgumentError,
+        "Execution should be GroupDocs::Questionnaire::Execution object, received: #{execution.inspect}"
+
+      json = GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/merge/{{client_id}}/questionnaires/#{id}/executions"
+        request[:request_body] = execution.to_hash.merge(executive: { primary_email: email })
+      end.execute!
+
+      execution.id = json[:execution_id]
+      execution.questionnaire_id = json[:questionnaire_id]
+
+      execution
+    end
+
+  end # Questionnaire
+end # GroupDocs