samanage 1.8.3 → 1.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1a73bd9d0ecff83e8c95ca29b389260d73eb3e7
-  data.tar.gz: b2a98bff4c554c017ac670f172981676a3ac9128
+  metadata.gz: 8eb0f2b3c57cf1e5b9b79b22c49f0d8e413c9c36
+  data.tar.gz: fd23d7f431814e09ca1f354e25fffeca6d1d124b
 SHA512:
-  metadata.gz: 0caa861127343267e8c33fe1a730acdf48a722244a2c9464178d9445d60576ed92e85ce9b1dd5cc1db7f53ec24590663cc8c8c35f61a4edbcdf91386f5874ccc
-  data.tar.gz: ddc7ad10f2e7f6f1642b08dd5d18d745d0956600b24fb6532a46c9049d83197e0098fdbc559aca3048b1874697edffe7dace52c57cc341bc0371d9ad43925a37
+  metadata.gz: f7fd9bcaf93c48131728a25c93f038489e993c5f26e53981592e8dfb1483f4baff11755349c9ad309f2309af12d29b502740a75b54c575545ec03a6d0f46a3d5
+  data.tar.gz: 9d26eec84dc84809c951f26787cc9781751c70c8f83def1148aa8a3dfef7662b2b3cadff653f056a43325ebc7efbab666e856dad2402f2515a3b2f93585d5821

data/README.md

@@ -24,21 +24,28 @@ Initialize API controller
     api_controller = Samanage::Api.new(token: 'abc123')
 ```
 
+- Create a user
+```ruby
+    user = {user: { name: 'John Doe', email: 'john.doe@example.com'}}
+    api_controller.create_user(payload: user)
+```
+
+
 - Find a user by email
 ```ruby
-    user_query = api_controller.execute(http_method: 'get', path: 'users.json?email=example@gmail.com')
+    my_user = api_controller.find_user_by_email(email: 'user@example.com')
 ```
 
 
 - Update incident by ID
 ```ruby
     incident_data = {incident: { priority: 'Critical' }}
-    incident_update = api_controller.execute(http_method: 'put', path: 'incidents/123.json', payload: incident_data)
+    incident_update = api_controller.update_incident(id: 123, payload: incident_data)
 ```
 
 - Update hardware
 ```ruby
