groupdocs 1.4.2 → 1.5.0

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## v1.5.0
+
+**New**
+
+* Added `Signature.get_for_recipients!`
+* Added `Signature#create_for_recipient!`
+* Added `Signature#signature_data!`
+* Added `Signature#initials_data!`
+
+**Changes**
+
+* `Signature::Envelope#fill_field!` supports `:public` flag
+* `Signature::Envelope#sign!` supports `:public` flag
+* `Signature::Form.get!` supports `:public` flag
+* `Signature::Form#documents!` supports `:public` flag
+* `Signature::Envelope#documents!` supports `:public` flag
+* `Signature::Envelope#recipients!` supports `:public` flag
+
 ## v1.4.2
 
 **New**

data/lib/groupdocs/api/helpers.rb

@@ -6,5 +6,6 @@ require 'groupdocs/api/helpers/credentials_helper'
 require 'groupdocs/api/helpers/mime_helper'
 require 'groupdocs/api/helpers/path_helper'
 require 'groupdocs/api/helpers/rest_helper'
+require 'groupdocs/api/helpers/signature_public_helper'
 require 'groupdocs/api/helpers/status_helper'
 require 'groupdocs/api/helpers/url_helper'

data/lib/groupdocs/api/helpers/signature_public_helper.rb

@@ -0,0 +1,22 @@
+module GroupDocs
+  module Api
+    module Helpers
+      module SignaturePublic
+
+        private
+
+        #
+        # Returns corresponding URI fragment for (un)public call.
+        #
+        # @param [Boolean, nil] public_flag
+        # @return [String]
+        # @api private
+        #
+        def client_id(public_flag)
+          !!public_flag ? 'public' : '{{client_id}}'
+        end
+
+      end # SignaturePublic
+    end # Helpers
+  end # Api
+end # GroupDocs

data/lib/groupdocs/signature.rb

@@ -33,6 +33,32 @@ module GroupDocs
       end
     end
 
+    #
+    # Returns a list of all signatures for recipient.
+    #
+    # @param [GroupDocs::Signature::Recipient] recipient
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Signature>]
+    #
+    def self.get_for_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] = :GET
+        request[:path] = '/signature/public/signatures'
+      end
+      api.add_params(:recipientId => recipient.id)
+      json = api.execute!
+
+      json[:signatures].map do |signature|
+        new(signature)
+      end
+    end
+
     # @attr [String] id
     attr_accessor :id
     # @attr [String] userGuid
@@ -113,6 +139,31 @@ module GroupDocs
       self.id = json[:signature][:id]
     end
 
+    #
+    # Creates signature for recipient.
+    #
+    # @param [GroupDocs::Signature::Recipient] recipient
+    # @param [String] title Signature title
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def create_for_recipient!(recipient, title, 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/public/signature'
+        request[:request_body] = to_hash
+      end
+      api.add_params(:name => title, :recipientId => recipient.id)
+      json = api.execute!
+
+      self.id = json[:signature][:id]
+    end
+
     #
     # Deletes signature.
     #
@@ -128,5 +179,35 @@ module GroupDocs
       end.execute!
     end
 
+    #
+    # Returns signature data.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def signature_data!(access = {})
+      self.signature_data = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/signature/public/signatures/signature/#{id}/signatureData"
+      end.execute!
+    end
+
+    #
+    # Returns initials data.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def initials_data!(access = {})
+      self.initials_data = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/signature/public/signatures/signature/#{id}/initialsData"
+      end.execute!
+    end
+
   end # Signature
 end # GroupDocs

data/lib/groupdocs/signature/envelope.rb

@@ -15,6 +15,7 @@ module GroupDocs
       :scheduled   => 99,
     }
 
+    include Api::Helpers::SignaturePublic
     include Signature::DocumentMethods
     include Signature::EntityFields
     include Signature::EntityMethods
@@ -245,6 +246,8 @@ module GroupDocs
     # @param [GroupDocs::Signature::Field] field
     # @param [GroupDocs::Document] document
     # @param [GroupDocs::Signature::Recipient] recipient
+    # @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
@@ -253,7 +256,7 @@ module GroupDocs
     # @raise [ArgumentError] if document is not GroupDocs::Document
     # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
     #
-    def fill_field!(value, field, document, recipient, access = {})
+    def fill_field!(value, field, document, recipient, options = {}, access = {})
       field.is_a?(GroupDocs::Signature::Field) or raise ArgumentError,
         "Field should be GroupDocs::Signature::Field object, received: #{field.inspect}"
       document.is_a?(GroupDocs::Document) or raise ArgumentError,
@@ -261,10 +264,11 @@ module GroupDocs
       recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
         "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
 
