SematextCloud 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +47 -6
  3. data/SematextCloud.gemspec +2 -2
  4. data/assets/octi-blue.png +0 -0
  5. data/lib/SematextCloud/version.rb +1 -1
  6. metadata +33 -31
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 725cb4d891d56d4bbd80dce9968b1eb0212f44e826d553886b443c29bbfdf544
4
- data.tar.gz: d4df7643a97b03195014754049cc717ea3a6c7aae64e612a4a959f40dd4e76e8
3
+ metadata.gz: 9e1afb70dae7f8dc9aa7162a0d6f952fb5eaec39127d4980fb7381b2018b1add
4
+ data.tar.gz: dc5b0c88835c619c76df4b8e9a2ff175c284ed062a448b432fc935dde334b44b
5
5
  SHA512:
6
- metadata.gz: 11843a61e80689be1ed2c50dc2c5fbccb9f9830086517abedb0a1fdee22f9df42ff747b03aeba9dcebbba0417477e37bceb4a01c2bc8aeebf7868e4f4a5fe35c
7
- data.tar.gz: 8d5fb8af47cc27c3a8f87edff35ed2b280a242185a54ce54382241208459e8bc75417cde7272dbb502b4cbb6410318a8c06ea29383c43b3422caff37d22694d1
6
+ metadata.gz: 4fbb92fe31b20c1db3f16a9dba522b88cbbdbbf633d1d87338a4675345cbbe0824a37967b1e68b31fe3eebd72d76c7877dd2a4516e34ac684990f268a9cfb92f
7
+ data.tar.gz: 53030a791782cdf243611d2d71d7a9d4275b30c846822ebf3ebc92a5cdce705a92add8e86e666b95bd9742259dd3655cd5730b0f4b5165e038193a8b5607f1c8
data/README.md CHANGED
@@ -1,11 +1,47 @@
1
- # Sematext Cloud - API Client - sematext-api-ruby
2
1
 
