ondotori-ruby-client 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a629b226e96126e7f1164d71fcd36700b7af8d2229c2e16a2ccbb6c5a44213a8
-  data.tar.gz: 5a134e0ca23f3fb706566f86fb335fddf2ae3ce3fcbbe035bcefeb546dfc35a7
+  metadata.gz: 4a965c44ac6b06067e1f7a91965f71b1aa5af922cf72f25810ea6c33a3b3ad34
+  data.tar.gz: a9a87b72b9667432147b0ee1b3e507379e336ef6323fb9ec5bc3f4de96b21c44
 SHA512:
-  metadata.gz: d0044b0473197e69e7f978f399ec29c24e62f406118f1e1808f76d822b371e4f41cf311e66727953fd8e1ba446f535aba101d8d92552ad0e658e21e8136d85b1
-  data.tar.gz: 1a0826dcc6e452c31f15f6c364559f8102d7403731659c1d55bb5974375fc0832199d63f9d40c8ca9e629be37e1d9ef1633a90f8553162e141536d79057d5444
+  metadata.gz: 3778d91789c76e492aed29ded770fae6f456793eb8ffcd9c7996dae9304ef4bcc72ff65f7633dcf89e72b95b571ef46b0d406585399aafa4ddde32725694c46f
+  data.tar.gz: 4433bd62632b388ec92f85b46ce7bc04318fa148417e57042dce7fdab87ecc8d2bdcf5dc1f6b473aa46795d6d9c1ea13c6444a482e473260c031d23b25282ecb

data/.rubocop.yml

@@ -44,6 +44,9 @@ Naming/FileName:
 Metrics/MethodLength:
   Max: 32
 
+Metrics/ParameterLists:
+  Max: 6
+
 # Offence count: 10
 Metrics/AbcSize:
   Max: 39

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:
@@ -44,8 +46,6 @@ 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)
 response = client.current()
 ```
 #### Get Latest Data
@@ -53,8 +53,6 @@ response = client.current()
 To get latest data, do the following.
 
 ```
-params = { "api-key" => "API Key you create", "login-id" => "tbxxxx", "login-pass" => "password"}
-client = Ondotori::WebAPI::Client.new(params)
 response = client.latest_data("SERIAL")
 ```
 
@@ -63,8 +61,6 @@ response = client.latest_data("SERIAL")
 To get latest data (RTR500), do the following.
 
 ```
-params = { "api-key" => "API Key you create", "login-id" => "tbxxxx", "login-pass" => "password"}
-client = Ondotori::WebAPI::Client.new(params)
 response = client.latest_data_rtr500(base: "BaseUnit Serial", remote: "RemoteUnit Serial")
 ```
 
@@ -75,12 +71,24 @@ To get data (TR-7wb/nw/wf, TR4), do the following.
 ```
 from = Time.now - (3600 * 24)
 to   = Time.now
-limit = 173
-params = { "api-key" => "API Key you create", "login-id" => "tbxxxx", "login-pass" => "password"}
-client = Ondotori::WebAPI::Client.new(params)
-response = client.data("Device Serial", from: from, to: to, limit: limit)
+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.
+
+```
+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)
 ```
-from, to and limit parameter is optional.
+data_range parameter is optional.
 
 #### Error Handling
 

data/lib/ondotori-ruby-client.rb

@@ -9,3 +9,4 @@ require_relative "ondotori/webapi/api/param"
 require_relative "ondotori/webapi/api/params"
 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.4"
+  VERSION = "1.0.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/params.rb

@@ -81,36 +81,48 @@ module Ondotori
       end
 
       class DataParams < ParamsBase
-        def initialize(param, serial, from: nil, to: nil, limit: nil)
+        def initialize(param, serial, data_range: nil)
           super(param)
-          validate(serial, from, to, limit)
+          validate(serial)
+          @data_range = data_range
           @serial = serial
-          @from = from
-          @to = to
-          @limit = limit.nil? ? 0 : [0, limit].max
         end
 
-        def validate(serial, from, to, _limit)
+        def validate(serial)
           unless serial.instance_of?(String)
             raise Ondotori::WebAPI::Api::Errors::InvaildParameter.new(
               "serial must be String.", 9991
             )
           end
-          [from, to].each do |param|
-            next if param.nil? || param.instance_of?(Time)
+        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(
-              "from and to parameter must be nil or Time.", 9992
+              "base unit serial must be String.", 9991
             )
           end
         end
 
         def to_ondotori_param
           params = super
-          params["remote-serial"] = @serial
-          params["unixtime-from"] = @from.to_i unless @from.nil?
-          params["unixtime-to"] = @to.to_i unless @to.nil?
-          params["number"] = @limit if @limit != 0
+          params["base-serial"] = @base
 
           params
         end

data/lib/ondotori/webapi/client.rb

@@ -10,32 +10,35 @@ 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)
-        response = @web_access.access("#{base_uri}latest-data", param.to_ondotori_param)
-        ondotori_response = Ondotori::WebAPI::Api::Response.new(response)
-        ondotori_response.result
+        access_server(param, "#{base_uri}latest-data")
       end
 
       def latest_data_rtr500(base: "", remote: "")
         param = Api::LatestDataRTR500Params.new(@param, base: base, remote: remote)
-        response = @web_access.access("#{base_uri}latest-data-rtr500", param.to_ondotori_param)
-        ondotori_response = Ondotori::WebAPI::Api::Response.new(response)
-        ondotori_response.result
+        access_server(param, "#{base_uri}latest-data-rtr500")
       end
 
-      def data(serial, from: nil, to: nil, limit: nil)
-        param = Api::DataParams.new(@param, serial, from: from, to: to, limit: limit)
-        response = @web_access.access("#{base_uri}data", param.to_ondotori_param)
-        ondotori_response = Ondotori::WebAPI::Api::Response.new(response)
-        ondotori_response.result
+      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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ondotori-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Kazuya Hatano
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-27 00:00:00.000000000 Z
+date: 2021-03-04 00:00:00.000000000 Z
 dependencies: []
 description: You can use this gem to get the recorded data from WebStorage.
 email:
@@ -31,6 +31,7 @@ files:
 - 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