groupdocs 1.1.0 → 1.2.0

data/lib/groupdocs/job.rb

@@ -244,7 +244,7 @@ module 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}"
+        request[:path] = "/async/{{client_id}}/jobs/#{id}/files/#{document.file.id}/datasources/#{datasource.id}"
       end.execute!
     end
 

data/lib/groupdocs/questionnaire.rb

@@ -1,27 +1,41 @@
 module GroupDocs
   class Questionnaire < Api::Entity
 
+    require 'groupdocs/questionnaire/collector'
     require 'groupdocs/questionnaire/execution'
     require 'groupdocs/questionnaire/page'
     require 'groupdocs/questionnaire/question'
 
+    include Api::Helpers::Status
+
     #
     # Returns an array of all questionnaires.
     #
+    # @param [Hash] options Hash of options
+    # @option options [Symbol] :status Filter questionnaires by status
+    # @option options [Integer] :page_number Page to start with
+    # @option options [Integer] :page_size How many items to list
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
     # @return [Array<GroupDocs::Questionnaire>]
     #
-    def self.all!(access = {})
-      json = Api::Request.new do |request|
+    def self.all!(options = {}, access = {})
+      if options[:status]
+        # TODO find better way to parse status
+        options[:status] = new.send(:parse_status, options[:status])
+      end
+
+      api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
         request[:path] = '/merge/{{client_id}}/questionnaires'
-      end.execute!
+      end
+      api.add_params(options)
+      json = api.execute!
 
       json[:questionnaires].map do |questionnaire|
-        Questionnaire.new(questionnaire)
+        new(questionnaire)
       end
     end
 
@@ -41,43 +55,38 @@ module GroupDocs
         request[:path] = "/merge/{{client_id}}/questionnaires/#{id}"
       end.execute!
 
-      Questionnaire.new(json[:questionnaire])
+      new(json[:questionnaire])
     rescue RestClient::ResourceNotFound
       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 = 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|
-        Questionnaire::Execution.new(execution)
-      end
-    end
-
     # @attr [Integer] id
     attr_accessor :id
+    # @attr [String] guid
+    attr_accessor :guid
     # @attr [String] name
     attr_accessor :name
+    # @attr [Symbol] status
+    attr_accessor :status
     # @attr [String] descr
     attr_accessor :descr
     # @attr [Array<GroupDocs::Questionnaire::Page>] pages
     attr_accessor :pages
+    # @attr [Integer] resolved_executions
+    attr_accessor :resolved_executions
+    # @attr [Integer] assigned_questions
+    attr_accessor :assigned_questions
+    # @attr [Integer] total_questions
+    attr_accessor :total_questions
+    # @attr [Integer] modified
+    attr_accessor :modified
+    # @attr [Integer] expires
+    attr_accessor :expires
+    # @attr [Array<String>] document_ids
+    attr_accessor :document_ids
 
     # Human-readable accessors
-    alias_method :description,  :descr
-    alias_method :description=, :descr=
+    alias_accessor :description, :descr
 
     #
     # Converts each page to GroupDocs::Questionnaire::Page object.
@@ -96,6 +105,15 @@ module GroupDocs
       end
     end
 
+    #
+    # Converts status to human-readable format.
+    #
+    # @return [Symbol]
+    #
+    def status
+      parse_status(@status)
+    end
+
     #
     # Adds page to questionnaire.
     #
@@ -126,6 +144,8 @@ module GroupDocs
       end.execute!
 
       self.id = json[:questionnaire_id]
+      self.guid = json[:questionnaire_guid]
+      self.name = json[:adjusted_name]
     end
 
     #
@@ -183,36 +203,110 @@ module GroupDocs
     end
 
     #
