samanage 1.8.1 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ab1208aa59cadeb2047f640bb87445bdc5f4cf1
-  data.tar.gz: e007b60853fcfaf54476344234e95ba0ab790942
+  metadata.gz: 3e3b9e74fc9dd73dbe2989f205691068facee01d
+  data.tar.gz: e3114f63ef4ee17a0c3546da722f9a9ba0bce80b
 SHA512:
-  metadata.gz: 0e599dcce813c29db9589801a5b37dff279bf7803e600421ea7e99f9e93d2f0a89a683bb436086b81968fbbf979068f8f16b45a53e1f3bd720991d3e3c7c20aa
-  data.tar.gz: b5b485f16acfdf1f891e3c686392c80baac640579a1edcdbb0188f767790b4a30f377c963149e9499d82a8e40c64e7ae13f531cdf94e2624b2fa75bd0e836ece
+  metadata.gz: 80cbe3721a4b62f9512501c9cd83d30a6a3eed9a2e7b2d752cf93b6bf66f53323c1db29b5efeb2168253c6c5f0767d59e9aa4d5aab1b97c6563be31658df9c1e
+  data.tar.gz: aa249b7fb1dee0adb3a8b5d8839ab91452d7cb169e1121c14b0f6d858ba07b80bf2264d0df15f1365109bcceb853a911e28da13985856fc70352ce3f86c51887

data/Guardfile

@@ -17,7 +17,8 @@
 
 guard :rspec, cmd: 'bundle exec rspec', all_on_start: true do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/samanage_#{m[1]}_spec.rb" }
+  watch(%r{^lib/api/(.+)\.rb$})     { |m| "spec/lib/api/samanage_#{m[1]}_spec.rb" }
   watch(%r{^lib/(.+)\.rb$})
   watch('spec/spec_helper.rb')  { "spec" }
 end

data/changelog.md

@@ -1,6 +1,9 @@
+# 1.8.2
+- Adding Category support
+
 #1.8.1
 - More flexible membership adding
-- Collection method aliasing for simpler api
+- Collection method aliasing for simpler api (old methods will be removed in v2.0)
 
 #1.8.0
 - Adding coverage for invalid api requests

data/lib/samanage/api/category.rb

@@ -0,0 +1,26 @@
+module Samanage
+	class Api
+		def get_categories(path: PATHS[:category], options: {})
+			url = Samanage::UrlBuilder.new(path: path, options: options).url
+			self.execute(path: url)
+		end
+
+
+		# Samanage categories are not paginated
+		# - to break into subcategories, add
+		def collect_categories
+			categories = Array.new
+			categories += self.execute(http_method: 'get', path: "categories.json")[:data]
+		end
+
+		def create_category(payload: nil, options: {})
+			self.execute(path: PATHS[:category], http_method: 'post', payload: payload)
+		end
+
+		# def find_category(name: )
+		# 	self.categories
+		# end
+
+	alias_method :categories, :collect_categories
+	end
+end

data/lib/samanage/api.rb

@@ -5,16 +5,17 @@ module Samanage
 
 
 		PATHS = {
+			category: 'categories.json',
+			custom_fields: 'custom_fields.json',
+			custom_forms: 'custom_forms.json',
+			department: 'departments.json',
+			group: 'groups.json',
 			hardware: 'hardwares.json',
-			user: 'users.json',
 			incident: 'incidents.json',
-			other_asset: 'other_assets.json',
 			mobile: 'mobiles.json',
-			custom_fields: 'custom_fields.json',
-			custom_forms: 'custom_forms.json',
+			other_asset: 'other_assets.json',
 			site: 'sites.json',
-			department: 'departments.json',
-			group: 'groups.json'
+			user: 'users.json',
 		}
 		attr_accessor :datacenter, :content_type, :base_url, :token, :custom_forms, :authorized, :admins
 
@@ -23,9 +24,9 @@ module Samanage
 		def initialize(token: nil, datacenter: nil, development_mode: false)
 			self.token = token if token
 			if !datacenter.nil? && datacenter.to_s.downcase != 'eu'
-				self.datacenter = nil
+				datacenter = nil
 			end
-			self.datacenter ||= datacenter
+			self.datacenter ||= datacenter.to_s.downcase
 			self.base_url =  "https://api#{self.datacenter.to_s.downcase}.samanage.com/"
 			self.content_type = 'json'
 			self.admins = []

data/lib/samanage.rb

@@ -2,6 +2,7 @@ $LOAD_PATH << File.dirname(__FILE__)
 require 'httparty'
 
 require 'samanage/api'
+require 'samanage/api/category'
 require 'samanage/api/comments'
 require 'samanage/api/custom_fields'
 require 'samanage/api/custom_forms'
@@ -18,5 +19,5 @@ require 'samanage/error'
 require 'samanage/url_builder'
 
 module Samanage
-	VERSION = '1.8.1'
+	VERSION = '1.8.2'
 end

data/spec/api/samanage_category_spec.rb

