groupdocs 1.0.0 → 1.1.0

data/lib/groupdocs/user.rb

@@ -1,6 +1,8 @@
 module GroupDocs
   class User < Api::Entity
 
+    include Api::Helpers::AccessRights
+
     #
     # Returns current user profile.
     #
@@ -54,12 +56,37 @@ module GroupDocs
     attr_accessor :news_enabled
     # @attr [Time] signed_up_on
     attr_accessor :signed_up_on
+    # @attr [Integer] color
+    attr_accessor :color
+    # @attr [String] customEmailMessage
+    attr_accessor :customEmailMessage
 
     # 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 :first_name,            :firstname
+    alias_method :first_name=,           :firstname=
+    alias_method :last_name,             :lastname
+    alias_method :last_name=,            :lastname=
+    alias_method :custom_email_message,  :customEmailMessage
+    alias_method :custom_email_message=, :customEmailMessage=
+
+    #
+    # Converts access rights to human-readable format flag.
+    # @return [Array<Symbol>]
+    #
+    def access_rights
+      convert_byte_to_access_rights @access_rights if @access_rights
+    end
+
+    #
+    # Converts access rights to machine-readable format flag.
+    # @param [Array<Symbol>] rights
+    #
+    def access_rights=(rights)
+      if rights.is_a?(Array)
+        rights = convert_access_rights_to_byte(rights)
+      end
+      @access_rights = rights
+    end
 
     #
     # Converts timestamp which is return by API server to Time object.

data/lib/groupdocs/version.rb

