samanage 2.1.20 → 2.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2123d5a06d5316e8f8c68eeddc675da008aaaaad062208796f8f89bc142ce51e
-  data.tar.gz: d8e19971dbadfdfe6b102fb40931786a30506f70090db7a56e2ada9babe539d2
+  metadata.gz: dbd3b3da593b36d83d02a91c0d79e3573a6e51a01ccd7e78460ea3493d64a271
+  data.tar.gz: 98953bce3408c07e8b56dce8f9833f7dae8679dbaa15c395fb457bc950ffc234
 SHA512:
-  metadata.gz: 8444a5784699c2b93ee52ac126c4221d4c6cc55bdc5053c2c930a91c6b0474a046b04b28e2dd68bf419ad1453d5a42c838724ff5a0406cc08e2ce88d75214b6e
-  data.tar.gz: f3e85b2df019e7776b286a58c0dff2631d125c1b0dca583ddae4e95f3736044d8069defa862642f9fa600422854da560deceafc075c880a984dc3fb5238e96a2
+  metadata.gz: f4f89a6c6afcf8ab99fa0c91b9e8c2a1a6ac7109d4010c1874ef3e4c2130e2eea0d0d95a1c0d0d63efe5c728e861ecacad0da36ad68573426bc3a8c53d819df2
+  data.tar.gz: 0e55006ee3345f13c5a2cfb7673031cb1f85e65209d8853b316db9451887a87b1c628bc3c0eb00e1104da60e5571c4de528e94e817b63a8b53a3e7787c12381c

data/Gemfile

@@ -2,18 +2,22 @@
 
 source "https://rubygems.org"
 
-gem "rspec"
 gem "httparty", "0.16.4"
 gem "ffi", "1.9.24"
 
 group :development do
-  gem "guard-rspec", require: false
+  gem "rspec"
   gem "rubocop", require: false
   gem "rubocop-performance"
 end
 
 
-group :test do
+group :development, :test do
   gem "guard-rspec", require: false
+  gem "guard"
+  gem "dotenv"
+end
+
+group :test do
   gem "faker"
 end

data/Gemfile.lock

@@ -5,6 +5,7 @@ GEM
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
     diff-lcs (1.3)
+    dotenv (2.7.5)
     faker (2.1.2)
       i18n (>= 0.8)
     ffi (1.9.24)
@@ -85,8 +86,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  dotenv
   faker
   ffi (= 1.9.24)
+  guard
   guard-rspec
   httparty (= 0.16.4)
   rspec

data/README.md

@@ -15,43 +15,50 @@
 
 Initialize API controller
 ```ruby
-    api_controller = Samanage::Api.new(token: 'abc123')
+    samanage = Samanage::Api.new(token: 'abc123')
 ```
 
 - Create a user
 ```ruby
     user = {user: { name: 'John Doe', email: 'john.doe@example.com'}}
-    api_controller.create_user(payload: user)
+    samanage.create_user(payload: user)
 ```
 
 
 - Find a user by email
 ```ruby
-    my_user = api_controller.find_user_by_email(email: 'user@example.com')
+    my_user = samanage.find_user_by_email(email: 'user@example.com')
 ```
 
 
 - Update incident by ID
 ```ruby
     incident_data = {incident: { priority: 'Critical' }}
-    incident_update = api_controller.update_incident(id: 123, payload: incident_data)
+    incident_update = samanage.update_incident(id: 123, payload: incident_data)
 ```
 
+
 - Update hardware
 ```ruby
-hardware = {hardware: {name: 'My Computer'}}
-result = api_controller.update_hardware(id: 123, payload: hardware)
+hardware = {hardware: {name: 'Cool New Hostname'}}
+result = samanage.update_hardware(id: 123, payload: hardware)
+```
+
+- Use Filters
+```ruby
+    incidents_updated_today = samanage.incidents(options: {'updated' => 1})
+    expired_hardwares = samanage.hardwares(options: {'warranty_status[]' => 'Expired'})
 ```
 
 
 ### Listing and Searching
 - Find All Users
 ```ruby
-users = api_controller.users # returns all users
+users = samanage.users # returns all users
 ```
 - Filtering Incidents matching custom field and updated in the last 7 days
 ```ruby
-incidents = api_controller.incidents(options: {'Custom Field' => 'Some Value', 'updated[]' => 7})
+incidents = samanage.incidents(options: {'Custom Field' => 'Some Value', 'updated[]' => 7})
 ```
 
 - Listing / Searching also responds to blocks

