samanage 1.9.33 → 2.0.03

data/lib/samanage/api/category.rb

@@ -1,26 +1,31 @@
 module Samanage
-	class Api
-		def get_categories(path: PATHS[:category], options: {})
-			url = Samanage::UrlBuilder.new(path: path, options: options).url
-			self.execute(path: url)
-		end
+  class Api
+    def get_categories(path: PATHS[:category], options: {})
+      url = Samanage::UrlBuilder.new(path: path, options: options).url
+      self.execute(path: url)
+    end
 
 
-		# Samanage categories are not paginated
-		# - to break into subcategories, add
-		def collect_categories
-			categories = Array.new
-			categories += self.execute(http_method: 'get', path: "categories.json")[:data]
-		end
+    # Samanage categories are not paginated
+    # - to break into subcategories, add
+    def collect_categories
+      categories = Array.new
+       self.execute(http_method: 'get', path: "categories.json")[:data].each do |category|
+        if block_given?
+          yield category
+        end
+        categories << category
+       end
+    end
 
-		def create_category(payload: nil, options: {})
-			self.execute(path: PATHS[:category], http_method: 'post', payload: payload)
-		end
+    def create_category(payload: nil, options: {})
+      self.execute(path: PATHS[:category], http_method: 'post', payload: payload)
+    end
 
-		# def find_category(name: )
-		# 	self.categories
-		# end
+    def delete_category(id: )
+      self.execute(path: "categories/#{id}", http_method: 'delete')
+    end
 
-	alias_method :categories, :collect_categories
-	end
+  alias_method :categories, :collect_categories
+  end
 end

data/lib/samanage/api/changes.rb

@@ -0,0 +1,59 @@
+module Samanage
+  class Api
+
+    # Default get change path
+    def get_changes(path: PATHS[:change], options: {})
+      url = Samanage::UrlBuilder.new(path: path, options: options).url
+      self.execute(path: url)
+    end
+
+
+    # Returns all changes. 
+    # Options: 
+    #   - audit_archives: true
+    #   - layout: 'long'
+    def collect_changes(options: {})
+      changes = Array.new
+      total_pages = self.get_changes[:total_pages]
+      1.upto(total_pages) do |page|
+      puts "Collecting changes page: #{page}/#{total_pages}" if options[:verbose]
+        layout = options[:layout] == 'long' ? '&layout=long' : nil
+        self.execute(http_method: 'get', path: "changes.json?page=#{page}#{layout}")[:data].each do |change|
+          if block_given?
+            yield change
+          end
+          changes << change
+        end
+      end
+      changes
+    end
+
+
+    # Create an change given json
+    def create_change(payload: nil, options: {})
+      self.execute(path: PATHS[:change], http_method: 'post', payload: payload)
+    end
+
+    # Find change by ID
+    def find_change(id: , options: {})
+      path = "changes/#{id}.json"
+      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: {})
+      path = "changes/#{id}.json"
+      self.execute(path: path, http_method: 'put', payload: payload)
+    end
+
+    def delete_change(id: )
+      self.execute(path: "changes/#{id}.json", http_method: 'delete')
+    end
+
+
+  alias_method :changes, :collect_changes
+  end
+end

data/lib/samanage/api/comments.rb

@@ -1,20 +1,20 @@
 module Samanage
-	class Api
+  class Api
 
 
-		# Find comments given incident_id
-		def get_comments(incident_id: )
-			path = "incidents/#{incident_id}/comments.json"
-			self.execute(path: path)
-		end
+    # Find comments given 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: {})
-			path = "incidents/#{incident_id}/comments.json"
-			self.execute(http_method: 'post', path: path, payload: comment)
-		end
+    # Add a new comment
+    def create_comment(incident_id: , comment: , options: {})
+      path = "incidents/#{incident_id}/comments.json"
+      self.execute(http_method: 'post', path: path, payload: comment)
+    end
 
 
-		alias_method :comments, :get_comments
-	end
+    alias_method :comments, :get_comments
+  end
 end

data/lib/samanage/api/contracts.rb

@@ -1,58 +1,62 @@
 module Samanage