+      client_id = client_id(options[:public])
       api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
-        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/documents/#{document.file.guid}/recipient/#{recipient.id}/field/#{field.id}"
+        request[:path] = "/signature/#{client_id}/envelopes/#{id}/documents/#{document.file.guid}/recipient/#{recipient.id}/field/#{field.id}"
       end
 
       type = field.field_type
@@ -286,19 +290,22 @@ module GroupDocs
     # Signs envelope.
     #
     # @param [GroupDocs::Signature::Recipient] recipient
+    # @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
     # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
     #
-    def sign!(recipient, access = {})
+    def sign!(recipient, options = {}, ccess = {})
       recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
         "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
 
+      client_id = client_id(options[:public])
       Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
-        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/recipient/#{recipient.id}/sign"
+        request[:path] = "/signature/#{client_id}/envelopes/#{id}/recipient/#{recipient.id}/sign"
       end.execute!
     end
 

data/lib/groupdocs/signature/form.rb

@@ -1,6 +1,7 @@
 module GroupDocs
   class Signature::Form < Api::Entity
 
+    include Api::Helpers::SignaturePublic
     include Signature::EntityMethods
     include Signature::DocumentMethods
     include Signature::FieldMethods
@@ -48,6 +49,31 @@ module GroupDocs
       end
     end
 
+    #
+    # Returns form by its identifier.
+    #
+    # @param [String] id
+    # @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 [GroupDocs::Signature::Form]
+    #
+    def self.get!(id, options = {}, access = {})
+      if options[:public]
+        json = Api::Request.new do |request|
+          request[:access] = access
+          request[:method] = :GET
+          request[:path] = "/signature/public/forms/#{id}"
+        end.execute!
+
+        new(json[:form])
+      else
+        super(id, access)
+      end
+    end
+
     # @attr [String] id
     attr_accessor :id
     # @attr [String] name
@@ -154,16 +180,20 @@ module GroupDocs
     #
     # Returns documents array.
     #
+    # @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::Document>]
     #
-    def documents!(access = {})
+    def documents!(options = {}, access = {})
+      client_id = client_id(options[:public])
+
       json = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
-        request[:path] = "/signature/{{client_id}}/forms/#{id}/documents"
+        request[:path] = "/signature/#{client_id}/forms/#{id}/documents"
       end.execute!
 
       json[:documents].map do |document|

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

@@ -4,6 +4,7 @@ module GroupDocs
     # Envelope and template entities share the same set of document methods.
     #
     # @see GroupDocs::Signature::Envelope
+    # @see GroupDocs::Signature::Form
     # @see GroupDocs::Signature::Template
     #
     module DocumentMethods
@@ -11,16 +12,35 @@ module GroupDocs
       #
       # Returns documents array.
       #
+      # @param [Hash] options
+      # @option options [Boolean] :public Defaults to false
+      # @option options [GroupDocs::Signature::Recipient] :recipient Used if :public is true and self is envelope
       # @param [Hash] access Access credentials
       # @option access [String] :client_id
       # @option access [String] :private_key
       # @return [Array<GroupDocs::Document>]
       #
-      def documents!(access = {})
+      def documents!(options = {}, access = {})
+        path = if options[:public]
+                 case class_name
+                 when 'envelope'
+                   options[:recipient].is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+                     "Recipient should be GroupDocs::Signature::Recipient object, received: #{options[:recipient].inspect}"
+
+                   "/signature/public/envelopes/#{id}/recipient/#{options[:recipient].id}/documents"
+                 when 'form'
+                   "/signature/public/forms/#{id}/documents"
+                 else
+                   raise ArgumentError, "Public is supported only for envelope or form."
+                 end
+               else
+                 "/signature/{{client_id}}/#{class_name.pluralize}/#{id}/documents"
+               end
+
         json = Api::Request.new do |request|
           request[:access] = access
           request[:method] = :GET
-          request[:path] = "/signature/{{client_id}}/#{class_name.pluralize}/#{id}/documents"
+          request[:path] = path
         end.execute!
 
         json[:documents].map do |document|

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

@@ -3,8 +3,8 @@ module GroupDocs
     #
     # Envelope and template entities share the same set of methods.
     #
-    # @see GroupDocs::Signature::Form
     # @see GroupDocs::Signature::Envelope
+    # @see GroupDocs::Signature::Form
     # @see GroupDocs::Signature::Template
     #
     module EntityMethods

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

@@ -4,6 +4,7 @@ module GroupDocs
     # Envelope and template entities share the same set of field methods.
     #
     # @see GroupDocs::Signature::Envelope
+    # @see GroupDocs::Signature::Form
     # @see GroupDocs::Signature::Template
     #
     module FieldMethods

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

