samanage 1.7.5 → 1.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 830811e5f34c766e6daf4366e1367a5d1a25bb2e
-  data.tar.gz: 0d0d2823495fefb862cde5acc354a44f733491e0
+  metadata.gz: 2dcaf45e80af6697cc02ed71271c47f35cafbaba
+  data.tar.gz: adbb18edb16566748da8bd0d10f2659fb1989fb8
 SHA512:
-  metadata.gz: 431ad262a4afbf8423f0f5f6250e6090b1f60c1f959374e5a1356bcb58932c2d49242fb97cb8c0fbd95eac78280a905369de93ae39a88389c365abeb18669a3e
-  data.tar.gz: 913374957d83cebed467421d8d488f1375a347943e92c72cc6a663a9ede29fbb627e8a513723d9534af2a4139ad9351e09c64c8d2909660d8f978411ee39f84c
+  metadata.gz: 253b6ed89aa71a09502d8feb86bb656aec49c9296a67263312778dcb64cf21ecd6573ebe0ed5a5a16f7e882cc8cbe4c8cd4348374e9db5ddd18ca0aa104a36a7
+  data.tar.gz: 8d46136866bb6db7bd66c91ef07dffe589c32693acd01456e40891de62bf1caa1134b6cddfe65501c3220f50ae4348253b3fdb0c42c53c1609c8348fe4881f99

data/changelog.md

@@ -1,3 +1,6 @@
+#1.7.6
+- Adding group_id find methods for group name and user email
+
 #1.7.5
 - Adding site, department, group creation
 

data/lib/samanage/api/groups.rb

@@ -21,6 +21,18 @@ module Samanage
 			self.execute(path: PATHS[:group], http_method: 'post', payload: payload)
 		end
 
+		def find_group_id_by_name(group: nil)
+			group_api = self.execute(path: "groups.json?name=#{group}")
+			if group_api[:data].size == 1 && group.to_s.downcase == group_api[:data].first['name'].to_s.downcase
+				return group_api[:data].first['id']
+			end
+		end
+
+		def find_group(id: nil)
+			path = "groups/#{id}.json"
+			self.execute(path: path)
+		end
+
 		def add_member_to_group(email: nil, group_id: nil)
 			user_id = self.find_user_id_by_email(email: email)
 			member_path = "memberships.json?group_id=#{group_id}.json&user_ids=#{user_id}"

data/lib/samanage/api/users.rb

@@ -6,7 +6,7 @@ module Samanage
 	def get_users(path: PATHS[:user], options: {})
     url = Samanage::UrlBuilder.new(path: path, options: options).url
     self.execute(path: url)
-   end
+	end
 
   # Returns all users in the account
 		def collect_users
@@ -37,8 +37,24 @@ module Samanage
 			api_call.dig(:data).first.to_h.dig('email').to_s.downcase == email.to_s.downcase ? api_call.dig(:data).first.dig('id') : nil
 		end
 
+		# Returns nil if no matching group_id
+		def find_user_group_id_by_email(email: nil)
+			user = self.check_user(value: email)
+			group_ids = user[:data].select{|u| u['email'] == email}.first['group_ids']
+			group_ids.each do |group_id|
+				group = self.find_group(id: group_id)
+				if group[:data]['is_user'] && email == group[:data]['email']
+					return group_id
+				end
+			end
+			return
+		end
+
     # Check for user by field (ex: users.json?field=value)
 		def check_user(field: 'email', value: nil)
+			if field.to_s.downcase == 'email'
+				value = value.gsub("+",'%2B')
+			end
 			url = "users.json?#{field}=#{value}"
 			self.execute(path: url)
 		end

data/samanage.gemspec

@@ -1,7 +1,7 @@
 $:.push File.expand_path("../lib", __FILE__)
 Gem::Specification.new do |s|
   s.name                    = 'samanage'
