ruby-egnyte 0.1.6

data/spec/helper_spec.rb

@@ -0,0 +1,30 @@
+#encoding: UTF-8
+
+require 'spec_helper'
+
+describe Egnyte::Helper do
+  describe "#normalize_path" do
+  	it 'should remove leading and trailing slashes' do
+	    expect(Egnyte::Helper.normalize_path('/banana')).to eq('banana')
+	    expect(Egnyte::Helper.normalize_path('banana/')).to eq('banana')
+	    expect(Egnyte::Helper.normalize_path('/banana/')).to eq('banana')
+	    expect(Egnyte::Helper.normalize_path('banana')).to eq('banana')
+	    expect(Egnyte::Helper.normalize_path('/ban/ana/')).to eq('ban/ana')
+	end
+  end
+
+  describe "#params_to_s" do
+    it 'should convert a parameters hash to an properly formatted params query string' do
+      expect(Egnyte::Helper.params_to_s({email: 'test@egnyte.com'})).to eq "?email=test@egnyte.com"
+      # expect(Egnyte::Helper.params_to_filter_string({authType: 'ad', userType: 'power'})).to eq "?filter=authType%20eq%20%22ad%22&filter=userType%20eq%20%22power%22"
+    end
+  end
+
+  describe "#params_to_filter_string" do
+  	it 'should convert a parameters hash to an Egnyte formatted filter string' do
+  		expect(Egnyte::Helper.params_to_filter_string({email: 'test@egnyte.com'})).to eq "?filter=email eq \"test@egnyte.com\""
+  		expect(Egnyte::Helper.params_to_filter_string({authType: 'ad', userType: 'power'})).to eq "?filter=authType eq \"ad\"&filter=userType eq \"power\""
+  	end
+  end
+
+end

data/spec/links_spec.rb

@@ -0,0 +1,156 @@
+#encoding: UTF-8
+
+require 'spec_helper'
+
+describe Egnyte::Link do
+  before(:each) do
+    @invalid_link_params = {}
+    @valid_folder_link_params = {
+      path: '/Shared/Documents',
+      type: 'folder',
+      accessibility: 'Anyone'
+    }
+    @valid_file_link_params = {
+      path: '/Shared/Documents/test.txt',
+      type: 'file',
+      accessibility: 'Anyone'
+    }
+    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)
+    @folder_link = Egnyte::Link.new(@session, @valid_folder_link_params)
+    @file_link = Egnyte::Link.new(@session, @valid_file_link_params)
+  end
+
+  describe "#initialize" do
+
+    it 'instantiates a valid link if it has all required fields' do
+      expect(@folder_link).to be_valid
+      expect(@file_link).to be_valid
+    end
+
+  end
+
+  context "Posting to Egnyte" do
+
+      before(:each) do
+        stub_request(:post, "https://test.egnyte.com/pubapi/v1/links")
+           .with(:body => @folder_link.to_json,
+                :headers => {'Authorization'=>'Bearer access_token', 'Content-Type'=>'application/json'})
+           .to_return(:status => 201, :body => File.read('./spec/fixtures/link/link_create.json'), :headers => {})
+        stub_request(:get, "https://test.egnyte.com/pubapi/v1/links/jFmtRccgU0")
+           .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 => File.read('./spec/fixtures/link/link.json'), :headers => {})
+      end
+
+    describe "#create" do
+
+      it "should create a new link if valid" do
+        @link = Egnyte::Link.create(@session, @valid_folder_link_params)
+        expect(@link.id).to eq 'jFmtRccgU0'
+      end
+
+      it "should raise an error if it tries to create an invaid link" do
+        expect{ Egnyte::Link.create(@session, @invalid_link_params) }.to raise_error(Egnyte::MissingAttribute)
+      end
+
+    end
+
+    describe "#save" do
+
+      it 'should raise an error if an attribute is missing' do
+        @folder_link.path = nil
+        expect{ @folder_link.save }.to raise_error(Egnyte::MissingAttribute)
+      end
+
+      it 'should save a valid new link object by sending a POST to the Egnyte Link API' do
+        @folder_link = @folder_link.save
+        expect(@folder_link.id).to eq 'jFmtRccgU0'
+        expect(@folder_link.path).to eq '/Shared/Documents'
+      end
+
+    end
+
+  end
+
+  describe "#Link::find" do
+
+    it 'should return an Egnyte::Link object from a link id string' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/links/jFmtRccgU0")
+        .with(:headers => {'Authorization'=>'Bearer access_token'})
+        .to_return(:status => 200, :body => File.read('./spec/fixtures/link/link.json'), :headers => {})
+      link = @client.link('jFmtRccgU0')
+      expect(link).to be_an Egnyte::Link
+      expect(link.id).to eq 'jFmtRccgU0'
+    end
+
+  end
+
+  describe "#Link::all" do
+
+    it 'should list all links' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/links")
+          .with(:headers => { 'Authorization' => 'Bearer access_token' })
+          .to_return(:body => File.read('./spec/fixtures/link/link_list.json'), :status => 200)
+      list = Egnyte::Link.all(@session)
+      expect(list).to be_an Array
+      expect(list.first).to be_a String
+      expect(list.size).to eq 4
+    end
+
+  end
+
+  describe "#Link::where" do
+
+    it 'should find links that match the where filter' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/links?path=/Shared/Documents")
+         .with(:headers => {'Authorization'=>'Bearer access_token'})
+         .to_return(:status => 200, :body => File.read('./spec/fixtures/link/link_list.json'), :headers => {})
+      link_list = Egnyte::Link.where(@session, {path: '/Shared/Documents'})
+      expect(link_list).to be_an Array
+      expect(link_list.size).to eq 4
+      expect(link_list.first).to be_a String
+    end
+
+    it 'should return an empty array if no match is found' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/links?path=/YagniFubar")
+         .with(:headers => {'Authorization'=>'Bearer access_token'})
+         .to_return(:status => 200, :body => File.read('./spec/fixtures/link/link_list_empty.json'), :headers => {})
+      link_list = Egnyte::Link.where(@session, {path: '/YagniFubar'})
+      expect(link_list).to be_an Array
+      expect(link_list.size).to eq 0
+    end
+
+  end
+
+  describe "#User::delete" do
+
+    it 'should delete a link by id if the link exists' do
+      stub_request(:delete, "https://test.egnyte.com/pubapi/v1/links/jFmtRccgU0")
+        .with(:headers => {'Authorization'=>'Bearer access_token'})
+        .to_return(:status => 200, :body => "", :headers => {})
+      expect(Egnyte::User).to receive(:delete)
+      Egnyte::User.delete(@session, 'jFmtRccgU0')
+    end
+    
+  end
+
+  describe "#to_json" do
+
+    it 'should render a valid json representation of a folder link' do
+      expect(@folder_link.to_json).to eq "{\"path\":\"/Shared/Documents\",\"type\":\"folder\",\"accessibility\":\"Anyone\"}"
+    end
+
+    it 'should render a valid json representation of a file link' do
+      expect(@file_link.to_json).to eq "{\"path\":\"/Shared/Documents/test.txt\",\"type\":\"file\",\"accessibility\":\"Anyone\"}"
+    end
+
+  end
+
+end