@@ -8,19 +8,23 @@ module GroupDocs
     #
     module RecipientMethods
 
+      include Api::Helpers::SignaturePublic
+
       #
       # Returns recipients array.
       #
+      # @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!(access = {})
+      def recipients!(options = {}, access = {})
         json = Api::Request.new do |request|
           request[:access] = access
           request[:method] = :GET
-          request[:path] = "/signature/{{client_id}}/#{class_name.pluralize}/#{id}/recipients"
+          request[:path] = "/signature/#{client_id(options[:public])}/#{class_name.pluralize}/#{id}/recipients"
         end.execute!
 
         json[:recipients].map do |recipient|

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

@@ -3,8 +3,8 @@ module GroupDocs
     #
     # Envelope and template entities share the same set of resource methods.
     #
-    # @see GroupDocs::Signature::Form
     # @see GroupDocs::Signature::Envelope
+    # @see GroupDocs::Signature::Form
     # @see GroupDocs::Signature::Template
     #
     module ResourceMethods

data/lib/groupdocs/version.rb

@@ -1,3 +1,3 @@
 module GroupDocs
-  VERSION = '1.4.2'
+  VERSION = '1.5.0'
 end # GroupDocs

data/spec/groupdocs/api/helpers/signature_public_helper_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe GroupDocs::Api::Helpers::SignaturePublic do
+  subject do
+    GroupDocs::Signature::Envelope.new
+  end
+
+  describe '#client_id' do
+    it 'returns "public" if true is passed' do
+      subject.send(:client_id, true).should == 'public'
+    end
+
+    it 'returns "{{client_id}}" if false is passed' do
+      subject.send(:client_id, false).should == '{{client_id}}'
+    end
+
+    it 'returns "{{client_id}}" if nil is passed' do
+      subject.send(:client_id, false).should == '{{client_id}}'
+    end
+  end
+end

data/spec/groupdocs/signature/envelope_spec.rb

@@ -151,10 +151,14 @@ describe GroupDocs::Signature::Envelope do
 
     it 'accepts access credentials hash' do
       lambda do
-        subject.fill_field!('test', field, document, recipient, :client_id => 'client_id', :private_key => 'private_key')
+        subject.fill_field!('test', field, document, recipient, {}, :client_id => 'client_id', :private_key => 'private_key')
       end.should_not raise_error(ArgumentError)
     end
 
+    it 'can be public' do
+      lambda { subject.fill_field!('test', field, document, recipient, :public => true) }.should_not raise_error(ArgumentError)
+    end
+
     it 'raises error if field is not GroupDocs::Signature::Field object' do
       lambda { subject.fill_field!('test', 'Field', document, recipient) }.should raise_error(ArgumentError)
     end
@@ -202,10 +206,14 @@ describe GroupDocs::Signature::Envelope do
 
     it 'accepts access credentials hash' do
       lambda do
-        subject.sign!(recipient, :client_id => 'client_id', :private_key => 'private_key')
+        subject.sign!(recipient, {}, :client_id => 'client_id', :private_key => 'private_key')
       end.should_not raise_error(ArgumentError)
     end
 
+    it 'can be public' do
+      lambda { subject.fill_field!('test', field, document, recipient, :public => true) }.should_not raise_error(ArgumentError)
+    end
+
     it 'raises error if recipient is not GroupDocs::Signature::Recipient object' do
       lambda { subject.sign!('Recipient') }.should raise_error(ArgumentError)
     end

data/spec/groupdocs/signature/form_spec.rb

@@ -120,10 +120,14 @@ describe GroupDocs::Signature::Form do
 
     it 'accepts access credentials hash' do
       lambda do
-        subject.documents!(:client_id => 'client_id', :private_key => 'private_key')
+        subject.documents!({}, :client_id => 'client_id', :private_key => 'private_key')
       end.should_not raise_error(ArgumentError)
     end
 
+    it 'can be public' do
+      lambda { subject.documents!(:public => true) }.should_not raise_error(ArgumentError)
+    end
+
     it 'returns array of GroupDocs::Document objects' do
       documents = subject.documents!
       documents.should be_an(Array)

data/spec/groupdocs/signature_spec.rb

@@ -24,6 +24,32 @@ describe GroupDocs::Signature do
     end
   end
 
