samanage 1.6.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 348de2f970605e8f2baeb69c0ca87a7dea845e23
-  data.tar.gz: 8c7ab63ef601c88afac8fe0e6446cf2fa7d8f0a5
+  metadata.gz: 6a868afa190497ef5e1ea3933c827800c6a0b872
+  data.tar.gz: 1795e4fc05003d145f8e4c20fd73240cac497a6e
 SHA512:
-  metadata.gz: 48be69466a5930baf751547391d721f90ae634425c348125c53a0d0ee00d5bc209dc8653b7157cafd3da143adbd36a36e7e92b76df551dd8ff5582ba3994013b
-  data.tar.gz: 55aece4f1e9a4933803213330827ea0fb6702bfe0d14d07bd89b9762a33178a4d722e532a5cfbdafa051c60f44374eaf0990fafb2c008cc006f2a5e696f8b1ea
+  metadata.gz: 55118de925fb9e075bcb4d318076f56a8410c1aa30e99ea6949afd5a7a0b5b977450cb5dfb1df1ca594bd084e11e8cdb14e7636ebb23173e630af4234fb83021
+  data.tar.gz: b504e6330c69bfc77db8c6ed614e8c27e0a60eb5d70a5d31da464de1d728ee4cecba7e6597b0284013c3727c79b07b6196e1dcb3fda17cf4f027f90166284ee6

data/README.md

