samanage 2.1.19 → 2.1.20

data/lib/samanage.rb

@@ -1,34 +1,37 @@
+# frozen_string_literal: true
+
 $LOAD_PATH << File.dirname(__FILE__)
-require 'httparty'
+require "httparty"
 
-require 'samanage/api'
-require 'samanage/api/attachments'
-require 'samanage/api/category'
-require 'samanage/api/changes'
-require 'samanage/api/comments'
-require 'samanage/api/contracts'
-require 'samanage/api/custom_fields'
-require 'samanage/api/custom_forms'
-require 'samanage/api/departments'
-require 'samanage/api/groups'
-require 'samanage/api/hardwares'
-require 'samanage/api/incidents'
-require 'samanage/api/mobiles'
-require 'samanage/api/other_assets'
-require 'samanage/api/problems'
-require 'samanage/api/purchase_orders'
-require 'samanage/api/requester'
-require 'samanage/api/releases'
-require 'samanage/api/sites'
-require 'samanage/api/solutions'
-require 'samanage/api/time_tracks'
-require 'samanage/api/users'
-require 'samanage/api/utils'
-require 'samanage/api/vendors'
-require 'samanage/error'
-require 'samanage/language'
-require 'samanage/url_builder'
-require 'samanage/version'
+require "samanage/api"
+require "samanage/api/attachments"
+require "samanage/api/category"
+require "samanage/api/changes"
+require "samanage/api/comments"
+require "samanage/api/contracts"
+require "samanage/api/custom_fields"
+require "samanage/api/custom_forms"
+require "samanage/api/departments"
+require "samanage/api/groups"
+require "samanage/api/hardwares"
+require "samanage/api/incidents"
+require "samanage/api/mobiles"
+require "samanage/api/other_assets"
+require "samanage/api/problems"
+require "samanage/api/purchase_orders"
+require "samanage/api/requester"
+require "samanage/api/releases"
+require "samanage/api/sites"
+require "samanage/api/tasks"
+require "samanage/api/solutions"
+require "samanage/api/time_tracks"
+require "samanage/api/users"
+require "samanage/api/utils"
+require "samanage/api/vendors"
+require "samanage/error"
+require "samanage/language"
+require "samanage/url_builder"
+require "samanage/version"
 
 module Samanage
 end
@@ -41,4 +44,4 @@ class Hash
   def except(*keys)
     dup.except!(*keys)
   end
-end
+end

data/lib/samanage/api.rb

@@ -1,104 +1,101 @@
-require 'httparty'
-require 'open-uri'
+# frozen_string_literal: true
+
+require "httparty"
+require "open-uri"
 module Samanage
   class Api
     include HTTParty
-    attr_accessor :datacenter, :content_type, :base_url, :token, :custom_forms, :authorized, :admins, :max_retries, :sleep_time
+    attr_accessor :datacenter, :content_type, :base_url, :token, :custom_forms,
+                  :authorized, :admins, :max_retries, :sleep_time
     PATHS = {
-      attachment: 'attachments.json',
-      category: 'categories.json',
-      change: 'changes.json',
-      contract: 'contracts.json',
-      custom_fields: 'custom_fields.json',
-      custom_forms: 'custom_forms.json',
-      department: 'departments.json',
-      group: 'groups.json',
-      hardware: 'hardwares.json',
-      incident: 'incidents.json',
-      mobile: 'mobiles.json',
-      other_asset: 'other_assets.json',
-      problem: 'problems.json',
-      purchase_order: 'purchase_orders.json',
-      release: 'releases.json',
-      site: 'sites.json',
-      solution: 'solutions.json',
-      user: 'users.json',
-      vendor: 'vendors.json',
-    }
+      attachment: "attachments.json",
+      category: "categories.json",
+      change: "changes.json",
+      contract: "contracts.json",
+      custom_fields: "custom_fields.json",
+      custom_forms: "custom_forms.json",
+      department: "departments.json",
+      group: "groups.json",
+      hardware: "hardwares.json",
+      incident: "incidents.json",
+      mobile: "mobiles.json",
+      other_asset: "other_assets.json",
+      problem: "problems.json",
+      purchase_order: "purchase_orders.json",
+      release: "releases.json",
+      site: "sites.json",
+      task: "tasks.json",
+      solution: "solutions.json",
+      user: "users.json",
+      vendor: "vendors.json"
+    }.freeze
     # 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: 3, content_type: 'json', sleep_time: 5)
