samanage 2.1.04 → 2.1.05

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2eae5b0a2fd2224a58170972a1743f1b4f97874
-  data.tar.gz: c77a999e1d466c5e98fd6f312b182a416f0d4df3
+  metadata.gz: 8c12e9f23a7417d96f83d1c76e7e5780cba44460
+  data.tar.gz: 1df4bc708e4688b5b84a6d33b358eb0f3d6eba0c
 SHA512:
-  metadata.gz: 859bb3474497a51470e7c8b54654e47cec0b2eb7e77e3760233faf8f823b195c1b6576508829b688e7044e737b93d130463b717842e4e740af32bb5f36806cad
-  data.tar.gz: f059e28ff6ddf2f33a5a06c3a9a2aeb07794790990b5b53255740b819b7af4a050f03f49b976cf01d6a4c8cb0bc29971eaba0964451ed242dcd9726856486b62
+  metadata.gz: 96ab8a94116c16ae22b3a35e466f0826a03b43793937e9c34a6664811b41442b311c4bfd957e8abcc3fac37c703837e084a7ac6d08d5851e73963f0cefcbf7d4
+  data.tar.gz: f64fc20a63cfa50828f909d9156f0fbb5bfca20834bcbf7f524cd2737539f66d649a0747fbca5a9211b4ccf8d08a5d33b5b19f9ad61dffeb711629570fed4117

data/Gemfile

@@ -3,7 +3,12 @@ source "https://rubygems.org"
 gem 'rspec'
 
 gem 'httparty', '0.15.7'
-
+gem 'ffi', '1.9.24'
 group :development do
   gem 'guard-rspec', require: false
+end
+
+group :test do
+  gem 'guard-rspec', require: false
+  gem 'faker'
 end

data/Gemfile.lock

@@ -2,7 +2,10 @@ GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
+    concurrent-ruby (1.0.5)
     diff-lcs (1.3)
+    faker (1.9.1)
+      i18n (>= 0.7)
     ffi (1.9.23)
     formatador (0.2.5)
     guard (2.14.2)
@@ -21,6 +24,8 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     httparty (0.15.7)
       multi_xml (>= 0.5.2)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -59,9 +64,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  faker
+  ffi (= 1.9.24)
   guard-rspec
   httparty (= 0.15.7)
   rspec
 
 BUNDLED WITH
-   1.16.0
+   1.16.1

data/changelog.md

@@ -1,3 +1,6 @@
+# 2.1.05
+- Adding new error checks
+- Using Faker for tests
 # 2.1.04
 - params bug fix
 # 2.1.03

data/lib/samanage/api.rb

@@ -3,6 +3,7 @@ require 'open-uri'
 module Samanage
   class Api
     include HTTParty
+    attr_accessor :datacenter, :content_type, :base_url, :token, :custom_forms, :authorized, :admins, :max_retries
     MAX_RETRIES = 3
     PATHS = {
       category: 'categories.json',
@@ -20,11 +21,9 @@ module Samanage
       solution: 'solutions.json',
       user: 'users.json',
     }
-    attr_accessor :datacenter, :content_type, :base_url, :token, :custom_forms, :authorized, :admins, :max_retries
-
     # Development mode forces authorization & pre-populates admins and custom forms / fields
     # datacenter should equal 'eu' or blank
-    def initialize(token: , datacenter: nil, development_mode: false, max_retries: MAX_RETRIES)
+    def initialize(token: , datacenter: nil, development_mode: false, max_retries: MAX_RETRIES, content_type: 'json')
       self.token = token
       if !datacenter.nil? && datacenter.to_s.downcase != 'eu'
         datacenter = nil
@@ -47,15 +46,15 @@ module Samanage
       self.authorized
     end
 
-    # Check token against api.json
+    # Check "oken against api.json"    
     def authorize
-      self.execute(path: 'api.json')
+      self.execute(path: "api.#{self.content_type}")
       self.authorized = true
     end
 
     # Calling execute without a method defaults to GET
     def execute(http_method: 'get', path: nil, payload: nil, verbose: nil, headers: {})
-      if payload.class == String
+      if payload.class == String && self.content_type == 'json'
         begin
           payload = JSON.parse(payload)
         rescue => e
@@ -92,8 +91,8 @@ module Samanage
         else
           raise Samanage::Error.new(response: {response: 'Unknown HTTP method'})
         end
-      rescue Errno::ECONNREFUSED, Net::OpenTimeout, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError => e
-        puts "[Warning]#{e.class}: #{e} -  Retry: #{retries}/#{self.max_retries}"
+      rescue Errno::ECONNREFUSED, Net::OpenTimeout, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError, Errno::ENETDOWN, Errno::ECONNRESET, Errno::ENOENT, EOFError => e
+        puts "[Warning] #{e.class}: #{e} -  Retry: #{retries}/#{self.max_retries}"
         sleep 3
         retries += 1
         retry if retries < self.max_retries
