ondotori-ruby-client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a965c44ac6b06067e1f7a91965f71b1aa5af922cf72f25810ea6c33a3b3ad34
-  data.tar.gz: a9a87b72b9667432147b0ee1b3e507379e336ef6323fb9ec5bc3f4de96b21c44
+  metadata.gz: 442594d52153a81560cbbf8a79fcda7cf1ab6034c54367257e6d79249904e84b
+  data.tar.gz: b5178b2d79592f93caa2263957977ac7b0962ba158901306768417b5882c97a4
 SHA512:
-  metadata.gz: 3778d91789c76e492aed29ded770fae6f456793eb8ffcd9c7996dae9304ef4bcc72ff65f7633dcf89e72b95b571ef46b0d406585399aafa4ddde32725694c46f
-  data.tar.gz: 4433bd62632b388ec92f85b46ce7bc04318fa148417e57042dce7fdab87ecc8d2bdcf5dc1f6b473aa46795d6d9c1ea13c6444a482e473260c031d23b25282ecb
+  metadata.gz: 2f5925a8a7843296922668e9168e799bf1fc6522c6c6104320555219aace442eef1c671d2e55e80e38c9f6d15d60f2444ba0b630c2793f9487f7350cae57562e
+  data.tar.gz: bf580712e184dc1e9f7942dac11a4b745c488afa43d38ec6df1d2c3901380a32732724098eb05e10b644090875c9eec1eaa505f20926be760f7c691719a23eed

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## [Unreleased]
+## [Released]
+
+## [1.1.0] - 2021-04-17
+
+- Support for getting RateLimit when an error occurs.
+
+## [1.0.0] - 2021-03-04
+
+- Support v1 all API
 
 ## [0.1.0] - 2021-02-18
 

data/README.md

@@ -29,7 +29,7 @@ The first step is to create an API key.
 
 #### Web Client Examples
 
-```
+```ruby
 params = { "api-key" => "API Key you create", "login-id" => "tbxxxx", "login-pass" => "password"}
 client = Ondotori::WebAPI::Client.new(params)
 ```
@@ -45,14 +45,15 @@ client = Ondotori::WebAPI::Client.new(params)
 
 To get current readings, do the following.
 
-```
+```ruby
 response = client.current()
 ```
+
 #### Get Latest Data
 
 To get latest data, do the following.
 
-```
+```ruby
 response = client.latest_data("SERIAL")
 ```
 
@@ -60,7 +61,7 @@ response = client.latest_data("SERIAL")
 
 To get latest data (RTR500), do the following.
 
-```
+```ruby
 response = client.latest_data_rtr500(base: "BaseUnit Serial", remote: "RemoteUnit Serial")
 ```
 