-	class Api
-
-		# Get contract default path
-		def get_contracts(path: PATHS[:contract], options: {})
-			url = Samanage::UrlBuilder.new(path: path, options: options).url
-			self.execute(path: url)
-		end
-
-		# Get all contracts
-		def collect_contracts(options: {})
-			page = 1
-			contracts = Array.new
-			total_pages = self.get_contracts[:total_pages]
-			1.upto(total_pages) do |page|
-				puts "Collecting contracts page: #{page}/#{total_pages}" if options[:verbose]
-				contracts += self.execute(http_method: 'get', path: "contracts.json?page=#{page}")[:data]
-			end
-			contracts
-		end
-
-		# Create contract given json 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: )
-			path = "contracts/#{id}.json"
-			self.execute(path: path)
-		end
-		
-		# Check for contract using URL builder
-		def check_contract(options: {})
-			url = Samanage::UrlBuilder.new(path: PATHS[:contract], options: options).url
-			self.execute(path: url)
-		end
-
-		# Update contract given id
-		def update_contract(payload: , id: , options: {})
-			path = "contracts/#{id}.json"
-			self.execute(path: path, http_method: 'put', payload: payload)
-		end
+  class Api
+
+    # Get contract default path
+    def get_contracts(path: PATHS[:contract], options: {})
+      url = Samanage::UrlBuilder.new(path: path, options: options).url
+      self.execute(path: url)
+    end
+
+    # Get all contracts
+    def collect_contracts(options: {})
+      contracts = Array.new
+      total_pages = self.get_contracts[:total_pages]
+      1.upto(total_pages) do |page|
+        puts "Collecting contracts page: #{page}/#{total_pages}" if options[:verbose]
+        self.execute(http_method: 'get', path: "contracts.json?page=#{page}")[:data].each do |contract|
+          if block_given?
+            yield contract
+          end
+          contracts << contract
+        end
+      end
+      contracts
+    end
+
+    # Create contract given json 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: )
+      path = "contracts/#{id}.json"
+      self.execute(path: path)
+    end
+    
+    # Check for contract using URL builder
+    def check_contract(options: {})
+      url = Samanage::UrlBuilder.new(path: PATHS[:contract], options: options).url
+      self.execute(path: url)
+    end
+
+    # Update contract given id
+    def update_contract(payload: , id: , options: {})
+      path = "contracts/#{id}.json"
+      self.execute(path: path, http_method: 'put', payload: payload)
+    end
 
     def add_item_to_contract(id: , payload: )
       path = "contracts/#{id}/items.json"
       self.execute(path: path, http_method: 'post', payload: payload)
-		end
-		
-		def delete_contract(id: )
+    end
+    
+    def delete_contract(id: )
       self.execute(path: "contracts/#{id}.json", http_method: 'delete')
     end
 
 
 
-	alias_method :contracts, :collect_contracts
-	end
+  alias_method :contracts, :collect_contracts
+  end
 end

data/lib/samanage/api/custom_fields.rb

@@ -1,25 +1,29 @@
 module Samanage
-	class Api
+  class Api
 
-		# Get custom fields default url
-		def get_custom_fields(path: PATHS[:custom_fields], options:{})
-			url = Samanage::UrlBuilder.new(path: path, options: options).url
-			self.execute(path: url)
-		end
+    # Get custom fields default url
+    def get_custom_fields(path: PATHS[:custom_fields], options:{})
+      url = Samanage::UrlBuilder.new(path: path, options: options).url
+      self.execute(path: url)
+    end
 
-		# Gets all custom fields
-		def collect_custom_fields(options: {})
-			page = 1
-			custom_fields = Array.new
-			total_pages = self.get_custom_fields[:total_pages] ||= 2
-			1.upto(total_pages) do |page|
-				puts "Collecting Custom Fields page: #{page}/#{total_pages}" if options[:verbose]
-				custom_fields += self.execute(path: "custom_fields.json")[:data]
-			end
-			custom_fields
-		end
+    # Gets all custom fields
+    def collect_custom_fields(options: {})
+      custom_fields = Array.new
+      total_pages = self.get_custom_fields[:total_pages] ||= 2
+      1.upto(total_pages) do |page|
+        puts "Collecting Custom Fields page: #{page}/#{total_pages}" if options[:verbose]
+        self.execute(path: "custom_fields.json")[:data].each do |custom_field|
+          if block_given?
+            yield custom_field
+          end
+          custom_fields << custom_field 
+        end
+      end
+      custom_fields
+    end
 
 
-		alias_method :custom_fields, :collect_custom_fields
-	end
+    alias_method :custom_fields, :collect_custom_fields
+  end
 end

