samanage 1.6.7 → 1.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a54ddc950e0e6cac420f3993849c31938243d5c2
-  data.tar.gz: 59711d40b30ae8085be861e41fa7298351a31521
+  metadata.gz: 6e1600c1cfe1aeb6437bafbf11b7dde1a559ced4
+  data.tar.gz: '029fc5d74874c982203171dc618facef9d36876f'
 SHA512:
-  metadata.gz: 5679aa41e37f5de3eded0e1f526c938a0fa55f466462816ca4eda6ca165f609ec947179197f46638a759562d751429486c0b6439cb0a44025244606a9092a0c8
-  data.tar.gz: 9a18fe328a045081d5343427804fc2aa7885473ebc4fb2010ac83dd1c67b7977a88bad8e7acf6cf10cc84f2b91e6f11c6b997d96d5e49ae30fe85a35d7976839
+  metadata.gz: dbf34b7680c92d9974d1bd09a196a8e4b9944f12ce1dae03cd116f1c8daa22abe67e46c56869baa12a6989a2ee43ea6c9355f771f1d582e95a1e8b39d3ce5186
+  data.tar.gz: f69601824dda579f8d9adcb69b31ac453636ccf903d9db130ebb98208776a9538c512d79126dd01eabc2144eeed6325054d485835f51039aadc7529b445261a1

data/lib/samanage/api/comments.rb

@@ -1,18 +1,22 @@
 module Samanage
 	class Api
 
+
+		# Find comments given incident_id
 		def get_comments(incident_id: )
 			path = "incidents/#{incident_id}/comments.json"
 			api_call = self.execute(path: path)
 			api_call
 		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
 		end
 
+		# Return all comments from the incident_id
 		def collect_comments(incident_id: nil)
 
 			page = 1

data/lib/samanage/api/custom_fields.rb

@@ -1,10 +1,14 @@
 module Samanage
 	class Api
+
+		# 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
 		end
+
+		# Gets all custom fields
 		def collect_custom_fields
 			page = 1
 			custom_fields = Array.new

data/lib/samanage/api/custom_forms.rb

@@ -1,11 +1,13 @@
 module Samanage
 	class Api
+		# 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
 		end
 
+		# Get all custom forms
 		def collect_custom_forms
 			page = 1
 			custom_forms = Array.new
@@ -19,6 +21,7 @@ module Samanage
 			custom_forms
 		end
 
+		# Set forms by type and map fields
 		def organize_forms
 			custom_forms = self.collect_custom_forms
 			custom_forms.map{|form| form.delete_if{|k, v| v.nil?}}
@@ -31,6 +34,8 @@ module Samanage
 					}
 				}
 		end
+
+		# Get form for a specific object type
 		def form_for(object_type: nil)
 			if self.custom_forms == nil
 				self.custom_forms = self.organize_forms

data/lib/samanage/api/hardwares.rb

@@ -1,11 +1,14 @@
 module Samanage
 	class Api
+
+		# 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
 		end
 
+		# Get all hardwares
 		def collect_hardwares
 			page = 1
 			hardwares = Array.new
@@ -19,23 +22,28 @@ module Samanage
 			hardwares
 		end
 
+		# 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
 		end
 
+		# Find hardware given id
 		def find_hardware(id: nil)
 			path = "hardwares/#{id}.json"
 			api_call = self.execute(path: path)
 			api_call
 		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
 		end
 
+
+		# Check for hardware using URL builder
 		def check_hardware(options: {})
 			url = Samanage::UrlBuilder.new(path: PATHS[:hardware], options: options).url
 			puts "Url: #{url}"
@@ -43,7 +51,7 @@ module Samanage
 			api_call
 		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)

data/lib/samanage/api/incidents.rb

@@ -1,11 +1,15 @@
 module Samanage
 	class Api
+
+		# 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
 		end
 
+
+		# Returns all incidents
 		def collect_incidents
 			page = 1
 			incidents = Array.new
@@ -19,17 +23,21 @@ module Samanage
 			incidents
 		end
 
+
+		# 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
 		end
 
+		# Find incident by ID
 		def find_incident(id: nil)
 			path = "incidents/#{id}.json"
 			api_call = self.execute(path: path)
 			api_call
 		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)

data/lib/samanage/api/other_assets.rb

@@ -1,11 +1,14 @@
 module Samanage
 	class Api
+
+		# 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
 		end
 
+		# Returns all other assets
 		def collect_other_assets
 			page = 1
 			other_assets = Array.new
