samanage 2.1.19 → 2.1.20

data/samanage.gemspec

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 $:.push File.expand_path("../lib", __FILE__)
-require 'samanage'
+require "samanage"
 
 Gem::Specification.new do |s|
-  s.name                    = 'samanage'
+  s.name                    = "samanage"
   s.version                 =  Samanage::VERSION
   s.date                    =  Date.today.strftime("%Y-%m-%d")
   s.summary                 = "Samanage Ruby Gem"
   s.description             = "Connect to Samanage using Ruby!"
   s.authors                 = ["Chris Walls"]
-  s.email                   = 'cwalls2908@gmail.com'
+  s.email                   = "cwalls2908@gmail.com"
   s.files                   = `git ls-files`.split("\n")
-  s.homepage                = 'https://github.com/cw2908/samanage-ruby'
-  s.license                 = 'MIT'
+  s.homepage                = "https://github.com/cw2908/samanage-ruby"
+  s.license                 = "MIT"
   s.require_paths           = ["lib"]
-  s.required_ruby_version   = '>= 2.3'
-  s.add_development_dependency 'httparty', ['0.16.4']
-  s.add_runtime_dependency 'httparty', ['0.16.4']
-end
+  s.required_ruby_version   = ">= 2.3"
+  s.add_development_dependency "httparty", ["0.16.4"]
+  s.add_runtime_dependency "httparty", ["0.16.4"]
+end

data/spec/api/samanage_attachment_spec.rb

@@ -1,43 +1,44 @@
+# frozen_string_literal: true
 
-require 'samanage'
+require "samanage"
 describe Samanage::Api do
-  context 'Attachments' do
-    describe 'API Functions' do
-      before(:all) do 
-        TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
+  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
-      it 'uploads an attachment' do
-        filename = 'sample_file.txt'
+      it "uploads an attachment" do
+        filename = "sample_file.txt"
         filepath = File.join(Dir.pwd, filename)
-        incident_id = @incidents.sample.dig('id')
+        incident_id = @incidents.sample.dig("id")
         attach = @samanage.create_attachment(
           filepath: filepath,
           attachable_id: incident_id,
-          attachable_type: 'Incident'
+          attachable_type: "Incident"
         )
         expect(attach[:code]).to eq(200).or(201)
-        expect(filename).to eq(attach[:data]['filename'])
-        expect(File.open(filepath).size).to eq(attach[:data]['size'])
+        expect(filename).to eq(attach[:data]["filename"])
+        expect(File.open(filepath).size).to eq(attach[:data]["size"])
       end
-      it 'downloads an attachment' do
-        incident_id = @incidents.sample.dig('id')
-        filename = 'sample_file.txt'
+      it "downloads an attachment" do
+        incident_id = @incidents.sample.dig("id")
+        filename = "sample_file.txt"
         filepath = File.join(Dir.pwd, filename)
         attach = @samanage.create_attachment(
           filepath: filepath,
           attachable_id: incident_id,
-          attachable_type: 'Incident'
+          attachable_type: "Incident"
         )
         expect(attach[:code]).to eq(200).or(201)
         attachable_incident_id = incident_id # Need filter for has attachment?
-        incident = @samanage.find_incident(id: attachable_incident_id, options: {layout: 'long'})
-        attachment = @samanage.download_attachment(attachment: incident[:data]['attachments'].first)
+        incident = @samanage.find_incident(id: attachable_incident_id, options: { layout: "long" })
+        attachment = @samanage.download_attachment(attachment: incident[:data]["attachments"].first)
         expect(attachment.class).to be(File)
-        expect(attachment.path.split('/').last).to eq(filename)
+        expect(attachment.path.split("/").last).to eq(filename)
       end
     end
   end
-end
+end

data/spec/api/samanage_category_spec.rb

@@ -1,18 +1,20 @@
-require 'samanage'
+# frozen_string_literal: true
+
+require "samanage"
 describe Samanage::Api do
-  context 'category' do
+  context "category" do
     before(:all) do
-      TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
+      TOKEN ||= ENV["SAMANAGE_TEST_API_TOKEN"]
       @samanage = Samanage::Api.new(token: TOKEN)
       @categories = @samanage.categories
     end