data/lib/samanage.rb

@@ -8,6 +8,7 @@ require "samanage/api/attachments"
 require "samanage/api/category"
 require "samanage/api/changes"
 require "samanage/api/comments"
+require "samanage/api/configuration_items"
 require "samanage/api/contracts"
 require "samanage/api/custom_fields"
 require "samanage/api/custom_forms"
@@ -19,11 +20,11 @@ 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/releases"
+require "samanage/api/requester"
 require "samanage/api/sites"
-require "samanage/api/tasks"
 require "samanage/api/solutions"
+require "samanage/api/tasks"
 require "samanage/api/time_tracks"
 require "samanage/api/users"
 require "samanage/api/utils"

data/lib/samanage/api.rb

@@ -12,7 +12,10 @@ module Samanage
       category: "categories.json",
       change: "changes.json",
       contract: "contracts.json",
+      configuration_item: "configuration_items.json",
+      custom_field: "custom_fields.json",
       custom_fields: "custom_fields.json",
+      custom_form: "custom_forms.json",
       custom_forms: "custom_forms.json",
       department: "departments.json",
       group: "groups.json",
@@ -114,6 +117,7 @@ module Samanage
           response = e.class
           raise Samanage::InvalidRequest.new(error: error, response: response, options: options)
         end
+
       end
 
       response = {}
@@ -148,6 +152,10 @@ module Samanage
         response[:data] = api_call.body
         error = response[:response]
         raise Samanage::InvalidRequest.new(error: error, response: response, options: options)
+      when 429
+        response[:data] = api_call.body
+        error = response[:response]
+        raise Samanage::InvalidRequest.new(error: error, response: response, options: options)
       else
         response[:data] = api_call.body
         error = response[:response]
@@ -162,9 +170,13 @@ module Samanage
 
     # Return all admins in the account
     def list_admins
-      admin_role_id = execute(path: "roles.json")[:data].select { |role| role["name"] == "Administrator" }.first["id"]
+      admin_role_id = execute(path: "roles.json")[:data]
+        .find { |role| role["name"] == "Administrator" }
+        .dig("id")
+      admin_path = "users.json?role=#{admin_role_id}"
       admins.push(
-        execute(path: "users.json?role=#{admin_role_id}")[:data].map { |u| u["email"] }
+        execute(path: admin_path)[:data]
+          .map { |u| u["email"] }
       ).flatten
     end
   end

data/lib/samanage/api/configuration_items.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Samanage
+  class Api
+    # Default get configuration_item path
+    def get_configuration_items(path: PATHS[:configuration_item], options: {})
+      path = "configuration_items.json?"
+      self.execute(path: path, options: options)
+    end
+
+
+    # Returns all configuration_items.
+    # Options:
+    #   - audit_archives: true
+    #   - layout: 'long'
+    def collect_configuration_items(options: {})
+      configuration_items = Array.new
+      total_pages = self.get_configuration_items(options: options)[:total_pages]
+      1.upto(total_pages) do |page|
+        options[:page] = page
+
+        puts "Collecting Configuration Items page: #{page}/#{total_pages}" if options[:verbose]
+        path = "configuration_items.json?"
+        request = self.execute(http_method: "get", path: path, options: options)
+        request[:data].each do |configuration_item|
+          if block_given?
+            yield configuration_item
+          end
+          configuration_items << configuration_item
+        end
+      end
+      configuration_items
+    end
+
+
+    # Create an configuration_item given json
+    def create_configuration_item(payload: nil, options: {})
+      self.execute(path: PATHS[:configuration_item], http_method: "post", payload: payload)
+    end
+
+    # Find configuration_item by ID
+    def find_configuration_item(id:, options: {})
+      path = "configuration_items/#{id}.json"
+      if options[:layout] == "long"
+        path += "?layout=long"
+      end
+      self.execute(path: path)
+    end
+
+    # Update an configuration_item given id and json
+    def update_configuration_item(payload:, id:, options: {})
+      path = "configuration_items/#{id}.json"
+      self.execute(path: path, http_method: "put", payload: payload)
+    end
+
+    def delete_configuration_item(id:)
+      self.execute(path: "configuration_items/#{id}.json", http_method: "delete")
+    end
+
+
+    alias_method :configuration_items, :collect_configuration_items
+  end
+end

