samanage 1.9.33 → 2.0.03

data/lib/samanage/api/requester.rb

@@ -1,9 +1,9 @@
 module Samanage
-	class Api
-		# Get requester from value (email)
-		def get_requester_id(value: )
-			api_call = self.execute(path: "requesters.json?name=#{value}")
-			api_call[:data].size == 1 ? api_call[:data][0] : nil
-		end
-	end
+  class Api
+    # Get requester from value (email)
+    def get_requester_id(value: )
+      api_call = self.execute(path: "requesters.json?name=#{value}")
+      api_call[:data].size == 1 ? api_call[:data][0] : nil
+    end
+  end
 end

data/lib/samanage/api/sites.rb

@@ -1,29 +1,33 @@
 module Samanage
-	class Api
-		def get_sites(path: PATHS[:site], options: {})
-			url = Samanage::UrlBuilder.new(path: path, options: options).url
-			self.execute(path: url)
-		end
+  class Api
+    def get_sites(path: PATHS[:site], options: {})
+      url = Samanage::UrlBuilder.new(path: path, options: options).url
+      self.execute(path: url)
+    end
 
-		def collect_sites(options: {})
-			page = 1
-			sites = Array.new
-			total_pages = self.get_sites[:total_pages]
-			1.upto(total_pages) do |page|
-				puts "Collecting Sites page: #{page}/#{total_pages}" if options[:verbose]
-				sites += self.execute(http_method: 'get', path: "sites.json?page=#{page}")[:data]
-			end
-			sites
-		end
+    def collect_sites(options: {})
+      sites = Array.new
+      total_pages = self.get_sites[:total_pages]
+      1.upto(total_pages) do |page|
+        puts "Collecting Sites page: #{page}/#{total_pages}" if options[:verbose]
+        self.execute(http_method: 'get', path: "sites.json?page=#{page}")[:data].each do |site|
+          if block_given?
+            yield site
+          end
+          sites << site
+        end
+      end
+      sites
+    end
 
-		def create_site(payload: , options: {})
-			self.execute(path: PATHS[:site], http_method: 'post', payload: payload)
-		end
+    def create_site(payload: , options: {})
+      self.execute(path: PATHS[:site], http_method: 'post', payload: payload)
+    end
 
-		def delete_site(id: )
-			self.execute(path: "sites/#{id}.json", http_method: 'delete')
-		end
+    def delete_site(id: )
+      self.execute(path: "sites/#{id}.json", http_method: 'delete')
+    end
 
-	alias_method :sites, :collect_sites
-	end
+  alias_method :sites, :collect_sites
+  end
 end

data/lib/samanage/api/users.rb

@@ -1,73 +1,77 @@
 module Samanage
-	class Api
+  class Api
 
-	# Get users, using URL builder
-	def get_users(path: PATHS[:user], options: {})
+  # Get users, using URL builder
+  def get_users(path: PATHS[:user], options: {})
     url = Samanage::UrlBuilder.new(path: path, options: options).url
     self.execute(path: url)
-	end
+  end
 
   # Returns all users in the account
-		def collect_users(options: {})
-			page = 1
-			users = Array.new
-			total_pages = self.get_users[:total_pages]
-			1.upto(total_pages) do |page|
-				puts "Collecting Users page: #{page}/#{total_pages}" if options[:verbose]
-				users += self.execute(http_method: 'get', path: "users.json?page=#{page}")[:data]
-			end
-			users
-		end
+    def collect_users(options: {})
+      users = Array.new
+      total_pages = self.get_users[:total_pages]
+      1.upto(total_pages) do |page|
+        puts "Collecting Users page: #{page}/#{total_pages}" if options[:verbose]
+        self.execute(http_method: 'get', path: "users.json?page=#{page}")[:data].each do |user|
+          if block_given?
+            yield user
+          end
+          users << user
+        end
+      end
+      users
+    end
 
-		# Create user given JSON
-		def create_user(payload: , options: {})
-			self.execute(path: PATHS[:user], http_method: 'post', payload: payload)
-		end
+    # Create user given JSON
+    def create_user(payload: , options: {})
+      self.execute(path: PATHS[:user], http_method: 'post', payload: payload)
+    end
 
     # Return user by ID
-		def find_user(id: )
-			path = "users/#{id}.json"
-			self.execute(path: path)
-		end
+    def find_user(id: )
+      path = "users/#{id}.json"
+      self.execute(path: path)
+    end
 
-		# 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']
-		end
+    # 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']
+    end
 
