samanage 1.6.2 → 1.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a868afa190497ef5e1ea3933c827800c6a0b872
-  data.tar.gz: 1795e4fc05003d145f8e4c20fd73240cac497a6e
+  metadata.gz: b1ee27251b28d9f40d4d55f4c0cc15a7edb6bc3a
+  data.tar.gz: 2041f972113561267d319d7aed592ebc961dc418
 SHA512:
-  metadata.gz: 55118de925fb9e075bcb4d318076f56a8410c1aa30e99ea6949afd5a7a0b5b977450cb5dfb1df1ca594bd084e11e8cdb14e7636ebb23173e630af4234fb83021
-  data.tar.gz: b504e6330c69bfc77db8c6ed614e8c27e0a60eb5d70a5d31da464de1d728ee4cecba7e6597b0284013c3727c79b07b6196e1dcb3fda17cf4f027f90166284ee6
+  metadata.gz: a21c0270079f3cb74d05b900467cc1f1a200dc669bff48b7bac62fa4ce39b20793c79069b5125981b4e9fcfbd636a0f830e080ea52bd23094f52331a4445cf09
+  data.tar.gz: e213eb9303ed3ed60fae82b876170b0cddd69850b6b2e30fc3254f36385faa10755192e5ef9d590275491e92078da83397b55a0265d3a4c08cee3c496bbec163

data/.gitignore

@@ -1,3 +1,7 @@
 tmp/*
 ./test.rb
-*.gem
+*.gem
+.gitignore
+.DS_STORE
+*.DS_STORE
+*/**.DS_STORE

data/README.md

@@ -18,21 +18,34 @@
 ## Usage
 ### Basic Queries
 
+Initialize API controller
 ```ruby
-    api_controller = Samanage::Api.new(token: api_token)
-    user_query = api_controller.execute(http_method: 'get', path: 'users.json')
+    api_controller = Samanage::Api.new(token: 'abc123')
 ```
 
+- Find a user by email
+```ruby
+    user_query = api_controller.execute(http_method: 'get', path: 'users.json?email=example@gmail.com')
+```
+
+
+- Update incident by ID
 ```ruby
     incident_data = {incident: { priority: 'Critical' }}.to_json
     incident_update = api_controller.execute(http_method: 'put', path: 'incidents/123.json', payload: incident_data)
 ```
 
+- Update hardware
+```ruby
+hardware = {'hardware':{'name':'My Computer'}}
+result = api_controller.update_hardware(id: 123, payload: hardware)
+```
+
 
 
 
 
-Returns query returns a Hash with keys:
+Executing an api query will return a Hash with the following keys:
 - `:response`*:* unparsed http response
 - `:code`*:* http status code
 - `:json`*:* Samanage API json response
@@ -43,15 +56,4 @@ Returns query returns a Hash with keys:
 
 
 
-### Function examples
-#### Return all Samanage Users
-```ruby
-users = api_controller.collect_users
-```
-
-#### Update hardware
-```ruby
-hardware = {'hardware':{'name':'My Computer'}}
-result = api_controller.update_hardware(id: 123, payload: hardware)
-```
 

data/lib/samanage/api/hardwares.rb

@@ -30,6 +30,12 @@ module Samanage
 			api_call
 		end
 
+		def find_hardwares_by_serial(serial_number: nil)
+			path = "hardwares.json?serial_number[]=#{serial_number}"
+			api_call = self.execute(path: path)
+			api_call
+		end
+
 		def check_hardware(options: {})
 			url = Samanage::UrlBuilder.new(path: PATHS[:hardware], options: options).url
 			puts "Url: #{url}"

data/lib/samanage/api/requester.rb

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

@@ -6,7 +6,7 @@ module Samanage
     api_call = self.execute(path: url)
     api_call
   end
-  
+
   # Returns all users in the account
 		def collect_users
 			page = 1
@@ -24,7 +24,7 @@ module Samanage
 			api_call = self.execute(path: PATHS[:user], http_method: 'post', payload: payload)
 			api_call
     end
-    
+
     # Find user by id
     def find_user(id: nil)
 			path = "users/#{id}.json"
@@ -32,6 +32,12 @@ module Samanage
 			api_call
 		end
 
