lm_rest 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ca4971177cb2794426ad3ae05d420f1fdbda78717fc4d881380f367b6d820c6
-  data.tar.gz: 796de6d0afa84b5e176f188c17ec92043cfa55794755b6ab3daa744aea826f86
+  metadata.gz: 3a4f87a7e7c93fa4a82609673f1f8e2d83838a4a66204aaff72c9bf4009dcaf6
+  data.tar.gz: b9c12122bab2c4d6dabfa8d3edefcd60e863d082238c0e456c50dd86ef15ce27
 SHA512:
-  metadata.gz: 05c2aca42fb85b2e09499664fa02fe6ac597ad2b2388f374b50bc3b8fa431871d8f0526b20e371ff55758bf6b4b7b4e57eac004c401f04521ed67c92100d1ae4
-  data.tar.gz: 9d433ae007765e5c3c7eccbfdeaa5aca086c21e0dd1fc5a9700ac4357c2393edec4f18d47474f4383f492c0e352dff99fa2038d66f9326b63272e4b6b15d4d8f
+  metadata.gz: 8b33d7e50310ea6f7a1d679f8bf4385839c3226b41830ef513ada313423aa6b2227988f40e1403e4e05be56d5d96fd51af8008a451311faec1d498ff4b990576
+  data.tar.gz: f2553bdb581abd17695a47e56aa23bf5790272a3ad57475ae42dd13b92a19a786ae404e09acecf40a43b3bd14bc4ebc8aeba11d31edbb648871a51394e399426

data/README.md

@@ -4,7 +4,7 @@ An Unofficial Ruby gem for the LogicMonitor REST API.
 
 [![Gem Version](https://badge.fury.io/rb/lm_rest.svg)](https://badge.fury.io/rb/lm_rest)
 
-[LM Swagger API Docs](https://www.logicmonitor.com/swagger-ui-master/dist/)
+[LogicMonitor REST API v3 Swagger Docs](https://www.logicmonitor.com/support/rest-api-v3-swagger-documentation)
 
 ## Installation
 
@@ -47,27 +47,32 @@ your system up even more.
 
 ## Supported API Resources
 
-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.
+Every API resource and operation is defined in `api.json`, which is generated
+from the LogicMonitor REST API v3 Swagger surface. Generated operation methods
+and legacy convenience aliases are both supported.
 
-Each method (`get_*, add_*, update_*, delete_*`) works the same
-for each resource. Each method name follows the pattern `method_resource`.
+Each method (`get_*, add_*, update_*, delete_*`) works the same for each
+resource. Each method name follows the pattern `method_resource`.
 
-Every method except for `delete_*` will return an `LMRest::Resource` object.
-It is essentially just a PORO with dynamically created property accessors
-(constructed from the API JSON response). This makes it easy to access
-attributes, edit them, and update objects. You can get a `Hash` version of the
-object with `#to_h`.
+Every method except for `delete_*` returns `LMRest::Resource` objects. A
+resource is a hash-backed wrapper around the API JSON response with dynamic
+attribute-style access, so both `resource.name` and `resource['name']` work.
+Use `#to_h` to get a deep-copied `Hash` version suitable for updates.
 
-Note: This library handles pagination for you! Use `size` and `offset` request
-parameters and get sane results. Default `size` is the total number of existing
-objects. The default `offset` is 0.
+Paginated GET endpoints are handled automatically. If you omit `size`, the
+client will keep requesting pages until all items have been collected. If you
+set `size`, the client will fetch up to that many items even when it spans
+multiple 1000-item API pages. `offset` defaults to `0`.
 
 ## Usage
 
 See the example `ds_checker.rb` script in `bin` to get a better feel for how to
-use the gem.
+use the gem. It expects:
+
+* LogicMonitor account name
+* API access ID
+* API access key
+* Datasource name or filter glob
 
 ```ruby
 require 'lm_rest'
@@ -77,7 +82,7 @@ require 'lm_rest'
 
 lm = LMRest::APIClient.new('company', 'access_id', 'access_key')
 
-# returns array of Resource objects
+# returns all datasource resources across every API page
 lm.get_datasources
 
 
@@ -134,6 +139,14 @@ lm.ack_collector_down(id, comment)
 lm.run_report(id)
 
 
+# Handle API failures without leaking response bodies to stdout
+begin
+  lm.get_device(999999)
+rescue LMRest::APIError => e
+  warn "#{e.status}: #{e.body}"
+end
+
+
 ```
 
 ## TODO