samanage 2.1.19 → 2.1.20

data/lib/samanage/api/comments.rb

@@ -1,21 +1,20 @@
+# frozen_string_literal: true
+
 module Samanage
   class Api
-
-
     # Find comments given incident_id
-    def get_comments(incident_id: )
+    def get_comments(incident_id:)
       path = "incidents/#{incident_id}/comments.json"
       self.execute(path: path)
     end
 
     # Add a new comment
-    def create_comment(incident_id: , comment: , options: {})
-      
+    def create_comment(incident_id:, comment:, options: {})
       path = "incidents/#{incident_id}/comments.json?"
-      self.execute(http_method: 'post', path: path, payload: comment, options: options)
+      self.execute(http_method: "post", path: path, payload: comment, options: options)
     end
 
 
     alias_method :comments, :get_comments
   end
-end
+end

data/lib/samanage/api/contracts.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 module Samanage
   class Api
-
     # Get contract default path
     def get_contracts(path: PATHS[:contract], options: {})
-      
-      path = 'contracts.json?'
+      path = "contracts.json?"
       self.execute(path: path, options: options)
     end
 
@@ -14,7 +14,7 @@ module Samanage
       total_pages = self.get_contracts(options: options)[:total_pages]
       1.upto(total_pages) do |page|
         options[:page] = page
-        
+
         puts "Collecting Contracts page: #{page}/#{total_pages}" if options[:verbose]
         path = "contracts.json?"
         self.execute(path: path, options: options)[:data].each do |contract|
@@ -28,16 +28,16 @@ module Samanage
     end
 
     # Create contract given json payload
-    def create_contract(payload: , options: {})
-      self.execute(path: PATHS[:contract], http_method: 'post', payload: payload)
+    def create_contract(payload:, options: {})
+      self.execute(path: PATHS[:contract], http_method: "post", payload: payload)
     end
 
     # Find contract given id
-    def find_contract(id: , options: {})
+    def find_contract(id:, options: {})
       path = "contracts/#{id}.json"
       self.execute(path: path, options: {})
     end
-    
+
     # Check for contract using URL builder
     def check_contract(options: {})
       url = Samanage::UrlBuilder.new(path: PATHS[:contract], options: options).url
@@ -45,22 +45,22 @@ module Samanage
     end
 
     # Update contract given id
-    def update_contract(payload: , id: , options: {})
+    def update_contract(payload:, id:, options: {})
       path = "contracts/#{id}.json"
-      self.execute(path: path, http_method: 'put', payload: payload)
+      self.execute(path: path, http_method: "put", payload: payload)
     end
 
-    def add_item_to_contract(id: , payload: )
+    def add_item_to_contract(id:, payload:)
       path = "contracts/#{id}/items.json"
-      self.execute(path: path, http_method: 'post', payload: payload)
+      self.execute(path: path, http_method: "post", payload: payload)
     end
-    
-    def delete_contract(id: )
-      self.execute(path: "contracts/#{id}.json", http_method: 'delete')
+
+    def delete_contract(id:)
+      self.execute(path: "contracts/#{id}.json", http_method: "delete")
     end
 
 
 
-  alias_method :contracts, :collect_contracts
+    alias_method :contracts, :collect_contracts
   end
-end
+end

data/lib/samanage/api/custom_fields.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 module Samanage
   class Api
-
     # Get custom fields default url
-    def get_custom_fields(path: PATHS[:custom_fields], options:{})
-      
-      path = 'custom_fields.json?'
+    def get_custom_fields(path: PATHS[:custom_fields], options: {})
+      path = "custom_fields.json?"
       self.execute(path: path, options: options)
     end
 
@@ -14,14 +14,14 @@ module Samanage
       total_pages = self.get_custom_fields(options: options)[:total_pages] ||= 2
       1.upto(total_pages) do |page|
         options[:page] = page
-        
+
         puts "Collecting Custom Fields page: #{page}/#{total_pages}" if options[:verbose]
         path = "custom_fields.json?"
         self.execute(path: path, options: options)[:data].each do |custom_field|
           if block_given?
             yield custom_field
           end
-          custom_fields << custom_field 
+          custom_fields << custom_field
         end
       end
       custom_fields