@@ -20,17 +23,22 @@ module Samanage
 			other_assets.uniq
 		end
 
+
+		# 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
 		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
 		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)

data/lib/samanage/api/requester.rb

@@ -1,6 +1,7 @@
 module Samanage
 	class Api
-		def get_requester_id(value: nil, name: nil, email: nil)
+		# 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

data/lib/samanage/api/users.rb

@@ -1,6 +1,8 @@
 module Samanage
 	class Api
 
+
+	# 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)
@@ -20,19 +22,20 @@ module Samanage
 			users
 		end
 
+		# 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
 
-    # Find user by id
+    # Return user by ID
     def find_user(id: nil)
 			path = "users/#{id}.json"
 			api_call = self.execute(path: path)
 			api_call
 		end
 
-		# Email is unique so compare first for exact match only. Return [nil..id]
+		# Email is unique so compare first for exact match only. Returns nil or the id
 		def find_user_id_by_email(email: nil)
 			api_call = self.check_user(value: email)
 			api_call.dig(:data).first.to_h.dig('email').to_s.downcase == email.to_s.downcase ? api_call.dig(:data).first.dig('id') : nil

data/lib/samanage/api.rb

@@ -9,13 +9,18 @@ module Samanage
 			custom_forms: 'custom_forms.json',
 		}
 		attr_accessor :datacenter, :content_type, :base_url, :token, :custom_forms, :authorized, :admins
-		def initialize(token: nil, dacenter: nil, development_mode: false)
+
+		# Development mode forzes authorization & prepopulates custom forms/fields and admins
+		# datacenter should equal 'eu' or blank
+		def initialize(token: nil, datacenter: nil, development_mode: false)
 			self.token = token if token
+			if !datacenter.nil? && datacenter.to_s.downcase != 'eu'
+				datacenter = nil
+			end
 			self.datacenter = datacenter if datacenter
 			self.base_url = "https://api#{datacenter}.samanage.com/"
 			self.content_type = 'json'
 			self.admins = []
-			# Development mode forzes authorization & prepopulates custom forms/fields and admins
 			if development_mode
 				if self.authorized? != true
 					self.authorize
@@ -29,6 +34,7 @@ module Samanage
 			self.authorized
 		end
 
+		# Check token against api.json
 		def authorize
 			self.execute(path: 'api.json')
 			rescue OpenSSL::SSL::SSLError => e
@@ -38,7 +44,7 @@ module Samanage
 			self.authorized = true
 		end
 
-		# Defaults to GET
+		# Calling execute without a method defaults to GET
 		def execute(http_method: 'get', path: nil, payload: nil, verbose: nil, ssl_fix: false, token: nil)
 			token = token ||= self.token
 			unless verbose.nil?
@@ -98,6 +104,8 @@ module Samanage
 		response
 		end
 
+
+		# Return all admins in the account
 		def list_admins
 			admin_role_id = self.execute(path: 'roles.json').select{|role| role['name'] == 'Administrator'}['id']
 			self.admins.push(

data/lib/samanage/error.rb

@@ -12,16 +12,12 @@ module Samanage
 	end
 
 	# API Errors
-	class SamanageError < Error
-	end
+	class SamanageError < Error; end
 
-	class AuthorizationError < SamanageError
-	end
+	class AuthorizationError < SamanageError; end
 
-	class InvalidRequest < SamanageError
-	end
+	class InvalidRequest < SamanageError; end
 
-	class NotFound < SamanageError
-	end
+	class NotFound < SamanageError; end
 
 end

data/lib/samanage/url_builder.rb

@@ -2,6 +2,7 @@ module Samanage
 	class UrlBuilder
 		attr_accessor :url
 		@url = ''
+
 		def initialize(path: nil,options: nil)
 			self.url =  map_path(path: path, options: options)
 			return url

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.7'
+  s.version                 = '1.6.8'
   s.date                    =  Date.today.strftime("%Y-%m-%d")
   s.summary                 = "Samanage Ruby Gem"
   s.description             = "Connect to Samanage using Ruby!"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: samanage
 version: !ruby/object:Gem::Version
-  version: 1.6.7
+  version: 1.6.8
 platform: ruby
 authors:
 - Chris Walls
@@ -50,6 +50,7 @@ files:
 - Guardfile
 - LICENSE
 - README.md
+- changelog.txt
 - lib/samanage.rb
 - lib/samanage/api.rb
 - lib/samanage/api/comments.rb