data/lib/samanage/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Samanage
-  VERSION = "2.1.20"
+  VERSION = "2.1.21"
 end

data/spec/api/samanage_configuration_item_spec.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "samanage"
+require "faker"
+
+describe Samanage::Api do
+  context "configuration_items" do
+    describe "API Functions" do
+      before(:all) do
+        TOKEN ||= ENV["SAMANAGE_TEST_API_TOKEN"]
+        @samanage = Samanage::Api.new(token: TOKEN)
+        @configuration_items = @samanage.configuration_items(options: { verbose: true })
+        @users = @samanage.get_users[:data]
+      end
+      it "get_configuration_items: it returns API call of configuration_items" do
+        api_call = @samanage.get_configuration_items
+        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_configuration_items: collects array of configuration_items" do
+        configuration_item_count = @samanage.get_configuration_items[:total_count]
+        expect(@configuration_items.size).to eq(configuration_item_count)
+        expect(@configuration_items).to be_an(Array)
+      end
+      it "create_configuration_item(payload: json): creates a configuration_item" do
+        users_email = @users.sample["email"]
+        configuration_item_name = Faker::Device.model_name
+        json = {
+          configuration_item: {
+            name: configuration_item_name,
+            priority: "Low",
+            description: "Description",
+            state: "Operational",
+            user: { email: users_email },
+          }
+        }
+        configuration_item_create = @samanage.create_configuration_item(payload: json)
+
+        expect(configuration_item_create[:data]["id"]).to be_an(Integer)
+        expect(configuration_item_create[:data]["name"]).to eq(configuration_item_name)
+        expect(configuration_item_create[:code]).to eq(200).or(201)
+      end
+      it "create_configuration_item: fails if no name/title" do
+        json = {
+          configuration_item: {
+            description: "Description"
+          }
+        }
+        expect { @samanage.create_configuration_item(payload: json) }.to raise_error(Samanage::InvalidRequest)
+      end
+      it "find_configuration_item: returns a configuration_item card by known id" do
+        sample_id = @configuration_items.sample["id"]
+        configuration_item = @samanage.find_configuration_item(id: sample_id)
+        expect(configuration_item[:data]["id"]).to eq(sample_id)  # id should match found configuration_item
+        expect(configuration_item[:data]).to have_key("name")
+        expect(configuration_item[:data]).to have_key("id")
+      end
+      it "find_configuration_item: returns more keys with layout=long" do
+        sample_id = @configuration_items.sample["id"]
+        layout_regular_configuration_item = @samanage.find_configuration_item(id: sample_id)
+        layout_long_configuration_item = @samanage.find_configuration_item(id: sample_id, options: { layout: "long" })
+
+        expect(layout_long_configuration_item[:data]["id"]).to eq(sample_id)  # id should match found configuration_item
+        expect(layout_long_configuration_item[:data].keys.size).to be > (layout_regular_configuration_item.keys.size)
+        expect(layout_long_configuration_item[:data].keys - layout_regular_configuration_item[:data].keys).to_not be([])
+      end
+      it "update_configuration_item: update_configuration_item by id" do
+        sample_configuration_item = @configuration_items
+          .reject { |i| ["Closed", "Resolved"].include? i["state"] }
+          .sample
+        sample_id = sample_configuration_item["id"]
+        description = (0...500).map { ("a".."z").to_a[rand(26)] }.join
+        configuration_item_json = {
+          configuration_item: {
+            description: description
+          }
+        }
+        configuration_item_update = @samanage.update_configuration_item(payload: configuration_item_json, id: sample_id)
+        # expect(configuration_item_update[:data]['description']).to eq(description) # configuration_item bug #00044569
+        expect(configuration_item_update[:code]).to eq(200).or(201)
+      end
+      it 'finds more data for option[:layout] = "long"' do
+        full_layout_configuration_item_keys = @samanage.configuration_items(options: { layout: "long" }).first.keys
+        basic_configuration_item_keys = @samanage.configuration_items.sample.keys
+        expect(basic_configuration_item_keys.size).to be < full_layout_configuration_item_keys.size
+      end
+      it "deletes a valid configuration_item" do
+        sample_configuration_item_id = @configuration_items.sample["id"]
+        configuration_item_delete = @samanage.delete_configuration_item(id: sample_configuration_item_id)
+        expect(configuration_item_delete[:code]).to eq(200).or(201)
+      end
+    end
+  end
+end