-  s.version                 = '1.7.5'
+  s.version                 = '1.7.6'
   s.date                    =  Date.today.strftime("%Y-%m-%d")
   s.summary                 = "Samanage Ruby Gem"
   s.description             = "Connect to Samanage using Ruby!"

data/spec/api/samanage_group_spec.rb

@@ -19,8 +19,15 @@ describe Samanage::Api do
 			expect(groups).to be_an(Array)
 			expect(groups.size).to eq(group_count)
 		end
+		it 'find_group: returns a group card by known id' do
+			groups = @controller.collect_groups
+			sample_id = groups.sample['id']
+			group = @controller.find_group(id: sample_id)
+			expect(group[:data]['id']).to eq(sample_id)  # id should match found group
+			expect(group[:data]).to have_key('name')
+		end
 		it 'creates a group' do
-			group_name = "Group Name ##{(rand*10**4).ceil}"
+			group_name = "Group Name #{(rand*10**4).ceil}"
 			group_description = "Description #{(rand*10**4).ceil}"
 			payload = {
 				group: {
@@ -34,6 +41,15 @@ describe Samanage::Api do
 			expect(group_create[:data]['name']).to eq(group_name)
 			expect(group_create[:code]).to eq(200).or(201)
 		end
+
+		it 'finds a group by name' do
+			group = @controller.collect_groups.sample
+			group_name = group['name']
+			group_id = group['id']
+			found_group_id = @controller.find_group_id_by_name(group: group_name)
+
+			expect(group_id).to eq(found_group_id)
+		end
 		it 'adds member to group' do
 			random_group_id = @controller.collect_groups.sample['id']
 			random_user_email = @controller.collect_users.sample['email']

data/spec/api/samanage_site_spec.rb

@@ -29,7 +29,6 @@ describe Samanage::Api do
 					description: site_description
 				}
 			}
-			puts "Payload: #{payload.inspect}"
 			site_create = @controller.create_site(payload: payload)
 
 			expect(site_create[:data]['id']).to be_an(Integer)

data/spec/api/samanage_user_spec.rb

@@ -69,6 +69,23 @@ describe Samanage::Api do
 				expect(sample_id).to eq(found_id)
 			end
 
+			it 'finds group_id for user' do
+				users = @controller.collect_users
+				sample_user = users.select{|u| u['role']['name'] == 'Administrator'}.sample
+				sample_user_email = sample_user['email']
+				group_ids = sample_user['group_ids']
+				found_id = nil
+
+				group_ids.each do |group_id|
+					group = @controller.find_group(id: group_id)
+					if group[:data]['is_user'] && sample_user_email == group[:data]['email']
+						found_id ||= group_id
+					end
+				end
+				function_id = @controller.find_user_group_id_by_email(email: sample_user_email)
+
+				expect(function_id).to eq(found_id)
+			end
 			it 'update_user: update_user by id' do
 				users = @controller.collect_users
 				sample_id = users.sample['id']

data/spec/samanage_api_spec.rb

@@ -6,7 +6,7 @@ describe Samanage do
 		end
 	  context 'on creation' do
 	  	it 'Requires Email & Token' do
-	  		expect{ 
+	  		expect{
 	  			api_controller = Samanage::Api.new(token: "invalid token")
 	  			api_controller.authorize
 	  		}.to raise_error(Samanage::AuthorizationError)
@@ -37,9 +37,7 @@ describe Samanage do
   		it 'Finds Admins' do
   			api_controller = Samanage::Api.new(token: TOKEN, development_mode: true)
   			admins = api_controller.list_admins
-  			puts "Admins were; #{admins}"
   			admin_email = admins.sample.gsub('+',"%2B")
-  			puts "Sampled Admin: #{admin_email}"
   			samanage_admin = api_controller.execute(path: "users.json?email=#{admin_email}")
   			expect(samanage_admin[:data].first['role']['name']).to eq('Administrator')
   		end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: samanage
 version: !ruby/object:Gem::Version
-  version: 1.7.5
+  version: 1.7.6
 platform: ruby
 authors:
 - Chris Walls