ondotori-ruby-client 0.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 335ed96b6ab74f8124f60984363e39c1bf535f48ef37f18406cf7e3f43d58f86
-  data.tar.gz: 4cbfa18a83fd71bd8d29f5a8ca39f63251263c6849878d76304162fa0f4f653e
+  metadata.gz: 442594d52153a81560cbbf8a79fcda7cf1ab6034c54367257e6d79249904e84b
+  data.tar.gz: b5178b2d79592f93caa2263957977ac7b0962ba158901306768417b5882c97a4
 SHA512:
-  metadata.gz: b1a6b1a13d2e82386c97d7b2fd6dc2702dbfe87c3172b25f1dfcb69209842c56dd3a2eabe98e42a8cdf0f6bee97da6480982bcf0a6319367d323bb029ddc3647
-  data.tar.gz: 58cf6d9f26bb298d4d5869b681a171e9076909815a5dc033fcea148f5f3e5c6f24f3f5d3c74416113f8c783f05466fa170f25159423752946ba4f71c169b84fc
+  metadata.gz: 2f5925a8a7843296922668e9168e799bf1fc6522c6c6104320555219aace442eef1c671d2e55e80e38c9f6d15d60f2444ba0b630c2793f9487f7350cae57562e
+  data.tar.gz: bf580712e184dc1e9f7942dac11a4b745c488afa43d38ec6df1d2c3901380a32732724098eb05e10b644090875c9eec1eaa505f20926be760f7c691719a23eed

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/.rubocop.yml

@@ -36,7 +36,7 @@ Style/GuardClause:
 
 Naming/FileName:
   Exclude:
-    - lib/ondotori-web-client.rb  
+    - lib/ondotori-ruby-client.rb  
 
 
 # Offense count: 14
@@ -44,6 +44,9 @@ Naming/FileName:
 Metrics/MethodLength:
   Max: 32
 
+Metrics/ParameterLists:
+  Max: 6
+
 # Offence count: 10
 Metrics/AbcSize:
   Max: 39

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