-		# Returns nil if no matching group_id
-		def find_user_group_id_by_email(email: )
-			user = self.check_user(value: email)
-			group_ids = user[:data].select{|u| u['email'].to_s.downcase == email.to_s.downcase}.first.to_h['group_ids'].to_a
-			group_ids.each do |group_id|
-				group = self.find_group(id: group_id)
-				if group[:data]['is_user'] && email == group[:data]['email']
-					return group_id
-				end
-			end
-			return nil
-		end
+    # Returns nil if no matching group_id
+    def find_user_group_id_by_email(email: )
+      user = self.check_user(value: email)
+      group_ids = user[:data].select{|u| u['email'].to_s.downcase == email.to_s.downcase}.first.to_h['group_ids'].to_a
+      group_ids.each do |group_id|
+        group = self.find_group(id: group_id)
+        if group[:data]['is_user'] && email == group[:data]['email']
+          return group_id
+        end
+      end
+      return nil
+    end
 
     # Check for user by field (ex: users.json?field=value)
-		def check_user(field: 'email', value: )
-			if field.to_s.downcase == 'email'
-				value = value.to_s.gsub("+",'%2B')
-			end
-			url = "users.json?#{field}=#{value}"
-			self.execute(path: url)
-		end
+    def check_user(field: 'email', value: )
+      if field.to_s.downcase == 'email'
+        value = value.to_s.gsub("+",'%2B')
+      end
+      url = "users.json?#{field}=#{value}"
+      self.execute(path: url)
+    end
 
     # Update user by id
-		def update_user(payload: , id: )
-			path = "users/#{id}.json"
-			self.execute(path: path, http_method: 'put', payload: payload)
-		end
+    def update_user(payload: , id: )
+      path = "users/#{id}.json"
+      self.execute(path: path, http_method: 'put', payload: payload)
+    end
 
-		def delete_user(id: )
+    def delete_user(id: )
       self.execute(path: "users/#{id}.json", http_method: 'delete')
-		end
+    end
 
-	alias_method :users, :collect_users
-	end
+  alias_method :users, :collect_users
+  end
 end

data/lib/samanage/api/utils.rb

@@ -7,24 +7,5 @@ module Samanage
       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
-
-    # Downloads a Samanage Attachment object can overwrite default filename and path (Object/ObjectID/Original_Filename)
-    def download_attachment(attachment: {}, filename: nil, path: nil)
-      attachable_type = attachment['attachable_type']
-      attachable_id = attachment['attachable_id'].to_s
-      filename = filename || attachment['filename']
-      url = attachment['url']
-      
-      file_path = path ?  path : File.join(Dir.pwd,attachable_type,attachable_id)
-      unless File.directory?(file_path)
-        FileUtils.mkpath(file_path)
-      end
-      
-      exact_path = File.join(file_path,filename)
-      downloaded_attachment = open(exact_path, "wb+") do |file|
-        file << open(url).read
-      end
-      downloaded_attachment
-    end
   end
 end

data/lib/samanage/error.rb

@@ -1,28 +1,28 @@
 module Samanage
-	class Error < StandardError
-		attr_accessor :status_code, :response, :error
-		
-		def initialize(error: nil, response: {})
-			self.error = error
-			if response.class == Hash
-				self.status_code = response[:code]
-				self.response = response[:data] ||= response[:response]
-			else
-				self.status_code = nil
-				self.response = response
-			end
+  class Error < StandardError
+    attr_accessor :status_code, :response, :error
+    
+    def initialize(error: nil, response: {})
+      self.error = error
+      if response.class == Hash
+        self.status_code = response[:code]
+        self.response = response[:data] ||= response[:response]
+      else
+        self.status_code = nil
+        self.response = response
+      end
 
-			puts "[Error] #{self.status_code}: #{self.response}"
-		end
-	end
+      puts "[Error] #{self.status_code}: #{self.response}"
+    end
+  end
 
-	# API Errors
-	class SamanageError < Error; end
+  # API Errors
+  class SamanageError < Error; end
 
-	class AuthorizationError < SamanageError; end
+  class AuthorizationError < SamanageError; end
 
-	class InvalidRequest < SamanageError; end
+  class InvalidRequest < SamanageError; end
 
-	class NotFound < SamanageError; end
+  class NotFound < SamanageError; end
 
 end

data/lib/samanage/url_builder.rb

@@ -1,60 +1,60 @@
 module Samanage
-	class UrlBuilder
-		attr_accessor :url
-		@url = ''
+  class UrlBuilder
+    attr_accessor :url
+    @url = ''
 