data/spec/api/samanage_department_spec.rb

@@ -25,7 +25,7 @@ describe Samanage::Api do
       department_name = [
         Faker::Internet.username,
         Faker::Internet.domain_word
-      ].shuffle.join(' ')
+      ].shuffle.join(" ")
       department_description = Faker::Book.author
       payload = {
         department: {

data/spec/api/samanage_task_spec.rb

@@ -2,6 +2,8 @@
 
 require "samanage"
 require "faker"
+require "dotenv"
+Dotenv.load
 describe Samanage::Api do
   context "Task" do
     before(:all) do
@@ -54,8 +56,6 @@ describe Samanage::Api do
     end
     it "deletes a valid task" do
       sample_task = @tasks.sample
-      pp sample_task
-      puts "sample_task: #{sample_task.inspect}"
       sample_task_id = sample_task["id"]
       incident_id = sample_task.dig("parent", "id")
       task_delete = @samanage.delete_task(
@@ -64,5 +64,14 @@ describe Samanage::Api do
       )
       expect(task_delete[:code]).to eq(200).or(201)
     end
+    it "collects all tasks from 90 days in demo" do
+      @samanage = Samanage::Api.new(token: ENV["DEMOTOKEN"])
+      opts = { verbose: true, 'created[]': 90 }
+      task_count = @samanage.get_tasks(options: opts)[:total_count]
+      @tasks = @samanage.tasks(options: opts)
+      expect(task_count).to be_a(Integer)
+      expect(task_count).to be > 0
+      expect(task_count).to eq(@tasks.count)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -10,3 +10,5 @@ $LOAD_PATH.uniq!
 
 require "samanage"
 require "faker"
+require "dotenv"
+Dotenv.load

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samanage
 version: !ruby/object:Gem::Version
-  version: 2.1.20
+  version: 2.1.21
 platform: ruby
 authors:
 - Chris Walls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-14 00:00:00.000000000 Z
+date: 2019-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -58,6 +58,7 @@ files:
 - lib/samanage/api/category.rb
 - lib/samanage/api/changes.rb
 - lib/samanage/api/comments.rb
+- lib/samanage/api/configuration_items.rb
 - lib/samanage/api/contracts.rb
 - lib/samanage/api/custom_fields.rb
 - lib/samanage/api/custom_forms.rb
@@ -89,6 +90,7 @@ files:
 - spec/api/samanage_category_spec.rb
 - spec/api/samanage_change_spec.rb
 - spec/api/samanage_comments_spec.rb
+- spec/api/samanage_configuration_item_spec.rb
 - spec/api/samanage_contract_spec.rb
 - spec/api/samanage_custom_field_spec.rb
 - spec/api/samanage_custom_form_spec.rb