groupdocs 0.3.11 → 1.0.0

data/lib/groupdocs/signature/list.rb

@@ -0,0 +1,93 @@
+module GroupDocs
+  class Signature::List < Api::Entity
+
+    #
+    # Returns array of predefined lists.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Signature::List>]
+    #
+    def self.get!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/signature/{{client_id}}/lists'
+      end.execute!
+
+      json[:lists].map do |list|
+        new(list)
+      end
+    end
+
+    # @attr [String] id
+    attr_accessor :id
+    # @attr [String] name
+    attr_accessor :name
+    # @attr [Array<String>] values
+    attr_accessor :values
+    # @attr [String] defaultValue
+    attr_accessor :defaultValue
+
+    # Human-readable accessors
+    alias_method :default_value,  :defaultValue
+    alias_method :default_value=, :defaultValue=
+
+    #
+    # Converts values to API compatible view.
+    # @param [Array<String>, String] values
+    #
+    def values=(values)
+      @values = values.is_a?(Array) ? values.join(?;) : values
+    end
+
+    #
+    # Returns values as array.
+    # @return [Array<String>]
+    #
+    def values
+      @values.split(?;)
+    end
+
+    #
+    # Adds predefined list.
+    #
+    # @example
+    #   list = GroupDocs::Signature::List.new
+    #   list.name = 'Cities'
+    #   list.values = %w(London Paris)
+    #   list.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] = '/signature/{{client_id}}/list'
+        request[:request_body] = to_hash
+      end.execute!
+
+      self.id = json[:list][:id]
+    end
+
+    #
+    # Deletes predefined list.
+    #
+    # @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] = "/signature/{{client_id}}/lists/#{id}"
+      end.execute!
+    end
+
+  end # Signature::List
+end # GroupDocs

data/lib/groupdocs/signature/recipient.rb

@@ -0,0 +1,47 @@
+module GroupDocs
+  class Signature::Recipient < Api::Entity
+
+    STATUSES = {
+      none:     -1,
+      waiting:   0,
+      notified:  1,
+      delegated: 2,
+      rejected:  3,
+      signed:    4,
+    }
+
+    # @attr [String] id
+    attr_accessor :id
+    # @attr [String] email
+    attr_accessor :email
+    # @attr [String] firstName
+    attr_accessor :firstName
+    # @attr [String] lastName
+    attr_accessor :lastName
+    # @attr [String] nickname
+    attr_accessor :nickname
+    # @attr [String] roleId
+    attr_accessor :roleId
+    # @attr [String] order
+    attr_accessor :order
+    # @attr [Symbol] status
+    attr_accessor :status
+
+    # Human-readable accessors
+    alias_method :first_name,  :firstName
+    alias_method :first_name=, :firstName=
+    alias_method :last_name,   :lastName
+    alias_method :last_name=,  :lastName=
+    alias_method :role_id,     :roleId
+    alias_method :role_id=,    :roleId=
+
+    #
+    # Converts status to human-readable format.
+    # @return [Symbol]
+    #
+    def status
+      STATUSES.invert[@status]
+    end
+
+  end # Signature::Recipient
+end # GroupDocs

data/lib/groupdocs/signature/role.rb

@@ -0,0 +1,84 @@
+module GroupDocs
+  class Signature::Role < Api::Entity
+
+    #
+    # Returns array of predefined roles.
+    #
+    # @param [Hash] options Hash of options
+    # @option options [String] :id Filter by identifier
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Signature::role>]
+    #
+    def self.get!(options = {}, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/signature/{{client_id}}/roles'
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:roles].map do |role|
+        new(role)
+      end
+    end
+
+    # @attr [String] id
+    attr_accessor :id
+    # @attr [String] name
+    attr_accessor :name
+    # @attr [Integer] canEdit
+    attr_accessor :canEdit
+    # @attr [Integer] canSign
+    attr_accessor :canSign
+    # @attr [Integer] canAnnotate
+    attr_accessor :canAnnotate
+    # @attr [Integer] canDelegate
+    attr_accessor :canDelegate
+
+    # Human-readable accessors
+    alias_method :can_edit,      :canEdit
+    alias_method :can_edit=,     :canEdit=
+    alias_method :can_sign,      :canSign
+    alias_method :can_sign=,     :canSign=
+    alias_method :can_annotate,  :canAnnotate
+    alias_method :can_annotate=, :canAnnotate=
+    alias_method :can_delegate,  :canDelegate
+    alias_method :can_delegate=, :canDelegate=
+
+    #
+    # Returns true if role can edit.
+    # @return [Boolean]
+    #
+    def can_edit?
+      can_edit == 1
+    end
+
+    #
+    # Returns true if role can sign.
+    # @return [Boolean]
+    #
+    def can_sign?
+      can_sign == 1
+    end
+
+    #
+    # Returns true if role can annotate.
+    # @return [Boolean]
+    #
+    def can_annotate?
+      can_annotate == 1
+    end
+
+    #
+    # Returns true if role can delegate.
+    # @return [Boolean]
+    #
+    def can_delegate?
+      can_delegate == 1
+    end
+
+  end # Signature::Role
+end # GroupDocs