-hardware = {'hardware':{'name':'My Computer'}}
+hardware = {hardware: {name: 'My Computer'}}
 result = api_controller.update_hardware(id: 123, payload: hardware)
 ```
 

data/changelog.md

@@ -1,3 +1,15 @@
+# 1.8.6
+- Removing layout=long verbosity
+
+# 1.8.5
+- Adding option for incidents layout=long
+
+# 1.8.3 
+- Additional Request Timeout retry support
+- Support for non-parsed responseq
+- Moving non object specific methods to samanage/api/utils
+- Added activation emails
+
 # 1.8.2
 - Adding Category support
 

data/lib/samanage.rb

@@ -15,7 +15,9 @@ require 'samanage/api/other_assets'
 require 'samanage/api/requester'
 require 'samanage/api/sites'
 require 'samanage/api/users'
+require 'samanage/api/utils'
 require 'samanage/error'
+require 'samanage/language'
 require 'samanage/url_builder'
 require 'samanage/version'
 

data/lib/samanage/api.rb

@@ -87,7 +87,7 @@ module Samanage
 				when 'put'
 					api_call = self.class.put(full_path, query: payload, headers: headers)
 				end
-			rescue Errno::ECONNREFUSED => e
+			rescue Errno::ECONNREFUSED, Net::OpenTimeout => e
 				puts "#{e} - #{e.class}"
 				puts "Retry: #{self.retries}/#{self.max_retries}"
 				self.retries += 1
@@ -109,7 +109,13 @@ module Samanage
 			# Error cases
 			case response[:code]
 			when 200..201
-				response[:data] = JSON.parse(api_call.body)
+				begin
+					response[:data] = JSON.parse(api_call.body)
+				rescue JSON::ParserError => e
+					response[:data] = api_call.body
+					puts "** Warning **#{e.class}"
+					puts e
+				end
 				response
 			when 401
 				response[:data] = api_call.body

data/lib/samanage/api/incidents.rb

@@ -9,12 +9,13 @@ module Samanage
 
 
 		# Returns all incidents
-		def collect_incidents
+		def collect_incidents(options: {})
 			page = 1
 			incidents = Array.new
 			total_pages = self.get_incidents[:total_pages]
+			layout = options[:layout] == 'long' ? '&layout=long' : nil
 			while page <= total_pages
-				incidents += self.execute(http_method: 'get', path: "incidents.json?page=#{page}")[:data]
+				incidents += self.execute(http_method: 'get', path: "incidents.json?page=#{page}#{layout}")[:data]
 				page += 1
 			end
 			incidents

data/lib/samanage/api/utils.rb

@@ -0,0 +1,10 @@
+module Samanage
+  class Api
+    # returns
+    def send_activation_email(email: )
+      user_id = self.find_user_id_by_email(email: email)
+      raise Samanage::Error.new(error: 'Invalid Email', response: {}) unless user_id
+      self.execute(http_method: 'put', path: "users/#{user_id}.json?send_activation_email=1&add_callbacks=1")
+    end
+  end
+end

data/lib/samanage/language.rb

@@ -0,0 +1,51 @@
+module Samanage
+  LANGUAGE = {
+    'arabic' => 'ar',
+    'belarusian' => 'be',
+    'bulgarian' => 'bg',
+    'catalan' => 'ca',
+    'chinese simplified' => 'zh-cn',
+    'chinese traditional' => 'zh-tw',
+    'croatian' => 'hr',
+    'czech' => 'cs',
+    'danish' => 'da',
+    'dutch' => 'nl',
+    'english' => 'en',
+    'estonian' => 'et',
+    'finnish' => 'fi',
+    'french' => 'fr',
+    'german' => 'de',
+    'greek' => 'el',
+    'hebrew' => 'he',
+    'hindi' => 'hi-in',
+    'hungarian' => 'hu',
+    'bahasa indonesia (indonesian)' => 'id',
+    'italian' => 'it',
+    'japanese' => 'ja',
+    'korean' => 'ko',
+    'latvian' => 'lv',
+    'lithuanian' => 'lt',
+    'malay' => 'ms',
+    'macedonian' => 'mk',
+    'norwegian' => 'nb',
+    'persian' => 'fa',
+    'polish' => 'pl',
+    'portuguese (brazil)' => 'pt-br',
+    'portuguese (portugal)' => 'pt-pt',
+    'romanian' => 'ro',
+    'russian' => 'ru',
+    'serbian' => 'sr',
+    'slovak' => 'sk',
+    'slovenian' => 'sl',
+    'spanish' => 'es',
+    'spanish  (latin america)' => 'es-419',
+    'swedish' => 'sv',
+    'thai' => 'th',
+    'turkish' => 'tr',
+    'ukrainian' => 'uk',
+    'vietnamese' => 'vi',
+  }
+  def self.lookup_language(language)
+    return LANGUAGE[language.to_s.downcase] ||= (language.to_s.downcase if LANGUAGE.values.include?(language.to_s.downcase))
+  end
+end

data/lib/samanage/version.rb

@@ -1,3 +1,3 @@
 module Samanage
-  VERSION = '1.8.3'
+  VERSION = '1.8.6'
 end

data/spec/api/samanage_incident_spec.rb

@@ -73,6 +73,11 @@ describe Samanage::Api do
 				expect(incident_update[:data]['description']).to eq(description)
 				expect(incident_update[:code]).to eq(200).or(201)
 			end
+			it 'finds more data for option[:layout] = "long"' do
+				basic_incident_keys = @controller.incidents.sample.keys
+				full_incident_keys = @controller.incidents(options: {layout: 'long'}).sample.keys
+				expect(basic_incident_keys.size).to be < full_incident_keys.size
+			end
 		end
 	end
 end

data/spec/api/samanage_util_spec.rb

@@ -0,0 +1,20 @@
+require 'samanage'
+describe Samanage::Api do
+	context 'Utils' do
+    describe 'API Functions' do
+      before(:each) do 
+        TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
+        @controller = Samanage::Api.new(token: TOKEN)
+      end
+      it 'sends an activation email' do
+        valid_email = @controller.users.sample['email'] 
+        send_email = @controller.send_activation_email(email: valid_email)
+        expect(send_email[:code]).to be(200)
+      end
+      it 'fails for invalid email' do
+        invalid_email = @controller.users.sample['email'].gsub!('@','$')
+        expect{@controller.send_activation_email(email: invalid_email)}.to raise_error(Samanage::Error)
+      end
+    end
+  end
+end

data/spec/samanage_language_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+describe Samanage do
+  describe 'Language' do
+    context 'when looking up language' do
+      it 'should find case-insensitive valid language codes' do
+        valid_lang = 'Czech'
+        valid_lang_code = 'cs'
+        expect(Samanage.lookup_language(valid_lang)).to eq(valid_lang_code)
+        expect(Samanage.lookup_language(valid_lang_code.upcase)).to eq(valid_lang_code)
+      end
+      it 'should return nil for invalid language codes' do
+        invalid_lang = 'Mandalorian'
+        invalid_lang_code = 'zzzzzzzzz'
+        expect(Samanage.lookup_language(invalid_lang)).to be(nil)
+        expect(Samanage.lookup_language(invalid_lang_code)).to be(nil)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samanage
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.8.6
 platform: ruby
 authors:
 - Chris Walls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2017-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -67,7 +67,9 @@ files:
 - lib/samanage/api/requester.rb
 - lib/samanage/api/sites.rb
 - lib/samanage/api/users.rb
+- lib/samanage/api/utils.rb
 - lib/samanage/error.rb
+- lib/samanage/language.rb
 - lib/samanage/url_builder.rb
 - lib/samanage/version.rb
 - samanage.gemspec
@@ -83,8 +85,10 @@ files:
 - spec/api/samanage_other_asset_spec.rb
 - spec/api/samanage_site_spec.rb
 - spec/api/samanage_user_spec.rb
+- spec/api/samanage_util_spec.rb
 - spec/samanage_api_spec.rb
 - spec/samanage_category_spec.rb
+- spec/samanage_language_spec.rb
 - spec/samanage_url_builder_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/cw2908/samanage-ruby