@@ -150,7 +149,7 @@ module Samanage
 
     # Return all admins in the account
     def list_admins
-      admin_role_id = self.execute(path: 'roles.json')[:data].select{|role| role['name'] == 'Administrator'}.first['id']
+      admin_role_id = self.execute(path: "roles.json")[:data].select{|role| role['name'] == 'Administrator'}.first['id']
       self.admins.push(
         self.execute(path: "users.json?role=#{admin_role_id}")[:data].map{|u| u['email']}
       ).flatten

data/lib/samanage/api/custom_forms.rb

@@ -3,7 +3,6 @@ module Samanage
     # Get custom forms path
     def get_custom_forms(path: PATHS[:custom_forms], options: {})
       params = self.set_params(options: options)
-      path = 'custom_forms.json?' + params
       self.execute(path: path)
     end
 

data/lib/samanage/api/users.rb

@@ -41,8 +41,10 @@ module Samanage
 
     # Email is unique so compare first for exact match only. Returns nil or the id
     def find_user_id_by_email(email: )
-      api_call = self.check_user(value: email)
-      api_call[:data].select{|u| u['email'].to_s.downcase == email.to_s.downcase}.first.to_h['id']
+      api_call = self.get_users(options: {email: email})
+      api_call[:data]
+        .select{|u| u['email'].to_s.downcase == email.to_s.downcase}
+        .first.to_h['id']
     end
 
     # Returns nil if no matching group_id

data/lib/samanage/error.rb

@@ -11,8 +11,8 @@ module Samanage
         self.status_code = nil
         self.response = response
       end
-
       puts "[Error] #{self.status_code}: #{self.response}" if options[:verbose]
+      return
     end
   end
 

data/lib/samanage/version.rb

@@ -1,3 +1,3 @@
 module Samanage
-  VERSION = '2.1.04'
+  VERSION = '2.1.05'
 end

data/spec/api/samanage_attachment_spec.rb

@@ -3,12 +3,41 @@ require 'samanage'
 describe Samanage::Api do
   context 'Attachments' do
     describe 'API Functions' do
-      before(:all) do 
-        TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
-        @samanage = Samanage::Api.new(token: TOKEN)
-        @users = @samanage.get_users[:data]
-        @incidents = @samanage.incidents
-      end
+    before(:all) do 
+      TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
+      @samanage = Samanage::Api.new(token: TOKEN)
+      @users = @samanage.get_users[:data]
+      @incidents = @samanage.incidents
     end
+    # it 'uploads an attachment' do
+    #   filename = 'sample_file.txt'
+    #   attachment = File.open(filename)
+    #   incident_id = @incidents.sample.dig('id')
+    #   attach = @samanage.upload_attachment(
+    #     attachment: attachment,
+    #     attachable_id: incident_id,
+    #     attachable_type: 'Incident'
+    #   )
+    #   expect(attach[:code]).to eq(200).or(201)
+    #   expect(filename).to eq(attach[:data]['filename'])
+    #   expect(attachment.size).to eq(attach[:data]['size'])
+    # end
+    # it 'downloads an attachment' do
+    #   incident_id = @incidents.sample.dig('id')
+    #   filename = 'sample_file.txt'
+    #   attachment = File.open(filename)
+    #   attach = @samanage.upload_attachment(
+    #     attachment: attachment,
+    #     attachable_id: incident_id,
+    #     attachable_type: 'Incident'
+    #   )
+    #   attachable_incident_id = incident_id # Need filter for has attachment?
+    #   incident = @samanage.find_incident(id: attachable_incident_id, options: {layout: 'long'})
+    #   attachment = @samanage.download_attachment(attachment: incident[:data]['attachments'].first)
+    #   expect(attachment.class).to be(File)
+    #   expect(attach[:code]).to eq(200)
+    #   expect(attachment.path.split('/').last).to eq(filename)
+    # end
+  end
   end
 end

data/spec/api/samanage_contract_spec.rb

@@ -21,7 +21,7 @@ describe Samanage::Api do
         expect(@contracts.size).to eq(contract_count)
       end
       it 'create_contract(payload: json): creates a contract' do