+    def initialize(token:, datacenter: nil, development_mode: false,
+      max_retries: 3, content_type: "json", sleep_time: 5)
       self.token = token
-      if !datacenter.nil? && datacenter.to_s.downcase != 'eu'
-        datacenter = nil
-      end
+      datacenter = nil if !datacenter.nil? && datacenter.to_s.downcase != "eu"
       self.datacenter ||= datacenter.to_s.downcase
-      self.base_url =  "https://api#{self.datacenter.to_s.downcase}.samanage.com/"
-      self.content_type = content_type || 'json'
+      self.base_url = "https://api#{self.datacenter.to_s.downcase}.samanage.com/"
+      self.content_type = content_type || "json"
       self.admins = []
       self.max_retries = max_retries
       self.sleep_time = sleep_time
       if development_mode
-        if self.authorized? != true
-          self.authorize
-        end
-        self.custom_forms = self.organize_forms
-        self.admins = self.list_admins
+        authorize if authorized? != true
+        self.custom_forms = organize_forms
+        self.admins = list_admins
       end
     end
 
     def authorized?
-      self.authorized
+      authorized
     end
 
-    # Check "oken against api.json"    
+    # Check "oken against api.json"
     def authorize
-      self.execute(path: "api.#{self.content_type}")
+      execute(path: "api.#{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: {}, options: {}, multipart: false)
-      if payload.class == Hash && self.content_type == 'json'
+    def execute(http_method: "get", path: nil, payload: nil, verbose: nil, headers: {}, options: {}, multipart: false)
+      if payload.class == Hash && content_type == "json"
         begin
-          if path != 'attachments.json'
-            payload = payload.to_json
-          end
-        rescue => e
+          payload = payload.to_json if path != "attachments.json"
+        rescue StandardError => e
           puts "Invalid JSON: #{payload.inspect}"
           raise Samanage::Error.new(error: e, response: nil, options: options)
         end
       end
-      token = token ||= self.token
-      unless verbose.nil?
-        verbose = '?layout=long'
-      end
+      verbose = "?layout=long" unless verbose.nil?
 
       headers = {
-        'Accept' => "application/vnd.samanage.v2.1+#{self.content_type}#{verbose}",
-        'Content-Type'  => "application/#{self.content_type}",
-        'X-Samanage-Authorization' => 'Bearer ' + self.token
+        "Accept" => "application/vnd.samanage.v2.1+#{content_type}#{verbose}",
+        "Content-Type" => "application/#{content_type}",
+        "X-Samanage-Authorization" => "Bearer " + self.token
       }.merge(headers)
       options = options.except(:verbose)
-      full_path = self.base_url + path
+      full_path = base_url + path
       retries = 0
       begin
         case http_method.to_s.downcase
-        when 'get'
+        when "get"
           api_call = self.class.get(full_path, headers: headers, query: options)
-        when 'post'
+        when "post"
           api_call = self.class.post(full_path, multipart: multipart,  body: payload, headers: headers, query: options)
-        when 'put'
+        when "put"
           api_call = self.class.put(full_path, body: payload, headers: headers, query: options)
-        when 'delete'
+        when "delete"
           api_call = self.class.delete(full_path, body: payload, headers: headers, query: options)
         else
-          raise Samanage::Error.new(response: {response: 'Unknown HTTP method'}, options: options)
+          raise Samanage::Error.new(response: { response: "Unknown HTTP method" }, options: options)
         end
-      rescue Errno::ECONNREFUSED, Net::OpenTimeout, Errno::ETIMEDOUT, Net::ReadTimeout, OpenSSL::SSL::SSLError, Errno::ENETDOWN, Errno::ECONNRESET, Errno::ENOENT, EOFError, Net::HTTPTooManyRequests, SocketError => e
+      rescue Errno::ECONNREFUSED, Net::OpenTimeout, Errno::ETIMEDOUT, Net::ReadTimeout, OpenSSL::SSL::SSLError,
+            Errno::ENETDOWN, Errno::ECONNRESET, Errno::ENOENT, EOFError, Net::HTTPTooManyRequests, SocketError => e
         retries += 1
-        if retries < self.max_retries
-          puts "[Warning] #{e.class}: #{e} -  Retry: #{retries}/#{self.max_retries}"
+        if retries < max_retries
+          puts "[Warning] #{e.class}: #{e} -  Retry: #{retries}/#{max_retries}"
           sleep sleep_time
           retry
         else
@@ -106,10 +103,10 @@ module Samanage
           response = e.class
           raise Samanage::InvalidRequest.new(error: error, response: response, options: options)
         end
-      rescue => e
+      rescue StandardError => e
         retries += 1
-        if retries < self.max_retries
-          puts "[Warning] #{e.class}: #{e} -  Retry: #{retries}/#{self.max_retries}"
+        if retries < max_retries
+          puts "[Warning] #{e.class}: #{e} -  Retry: #{retries}/#{max_retries}"
           sleep sleep_time
           retry
         else
@@ -119,14 +116,14 @@ module Samanage
         end
       end
 
-      response = Hash.new
+      response = {}
       response[:code] = api_call.code.to_i
       response[:json] = api_call.body
       response[:response] = api_call
       response[:headers] = api_call.headers
-      response[:total_pages] = api_call.headers['X-Total-Pages'].to_i
+      response[:total_pages] = api_call.headers["X-Total-Pages"].to_i
       response[:total_pages] = 1 if response[:total_pages] == 0
-      response[:total_count] = api_call.headers['X-Total-Count'].to_i
+      response[:total_count] = api_call.headers["X-Total-Count"].to_i
 
       # Error cases
       case response[:code]
@@ -135,16 +132,14 @@ module Samanage
           response[:data] = JSON.parse(api_call.body)
         rescue JSON::ParserError => e
           response[:data] = api_call.body
-          if !path.match('send_activation_email')
-            puts "[Warning] #{e.class}: #{e}"
-          end
+          puts "[Warning] #{e.class}: #{e}" unless path.match?("send_activation_email")
         end
         response
       when 401
         response[:data] = api_call.body
         error = response[:response]
         self.authorized = false
-        raise Samanage::AuthorizationError.new(error: error,response: response, options: options)
+        raise Samanage::AuthorizationError.new(error: error, response: response, options: options)
       when 404
         response[:data] = api_call.body
         error = response[:response]
@@ -160,18 +155,16 @@ module Samanage
       end
     end
 
-
     def set_params(options:)
       options[:audit_archive] = options[:audit_archive] || options[:audit_archives] if options[:audit_archives]
       URI.encode_www_form(options.except(:verbose))
     end
 
-
     # 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']
-      self.admins.push(
-        self.execute(path: "users.json?role=#{admin_role_id}")[:data].map{|u| u['email']}
+      admin_role_id = execute(path: "roles.json")[:data].select { |role| role["name"] == "Administrator" }.first["id"]
+      admins.push(
+        execute(path: "users.json?role=#{admin_role_id}")[:data].map { |u| u["email"] }
       ).flatten
     end
   end

data/lib/samanage/api/attachments.rb

@@ -3,16 +3,16 @@
 module Samanage
   class Api
     def download_attachment(attachment: {}, filename: nil, path: nil)
-      attachable_type = attachment['attachable_type']
-      attachable_id = attachment['attachable_id'].to_s
-      filename ||= attachment['filename']
-      url = attachment['url']
+      attachable_type = attachment["attachable_type"]
+      attachable_id = attachment["attachable_id"].to_s
+      filename ||= attachment["filename"]
+      url = attachment["url"]
 
       file_path = path || File.join(Dir.pwd, attachable_type, attachable_id)
       FileUtils.mkpath(file_path) unless File.directory?(file_path)
 
       exact_path = File.join(file_path, filename)
-      downloaded_attachment = File.open(exact_path, 'wb+') do |file|
+      downloaded_attachment = File.open(exact_path, "wb+") do |file|
         file << URI.parse(url).read
       end
       downloaded_attachment
@@ -24,17 +24,17 @@ module Samanage
         return
       end
       req = execute(
-        path: 'attachments.json',
-        http_method: 'post',
+        path: "attachments.json",
+        http_method: "post",
         multipart: true,
         payload: {
-          'file[attachable_type]' => attachable_type,
-          'file[attachable_id]' => attachable_id,
-          'file[attachment]' => File.open(filepath, 'rb')
+          "file[attachable_type]" => attachable_type,
+          "file[attachable_id]" => attachable_id,
+          "file[attachment]" => File.open(filepath, "rb")
         },
         headers: {
-          'Content-Type' => 'multipart/form-data',
-          'X-Samanage-Authorization' => 'Bearer ' + token
+          "Content-Type" => "multipart/form-data",
+          "X-Samanage-Authorization" => "Bearer " + token
         }
       )
       req

data/lib/samanage/api/category.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Samanage
   class Api
     def get_categories(path: PATHS[:category], options: {})
-      path = 'categories.json'
+      path = "categories.json"
       self.execute(path: path, options: options)
     end
 
@@ -9,18 +11,18 @@ module Samanage
     # Samanage categories are not paginated
     # - to break into subcategories, add
     def collect_categories(options: {})
-      request = self.execute(http_method: 'get', path: "categories.json", options: options)
+      request = self.execute(http_method: "get", path: "categories.json", options: options)
       request[:data]
     end
 
     def create_category(payload: nil, options: {})
-      self.execute(path: PATHS[:category], http_method: 'post', payload: payload, options: options)
+      self.execute(path: PATHS[:category], http_method: "post", payload: payload, options: options)
     end
 
-    def delete_category(id: )
-      self.execute(path: "categories/#{id}", http_method: 'delete', options: options)
+    def delete_category(id:)
+      self.execute(path: "categories/#{id}", http_method: "delete", options: options)
     end
 
-  alias_method :categories, :collect_categories
+    alias_method :categories, :collect_categories
   end
-end
+end

data/lib/samanage/api/changes.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 module Samanage
   class Api
-
     # Default get change path
     def get_changes(path: PATHS[:change], options: {})
-      path = 'changes.json?'
+      path = "changes.json?"
       self.execute(path: path, options: options)
     end
 
 
-    # Returns all changes. 
-    # Options: 
+    # Returns all changes.
+    # Options:
     #   - audit_archives: true
     #   - layout: 'long'
     def collect_changes(options: {})
@@ -17,10 +18,10 @@ module Samanage
       total_pages = self.get_changes(options: options)[:total_pages]
       1.upto(total_pages) do |page|
         options[:page] = page
-        
+
         puts "Collecting Changes page: #{page}/#{total_pages}" if options[:verbose]
         path = "changes.json?"
-        request = self.execute(http_method: 'get', path: path, options: options)
+        request = self.execute(http_method: "get", path: path, options: options)
         request[:data].each do |change|
           if block_given?
             yield change
@@ -34,29 +35,29 @@ module Samanage
 
     # Create an change given json
     def create_change(payload: nil, options: {})
-      self.execute(path: PATHS[:change], http_method: 'post', payload: payload)
+      self.execute(path: PATHS[:change], http_method: "post", payload: payload)
     end
 
     # Find change by ID
-    def find_change(id: , options: {})
+    def find_change(id:, options: {})
       path = "changes/#{id}.json"
-      if options[:layout] == 'long'
-        path += '?layout=long'
+      if options[:layout] == "long"
+        path += "?layout=long"
       end
       self.execute(path: path)
     end
 
     # Update an change given id and json
-    def update_change(payload: , id: , options: {})
+    def update_change(payload:, id:, options: {})
       path = "changes/#{id}.json"
-      self.execute(path: path, http_method: 'put', payload: payload)
+      self.execute(path: path, http_method: "put", payload: payload)
     end
 
-    def delete_change(id: )
-      self.execute(path: "changes/#{id}.json", http_method: 'delete')
+    def delete_change(id:)
+      self.execute(path: "changes/#{id}.json", http_method: "delete")
     end
 
 
-  alias_method :changes, :collect_changes
+    alias_method :changes, :collect_changes
   end
-end
+end