groupdocs 2.2.0 → 2.3.0

data/lib/groupdocs/questionnaire/execution.rb

@@ -1,181 +1,181 @@
-module GroupDocs
-  class Questionnaire::Execution < Api::Entity
-
-    include Api::Helpers::Status
-
-    #
-    # Returns execution by identifier.
-    #
-    # @param [String] guid
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [GroupDocs::Questionnaire::Execution, nil]
-    #
-    def self.get!(guid, access = {})
-      json = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{guid}"
-      end.execute!
-
-      new(json[:execution])
-    rescue BadResponseError
-      nil
-    end
-
-    # @attr [Integer] id
-    attr_accessor :id
-    # @attr [String] guid
-    attr_accessor :guid
-    # @attr [Integer] collector_id
-    attr_accessor :collector_id
-    # @attr [String] collector_guid
-    attr_accessor :collector_guid
-    # @attr [String] questionnaire_name
-    attr_accessor :questionnaire_name
-    # @attr [GroupDocs::User] owner
-    attr_accessor :owner
-    # @attr [GroupDocs::User] executive
-    attr_accessor :executive
-    # @attr [GroupDocs::User] approver
-    attr_accessor :approver
-    # @attr [Integer] datasource_id
-    attr_accessor :datasource_id
-    # @attr [Symbol] status
-    attr_accessor :status
-    # @attr [Time] modified
-    attr_accessor :modified
-    # @attr [GroupDocs::Storage::File] document
-    attr_accessor :document
-
-    #
-    # 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 modified
-      Time.at(@modified / 1000)
-    end
-
-    #
-    # Converts document to GroupDocs::Document object.
-    # @param [Hash] options
-    #
-    def document=(options)
-      if options.is_a?(Hash)
-        options = GroupDocs::Storage::File.new(options)
-      elsif options.is_a?(Document)
-        options = options.file
-      end
-
-      @document = options
-    end
-
-    %w(owner executive approver).each do |method|
-      #
-      # Converts hash of user options to GroupDocs::User object.
-      #
-      # @param [GroupDocs::User, Hash] options
-      #
-      define_method(:"#{method}=") do |options|
-        case options
-        when User then instance_variable_set(:"@#{method}", options)
-        when Hash then instance_variable_set(:"@#{method}", User.new(options))
-        end
-      end
-    end
-
-    #
-    # Updates status of execution on server.
-    #
-    # @param [Symbol] status
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def set_status!(status, access = {})
-      status = parse_status(status)
-
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{id}/status"
-        request[:request_body] = status
-      end.execute!
-
-      self.status = status
-    end
-
-    #
-    # Updates execution on server.
-    #
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    #
-    def update!(access = {})
-      Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{id}"
-        request[:request_body] = to_hash
-      end.execute!
-    end
-
-    #
-    # Deletes execution.
-    #
-    # @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] = "/merge/{{client_id}}/questionnaires/executions/#{id}"
-      end.execute!
-    end
-
-    #
-    # Creates new job to merge datasource into questionnaire collector execution.
-    #
-    # When you fill collector, execution for it creates. You can then fill this execution
-    # (for example if you didn't answered all the questions at first).
-    #
-    # @param [GroupDocs::DataSource] datasource
-    # @param [Hash] options
-    # @option options [Boolean] :new_type New file format type
-    # @option options [Boolean] :email_results Set to true if converted document should be emailed
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [GroupDocs::Job]
-    #
-    # @raise [ArgumentError] if datasource is not GroupDocs::DataSource object
-    #
-    def fill!(datasource, options = {}, access = {})
-      datasource.is_a?(GroupDocs::DataSource) or raise ArgumentError,
-        "Datasource should be GroupDocs::DataSource object, received: #{datasource.inspect}"
-
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :POST
-        request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{guid}/datasources/#{datasource.id}"
-      end
-      api.add_params(options)
-      json = api.execute!
-
-      Job.new(:id => json[:job_id])
-    end
-
-  end # Questionnaire::Execution
-end # GroupDocs
+module GroupDocs
+  class Questionnaire::Execution < Api::Entity
+
+    include Api::Helpers::Status
+
+    #
+    # Returns execution by identifier.
+    #
+    # @param [String] guid
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Questionnaire::Execution, nil]
+    #
+    def self.get!(guid, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{guid}"
+      end.execute!
+
+      new(json[:execution])
+    rescue BadResponseError
+      nil
+    end
+
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [String] guid
+    attr_accessor :guid
+    # @attr [Integer] collector_id
+    attr_accessor :collector_id
+    # @attr [String] collector_guid
+    attr_accessor :collector_guid
+    # @attr [String] questionnaire_name
+    attr_accessor :questionnaire_name
+    # @attr [GroupDocs::User] owner
+    attr_accessor :owner
+    # @attr [GroupDocs::User] executive
+    attr_accessor :executive
+    # @attr [GroupDocs::User] approver
+    attr_accessor :approver
+    # @attr [Integer] datasource_id
+    attr_accessor :datasource_id
+    # @attr [Symbol] status
+    attr_accessor :status
+    # @attr [Time] modified
+    attr_accessor :modified
+    # @attr [GroupDocs::Storage::File] document
+    attr_accessor :document
+
+    #
+    # 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 modified
+      Time.at(@modified / 1000)
+    end
+
+    #
+    # Converts document to GroupDocs::Document object.
+    # @param [Hash] options
+    #
+    def document=(options)
+      if options.is_a?(Hash)
+        options = GroupDocs::Storage::File.new(options)
+      elsif options.is_a?(Document)
+        options = options.file
+      end
+
+      @document = options
+    end
+
+    %w(owner executive approver).each do |method|
+      #
+      # Converts hash of user options to GroupDocs::User object.
+      #
+      # @param [GroupDocs::User, Hash] options
+      #
+      define_method(:"#{method}=") do |options|
+        case options
+        when User then instance_variable_set(:"@#{method}", options)
+        when Hash then instance_variable_set(:"@#{method}", User.new(options))
+        end
+      end
+    end
+
+    #
+    # Updates status of execution on server.
+    #
+    # @param [Symbol] status
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def set_status!(status, access = {})
+      status = parse_status(status)
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{id}/status"
+        request[:request_body] = status
+      end.execute!
+
+      self.status = status
+    end
+
+    #
+    # Updates execution on server.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def update!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{id}"
+        request[:request_body] = to_hash
+      end.execute!
+    end
+
+    #
+    # Deletes execution.
+    #
+    # @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] = "/merge/{{client_id}}/questionnaires/executions/#{id}"
+      end.execute!
+    end
+
+    #
+    # Creates new job to merge datasource into questionnaire collector execution.
+    #
+    # When you fill collector, execution for it creates. You can then fill this execution
+    # (for example if you didn't answered all the questions at first).
+    #
+    # @param [GroupDocs::DataSource] datasource
+    # @param [Hash] options
+    # @option options [Boolean] :new_type New file format type
+    # @option options [Boolean] :email_results Set to true if converted document should be emailed
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Job]
+    #
+    # @raise [ArgumentError] if datasource is not GroupDocs::DataSource object
+    #
+    def fill!(datasource, options = {}, access = {})
+      datasource.is_a?(GroupDocs::DataSource) or raise ArgumentError,
+        "Datasource should be GroupDocs::DataSource object, received: #{datasource.inspect}"
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{guid}/datasources/#{datasource.id}"
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      Job.new(:id => json[:job_id])
+    end
+
+  end # Questionnaire::Execution
+end # GroupDocs

