samanage 1.6.8 → 1.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e1600c1cfe1aeb6437bafbf11b7dde1a559ced4
-  data.tar.gz: '029fc5d74874c982203171dc618facef9d36876f'
+  metadata.gz: dd423983751b04925ffae9682558c704a9264b07
+  data.tar.gz: e03159f0fefc436de87abd20522ce42e293c31af
 SHA512:
-  metadata.gz: dbf34b7680c92d9974d1bd09a196a8e4b9944f12ce1dae03cd116f1c8daa22abe67e46c56869baa12a6989a2ee43ea6c9355f771f1d582e95a1e8b39d3ce5186
-  data.tar.gz: f69601824dda579f8d9adcb69b31ac453636ccf903d9db130ebb98208776a9538c512d79126dd01eabc2144eeed6325054d485835f51039aadc7529b445261a1
+  metadata.gz: 13117b118b758a29d7441b9a03d4cf2582b4579c5c4110e2bc5b886b1bdb6656dbf01c02dfe10390df07cc667b874c7dfd3d6b83285ee9ee6d69b31c3720d0e1
+  data.tar.gz: cf10be0fdb93b0cb35b09a309f4c6c1aa5f5ecee8b848d253139b7fcd26f76387cfd7559da51d1ebdc7116127dad37e262b086c94675a6f9abbdbec768f037e0

data/README.md