data/spec/permissions_spec.rb

@@ -0,0 +1,98 @@
+#encoding: UTF-8
+
+require 'spec_helper'
+
+describe Egnyte::Permission do
+  before(:each) do
+    @valid_permission_hash = {
+        "users" => {
+            "david" => "Owner",
+            "dpfeffer" => "Editor"
+        },
+        "groups" => { "Test Group" => "Editor" }
+    }
+    @invalid_permission_hash = {
+        "blah" => { 
+          "david" => "Owner", 
+          "dpfeffer" => "Editor" 
+        }
+    }
+    @lowercase_permission_hash = {
+        "users" => {
+            "david" => "owner",
+            "dpfeffer" => "editor"
+        },
+        "groups" => { "Test Group" => "editor" }
+    }
+    @crazy_permission_hash = {
+        "users" => {
+            "david" => "crazy",
+            "dpfeffer" => "Viewer"
+        },
+        "groups" => { "Test Group" => "perms" }
+    }
+    @valid_permission_structure_from_api = JSON.parse(File.read('./spec/fixtures/permission/permission_list.json'))
+    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)
+    @permission = Egnyte::Permission.new(@valid_permission_hash)
+  end
+
+  describe "#initialize" do
+
+    it 'instantiates a valid permission set if it has all required fields' do
+      expect(@permission.valid?).to be true
+      expect(@permission.has_data?).to be true
+    end
+
+    it 'raises an error if it does not have valid fields' do
+      expect {Egnyte::Permission.new(@invalid_permission_hash)}.to raise_error( Egnyte::InvalidParameters ) 
+    end
+
+    it 'drops invalid permission levels' do
+      @permission = Egnyte::Permission.new(@crazy_permission_hash)
+      expect(@permission.data["users"]["dpfeffer"]).to eq "Viewer"
+      expect(@permission.data["users"]["david"]).to be nil
+    end
+
+    it 'capitalizes the first letter of permission levels' do
+      @permission = Egnyte::Permission.new(@lowercase_permission_hash)
+      expect(@permission.data["users"]["david"]).to eq "Owner"
+    end
+
+    it 'can construct a valid permission listing response from the API' do
+      perm = Egnyte::Permission.build_from_api_listing(@valid_permission_structure_from_api)
+      expect(perm.valid?).to be true
+      expect(perm.has_data?).to be true
+    end
+
+  end
+
+  describe "#to_json" do
+
+    it 'should render a valid json representation of a permission object' do
+      expect(@permission.to_json).to eq "{\"users\":{\"david\":\"Owner\",\"dpfeffer\":\"Editor\"},\"groups\":{\"Test Group\":\"Editor\"}}"
+    end
+
+  end
+
+  describe "#merge" do
+
+    it 'should be able to merge two permission objects' do
+      @permission.merge!({
+          "users" => {
+              "jsmith" => "Owner" ,
+              "jdoe" => "Editor"
+          }
+      })
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'egnyte'
+require 'webmock/rspec'
+
+RSpec.configure do |c|
+  c.filter_run_excluding :skip => true
+  # Use color in STDOUT
+  c.color = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  c.tty = true
+
+  # Use the specified formatter
+  #c.formatter = :progress # :documentation, :html, :textmate
+end