data/lib/samanage/api/custom_forms.rb

@@ -1,43 +1,47 @@
 module Samanage
-	class Api
-		# Get custom forms path
-		def get_custom_forms(path: PATHS[:custom_forms], options: {})
-			url = Samanage::UrlBuilder.new(path: path, options: options).url
-			self.execute(path: url)
-		end
+  class Api
+    # Get custom forms path
+    def get_custom_forms(path: PATHS[:custom_forms], options: {})
+      url = Samanage::UrlBuilder.new(path: path, options: options).url
+      self.execute(path: url)
+    end
 
-		# Get all custom forms
-		def collect_custom_forms(options: {})
-			page = 1
-			custom_forms = Array.new
-			total_pages = self.get_custom_forms[:total_pages]
-			1.upto(total_pages) do |page|
-				puts "Collecting Custom Forms page: #{page}/#{total_pages}" if options[:verbose]
-				custom_forms += self.execute(http_method: 'get', path: "custom_forms.json?page=#{page}")[:data]
-			end
-			custom_forms
-		end
+    # Get all custom forms
+    def collect_custom_forms(options: {})
+      custom_forms = Array.new
+      total_pages = self.get_custom_forms[:total_pages]
+      1.upto(total_pages) do |page|
+        puts "Collecting Custom Forms page: #{page}/#{total_pages}" if options[:verbose]
+        self.execute(http_method: 'get', path: "custom_forms.json?page=#{page}")[:data].each do |custom_form|
+          if block_given?
+            yield custom_form
+          end
+          custom_forms << custom_form
+        end
+      end
+      custom_forms
+    end
 
-		# 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'] }
-					}
-				}
-		end
+    # 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'] }
+          }
+        }
+    end
 
-		# Get form for a specific object type
-		def form_for(object_type: nil)
-			if self.custom_forms == nil
-				self.custom_forms = self.organize_forms
-			end
-			self.custom_forms[object_type]
-		end
-	end
+    # Get form for a specific object type
+    def form_for(object_type: nil)
+      if self.custom_forms == nil
+        self.custom_forms = self.organize_forms
+      end
+      self.custom_forms[object_type]
+    end
+  end
 end

data/lib/samanage/api/departments.rb

@@ -1,30 +1,33 @@
 module Samanage
-	class Api
-		def get_departments(path: PATHS[:department], options: {})
-			url = Samanage::UrlBuilder.new(path: path, options: options).url
-			self.execute(path: url)
-		end
+  class Api
+    def get_departments(path: PATHS[:department], options: {})
+      url = Samanage::UrlBuilder.new(path: path, options: options).url
+      self.execute(path: url)
+    end
 
-		def collect_departments(options: {})
-			page = 1
-			departments = Array.new
-			total_pages = self.get_departments[:total_pages]
-			1.upto(total_pages) do |page|
-				puts "Collecting Groups page: #{page}/#{total_pages}" if options[:verbose]
-				departments += self.execute(http_method: 'get', path: "departments.json?page=#{page}")[:data]
-				page += 1
-			end
-			departments
-		end
+    def collect_departments(options: {})
+      departments = Array.new
+      total_pages = self.get_departments[:total_pages]
+      1.upto(total_pages) do |page|
+        puts "Collecting Groups page: #{page}/#{total_pages}" if options[:verbose]
+        self.execute(http_method: 'get', path: "departments.json?page=#{page}")[:data].each do |department|
+          if block_given?
+            yield department
+          end
+          departments << department
+        end
+      end
+      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: )
+    end
+    def delete_department(id: )
       self.execute(path: "departments/#{id}.json", http_method: 'delete')
     end
 
-		alias_method :departments, :collect_departments
-	end
+    alias_method :departments, :collect_departments
+  end
 end