-    it 'collects all categories' do
+    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}"
+    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,
@@ -21,9 +23,9 @@ describe Samanage::Api do
       }
       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[: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
+end

data/spec/api/samanage_change_spec.rb

@@ -1,81 +1,84 @@
-require 'samanage'
+# frozen_string_literal: true
+
+require "samanage"
 describe Samanage::Api do
-  context 'changes' do
-    describe 'API Functions' do
-    before(:all) do
-      TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
-      @samanage = Samanage::Api.new(token: TOKEN)
-      @changes = @samanage.changes
-      @users = @samanage.get_users[:data]
-    end
-      it 'get_changes: it returns API call of changes' do
+  context "changes" do
+    describe "API Functions" do
+      before(:all) do
+        TOKEN ||= ENV["SAMANAGE_TEST_API_TOKEN"]
+        @samanage = Samanage::Api.new(token: TOKEN)
+        @changes = @samanage.changes
+        @users = @samanage.get_users[:data]
+      end
+      it "get_changes: it returns API call of changes" do
         api_call = @samanage.get_changes
         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_changes: collects array of changes' do
+      it "collect_changes: collects array of changes" do
         change_count = @samanage.get_changes[:total_count]
         @changes = @samanage.changes
         expect(@changes).to be_an(Array)
         expect(@changes.size).to eq(change_count)
       end
-      it 'create_change(payload: json): creates a change' do
-        users_email = @samanage.collect_users.sample['email']
+      it "create_change(payload: json): creates a change" do
+        users_email = @samanage.collect_users.sample["email"]
         change_name = "Samanage Ruby change"
         json = {
           change: {
-            requester: {email: users_email},
+            requester: { email: users_email },
             name: change_name,
-            priority: 'Low',
+            priority: "Low",
             description: "Description"
           }
         }
         change_create = @samanage.create_change(payload: json)
 
-        expect(change_create[:data]['id']).to be_an(Integer)
-        expect(change_create[:data]['name']).to eq(change_name)
+        expect(change_create[:data]["id"]).to be_an(Integer)
+        expect(change_create[:data]["name"]).to eq(change_name)
         expect(change_create[:code]).to eq(200).or(201)
       end
-      it 'create_change: fails if no name/title' do
-        users_email = @users.sample['email']
+      it "create_change: fails if no name/title" do
+        users_email = @users.sample["email"]
         json = {
-          :change => {
-            :requester => {:email => users_email},
-            :description => "Description"
+          change: {
+            requester: { email: users_email },
+            description: "Description"
           }
         }
-        expect{@samanage.create_change(payload: json)}.to raise_error(Samanage::InvalidRequest)
+        expect { @samanage.create_change(payload: json) }.to raise_error(Samanage::InvalidRequest)
       end
-      it 'find_change: returns a change card by known id' do
-        sample_id = @changes.sample['id']
+      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')
-        expect(change[:data]).to have_key('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")
+        expect(change[:data]).to have_key("id")
       end
-      it 'find_change: returns more keys with layout=long' do
-        sample_id = @changes.sample['id']
+      it "find_change: returns more keys with layout=long" do
+        sample_id = @changes.sample["id"]
         layout_regular_change = @samanage.find_change(id: sample_id)
-        layout_long_change = @samanage.find_change(id: sample_id, options: {layout: 'long'})
+        layout_long_change = @samanage.find_change(id: sample_id, options: { layout: "long" })
 
-        expect(layout_long_change[:data]['id']).to eq(sample_id)  # id should match found change
+        expect(layout_long_change[:data]["id"]).to eq(sample_id)  # id should match found change
         expect(layout_long_change[:data].keys.size).to be > (layout_regular_change.keys.size)
         expect(layout_long_change[:data].keys - layout_regular_change[:data].keys).to_not be([])
       end
-      it 'find_change: returns nothing for an invalid id' do
+      it "find_change: returns nothing for an invalid id" do
         sample_id = (0..10).entries.sample
-        expect{@samanage.find_change(id: sample_id)}.to raise_error(Samanage::NotFound)  # id should match found change
+        # id should match found change
+        expect { @samanage.find_change(id: sample_id) }.to raise_error(Samanage::NotFound)
       end
-      it 'update_change: update_change by id' do
-        sample_change = @changes.reject{|i| ['Closed','Resolved'].include? i['state']}.sample
-        sample_id = sample_change['id']
-        description = (0...500).map { ('a'..'z').to_a[rand(26)] }.join
+      it "update_change: update_change by id" do
+        sample_change = @changes.reject { |i| ["Closed", "Resolved"].include? i["state"] }.sample
+        sample_id = sample_change["id"]
+        description = (0...500).map { ("a".."z").to_a[rand(26)] }.join
         change_json = {
-          :change => {
-            :description => description
+          change: {
+            description: description
           }
         }
         change_update = @samanage.update_change(payload: change_json, id: sample_id)
@@ -83,12 +86,12 @@ describe Samanage::Api do
         expect(change_update[:code]).to eq(200).or(201)
       end
       it 'finds more data for option[:layout] = "long"' do
-        full_layout_change_keys = @samanage.changes(options: {layout: 'long'}).first.keys
+        full_layout_change_keys = @samanage.changes(options: { layout: "long" }).first.keys
         basic_change_keys = @samanage.changes.sample.keys
         expect(basic_change_keys.size).to be < full_layout_change_keys.size
       end
-      it 'deletes a valid change' do
-        sample_change_id = @changes.sample['id']
+      it "deletes a valid change" do
+        sample_change_id = @changes.sample["id"]
         change_delete = @samanage.delete_change(id: sample_change_id)
         expect(change_delete[:code]).to eq(200).or(201)
       end

data/spec/api/samanage_comments_spec.rb

@@ -1,21 +1,23 @@
-require 'samanage'
+# frozen_string_literal: true
+
+require "samanage"
 describe Samanage::Api do
-  context 'Comments' do
+  context "Comments" do
     before(:all) do
-      TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
+      TOKEN ||= ENV["SAMANAGE_TEST_API_TOKEN"]
       @samanage = Samanage::Api.new(token: TOKEN)
       @incidents = @samanage.get_incidents[:data]
     end
-    describe 'API Functions' do
-      it 'gets comments' do
-        incident_id = @incidents.sample.dig('id')
+    describe "API Functions" do
+      it "gets comments" do
+        incident_id = @incidents.sample.dig("id")
         comments = @samanage.get_comments(incident_id: incident_id)
         expect(comments).to be_a(Hash)
       end
 
-      it 'creates a comment' do
-        incident_id = @incidents.sample.dig('id')
-        rand_text = ('a'..'z').to_a.shuffle[0,8].join
+      it "creates a comment" do
+        incident_id = @incidents.sample.dig("id")
+        rand_text = ("a".."z").to_a.shuffle[0, 8].join
         comment = {
           comment: {
             body: rand_text,
@@ -23,7 +25,7 @@ describe Samanage::Api do
         }
         api_call = @samanage.create_comment(incident_id: incident_id, comment: comment)
 
-        expect(api_call.dig(:data,'body')).to eq(rand_text)
+        expect(api_call.dig(:data, "body")).to eq(rand_text)
       end
     end
   end

data/spec/api/samanage_contract_spec.rb

@@ -1,66 +1,72 @@
-require 'samanage'
+# frozen_string_literal: true
+
+require "samanage"
 
 describe Samanage::Api do
-  context 'Contract' do 
-    describe 'API Fucntions' do
-      before(:all) do 
-        TOKEN ||= ENV['SAMANAGE_TEST_API_TOKEN']
+  context "Contract" do
+    describe "API Fucntions" do
+      before(:all) do
+        TOKEN ||= ENV["SAMANAGE_TEST_API_TOKEN"]
         @samanage = Samanage::Api.new(token: TOKEN)
         @contracts = @samanage.contracts
       end
-      it 'get_contracts: it returns API call of contracts' do
+      it "get_contracts: it returns API call of contracts" do
         api_call = @samanage.get_contracts
         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_contracts: collects array of contracts' do
+      it "collect_contracts: collects array of contracts" do
         contract_count = @samanage.get_contracts[:total_count]
         expect(@contracts).to be_an(Array)
         expect(@contracts.size).to eq(contract_count)
       end
-      it 'create_contract(payload: json): creates a contract' do
+      it "create_contract(payload: json): creates a contract" do
         random_name = Faker::Artist.name
         json = {
           contract: {
-            type: 'SoftwareLicense',
-            manufacturer_name: 'Adobe',
-            status: 'Active',
+            type: "SoftwareLicense",
+            manufacturer_name: "Adobe",
+            status: "Active",
             name:  random_name,
           }
         }
         contract_create = @samanage.create_contract(payload: json)
 
-        expect(contract_create[:data]['id']).to be_an(Integer)
-        expect(contract_create[:data]['name']).to eq(random_name)
+        expect(contract_create[:data]["id"]).to be_an(Integer)
+        expect(contract_create[:data]["name"]).to eq(random_name)
       end
-      it 'create_contract: fails if no status' do
+      it "create_contract: fails if no status" do
         contract_name = Faker::Ancient.god
         json = {
-          :contract => {
-            model: 'test',
+          contract: {
+            model: "test",
             manufacturer_name: contract_name,
           }
         }
-        expect{@samanage.create_contract(payload: json)}.to raise_error(Samanage::InvalidRequest)
+        expect {
+          @samanage.create_contract(payload: json)
+        }.to raise_error(Samanage::InvalidRequest)
       end
-      it 'find_contract: returns a contract card by known id' do
-        sample_id = @contracts.sample['id']
+      it "find_contract: returns a contract card by known id" do
+        sample_id = @contracts.sample["id"]
         contract = @samanage.find_contract(id: sample_id)
 
-        expect(contract[:data]['id']).to eq(sample_id)  # id should match found contract
-        expect(contract[:data]).to have_key('manufacturer_name')
-        expect(contract[:data]).to have_key('name')
-        expect(contract[:data]).to have_key('id')
+        expect(contract[:data]["id"]).to eq(sample_id)  # id should match found contract
+        expect(contract[:data]).to have_key("manufacturer_name")
+        expect(contract[:data]).to have_key("name")
+        expect(contract[:data]).to have_key("id")
       end
-      it 'find_contract: returns nothing for an invalid id' do
+      it "find_contract: returns nothing for an invalid id" do
         sample_id = (0..10).entries.sample
-        expect{@samanage.find_contract(id: sample_id)}.to raise_error(Samanage::NotFound)  # id should match found contract
+        expect {
+          @samanage.find_contract(id: sample_id)
+        }.to raise_error(Samanage::NotFound)  # id should match found contract
       end
-      it 'update_contract: update_contract by id' do
-        sample_id = @contracts.sample['id']
-        new_name = Faker::Company.name 
+      it "update_contract: update_contract by id" do
+        sample_id = @contracts.sample["id"]
+        new_name = Faker::Company.name
         json = {
           contract: {
             manufacturer_name: new_name
@@ -70,12 +76,12 @@ describe Samanage::Api do
         expect(contract_update[:data]["manufacturer_name"]).to eq(new_name)
         expect(contract_update[:code]).to eq(200).or(201)
       end
-      it 'adds an item to a contract by id' do
-        sample_id = @contracts.sample['id']
+      it "adds an item to a contract by id" do
+        sample_id = @contracts.sample["id"]
         item = {
           item: {
-            name: Faker::Company.catch_phrase ,
-            version:" 123",
+            name: Faker::Company.catch_phrase,
+            version: " 123",
             qty: "2",
             tag: Faker::Company.profession,
           }
@@ -83,11 +89,11 @@ describe Samanage::Api do
         add_item = @samanage.add_item_to_contract(id: sample_id, payload: item)
         expect(add_item[:code]).to eq(200).or(201)
       end
-      it 'deletes a valid contract' do
-        sample_contract_id = @contracts.sample['id']
+      it "deletes a valid contract" do
+        sample_contract_id = @contracts.sample["id"]
         contract_delete = @samanage.delete_contract(id: sample_contract_id)
         expect(contract_delete[:code]).to eq(200).or(201)
       end
     end
   end
-end
+end