+  describe '.get_for_recipient!' do
+    let(:recipient) { GroupDocs::Signature::Recipient.new }
+
+    before(:each) do
+      mock_api_server(load_json('signatures_get'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.get_for_recipient!(recipient, :client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'raises error if recipient is not GroupDocs::Signature::Recipient object' do
+      lambda { described_class.get_for_recipient!('Recipient') }.should raise_error(ArgumentError)
+    end
+
+    it 'returns array of GroupDocs::Signature objects' do
+      signatures = described_class.get_for_recipient!(recipient)
+      signatures.should be_an(Array)
+      signatures.each do |signature|
+        signature.should be_a(GroupDocs::Signature)
+      end
+    end
+  end
+
   it { should have_accessor(:id)                   }
   it { should have_accessor(:userGuid)             }
   it { should have_accessor(:recipientId)          }
@@ -81,6 +107,35 @@ describe GroupDocs::Signature do
     end
   end
 
+  describe '#create_for_recipient!' do
+    let(:recipient) { GroupDocs::Signature::Recipient.new }
+
+    before(:each) do
+      mock_api_server(load_json('signature_create'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.create_for_recipient!(recipient, 'Signature', :client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'raises error if recipient is not GroupDocs::Signature::Recipient object' do
+      lambda { subject.create_for_recipient!('Recipient') }.should raise_error(ArgumentError)
+    end
+
+    it 'uses hashed version of self as request body' do
+      subject.should_receive(:to_hash)
+      subject.create_for_recipient!(recipient, 'Signature')
+    end
+
+    it 'updates identifier of signature' do
+      lambda do
+        subject.create_for_recipient!(recipient, 'Signature')
+      end.should change(subject, :id)
+    end
+  end
+
   describe '#delete!' do
     before(:each) do
       mock_api_server('{ "status": "Ok", "result": {}}')
@@ -92,4 +147,48 @@ describe GroupDocs::Signature do
       end.should_not raise_error(ArgumentError)
     end
   end
+
+  describe '#signature_data!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": "Data"}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.signature_data!(:client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns data' do
+      subject.signature_data!.should == 'Data'
+    end
+
+    it 'updates signature data of signature' do
+      lambda do
+        subject.signature_data!
+      end.should change(subject, :signature_data)
+    end
+  end
+
+  describe '#initials_data!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": "Data"}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.initials_data!(:client_id => 'client_id', :private_key => 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns data' do
+      subject.initials_data!.should == 'Data'
+    end
+
+    it 'updates initials data of signature' do
+      lambda do
+        subject.initials_data!
+      end.should change(subject, :initials_data)
+    end
+  end
 end

data/spec/support/shared_examples/signature/shared/recipient_methods.rb

@@ -7,10 +7,14 @@ shared_examples_for GroupDocs::Signature::RecipientMethods do
 
     it 'accepts access credentials hash' do
       lambda do
-        subject.recipients!(:client_id => 'client_id', :private_key => 'private_key')
+        subject.recipients!({}, :client_id => 'client_id', :private_key => 'private_key')
       end.should_not raise_error(ArgumentError)
     end
 
+    it 'can be public' do
+      lambda { subject.recipients!(:public => true) }.should_not raise_error(ArgumentError)
+    end
+
     it 'returns array of GroupDocs::Signature::Recipient objects' do
       recipients = subject.recipients!
       recipients.should be_an(Array)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groupdocs
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2013-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -278,6 +278,7 @@ files:
 - lib/groupdocs/api/helpers/mime_helper.rb
 - lib/groupdocs/api/helpers/path_helper.rb
 - lib/groupdocs/api/helpers/rest_helper.rb
+- lib/groupdocs/api/helpers/signature_public_helper.rb
 - lib/groupdocs/api/helpers/status_helper.rb
 - lib/groupdocs/api/helpers/url_helper.rb
 - lib/groupdocs/api/request.rb
@@ -336,6 +337,7 @@ files:
 - spec/groupdocs/api/helpers/mime_helper_spec.rb
 - spec/groupdocs/api/helpers/path_helper_spec.rb
 - spec/groupdocs/api/helpers/rest_helper_spec.rb
+- spec/groupdocs/api/helpers/signature_public_helper_spec.rb
 - spec/groupdocs/api/helpers/status_helper_spec.rb
 - spec/groupdocs/api/helpers/url_helper_spec.rb
 - spec/groupdocs/api/request_spec.rb
@@ -499,7 +501,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2511714868888231436
+      hash: 2302864106414593407
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -508,7 +510,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2511714868888231436
+      hash: 2302864106414593407
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -525,6 +527,7 @@ test_files:
 - spec/groupdocs/api/helpers/mime_helper_spec.rb
 - spec/groupdocs/api/helpers/path_helper_spec.rb
 - spec/groupdocs/api/helpers/rest_helper_spec.rb
+- spec/groupdocs/api/helpers/signature_public_helper_spec.rb
 - spec/groupdocs/api/helpers/status_helper_spec.rb
 - spec/groupdocs/api/helpers/url_helper_spec.rb
 - spec/groupdocs/api/request_spec.rb