3
- This Ruby gem contains client code talks to [Sematext Cloud API](https://sematext.com/cloud/) providing a way to automate setup of solution monitoring.<br>
4
- It's primary purpose is as a client module supporting [Sematext Terraform Provider](https://github.com/sematext/terraform-provider-sematext)
5
- <br><br>
2
+ # <img src="./assets/octi-blue.png" valign="bottom" width="60px"/>**&nbsp;&nbsp;sematext-api-client-ruby**
6
3
 
7
- Further information and API browsing refer to the [Sematext Cloud API web page](https://sematext.com/docs/api/)
4
+ <br>
8
5
 
6
+ >*A [Sematext Cloud](https://sematext.com/cloud/) API client, for interaction with Sematext Cloud solution monitoring, alerting and log shipping.*
7
+
8
+ <br>
9
+
10
+ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
11
+
12
+ <br>
13
+ One of a family of clients in following flavours:
14
+ <br>
15
+ <br>
16
+
17
+ * [sematext-api-client-javascript](https://github.com/sematext/sematext-api-client-javascript "Javascript")
18
+ * [sematext-api-client-rust](https://github.com/sematext/sematext-api-client-rust "Rust")
19
+ * [sematext-api-client-ruby](https://github.com/sematext/sematext-api-client-ruby "Ruby")
20
+ * [sematext-api-client-python](https://github.com/sematext/sematext-api-client-python "Python")
21
+ * [sematext-api-client-php](https://github.com/sematext/sematext-api-client-php "PHP")
22
+ * [sematext-api-client-java](https://github.com/sematext/sematext-api-client-java "Java")
23
+ * [sematext-api-client-go](https://github.com/sematext/sematext-api-client-go "Go/Golang")
24
+
25
+ <br>
26
+ Refer to below link for deeper information on the API itself.
27
+ <br>
28
+ <br>
29
+
30
+ * [Sematext Cloud API Reference](https://sematext.com/docs/api/ "API Reference")
31
+
32
+ <br>
33
+
34
+ ## Contents
35
+
36
+ - [&nbsp;&nbsp;sematext-api-client-ruby](#sematext-api-client-ruby)
37
+ - [Contents](#contents)
38
+ - [Installation](#installation)
39
+ - [Getting Started](#getting-started)
40
+ - [Authentication](#authentication)
41
+ - [Reference](#reference)
42
+ - [Documentation for Models](#documentation-for-models)
43
+
44
+ <br>
9
45
 
10
46
  ## Installation
11
47
 
@@ -44,6 +80,11 @@ Include the Ruby code directly using `-I` as follows:
44
80
  ruby -Ilib script.rb
45
81
  ```
46
82
 
83
+ ## Authentication
84
+
85
+ This client code requires a Sematext API Access token to function. You can find this by logging into your [Sematext Cloud Account](https://apps.sematext.com/ui/account/api)
86
+
87
+
47
88
  ## Getting Started
48
89
 
49
90
  Please follow the [installation](#installation) procedure and then run the following code:
@@ -76,7 +117,7 @@ end
76
117
 
77
118
  ```
78
119
 
79
- ## Documentation for API Endpoints
120
+ ## Reference
80
121
 
81
122
  All URIs are relative to *https://localhost*
82
123
 
data/SematextCloud.gemspec CHANGED
@@ -20,9 +20,9 @@ Gem::Specification.new do |s|
20
20
  s.version = SematextCloud::VERSION
21
21
  s.platform = Gem::Platform::RUBY
22
22
  s.authors = ["sematext.com"]
23
- s.email = ["support@sematext.com"]
23
+ s.email = ["packages@sematext.com"]
24
24
  s.homepage = "https://github.com/sematext/sematext-api-client-ruby"
25
- s.summary = "Sematext Cloud API Client for talking to https://sematext.com/docs/api/"
25
+ s.summary = "A Sematext Cloud API client, for interaction with Sematext Cloud solution monitoring, alerting and log shipping."
26
26
  s.description = "Sematext Cloud API Client for talking to https://sematext.com/docs/api/"
27
27
  s.license = 'Apache-2.0'
28
28
  s.required_ruby_version = ">= 1.9"
data/assets/octi-blue.png ADDED
Binary file
data/lib/SematextCloud/version.rb CHANGED
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.12
11
11
  =end
12
12
 
13
13
  module SematextCloud
14
- VERSION = '0.1.0'
14
+ VERSION = '0.1.1'
15
15
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: SematextCloud
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - sematext.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-06-29 00:00:00.000000000 Z
11
+ date: 2020-07-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -192,7 +192,7 @@ dependencies:
192
192
  version: 0.2.12
193
193
  description: Sematext Cloud API Client for talking to https://sematext.com/docs/api/
194
194
  email:
195
- - support@sematext.com
195
+ - packages@sematext.com
196
196
  executables: []
197
197
  extensions: []
198
198
  extra_rdoc_files: []
@@ -202,6 +202,7 @@ files:
202
202
  - README.md
203
203
  - Rakefile
204
204
  - SematextCloud.gemspec
205
+ - assets/octi-blue.png
205
206
  - docs/AlertNotificationRequest.md
206
207
  - docs/AlertNotificationsApi.md
207
208
  - docs/AlertRule.md
@@ -349,47 +350,48 @@ requirements: []
349
350
  rubygems_version: 3.1.2
350
351
  signing_key:
351
352
  specification_version: 4
352
- summary: Sematext Cloud API Client for talking to https://sematext.com/docs/api/
353
+ summary: A Sematext Cloud API client, for interaction with Sematext Cloud solution
354
+ monitoring, alerting and log shipping.
353
355
  test_files:
354
- - spec/api/alert_notifications_api_spec.rb
355
- - spec/api/tag_api_controller_api_spec.rb
356
+ - spec/api/billing_api_spec.rb
357
+ - spec/api/metrics_api_spec.rb
356
358
  - spec/api/subscriptions_api_spec.rb
359
+ - spec/api/aws_settings_controller_api_spec.rb
360
+ - spec/api/apps_api_spec.rb
361
+ - spec/api/alerts_api_spec.rb
357
362
  - spec/api/logs_app_api_spec.rb
363
+ - spec/api/alert_notifications_api_spec.rb
364
+ - spec/api/monitoring_app_api_spec.rb
365
+ - spec/api/tag_api_controller_api_spec.rb
358
366
  - spec/api/saved_queries_api_spec.rb
359
- - spec/api/alerts_api_spec.rb
360
367
  - spec/api/reset_password_api_spec.rb
361
- - spec/api/monitoring_app_api_spec.rb
362
- - spec/api/apps_api_spec.rb
363
- - spec/api/metrics_api_spec.rb
364
- - spec/api/billing_api_spec.rb
365
- - spec/api/aws_settings_controller_api_spec.rb
366
368
  - spec/api_client_spec.rb
367
369
  - spec/configuration_spec.rb
368
- - spec/models/app_description_spec.rb
370
+ - spec/models/invitation_spec.rb
371
+ - spec/models/saved_query_spec.rb
369
372
  - spec/models/update_app_info_spec.rb
370
- - spec/models/basic_auth_method_dto_spec.rb
371
- - spec/models/user_permissions_spec.rb
372
- - spec/models/data_series_filter_spec.rb
373
- - spec/models/user_role_spec.rb
374
373
  - spec/models/alert_rule_spec.rb
375
- - spec/models/billing_info_spec.rb
376
- - spec/models/report_info_spec.rb
377
- - spec/models/basic_organization_dto_spec.rb
378
374
  - spec/models/alert_rule_schedule_time_range_dto_spec.rb
379
- - spec/models/create_app_info_spec.rb
380
- - spec/models/data_series_request_spec.rb
375
+ - spec/models/plan_spec.rb
376
+ - spec/models/app_spec.rb
377
+ - spec/models/data_series_filter_spec.rb
381
378
  - spec/models/error_spec.rb
379
+ - spec/models/user_permissions_spec.rb
380
+ - spec/models/billing_info_spec.rb
382
381
  - spec/models/app_metadata_spec.rb
383
- - spec/models/invitation_spec.rb
384
- - spec/models/filter_value_spec.rb
385
- - spec/models/app_spec.rb
386
- - spec/models/notification_integration_spec.rb
387
- - spec/models/saved_query_spec.rb
388
- - spec/models/generic_api_response_spec.rb
389
382
  - spec/models/alert_rule_schedule_weekday_dto_spec.rb
390
- - spec/models/plan_spec.rb
391
- - spec/models/user_info_spec.rb
383
+ - spec/models/filter_value_spec.rb
384
+ - spec/models/report_info_spec.rb
385
+ - spec/models/data_series_request_spec.rb
386
+ - spec/models/create_app_info_spec.rb
392
387
  - spec/models/alert_notification_request_spec.rb
393
- - spec/models/cloud_watch_settings_spec.rb
388
+ - spec/models/basic_auth_method_dto_spec.rb
389
+ - spec/models/app_description_spec.rb
390
+ - spec/models/user_info_spec.rb
391
+ - spec/models/basic_organization_dto_spec.rb
392
+ - spec/models/notification_integration_spec.rb
394
393
  - spec/models/service_integration_spec.rb
394
+ - spec/models/cloud_watch_settings_spec.rb
395
+ - spec/models/generic_api_response_spec.rb
396
+ - spec/models/user_role_spec.rb
395
397
  - spec/spec_helper.rb