data/lib/groupdocs/signature/shared.rb

@@ -0,0 +1,6 @@
+require 'groupdocs/signature/shared/document_methods'
+require 'groupdocs/signature/shared/entity_fields'
+require 'groupdocs/signature/shared/entity_methods'
+require 'groupdocs/signature/shared/field_methods'
+require 'groupdocs/signature/shared/recipient_methods'
+require 'groupdocs/signature/shared/resource_methods'

data/lib/groupdocs/signature/shared/document_methods.rb

@@ -0,0 +1,98 @@
+module GroupDocs
+  class Signature
+    #
+    # Envelope and template entities share the same set of document methods.
+    #
+    # @see GroupDocs::Signature::Envelope
+    # @see GroupDocs::Signature::Template
+    #
+    module DocumentMethods
+
+      #
+      # Returns documents array.
+      #
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [Array<GroupDocs::Document>]
+      #
+      def documents!(access = {})
+        json = Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :GET
+          request[:path] = "/signature/{{client_id}}/#{pluralized_class_name}/#{id}/documents"
+        end.execute!
+
+        json[:documents].map do |document|
+          file = Storage::File.new(guid: document[:documentId], name: document[:name])
+          Document.new(document.merge(file: file))
+        end
+      end
+
+      #
+      # Adds document.
+      #
+      # @example
+      #   template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
+      #   document = GroupDocs::Storage::Folder.list!.last.to_document
+      #   template.add_document! document
+      #
+      # @example
+      #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+      #   document = GroupDocs::Storage::Folder.list!.last.to_document
+      #   envelope.add_document! document
+      #
+      # @param [GroupDocs::Document] document
+      # @param [Hash] options
+      # @option options [Integer] :order Display order of the document
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @raise [ArgumentError] if document is not GroupDocs::Document
+      #
+      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] = :POST
+          request[:path] = "/signature/{{client_id}}/#{pluralized_class_name}/#{id}/document/#{document.file.guid}"
+        end
+        api.add_params(options)
+        api.execute!
+      end
+
+      #
+      # Removes document.
+      #
+      # @example
+      #   template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
+      #   document = template.documents!.first
+      #   template.remove_document! document
+      #
+      # @example
+      #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+      #   document = envelope.documents!.first
+      #   envelope.remove_document! document
+      #
+      # @param [GroupDocs::Document] document
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @raise [ArgumentError] if document is not GroupDocs::Document
+      #
+      def remove_document!(document, access = {})
+        document.is_a?(GroupDocs::Document) or raise ArgumentError,
+          "Document should be GroupDocs::Document object, received: #{document.inspect}"
+
+        Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :DELETE
+          request[:path] = "/signature/{{client_id}}/#{pluralized_class_name}/#{id}/documents/#{document.file.guid}"
+        end.execute!
+      end
+
+    end # DocumentMethods
+  end # Signature
+end # GroupDocs

data/lib/groupdocs/signature/shared/entity_fields.rb

@@ -0,0 +1,94 @@
+module GroupDocs
+  class Signature
+    #
+    # Envelope and template entities share the same set of fields.
+    #
+    # @see GroupDocs::Signature::Envelope
+    # @see GroupDocs::Signature::Template
+    #
+    module EntityFields
+
+      # @attr [String] id
+      attr_accessor :id
+      # @attr [String] name
+      attr_accessor :name
+      # @attr [Integer] ownerId
+      attr_accessor :ownerId
+      # @attr [String] ownerGuid
+      attr_accessor :ownerGuid
+      # @attr [String] reminderTime
+      attr_accessor :reminderTime
+      # @attr [Integer] stepExpireTime
+      attr_accessor :stepExpireTime
+      # @attr [Boolean] ownerShouldSign
+      attr_accessor :ownerShouldSign
+      # @attr [Boolean] orderedSignature
+      attr_accessor :orderedSignature
+      # @attr [String] emailSubject
+      attr_accessor :emailSubject
+      # @attr [String] emailBody
+      attr_accessor :emailBody
+      # @attr [Integer] documentsCount
+      attr_accessor :documentsCount
+      # @attr [Integer] documentsPages
+      attr_accessor :documentsPages
+      # @attr [Array<GroupDocs::Signature::Contact>] recipients
+      attr_accessor :recipients
+
+      # Human-readable accessors
+      alias_method :owner_id,           :ownerId
+      alias_method :owner_id=,          :ownerId=
+      alias_method :owner_guid,         :ownerGuid
+      alias_method :owner_guid=,        :ownerGuid=
+      alias_method :reminder_time,      :reminderTime
+      alias_method :reminder_time=,     :reminderTime=
+      alias_method :step_expire_time,   :stepExpireTime
+      alias_method :step_expire_time=,  :stepExpireTime=
+      alias_method :owner_should_sign,  :ownerShouldSign
+      alias_method :owner_should_sign=, :ownerShouldSign=
+      alias_method :ordered_signature,  :orderedSignature
+      alias_method :ordered_signature=, :orderedSignature=
+      alias_method :email_subject,      :emailSubject
+      alias_method :email_subject=,     :emailSubject=
+      alias_method :email_body,         :emailBody
+      alias_method :email_body=,        :emailBody=
+      alias_method :documents_count,    :documentsCount
+      alias_method :documents_count=,   :documentsCount=
+      alias_method :documents_pages,    :documentsPages
+      alias_method :documents_pages=,   :documentsPages=
+
+      #
+      # Converts each recipient to GroupDocs::Signature::Recipient object.
+      # @param [Array<GroupDocs::Signature::Recipient, Hash>] recipients
+      #
+      def recipients=(recipients)
+        if recipients
+          @recipients = recipients.map do |recipient|
+            if recipient.is_a?(GroupDocs::Signature::Recipient)
+              recipient
+            else
+              Signature::Recipient.new(recipient)
+            end
+          end
+        end
+      end
+
+      #
+      # Returns true if owner should sign.
+      # @return [Boolean]
+      #
+      def owner_should_sign
+        @ownerShouldSign == 1 ? true : false
+      end
+
+      #
+      # Returns ordered signature type.
+      # @return [Symbol]
+      #
+      def ordered_signature
+        @orderedSignature == 1 ? :parallel : :ordered
+      end
+
+    end # EntityFields
+  end # Signature
+end # GroupDocs