data/lib/samanage/api/custom_forms.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module Samanage
   class Api
     # Get custom forms path
     def get_custom_forms(path: PATHS[:custom_forms], options: {})
-      
       self.execute(path: path)
     end
 
@@ -12,7 +13,7 @@ module Samanage
       total_pages = self.get_custom_forms(options: options)[:total_pages]
       1.upto(total_pages) do |page|
         options[:page] = page
-        
+
         puts "Collecting Custom Forms page: #{page}/#{total_pages}" if options[:verbose]
         path = "custom_forms.json?"
         self.execute(path: path, options: options)[:data].each do |custom_form|
@@ -28,13 +29,15 @@ module Samanage
     # Set forms by type and map fields
     def organize_forms
       custom_forms = self.collect_custom_forms
-      custom_forms.map{|form| form.delete_if{|k, v| v.nil?}}
-      custom_forms.map{|form| form['custom_form_fields'].map{|fields| fields.delete_if{|k, v| v == false}}}
-      custom_forms.map{|form| form['custom_form_fields'].map{|fields| fields['custom_field'].delete_if{|k, v| !v}}}
-      custom_forms.group_by{|k|
-        k['module']}.each_pair{|forms_name, forms|
-          forms.each{|form|
-            form['custom_form_fields'].group_by{|f| f['name'] }
+      custom_forms.map { |form| form.delete_if { |k, v| v.nil? } }
+      custom_forms.map { |form| form["custom_form_fields"].map { |fields| fields.delete_if { |k, v| v == false } } }
+      custom_forms.map { |form|
+        form["custom_form_fields"].map { |fields| fields["custom_field"].delete_if { |k, v| !v } }
+      }
+      custom_forms.group_by { |k|
+        k["module"]}.each_pair { |forms_name, forms|
+          forms.each { |form|
+            form["custom_form_fields"].group_by { |f| f["name"] }
           }
         }
     end
@@ -47,4 +50,4 @@ module Samanage
       self.custom_forms[object_type]
     end
   end
-end
+end

data/lib/samanage/api/departments.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module Samanage
   class Api
     def get_departments(path: PATHS[:department], options: {})
-      
-      path = 'departments.json?'
+      path = "departments.json?"
       self.execute(path: path, options: options)
     end
 
@@ -11,7 +12,7 @@ module Samanage
       total_pages = self.get_departments(options: options)[:total_pages]
       1.upto(total_pages) do |page|
         options[:page] = page
-        
+
         puts "Collecting Departments page: #{page}/#{total_pages}" if options[:verbose]
         path = "departments.json?"
         self.execute(path: path, options: options)[:data].each do |department|
@@ -24,14 +25,13 @@ module Samanage
       departments
     end
 
-    def create_department(payload: , options: {})
-      self.execute(path: PATHS[:department], http_method: 'post', payload: payload)
-
+    def create_department(payload:, options: {})
+      self.execute(path: PATHS[:department], http_method: "post", payload: payload)
     end
-    def delete_department(id: )
-      self.execute(path: "departments/#{id}.json", http_method: 'delete')
+    def delete_department(id:)
+      self.execute(path: "departments/#{id}.json", http_method: "delete")
     end
 
     alias_method :departments, :collect_departments
   end
-end
+end

data/lib/samanage/api/groups.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module Samanage
   class Api
     def get_groups(path: PATHS[:group], options: {})
-      
-      path = 'groups.json?'
+      path = "groups.json?"
       self.execute(path: path, options: options)
     end
 
@@ -11,9 +12,9 @@ module Samanage
       total_pages = self.get_groups(options: options)[:total_pages]
       1.upto(total_pages) do |page|
         options[:page] = page
-        
+
         puts "Collecting Groups page: #{page}/#{total_pages}" if options[:verbose]
-        path = 'groups.json?'
+        path = "groups.json?"
         self.execute(path: path, options: options)[:data].each do |group|
           if block_given?
             yield group
@@ -24,37 +25,37 @@ module Samanage
       groups
     end
 
-    def create_group(payload: , options: {})
-      self.execute(path: PATHS[:group], http_method: 'post', payload: payload)
+    def create_group(payload:, options: {})
+      self.execute(path: PATHS[:group], http_method: "post", payload: payload)
     end
 
-    def find_group_id_by_name(group: '', options: {})
-      options.merge!({name: group}) if group && !options.keys.include?(:name)
-      
+    def find_group_id_by_name(group: "", options: {})
+      options[:name] = group if group && !options.keys.include?(:name)
+
       path = "groups.json?"
       group_api = self.execute(path: path, options: options)
       # Group names are case sensitive
-      if !group_api[:data].empty? && group == group_api[:data].first['name']
-        return group_api[:data].first['id']
+      if !group_api[:data].empty? && group == group_api[:data].first["name"]
+        return group_api[:data].first["id"]
       end
     end
 
-    def find_group(id: , options: {})
+    def find_group(id:, options: {})
       path = "groups/#{id}.json"
       self.execute(path: path, options: {})
     end
 
-    def add_member_to_group(email: , group_id: nil, group_name: nil)
-      group_id = group_id ||= self.find_group_id_by_name(group: group_name)
+    def add_member_to_group(email:, group_id: nil, group_name: nil)
+      group_id ||= self.find_group_id_by_name(group: group_name)
       user_id = self.find_user_id_by_email(email: email)
       member_path = "memberships.json?group_id=#{group_id}.json&user_ids=#{user_id}"
-      self.execute(path: member_path, http_method: 'post')
+      self.execute(path: member_path, http_method: "post")
     end
-    
-    def delete_group(id: )
-      self.execute(path: "groups/#{id}.json", http_method: 'delete')
+
+    def delete_group(id:)
+      self.execute(path: "groups/#{id}.json", http_method: "delete")
     end
-    
+
     alias_method :groups, :collect_groups
   end
-end
+end

data/lib/samanage/api/hardwares.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 module Samanage
   class Api
-
     # Get hardware default path
     def get_hardwares(path: PATHS[:hardware], options: {})
-      
-      path = 'hardwares.json?'
+      path = "hardwares.json?"
       self.execute(path: path, options: options)
     end
 
@@ -14,7 +14,7 @@ module Samanage
       total_pages = self.get_hardwares(options: options)[:total_pages]
       1.upto(total_pages) do |page|
         options[:page] = page
-        
+
         puts "Collecting Hardwares page: #{page}/#{total_pages}" if options[:verbose]
         path = "hardwares.json?"
         self.execute(path: path, options: options)[:data].each do |hardware|
@@ -28,18 +28,18 @@ module Samanage
     end
 
     # Create hardware given json payload
-    def create_hardware(payload: , options: {})
-      self.execute(path: PATHS[:hardware], http_method: 'post', payload: payload)
+    def create_hardware(payload:, options: {})
+      self.execute(path: PATHS[:hardware], http_method: "post", payload: payload)
     end
 
     # Find hardware given id
-    def find_hardware(id: )
+    def find_hardware(id:)
       path = "hardwares/#{id}.json"
       self.execute(path: path)
     end
 
     # Find hardware given a serial number
-    def find_hardwares_by_serial(serial_number: )
+    def find_hardwares_by_serial(serial_number:)
       path = "hardwares.json?serial_number[]=#{serial_number}"
       self.execute(path: path)
     end
@@ -52,15 +52,15 @@ module Samanage
     end
 
     # Update hardware given id
-    def update_hardware(payload: , id: , options: {})
+    def update_hardware(payload:, id:, options: {})
       path = "hardwares/#{id}.json"
-      self.execute(path: path, http_method: 'put', payload: payload)
+      self.execute(path: path, http_method: "put", payload: payload)
     end
 
-    def delete_hardware(id: )
-      self.execute(path: "hardwares/#{id}.json", http_method: 'delete')
+    def delete_hardware(id:)
+      self.execute(path: "hardwares/#{id}.json", http_method: "delete")
     end
 
-  alias_method :hardwares, :collect_hardwares
+    alias_method :hardwares, :collect_hardwares
   end
-end
+end

data/lib/samanage/api/incidents.rb

@@ -14,23 +14,22 @@ module Samanage
     def collect_incidents(options: {})
       incidents = []
       total_pages = get_incidents(options: options.except(:audit_archives, :audit_archive, :layout))[:total_pages]
-      puts 'Requesting Incidents with Audit Archives (this may take a while)' if options[:audit_archives] && options[:verbose]
+      message = "Requesting Incidents with Audit Archives (this may take a while)"
+      puts message if options[:audit_archives] && options[:verbose]
       1.upto(total_pages) do |page|
         puts "Collecting Incidents page: #{page}/#{total_pages}" if options[:verbose]
         options[:page] = page
         if options[:audit_archives]
-          params = URI.encode_www_form(options.except(:audit_archives, :audit_archive, :layout)) # layout not needed as audit only on individual record
-          paginated_path = 'incidents.json?'
+          paginated_path = "incidents.json?"
           paginated_incidents = execute(path: paginated_path, options: options)[:data]
           paginated_incidents.map do |incident|
-            params = set_params(options: options.except(:audit_archives, :audit_archive, :layout))
             archive_uri = "incidents/#{incident['id']}.json?layout=long&audit_archive=true"
             incident_with_archive = execute(path: archive_uri)[:data]
             yield incident_with_archive if block_given?
             incidents.push(incident_with_archive)
           end
         else
-          path = 'incidents.json?'
+          path = "incidents.json?"
           execute(path: path, options: options)[:data].each do |incident|
             yield incident if block_given?
             incidents.push(incident)
@@ -42,7 +41,7 @@ module Samanage
 
     # Create an incident given json
     def create_incident(payload: nil, options: {})
-      execute(path: PATHS[:incident], http_method: 'post', payload: payload, options: options)
+      execute(path: PATHS[:incident], http_method: "post", payload: payload, options: options)
     end
 
     # Find incident by ID
@@ -54,11 +53,11 @@ module Samanage
     # Update an incident given id and json
     def update_incident(payload:, id:, options: {})
       path = "incidents/#{id}.json?"
-      execute(path: path, http_method: 'put', payload: payload, options: options)
+      execute(path: path, http_method: "put", payload: payload, options: options)
     end
 
     def delete_incident(id:, options: {})
-      execute(path: "incidents/#{id}.json", http_method: 'delete', options: options)
+      execute(path: "incidents/#{id}.json", http_method: "delete", options: options)
     end
 
     alias incidents collect_incidents

data/lib/samanage/api/mobiles.rb

@@ -1,12 +1,11 @@
+# frozen_string_literal: true
+
 module Samanage
   class Api
-
     # Get mobile default path
     def get_mobiles(path: PATHS[:mobile], options: {})
-      
-      path = 'mobiles.json?'
+      path = "mobiles.json?"
       self.execute(path: path, options: options)
-
     end
 
     # Get all mobiles
@@ -15,11 +14,11 @@ module Samanage
       total_pages = self.get_mobiles(options: options)[:total_pages]
       1.upto(total_pages) do |page|
         options[:page] = page
-        
+
         puts "Collecting Mobiles page: #{page}/#{total_pages}" if options[:verbose]
         path = "mobiles.json?"
         self.execute(path: path, options: options)[:data].each do |mobile|
-          if block_given? 
+          if block_given?
             yield mobiles
           end
           mobiles << mobile
@@ -30,15 +29,15 @@ module Samanage
 
     # Create mobile given json payload
     def create_mobile(payload: nil, options: {})
-      self.execute(path: PATHS[:mobile], http_method: 'post', payload: payload)
+      self.execute(path: PATHS[:mobile], http_method: "post", payload: payload)
     end
 
     # Find mobile given id
-    def find_mobile(id: , options: {})
+    def find_mobile(id:, options: {})
       path = "mobiles/#{id}.json"
       self.execute(path: path)
     end
-    
+
     # Check for mobile using URL builder
     def check_mobile(options: {})
       url = Samanage::UrlBuilder.new(path: PATHS[:mobile], options: options).url
@@ -46,16 +45,16 @@ module Samanage
     end
 
     # Update mobile given id
-    def update_mobile(payload: , id: , options: {})
+    def update_mobile(payload:, id:, options: {})
       path = "mobiles/#{id}.json"
-      self.execute(path: path, http_method: 'put', payload: payload)
+      self.execute(path: path, http_method: "put", payload: payload)
     end
 
-    def delete_mobile(id: )
-      self.execute(path: "mobiles/#{id}.json", http_method: 'delete')
+    def delete_mobile(id:)
+      self.execute(path: "mobiles/#{id}.json", http_method: "delete")
     end
 
 
-  alias_method :mobiles, :collect_mobiles
+    alias_method :mobiles, :collect_mobiles
   end
-end
+end