groupdocs 0.1.0

data/lib/groupdocs/questionnaire/execution.rb

@@ -0,0 +1,120 @@
+module GroupDocs
+  class Questionnaire::Execution < GroupDocs::Api::Entity
+
+    STATUSES = {
+      draft:     0,
+      submitted: 1,
+      executed:  2,
+      approved:  3,
+      rejected:  4,
+      closed:    5,
+    }
+
+    #
+    # 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.all!(access = {})
+      GroupDocs::Questionnaire.executions!(access)
+    end
+
+    # @attr [Integer] id
+    attr_accessor :id
+    # @attr [Integer] ownerId
+    attr_accessor :ownerId
+    # @attr [Integer] questionnaireId
+    attr_accessor :questionnaireId
+    # @attr [Integer] executiveId
+    attr_accessor :executiveId
+    # @attr [Integer] approverId
+    attr_accessor :approverId
+    # @attr [Integer] datasourceId
+    attr_accessor :datasourceId
+    # @attr [Integer] documentId
+    attr_accessor :documentId
+    # @attr [Integer] status
+    attr_accessor :status
+    # @attr [String] guid
+    attr_accessor :guid
+
+    # Human-readable accessors
+    alias_method :owner_id,           :ownerId
+    alias_method :owner_id=,          :ownerId=
+    alias_method :questionnaire_id,   :questionnaireId
+    alias_method :questionnaire_id=,  :questionnaireId=
+    alias_method :executive_id,       :executiveId
+    alias_method :executive_id=,      :executiveId=
+    alias_method :approver_id,        :approverId
+    alias_method :approver_id=,       :approverId=
+    alias_method :datasource_id,      :datasourceId
+    alias_method :datasource_id=,     :datasourceId=
+    alias_method :document_id,        :documentId
+    alias_method :document_id=,       :documentId=
+
+    #
+    # Updates status with machine-readable format.
+    #
+    # If you want to update status on server, use #set_status! method.
+    #
+    # @param [Symbol, Integer] status
+    # @raise [ArgumentError] if status is unknown
+    #
+    def status=(status)
+      if status.is_a?(Symbol)
+        STATUSES.keys.include?(status) or raise ArgumentError, "Unknown status: #{status.inspect}"
+        status = STATUSES[status]
+      end
+
+      @status = status
+    end
+
+    #
+    # Returns execution status in human-readable format.
+    #
+    # @return [Symbol]
+    #
+    def status
+      STATUSES.invert[@status]
+    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 = {})
+      GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{id}/status"
+        request[:request_body] = STATUSES[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 = {})
+      GroupDocs::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
+
+  end # Questionnaire::Execution
+end # GroupDocs

data/lib/groupdocs/questionnaire/page.rb

@@ -0,0 +1,43 @@
+module GroupDocs
+  class Questionnaire::Page < GroupDocs::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
+            GroupDocs::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

@@ -0,0 +1,75 @@
+module GroupDocs
+  class Questionnaire::Question < GroupDocs::Api::Entity
+
+    require 'groupdocs/questionnaire/question/answer'
+
+    TYPES = {
+      simple:          0,
+      multiple_choice: 1,
+    }
+
+    # @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
+
+    #
+    # 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
+            GroupDocs::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
+    #
+    def type=(type)
+      type = TYPES[type] if type.is_a?(Symbol)
+      @type = type
+    end
+
+    #
+    # Returns field type in human-readable format.
+    #
+    # @return [Symbol]
+    #
+    def type
+      TYPES.invert[@type]
+    end
+
+  end # Questionnaire::Question
+end # GroupDocs

data/lib/groupdocs/questionnaire/question/answer.rb

@@ -0,0 +1,10 @@
+module GroupDocs
+  class Questionnaire::Question::Answer < GroupDocs::Api::Entity
+
+    # @attr [String] text
+    attr_accessor :text
+    # @attr [String] value
+    attr_accessor :value
+
+  end # Questionnaire::Question::Answer
+end # GroupDocs