@@ -1,5 +1,6 @@
 # Samanage Ruby Gem
 [![Gem Version](https://badge.fury.io/rb/samanage.svg)](https://badge.fury.io/rb/samanage)
+[![Build Status](https://semaphoreci.com/api/v1/projects/8e1f8e7f-6e09-4dad-ac10-e9f41fa61b7d/1437435/shields_badge.svg)](https://semaphoreci.com/cw2908/samanage-ruby)
 ## Requirements
 - Ruby >= 2.3
 
@@ -37,7 +38,7 @@ Initialize API controller
 
 - Update hardware
 ```ruby
-hardware = {'hardware':{'name':'My Computer'}}
+hardware = {'hardware':{'name':'My Computer'}}.to_json
 result = api_controller.update_hardware(id: 123, payload: hardware)
 ```
 

data/changelog.txt

@@ -0,0 +1 @@
+1.6.9 Added CRU support for Mobile Devices

data/lib/samanage.rb

@@ -6,6 +6,7 @@ require 'samanage/api/users'
 require 'samanage/api/requester'
 require 'samanage/api/hardwares'
 require 'samanage/api/other_assets'
+require 'samanage/api/mobiles'
 require 'samanage/api/incidents'
 require 'samanage/api/comments'
 require 'samanage/api/custom_fields'

data/lib/samanage/api.rb

@@ -5,6 +5,7 @@ module Samanage
 			user: 'users.json',
 			incident: 'incidents.json',
 			other_asset: 'other_assets.json',
+			mobile: 'mobiles.json',
 			custom_fields: 'custom_fields.json',
 			custom_forms: 'custom_forms.json',
 		}
@@ -100,8 +101,8 @@ module Samanage
 				error = e.class
 				response = nil
 				raise Samanage::Error.new(error: error, response: response)
-		# Always return response hash
-		response
+			# Always return response hash
+			response
 		end
 
 

data/lib/samanage/api/comments.rb

@@ -5,15 +5,13 @@ module Samanage
 		# Find comments given incident_id
 		def get_comments(incident_id: )
 			path = "incidents/#{incident_id}/comments.json"
-			api_call = self.execute(path: path)
-			api_call
+			self.execute(path: path)
 		end
 
 		# Add a new comment
 		def create_comment(incident_id: nil, comment: nil, options: {})
 			path = "incidents/#{incident_id}/comments.json"
-			api_call = self.execute(http_method: 'post', path: path, payload: comment)
-			api_call
+			self.execute(http_method: 'post', path: path, payload: comment)
 		end
 
 		# Return all comments from the incident_id
@@ -24,8 +22,7 @@ module Samanage
 			comments = Array.new
 			while page <= max_pages
 				path = "incidents/#{incident_id}/comments.json?page=#{page}"
-				api_call = self.execute(path: path)
-				comments += api_call[:data]
+				comments += self.execute(path: path)[:data]
 				page += 1
 			end
 			comments

data/lib/samanage/api/custom_fields.rb

@@ -4,8 +4,7 @@ module Samanage
 		# Get custom fields default url
 		def get_custom_fields(path: PATHS[:custom_fields], options:{})
 			url = Samanage::UrlBuilder.new(path: path, options: options).url
-			api_call = self.execute(path: url)
-			api_call
+			self.execute(path: url)
 		end
 
 		# Gets all custom fields
@@ -14,8 +13,7 @@ module Samanage
 			custom_fields = Array.new
 			total_pages = self.get_custom_fields[:total_pages] ||= 2
 			while page <= total_pages
-				api_call = self.execute(path: "custom_fields.json")
-				custom_fields += api_call[:data]
+				custom_fields += self.execute(path: "custom_fields.json")[:data]
 				page += 1
 			end
 			custom_fields

data/lib/samanage/api/custom_forms.rb

@@ -3,8 +3,7 @@ module Samanage
 		# Get custom forms path
 		def get_custom_forms(path: PATHS[:custom_forms], options: {})
 			url = Samanage::UrlBuilder.new(path: path, options: options).url
-			api_call = self.execute(path: url)
-			api_call
+			self.execute(path: url)
 		end
 
 		# Get all custom forms
@@ -12,10 +11,8 @@ module Samanage
 			page = 1
 			custom_forms = Array.new
 			total_pages = self.get_custom_forms[:total_pages]
-			# puts api_call
 			while page <= total_pages
-				api_call = self.execute(http_method: 'get', path: "custom_forms.json?page=#{page}")
-				custom_forms += api_call[:data]
+				custom_forms += self.execute(http_method: 'get', path: "custom_forms.json?page=#{page}")[:data]
 				page += 1
 			end
 			custom_forms

data/lib/samanage/api/hardwares.rb

@@ -4,8 +4,7 @@ module Samanage
 		# Get hardware default path
 		def get_hardwares(path: PATHS[:hardware], options: {})
 			url = Samanage::UrlBuilder.new(path: path, options: options).url
-			api_call = self.execute(path: url)
-			api_call
+			self.execute(path: url)
 		end
 
 		# Get all hardwares
@@ -13,10 +12,8 @@ module Samanage
 			page = 1
 			hardwares = Array.new
 			total_pages = self.get_hardwares[:total_pages]
-			# puts api_call
 			while page <= total_pages
-				api_call = self.execute(http_method: 'get', path: "hardwares.json?page=#{page}")
-				hardwares += api_call[:data]
+				hardwares += self.execute(http_method: 'get', path: "hardwares.json?page=#{page}")[:data]
 				page += 1
 			end
 			hardwares
@@ -24,38 +21,32 @@ module Samanage
 
 		# Create hardware given json payload
 		def create_hardware(payload: nil, options: {})
-			api_call = self.execute(path: PATHS[:hardware], http_method: 'post', payload: payload)
-			api_call
+			self.execute(path: PATHS[:hardware], http_method: 'post', payload: payload)
 		end
 
 		# Find hardware given id
 		def find_hardware(id: nil)
 			path = "hardwares/#{id}.json"
-			api_call = self.execute(path: path)
-			api_call
+			self.execute(path: path)
 		end
 
 		# Find hardware given a serial number
 		def find_hardwares_by_serial(serial_number: nil)
 			path = "hardwares.json?serial_number[]=#{serial_number}"
-			api_call = self.execute(path: path)
-			api_call
+			self.execute(path: path)
 		end
 
 
 		# Check for hardware using URL builder
 		def check_hardware(options: {})
 			url = Samanage::UrlBuilder.new(path: PATHS[:hardware], options: options).url
-			puts "Url: #{url}"
-			api_call = self.execute(path: url)
-			api_call
+			self.execute(path: url)
 		end
 
 		# Update hardware given id
 		def update_hardware(payload: nil, id: nil, options: {})
 			path = "hardwares/#{id}.json"
-			api_call = self.execute(path: path, http_method: 'put', payload: payload)
-			api_call
+			self.execute(path: path, http_method: 'put', payload: payload)
 		end
 	end
 end

data/lib/samanage/api/incidents.rb

@@ -4,8 +4,7 @@ module Samanage
 		# Default get incident path
 		def get_incidents(path: PATHS[:incident], options: {})
 			url = Samanage::UrlBuilder.new(path: path, options: options).url
-			api_call = self.execute(path: url)
-			api_call
+			self.execute(path: url)
 		end
 
 
@@ -14,10 +13,8 @@ module Samanage
 			page = 1
 			incidents = Array.new
 			total_pages = self.get_incidents[:total_pages]
-			# puts api_call
 			while page <= total_pages
-				api_call = self.execute(http_method: 'get', path: "incidents.json?page=#{page}")
-				incidents += api_call[:data]
+				incidents += self.execute(http_method: 'get', path: "incidents.json?page=#{page}")[:data]
 				page += 1
 			end
 			incidents
@@ -26,22 +23,19 @@ module Samanage
 
 		# Create an incident given json
 		def create_incident(payload: nil, options: {})
-			api_call = self.execute(path: PATHS[:incident], http_method: 'post', payload: payload)
-			api_call
+			self.execute(path: PATHS[:incident], http_method: 'post', payload: payload)
 		end
 
 		# Find incident by ID
 		def find_incident(id: nil)
 			path = "incidents/#{id}.json"
-			api_call = self.execute(path: path)
-			api_call
+			self.execute(path: path)
 		end
 
 		# Update an incident given id and json
 		def update_incident(payload: nil, id: nil, options: {})
 			path = "incidents/#{id}.json"
-			api_call = self.execute(path: path, http_method: 'put', payload: payload)
-			api_call
+			self.execute(path: path, http_method: 'put', payload: payload)
 		end
 	end
 end

data/lib/samanage/api/mobiles.rb

@@ -0,0 +1,45 @@
+module Samanage
+	class Api
+
+		# Get mobile default path
+		def get_mobiles(path: PATHS[:mobile], options: {})
+			url = Samanage::UrlBuilder.new(path: path, options: options).url
+			self.execute(path: url)
+		end
+
+		# Get all mobiles
+		def collect_mobiles
+			page = 1
+			mobiles = Array.new
+			total_pages = self.get_mobiles[:total_pages]
+			while page <= total_pages
+				mobiles += self.execute(http_method: 'get', path: "mobiles.json?page=#{page}")[:data]
+				page += 1
+			end
+			mobiles
+		end
+
+		# Create mobile given json payload
+		def create_mobile(payload: nil, options: {})
+			self.execute(path: PATHS[:mobile], http_method: 'post', payload: payload)
+		end
+
+		# Find mobile given id
+		def find_mobile(id: nil)
+			path = "mobiles/#{id}.json"
+			self.execute(path: path)
+		end
+		
+		# Check for mobile using URL builder
+		def check_mobile(options: {})
+			url = Samanage::UrlBuilder.new(path: PATHS[:mobile], options: options).url
+			self.execute(path: url)
+		end
+
+		# Update mobile given id
+		def update_mobile(payload: nil, id: nil, options: {})
+			path = "mobiles/#{id}.json"
+			self.execute(path: path, http_method: 'put', payload: payload)
+		end
+	end
+end

data/lib/samanage/api/other_assets.rb

@@ -4,8 +4,7 @@ module Samanage
 		# Default get other_assets path
 		def get_other_assets(path: PATHS[:other_asset], options: {})
 			url = Samanage::UrlBuilder.new(path: path, options: options).url
-			api_call = self.execute(path: url)
-			api_call
+			self.execute(path: url)
 		end
 
 		# Returns all other assets
@@ -13,11 +12,9 @@ module Samanage
 			page = 1
 			other_assets = Array.new
 			total_pages = self.get_other_assets[:total_pages]
-			# puts api_call
 			other_assets = []
 			while page <= total_pages
-				api_call = self.execute(http_method: 'get', path: "other_assets.json?page=#{page}")
-				other_assets += api_call[:data]
+				other_assets += self.execute(http_method: 'get', path: "other_assets.json?page=#{page}")[:data]
 				page += 1
 			end
 			other_assets.uniq
@@ -26,23 +23,20 @@ module Samanage
 
 		# Create an other_asset given json
 		def create_other_asset(payload: nil, options: {})
-			api_call = self.execute(path: PATHS[:other_asset], http_method: 'post', payload: payload)
-			api_call
+			self.execute(path: PATHS[:other_asset], http_method: 'post', payload: payload)
 		end
 
 
 		# Find other_asset by id
 		def find_other_asset(id: nil)
 			path = "other_assets/#{id}.json"
-			api_call = self.execute(path: path)
-			api_call
+			self.execute(path: path)
 		end
 
  		# Update other_asset given json and id
 		def update_other_asset(payload: nil, id: nil, options: {})
 			path = "other_assets/#{id}.json"
-			api_call = self.execute(path: path, http_method: 'put', payload: payload)
-			api_call
+			self.execute(path: path, http_method: 'put', payload: payload)
 		end
 	end
 end

data/lib/samanage/api/requester.rb

@@ -3,8 +3,7 @@ module Samanage
 		# Get requester from value (email)
 		def get_requester_id(value: nil)
 			api_call = self.execute(path: "requesters.json?name=#{value}")
-			requester = api_call[:data].size == 1 ? api_call[:data][0] : nil
-			requester
+			api_call[:data].size == 1 ? api_call[:data][0] : nil
 		end
 	end
 end

data/lib/samanage/api/users.rb

@@ -5,9 +5,8 @@ module Samanage
 	# Get users, using URL builder
 	def get_users(path: PATHS[:user], options: {})
     url = Samanage::UrlBuilder.new(path: path, options: options).url
-    api_call = self.execute(path: url)
-    api_call
-  end
+    self.execute(path: url)
+   end
 
   # Returns all users in the account
 		def collect_users
@@ -15,8 +14,7 @@ module Samanage
 			users = Array.new
 			total_pages = self.get_users[:total_pages]
 			while page <= total_pages
-				api_call = self.execute(http_method: 'get', path: "users.json?page=#{page}")
-				users += api_call[:data]
+				users += self.execute(http_method: 'get', path: "users.json?page=#{page}")[:data]
 				page += 1
 			end
 			users
@@ -24,15 +22,13 @@ module Samanage
 
 		# Create user given JSON
 		def create_user(payload: nil, options: {})
-			api_call = self.execute(path: PATHS[:user], http_method: 'post', payload: payload)
-			api_call
-    end
+			self.execute(path: PATHS[:user], http_method: 'post', payload: payload)
+		end
 
     # Return user by ID
     def find_user(id: nil)
 			path = "users/#{id}.json"
-			api_call = self.execute(path: path)
-			api_call
+			self.execute(path: path)
 		end
 
 		# Email is unique so compare first for exact match only. Returns nil or the id
@@ -44,15 +40,13 @@ module Samanage
     # Check for user by field (ex: users.json?field=value)
 		def check_user(field: 'email', value: nil)
 			url = "users.json?#{field}=#{value}"
-			api_call = self.execute(path: url)
-			api_call
+			self.execute(path: url)
 		end
 
     # Update user by id
 		def update_user(payload: nil, id: nil)
 			path = "users/#{id}.json"
-			api_call = self.execute(path: path, http_method: 'put', payload: payload)
-			api_call
+			self.execute(path: path, http_method: 'put', payload: payload)
 		end
 	end
 end

data/lib/samanage/url_builder.rb

@@ -27,6 +27,8 @@ module Samanage
 				url += 'custom_fields'
 			when /custom_form/
 				url += 'custom_forms'
+			when /mobile/
+				url += 'mobiles'
 			end
 
 			if path.match(/(\d)+/)

data/lib/test.rb

@@ -1,4 +1,4 @@
 require_relative 'samanage'
-# require 'awesome_print'
+require 'awesome_print'
 
 api_controller = Samanage::Api.new(token: ENV['SAMANAGE_TEST_API_TOKEN'],  development_mode: true)

data/samanage.gemspec

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

data/spec/api/comments_spec.rb

@@ -30,8 +30,6 @@ describe Samanage::Api do
 				incident_id = 19394209
 				comments_api = @controller.get_comments(incident_id: incident_id)
 				comments_found = @controller.collect_comments(incident_id: incident_id)
-				# puts "comments api size: #{comments_api.inspect}"
-				# puts "Found Comments: #{comments_found.size}"
 
 				# Total count bug
 				# expect(comments_api[:total_count]).to eq(comments_found.size)

data/spec/api/samanage_incident_spec.rb

@@ -21,7 +21,6 @@ describe Samanage::Api do
 			end
 			it 'create_incident(payload: json): creates a incident' do
 				users_email = @controller.collect_users.sample['email']
-				serial_number = (0...50).map { ('a'..'z').to_a[rand(26)] }.join
 				incident_name = "Samanage Ruby Incident"
 				json = {
 					:incident => {
@@ -62,15 +61,16 @@ describe Samanage::Api do
 			end
 			it 'update_incident: update_incident by id' do
 				incidents = @controller.collect_incidents
-				sample_id = incidents.sample['id']
-				new_name = (0...50).map { ('a'..'z').to_a[rand(26)] }.join
+				sample_incident = incidents.reject{|i| ['Closed','Resolved'].include? i['state']}.sample
+				sample_id = sample_incident['id']
+				description = (0...500).map { ('a'..'z').to_a[rand(26)] }.join
 				incident_json = {
 					:incident => {
-						:name => new_name
+						:description => description
 					}
 				}
 				incident_update = @controller.update_incident(payload: incident_json.to_json, id: sample_id)
-				expect(incident_update[:data]["name"]).to eq(new_name)
+				expect(incident_update[:data]['description']).to eq(description)
 				expect(incident_update[:code]).to eq(200).or(201)
 			end
 		end

data/spec/api/samanage_mobile_spec.rb

@@ -0,0 +1,77 @@
+require 'samanage'
+
+describe Samanage::Api do
+	context 'Mobile' do
+		describe 'API Functions' do
+			before(:each) do
+				TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
+				@controller = Samanage::Api.new(token: TOKEN)
+			end
+			it 'get_mobiles: it returns API call of mobiles' do
+				api_call = @controller.get_mobiles
+				expect(api_call).to be_a(Hash)
+				expect(api_call[:total_count]).to be_an(Integer)
+				expect(api_call).to have_key(:response)
+				expect(api_call).to have_key(:code)
+			end
+			it 'collect_mobiles: collects array of mobiles' do
+				mobiles = @controller.collect_mobiles
+				mobile_count = @controller.get_mobiles[:total_count]
+				expect(mobiles).to be_an(Array)
+				expect(mobiles.size).to eq(mobile_count)
+			end
+			it 'create_mobile(payload: json): creates a mobile' do
+				mobile_name = "samanage-ruby-#{(rand*10**10).ceil}"
+				serial_number = (0...50).map { ('a'..'z').to_a[rand(26)] }.join
+				json = {
+					:mobile => {
+						model: 'test',
+						manufacturer: mobile_name,
+						serial_number:  serial_number,
+					}
+				}
+				mobile_create = @controller.create_mobile(payload: json.to_json)
+
+				expect(mobile_create[:data]['id']).to be_an(Integer)
+				expect(mobile_create[:data]['manufacturer']).to eq(mobile_name)
+			end
+			it 'create_mobile: fails if no serial' do
+				mobile_name = "samanage-ruby-#{(rand*10**10).ceil}"
+				json = {
+					:mobile => {
+						model: 'test',
+						manufacturer: mobile_name,
+					}
+				}
+				expect{@controller.create_mobile(payload: json.to_json)}.to raise_error(Samanage::InvalidRequest)
+			end
+			it 'find_mobile: returns a mobile card by known id' do
+				mobiles = @controller.collect_mobiles
+				sample_id = mobiles.sample['id']
+				mobile = @controller.find_mobile(id: sample_id)
+
+				expect(mobile[:data]['id']).to eq(sample_id)  # id should match found mobile
+				expect(mobile[:data]).to have_key('manufacturer')
+				expect(mobile[:data]).to have_key('serial_number')
+				expect(mobile[:data]).to have_key('id')
+			end
+			it 'find_mobile: returns nothing for an invalid id' do
+				sample_id = (0..10).entries.sample
+				expect{@controller.find_mobile(id: sample_id)}.to raise_error(Samanage::NotFound)  # id should match found mobile
+			end
+			it 'update_mobile: update_mobile by id' do
+				mobiles = @controller.collect_mobiles
+				sample_id = mobiles.sample['id']
+				new_name = (0...50).map {('a'..'z').to_a[rand(26)] }.join
+				json = {
+					:mobile => {
+						:manufacturer => new_name
+					}
+				}
+				mobile_update = @controller.update_mobile(payload: json.to_json, id: sample_id)
+				expect(mobile_update[:data]["manufacturer"]).to eq(new_name)
+				expect(mobile_update[:code]).to eq(200).or(201)
+			end
+		end
+	end
+end

data/spec/api/samanage_other_asset_spec.rb

@@ -50,9 +50,6 @@ describe Samanage::Api do
 
 			it 'find_other_asset: returns an other_asset card by known id' do
 				other_assets = @controller.collect_other_assets
-				puts "Found ##{other_assets.size} other assets"
-				puts ".sample ##{other_assets.sample}"
-				puts ".sample['id'] ##{other_assets.sample['id']}"
 				sample_id = other_assets.sample['id']
 
 				other_asset = @controller.find_other_asset(id: sample_id)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samanage
 version: !ruby/object:Gem::Version
-  version: 1.6.8
+  version: 1.6.9
 platform: ruby
 authors:
 - Chris Walls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-10 00:00:00.000000000 Z
+date: 2017-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -58,6 +58,7 @@ files:
 - lib/samanage/api/custom_forms.rb
 - lib/samanage/api/hardwares.rb
 - lib/samanage/api/incidents.rb
+- lib/samanage/api/mobiles.rb
 - lib/samanage/api/other_assets.rb
 - lib/samanage/api/requester.rb
 - lib/samanage/api/users.rb
@@ -70,12 +71,12 @@ files:
 - spec/api/samanage_custom_form_spec.rb
 - spec/api/samanage_hardware_spec.rb
 - spec/api/samanage_incident_spec.rb
+- spec/api/samanage_mobile_spec.rb
 - spec/api/samanage_other_asset_spec.rb
 - spec/api/samanage_user_spec.rb
 - spec/samanage_api_spec.rb
 - spec/samanage_url_builder_spec.rb
 - spec/spec_helper.rb
-- test.rb
 homepage: https://github.com/cw2908/samanage-ruby
 licenses:
 - MIT

data/test.rb

@@ -1,5 +0,0 @@
-require_relative 'lib/samanage'
-require 'awesome_print'
-api_controller = Samanage::Api.new(token: ENV['SAMANAGE_TEST_API_TOKEN'])
-ap api_controller
-api_controller.collect_users