@@ -1,10 +1,12 @@
 # Samanage Ruby Gem
 [![Gem Version](https://badge.fury.io/rb/samanage.svg)](https://badge.fury.io/rb/samanage)
 ## Requirements
-- Ruby >= 2.0
+- Ruby >= 2.3
+
 
 ## Installation
 `gem install samanage`
+
 #### Linux (CentOS)
 - `sudo yum install gcc-c++`
 - `sudo yum install ruby-devel`
@@ -14,13 +16,22 @@
 
 
 ## Usage
-### Queries
+### Basic Queries
 
 ```ruby
     api_controller = Samanage::Api.new(token: api_token)
-    user_query = api_controller.execute(http_method: 'get',
-     path: 'users.json')
+    user_query = api_controller.execute(http_method: 'get', path: 'users.json')
+```
+
+```ruby
+    incident_data = {incident: { priority: 'Critical' }}.to_json
+    incident_update = api_controller.execute(http_method: 'put', path: 'incidents/123.json', payload: incident_data)
 ```
+
+
+
+
+
 Returns query returns a Hash with keys:
 - `:response`*:* unparsed http response
 - `:code`*:* http status code
@@ -30,6 +41,8 @@ Returns query returns a Hash with keys:
 - `:total_count`*:* Total count of records
 - `:data`*:* Hash containing response body
 
+
+
 ### Function examples
 #### Return all Samanage Users
 ```ruby

data/lib/samanage/api.rb

@@ -9,17 +9,17 @@ module Samanage
 			custom_forms: 'custom_forms.json',
 		}
 		attr_accessor :datacenter, :content_type, :base_url, :token, :custom_forms, :authorized, :admins
-		def initialize(token: '', dacenter: '', development_mode: false)
-			self.token = token
-			self.datacenter = nil || datacenter
+		def initialize(token: nil, dacenter: nil, development_mode: false)
+			self.token = token if token
+			self.datacenter = datacenter if datacenter
 			self.base_url = "https://api#{datacenter}.samanage.com/"
-			# self.content_type = content_type || 'json'
 			self.content_type = 'json'
 			self.admins = []
-			if self.authorized != true
-				self.authorize
-			end
+			# Development mode forzes authorization & prepopulates custom forms/fields and admins
 			if development_mode
+				if self.authorized? != true
+					self.authorize
+				end
 				self.custom_forms = self.organize_forms
 				self.admins = self.list_admins
 			end
@@ -39,7 +39,8 @@ module Samanage
 		end
 
 		# Defaults to GET
-		def execute(http_method: 'get', path: nil, payload: nil, verbose: nil, ssl_fix: false)
+		def execute(http_method: 'get', path: nil, payload: nil, verbose: nil, ssl_fix: false, token: nil)
+			token = token ||= self.token
 			unless verbose.nil?
 				verbose = '?layout=long'
 			end
@@ -47,7 +48,7 @@ module Samanage
 			api_call = HTTP.headers(
 				'Accept' => "application/vnd.samanage.v2.0+#{self.content_type}#{verbose}",
 				'Content-type'  => "application/#{self.content_type}",
-				'X-Samanage-Authorization' => 'Bearer ' + self.token
+				'X-Samanage-Authorization' => 'Bearer ' + token
 			)
 			ctx = OpenSSL::SSL::SSLContext.new
 			if ssl_fix

data/lib/samanage/api/users.rb

@@ -1,18 +1,17 @@
 module Samanage
 	class Api
-		# Returns all users in the account
-
-		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
 
+	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
+  
+  # Returns all users in the account
 		def collect_users
 			page = 1
 			users = Array.new
 			total_pages = self.get_users[:total_pages]
-			# puts api_call
 			while page <= total_pages
 				api_call = self.execute(http_method: 'get', path: "users.json?page=#{page}")
 				users += api_call[:data]
@@ -24,20 +23,23 @@ module Samanage
 		def create_user(payload: nil, options: {})
 			api_call = self.execute(path: PATHS[:user], http_method: 'post', payload: payload)
 			api_call
-		end
-
-		def find_user(id: nil)
+    end
+    
+    # Find user by id
+    def find_user(id: nil)
 			path = "users/#{id}.json"
 			api_call = self.execute(path: path)
 			api_call
 		end
 
+    # 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
 		end
 
+    # Update user by id
 		def update_user(payload: nil, id: nil)
 			path = "users/#{id}.json"
 			puts "Path: #{path}"

data/samanage.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'samanage'
-  s.version     = '1.6.1'
+  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!"
@@ -10,6 +10,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.add_development_dependency 'http', ['~> 2.2']
   s.add_runtime_dependency 'http', ["~> 2.2"]
-  s.homepage    = 'http://rubygems.org/gems/samanage'
+  s.homepage    = 'https://github.com/cw2908/samanage-ruby'
   s.license     = 'MIT'
 end

data/spec/api/samanage_incident_spec.rb

@@ -1,5 +1,4 @@
 require 'samanage'
-
 describe Samanage::Api do
 	context 'Incidents' do
 		describe 'API Functions' do

data/spec/api/samanage_user_spec.rb

@@ -36,10 +36,10 @@ describe Samanage::Api do
 				expect(user_create[:code]).to eq(200).or(201)
 			end
 			it 'create_user: fails if no email' do
-				user_name = "samanage-ruby-#{(rand*10**10).ceil}"
+				user_name = "samanage-ruby-#{(rand*10**(rand(10))).ceil}"
 				json = {
 					:user => {
-						:name => user_name,
+            :name => user_name,
 					}
 				}
 				expect{@controller.create_user(payload: json.to_json)}.to raise_error(Samanage::InvalidRequest)

data/spec/samanage_api_spec.rb

@@ -6,7 +6,10 @@ describe Samanage do
 		end
 	  context 'on creation' do
 	  	it 'Requires Email & Token' do
-	  		expect{ Samanage::Api.new(token: "invalid token") }.to raise_error(Samanage::AuthorizationError)
+	  		expect{ 
+	  			api_controller = Samanage::Api.new(token: "invalid token")
+	  			api_controller.authorize
+	  		}.to raise_error(Samanage::AuthorizationError)
 	  		expect{ Samanage::Api.new(token: TOKEN) }.to_not raise_error
 	  	end
 
@@ -14,8 +17,10 @@ describe Samanage do
 	  		# Valid Credentials
 	  		expect(Samanage::Api.new(token: TOKEN)).to be_an_instance_of(Samanage::Api)
 	  		# Invalid / Reversed Credentials
-				expect{Samanage::Api.new(token: 'invalid')}.to raise_error(Samanage::AuthorizationError)
-				expect(Samanage::Api.new(token: TOKEN).custom_forms).to be(nil)
+				expect{
+					api_controller = Samanage::Api.new(token: 'invalid')
+					api_controller.authorize
+				}.to raise_error(Samanage::AuthorizationError)
   		end
 
   		it 'Finds all custom forms in development mode' do
@@ -24,6 +29,9 @@ describe Samanage do
   			expect(api_controller.custom_forms).not_to be(nil)
   			expect(api_controller.custom_forms).to be_a(Hash)
   		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)
+  		end
 	  end
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samanage
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.2
 platform: ruby
 authors:
 - Chris Walls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2017-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -76,7 +76,7 @@ files:
 - spec/samanage_url_builder_spec.rb
 - spec/spec_helper.rb
 - test.rb
-homepage: http://rubygems.org/gems/samanage
+homepage: https://github.com/cw2908/samanage-ruby
 licenses:
 - MIT
 metadata: {}