data/lib/groupdocs/storage.rb

@@ -0,0 +1,37 @@
+require 'groupdocs/storage/folder'
+require 'groupdocs/storage/file'
+require 'groupdocs/storage/package'
+
+
+module GroupDocs
+  module Storage
+
+    #
+    # Returns hash of information about user's storage.
+    #
+    # @example
+    #   GroupDocs::Storage.info!
+    #   #=> { total_space: "1024 MB", available_space: "1020 MB", document_credits: 5000, available_credits: 4964 }
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Hash]
+    #
+    def self.info!(access = {})
+      json = GroupDocs::Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/storage/{{client_id}}'
+      end.execute!
+
+      {
+        total_space:       "#{json[:total_space] / 1048576} MB",
+        available_space:   "#{json[:avail_space] / 1048576} MB",
+        document_credits:  json[:doc_credits],
+        available_credits: json[:avail_credits]
+      }
+    end
+
+  end # Storage
+end # GroupDocs

data/lib/groupdocs/storage/file.rb

@@ -0,0 +1,248 @@
+module GroupDocs
+  module Storage
+    class File < GroupDocs::Api::Entity
+
+      extend GroupDocs::Api::Sugar::Lookup
+
+      #
+      # Uploads file to API server.
+      #
+      # @example
+      #   GroupDocs::Storage::File.upload!('resume.pdf', '/folder/cv.pdf', description: 'My resume')
+      #
+      # @param [String] filepath Path to file to be uploaded
+      # @param [String] upload_path Full path to directory to upload file to starting with "/".
+      #                      You can also add filename and then uploaded file will use it.
+      # @param [Hash] options Hash of options
+      # @option options [String] :description Optional description for file
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [GroupDocs::Storage::File]
+      #
+      # @raise [ArgumentError] If path does not start with /
+      #
+      def self.upload!(filepath, upload_path = '/', options = {}, access = {})
+        upload_path.chars.first == '/' or raise ArgumentError, "Path should start with /: #{upload_path.inspect}"
+        upload_path << "/#{Object::File.basename(filepath)}" unless upload_path =~ /\.(\w){3,4}$/
+
+        api = GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :POST
+          request[:path] = "/storage/{{client_id}}/folders#{upload_path.gsub(/[\/]{2}/, '/')}"
+          request[:request_body] = Object::File.new(filepath, 'rb')
+        end
+        api.add_params(options)
+        json = api.execute!
+
+        GroupDocs::Storage::File.new(json)
+      end
+
+      #
+      # Returns an array of all files on server starting with given path.
+      #
+      # @param [String] path Starting path to look for files
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [Array<GroupDocs::Storage::File>]
+      #
+      def self.all!(path = '/', access = {})
+        files = Array.new
+        folder = GroupDocs::Storage::Folder.new(path: path)
+        folder.list!({}, access).each do |entity|
+          if entity.is_a?(GroupDocs::Storage::Folder)
+            files += all!("#{path}/#{entity.name}".gsub(/[\/]{2}/, '/'), access)
+          else
+            files << entity
+          end
+        end
+
+        files
+      end
+
+      # @attr [Integer] id
+      attr_accessor :id
+      # @attr [Integer] guid
+      attr_accessor :guid
+      # @attr [Integer] size
+      attr_accessor :size
+      # @attr [Boolean] known
+      attr_accessor :known
+      # @attr [String] thumbnail
+      attr_accessor :thumbnail
+      # @attr [Time] created_on
+      attr_accessor :created_on
+      # @attr [Time] modified_on
+      attr_accessor :modified_on
+      # @attr [String] url
+      attr_accessor :url
+      # @attr [String] name
+      attr_accessor :name
+      # @attr [Integer] version
+      attr_accessor :version
+      # @attr [Integer] type
+      attr_accessor :type
+      # @attr [Integer] access
+      attr_accessor :access
+      # @attr [String] path
+      attr_accessor :path
+
+      # Compatibility with response JSON
+      alias_method :adj_name=, :name=
+
+      #
+      # Converts timestamp which is return by API server to Time object.
+      #
+      # @return [Time]
+      #
+      def created_on
+        Time.at(@created_on)
+      end
+
+      #
+      # Converts timestamp which is return by API server to Time object.
+      #
+      # @return [Time]
+      #
+      def modified_on
+        Time.at(@modified_on)
+      end
+
+      #
+      # Downloads file to given path.
+      #
+      # @param [String] path Directory to download file to
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [String] Path to downloaded file
+      #
+      def download!(path, access = {})
+        response = GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :DOWNLOAD
+          request[:path] = "/storage/{{client_id}}/files/#{id}"
+        end.execute!
+
+        filepath = "#{path}/#{name}"
+        Object::File.open(filepath, 'w') do |file|
+          file.write(response)
+        end
+
+        filepath
+      end
+
+      #
+      # Moves file to given path.
+      #
+      # @param [String] path Full path to directory to move file to starting with "/".
+      #                      You can also add filename and then moved file will use it.
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [GroupDocs::Storage::File] Moved to file
+      #
+      # @raise [ArgumentError] If path does not start with /
+      #
+      def move!(path, access = {})
+        path.chars.first == '/' or raise ArgumentError, "Path should start with /: #{path.inspect}"
+        path << "/#{Object::File.basename(name)}" unless path =~ /\.(\w){3,4}$/
+
+        json = GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :PUT
+          request[:headers] = { :'Groupdocs-Move' => id }
+          request[:path] = "/storage/{{client_id}}/files#{path}"
+        end.execute!
+
+        GroupDocs::Storage::File.new(json[:dst_file])
+      end
+
+      #
+      # Renames file to new one.
+      #
+      # @param [String] name New file name
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [GroupDocs::Storage::File] Renamed file
+      #
+      def rename!(name, access = {})
+        move!("#{path}#{name}", access)
+      end
+
+      #
+      # Moves file to given path.
+      #
+      # @param [String] path Full path to directory to copy file to starting with "/".
+      #                      You can also add filename and then copied file will use it.
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [GroupDocs::Storage::File] Copied to file
+      #
+      # @raise [ArgumentError] If path does not start with /
+      #
+      def copy!(path, access = {})
+        path.chars.first == '/' or raise ArgumentError, "Path should start with /: #{path.inspect}"
+        path << "/#{Object::File.basename(name)}" unless path =~ /\.(\w){3,4}$/
+
+        json = GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :PUT
+          request[:headers] = { :'Groupdocs-Copy' => id }
+          request[:path] = "/storage/{{client_id}}/files#{path}"
+        end.execute!
+
+        GroupDocs::Storage::File.new(json[:dst_file])
+      end
+
+      #
+      # Compresses file on server to given archive type.
+      #
+      # @param [Symbol] type Archive type: :zip, :rar.
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [GroupDocs::Storage::File] Archive file
+      #
+      def compress!(type = :zip, access = {})
+        json = GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :POST
+          request[:path] = "/storage/{{client_id}}/files/#{id}/archive/#{type}"
+        end.execute!
+
+        # HACK add filename for further download
+        json[:name] = "#{name}.#{type}"
+        GroupDocs::Storage::File.new(json)
+      end
+
+      #
+      # Deletes file from server.
+      #
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      #
+      def delete!(access = {})
+        GroupDocs::Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :DELETE
+          request[:path] = "/storage/{{client_id}}/files/#{guid}"
+        end.execute!
+      end
+
+      #
+      # Converts file to GroupDocs::Document.
+      #
+      # @return [GroupDocs::Document]
+      #
+      def to_document
+        GroupDocs::Document.new(file: self)
+      end
+
+    end # File
+  end # Storage
+end # GroupDocs