samanage 2.1.06 → 2.1.07

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57907ba419f116d71c6213300a479cb66c295fb2
-  data.tar.gz: 5596f9279a0a966be653698370b0a7656d6ff492
+  metadata.gz: ece5c3016e90c18aaf34302957f04396f3853650
+  data.tar.gz: 6f618e3d780ade5f0311f3ff76e611ab3ebc5dfc
 SHA512:
-  metadata.gz: 037f7a2eb6dfcbea53e665458915205574141b560c31fc8808a89c705e2fa9d0daa7621946215b44d3912630fb9d16f2a5824a06f793ad8191b8ac96a912e78b
-  data.tar.gz: 659da3f6311b6810d69a1107ca8ca545da3c82010decf93c727dd702d698cf1671802bad00b83395754720551c2c98cb4db7529f7d279a7c5859d322cb26488c
+  metadata.gz: 760118d00c46695d9ca41e8cbbd529225cc83b0e46b7c8c194d1b1f76612f99f4afec0dcae310bccd5f2376d12fea29cc43e3279a01b30349584c9793d054d8f
+  data.tar.gz: 4331fcb97fcdfd58986985c93a2c576d6d4e4fce06f36f5b1a9ff4474e86e704453c6166a07da09f4326cd1b028a470c3707b5e7a455e6798a920fe217e9cbcc

data/changelog.md

@@ -1,3 +1,6 @@
+### 2.1.07
+- Added problems
+
 ### 2.1.06 
 - Added time track support
 ### 2.1.05

data/lib/samanage.rb

@@ -15,6 +15,7 @@ require 'samanage/api/hardwares'
 require 'samanage/api/incidents'
 require 'samanage/api/mobiles'
 require 'samanage/api/other_assets'
+require 'samanage/api/problems'
 require 'samanage/api/requester'
 require 'samanage/api/sites'
 require 'samanage/api/solutions'

data/lib/samanage/api.rb

@@ -14,6 +14,7 @@ module Samanage
       department: 'departments.json',
       group: 'groups.json',
       hardware: 'hardwares.json',
+      problem: 'problems.json',
       incident: 'incidents.json',
       mobile: 'mobiles.json',
       other_asset: 'other_assets.json',

data/lib/samanage/api/problems.rb

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

data/lib/samanage/url_builder.rb

@@ -37,6 +37,8 @@ module Samanage
         url += 'solutions'
       when /contract/
         url += 'contracts'
+      when /problem/
+        url += 'problems'
       when /group/
         url += 'groups'
       end

data/lib/samanage/version.rb

@@ -1,3 +1,3 @@
 module Samanage
-  VERSION = '2.1.06'
+  VERSION = '2.1.07'
 end

data/spec/api/samanage_problem_spec.rb

@@ -0,0 +1,100 @@
+require 'samanage'
+require 'faker'
+describe Samanage::Api do
+  context 'problems' do
+    describe 'API Functions' do
+    before(:all) do
+      TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
+      @samanage = Samanage::Api.new(token: TOKEN)
+      @problems = @samanage.problems
+      @users = @samanage.get_users[:data]
+    end
+      it 'get_problems: it returns API call of problems' do
+        api_call = @samanage.get_problems
+        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_problems: collects array of problems' do
+        problem_count = @samanage.get_problems[:total_count]
+        @problems = @samanage.problems
+        expect(@problems).to be_an(Array)
+        expect(@problems.size).to eq(problem_count)
+      end
+      it 'create_problem(payload: json): creates a problem' do
+        users_email = @samanage.collect_users.sample['email']
+        problem_name = Faker::Book.title
+        json = {
+          problem: {
+            requester: {email: users_email},
+            name: problem_name,
+            state: 'Open',
+            priority: 'Low',
+            description: "Description"
+          }
+        }
+        problem_create = @samanage.create_problem(payload: json)
+
+        expect(problem_create[:data]['id']).to be_an(Integer)
+        expect(problem_create[:data]['name']).to eq(problem_name)
+        expect(problem_create[:code]).to eq(200).or(201)
+      end
+      it 'create_problem: fails if no name/title' do
+        users_email = @users.sample['email']
+        json = {
+          :problem => {
+            :requester => {:email => users_email},
+            :description => "Description"
+          }
+        }
+        expect{@samanage.create_problem(payload: json)}.to raise_error(Samanage::InvalidRequest)
+      end
+      it 'find_problem: returns a problem card by known id' do
+        sample_id = @problems.sample['id']
+        problem = @samanage.find_problem(id: sample_id)
+
+        expect(problem[:data]['id']).to eq(sample_id)  # id should match found problem
+        expect(problem[:data]).to have_key('name')
+        expect(problem[:data]).to have_key('requester')
+        expect(problem[:data]).to have_key('id')
+      end
+      it 'find_problem: returns more keys with layout=long' do
+        sample_id = @problems.sample['id']
+        layout_regular_problem = @samanage.find_problem(id: sample_id)
+        layout_long_problem = @samanage.find_problem(id: sample_id, options: {layout: 'long'})
+
+        expect(layout_long_problem[:data]['id']).to eq(sample_id)  # id should match found problem
+        expect(layout_long_problem[:data].keys.size).to be > (layout_regular_problem.keys.size)
+        expect(layout_long_problem[:data].keys - layout_regular_problem[:data].keys).to_not be([])
+      end
+      it 'find_problem: returns nothing for an invalid id' do
+        sample_id = (0..10).entries.sample
+        expect{@samanage.find_problem(id: sample_id)}.to raise_error(Samanage::NotFound)  # id should match found problem
+      end
+      it 'update_problem: update_problem by id' do
+        sample_problem = @problems.reject{|i| ['Closed','Resolved'].include? i['state']}.sample
+        sample_id = sample_problem['id']
+        description = (0...500).map { ('a'..'z').to_a[rand(26)] }.join
+        problem_json = {
+          :problem => {
+            :description => description
+          }
+        }
+        problem_update = @samanage.update_problem(payload: problem_json, id: sample_id)
+        # expect(problem_update[:data]['description']).to eq(description) # problem bug #00044569
+        expect(problem_update[:code]).to eq(200).or(201)
+      end
+      it 'finds more data for option[:layout] = "long"' do
+        full_layout_problem_keys = @samanage.problems(options: {layout: 'long'}).first.keys
+        basic_problem_keys = @samanage.problems.sample.keys
+        expect(basic_problem_keys.size).to be < full_layout_problem_keys.size
+      end
+      it 'deletes a valid problem' do
+        sample_problem_id = @problems.sample['id']
+        problem_delete = @samanage.delete_problem(id: sample_problem_id)
+        expect(problem_delete[:code]).to eq(200).or(201)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samanage
 version: !ruby/object:Gem::Version
-  version: 2.1.06
+  version: 2.1.07
 platform: ruby
 authors:
 - Chris Walls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -66,6 +66,7 @@ files:
 - lib/samanage/api/incidents.rb
 - lib/samanage/api/mobiles.rb
 - lib/samanage/api/other_assets.rb
+- lib/samanage/api/problems.rb
 - lib/samanage/api/requester.rb
 - lib/samanage/api/sites.rb
 - lib/samanage/api/solutions.rb
@@ -91,6 +92,7 @@ files:
 - spec/api/samanage_incident_spec.rb
 - spec/api/samanage_mobile_spec.rb
 - spec/api/samanage_other_asset_spec.rb
+- spec/api/samanage_problem_spec.rb
 - spec/api/samanage_site_spec.rb
 - spec/api/samanage_solution_spec.rb
 - spec/api/samanage_time_tracks_spec.rb