lm_rest 1.0.1 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa5d869b3f6a8928f4c7328c79e695ed96b3559abff1cac0daf4da09d0ad6526
-  data.tar.gz: 183f6cca33109ce03c90d2d43cedba9b52d54b4c93d7143e864abc44c2290760
+  metadata.gz: 3c01ece27d96964546705d1d5a610b33e5a5c173d63a44f9a20252846192cb23
+  data.tar.gz: 8ab3dc099b5088d46d0d752de09c73a273a662d17b05b2a753363f6f9498ed6b
 SHA512:
-  metadata.gz: 220d6193ce97099a9e6af01b5eb5c2ef43cf91d580d626737ca9bf7f0954ebfe7171bb9e04797fbd23317ce75a673a221a48a825dbadc246782a7b15b154c218
-  data.tar.gz: 574b492b98762c1be1f41acac90039f985852cf585dc9976d7176996e86c276515d0fe75bb0b60be192b191ad08de46956542f566088d36ccdca19c627c017a8
+  metadata.gz: c6180a42bdb7fdd738651da70f41c5a4158dd5ecd177e37bc45ce67434f4ec711183743526dea241d0a99ab73c247bfd13d879cf8119c5b89af88250c9f81f35
+  data.tar.gz: b9e563ccf97f75174a23dd88e4d58222fa40b58a1078a22ba06d2f199ae8252cd8ed4249b007ee1efbbaa3b73c3c30fe43edde48bd395d962d41e78c6751e005

data/README.md

@@ -1,6 +1,6 @@
 # LMRest
 
-A Ruby gem for the LogicMonitor REST API.
+An Unofficial Ruby gem for the LogicMonitor REST API.
 
 ## Installation
 
@@ -20,8 +20,8 @@ Or install it yourself as:
 
 ## Supported API Resources
 
-Every API resource defined in the `api.json` file and its associated defined
-methods are supported, and you can easily add your own if you can't wait for me
+Every API resource is defined in the `api.json` file and its associated defined
+methods are supported. You can easily add your own if you can't wait for me
 to update this.
 
 Each method (`get_*, add_*, update_*, delete_*`) works the same
@@ -45,21 +45,10 @@ use the gem.
 ```ruby
 require 'lm_rest'
 
+# Create an instance of the API Client, passing in an API token for 
+# authentication. Pretend this portal is at `company.logicmonitor.com`:
 
-# Authenticate with an API token (preferred):
-credential = {company: 'company',
-              access_key:'api_access_key',
-              access_id:'api_access_id'}
-
-
-# Authenticate with Basic Auth (not preferred):
-credential = {company: 'company',
-              user: 'user',
-              password: 'password'}
-
-# Create an instance of the API Client
-lm = LMRest::APIClient.new(credential)
-
+lm = LMRest::APIClient.new('company', 'access_id', 'access_key')
 
 # returns array of Resource objects
 lm.get_datasources
@@ -100,7 +89,6 @@ lm.delete_device(device)
 lm.add_device(device)
 
 
-
 # Get your Santaba version info
 lm.get_version
 
@@ -119,12 +107,9 @@ lm.run_report(id)
 
 ```
 
+## TODO
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+* Handle nested stuff, and resource-specific operations
 
 
 ## Contributing

data/api.json

@@ -23,7 +23,7 @@
 		]
 	},
 	"Collector": {
-		"url": "/setting/collectors",
+		"url": "/setting/collector/collectors",
 		"method_names": {
 			"singular": "collector",
 			"plural": "collectors"
@@ -34,6 +34,28 @@
 			"delete"
 		]
 	},
+	"CollectorGroups": {
+		"url": "/setting/collector/groups",
+		"method_names": {
+			"singular": "collector_group",
+			"plural": "collector_groups"
+		},
+		"actions": [
+			"get",
+			"add",
+			"update",
+			"delete"
+		]
+	},
+	"CollectorVersions": {
+		"url": "/setting/collector/collectors/versions",
+		"method_names": {
+			"singular": "collector_versions"
+		},
+		"actions": [
+			"get"
+		]
+	},
 	"Datasource": {
 		"url": "/setting/datasources",
 		"method_names": {
@@ -87,7 +109,7 @@
 			"delete"
 		]
 	},