-        random_name = (0...50).map { ('a'..'z').to_a[rand(26)] }.join
+        random_name = Faker::Artist.name
         json = {
           contract: {
             type: 'SoftwareLicense',
@@ -36,7 +36,7 @@ describe Samanage::Api do
         expect(contract_create[:data]['name']).to eq(random_name)
       end
       it 'create_contract: fails if no status' do
-        contract_name = "samanage-ruby-#{(rand*10**10).ceil}"
+        contract_name = Faker::Ancient.god
         json = {
           :contract => {
             model: 'test',
@@ -60,7 +60,7 @@ describe Samanage::Api do
       end
       it 'update_contract: update_contract by id' do
         sample_id = @contracts.sample['id']
-        new_name = (0...50).map {('a'..'z').to_a[rand(26)] }.join
+        new_name = Faker::Company.name 
         json = {
           contract: {
             manufacturer_name: new_name
@@ -74,10 +74,10 @@ describe Samanage::Api do
         sample_id = @contracts.sample['id']
         item = {
           item: {
-            name: "name",
+            name: Faker::Company.catch_phrase ,
             version:" 123",
             qty: "2",
-            tag: "tag",
+            tag: Faker::Company.profession,
           }
         }
         add_item = @samanage.add_item_to_contract(id: sample_id, payload: item)

data/spec/api/samanage_custom_form_spec.rb

@@ -9,7 +9,7 @@ describe Samanage::Api do
         @custom_forms = @controller.collect_custom_forms
       end
       it 'collects all custom forms' do
-        expect(@custom_forms).to be_a(Array)
+        expect(@custom_forms).to be_an(Array)
       end
       it 'Organizes custom forms by module' do
         api_call = @controller.organize_forms

data/spec/api/samanage_department_spec.rb

@@ -1,4 +1,5 @@
 require 'samanage'
+require 'faker'
 describe Samanage::Api do
   context 'department' do
     before(:all) do
@@ -19,8 +20,8 @@ describe Samanage::Api do
       expect(@departments.size).to eq(department_count)
     end
     it 'creates a department' do
-      department_name = "department ##{(rand*10**4).ceil}"
-      department_description = "Location #{(rand*10**4).ceil}"
+      department_name = Faker::Book.title
+      department_description = Faker::Book.author
       payload = {
         department: {
           name: department_name,

data/spec/api/samanage_group_spec.rb

@@ -26,8 +26,8 @@ describe Samanage::Api do
       expect(group[:data]).to have_key('name')
     end
     it 'creates a group' do
-      group_name = "Group Name #{(rand*10**4).ceil}"
-      group_description = "Description #{(rand*10**4).ceil}"
+      group_name = Faker::BossaNova.artist
+      group_description = Faker::BossaNova.song
       payload = {
         group: {
           name: group_name,

data/spec/api/samanage_hardware_spec.rb

@@ -1,4 +1,5 @@
 require 'samanage'
+require 'faker'
 describe Samanage::Api do
   context 'Hardware' do
     describe 'API Functions' do
@@ -21,8 +22,8 @@ describe Samanage::Api do
         expect(@hardwares.size).to eq(hardware_count)
       end
       it 'create_hardware(payload: payload): creates a hardware' do
-        hardware_name = "samanage-ruby-#{(rand*10**10).ceil}"
-        serial_number = (0...50).map { ('a'..'z').to_a[rand(26)] }.join
+        hardware_name = Faker::Science.scientist
+        serial_number = Faker::Device.serial
         payload = {
           :hardware => {
             :name => hardware_name,
@@ -70,10 +71,12 @@ describe Samanage::Api do
       end
       it 'update_hardware: update_hardware by id' do
         sample_id = @hardwares.sample['id']
-        new_name = (0...50).map { ('a'..'z').to_a[rand(26)] }.join
+        new_name = [Faker::Dune.planet,Faker::ProgrammingLanguage.name].join('-')
         payload = {
           :hardware => {
-            :name => new_name
+            name: new_name,
+            tag: Faker::Dune.saying,
+            asset_id: Faker::Space.moon
           }
         }
         hardware_update = @samanage.update_hardware(payload: payload, id: sample_id)

data/spec/api/samanage_incident_spec.rb

@@ -1,4 +1,5 @@
 require 'samanage'
+require 'faker'
 describe Samanage::Api do
   context 'Incidents' do
     describe 'API Functions' do
@@ -24,12 +25,12 @@ describe Samanage::Api do
       end
       it 'create_incident(payload: json): creates a incident' do
         users_email = @samanage.collect_users.sample['email']
-        incident_name = "Samanage Ruby Incident"
+        incident_name = [Faker::StarWars.specie,Faker::StarWars.planet,Faker::StarWars.droid].shuffle.join(' ')
         json = {
           :incident => {
             :requester => {:email => users_email},
             :name => incident_name,
-            :description => "Description"
+            :description => Faker::StarWars.quote
           }
         }
         incident_create = @samanage.create_incident(payload: json)
@@ -43,7 +44,7 @@ describe Samanage::Api do
         json = {
           :incident => {
             :requester => {:email => users_email},
-            :description => "Description"
+            :description => Faker::StarWars.quote
           }
         }
         expect{@samanage.create_incident(payload: json)}.to raise_error(Samanage::InvalidRequest)
@@ -73,7 +74,8 @@ describe Samanage::Api do
       it 'update_incident: update_incident by id' do
         sample_incident = @incidents.reject{|i| ['Closed','Resolved'].include? i['state']}.sample
         sample_id = sample_incident['id']
-        description = (0...500).map { ('a'..'z').to_a[rand(26)] }.join
+        name = Faker::Movie.quote
+        description = [Faker::String.random,Faker::Seinfeld.quote,Faker::Lorem.paragraph].sample
         incident_json = {
           :incident => {
             :description => description

data/spec/api/samanage_site_spec.rb

@@ -22,7 +22,7 @@ describe Samanage::Api do
     it 'creates a site' do
       site_name = "Site ##{(rand*10**4).ceil}"
       site_location = "Location #{(rand*10**4).ceil}"
-      site_description = "Descrption #{(rand*10**4).ceil}"
+      site_description = Faker::Movie.quote
       payload = {
         site: {
           name: site_name,

data/spec/api/samanage_solution_spec.rb

@@ -20,8 +20,8 @@ describe Samanage::Api do
       expect(solutions.size).to eq(solution_count)
     end
     it 'creates a solution' do
-      solution_name = "solution ##{(rand*10**4).ceil}"
-      solution_description = "Description #{(rand*10**4).ceil}"
+      solution_name = Faker::Music.album
+      solution_description = Faker::Music.band
       payload = {
         solution: {
           name: solution_name,
@@ -36,7 +36,7 @@ describe Samanage::Api do
     end
     it 'updates a valid solution' do
       sample_solution_id = @solutions.sample['id']
-      new_description = solution_description = "Description #{(rand*10**4).ceil}"
+      new_description = Faker::Movie.quote
       payload = {solution: {description: new_description}}
       solution_update = @samanage.update_solution(id: sample_solution_id, payload: payload)
       

data/spec/api/samanage_user_spec.rb

@@ -1,4 +1,5 @@
 require 'samanage'
+require 'faker'
 
 describe Samanage::Api do
   context 'Users' do
@@ -9,8 +10,10 @@ describe Samanage::Api do
     end
     describe 'API Functions' do
       it 'ensures custom field is updated' do
-        val ="Random #{(rand*10**4).ceil}"
-        field_name = @samanage.custom_forms['user'][0]['custom_form_fields'].sample.dig('custom_field','name')
+        val = Faker::Seinfeld.quote
+        field_name = @samanage.custom_forms['user'][0]['custom_form_fields']
+          .select{|f|  f.dig('custom_field','field_type') == 1} # field_type == 1 is text
+          .sample.dig('custom_field','name')
         payload = {
           user: {
             custom_fields_values:{
@@ -38,8 +41,8 @@ describe Samanage::Api do
         expect(@users.size).to eq(user_count)
       end
       it 'create_user(payload: json): creates a user' do
-        user_name = "autotest-#{(rand*42**100).ceil}"
-        email = user_name + "@samanage.com"
+        user_name = [Faker::Simpsons.character,Faker::StarWars.character,Faker::Name.name].sample
+        email = Faker::Internet.safe_email(user_name)
         json = {
           :user => {
             :name => user_name,
@@ -53,7 +56,7 @@ 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**(rand(10))).ceil}"
+        user_name = Faker::Superhero.name
         json = {
           :user => {
             :name => user_name,
@@ -120,10 +123,11 @@ describe Samanage::Api do
 
       it 'update_user: update_user by id' do
         sample_id = @users.sample['id']
-        new_name = (0...25).map { ('a'..'z').to_a[rand(26)] }.join
+        new_name = [Faker::Simpsons.character,Faker::StarWars.character,Faker::Name.name].sample
         json = {
           :user => {
-            :name => new_name
+            name: new_name,
+            title: Faker::Job.title
           }
         }
         user_update = @samanage.update_user(payload: json, id: sample_id)

data/spec/api/samanage_util_spec.rb

@@ -9,7 +9,7 @@ describe Samanage::Api do
         @incidents = @samanage.incidents
       end
       it 'sends an activation email' do
-        valid_email = @users.sample['email'] 
+        valid_email = @users.select{|u| !u['disabled'] && !u['last_login']}.sample['email']
         send_email = @samanage.send_activation_email(email: valid_email)
         expect(send_email[:code]).to eq(200)
       end

data/spec/spec_helper.rb

@@ -6,4 +6,5 @@ $LOAD_PATH.unshift(spec_dir)
 $LOAD_PATH.unshift(lib_dir)
 $LOAD_PATH.uniq!
 
-require 'samanage'
+require 'samanage'
+require 'faker'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samanage
 version: !ruby/object:Gem::Version
-  version: 2.1.04
+  version: 2.1.05
 platform: ruby
 authors:
 - Chris Walls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-11 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty