ruby-egnyte 0.1.6

data/spec/fixtures/user/user_by_email.json

@@ -0,0 +1,27 @@
+{
+	"startIndex":1,
+	"totalResults":1,
+	"itemsPerPage":100,
+	"resources":[
+		{
+			"id":12408258604,
+			"userName":"afisher",
+			"externalId":"afisher",
+			"email":"afisher@example.com",
+			"name":{
+				"formatted":"Alberta Fisher",
+				"familyName":"Fisher",
+				"givenName":"Alberta"
+			},
+			"active":false,
+			"locked":false,
+			"emailChangePending":true,
+			"authType":"sso",
+			"userType":"power",
+			"idpUserId":"afisher",
+			"userPrincipalName":null,
+			"expiryDate":null,
+			"deleteOnExpiry":null
+		}
+	]
+}

data/spec/fixtures/user/user_create.json

@@ -0,0 +1,20 @@
+{
+	"id":12163350648,
+	"userName":"userA",
+	"externalId":null,
+	"email":"userA@example.com",
+	"name":{
+		"formatted":"user A",
+		"familyName":"A",
+		"givenName":"user"
+	},
+	"active":true,
+	"locked":false,
+	"emailChangePending":null,
+	"authType":"egnyte",
+	"userType":"power",
+	"idpUserId":null,
+	"userPrincipalName":null,
+	"expiryDate":null,
+	"deleteOnExpiry":null
+}

data/spec/fixtures/user/user_find.json

@@ -0,0 +1,20 @@
+{
+	"id":12408258604,
+	"userName":"afisher",
+	"externalId":"afisher",
+	"email":"afisher@example.com",
+	"name":{
+		"formatted":"Alberta Fisher",
+		"familyName":"Fisher",
+		"givenName":"Alberta"
+	},
+	"active":false,
+	"locked":false,
+	"emailChangePending":true,
+	"authType":"sso",
+	"userType":"power",
+	"idpUserId":"afisher",
+	"userPrincipalName":null,
+	"expiryDate":null,
+	"deleteOnExpiry":null
+}

data/spec/fixtures/user/user_update.json

@@ -0,0 +1,20 @@
+{
+	"id":12163350648,
+	"userName":"usera",
+	"externalId":"",
+	"email":"userA@example.com",
+	"name":{
+		"formatted":"user A",
+		"familyName":"A",
+		"givenName":"user"
+	},
+	"active":true,
+	"locked":false,
+	"emailChangePending":true,
+	"authType":"egnyte",
+	"userType":"power",
+	"idpUserId":"",
+	"userPrincipalName":null,
+	"expiryDate":null,
+	"deleteOnExpiry":null
+}

data/spec/folder_spec.rb

