atsd 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9048a6df918c13c0735a88772e2f6ec0efd03ebd
-  data.tar.gz: 7145ea2cfe5149d9c6e49f168f944158eb71dd46
+  metadata.gz: b0e89bd60ef6cebc62ea916e081c3a8c656ffe63
+  data.tar.gz: 3ac82ee116c326a1b4654804c1755a2eb4c32c4c
 SHA512:
-  metadata.gz: 679adcba7de6756e40f1ed2ab250a537d2173be3b68bd8096cacd64211dbb2db1817c8be612e658326eb994e4ec1ac5eb2c7f81ddc0d18a5160a1f99fd515dd6
-  data.tar.gz: b56edd97517d94ab36e9fcc6e188a6f02f6fa9952f7b6aa0a887d78f0720cc8e47f2afcb23e92ab65ee48d117af096d48bcd5a8826fb07c90c4d1571dd229f71
+  metadata.gz: 555ff0f339e534b1a3964f5d86dace6c062f6b338c344530992bf81cb2c07f7b1028978274d2c8912974c91b2f9b14e633e736d0c1600b6755ad35467751c803
+  data.tar.gz: aae4d446164fd7c1e847adc972d78f6271a657c360f49bd4069917be09dc8131777d4a434bcaf6023e18dfb12c231736f227e261f8e07331308aee6732dfd3ce

data/README.md

@@ -2,7 +2,7 @@
 
 The ATSD Client for Ruby enables Ruby developers 
 to easily read and write statistics and metadata 
-from Axibase Time Series Database.
+from the Axibase Time Series Database.
 
 API documentation: https://github.com/axibase/atsd-docs/blob/master/api/README.md
 
@@ -89,7 +89,7 @@ atsd = ATSD.new :url => "#{API_ENDPOINT}/api/v1",
 ### Configuration
 
 #### Authorization
-In order to use the API you need to specify `:basic_auth` option in one
+In order to use the API, you need to specify the `:basic_auth` option in one
 of the following ways:
 
 - `"login:password"`
@@ -98,31 +98,31 @@ of the following ways:
 #### SSL 
 Connecting to ATSD via SSL requires extra configuration if your ATSD instance runs on a self-signed SSL certificate. 
 See [Faraday Wiki](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates) on how to setup SSL. 
-As a workaround you can specify `ssl: { verify: false }` option in the client.
+As a workaround you can specify the `ssl: { verify: false }` option in the client.
 
 
 #### Logging
 
 - To use a custom logger specify it in the `:logger` option. 
-- To use the default STDOUT logger set `:logger` option to `true`. 
+- To use the default STDOUT logger set the `:logger` option to `true`. 
 
 ### Services
 Once you instantiated the ATSD class, you can use different services. 
-Each service represents a particular object type in Axibase Time Series Database.
+Each service represents a particular object type in the Axibase Time Series Database.
 The following services are currently implemented: 
 
-- series_service, 
-- properties_service, 
-- messages_service, 
-- alerts_service, 
-- metrics_service,
-- entities_service,
-- entity_groups_service.
+- `series_service`
+- `properties_service`
+- `messages_service`
+- `alerts_service`
+- `metrics_service`
+- `entities_service`
+- `entity_groups_service`
 
 #### Query builders
 Query objects created by services provide convenient methods to build complex queries.
-They support method chaining and automatically translate snake_styled properties 
-to CamelCase used in the API. For example, `end_time` property in ruby code becomes `endTime` in json request.
+They support method chaining and automatically translate `snake_styled` properties 
+to CamelCase used in the API. For example, the `end_time` property in ruby code becomes `endTime` in a json request.
 
 #### Series Service
 
@@ -176,7 +176,7 @@ query.execute
 #   :data=>[{"t"=>1428300000000, "v"=>23.57}]}]
 ```
 
-Query with Versions:
+Query with versions:
 
 ```ruby
 query = atsd.series_service.query("sensor-2", "pressure", Time.parse("2015-11-17T12:00:00Z"), Time.parse("2015-11-17T19:00:00Z"), {:versioned => true})
@@ -211,7 +211,7 @@ puts output
    2015-11-17T18:00:00Z,            17.0,      2015-11-19T11:32:35Z,           gateway-1,               error
 ```
 
-Inserting series:
+Inserting Series:
 
 ```ruby
 s = Series.new
@@ -263,7 +263,7 @@ Inserting CSV data from file:
 series_service.csv_insert('sensor-1', File.read('/path/to/data.csv'), { :user => 'beta' })
 ```
 
-Retrieving series values CSV and JSON format:
+Retrieving series values in CSV and JSON format:
 
 ```ruby
 series_service.url_query('json','nurswgvml007','cpu_busy', :startDate => 'previous_minute', :endDate => 'now')
@@ -485,15 +485,15 @@ entity_groups_service.get_entities("java-loggers", :limit => 3, :timeFormat => "
 ```
 
 ### Errors
-If the request wasn't completed successfully then an `ATSD::APIError` exception is raised. You can get a message and HTTP status code using the `message` and `status`
+If the request wasn't completed successfully, then an `ATSD::APIError` exception is raised. You can get a message and HTTP status code using the `message` and `status`
 fields.
 
 ### Low-level API Client
-Gem also provides an `ATSD::Client` class. It is a simple API wrapper 
+Gem also provides an `ATSD::Client` class. It is a simple API wrapper, 
 which uses [Faraday](https://github.com/lostisland/faraday) to handle HTTP-related routines. 
 All services are built on top of it. 
 
-You can access `Faraday::Connection` object using the `connection` field of the client if necessary.
+You can access the `Faraday::Connection` object using the `connection` field of the client if necessary.
 
 ## Development
 

data/atsd.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'vcr', '~> 2.9'
-  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'yard', '~> 0.9.11'
   spec.add_development_dependency 'redcarpet'
   spec.add_development_dependency 'geminabox'
   spec.add_development_dependency 'multi_json'

data/lib/atsd/version.rb

@@ -1,3 +1,3 @@
 module ATSD
-  VERSION = '1.0.9'
+  VERSION = '1.0.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atsd
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Axibase Corporation
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-28 00:00:00.000000000 Z
+date: 2017-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -259,9 +259,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Axibase Time Series Database Client for Ruby.
 test_files: []
-has_rdoc: