groupdocs 2.2.0 → 2.3.0

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

@@ -1,75 +1,75 @@
-module GroupDocs
-  class Signature
-    #
-    # Envelope and template entities share the same set of recipient methods.
-    #
-    # @see GroupDocs::Signature::Envelope
-    # @see GroupDocs::Signature::Template
-    #
-    module RecipientMethods
-
-      include Api::Helpers::SignaturePublic
-
-      #
-      # Returns recipients array.
-      #
-      #  roles = GroupDocs::Signature::Role.get!
-      #  template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
-      #  recipient = GroupDocs::Signature::Recipient.new
-      #  recipient.nickname = 'John Smith'
-      #  recipient.role_id = roles.detect { |role| role.name == "Signer" }.id
-      #  template.add_recipient! recipient
-      #  template.recipients!
-      #
-      # @param [Hash] options
-      # @option options [Boolean] :public Defaults to false
-      # @param [Hash] access Access credentials
-      # @option access [String] :client_id
-      # @option access [String] :private_key
-      # @return [Array<GroupDocs::Signature::Recipient>]
-      #
-      def recipients!(options = {}, access = {})
-        json = Api::Request.new do |request|
-          request[:access] = access
-          request[:method] = :GET
-          request[:path] = "/signature/#{client_id(options[:public])}/#{class_name.pluralize}/#{id}/recipients"
-        end.execute!
-
-        json[:recipients].map do |recipient|
-          Signature::Recipient.new(recipient)
-        end
-      end
-
-      #
-      # Removes recipient.
-      #
-      # @example
-      #   template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
-      #   recipient = template.recipients!.first
-      #   template.remove_recipient! recipient
-      #
-      # @example
-      #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
-      #   recipient = envelope.recipients!.first
-      #   envelope.remove_recipient! recipient
-      #
-      # @param [GroupDocs::Signature::Recipient] recipient
-      # @param [Hash] access Access credentials
-      # @option access [String] :client_id
-      # @option access [String] :private_key
-      # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
-      #
-      def remove_recipient!(recipient, access = {})
-        recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
-          "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
-
-        Api::Request.new do |request|
-          request[:access] = access
-          request[:method] = :DELETE
-          request[:path] = "/signature/{{client_id}}/#{class_name.pluralize}/#{id}/recipients/#{recipient.id}"
-        end.execute!
-      end
-
-    end # RecipientMethods
-  end # Signature
-end # GroupDocs
+module GroupDocs
+  class Signature
+    #
+    # Envelope and template entities share the same set of recipient methods.
+    #
+    # @see GroupDocs::Signature::Envelope
+    # @see GroupDocs::Signature::Template
+    #
+    module RecipientMethods
+
+      include Api::Helpers::SignaturePublic
+
+      #
+      # Returns recipients array.
+      #
+      #  roles = GroupDocs::Signature::Role.get!
+      #  template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
+      #  recipient = GroupDocs::Signature::Recipient.new
+      #  recipient.nickname = 'John Smith'
+      #  recipient.role_id = roles.detect { |role| role.name == "Signer" }.id
+      #  template.add_recipient! recipient
+      #  template.recipients!
+      #
+      # @param [Hash] options
+      # @option options [Boolean] :public Defaults to false
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [Array<GroupDocs::Signature::Recipient>]
+      #
+      def recipients!(options = {}, access = {})
+        json = Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :GET
+          request[:path] = "/signature/#{client_id(options[:public])}/#{class_name.pluralize}/#{id}/recipients"
+        end.execute!
+
+        json[:recipients].map do |recipient|
+          Signature::Recipient.new(recipient)
+        end
+      end
+
+      #
+      # Removes recipient.
+      #
+      # @example
+      #   template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
+      #   recipient = template.recipients!.first
+      #   template.remove_recipient! recipient
+      #
+      # @example
+      #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+      #   recipient = envelope.recipients!.first
+      #   envelope.remove_recipient! recipient
+      #
+      # @param [GroupDocs::Signature::Recipient] recipient
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
+      #
+      def remove_recipient!(recipient, access = {})
+        recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+          "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
+
+        Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :DELETE
+          request[:path] = "/signature/{{client_id}}/#{class_name.pluralize}/#{id}/recipients/#{recipient.id}"
+        end.execute!
+      end
+
+    end # RecipientMethods
+  end # Signature
+end # GroupDocs

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