@@ -0,0 +1,207 @@
+#encoding: UTF-8
+
+require 'spec_helper'
+
+describe Egnyte::Folder do
+  before(:each) do
+    stub_request(:get, "https://test.egnyte.com/pubapi/v1/userinfo").
+             with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'Bearer access_token', 'User-Agent'=>'Ruby'}).
+             to_return(:status => 200, :body => "", :headers => {})
+    @session = Egnyte::Session.new({
+      key: 'api_key',
+      domain: 'test',
+      access_token: 'access_token'
+    }, :implicit, 0.0)
+    @client = Egnyte::Client.new(@session)
+  end
+
+  describe "#upload" do
+    context "when the upload fails (e.g. when the service is unavailable)" do
+      it "raises an appropriate exception" do
+        file_contents = 'Some data.'
+
+        stub_request(:post, "https://test.egnyte.com/pubapi/v1/fs-content/apple/banana/LICENSE.txt")
+          .with(:headers => { 'Authorization' => 'Bearer access_token' }, :body => file_contents)
+          .to_return(:body => '', :status => 503)
+
+          folder = Egnyte::Folder.new({
+            'path' => 'apple/banana',
+            'name' => 'banana'
+          }, @session)
+
+          expect {
+            folder.upload('LICENSE.txt', StringIO.new(file_contents))
+          }.to raise_error(Egnyte::RequestError)
+      end
+    end
+
+    it "upload file to appropriate endpoint, and return a file object" do
+      stub_request(:post, "https://test.egnyte.com/pubapi/v1/fs-content/apple/banana/LICENSE.txt")
+        .with(:headers => { 'Authorization' => 'Bearer access_token' }, :body => File.open('./LICENSE.txt').read)
+        .to_return(:body => '', :status => 200, :headers => {
+          'ETag' => 'c0c6c151-104b-4ddd-a0c7-eea809fc8a6a',
+          'X-Sha512-Checksum' => '434390eddf638ab28e0f4668dca32e4a2b05c96eb3c8c0ca889788e204158cb4f240f1055ebac35745ede0e2349c83b407b9e4e0109bdc0b5ccdfe332a60fcfc',
+          'last_modified' => 'Mon, 05 Aug 2013 22:37:35 GMT'
+        })
+
+      folder = Egnyte::Folder.new({
+        'path' => 'apple/banana',
+        'name' => 'banana'
+      }, @session)
+
+      file = nil
+
+      File.open( './LICENSE.txt' ) do |data|
+        file = folder.upload('LICENSE.txt', data)
+      end
+
+      expect(file.is_folder).to be false
+      expect(file.name).to eq('LICENSE.txt')
+      expect(file.entry_id).to eq('c0c6c151-104b-4ddd-a0c7-eea809fc8a6a')
+      expect(file.checksum).to eq('434390eddf638ab28e0f4668dca32e4a2b05c96eb3c8c0ca889788e204158cb4f240f1055ebac35745ede0e2349c83b407b9e4e0109bdc0b5ccdfe332a60fcfc')
+      expect(file.last_modified).to eq('Mon, 05 Aug 2013 22:37:35 GMT')
+      expect(file.size).to eq(1103)
+    end
+  end
+
+  describe "#create" do
+    it "should call post to fs/path with appropriate payload and return folder object" do
+      stub_request(:post, "https://test.egnyte.com/pubapi/v1/fs/apple/banana/New%20Folder")
+        .with(:headers => { 'Authorization' => 'Bearer access_token' }, :body => JSON.dump({"action" => "add_folder"}))
+        .to_return(:body => '', :status => 200)
+
+      folder = Egnyte::Folder.new({
+        'path' => 'apple/banana',
+        'name' => 'banana'
+      }, @session)
+
+      new_folder = folder.create('New Folder')
+      expect(new_folder.name).to eq('New Folder')
+      expect(new_folder.path).to eq('apple/banana/New Folder')
+      expect(new_folder.folders).to eq([])
+    end
+  end
+
+  describe "Folder::find" do
+    it "should return a folder object if the folder exists" do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/fs/Shared")
+        .with(:headers => { 'Authorization' => 'Bearer access_token' })
+        .to_return(:body => File.read('./spec/fixtures/list_folder.json'), :status => 200)
+
+      expect(@client.folder.name).to eq('docs')
+    end
+
+    it "should raise FileOrFolderNotFound error for a non-existent folder" do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/fs/banana")
+        .with(:headers => { 'Authorization' => 'Bearer access_token' })
+        .to_return(:status => 404)
+
+      expect {@client.folder('banana')}.to raise_error( Egnyte::RecordNotFound )
+    end
+
+    it "should raise FolderExpected if path to file provided" do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/fs/Shared")
+        .with(:headers => { 'Authorization' => 'Bearer access_token' })
+        .to_return(:body => File.read('./spec/fixtures/list_file.json'), :status => 200)
+
+      expect {@client.folder}.to raise_error( Egnyte::FolderExpected )
+    end
+  end
+
+  describe "Folder::permissions" do
+    it "should return a folder permissions object if the folder exists" do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/fs/Shared")
+        .with(:headers => { 'Authorization' => 'Bearer access_token' })
+        .to_return(:body => File.read('./spec/fixtures/list_folder.json'), :status => 200)
+      expect(@client.folder.name).to eq('docs')
+    end
+
+    it "should raise FileOrFolderNotFound error for a non-existent folder" do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/fs/banana")
+        .with(:headers => { 'Authorization' => 'Bearer access_token' })
+        .to_return(:status => 404)
+
+      expect {@client.folder('banana')}.to raise_error( Egnyte::RecordNotFound )
+    end
+
+    it "should raise FolderExpected if path to file provided" do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/fs/Shared")
+        .with(:headers => { 'Authorization' => 'Bearer access_token' })
+        .to_return(:body => File.read('./spec/fixtures/list_file.json'), :status => 200)
+
+      expect {@client.folder}.to raise_error( Egnyte::FolderExpected )
+    end
+  end
+
+  describe "#files" do
+    it "should return an array of file objects" do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/fs/Shared")
+        .with(:headers => { 'Authorization' => 'Bearer access_token' })
+        .to_return(:body => File.read('./spec/fixtures/list_folder.json'), :status => 200)
+
+      folder = @client.folder
+      file = folder.files.first
+      expect(file).to be_instance_of(Egnyte::File)
+      expect(file.path).to eq('Shared/test.txt')
+    end
+
+    it "should return an empty array if there arent any files in the folder" do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/fs/Shared")
+        .with(:headers => { 'Authorization' => 'Bearer access_token' })
+        .to_return(:body => File.read('./spec/fixtures/folder_listing_no_files.json'), :status => 200)
+
+      folder = @client.folder
+      files = folder.files
+      expect(files.size).to eq(0)
+    end
+  end
+
+  describe "#folders" do
+    it "should return an array of file objects" do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/fs/Shared")
+        .with(:headers => { 'Authorization' => 'Bearer access_token' })
+        .to_return(:body => File.read('./spec/fixtures/list_folder.json'), :status => 200)
+
+      folder = @client.folder
+      file = folder.folders.first
+      expect(file).to be_instance_of(Egnyte::Folder)
+      expect(file.path).to eq('Shared/subfolder1')
+    end
+  end
+
+  context "permissions" do
+    before(:each) do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/fs/Shared")
+        .with(:headers => { 'Authorization' => 'Bearer access_token' })
+        .to_return(:body => File.read('./spec/fixtures/list_folder.json'), :status => 200)
+    end
+
+    describe "#permissions" do
+      it "should returned a parsed list permissions" do
+        stub_request(:get, "https://test.egnyte.com/pubapi/v1/perms/folder/Shared")
+          .with(:headers => { 'Authorization' => 'Bearer access_token' })
+          .to_return(:body => File.read('./spec/fixtures/permission/permission_list.json'), :status => 200)
+        folder = Egnyte::Folder.find(@session, 'Shared')
+        permissions = folder.permissions
+        expect(permissions.class).to eq Egnyte::Permission
+        expect(permissions.data['groups'].size).to eq 2
+        expect(permissions.data['users'].size).to eq 66
+        expect(permissions.data['users']['knikolaus']).to eq "Owner"
+      end
+    end
+
+    describe "#apply_permission" do
+      it "should call the apply method in Egnyte::Permission" do
+        stub_request(:post, "https://test.egnyte.com/pubapi/v1/perms/folder/Shared")
+          .with(:headers => { 'Authorization' => 'Bearer access_token' })
+          .to_return(:body => "", :status => 200)
+        perm_obj = Egnyte::Permission.build_from_api_listing({'users' => [{'subject' => 'thintz', 'permission' => 'Viewer'}]})
+        folder = Egnyte::Folder.find(@session, 'Shared')
+        expect(Egnyte::Permission).to receive(:apply)
+        folder.apply_permissions(perm_obj)
+      end
+    end
+
+  end
+
+end