-    # Creates new questionnaire execution.
+    # Returns an array of questionnaire executions.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Questionnaire::Execution>]
+    #
+    def executions!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/#{guid}/executions"
+      end.execute!
+
+      json[:executions].map do |execution|
+        Execution.new(execution)
+      end
+    end
+
+    #
+    # Returns an array of questionnaire collectors.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Questionnaire::Collector>]
+    #
+    def collectors!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/#{guid}/collectors"
+      end.execute!
+
+      json[:collectors].map do |collector|
+        collector.merge!(questionnaire: self)
+        Collector.new(collector)
+      end
+    end
+
+    #
+    # Returns questionnaire metadata.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Questionnaire]
+    #
+    def metadata!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/#{guid}/metadata"
+      end.execute!
+
+      Questionnaire.new(json[:questionnaire])
+    end
+
+    #
+    # Updates questionnaire metadata.
     #
     # @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>
+    #   metadata = questionnaire.metadata!
+    #   metadata.name = 'New questionnaire name'
+    #   questionnaire.update_metadata! metadata
     #
-    # @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
+    # @raise [ArgumentError] if metadata is not GroupDocs::Questionnaire
     #
-    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}"
+    def update_metadata!(metadata, access = {})
+      metadata.is_a?(GroupDocs::Questionnaire) or raise ArgumentError,
+        "Metadata should be GroupDocs::Questionnaire object, received: #{metadata.inspect}"
 
-      json = Api::Request.new do |request|
+      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 })
+        request[:method] = :PUT
+        request[:path] = "/merge/{{client_id}}/questionnaires/#{guid}/metadata"
+        request[:request_body] = metadata.to_hash
       end.execute!
+    end
 