+		# Email is unique so compare first for exact match only. Return [nil..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
+		end
+
     # Check for user by field (ex: users.json?field=value)
 		def check_user(field: 'email', value: nil)
 			url = "users.json?#{field}=#{value}"

data/samanage.gemspec

@@ -1,15 +1,16 @@
 Gem::Specification.new do |s|
-  s.name        = 'samanage'
-  s.version     = '1.6.2'
-  s.date        =  Date.today.strftime("%Y-%m-%d")
-  s.summary     = "Samanage Ruby Gem"
-  s.description = "Connect to Samanage using Ruby!"
-  s.authors     = ["Chris Walls"]
-  s.email       = 'cwalls2908@gmail.com'
-  s.files       = `git ls-files`.split("\n")
-  s.require_paths = ["lib"]
+  s.name                    = 'samanage'
+  s.version                 = '1.6.5'
+  s.date                    =  Date.today.strftime("%Y-%m-%d")
+  s.summary                 = "Samanage Ruby Gem"
+  s.description             = "Connect to Samanage using Ruby!"
+  s.authors                 = ["Chris Walls"]
+  s.email                   = 'cwalls2908@gmail.com'
+  s.files                   = `git ls-files`.split("\n")
+  s.homepage                = 'https://github.com/cw2908/samanage-ruby'
+  s.license                 = 'MIT'
+  s.require_paths           = ["lib"]
+  s.required_ruby_version   = '>= 2.3'
   s.add_development_dependency 'http', ['~> 2.2']
-  s.add_runtime_dependency 'http', ["~> 2.2"]
-  s.homepage    = 'https://github.com/cw2908/samanage-ruby'
-  s.license     = 'MIT'
+  s.add_runtime_dependency 'http', ['~> 2.2']
 end

data/spec/api/samanage_hardware_spec.rb

@@ -58,6 +58,19 @@ describe Samanage::Api do
 				sample_id = (0..10).entries.sample
 				expect{@controller.find_hardware(id: sample_id)}.to raise_error(Samanage::NotFound)  # id should match found hardware
 			end
+
+			it 'finds_hardwares_by_serial' do
+				hardwares = @controller.collect_hardwares
+				sample_hardware = hardwares.sample
+				sample_serial_number = sample_hardware['serial_number']
+				sample_id = sample_hardware['id']
+				found_assets = @controller.find_hardwares_by_serial(serial_number: sample_serial_number)
+				found_sample = found_assets[:data].sample
+				expect(sample_serial_number).not_to be(nil)
+				expect(found_sample['serial_number']).not_to be(nil)
+				expect(found_sample['serial_number']).to eq(sample_serial_number)
+				# expect(sample_id).to eq(found_assets[:data].first.dig('id'))
+			end
 			it 'update_hardware: update_hardware by id' do
 				hardwares = @controller.collect_hardwares
 				sample_id = hardwares.sample['id']

data/spec/api/samanage_user_spec.rb

@@ -52,10 +52,23 @@ describe Samanage::Api do
 				expect(user[:data]).to have_key('email')
 				expect(user[:data]).to have_key('name')
 			end
+
+
 			it 'find_user: returns nothing for an invalid id' do
 				sample_id = (0..10).entries.sample
 				expect{@controller.find_user(id: sample_id)}.to raise_error(Samanage::NotFound)  # id should match found user
 			end
+
+			it 'finds_user_id_by_email' do
+				users = @controller.collect_users
+				sample_user = users.sample
+				sample_email = sample_user['email']
+				sample_id = sample_user['id']
+				found_id = @controller.find_user_id_by_email(email: sample_email)
+				expect(sample_email).not_to be(nil)
+				expect(sample_id).to eq(found_id)
+			end
+
 			it 'update_user: update_user by id' do
 				users = @controller.collect_users
 				sample_id = users.sample['id']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samanage
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.5
 platform: ruby
 authors:
 - Chris Walls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -44,16 +44,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
-- lib/.DS_Store
 - lib/samanage.rb
-- lib/samanage/.DS_Store
 - lib/samanage/api.rb
 - lib/samanage/api/custom_fields.rb
 - lib/samanage/api/custom_forms.rb
@@ -88,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -96,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Samanage Ruby Gem