data/spec/user_spec.rb

@@ -0,0 +1,212 @@
+#encoding: UTF-8
+
+require 'spec_helper'
+
+describe Egnyte::User do
+  before(:each) do
+    @invalid_user_params = {}
+    @valid_user_params = {
+      :userName => "userA",
+      :email => "userA@example.com",
+      :name => {
+        :familyName => "A",
+        :givenName => "user"
+      },
+      :authType => "egnyte",
+      :userType => "power",
+      :active => true,
+      :sendInvite => true
+    }
+    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)
+    @user = Egnyte::User.new(@session, @valid_user_params)
+  end
+
+  describe "#initialize" do
+
+    it 'instantiates a valid user if it has all required fields' do
+      expect(@user).to be_valid
+    end
+
+  end
+
+  describe "#create" do
+
+    it "should create a new user if valid" do
+      stub_request(:post, "https://test.egnyte.com/pubapi/v2/users")
+         .with(:body => @user.to_json,
+              :headers => {'Authorization'=>'Bearer access_token', 'Content-Type'=>'application/json'})
+         .to_return(:status => 201, :body => File.read('./spec/fixtures/user/user_create.json'), :headers => {})
+      @user = Egnyte::User.create(@session, @valid_user_params)
+      expect(@user.id).to eq 12163350648
+    end
+
+    it "should raise an error if it tries to create an invaid user" do
+      expect{ Egnyte::User.create(@session, @invalid_user_params) }.to raise_error(Egnyte::MissingAttribute)
+    end
+
+  end
+
+  describe "#save" do
+
+    it 'should raise an error if an attribute is missing' do
+      @user.userName = nil
+      expect{ @user.save }.to raise_error(Egnyte::MissingAttribute)
+    end
+
+    it 'should save a valid new user object by sending a POST to the Egnyte User API' do
+      stub_request(:post, "https://test.egnyte.com/pubapi/v2/users")
+         .with(:body => @user.to_json,
+              :headers => {'Authorization'=>'Bearer access_token', 'Content-Type'=>'application/json'})
+         .to_return(:status => 201, :body => File.read('./spec/fixtures/user/user_create.json'), :headers => {})
+      @user = @user.save
+      expect(@user.id).to eq 12163350648
+    end
+
+    it 'should update an existing user object by sending a PATCH to the Egnyte User API' do
+      stub_request(:patch, "https://test.egnyte.com/pubapi/v2/users/12163350648")
+         .with(:body => @user.to_json_for_update,
+              :headers => {'Authorization'=>'Bearer access_token', 'Content-Type'=>'application/json'})
+         .to_return(:status => 200, :body => File.read('./spec/fixtures/user/user_update.json'), :headers => {})
+      @valid_user_params[:id] = 12163350648
+      @user = Egnyte::User.new(@session, @valid_user_params)
+      @user.save
+    end
+
+  end
+
+  describe "#User::find" do
+
+    it 'should find a user by id if the user exists' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v2/users/12408258604")
+        .with(:headers => {'Authorization'=>'Bearer access_token'})
+        .to_return(:status => 200, :body => File.read('./spec/fixtures/user/user_find.json'), :headers => {})
+      user = @client.user(12408258604)
+      expect(user).to be_an Egnyte::User
+      expect(user.id).to eq 12408258604
+    end
+
+  end
+
+  describe "#User::find_by_email" do
+
+    it 'should find a user by email if the user exists' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v2/users?count=100&filter=email%20eq%20%22afisher@example.com%22&startIndex=1")
+        .with(:headers => {'Authorization'=>'Bearer access_token'})
+        .to_return(:status => 200, :body => File.read('./spec/fixtures/user/user_by_email.json'), :headers => {})
+      user = @client.user_by_email('afisher@example.com')
+      expect(user).to be_an Egnyte::User
+      expect(user.id).to eq 12408258604
+    end
+
+  end
+
+  describe "#User::all" do
+
+    it 'should list all users' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v2/users?count=100&startIndex=1")
+          .with(:headers => { 'Authorization' => 'Bearer access_token' })
+          .to_return(:body => File.read('./spec/fixtures/user/user_all.json'), :status => 200)
+      list = Egnyte::User.all(@session)
+      expect(list).to be_an Array
+      expect(list.first).to be_an Egnyte::User
+      expect(list.size).to eq 50
+    end
+
+  end
+
+  describe "#User::where" do
+
+    it 'should find users that match the where filter' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v2/users?count=100&filter=email%20eq%20%22afisher@example.com%22&startIndex=1")
+         .with(:headers => {'Authorization'=>'Bearer access_token'})
+         .to_return(:status => 200, :body => File.read('./spec/fixtures/user/user_by_email.json'), :headers => {})
+      user_list = Egnyte::User.where(@session, {email: 'afisher@example.com'})
+      expect(user_list).to be_an Array
+      expect(user_list.first).to be_an Egnyte::User
+      expect(user_list.first.id).to eq 12408258604
+      expect(user_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/users?filter=email%20eq%20%22FakeEmailThatDoesNotExist%22&startIndex=1&count=100")
+         .with(:headers => {'Authorization'=>'Bearer access_token'})
+         .to_return(:status => 200, :body => '{"startIndex":1,"totalResults":0,"itemsPerPage":100,"resources":[]}', :headers => {})
+      user_list = Egnyte::User.where(@session, {email: 'FakeEmailThatDoesNotExist'})
+      expect(user_list).to be_an Array
+      expect(user_list.size).to eq 0
+    end
+
+  end
+
+  describe "#User::search" do
+
+    before(:each) do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v2/users?count=100&startIndex=1")
+          .with(:headers => { 'Authorization' => 'Bearer access_token' })
+          .to_return(:body => File.read('./spec/fixtures/user/user_all.json'), :status => 200)
+    end
+
+    it 'should find users that match the search criteria' do
+      user_list = Egnyte::User.search(@session, 'example.com')
+      expect(user_list).to be_an Array
+      expect(user_list.first).to be_an Egnyte::User
+      expect(user_list.size).to eq 50
+    end
+
+    it 'should return an empty array if no match is found' do
+      user_list = Egnyte::User.search(@session, 'NonexistantSearchCriteria')
+      expect(user_list).to be_an Array
+      expect(user_list.size).to eq 0
+    end
+
+  end
+
+  describe "#User::delete" do
+
+    it 'should delete a user by id if the user exists' do
+      stub_request(:delete, "https://test.egnyte.com/pubapi/v2/users/12408258604")
+        .with(:headers => {'Authorization'=>'Bearer access_token'})
+        .to_return(:status => 200, :body => "", :headers => {})
+      expect(Egnyte::User).to receive(:delete).and_return({})
+      Egnyte::User.delete(@session, 12408258604)
+    end
+    
+  end
+
+  describe "#User::links" do
+
+    it 'should find link associated with this user' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v2/users/12408258604")
+        .with(:headers => {'Authorization'=>'Bearer access_token'})
+        .to_return(:status => 200, :body => File.read('./spec/fixtures/user/user_find.json'), :headers => {})
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/links?username=afisher")
+        .with(:headers => {'Authorization'=>'Bearer access_token'})
+        .to_return(:status => 200, :body => File.read('./spec/fixtures/link/link_list.json'), :headers => {})
+      Egnyte::User.links(@session, 12408258604)
+    end
+    
+  end
+
+  describe "#User::permissions" do
+
+    it 'should find link associated with this user' do
+      stub_request(:get, "https://test.egnyte.com/pubapi/v2/users/12408258604")
+        .with(:headers => {'Authorization'=>'Bearer access_token'})
+        .to_return(:status => 200, :body => File.read('./spec/fixtures/user/user_find.json'), :headers => {})
+      stub_request(:get, "https://test.egnyte.com/pubapi/v1/links?username=afisher")
+        .with(:headers => {'Authorization'=>'Bearer access_token'})
+        .to_return(:status => 200, :body => File.read('./spec/fixtures/link/link_list.json'), :headers => {})
+      Egnyte::User.links(@session, 12408258604)
+    end
+    
+  end
+
+end