@@ -68,26 +69,28 @@ response = client.latest_data_rtr500(base: "BaseUnit Serial", remote: "RemoteUni
 
 To get data (TR-7wb/nw/wf, TR4), do the following.
 
-```
+```ruby
 from = Time.now - (3600 * 24)
 to   = Time.now
 limit = 16000
 data_range = Ondotori::WebAPI::Api::DataRange.new(from: from, to: to, limit: 10)
 response = client.data("Device Serial", data_range: data_range)
 ```
+
 data_range parameter is optional.
 
 #### Get Data (RTR500 Series)
 
 To get data (RTR500 Series), do the following.
 
-```
+```ruby
 from = Time.now - (3600 * 24)
 to   = Time.now
 limit = 16000
 data_range = Ondotori::WebAPI::Api::DataRange.new(from: from, to: to, limit: 10)
 response = client.data_rtr500(base: "BaseUnit Serial", remote: "Device Serial", data_range: data_range)
 ```
+
 data_range parameter is optional.
 
 #### Error Handling
@@ -96,15 +99,19 @@ Ondotori Errors
 
 In case of parameter abnormality or error returned from the web server, the error will be raised.
 For example, to receive an authentication error from the server, use the following.
-```
+
+```ruby
 rescue Ondotori::WebAPI::Api::Errors::ResponseError => e
-  # puts "Response error #{e.messaeg}"
+  puts "Response error #{e.message}"
 end
 ```
+
+If you reach the limit, you can check it with ResponseError.ratelimit.  
 All of these errors inherit from `Ondotori::WebAPI::Api::Errors::Error`, so you can handle or silence all errors if necessary:
-```
+
+```ruby
 rescue Ondotori::WebAPI::Api::Errors::Error => e
-  # puts "Response error #{e.messaeg}"
+  puts "An error has occurred #{e.message}"
 end
 ```
 

data/example/get_current_temp.rb

@@ -35,6 +35,13 @@ def main
     return
   end
 
+  %w[api-key login-id login-pass].each do |k|
+    if params[k].nil?
+      puts "parameter #{k} is nil. Please check #{WEB_STORAGE_ACCESS_INFO_PATH}"
+      exit
+    end
+  end
+
   begin
     client = Ondotori::WebAPI::Client.new(params)
     response = client.current

data/lib/ondotori-ruby-client.rb

@@ -7,6 +7,7 @@ require_relative "ondotori/webapi/httpwebaccess"
 require_relative "ondotori/webapi/api/errors"
 require_relative "ondotori/webapi/api/param"
 require_relative "ondotori/webapi/api/params"
+require_relative "ondotori/webapi/api/rate_limit"
 require_relative "ondotori/webapi/api/response"
 require_relative "ondotori/webapi/api/uri"
 require_relative "ondotori/webapi/api/data_range"

data/lib/ondotori/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ondotori
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/ondotori/webapi/api/errors.rb

@@ -13,7 +13,14 @@ module Ondotori
           end
         end
 
-        class ResponseError < Error; end
+        class ResponseError < Error
+          attr_reader :ratelimit
+
+          def initialize(message, code, ratelimit)
+            super message, code
+            @ratelimit = ratelimit
+          end
+        end
 
         class InitializeParameterNotFound < Error; end
 

data/lib/ondotori/webapi/api/rate_limit.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Ondotori
+  module WebAPI
+    module Api
+      class RateLimit
+        attr_reader :limit, :reset, :remaining
+
+        def initialize(response)
+          @limit     = response.get_fields("X-RateLimit-Limit")
+          @reset     = response.get_fields("X-RateLimit-Reset")
+          @remaining = response.get_fields("X-RateLimit-Remaining")
+        end
+      end
+    end
+  end
+end

data/lib/ondotori/webapi/api/response.rb

@@ -18,7 +18,8 @@ module Ondotori
             if result.key?("error")
               code = result["error"]["code"]
               message = result["error"]["message"]
-              raise Ondotori::WebAPI::Api::Errors::ResponseError.new(message, code)
+              ratelimit = Ondotori::WebAPI::Api::RateLimit.new(@response)
+              raise Ondotori::WebAPI::Api::Errors::ResponseError.new(message, code, ratelimit)
             end
 
             # unknown error...

data/lib/ondotori/webapi/httpwebaccess.rb

@@ -23,7 +23,7 @@ module Ondotori
         when Net::HTTPClientError, Net::HTTPServerError
           response
         else
-          # response.value raises Eception...
+          # response.value raises Exception...
           raise Ondotori::WebAPI::Api::Errors::HttpAccessError.new("#{response.message}", "#{response.code}", 9995)
         end
       end

data/ondotori-ruby-client.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["k28@me.com"]
 
   spec.summary       = "T&D WebStorage API Client"
-  spec.description   = "You can use this gem to get the recorded data from WebStorage."
+  spec.description   = "You can use this gem to get the recorded data from T&D WebStorage Service API."
   spec.homepage      = "https://github.com/k28/ondotori-ruby-client"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: ondotori-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kazuya Hatano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-04-17 00:00:00.000000000 Z
 dependencies: []
-description: You can use this gem to get the recorded data from WebStorage.
+description: You can use this gem to get the recorded data from T&D WebStorage Service
+  API.
 email:
 - k28@me.com
 executables: []
@@ -35,6 +36,7 @@ files:
 - lib/ondotori/webapi/api/errors.rb
 - lib/ondotori/webapi/api/param.rb
 - lib/ondotori/webapi/api/params.rb
+- lib/ondotori/webapi/api/rate_limit.rb
 - lib/ondotori/webapi/api/response.rb
 - lib/ondotori/webapi/api/uri.rb
 - lib/ondotori/webapi/client.rb