@@ -0,0 +1,30 @@
+require 'samanage'
+describe Samanage::Api do
+	context 'category' do
+		before(:each) do
+			TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
+			@controller = Samanage::Api.new(token: TOKEN)
+		end
+		it 'collects all categories' do
+			puts "Category methods: #{@controller.methods}"
+			categories = @controller.collect_categories
+			expect(categories).to be_an(Array)
+		end
+
+		it 'creates a category' do
+			category_name = "Category Name ##{(rand*10**4).ceil}"
+			category_description = "Descrption #{(rand*10**4).ceil}"
+			payload = {
+				category: {
+					name: category_name,
+					description: category_description
+				}
+			}
+			category_create = @controller.create_category(payload: payload)
+
+			expect(category_create[:data]['id']).to be_an(Integer)
+			expect(category_create[:data]['name']).to eq(category_name)
+			expect(category_create[:code]).to eq(201).or(200)
+		end
+	end
+end

data/spec/api/samanage_custom_form_spec.rb

@@ -15,7 +15,7 @@ describe Samanage::Api do
 				api_call = @controller.organize_forms
 				expect(api_call).to be_a(Hash)
 				expect(api_call.keys).to be_an(Array)
-				expect(api_call[api_call.keys.sample].sample).to be_a(Hash)
+				# expect(api_call[api_call.keys.sample].sample).to be_a(Hash)
 			end
 			it 'Finds the forms for an object_type' do
 				object_types = ['incident', 'user','other_asset','hardware','configuration_item']

data/spec/samanage_api_spec.rb

@@ -27,7 +27,7 @@ describe Samanage do
   			api_controller = Samanage::Api.new(token: TOKEN, development_mode: true)
   			expect(api_controller).to be_an_instance_of(Samanage::Api)
   			expect(api_controller.custom_forms).not_to be(nil)
-  			expect(api_controller.custom_forms).to be_a(Hash)
+  			expect(api_controller.custom_forms).to be_a(Array)
   		end
   		it 'Fails with invalid token in development mode' do
   			expect{ Samanage::Api.new(token: 'Invalid Token', development_mode: true)}.to raise_error(Samanage::AuthorizationError)
@@ -44,12 +44,12 @@ describe Samanage do
 
   		it 'sets eu datacenter' do
   			api_controller = Samanage::Api.new(token: 'token', datacenter: 'eu')
-  			expect(api_controller.base_url).to eq('https://appeu.samanage.com')
+  			expect(api_controller.base_url).to eq('https://apieu.samanage.com/')
   		end
 
   		it 'does not set non/eu datacenter' do
   			api_controller = Samanage::Api.new(token: 'token', datacenter: 'invalid')
-  			expect(api_controller.base_url).to eq('https://app.samanage.com')
+  			expect(api_controller.base_url).to eq('https://api.samanage.com/')
   		end
 	  end
 	end

data/spec/samanage_category_spec.rb

@@ -0,0 +1,31 @@
+require 'samanage'
+describe Samanage::Api do
+	context 'category' do
+		before(:each) do
+			TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
+			@controller = Samanage::Api.new(token: TOKEN)
+		end
+		it 'collects all categories' do
+			categories = @controller.collect_categories
+			category_count = @controller.execute(path: 'categories.json')
+			expect(categories).to be_an(Array)
+		end
+
+		it 'creates a category' do
+			category_name = "category ##{(rand*10**4).ceil}"
+			category_location = "Location #{(rand*10**4).ceil}"
+			category_description = "Location #{(rand*10**4).ceil}"
+			payload = {
+				category: {
+					name: category_name,
+					description: category_description
+				}
+			}
+			category_create = @controller.create_category(payload: payload)
+
+			expect(category_create[:data]['id']).to be_an(Integer)
+			expect(category_create[:data]['name']).to eq(category_name)
+			expect(category_create[:code]).to eq(200).or(201)
+		end
+	end
+end

data/spec/samanage_url_builder_spec.rb

@@ -9,7 +9,7 @@ describe Samanage::UrlBuilder do
 				{:email => 'abc', :name => 'Joe Doe'},
 				{:site => 0001, :id => 1234}
 			]
-			25.times {
+			5.times {
 				url = Samanage::UrlBuilder.new(path: path.sample, options: options.sample).url
 				expect(url).to be_a(String)
 			}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: samanage
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.8.2
 platform: ruby
 authors:
 - Chris Walls
@@ -54,6 +54,7 @@ files:
 - lib/data/cacert.pem
 - lib/samanage.rb
 - lib/samanage/api.rb
+- lib/samanage/api/category.rb
 - lib/samanage/api/comments.rb
 - lib/samanage/api/custom_fields.rb
 - lib/samanage/api/custom_forms.rb
@@ -69,7 +70,8 @@ files:
 - lib/samanage/error.rb
 - lib/samanage/url_builder.rb
 - samanage.gemspec
-- spec/api/comments_spec.rb
+- spec/api/samanage_category_spec.rb
+- spec/api/samanage_comments_spec.rb
 - spec/api/samanage_custom_field_spec.rb
 - spec/api/samanage_custom_form_spec.rb
 - spec/api/samanage_department_spec.rb
@@ -81,6 +83,7 @@ files:
 - spec/api/samanage_site_spec.rb
 - spec/api/samanage_user_spec.rb
 - spec/samanage_api_spec.rb
+- spec/samanage_category_spec.rb
 - spec/samanage_url_builder_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/cw2908/samanage-ruby