@@ -1,65 +1,65 @@
-module GroupDocs
-  class Signature
-    #
-    # Envelope and template entities share the same set of resource methods.
-    #
-    # @see GroupDocs::Signature::Envelope
-    # @see GroupDocs::Signature::Form
-    # @see GroupDocs::Signature::Template
-    #
-    module ResourceMethods
-
-      #
-      # Returns a list of resources.
-      #
-      # @example
-      #   resources = GroupDocs::Signature::Envelope.resources!
-      #   resources[:documents]
-      #   #=> [#<GroupDocs::Document>]
-      #   resources[:recipients]
-      #   #=> [#<GroupDocs::Signature::Recipient>]
-      #   resources[:dates]
-      #   #=> ["2012-09-25T00:00:00.0000000"]
-      #
-      # @param [Hash] options Hash of options
-      # @option options [Array<Integer>] :status_ids List of status identifiers to filter. Doesn't work for template
-      # @param [Hash] access Access credentials
-      # @option access [String] :client_id
-      # @option access [String] :private_key
-      # @return [Hash]
-      #
-      def resources!(options = {}, access = {})
-        class_name = self.name.split('::').last.downcase
-
-        # filter doesn't work for template
-        unless class_name == 'template'
-          ids = options.delete(:status_ids)
-          options[:statusIds] = ids.join(?,) if ids
-        end
-
-        api = Api::Request.new do |request|
-          request[:access] = access
-          request[:method] = :GET
-          request[:path] = "/signature/{{client_id}}/#{class_name}s/resources"
-        end
-        api.add_params(options)
-        json = api.execute!
-
-        resources = {}
-        json.each do |key, value|
-          resources[key] = case key
-                           when :documents
-                             value.map { |doc| Document.new(:file => Storage::File.new(doc)) }
-                           when :recipients
-                             value.map { |recipient| Signature::Recipient.new(recipient) }
-                           else
-                             value
-                           end
-        end
-
-        resources
-      end
-
-    end # ResourceMethods
-  end # Signature
-end # GroupDocs
+module GroupDocs
+  class Signature
+    #
+    # Envelope and template entities share the same set of resource methods.
+    #
+    # @see GroupDocs::Signature::Envelope
+    # @see GroupDocs::Signature::Form
+    # @see GroupDocs::Signature::Template
+    #
+    module ResourceMethods
+
+      #
+      # Returns a list of resources.
+      #
+      # @example
+      #   resources = GroupDocs::Signature::Envelope.resources!
+      #   resources[:documents]
+      #   #=> [#<GroupDocs::Document>]
+      #   resources[:recipients]
+      #   #=> [#<GroupDocs::Signature::Recipient>]
+      #   resources[:dates]
+      #   #=> ["2012-09-25T00:00:00.0000000"]
+      #
+      # @param [Hash] options Hash of options
+      # @option options [Array<Integer>] :status_ids List of status identifiers to filter. Doesn't work for template
+      # @param [Hash] access Access credentials
+      # @option access [String] :client_id
+      # @option access [String] :private_key
+      # @return [Hash]
+      #
+      def resources!(options = {}, access = {})
+        class_name = self.name.split('::').last.downcase
+
+        # filter doesn't work for template
+        unless class_name == 'template'
+          ids = options.delete(:status_ids)
+          options[:statusIds] = ids.join(?,) if ids
+        end
+
+        api = Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :GET
+          request[:path] = "/signature/{{client_id}}/#{class_name}s/resources"
+        end
+        api.add_params(options)
+        json = api.execute!
+
+        resources = {}
+        json.each do |key, value|
+          resources[key] = case key
+                           when :documents
+                             value.map { |doc| Document.new(:file => Storage::File.new(doc)) }
+                           when :recipients
+                             value.map { |recipient| Signature::Recipient.new(recipient) }
+                           else
+                             value
+                           end
+        end
+
+        resources
+      end
+
+    end # ResourceMethods
+  end # Signature
+end # GroupDocs

data/lib/groupdocs/signature/template.rb