data/lib/groupdocs/signature/shared/entity_methods.rb

@@ -0,0 +1,145 @@
+module GroupDocs
+  class Signature
+    #
+    # Envelope and template entities share the same set of methods.
+    #
+    # @see GroupDocs::Signature::Form
+    # @see GroupDocs::Signature::Envelope
+    # @see GroupDocs::Signature::Template
+    #
+    module EntityMethods
+
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        #
+        # Returns template, envelope or form by its identifier.
+        #
+        # @param [String] id
+        # @param [Hash] access Access credentials
+        # @option access [String] :client_id
+        # @option access [String] :private_key
+        # @return [GroupDocs::Signature::Template, GroupDocs::Signature::Envelope, GroupDocs::Signature::Form]
+        #
+        def get!(id, access = {})
+          class_name = self.name.split('::').last.downcase
+
+          json = Api::Request.new do |request|
+            request[:access] = access
+            request[:method] = :GET
+            request[:path] = "/signature/{{client_id}}/#{class_name}s/#{id}"
+          end.execute!
+
+          new(json[class_name.to_sym])
+        end
+      end # ClassMethods
+
+      #
+      # Creates template or envelope.
+      #
+      # @example Create new template
+      #   template = GroupDocs::Signature::Template.new
+      #   template.name = "Template"
+      #   template.email_subject = "Sing this!"
+      #   template.create!
+      #
+      # @example Create new envelope
+      #   envelope = GroupDocs::Signature::Envelope.new
+      #   envelope.name = "Envelope"
+      #   envelope.email_subject = "Sing this!"
+      #   envelope.create!
+      #
+      # @param [Hash] options Hash of options
+      # @option options [Integer] :template_id Template GUID to use
+      # @option options [Integer] :envelope_id Envelope GUID to use
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      #
+      def create!(options = {}, access = {})
+        template_id = options.delete(:template_id)
+        envelope_id = options.delete(:envelope_id)
+        options[:templateId] = template_id if template_id
+        options[:envelopeId] = envelope_id if envelope_id
+
+        api = Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :POST
+          request[:path] = "/signature/{{client_id}}/#{class_name}"
+          request[:request_body] = to_hash
+        end
+        api.add_params(options.merge(name: name))
+        json = api.execute!
+
+        self.id = json[class_name.to_sym][:id]
+      end
+
+      #
+      # Modifies template, envelope or form.
+      #
+      # @example Modify template
+      #   template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
+      #   template.name = "Template"
+      #   template.email_subject = "Sing this!"
+      #   template.modify!
+      #
+      # @example Modify envelope
+      #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+      #   envelope.name = "Envelope"
+      #   envelope.email_subject = "Sing this!"
+      #   envelope.modify!
+      #
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      #
+      def modify!(access = {})
+        Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :POST
+          request[:path] = "/signature/{{client_id}}/#{pluralized_class_name}/#{id}"
+          request[:request_body] = to_hash
+        end.execute!
+      end
+
+      #
+      # Renames template, envelope or form.
+      #
+      # @param [String] name New template name
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      #
+      def rename!(name, access = {})
+        api = Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :PUT
+          request[:path] = "/signature/{{client_id}}/#{pluralized_class_name}/#{id}"
+        end
+        key = (class_name == 'form' ? :new_name : :name )
+        api.add_params(key => name)
+        api.execute!
+
+        self.name = name
+      end
+
+      #
+      # Deletes template, envelope or form.
+      #
+      # @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] = "/signature/{{client_id}}/#{pluralized_class_name}/#{id}"
+        end.execute!
+      end
+
+    end # EntityMethods
+  end # Signature
+end # GroupDocs