-		def initialize(path: nil,options: nil)
-			self.url =  map_path(path: path, options: options)
-			return url
-		end
+    def initialize(path: nil,options: nil)
+      self.url =  map_path(path: path, options: options)
+      return url
+    end
 
 
-		def map_path(path: nil, options: nil)
-			url = String.new
-			parameters = String.new
-			case path
-			when /user/
-				url += 'users'
-			when /hardware/
-				url += 'hardwares'
-			when /other_asset/
-				url += 'other_assets'
-			when /incident/
-				url += 'incidents'
-			when /change/
-				url += 'changes'
-			when /custom_field/
-				url += 'custom_fields'
-			when /custom_form/
-				url += 'custom_forms'
-			when /mobile/
-				url += 'mobiles'
-			when /site/
-				url += 'sites'
-			when /department/
-				url += 'departments'
-			when /contract/
-				url += 'contracts'
-			when /group/
-				url += 'groups'
-			end
+    def map_path(path: nil, options: nil)
+      url = String.new
+      parameters = String.new
+      case path
+      when /user/
+        url += 'users'
+      when /hardware/
+        url += 'hardwares'
+      when /other_asset/
+        url += 'other_assets'
+      when /incident/
+        url += 'incidents'
+      when /change/
+        url += 'changes'
+      when /custom_field/
+        url += 'custom_fields'
+      when /custom_form/
+        url += 'custom_forms'
+      when /mobile/
+        url += 'mobiles'
+      when /site/
+        url += 'sites'
+      when /department/
+        url += 'departments'
+      when /contract/
+        url += 'contracts'
+      when /group/
+        url += 'groups'
+      end
 
-			if path.match(/(\d)+/)
-				url += "/" + path.match(/(\d)+/)[0] + ".json"
-				return url
-			end
+      if path.match(/(\d)+/)
+        url += "/" + path.match(/(\d)+/)[0] + ".json"
+        return url
+      end
 
-			options.each_pair do |field, value|
-				if field.to_s == 'id' && value.to_s.match(/(\d)+/)
-					url += "/#{value}.json"
-					# Return. Filters not valid on an id
-					return url
-				end
-				sub_param = "?#{field}=#{value}"
-				parameters += sub_param + '&'
-			end
-			url += ".json" + parameters
-			return url
-		end
-	end
+      options.each_pair do |field, value|
+        if field.to_s == 'id' && value.to_s.match(/(\d)+/)
+          url += "/#{value}.json"
+          # Return. Filters not valid on an id
+          return url
+        end
+        sub_param = "?#{field}=#{value}"
+        parameters += sub_param + '&'
+      end
+      url += ".json" + parameters
+      return url
+    end
+  end
 end

data/lib/samanage/version.rb

@@ -1,3 +1,3 @@
 module Samanage
-  VERSION = '1.9.33'
-end
+  VERSION = '2.0.03'
+end

data/samanage.gemspec

@@ -14,6 +14,6 @@ Gem::Specification.new do |s|
   s.license                 = 'MIT'
   s.require_paths           = ["lib"]
   s.required_ruby_version   = '>= 2.3'
-  s.add_development_dependency 'httparty', ['~> 0.15']
-  s.add_runtime_dependency 'httparty', ['~> 0.15']
+  s.add_development_dependency 'httparty', ['0.15.7']
+  s.add_runtime_dependency 'httparty', ['0.15.7']
 end

data/sample_file.txt

@@ -0,0 +1 @@
+blah blah blah

data/spec/api/samanage_attachment_spec.rb

@@ -0,0 +1,14 @@
+
+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
+    end
+  end
+end

data/spec/api/samanage_category_spec.rb

@@ -1,29 +1,29 @@
 require 'samanage'
 describe Samanage::Api do
-	context 'category' do
-		before(:all) do
-			TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
-			@samanage = Samanage::Api.new(token: TOKEN)
-			@categories = @samanage.categories
-		end
-		it 'collects all categories' do
-			expect(@categories).to be_an(Array)
-		end
+  context 'category' do
+    before(:all) do
+      TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
+      @samanage = Samanage::Api.new(token: TOKEN)
+      @categories = @samanage.categories
+    end
+    it 'collects all categories' do
+      expect(@categories).to be_an(Array)
+    end
 
-		it 'creates a category' do
-			category_name = "Category Name ##{(rand*10**4).ceil}"
-			category_description = "Descrption #{(rand*10**4).ceil}"
-			payload = {
-				category: {
-					name: category_name,
-					description: category_description
-				}
-			}
-			category_create = @samanage.create_category(payload: payload)
+    it 'creates a category' do
+      category_name = "Category Name ##{(rand*10**4).ceil}"
+      category_description = "Descrption #{(rand*10**4).ceil}"
+      payload = {
+        category: {
+          name: category_name,
+          description: category_description
+        }
+      }
+      category_create = @samanage.create_category(payload: payload)
 
-			expect(category_create[:data]['id']).to be_an(Integer)
-			expect(category_create[:data]['name']).to eq(category_name)
-			expect(category_create[:code]).to eq(200).or(201)
-		end
-	end
+      expect(category_create[:data]['id']).to be_an(Integer)
+      expect(category_create[:data]['name']).to eq(category_name)
+      expect(category_create[:code]).to eq(200).or(201)
+    end
+  end
 end