@@ -1,124 +1,124 @@
-module GroupDocs
-  class Signature::Template < Api::Entity
-
-    include Signature::DocumentMethods
-    include Signature::EntityFields
-    include Signature::EntityMethods
-    include Signature::FieldMethods
-    include Signature::RecipientMethods
-    extend  Signature::ResourceMethods
-
-    #
-    # Changed in release 1.7.0
-    #
-    #
-    # Returns a list of all templates.  
-    #
-    # @param [Hash] options Hash of options
-    # @option options [Integer] :page Page to start with
-    # @option options [Integer] :records How many items to list
-    # @option options [String] :documentGuid Fitler templates by document originalMD5
-    # @option options [String] :recipientName Filter templates by recipient nickname
-    # @option options [String] :name Filter templates by signatureTemplate name
-    # @option options [String] :tag Filter templates by tag
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @return [Array<GroupDocs::Signature::Template>]
-    #
-    def self.all!(options = {}, access = {})
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :GET
-        request[:path] = '/signature/{{client_id}}/templates'
-      end
-      api.add_params(options)
-      json = api.execute!
-
-      json[:templates].map do |template|
-        new(template)
-      end
-    end
-
-    # @attr [Integer] templateExpireTime
-    attr_accessor :templateExpireTime
-
-    #added in release 1.7.0
-    # @attr [Double] fieldsCount
-    attr_accessor :fieldsCount
-    # @attr [Boolean] enableTypedSignature
-    attr_accessor :enableTypedSignature
-    # @attr [Boolean] enableUploadedSignature
-    attr_accessor :enableUploadedSignature
-    # @attr [String] tags
-    attr_accessor :tags
-
-    # Human-readable accessors
-    alias_accessor :template_expire_time, :templateExpireTime
-
-    #
-    # Adds recipient to template.
-    #
-    # @example
-    #   roles = GroupDocs::Signature::Role.get!
-    #   template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
-    #   recipient = GroupDocs::Signature::Recipient.new
-    #   recipient.nickname = 'John Smith'
-    #   recipient.role_id = roles.detect { |role| role.name == "Signer" }.id
-    #   template.add_recipient! recipient
-    #
-    # @param [GroupDocs::Signature::Recipient] recipient
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
-    #
-    def add_recipient!(recipient, access = {})
-      recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
-        "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
-
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :POST
-        request[:path] = "/signature/{{client_id}}/templates/#{id}/recipient"
-      end
-      api.add_params(:nickname => recipient.nickname,
-                     :role     => recipient.role_id,
-                     :order    => recipient.order)
-      api.execute!
-    end
-
-    #
-    # Modify recipient of template.
-    #
-    # @example
-    #   roles = GroupDocs::Signature::Role.get!
-    #   template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
-    #   recipient = template.recipients!.first
-    #   recipient.nickname = 'John Smith'
-    #   recipient.role_id = roles.detect { |role| role.name == "Signer" }.id
-    #   template.modify_recipient! recipient
-    #
-    # @param [GroupDocs::Signature::Recipient] recipient
-    # @param [Hash] access Access credentials
-    # @option access [String] :client_id
-    # @option access [String] :private_key
-    # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
-    #
-    def modify_recipient!(recipient, access = {})
-      recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
-        "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
-
-      api = Api::Request.new do |request|
-        request[:access] = access
-        request[:method] = :PUT
-        request[:path] = "/signature/{{client_id}}/templates/#{id}/recipient/#{recipient.id}"
-      end
-      api.add_params(:nickname => recipient.nickname, :role => recipient.role_id , :order => recipient.order)
-      api.execute!
-    end
-
-
-
-  end # Signature::Template
-end # GroupDocs
+module GroupDocs
+  class Signature::Template < Api::Entity
+
+    include Signature::DocumentMethods
+    include Signature::EntityFields
+    include Signature::EntityMethods
+    include Signature::FieldMethods
+    include Signature::RecipientMethods
+    extend  Signature::ResourceMethods
+
+    #
+    # Changed in release 1.7.0
+    #
+    #
+    # Returns a list of all templates.  
+    #
+    # @param [Hash] options Hash of options
+    # @option options [Integer] :page Page to start with
+    # @option options [Integer] :records How many items to list
+    # @option options [String] :documentGuid Fitler templates by document originalMD5
+    # @option options [String] :recipientName Filter templates by recipient nickname
+    # @option options [String] :name Filter templates by signatureTemplate name
+    # @option options [String] :tag Filter templates by tag
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Signature::Template>]
+    #
+    def self.all!(options = {}, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/signature/{{client_id}}/templates'
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:templates].map do |template|
+        new(template)
+      end
+    end
+
+    # @attr [Integer] templateExpireTime
+    attr_accessor :templateExpireTime
+
+    #added in release 1.7.0
+    # @attr [Double] fieldsCount
+    attr_accessor :fieldsCount
+    # @attr [Boolean] enableTypedSignature
+    attr_accessor :enableTypedSignature
+    # @attr [Boolean] enableUploadedSignature
+    attr_accessor :enableUploadedSignature
+    # @attr [String] tags
+    attr_accessor :tags
+
+    # Human-readable accessors
+    alias_accessor :template_expire_time, :templateExpireTime
+
+    #
+    # Adds recipient to template.
+    #
+    # @example
+    #   roles = GroupDocs::Signature::Role.get!
+    #   template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
+    #   recipient = GroupDocs::Signature::Recipient.new
+    #   recipient.nickname = 'John Smith'
+    #   recipient.role_id = roles.detect { |role| role.name == "Signer" }.id
+    #   template.add_recipient! recipient
+    #
+    # @param [GroupDocs::Signature::Recipient] recipient
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
+    #
+    def add_recipient!(recipient, access = {})
+      recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+        "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/signature/{{client_id}}/templates/#{id}/recipient"
+      end
+      api.add_params(:nickname => recipient.nickname,
+                     :role     => recipient.role_id,
+                     :order    => recipient.order)
+      api.execute!
+    end
+
+    #
+    # Modify recipient of template.
+    #
+    # @example
+    #   roles = GroupDocs::Signature::Role.get!
+    #   template = GroupDocs::Signature::Template.get!("g94h5g84hj9g4gf23i40j")
+    #   recipient = template.recipients!.first
+    #   recipient.nickname = 'John Smith'
+    #   recipient.role_id = roles.detect { |role| role.name == "Signer" }.id
+    #   template.modify_recipient! recipient
+    #
+    # @param [GroupDocs::Signature::Recipient] recipient
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
+    #
+    def modify_recipient!(recipient, access = {})
+      recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+        "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/templates/#{id}/recipient/#{recipient.id}"
+      end
+      api.add_params(:nickname => recipient.nickname, :role => recipient.role_id , :order => recipient.order)
+      api.execute!
+    end
+
+
+
+  end # Signature::Template
+end # GroupDocs