data/lib/groupdocs/questionnaire/page.rb

@@ -1,43 +1,43 @@
-module GroupDocs
-  class Questionnaire::Page < Api::Entity
-
-    # @attr [Integer] number
-    attr_accessor :number
-    # @attr [String] title
-    attr_accessor :title
-    # @attr [Array<GroupDocs::Questionnaire::Question>] questions
-    attr_accessor :questions
-
-    #
-    # Converts each question to GroupDocs::Questionnaire::Question object.
-    #
-    # @param [Array<GroupDocs::Questionnaire::Question, Hash>] questions
-    #
-    def questions=(questions)
-      if questions
-        @questions = questions.map do |question|
-          if question.is_a?(GroupDocs::Questionnaire::Question)
-            question
-          else
-            Questionnaire::Question.new(question)
-          end
-        end
-      end
-    end
-
-    #
-    # Adds question to page.
-    #
-    # @param [GroupDocs::Questionnaire::Question] question
-    # @raise [ArgumentError] if question is not GroupDocs::Questionnaire::Question object
-    #
-    def add_question(question)
-      question.is_a?(GroupDocs::Questionnaire::Question) or raise ArgumentError,
-        "Question should be GroupDocs::Questionnaire::Question object, received: #{question.inspect}"
-
-      @questions ||= Array.new
-      @questions << question
-    end
-
-  end # Questionnaire::Page
-end # GroupDocs
+module GroupDocs
+  class Questionnaire::Page < Api::Entity
+
+    # @attr [Integer] number
+    attr_accessor :number
+    # @attr [String] title
+    attr_accessor :title
+    # @attr [Array<GroupDocs::Questionnaire::Question>] questions
+    attr_accessor :questions
+
+    #
+    # Converts each question to GroupDocs::Questionnaire::Question object.
+    #
+    # @param [Array<GroupDocs::Questionnaire::Question, Hash>] questions
+    #
+    def questions=(questions)
+      if questions
+        @questions = questions.map do |question|
+          if question.is_a?(GroupDocs::Questionnaire::Question)
+            question
+          else
+            Questionnaire::Question.new(question)
+          end
+        end
+      end
+    end
+
+    #
+    # Adds question to page.
+    #
+    # @param [GroupDocs::Questionnaire::Question] question
+    # @raise [ArgumentError] if question is not GroupDocs::Questionnaire::Question object
+    #
+    def add_question(question)
+      question.is_a?(GroupDocs::Questionnaire::Question) or raise ArgumentError,
+        "Question should be GroupDocs::Questionnaire::Question object, received: #{question.inspect}"
+
+      @questions ||= Array.new
+      @questions << question
+    end
+
+  end # Questionnaire::Page
+end # GroupDocs