data/spec/group_spec.rb

@@ -0,0 +1,166 @@
+require 'spec_helper'
+
+describe Egnyte::Group do
+  before(:each) do
+    @invalid_group_params = {}
+    @valid_group_params = {
+      :displayName => "Test with members",
+      :members => [9967960066, 9967960068]
+    }
+    stub_request(:get, "https://test.egnyte.com/pubapi/v1/userinfo").
+             with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'Bearer access_token', 'User-Agent'=>'Ruby'}).
+             to_return(:status => 200, :body => "", :headers => {})
+    @session = Egnyte::Session.new({
+      key: 'api_key',
+      domain: 'test',
+      access_token: 'access_token'
+    }, :implicit, 0.0)
+    @client = Egnyte::Client.new(@session)
+    @group = Egnyte::Group.new(@session, @valid_group_params)
+    @group2 = Egnyte::Group.new(@session, "Test without members")
+  end
+
+  describe "#initialize" do
+
+    it 'instantiates a valid group if only a name is provided' do
+      expect(@group).to be_valid
+    end
+
+    it 'instantiates a valid group if a name and group members are provided' do
+      expect(@group2).to be_valid
+    end
+
+  end
+
+  describe "#create" do
+
+    it "should create a new group if valid" do
+      stub_request(:post, "https://test.egnyte.com/pubapi/v2/groups")
+        .with(:body => @group.to_json_for_api_call,
+              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'Bearer access_token', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'})
+        .to_return(:status => 201, :body => File.read('./spec/fixtures/group/group_create.json'), :headers => {})
+      @group = Egnyte::Group.create(@session, @valid_group_params)
+      expect(@group.id).to eq "5ef70bb0-edeb-4fcb-86d4-e1e1a0b6c9dc"
+    end
+
+    it "should raise an error if it tries to create an invaid group" do
+      expect{ Egnyte::Group.create(@session, @invalid_group_params) }.to raise_error(Egnyte::MissingAttribute)
+    end
+
+  end
+
+  describe "#save" do
+
+    it 'should raise an error if an attribute is missing' do
+      @group.displayName = nil
+      expect{ @group.save }.to raise_error(Egnyte::MissingAttribute)
+    end
+
+    it 'should save a valid new group object by sending a POST to the Egnyte Group API' do
+      stub_request(:post, "https://test.egnyte.com/pubapi/v2/groups")
+        .with(:body => @group.to_json_for_api_call,
+              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'Bearer access_token', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'})
+        .to_return(:status => 201, :body => File.read('./spec/fixtures/group/group_create.json'), :headers => {})
+      @group = @group.save
+      expect(@group.id).to eq "5ef70bb0-edeb-4fcb-86d4-e1e1a0b6c9dc"
+    end
+
+    it 'should update an existing group object by sending a PUT to the Egnyte Group API' do
+      stub_request(:put, "https://test.egnyte.com/pubapi/v2/groups/5ef70bb0-edeb-4fcb-86d4-e1e1a0b6c9dc")
+         .with(:body => @group.to_json_for_api_call,
+              :headers => {'Authorization'=>'Bearer access_token', 'Content-Type'=>'application/json'})
+         .to_return(:status => 200, :body => File.read('./spec/fixtures/group/group_create.json'), :headers => {})
+      @valid_group_params[:id] = "5ef70bb0-edeb-4fcb-86d4-e1e1a0b6c9dc"
+      @group = Egnyte::Group.new(@session, @valid_group_params)
+      @group.save
+    end
+
+  end
+
+  describe "#Group::find" do
+
+    it 'should find a group by id if the group exists' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v2/groups/5ef70bb0-edeb-4fcb-86d4-e1e1a0b6c9dc")
+        .with(:headers => {'Authorization'=>'Bearer access_token'})
+        .to_return(:status => 200, :body => File.read('./spec/fixtures/group/group_create.json'), :headers => {})
+      @group = @client.group('5ef70bb0-edeb-4fcb-86d4-e1e1a0b6c9dc')
+      expect(@group).to be_an Egnyte::Group
+      expect(@group.id).to eq '5ef70bb0-edeb-4fcb-86d4-e1e1a0b6c9dc'
+    end
+
+  end
+
+  describe "#Groups::all" do
+
+    it 'should list all users' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v2/groups?count=100&startIndex=1")
+          .with(:headers => { 'Authorization' => 'Bearer access_token' })
+          .to_return(:body => File.read('./spec/fixtures/group/group_all.json'), :status => 200)
+      list = Egnyte::Group.all(@session)
+      expect(list).to be_an Array
+      expect(list.first).to be_an Egnyte::Group
+      expect(list.size).to eq 3
+    end
+
+  end
+
+  describe "#Group::where" do
+
+    it 'should find groups that match the where filter' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v2/groups?count=100&filter=displayName%20eq%20%22Finance%22&startIndex=1")
+         .with(:headers => {'Authorization'=>'Bearer access_token'})
+         .to_return(:status => 200, :body => File.read('./spec/fixtures/group/group_by_parameter.json'), :headers => {})
+      group_list = Egnyte::Group.where(@session, {displayName: "Finance"})
+      expect(group_list).to be_an Array
+      expect(group_list.first).to be_an Egnyte::Group
+      expect(group_list.first.id).to eq "d5ea2e76-63e4-4b47-92af-0d7ba6972e3c"
+      expect(group_list.size).to eq 1
+    end
+
+    it 'should return an empty array if no match is found' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v2/groups?count=100&filter=displayName%20eq%20%22FakeEmailThatDoesNotExist%22&startIndex=1")
+         .with(:headers => {'Authorization'=>'Bearer access_token'})
+         .to_return(:status => 200, :body => File.read('./spec/fixtures/group/group_by_parameter_empty.json'), :headers => {})
+      group_list = Egnyte::Group.where(@session, {displayName: "FakeEmailThatDoesNotExist"})
+      expect(group_list).to be_an Array
+      expect(group_list.size).to eq 0
+    end
+
+  end
+
+  describe "#User::search" do
+
+    before(:each) do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v2/groups?count=100&startIndex=1")
+          .with(:headers => { 'Authorization' => 'Bearer access_token' })
+          .to_return(:body => File.read('./spec/fixtures/group/group_all.json'), :status => 200)
+    end
+
+    it 'should find users that match the search criteria' do
+      user_list = Egnyte::Group.search(@session, "Fin")
+      expect(user_list).to be_an Array
+      expect(user_list.first).to be_an Egnyte::Group
+      expect(user_list.size).to eq 1
+    end
+
+    it 'should return an empty array if no match is found' do
+      user_list = Egnyte::Group.search(@session, 'NonexistantSearchCriteria')
+      expect(user_list).to be_an Array
+      expect(user_list.size).to eq 0
+    end
+
+  end
+
+  describe "#Group::delete" do
+
+    it 'should delete a group by id if the group exists' do
+      stub_request(:delete, "https://test.egnyte.com/pubapi/v2/groups/5ef70bb0-edeb-4fcb-86d4-e1e1a0b6c9dc")
+        .with(:headers => {'Authorization'=>'Bearer access_token'})
+        .to_return(:status => 200, :body => "", :headers => {})
+      expect(Egnyte::User).to receive(:delete).and_return({})
+      Egnyte::User.delete(@session, "5ef70bb0-edeb-4fcb-86d4-e1e1a0b6c9dc")
+    end
+    
+  end
+
+end