@@ -1,3 +1,5 @@
+[![Ruby](https://github.com/k28/ondotori-ruby-client/actions/workflows/main.yml/badge.svg)](https://github.com/k28/ondotori-ruby-client/actions/workflows/main.yml)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -27,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)
 ```
@@ -43,27 +45,73 @@ client = Ondotori::WebAPI::Client.new(params)
 
 To get current readings, do the following.
 
-```
-params = { "api-key" => "API Key you create", "login-id" => "tbxxxx", "login-pass" => "password"}
-client = Ondotori::WebAPI::Client.new(params)
+```ruby
 response = client.current()
 ```
 
+#### Get Latest Data
+
+To get latest data, do the following.
+
+```ruby
+response = client.latest_data("SERIAL")
+```
+
+#### Get Latest Data RTR500
+
+To get latest data (RTR500), do the following.
+
+```ruby
+response = client.latest_data_rtr500(base: "BaseUnit Serial", remote: "RemoteUnit Serial")
+```
+
+#### Get Data (TR-7wb/nw/wf, TR4)
+
+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
 
 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
 ```
 
@@ -75,7 +123,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ondotori-ruby-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ondotori-ruby-client/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/k28/ondotori-ruby-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ondotori-ruby-client/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/example/get_current_temp.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require "ondotori-ruby-client"
+
+WEB_STORAGE_ACCESS_INFO_PATH = "/var/tmp/webstorage.json"
+# The webstorage.json looks like the following.
+# {
+#     "api-key":"T&D WebStorage API Key",
+#     "login-id" : "rbacxxxx",
+#     "login-pass" : "password"
+# }
+
+# Reads the information for API access from the file.
+def load_params
+  File.open(WEB_STORAGE_ACCESS_INFO_PATH) do |file|
+    storage_info = file.read
+    load_info = JSON.parse(storage_info)
+
+    # This is not necessary, but is left for the explanation of the parameter settings.
+    wss_access_info = {}
+    wss_access_info["api-key"]    = load_info["api-key"]
+    wss_access_info["login-id"]   = load_info["login-id"]
+    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
+  puts %(class=[#{e.class}] message=[#{e.message}])
+end
+
+def main
+  params = load_params
+  if params.nil?
+    puts "Load parameter error..."
+    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
+    puts "#{response}"
+  rescue Ondotori::WebAPI::Api::Errors::Error => e
+    puts "Some error happend #{e.message} #{e.code}"
+  end
+end
+
+main

data/lib/{ondotori-web-client.rb → ondotori-ruby-client.rb}

@@ -7,5 +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 = "0.0.1"
+  VERSION = "1.1.0"
 end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Ondotori
+  module WebAPI
+    module Api
+      class DataRange
+        attr_reader :from, :to, :limit
+
+        def initialize(from: nil, to: nil, limit: nil)
+          validate(from, to, limit)
+
+          @from = from
+          @to = to
+          @limit = limit.nil? ? 0 : [0, limit].max
+        end
+
+        def validate(from, to, _limit)
+          [from, to].each do |param|
+            next if param.nil? || param.instance_of?(Time)
+
+            raise Ondotori::WebAPI::Api::Errors::InvaildParameter.new(
+              "from and to parameter must be nil or Time.", 9992
+            )
+          end
+        end
+
+        def add_data_range(params)
+          params["unixtime-from"] = @from.to_i unless @from.nil?
+          params["unixtime-to"] = @to.to_i unless @to.nil?
+          params["number"] = @limit if @limit != 0
+        end
+      end
+    end
+  end
+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/params.rb

@@ -3,9 +3,24 @@
 module Ondotori
   module WebAPI
     module Api
-      class CurrentParams
-        def initialize(param, remote: [], base: [])
+      class ParamsBase
+        def initialize(param)
           @param = param
+        end
+
+        def to_ondotori_param
+          params = {}
+          params[Api::Param::API_KEY] = @param.api_key
+          params[Api::Param::LOGIN_ID] = @param.login_id
+          params[Api::Param::LOGIN_PASS] = @param.login_pass
+
+          params
+        end
+      end
+
+      class CurrentParams < ParamsBase
+        def initialize(param, remote: [], base: [])
+          super(param)
 
           if remote.length.positive? && base.length.positive?
             raise Ondotori::WebAPI::Api::Errors::InvaildParameter.new(
@@ -17,10 +32,7 @@ module Ondotori
         end
 
         def to_ondotori_param
-          params = {}
-          params[Api::Param::API_KEY] = @param.api_key
-          params[Api::Param::LOGIN_ID] = @param.login_id
-          params[Api::Param::LOGIN_PASS] = @param.login_pass
+          params = super
           params["remote-serial"] = @remote_serial_list if @remote_serial_list.length.positive?
           params["base-serial"] = @base_serial_list if @base_serial_list.length.positive?
 
@@ -28,26 +40,93 @@ module Ondotori
         end
       end
 
-      class LatestDataParams
-        def initialize(_param, serial)
+      class LatestDataParams < ParamsBase
+        def initialize(param, serial: "")
+          super(param)
           if serial.empty?
             raise Ondotori::WebAPI::Api::Errors::InvaildParameter.new(
-              "latest-data need remote-serial", 9998
+              "latest-data need remote-serial", 9994
             )
           end
           @remote_serial = serial
         end
 
         def to_ondotori_param
-          params = {}
-          params[Api::Param::API_KEY] = @param.api_key
-          params[Api::Param::LOGIN_ID] = @param.login_id
-          params[Api::Param::LOGIN_PASS] = @param.login_pass
+          params = super
+          params["remote-serial"] = @remote_serial
+
+          params
+        end
+      end
+
+      class LatestDataRTR500Params < ParamsBase
+        def initialize(param, base: "", remote: "")
+          super(param)
+          if base.empty? || remote.empty?
+            raise Ondotori::WebAPI::Api::Errors::InvaildParameter.new(
+              "latest-data-rtr500 need both the  baseunit serial and remote unit serial.", 9993
+            )
+          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
+
+      class DataParams < ParamsBase
+        def initialize(param, serial, data_range: nil)
+          super(param)
+          validate(serial)
+          @data_range = data_range
+          @serial = serial
+        end
+
+        def validate(serial)
+          unless serial.instance_of?(String)
+            raise Ondotori::WebAPI::Api::Errors::InvaildParameter.new(
+              "serial must be String.", 9991
+            )
+          end
+        end
+
+        def to_ondotori_param
+          params = super
+          params["remote-serial"] = @serial
+          @data_range&.add_data_range(params)
+
+          params
+        end
+      end
+
+      class DataRTR500Params < DataParams
+        def initialize(param, serial, base, data_range: nil)
+          super(param, serial, data_range: data_range)
+          validate_base(base)
+          @base =  base
+        end
+
+        def validate_base(base)
+          unless base.instance_of?(String)
+            raise Ondotori::WebAPI::Api::Errors::InvaildParameter.new(
+              "base unit serial must be String.", 9991
+            )
+          end
+        end
+
+        def to_ondotori_param
+          params = super
+          params["base-serial"] = @base
+
+          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

@@ -10,13 +10,37 @@ module Ondotori
         @uri = uri
       end
 
-      def current(remote_serial_list: [], base_serial_list: [])
-        current_param = Api::CurrentParams.new(@param, remote: remote_serial_list, base: base_serial_list)
-        response = @web_access.access("#{base_uri}current", current_param.to_ondotori_param)
+      def access_server(param, uri)
+        response = @web_access.access(uri, param.to_ondotori_param)
         ondotori_response = Ondotori::WebAPI::Api::Response.new(response)
         ondotori_response.result
       end
 
+      def current(remote_serial_list: [], base_serial_list: [])
+        param = Api::CurrentParams.new(@param, remote: remote_serial_list, base: base_serial_list)
+        access_server(param, "#{base_uri}current")
+      end
+
+      def latest_data(serial)
+        param = Api::LatestDataParams.new(@param, serial: serial)
+        access_server(param, "#{base_uri}latest-data")
+      end
+
+      def latest_data_rtr500(base: "", remote: "")
+        param = Api::LatestDataRTR500Params.new(@param, base: base, remote: remote)
+        access_server(param, "#{base_uri}latest-data-rtr500")
+      end
+
+      def data(serial, data_range: nil)
+        param = Api::DataParams.new(@param, serial, data_range: data_range)
+        access_server(param, "#{base_uri}data")
+      end
+
+      def data_rtr500(base: "", remote: "", data_range: nil)
+        param = Api::DataRTR500Params.new(@param, remote, base, data_range: data_range)
+        access_server(param, "#{base_uri}data-rtr500")
+      end
+
       def base_uri
         return @uri unless @uri.empty?
 

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/lib/ondotori/webapi/webaccess.rb

@@ -13,14 +13,15 @@ module Ondotori
     end
 
     class StbWebAccess < WebAccess
-      attr_reader :params
+      attr_reader :params, :uri
 
       def initialize(timeout, on_access)
         super timeout
         @on_access = on_access
       end
 
-      def access(_uri, params)
+      def access(uri, params)
+        @uri = uri
         @params = params
         @on_access.call(self)
       end

data/ondotori-ruby-client.gemspec

@@ -9,9 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["k28@me.com"]
 
   spec.summary       = "T&D WebStorage API Client"
-  spec.description   = <<-TXT.gsub(/^ +/, '')
-    You can use this gem to get the recorded data from WebStorage.
-  TXT
+  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,18 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: ondotori-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Kazuya Hatano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-22 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: []
@@ -30,11 +29,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/ondotori-web-client.rb
+- example/get_current_temp.rb
+- lib/ondotori-ruby-client.rb
 - lib/ondotori/version.rb
+- lib/ondotori/webapi/api/data_range.rb
 - 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