data/lib/groupdocs/questionnaire/question.rb

@@ -1,108 +1,108 @@
-module GroupDocs
-  class Questionnaire::Question < Api::Entity
-
-    require 'groupdocs/questionnaire/question/answer'
-    require 'groupdocs/questionnaire/question/conditions'
-
-    TYPES = %w(GenericText MultipleChoice)
-
-    # @attr [String] field
-    attr_accessor :field
-    # @attr [String] text
-    attr_accessor :text
-    # @attr [String] def_answer
-    attr_accessor :def_answer
-    # @attr [Boolean] required
-    attr_accessor :required
-    # @attr [Symbol] type
-    attr_accessor :type
-    # @attr [Array<Hash>] answers
-    attr_accessor :answers
-
-    #
-    # added in release 1.5.8
-    #
-    # @attr [Boolean] disabled
-    attr_accessor :disabled
-    # @attr [Integer] max_length
-    attr_accessor :max_length
-    # @attr [GroupDocs::Document::Rectangle] rect
-    attr_accessor :rect
-    # @attr [Array<String>] acceptableValues
-    attr_accessor :acceptableValues
-    # @attr [Array<GroupDocs::Questionnaire::Question::Conditions>] conditions
-    attr_accessor :conditions
-
-    # added in release 1.7.0
-    #
-    # @attr [String] regionName
-    attr_accessor :regionName
-    ## @attr [String] hint
-    attr_accessor :hint
-    # @attr [Array<String>] dimension
-    attr_accessor :dimension
-
-
-    # Human-readable accessors
-    alias_accessor :default_answer, :def_answer
-
-    # added in release 1.5.8
-    alias_accessor :acceptable_values, :acceptableValues
-
-    #
-    # Converts each answer to GroupDocs::Questionnaire::Question::Answer object.
-    #
-    # @param [Array<Hash>] answers
-    #
-    def answers=(answers)
-      if answers
-        @answers = answers.map do |answer|
-          if answer.is_a?(GroupDocs::Questionnaire::Question::Answer)
-            answer
-          else
-            Questionnaire::Question::Answer.new(answer)
-          end
-        end
-      end
-    end
-
-    #
-    # Adds answer to the question.
-    #
-    # @param [GroupDocs::Questionnaire::Question::Answer] answer
-    # @raise [ArgumentError] if answer is not GroupDocs::Questionnaire::Question::Answer object
-    #
-    def add_answer(answer)
-      answer.is_a?(GroupDocs::Questionnaire::Question::Answer) or raise ArgumentError,
-        "Answer should be GroupDocs::Questionnaire::Question::Answer object, received: #{answer.inspect}"
-
-      @answers ||= Array.new
-      @answers << answer
-    end
-
-    #
-    # Updates type with machine-readable format.
-    #
-    # @param [Symbol] type
-    # @raise [ArgumentError] if type is unknown
-    #
-    def type=(type)
-      if type.is_a?(Symbol)
-        type = type.to_s.camelize
-        TYPES.include?(type) or raise ArgumentError, "Unknown type: #{type.inspect}"
-      end
-
-      @type = type
-    end
-
-    #
-    # Returns field type in human-readable format.
-    #
-    # @return [Symbol]
-    #
-    def type
-      @type.underscore.to_sym
-    end
-
-  end # Questionnaire::Question
-end # GroupDocs
+module GroupDocs
+  class Questionnaire::Question < Api::Entity
+
+    require 'groupdocs/questionnaire/question/answer'
+    require 'groupdocs/questionnaire/question/conditions'
+
+    TYPES = %w(GenericText MultipleChoice)
+
+    # @attr [String] field
+    attr_accessor :field
+    # @attr [String] text
+    attr_accessor :text
+    # @attr [String] def_answer
+    attr_accessor :def_answer
+    # @attr [Boolean] required
+    attr_accessor :required
+    # @attr [Symbol] type
+    attr_accessor :type
+    # @attr [Array<Hash>] answers
+    attr_accessor :answers
+
+    #
+    # added in release 1.5.8
+    #
+    # @attr [Boolean] disabled
+    attr_accessor :disabled
+    # @attr [Integer] max_length
+    attr_accessor :max_length
+    # @attr [GroupDocs::Document::Rectangle] rect
+    attr_accessor :rect
+    # @attr [Array<String>] acceptableValues
+    attr_accessor :acceptableValues
+    # @attr [Array<GroupDocs::Questionnaire::Question::Conditions>] conditions
+    attr_accessor :conditions
+
+    # added in release 1.7.0
+    #
+    # @attr [String] regionName
+    attr_accessor :regionName
+    ## @attr [String] hint
+    attr_accessor :hint
+    # @attr [Array<String>] dimension
+    attr_accessor :dimension
+
+
+    # Human-readable accessors
+    alias_accessor :default_answer, :def_answer
+
+    # added in release 1.5.8
+    alias_accessor :acceptable_values, :acceptableValues
+
+    #
+    # Converts each answer to GroupDocs::Questionnaire::Question::Answer object.
+    #
+    # @param [Array<Hash>] answers
+    #
+    def answers=(answers)
+      if answers
+        @answers = answers.map do |answer|
+          if answer.is_a?(GroupDocs::Questionnaire::Question::Answer)
+            answer
+          else
+            Questionnaire::Question::Answer.new(answer)
+          end
+        end
+      end
+    end
+
+    #
+    # Adds answer to the question.
+    #
+    # @param [GroupDocs::Questionnaire::Question::Answer] answer
+    # @raise [ArgumentError] if answer is not GroupDocs::Questionnaire::Question::Answer object
+    #
+    def add_answer(answer)
+      answer.is_a?(GroupDocs::Questionnaire::Question::Answer) or raise ArgumentError,
+        "Answer should be GroupDocs::Questionnaire::Question::Answer object, received: #{answer.inspect}"
+
+      @answers ||= Array.new
+      @answers << answer
+    end
+
+    #
+    # Updates type with machine-readable format.
+    #
+    # @param [Symbol] type
+    # @raise [ArgumentError] if type is unknown
+    #
+    def type=(type)
+      if type.is_a?(Symbol)
+        type = type.to_s.camelize
+        TYPES.include?(type) or raise ArgumentError, "Unknown type: #{type.inspect}"
+      end
+
+      @type = type
+    end
+
+    #
+    # Returns field type in human-readable format.
+    #
+    # @return [Symbol]
+    #
+    def type
+      @type.underscore.to_sym
+    end
+
+  end # Questionnaire::Question
+end # GroupDocs