samanage 2.1.08 → 2.1.09

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e376a06968afc85a3f7f74f55999d7e548785b1d
-  data.tar.gz: 6939690d8c8d2bfcaeb452a7ff072492f2f80fd1
+  metadata.gz: 1b27ba531435e04046290dc044b89fc0e2f51125
+  data.tar.gz: 203d7b74e6757cc0e8e97344e0e79b7fc97851de
 SHA512:
-  metadata.gz: 6e4af5a38e8f3201079f00bec15360a66cad77dc4312dca56aaaa3afb131e7760ca8508a75baf3a0772ed60cd6798dc2d7c5db10542a047d7f79e9c9e5a33d8e
-  data.tar.gz: 3bf8bc187267a37bdb101a97e0ebd45c9ebe8476851b77ee15ad2ad628a6dbed7273eb709f60c725dd20148ef6824d8683939ddea8c0a60894729be2bb46239b
+  metadata.gz: e44d497c9ff424afe653e29344904dae7290cec74af9c6f3695c00ae376db34136b47f179f83ad9025f46c35e82a31e342deee7a9216640618627fef1112da3b
+  data.tar.gz: 63f2235a968316f2c4617401c15f5e7fef12cf3e463c00621a7baa8e3d2c9d13b37ba89d4331ed4f3daa8853c4154c18e5164ff696c590d80ca6a4995e331a69

data/Gemfile

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gem 'rspec'
 
-gem 'httparty', '0.15.7'
+gem 'httparty', '0.16.4'
 gem 'ffi', '1.9.24'
 group :development do
   gem 'guard-rspec', require: false

data/Gemfile.lock

@@ -22,7 +22,8 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    httparty (0.15.7)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     i18n (1.1.0)
       concurrent-ruby (~> 1.0)
@@ -32,6 +33,9 @@ GEM
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
     method_source (0.9.0)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
     multi_xml (0.6.0)
     nenv (0.3.0)
     notiffany (0.1.1)
@@ -67,7 +71,7 @@ DEPENDENCIES
   faker
   ffi (= 1.9.24)
   guard-rspec
-  httparty (= 0.15.7)
+  httparty (= 0.16.4)
   rspec
 
 BUNDLED WITH

data/changelog.md

@@ -1,3 +1,12 @@
+### 2.1.09
+- Updated HTTParty to 0.16.4
+- Optimize heavy audit+layout incident collection
+- Adding purchase order support
+- Added support for attachments
+- Fix content type inheritance
+- Use body instead of query params
+- Handle HTTPTooManyRequests
+
 ### 2.1.08
 - Correct Message
 

data/lib/samanage.rb

@@ -16,6 +16,7 @@ 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/sites'
 require 'samanage/api/solutions'

data/lib/samanage/api.rb