-      execution.id = json[:execution_id]
-      execution.questionnaire_id = json[:questionnaire_id]
+    #
+    # Returns an array of document fields for questionnaire.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Document::Field>]
+    #
+    def fields!(access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/#{guid}/fields"
+      end
+      api.add_params(include_geometry: true)
+      json = api.execute!
 
-      execution
+      json[:fields].map do |field|
+        Document::Field.new(field)
+      end
     end
 
   end # Questionnaire

data/lib/groupdocs/questionnaire/collector.rb

@@ -0,0 +1,262 @@
+module GroupDocs
+  class Questionnaire::Collector < Api::Entity
+
+    include Api::Helpers::Status
+
+    #
+    # Returns collector by its guid.
+    #
+    # @param [String] guid
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Questionnaire::Collector]
+    #
+    def self.get!(guid, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}"
+      end.execute!
+
+      collector = json[:collector]
+      collector.merge!(questionnaire: Questionnaire.new(id: collector[:questionnaire_id]))
+
+      new(collector)
+    end
+
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [String] guid
+    attr_accessor :guid
+    # @attr [GroupDocs::Questionnaire] questionnaire
+    attr_accessor :questionnaire
+    # @attr [Integer] questionnaire_id
+    attr_accessor :questionnaire_id
+    # @attr [Symbol] status
+    attr_accessor :status
+    # @attr [Symbol] type
+    attr_accessor :type
+    # @attr [Integer] resolved_executions
+    attr_accessor :resolved_executions
+    # @attr [Array<String>] emails
+    attr_accessor :emails
+    # @attr [Time] modified
+    attr_accessor :modified
+
+    #
+    # Creates new GroupDocs::Questionnaire::Collector.
+    #
+    # @raise [ArgumentError] If questionnaire is not passed or is not an instance of GroupDocs::Questionnaire
+    #
+    def initialize(options = {}, &blk)
+      super(options, &blk)
+      questionnaire.is_a?(GroupDocs::Questionnaire) or raise ArgumentError,
+        "You have to pass GroupDocs::Questionnaire object: #{questionnaire.inspect}."
+    end
+
+    #
+    # Converts status to human-readable format.
+    # @return [Symbol]
+    #
+    def status
+      parse_status(@status)
+    end
+
+    #
+    # Updates type with machine-readable format.
+    #
+    # @param [Symbol] type
+    #
+    def type=(type)
+      @type = type.is_a?(Symbol) ? type.to_s.capitalize : type
+    end
+
+    #
+    # Converts type to human-readable format.
+    # @return [Symbol]
+    #
+    def type
+      parse_status(@type)
+    end
+
+    #
+    # Converts timestamp which is return by API server to Time object.
+    # @return [Time]
+    #
+    def modified
+      Time.at(@modified / 1000)
+    end
+
+    #
+    # Adds collector.
+    #
+    # @example
+    #   questionnaire = GroupDocs::Questionnaire.get!(1)
+    #   collector = GroupDocs::Questionnaire::Collector.new(questionnaire: questionnaire)
+    #   collector.type = :link
+    #   collector.add!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def add!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/merge/{{client_id}}/questionnaires/#{questionnaire.guid}/collectors"
+        request[:request_body] = to_hash
+      end.execute!
+
+      self.id   = json[:collector_id]
+      self.guid = json[:collector_guid]
+    end
+
+    #
+    # Updates collector.
+    #
+    # @example
+    #   questionnaire = GroupDocs::Questionnaire.get!(1)
+    #   collector = questionnaire.collectors!.first
+    #   collector.type = :embedded
+    #   collector.update!
+    #
+    # @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/collectors/#{guid}"
+        request[:request_body] = to_hash
+      end.execute!
+    end
+
+    #
+    # Removes collector.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def remove!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}"
+      end.execute!
+    end
+
+    #
+    # Returns an array of questionnaire collector executions.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Questionnaire::Execution>]
+    #
+    def executions!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}/executions"
+      end.execute!
+
+      json[:executions].map do |execution|
+        Questionnaire::Execution.new(execution)
+      end
+    end
+
+    #
+    # Adds new questionnaire execution.
+    #
+    # @example
+    #   questionnaire = GroupDocs::Questionnaire.get!(1)
+    #   collector = questionnaire.collectors!.first
+    #   execution = GroupDocs::Questionnaire::Execution.new
+    #   execution.executive = GroupDocs::User.new(primary_email: 'john@smith.com')
+    #   # make sure to save execution as it has updated attributes
+    #   execution = collector.add_execution!(execution)
+    #   #=> #<GroupDocs::Questionnaire::Execution @id=1, @questionnaire_id=1>
+    #
+    # @param [GroupDocs::Questionnaire::Execution] execution
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Questionnaire::Execution] updated execution
+    #
+    def add_execution!(execution, access = {})
+      execution.is_a?(GroupDocs::Questionnaire::Execution) or raise ArgumentError,
+        "Execution should be GroupDocs::Questionnaire::Execution object, received: #{execution.inspect}"
+
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}/executions"
+        request[:request_body] = execution.to_hash
+      end.execute!
+
+      execution.id = json[:execution_id]
+      execution.guid = json[:execution_guid]
+      execution.collector_id = json[:collector_id]
+
+      execution
+    end
+
+    #
+    # Creates new job to merge datasource into questionnaire collector.
+    #
+    # @example
+    #   # get template and its first field
+    #   document = GroupDocs::Document.templates!.first
+    #   field = document.fields!.first
+    #   # create questionnaire
+    #   answer = GroupDocs::Questionnaire::Question::Answer.new(text: 'Text', value: 'Value1')
+    #   question = GroupDocs::Questionnaire::Question.new(field: field.name, text: 'Question', answers: [answer])
+    #   page = GroupDocs::Questionnaire::Page.new(number: field.page, questions: [question])
+    #   questionnaire = GroupDocs::Questionnaire.new(name: 'Questionnaire', description: 'Description', pages: [page])
+    #   questionnaire.create!
+    #   # add questionnaire to document
+    #   document.add_questionnaire! questionnaire
+    #   # create collector
+    #   collector = GroupDocs::Questionnaire::Collector.new(questionnaire: questionnaire)
+    #   collector.type = :link
+    #   collector.add!
+    #   # create datasource and its field
+    #   field = GroupDocs::DataSource::Field.new(field: field.name, values: %w(test1 test2))
+    #   datasource = GroupDocs::DataSource.new(fields: [field])
+    #   datasource.add!
+    #   # fill collector with datasrouce and send results to email
+    #   collector.fill!(datasource, email_results: true)
+    #
+    # @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/collectors/#{guid}/datasources/#{datasource.id}"
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      Job.new(id: json[:job_id])
+    end
+
+  end # Questionnaire::Collector
+end # GroupDocs