ondotori-ruby-client 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a965c44ac6b06067e1f7a91965f71b1aa5af922cf72f25810ea6c33a3b3ad34
-  data.tar.gz: a9a87b72b9667432147b0ee1b3e507379e336ef6323fb9ec5bc3f4de96b21c44
+  metadata.gz: 3e2b5691b375a55fc06352a122ce7a460bb8c3c2dc24762b426e42408e4cb4ce
+  data.tar.gz: 6c35ca3b21b11fb29a30ca4ce43baa38ec06ab08514b4cdc67391ff555c9d13b
 SHA512:
-  metadata.gz: 3778d91789c76e492aed29ded770fae6f456793eb8ffcd9c7996dae9304ef4bcc72ff65f7633dcf89e72b95b571ef46b0d406585399aafa4ddde32725694c46f
-  data.tar.gz: 4433bd62632b388ec92f85b46ce7bc04318fa148417e57042dce7fdab87ecc8d2bdcf5dc1f6b473aa46795d6d9c1ea13c6444a482e473260c031d23b25282ecb
+  metadata.gz: e5d1a863aa4f7eb4fcb5b7ed30b42177c47c37b959e8554dfbbfbd03a8610f598ac255897a03ee3f803579b6651b5460e3fc39b986864a94cf46f9d1bb2aa2e4
+  data.tar.gz: 545a1ff4496317c78eb4c520f8ded98dbe83ca4b7e62329a8dd4311fd08b8cc2d0f6846ba7c4f65429d49fd09dc065678ded5f50f7922c313b083c0cd84afc5d

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  NewCops: enable
+  SuggestExtensions: false
 
 Style/StringLiterals:
   Enabled: true

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/Gemfile

@@ -9,4 +9,4 @@ gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
 
-gem "rubocop", "~> 1.7"
+gem "rubocop", "1.12"

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,43 +69,57 @@ 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.
 
+#### Get Alert log
+
+To get alert log, do the following.
+
+```ruby
+response = client.alert_log(base: "BaseUnit Serial", remote: "RemoteUnit Serial")
+```
+
 #### Error Handling
 
 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

@@ -22,9 +22,7 @@ def load_params
     wss_access_info["login-pass"] = load_info["login-pass"]
     return wss_access_info
   end
-rescue SystemCallError => e
-  puts %(class=[#{e.class}] message=[#{e.message}])
-rescue IOError => e
+rescue SystemCallError, IOError => e
   puts %(class=[#{e.class}] message=[#{e.message}])
 end
 
@@ -35,6 +33,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/version.rb

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

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

@@ -8,12 +8,19 @@ module Ondotori
           attr_reader :code
 
           def initialize(message, code = nil)
-            super message
+            super(message)
             @code = code
           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
 
@@ -23,7 +30,7 @@ module Ondotori
           attr_reader :detail
 
           def initialize(message, detail, code = nil)
-            super message, code
+            super(message, code)
             @detail = detail
           end
         end

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

@@ -127,6 +127,27 @@ module Ondotori
           params
         end
       end
+
+      class AlertLogParams < ParamsBase
+        def initialize(param, base: "", remote: "")
+          super(param)
+          if base.empty? || remote.empty?
+            raise Ondotori::WebAPI::Api::Errors::InvaildParameter.new(
+              "alert-log need both the baseunit serial and remote unit serial.", 9990
+            )
+          end
+          @base_serial = base
+          @remote_serial = remote
+        end
+
+        def to_ondotori_param
+          params = super
+          params["base-serial"] = @base_serial
+          params["remote-serial"] = @remote_serial
+
+          params
+        end
+      end
     end
   end
 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/client.rb

@@ -41,6 +41,11 @@ module Ondotori
         access_server(param, "#{base_uri}data-rtr500")
       end
 
+      def alert_log(base: "", remote: "")
+        param = Api::AlertLogParams.new(@param, base: base, remote: remote)
+        access_server(param, "#{base_uri}alert")
+      end
+
       def base_uri
         return @uri unless @uri.empty?
 

data/lib/ondotori/webapi/httpwebaccess.rb

@@ -18,12 +18,10 @@ module Ondotori
 
         response = http.request_post(web_uri.path, params.to_json, make_headers)
         case response
-        when Net::HTTPSuccess
-          response
-        when Net::HTTPClientError, Net::HTTPServerError
+        when Net::HTTPSuccess, 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/lib/ondotori/webapi/webaccess.rb

@@ -16,7 +16,7 @@ module Ondotori
       attr_reader :params, :uri
 
       def initialize(timeout, on_access)
-        super timeout
+        super(timeout)
         @on_access = on_access
       end
 

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/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")
@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: ondotori-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kazuya Hatano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2025-05-03 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
@@ -48,6 +50,7 @@ metadata:
   homepage_uri: https://github.com/k28/ondotori-ruby-client
   source_code_uri: https://github.com/k28/ondotori-ruby-client
   changelog_uri: https://github.com/k28/ondotori-ruby-client/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -63,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: T&D WebStorage API Client