@@ -1,3 +1,3 @@
 module GroupDocs
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end # GroupDocs

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

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe GroupDocs::Api::Helpers::AccessMode do
-
   subject do
     GroupDocs::Storage::Folder.new
   end

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

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe GroupDocs::Api::Helpers::AccessRights do
+  subject do
+    GroupDocs::User.new
+  end
+
+  describe '#convert_access_rights_to_byte' do
+    let(:rights) { %w(export view proof download) }
+
+    it 'raises error if rights is not an array' do
+      -> { subject.send(:convert_access_rights_to_byte, :export) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if right is unknown' do
+      -> { subject.send(:convert_access_rights_to_byte, %w(unknown)) }.should raise_error(ArgumentError)
+    end
+
+    it 'converts each right to Symbol' do
+      rights.each do |right|
+        symbol = right.to_sym
+        right.should_receive(:to_sym).and_return(symbol)
+      end
+      subject.send(:convert_access_rights_to_byte, rights)
+    end
+
+    it 'returns correct byte flag' do
+      subject.send(:convert_access_rights_to_byte, rights).should == 15
+    end
+  end
+
+  describe '#convert_byte_to_access_rights' do
+    let(:rights) { %w(export view proof) }
+
+    it 'raises error if rights is not an integer' do
+      -> { subject.send(:convert_byte_to_access_rights, :export) }.should raise_error(ArgumentError)
+    end
+
+    it 'returns correct rights array flag' do
+      subject.send(:convert_byte_to_access_rights, 13).should =~ rights.map(&:to_sym)
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe GroupDocs::Api::Helpers::ByteFlag do
+  subject do
+    GroupDocs::User.new
+  end
+
+  let(:value_to_byte) { GroupDocs::Api::Helpers::AccessRights::ACCESS_RIGHTS }
+
+  describe '#byte_from_array' do
+    it 'returns correct byte flag' do
+      values = value_to_byte.map { |k, _| k }
+      subject.byte_from_array(values, value_to_byte).should == 15
+    end
+  end
+
+  describe '#array_from_byte' do
+    it 'returns correct byte flag' do
+      values = subject.array_from_byte(15, value_to_byte)
+      values.should =~ value_to_byte.map { |k, _| k }
+    end
+  end
+end

data/spec/groupdocs/document/annotation/reviewer_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe GroupDocs::Document::Annotation::Reviewer do
+
+  it_behaves_like GroupDocs::Api::Entity
+
+  describe '.all!' do
+    before(:each) do
+      mock_api_server(load_json('annotation_reviewers_get'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.all!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns an array of GroupDocs::Document::Annotation::Reviewer objects' do
+      reviewers = described_class.all!
+      reviewers.should be_an(Array)
+      reviewers.each do |reviewer|
+        reviewer.should be_a(GroupDocs::Document::Annotation::Reviewer)
+      end
+    end
+  end
+
+  describe '.set!' do
+    before(:each) do
+      mock_api_server(load_json('annotation_reviewers_get'))
+    end
+
+    let!(:reviewers) { [described_class.new(email_address: 'test@test.com')] }
+
+    it 'accepts access credentials hash' do
+      lambda do
+        described_class.set!(reviewers, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'uses hashed version of reviewers' do
+      reviewers.each do |reviewer|
+        reviewer.should_receive(:to_hash)
+      end
+      described_class.set! reviewers
+    end
+  end
+
+  it { should respond_to(:emailAddress)  }
+  it { should respond_to(:emailAddress=) }
+  it { should respond_to(:FullName)      }
+  it { should respond_to(:FullName=)     }
+
+  it { should have_alias(:email_address, :emailAddress)   }
+  it { should have_alias(:email_address=, :emailAddress=) }
+  it { should have_alias(:full_name, :FullName)           }
+  it { should have_alias(:full_name=, :FullName=)         }
+end

data/spec/groupdocs/document/annotation_spec.rb

@@ -184,50 +184,6 @@ describe GroupDocs::Document::Annotation do
     end
   end
 
-  describe '#collaborators!' do
-    before(:each) do
-      mock_api_server(load_json('annotation_collaborators_get'))
-    end
-
-    it 'accepts access credentials hash' do
-      lambda do
-        subject.collaborators!(client_id: 'client_id', private_key: 'private_key')
-      end.should_not raise_error(ArgumentError)
-    end
-
-    it 'returns an array of GroupDocs::User objects' do
-      users = subject.collaborators!
-      users.should be_an(Array)
-      users.each do |user|
-        user.should be_a(GroupDocs::User)
-      end
-    end
-  end
-
-  describe '#collaborators_set!' do
-    before(:each) do
-      mock_api_server(load_json('annotation_collaborators_set'))
-    end
-
-    it 'accepts access credentials hash' do
-      lambda do
-        subject.collaborators_set!(%w(test1@email.com), client_id: 'client_id', private_key: 'private_key')
-      end.should_not raise_error(ArgumentError)
-    end
-
-    it 'returns an array of GroupDocs::User objects' do
-      users = subject.collaborators_set!(%w(test1@email.com))
-      users.should be_an(Array)
-      users.each do |user|
-        user.should be_a(GroupDocs::User)
-      end
-    end
-
-    it 'is aliased to #collaborators=' do
-      subject.should have_alias(:collaborators=, :collaborators_set!)
-    end
-  end
-
   describe '#remove!' do
     before(:each) do
       mock_api_server(load_json('annotation_remove'))
@@ -265,6 +221,18 @@ describe GroupDocs::Document::Annotation do
     end
   end
 
+  describe '#move_marker!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.move_marker!(10, 10, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+
   describe '#set_access!' do
     before(:each) do
       mock_api_server(load_json('annotation_access_set'))

data/spec/groupdocs/document_spec.rb

@@ -494,6 +494,144 @@ describe GroupDocs::Document do
     end
   end
 
+
+  describe '#collaborators!' do
+    before(:each) do
+      mock_api_server(load_json('annotation_collaborators_get'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.collaborators!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns an array of GroupDocs::User objects' do
+      users = subject.collaborators!
+      users.should be_an(Array)
+      users.each do |user|
+        user.should be_a(GroupDocs::User)
+      end
+    end
+  end
+
+  describe '#set_collaborators!' do
+    before(:each) do
+      mock_api_server(load_json('annotation_collaborators_set'))
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.set_collaborators!(%w(test1@email.com), 1, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'accepts version' do
+      lambda do
+        subject.set_collaborators!(%w(test1@email.com), 1)
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'returns an array of GroupDocs::User objects' do
+      users = subject.set_collaborators!(%w(test1@email.com))
+      users.should be_an(Array)
+      users.each do |user|
+        user.should be_a(GroupDocs::User)
+      end
+    end
+  end
+
+  describe '#add_collaborator!' do
+    before(:each) do
+      mock_api_server(load_json('annotation_collaborators_get'))
+    end
+
+    let!(:collaborator) { GroupDocs::User.new }
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.add_collaborator!(collaborator, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'uses hashed version of collaborator as request body' do
+      collaborator.should_receive(:to_hash)
+      subject.add_collaborator! collaborator
+    end
+
+    it 'raises error if collaborator is not an instance of GroupDocs::User' do
+      -> { subject.add_collaborator!('collaborator') }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe '#set_reviewers!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    let!(:reviewers) { [GroupDocs::User.new, GroupDocs::User.new] }
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.set_reviewers!(reviewers, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'uses hashed version of each reviewer as request body' do
+      reviewers.each do |reviewer|
+        reviewer.should_receive(:to_hash)
+      end
+      subject.set_reviewers! reviewers
+    end
+  end
+
+  describe '#shared_link_access_rights!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": { "accessRights": 15 }}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.shared_link_access_rights!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'converts response byte flag into array of access rights' do
+      subject.should_receive(:convert_byte_to_access_rights).with(15)
+      subject.shared_link_access_rights!
+    end
+
+    it 'returns array of access rights symbols' do
+      access_rights = subject.shared_link_access_rights!
+      access_rights.should be_an(Array)
+      access_rights.each do |access_right|
+        access_right.should be_a(Symbol)
+      end
+    end
+
+    it 'returns empty array if access rights is null' do
+      mock_api_server('{ "status": "Ok", "result": { "accessRights": null }}')
+      subject.shared_link_access_rights!.should be_empty
+    end
+  end
+
+  describe '#set_shared_link_access_rights!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {}}')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.set_shared_link_access_rights!(%w(view), client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
+    it 'converts array of access rights into byte flag' do
+      subject.should_receive(:convert_access_rights_to_byte).with(%w(view))
+      subject.set_shared_link_access_rights! %w(view)
+    end
+  end
+
   describe '#method_missing' do
     it 'passes unknown methods to file object' do
       -> { subject.name }.should_not raise_error(NoMethodError)

data/spec/groupdocs/job_spec.rb

@@ -268,9 +268,51 @@ describe GroupDocs::Job do
       mock_api_server(load_json('job_update'))
     end
 
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.update!({}, client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+
     it 'parses status' do
       subject.should_receive(:parse_status).with(:draft).and_return(-1)
       subject.update!(status: :draft)
     end
   end
+
+  describe '#delete!' do
+    before(:each) do
+      mock_api_server('{ "status": "Ok", "result": {} }')
+    end
+
+    it 'accepts access credentials hash' do
+      lambda do
+        subject.delete!(client_id: 'client_id', private_key: 'private_key')
+      end.should_not raise_error(ArgumentError)
+    end
+  end
+
+  describe '#convert_actions_to_byte' do
+    let(:actions) { %w(convert compare) }
+
+    it 'raises error if actions is not an array' do
+      -> { described_class.convert_actions_to_byte(:export) }.should raise_error(ArgumentError)
+    end
+
+    it 'raises error if action is unknown' do
+      -> { described_class.convert_actions_to_byte(%w(unknown)) }.should raise_error(ArgumentError)
+    end
+
+    it 'converts each action to Symbol' do
+      actions.each do |action|
+        symbol = action.to_sym
+        action.should_receive(:to_sym).and_return(symbol)
+      end
+      described_class.convert_actions_to_byte(actions)
+    end
+
+    it 'returns correct byte flag' do
+      described_class.convert_actions_to_byte(actions).should == 257
+    end
+  end
 end

data/spec/groupdocs/user_spec.rb

@@ -20,46 +20,71 @@ describe GroupDocs::User do
     end
   end
 
-  it { should respond_to(:id)             }
-  it { should respond_to(:id=)            }
-  it { should respond_to(:guid)           }
-  it { should respond_to(:guid=)          }
-  it { should respond_to(:nickname)       }
-  it { should respond_to(:nickname=)      }
-  it { should respond_to(:firstname)      }
-  it { should respond_to(:firstname=)     }
-  it { should respond_to(:lastname)       }
-  it { should respond_to(:lastname=)      }
-  it { should respond_to(:primary_email)  }
-  it { should respond_to(:primary_email=) }
-  it { should respond_to(:private_key)    }
-  it { should respond_to(:private_key=)   }
-  it { should respond_to(:password_salt)  }
-  it { should respond_to(:password_salt=) }
-  it { should respond_to(:claimed_id)     }
-  it { should respond_to(:claimed_id=)    }
-  it { should respond_to(:token)          }
-  it { should respond_to(:token=)         }
-  it { should respond_to(:storage)        }
-  it { should respond_to(:storage=)       }
-  it { should respond_to(:photo)          }
-  it { should respond_to(:photo=)         }
-  it { should respond_to(:active)         }
-  it { should respond_to(:active=)        }
-  it { should respond_to(:news_enabled)   }
-  it { should respond_to(:news_enabled=)  }
-  it { should respond_to(:signed_up_on)   }
-  it { should respond_to(:signed_up_on=)  }
-
-  it { should have_alias(:first_name, :firstname)  }
-  it { should have_alias(:first_name=, :firstname=) }
-  it { should have_alias(:last_name, :lastname)   }
-  it { should have_alias(:last_name=, :lastname=)  }
-
-  it { should have_alias(:pkey=, :private_key=) }
+  it { should respond_to(:id)                  }
+  it { should respond_to(:id=)                 }
+  it { should respond_to(:guid)                }
+  it { should respond_to(:guid=)               }
+  it { should respond_to(:nickname)            }
+  it { should respond_to(:nickname=)           }
+  it { should respond_to(:firstname)           }
+  it { should respond_to(:firstname=)          }
+  it { should respond_to(:lastname)            }
+  it { should respond_to(:lastname=)           }
+  it { should respond_to(:primary_email)       }
+  it { should respond_to(:primary_email=)      }
+  it { should respond_to(:private_key)         }
+  it { should respond_to(:private_key=)        }
+  it { should respond_to(:password_salt)       }
+  it { should respond_to(:password_salt=)      }
+  it { should respond_to(:claimed_id)          }
+  it { should respond_to(:claimed_id=)         }
+  it { should respond_to(:token)               }
+  it { should respond_to(:token=)              }
+  it { should respond_to(:storage)             }
+  it { should respond_to(:storage=)            }
+  it { should respond_to(:photo)               }
+  it { should respond_to(:photo=)              }
+  it { should respond_to(:active)              }
+  it { should respond_to(:active=)             }
+  it { should respond_to(:news_enabled)        }
+  it { should respond_to(:news_enabled=)       }
+  it { should respond_to(:signed_up_on)        }
+  it { should respond_to(:signed_up_on=)       }
+  it { should respond_to(:color)               }
+  it { should respond_to(:color=)              }
+  it { should respond_to(:customEmailMessage)  }
+  it { should respond_to(:customEmailMessage=) }
+
+  it { should have_alias(:first_name, :firstname)                      }
+  it { should have_alias(:first_name=, :firstname=)                    }
+  it { should have_alias(:last_name, :lastname)                        }
+  it { should have_alias(:last_name=, :lastname=)                      }
+  it { should have_alias(:custom_email_message, :customEmailMessage)   }
+  it { should have_alias(:custom_email_message=, :customEmailMessage=) }
+
+  it { should have_alias(:pkey=, :private_key=)        }
   it { should have_alias(:pswd_salt=, :password_salt=) }
   it { should have_alias(:signedupOn=, :signed_up_on=) }
 
+  describe '#access_rights' do
+    it 'returns rights in human-readable format' do
+      subject.instance_variable_set(:@access_rights, 15)
+      subject.access_rights.should =~ [:export, :view, :proof, :download]
+    end
+  end
+
+  describe '#access_rights=' do
+    it 'converts rights in machine-readable format if array is passed' do
+      subject.access_rights = %w(export view proof download)
+      subject.instance_variable_get(:@access_rights).should == 15
+    end
+
+    it 'does nothing if not array is passed' do
+      subject.access_rights = 15
+      subject.instance_variable_get(:@access_rights).should == 15
+    end
+  end
+
   describe '#signed_up_on' do
     it 'returns converted to Time object Unix timestamp' do
       subject.signed_up_on = 1330450135000