-	"Function": {
+	"AppliesToFunction": {
 		"url": "/setting/functions",
 		"method_names": {
 			"singular": "function",
@@ -126,11 +148,11 @@
 			"delete"
 		]
 	},
-	"Service": {
-		"url": "/service/services",
+	"Website": {
+		"url": "/website/websites",
 		"method_names": {
-			"singular": "service",
-			"plural": "services"
+			"singular": "website",
+			"plural": "websites"
 		},
 		"actions": [
 			"get",
@@ -143,7 +165,7 @@
 		]
 	},
 	"SiteMonitorCheckpoint": {
-		"url": "/service/smcheckpoints",
+		"url": "/website/smcheckpoints",
 		"method_names": {
 			"singular": "smcheckpoint",
 			"plural": "smcheckpoints"
@@ -153,7 +175,7 @@
 		]
 	},
 	"ServiceGroup": {
-		"url": "/service/groups",
+		"url": "/website/groups",
 		"method_names": {
 			"singular": "service_group",
 			"plural": "service_groups"
@@ -195,7 +217,7 @@
 		]
 	},
 	"APIToken": {
-		"url": "/setting/apiTokens",
+		"url": "/setting/admin/apitokens",
 		"method_names": {
 			"singular": "api_token",
 			"plural": "api_tokens"
@@ -265,6 +287,19 @@
 		],
 		"children": []
 	},
+	"DashboardGroups": {
+		"url": "/dashboard/groups",
+		"method_names": {
+			"singular": "dashboard_group",
+			"plural": "dashboard_groups"
+		},
+		"actions": [
+			"get",
+			"add",
+			"update",
+			"delete"
+		]
+	},
 	"Widget": {
 		"url": "/dashboard/widgets",
 		"method_names": {
@@ -279,6 +314,17 @@
 		],
 		"children": []
 	},
+	"Debug": {
+		"url": "/debug",
+		"method_names": {
+			"singular": "debug"
+		},
+		"actions": [
+			"get",
+			"add"
+		],
+		"children": []
+	},
 	"Report": {
 		"url": "/report/reports",
 		"method_names": {
@@ -374,6 +420,15 @@
 			"get"
 		]
 	},
+	"APIPerfStats": {
+		"url": "/apiStats/externalApis",
+		"method_names": {
+			"singular": "api_perf_stats"
+		},
+		"actions": [
+			"get"
+		]
+	},
 	"Version": {
 		"url": "/version",
 		"method_names": {

data/bin/system_category_cleaner.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+#
+#
+# Based on a script written originally by Matt Dunham
+#
+require 'lm_rest'
+
+def usage
+  puts "USAGE:\t" + $PROGRAM_NAME + ' account id key applies_to category'
+  puts ""
+  puts "\taccount    - just the beginning of your portal name, like 'hooli'"
+  puts "\tid         - API key access id"
+  puts "\tkey        - API key access key"
+  puts "\tapplies_to - AppliesTo (in quotes on one line) matching devices you want to scrub"
+  puts "\tcategory   - The system category value you wish to remove."
+end
+
+if ARGV.length ==5 
+  @account = ARGV[0]
+  @id  = ARGV[1]
+  @key  = ARGV[2]
+  @at = ARGV[3]
+  @category = ARGV[4]
+  @lm = LMRest::APIClient.new(@account, @id, @key)
+else
+  usage
+  fail 'Bad arguments.'
+end
+
+request = {
+  currentAppliesTo: @at,
+  needInheritProps: true,
+  originalAppliesTo: @at,
+  type: "testAppliesTo"
+}
+
+devices = @lm.request(:post, "/functions", request)['originalMatches'].map do |device|
+  [device['id'], device['name']]
+end
+
+devices.each do |id, name|
+  puts "Fetching device id #{id}, #{name}"
+  current = @lm.request(:get, "/device/devices/#{id}/properties/system.categories", nil)
+  if (@lm.remaining.to_f / @lm.limit.to_f) * 100 <= 10
+    puts "sleeping for #{@lm.window} to avoid rate limit violation"
+    sleep @lm.window
+  end
+  if current['value'].split(',').include? @category
+    new_string = current['value'].split(',') - [@category]
+    new = current
+    new['value'] = new_string.join(",")
+    @lm.request(:put, "/device/devices/#{id}/properties/system.categories", new)
+    puts "  Successfully scrubbed!"
+  else
+    puts "  No scrubbing needed."
+  end
+end

data/lib/lm_rest/api_client.rb

@@ -17,6 +17,7 @@ module LMRest
     BASE_URL_SUFFIX = '.logicmonitor.com/santaba/rest'
 
     attr_reader :company, :api_url, :access_id
+    attr_reader :limit, :remaining, :window
 
     def initialize(company = nil, access_id =  nil, access_key = nil)
       APIClient.setup
@@ -38,14 +39,6 @@ module LMRest
       uri.split("?")[0].split("/").join("/")
     end
 
-    def snakerize(string)
-      string.gsub(/::/, '/').
-        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-        gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr("-", "_").
-        downcase
-    end
-
     def sign(method, uri, data = nil)
 
       resource_uri = uri_to_resource_uri(uri)
@@ -86,15 +79,20 @@ module LMRest
 
       json_params = params.to_json
 
-      case method
-      when :get
-        response = RestClient.get(url, headers)
-      when :post
-        response = RestClient.post(url, json_params, headers)
-      when :put
-        response = RestClient.put(url, json_params, headers)
-      when :delete
-        response = RestClient.delete(url, headers: headers)
+      begin
+        case method
+        when :get
+          response = RestClient.get(url, headers)
+        when :post
+          response = RestClient.post(url, json_params, headers)
+        when :put
+          response = RestClient.put(url, json_params, headers)
+        when :delete
+          response = RestClient.delete(url, headers: headers)
+        end
+      rescue => e
+        puts e.http_body
+        raise
       end
 
       if response.code != 200
@@ -102,6 +100,9 @@ module LMRest
         raise
       end
 
+      @limit = response.headers['x_rate_limit_limit']
+      @remaining = response.headers['x_rate_limit_remaining']
+      @window = response.headers['x_rate_limit_window']
 
       JSON.parse(response.body)
     end
@@ -180,76 +181,75 @@ module LMRest
       end
     end
 
-    def self.process_paths
+    def self.define_action_methods(resource_type, attributes)
+      singular = attributes['method_names']['singular']
+      plural = attributes['method_names']['plural']
       resource_uri = attributes['url']
-      @@api_json[paths].keys.each do |path|
 
-        path.keys.each do |action|
-          case action
-          when 'get'
+      attributes['actions'].each do |action|
+        case action
+        when 'get'
 
-            uri = lambda { |params| "#{resource_uri}#{RequestParams.parameterize(params)}"}
-            method_name = snakerize(@@api_json['paths'][path][action][operationId])
+          uri = lambda { |params| "#{resource_uri}#{RequestParams.parameterize(params)}"}
 
-            unless plural.nil?
-              # Define a method to fetch multiple resources with optional params
-              define_method("get_#{plural}") do |params = {}|
-                Resource.parse paginate(uri, params)
-              end
+          unless plural.nil?
+            # Define a method to fetch multiple resources with optional params
+            define_method("get_#{plural}") do |params = {}|
+              Resource.parse paginate(uri, params)
             end
+          end
 
-            # Define a method to get one resource by it's id number, with optional
-            # params, thought now that I think about it I'm not sure why you'd pass
-            # params when grabbing just one resource.
-
-            # Some resources are Singletons
-            unless singular.nil?
-              define_method("get_#{singular}") do |*args|
-                case args.size
-                when 0
-                  Resource.parse request(:get, "#{resource_uri}", nil)
-                when 1
-                  Resource.parse request(:get, "#{resource_uri}/#{args[0]}", nil)
-                when 2
-                  Resource.parse request(:get, "#{resource_uri}/#{args[0]}#{RequestParams.parameterize(args[1])}", nil)
-                else
-                  raise ArgumentError.new("wrong number for arguments (#{args.count} for 1..2)")
-                end
+          # Define a method to get one resource by it's id number, with optional
+          # params, thought now that I think about it I'm not sure why you'd pass
+          # params when grabbing just one resource.
+
+          # Some resources are Singletons
+          unless singular.nil?
+            define_method("get_#{singular}") do |*args|
+              case args.size
+              when 0
+                Resource.parse request(:get, "#{resource_uri}", nil)
+              when 1
+                Resource.parse request(:get, "#{resource_uri}/#{args[0]}", nil)
+              when 2
+                Resource.parse request(:get, "#{resource_uri}/#{args[0]}#{RequestParams.parameterize(args[1])}", nil)
+              else
+                raise ArgumentError.new("wrong number for arguments (#{args.count} for 1..2)")
               end
             end
+          end
 
-          when 'add'
+        when 'add'
 
-            # Define a method to add a new resource to the account
-            define_method("add_#{singular}") do |properties|
-              if properties.class == LMRest::Resource
-                Resource.parse request(:post, "#{resource_uri}", properties.to_h)
-              else
-                Resource.parse request(:post, "#{resource_uri}", properties)
-              end
+          # Define a method to add a new resource to the account
+          define_method("add_#{singular}") do |properties|
+            if properties.class == LMRest::Resource
+              Resource.parse request(:post, "#{resource_uri}", properties.to_h)
+            else
+              Resource.parse request(:post, "#{resource_uri}", properties)
             end
+          end
 
-          when 'update'
+        when 'update'
 
-            # Define a method to update a resource
-            define_method("update_#{singular}") do |id, properties = {}|
-              if id.class == LMRest::Resource
-                Resource.parse request(:put, "#{resource_uri}/#{id.id}", id.to_h)
-              else
-                Resource.parse request(:put, "#{resource_uri}/#{id}", properties)
-              end
+          # Define a method to update a resource
+          define_method("update_#{singular}") do |id, properties = {}|
+            if id.class == LMRest::Resource
+              Resource.parse request(:put, "#{resource_uri}/#{id.id}", id.to_h)
+            else
+              Resource.parse request(:put, "#{resource_uri}/#{id}", properties)
             end
+          end
 
-          when 'delete'
+        when 'delete'
 
-            # Define a method to delete the resource
-            define_method("delete_#{singular}") do |id|
-              if id.class == LMRest::Resource
-                id = id.id
-                Resource.parse request(:delete, "#{resource_uri}/#{id}", nil)
-              else
-                Resource.parse request(:delete, "#{resource_uri}/#{id}", nil)
-              end
+          # Define a method to delete the resource
+          define_method("delete_#{singular}") do |id|
+            if id.class == LMRest::Resource
+              id = id.id
+              Resource.parse request(:delete, "#{resource_uri}/#{id}", nil)
+            else
+              Resource.parse request(:delete, "#{resource_uri}/#{id}", nil)
             end
           end
         end

data/lib/lm_rest/version.rb

@@ -1,3 +1,3 @@
 module LMRest
-  VERSION = '1.0.1'
+  VERSION = '1.0.5'
 end

data/lm_rest.gemspec

@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest'
   spec.add_dependency 'rest-client'
-  spec.add_dependency 'json', '~> 2.1.0'
+  spec.add_dependency 'json', '~> 2.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lm_rest
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.5
 platform: ruby
 authors:
 - Michael Rodrigues
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.5.1
 description: Interact programmatically with your LogicMonitor account via the REST
   API.
 email:
@@ -99,6 +99,7 @@ files:
 - bin/console
 - bin/ds_checker.rb
 - bin/setup
+- bin/system_category_cleaner.rb
 - lib/lm_rest.rb
 - lib/lm_rest/api_client.rb
 - lib/lm_rest/request_params.rb
@@ -124,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: API Wrapper for LogicMonitor Rest API v2.