@@ -7,17 +7,18 @@ module Samanage
     MAX_RETRIES = 3
     PATHS = {
       category: 'categories.json',
-      contract: 'contracts.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',
-      problem: 'problems.json',
       incident: 'incidents.json',
       mobile: 'mobiles.json',
       other_asset: 'other_assets.json',
+      problem: 'problems.json',
+      purchase_order: 'purchase_orders.json',
       site: 'sites.json',
       solution: 'solutions.json',
       user: 'users.json',
@@ -31,7 +32,7 @@ module Samanage
       end
       self.datacenter ||= datacenter.to_s.downcase
       self.base_url =  "https://api#{self.datacenter.to_s.downcase}.samanage.com/"
-      self.content_type = 'json'
+      self.content_type = content_type || 'json'
       self.admins = []
       self.max_retries = max_retries
       if development_mode
@@ -55,9 +56,9 @@ module Samanage
 
     # Calling execute without a method defaults to GET
     def execute(http_method: 'get', path: nil, payload: nil, verbose: nil, headers: {})
-      if payload.class == String && self.content_type == 'json'
+      if payload.class == Hash && self.content_type == 'json'
         begin
-          payload = JSON.parse(payload)
+          payload = payload.to_json
         rescue => e
           puts "Invalid JSON: #{payload.inspect}"
           raise Samanage::Error.new(error: e, response: nil)
@@ -84,17 +85,17 @@ module Samanage
         when 'get'
           api_call = self.class.get(full_path, headers: headers)
         when 'post'
-          api_call = self.class.post(full_path, query: payload, headers: headers)
+          api_call = self.class.post(full_path, body: payload, headers: headers)
         when 'put'
-          api_call = self.class.put(full_path, query: payload, headers: headers)
+          api_call = self.class.put(full_path, body: payload, headers: headers)
         when 'delete'
-          api_call = self.class.delete(full_path, query: payload, headers: headers)
+          api_call = self.class.delete(full_path, body: payload, headers: headers)
         else
           raise Samanage::Error.new(response: {response: 'Unknown HTTP method'})
         end
-      rescue Errno::ECONNREFUSED, Net::OpenTimeout, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError, Errno::ENETDOWN, Errno::ECONNRESET, Errno::ENOENT, EOFError => e
+      rescue Errno::ECONNREFUSED, Net::OpenTimeout, Errno::ETIMEDOUT, OpenSSL::SSL::SSLError, Errno::ENETDOWN, Errno::ECONNRESET, Errno::ENOENT, EOFError, Net::HTTPTooManyRequests => e
         puts "[Warning] #{e.class}: #{e} -  Retry: #{retries}/#{self.max_retries}"
-        sleep 3
+        sleep 5
         retries += 1
         retry if retries < self.max_retries
         error = e

data/lib/samanage/api/attachments.rb

@@ -17,5 +17,26 @@ module Samanage
       end
       downloaded_attachment
     end
+
+    def create_attachment(filepath: , attachable_type: , attachable_id: )
+      if !File.exists?(filepath)
+        puts "Cannot find filepath: '#{filepath.inspect}'"
+        return
+      end
+      self.class.post(
+        self.base_url + 'attachments.json',
+        body: {
+          'file[attachable_type]' =>  attachable_type,
+          'file[attachable_id]' =>  attachable_id,
+          'file[attachment]' =>  File.open(filepath, 'r')
+        },
+        headers: {
+          'Content-Type' => 'multipart/form-data',
+          'X-Samanage-Authorization' => 'Bearer ' + self.token
+        }
+      )
+    end
+
+
   end
 end

data/lib/samanage/api/incidents.rb

@@ -15,17 +15,17 @@ module Samanage
     #   - layout: 'long'
     def collect_incidents(options: {})
       incidents = Array.new
-      total_pages = self.get_incidents(options: options)[:total_pages]
+      total_pages = self.get_incidents(options: options.except(:audit_archives,:audit_archive,:layout))[:total_pages]
       puts "Pulling Incidents with Audit Archives (this may take a while)" if options[:audit_archives] && options[:verbose]
       1.upto(total_pages) do |page|
         puts "Collecting Incidents page: #{page}/#{total_pages}" if options[:verbose]
         if options[:audit_archives]
           options[:page] = page
-          params = URI.encode_www_form(options.except!(:layout,'layout')) # layout not needed as audit only on individual record
+          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?" + params
           paginated_incidents = self.execute(path: paginated_path)[:data]
           paginated_incidents.map do |incident|
-            params = self.set_params(options: options)
+            params = self.set_params(options: options.except(:audit_archives,:audit_archive,:layout))
             archive_uri = "incidents/#{incident['id']}.json?layout=long&audit_archive=true"
             incident_with_archive = self.execute(path: archive_uri)[:data]
             if block_given?

data/lib/samanage/api/purchase_orders.rb

@@ -0,0 +1,62 @@
+module Samanage
+  class Api
+
+    # Default get purchase_order path
+    def get_purchase_orders(path: PATHS[:purchase_order], options: {})
+      params = self.set_params(options: options)
+      path = 'purchase_orders.json?' + params
+      self.execute(path: path)
+    end
+
+
+    # Returns all purchase_orders. 
+    # Options: 
+    #   - audit_archives: true
+    #   - layout: 'long'
+    def collect_purchase_orders(options: {})
+      purchase_orders = Array.new
+      total_pages = self.get_purchase_orders(options: options)[:total_pages]
+      1.upto(total_pages) do |page|
+        options[:page] = page
+        params = self.set_params(options: options)
+        puts "Collecting purchase_orders page: #{page}/#{total_pages}" if options[:verbose]
+        path = "purchase_orders.json?" + params
+        request = self.execute(http_method: 'get', path: path)
+        request[:data].each do |purchase_order|
+          if block_given?
+            yield purchase_order
+          end
+          purchase_orders << purchase_order
+        end
+      end
+      purchase_orders
+    end
+
+
+    # Create an purchase_order given json
+    def create_purchase_order(payload: nil, options: {})
+      self.execute(path: PATHS[:purchase_order], http_method: 'post', payload: payload)
+    end
+
+    # Find purchase_order by ID
+    def find_purchase_order(id: , options: {})
+      path = "purchase_orders/#{id}.json"
+      if options[:layout] == 'long'
+        path += '?layout=long'
+      end
+      self.execute(path: path)
+    end
+
+    # Update an purchase_order given id and json
+    def update_purchase_order(payload: , id: , options: {})
+      path = "purchase_orders/#{id}.json"
+      self.execute(path: path, http_method: 'put', payload: payload)
+    end
+
+    def delete_purchase_order(id: )
+      self.execute(path: "purchase_orders/#{id}.json", http_method: 'delete')
+    end
+
+  alias_method :purchase_orders, :collect_purchase_orders
+  end
+end

data/lib/samanage/api/utils.rb

@@ -1,5 +1,7 @@
 require 'open-uri'
 require 'fileutils'
+
+# API Utils
 module Samanage
   class Api
     def send_activation_email(email: )
@@ -7,5 +9,14 @@ 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
+
+    def find_name_from_group_id(group_id: )
+      return if [-1,'-1',nil,''].include?(group_id)
+      begin
+        self.find_group(id: group_id).to_h.dig(:data,'name')
+      rescue => e
+        return "Unable to find user for group id #{group_id}"
+      end
+    end
   end
 end

data/lib/samanage/utils.rb

@@ -0,0 +1,24 @@
+# Consts and common lookup functions
+module Samanage
+  INCIDENT_ORIGIN = {
+    1 => 'Web',
+    2 => 'Portal',
+    3 => 'API',
+    4 => 'Email'
+  }
+
+  def find_custom_field(custom_fields_values: , field_name:, user_type: false, user_resolve: 'email')
+    result = custom_fields_values.select{|field| field['name'] == field_name}.first.to_h
+    if user_type
+      if user_resolve == 'email'
+        result_value = result.dig('user','email')
+      else
+        result_value = result.dig('user','name')
+      end
+    else
+      result_value =  result.dig('value')
+    end
+    return if [-1,'-1',nil,'',{}].include?(result_value)
+    result_value
+  end
+end

data/lib/samanage/version.rb

@@ -1,3 +1,3 @@
 module Samanage
-  VERSION = '2.1.08'
+  VERSION = '2.1.09'
 end

data/spec/api/samanage_change_spec.rb

@@ -51,7 +51,6 @@ describe Samanage::Api do
       it 'find_change: returns a change card by known id' do
         sample_id = @changes.sample['id']
         change = @samanage.find_change(id: sample_id)
-
         expect(change[:data]['id']).to eq(sample_id)  # id should match found change
         expect(change[:data]).to have_key('name')
         expect(change[:data]).to have_key('requester')

data/spec/api/samanage_department_spec.rb

@@ -32,7 +32,7 @@ describe Samanage::Api do
 
       expect(department_create[:data]['id']).to be_an(Integer)
       expect(department_create[:data]['name']).to eq(department_name)
-      expect(department_create[:code]).to eq(201).or(200)
+      expect(department_create[:code]).to eq(200).or(201)
     end
     it 'deletes a valid department' do
       sample_department_id = @departments.sample.dig('id')

data/spec/api/samanage_group_spec.rb

@@ -1,3 +1,4 @@
+require 'faker'
 require 'samanage'
 describe Samanage::Api do
   context 'group' do
@@ -46,7 +47,6 @@ describe Samanage::Api do
       group_name = group['name']
       group_id = group['id']
       found_group_id = @samanage.find_group_id_by_name(group: group_name)
-
       expect(group_id).to eq(found_group_id)
     end
     it 'returns nil for finding invalid group by name' do

data/spec/api/samanage_purchase_order_spec.rb

@@ -0,0 +1,82 @@
+require 'samanage'
+require 'faker'
+describe Samanage::Api do
+  context 'purchase_orders' do
+    describe 'API Functions' do
+    before(:all) do
+      TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
+      @samanage = Samanage::Api.new(token: TOKEN)
+      @purchase_orders = @samanage.purchase_orders
+      @users = @samanage.get_users[:data]
+    end
+      it 'get_purchase_orders: it returns API call of purchase_orders' do
+        api_call = @samanage.get_purchase_orders
+        expect(api_call).to be_a(Hash)
+        expect(api_call[:total_count]).to be_an(Integer)
+        expect(api_call).to have_key(:response)
+        expect(api_call).to have_key(:code)
+      end
+      it 'collect_purchase_orders: collects array of purchase_orders' do
+        purchase_order_count = @samanage.get_purchase_orders[:total_count]
+        @purchase_orders = @samanage.purchase_orders
+        expect(@purchase_orders).to be_an(Array)
+        expect(@purchase_orders.size).to eq(purchase_order_count)
+      end
+      it 'create_purchase_order(payload: json): creates a purchase_order' do
+        users_email = @samanage.collect_users.sample['email']
+        purchase_order_name = Faker::Book.title
+        json = {
+          purchase_order: {
+            buyer: {email: users_email},
+            name: purchase_order_name,
+            vendor: {name: 'Samanage'}
+          }
+        }
+        purchase_order_create = @samanage.create_purchase_order(payload: json)
+        expect(purchase_order_create[:data]['id']).to be_an(Integer)
+        expect(purchase_order_create[:data]['name']).to eq(purchase_order_name)
+        expect(purchase_order_create[:code]).to eq(200).or(201)
+      end
+      it 'create_purchase_order: fails if no name/title' do
+        users_email = @users.sample['email']
+        json = {
+          :purchase_order => {
+            :buyer => {:email => users_email},
+            :description => "Description"
+          }
+        }
+        expect{@samanage.create_purchase_order(payload: json)}.to raise_error(Samanage::InvalidRequest)
+      end
+      it 'find_purchase_order: returns a purchase_order card by known id' do
+        sample_id = @purchase_orders.sample['id']
+        purchase_order = @samanage.find_purchase_order(id: sample_id)
+        expect(purchase_order[:data]['id']).to eq(sample_id)  # id should match found purchase_order
+        expect(purchase_order[:data]).to have_key('name')
+        expect(purchase_order[:data]).to have_key('id')
+      end
+
+      it 'find_purchase_order: returns nothing for an invalid id' do
+        sample_id = (0..10).entries.sample
+        expect{@samanage.find_purchase_order(id: sample_id)}.to raise_error(Samanage::NotFound)  # id should match found purchase_order
+      end
+      it 'update_purchase_order: update_purchase_order by id' do
+        sample_purchase_order = @purchase_orders.reject{|i| ['Closed','Resolved'].include? i['state']}.sample
+        sample_id = sample_purchase_order['id']
+        description = (0...500).map { ('a'..'z').to_a[rand(26)] }.join
+        purchase_order_json = {
+          :purchase_order => {
+            :description => description
+          }
+        }
+        purchase_order_update = @samanage.update_purchase_order(payload: purchase_order_json, id: sample_id)
+        # expect(purchase_order_update[:data]['description']).to eq(description) # purchase_order bug #00044569
+        expect(purchase_order_update[:code]).to eq(200).or(201)
+      end
+      it 'deletes a valid purchase_order' do
+        sample_purchase_order_id = @purchase_orders.sample['id']
+        purchase_order_delete = @samanage.delete_purchase_order(id: sample_purchase_order_id)
+        expect(purchase_order_delete[:code]).to eq(200).or(201)
+      end
+    end
+  end
+end

data/spec/api/samanage_site_spec.rb

@@ -1,4 +1,5 @@
 require 'samanage'
+require 'faker'
 describe Samanage::Api do
   context 'Site' do
     before(:all) do
@@ -34,7 +35,7 @@ describe Samanage::Api do
 
       expect(site_create[:data]['id']).to be_an(Integer)
       expect(site_create[:data]['name']).to eq(site_name)
-      expect(site_create[:code]).to eq(201).or(200)
+      expect(site_create[:code]).to eq(200).or(201)
     end
     it 'deletes a valid site' do
       sample_site_id = @sites.sample['id']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samanage
 version: !ruby/object:Gem::Version
-  version: 2.1.08
+  version: 2.1.09
 platform: ruby
 authors:
 - Chris Walls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2019-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -67,6 +67,7 @@ files:
 - lib/samanage/api/mobiles.rb
 - lib/samanage/api/other_assets.rb
 - lib/samanage/api/problems.rb
+- lib/samanage/api/purchase_orders.rb
 - lib/samanage/api/requester.rb
 - lib/samanage/api/sites.rb
 - lib/samanage/api/solutions.rb
@@ -76,6 +77,7 @@ files:
 - lib/samanage/error.rb
 - lib/samanage/language.rb
 - lib/samanage/url_builder.rb
+- lib/samanage/utils.rb
 - lib/samanage/version.rb
 - samanage.gemspec
 - sample_file.txt
@@ -93,6 +95,7 @@ files:
 - spec/api/samanage_mobile_spec.rb
 - spec/api/samanage_other_asset_spec.rb
 - spec/api/samanage_problem_spec.rb
+- spec/api/samanage_purchase_order_spec.rb
 - spec/api/samanage_site_spec.rb
 - spec/api/samanage_solution_spec.rb
 - spec/api/samanage_time_tracks_spec.rb