tanita-api-client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0325b0624c8b82bbec750574aaf9330352520598be1a35d7992389807477af0d
-  data.tar.gz: d976f86f33c4e72c89009dd5e474d62834c570316ebb4ce712c379aa04b1792c
+  metadata.gz: fb992058a0dd7fdb3add0db60205e370a8d167416324ed7339b32ef0c588f98e
+  data.tar.gz: 2e1ce4e7562d1eeec91516edb07df7447fa730c980c61891cbe1d5f122c39abb
 SHA512:
-  metadata.gz: c7a6f768eedd5365e0381162ebe5f40f3dda5ca70b5c7623dd7c5b1d3a99990181ffa27f75a73d41895cbb470b9d40db125885bc86463ff3585e4d845e85745c
-  data.tar.gz: acd0893e68b74525c66b8834df29d00f94c006b0845ec607f773015776612f5f2245432069087306bc0305a333e814bf6896dce44e8f1a9f8814e86c9fb0c34a
+  metadata.gz: 3c5215df1edcc0cea3ddc324b1ed99ba0791a3b3fd5b8ac1fdf8433402248fd820ebf38427f3cf8f24a269a63f38f7351c03902b625dad0432e50c02736a2898
+  data.tar.gz: 770dc23e29bfa3f054957c7de11f3778d1211616608bba427808c7acf95d3f117ef935db67adbf39181db6e317ccb60aa05526be72ea16bb994c600e708a769f

data/CHANGELOG.md

@@ -1,4 +1,14 @@
 
+# 0.2.0
+
+* set required ruby version to greater than or equal to v2.4
+* added `data_type` argument in BaseApiClient#initialize
+* set a proper data type in Result class attributes
+* rename some attributes in Result class
+  * e.g.
+  * `@data` to `@items`
+  * `@data[0][:date]` to `@items[0][:measured_at]` or `@items[0][:registered_at]`
+
 # 0.1.1
 
 * support Tanita::Api::Client.configure
@@ -6,4 +16,4 @@
 
 # 0.1.0
 
-* Initial release
+* Initial release

data/Gemfile

@@ -2,11 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in tanita-api-client.gemspec
 gemspec
-
-group :development do
-  gem 'rubocop', require: false
-end
-
-group :test do
-  gem 'webmock', require: false
-end

data/Gemfile.lock

@@ -1,25 +1,19 @@
 PATH
   remote: .
   specs:
-    tanita-api-client (0.1.1)
+    tanita-api-client (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     hashdiff (1.0.0)
-    jaro_winkler (1.5.4)
-    parallel (1.19.1)
-    parser (2.7.0.1)
-      ast (~> 2.4.0)
     public_suffix (4.0.3)
-    rainbow (3.0.0)
-    rake (10.5.0)
+    rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -33,16 +27,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.78.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.6)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
-    unicode-display_width (1.6.0)
     webmock (3.7.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -53,11 +38,10 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
-  rake (~> 10.0)
+  rake (~> 12.0)
   rspec (~> 3.0)
-  rubocop
   tanita-api-client!
-  webmock
+  webmock (~> 3.7.6)
 
 BUNDLED WITH
    2.1.3

data/README.md

@@ -60,7 +60,7 @@ auth_helper = Tanita::Api::Client::Auth.new(
 Below is the sample get an authentication url and exchange access token from an authentication code.
 
 ```ruby
-# get Tanita authentication url
+# get Health Planet authentication url
 auth_helper.auth_uri
 => "https://www.healthplanet.jp/oauth/auth?client_id=YOUR_ID&redirect_uri=http%3A%2F%2F127.0.0.1%2Fcallback&scope=innerscan&response_type=code"
 
@@ -91,21 +91,42 @@ result = api.status
 result = api.status(from: Date.current.ago(1.month), to: Date.current)
 
 # list the body-weight data
-result.data.each{|item| puts "#{item[:date]} #{item[:weight]}" }
->> result.data.each{|item| puts "#{item[:date]} #{item[:weight]}" }
-201910070753 66.70
-201910070917 66.00
-201910080739 66.40
-201910090806 66.20
-201910090852 65.50
-201910100809 66.70
-201910110902 66.50
-201910130822 66.70
+result.items.each{|item| puts "#{Time.at(item[:measured_at]).strftime('%F %R')} => #{item[:weight]}" }
+2019-10-10 08:09 => 66.7
+2019-10-11 09:02 => 66.5
+2019-10-13 08:22 => 66.7
+2019-10-15 08:49 => 66.4
+2019-10-17 07:52 => 67.0
+
+# Result of Innerscan Api
+result = Tanita::Api::Client::Innerscan.new.status
+result.items[0].keys
+=> [:measured_at, :model, :weight, :body_fat, :muscle_mass, :physique_rating, :visceral_fat_rating, :basal_metabolic_rate, :metabolic_age, :bone_mass]
+
+# Result of Sphygmomanometer Api
+result = Tanita::Api::Client::Sphygmomanometer.new.status
+result.items[0].keys
+=> [:measured_at, :model, :maximal_pressure, :minimal_pressure, :pulse]
+
+# Result of Pedometer Api
+result = Tanita::Api::Client::Pedometer.new.status
+result.items[0].keys
+=> [:measured_at, :model, :steps, :calories]
+
+# Result of Smug Api
+result = Tanita::Api::Client::Smug.new.status
+result.items[0].keys
+=> [:measured_at, :model, :urinary_sugar]
+
+# common attributes of Result class
+result.birth_date # [Date]
+result.height     # [Float] (centimeter)
+result.sex        # [String] 'male' or 'female'
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/koshilife/tanita-api-ruby-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on [GitHub](https://github.com/koshilife/tanita-api-ruby-client). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/tanita/api/client.rb

@@ -73,15 +73,14 @@ module Tanita
 
         def measurement_tags
           {
-            :weight => '6021',
-            :body_fat => '6022',
-            :muscle_mass => '6023',
-            :physique_rating => '6024',
-            :visceral_fat_rating2 => '6025',
-            :visceral_fat_rating1 => '6026',
-            :basal_metabolic_rate => '6027',
-            :metabolic_age => '6028',
-            :bone_mass => '6029'
+            :weight => {:code => '6021', :type => Float},
+            :body_fat => {:code => '6022', :type => Float},
+            :muscle_mass => {:code => '6023', :type => Float},
+            :physique_rating => {:code => '6024', :type => Integer},
+            :visceral_fat_rating => {:code => '6025', :type => Float},
+            :basal_metabolic_rate => {:code => '6027', :type => Integer},
+            :metabolic_age =>  {:code => '6028', :type => Integer},
+            :bone_mass =>  {:code => '6029', :type => Float}
           }
         end
       end
@@ -93,9 +92,9 @@ module Tanita
 
         def measurement_tags
           {
-            :maximal_pressure => '622E',
-            :minimal_pressure => '622F',
-            :pulse => '6230'
+            :maximal_pressure => {:code =>  '622E', :type =>  Integer},
+            :minimal_pressure => {:code =>  '622F', :type =>  Integer},
+            :pulse => {:code =>  '6230', :type =>  Integer}
           }
         end
       end
@@ -107,9 +106,9 @@ module Tanita
 
         def measurement_tags
           {
-            :steps => '6331',
-            :exercise => '6335',
-            :calories => '6336'
+            :steps => {:code =>  '6331', :type =>  Integer},
+            :exercise => {:code => '6335', :type => Integer},
+            :calories => {:code => '6336', :type => Integer}
           }
         end
       end
@@ -121,7 +120,7 @@ module Tanita
 
         def measurement_tags
           {
-            :urinary_sugar => '6240'
+            :urinary_sugar => {:code => '6240', :type => Integer}
           }
         end
       end

data/lib/tanita/api/client/base.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'time'
 require 'tanita/api/client/helpers'
 
 module Tanita
@@ -18,33 +19,35 @@ module Tanita
       class Error < StandardError
       end
 
+      DATE_TYPE_REGISTERD_AT = 0
+      DATE_TYPE_MEASURED_AT = 1
+
       class BaseApiClient
         include HttpHelper
 
-        DATE_REGISTERD_AT = 0
-        DATE_MEASURED_AT = 1
-
-        def initialize(access_token: nil)
+        def initialize(access_token: nil, date_type: DATE_TYPE_MEASURED_AT)
           config = Tanita::Api::Client.configuration
           @access_token = access_token || config.access_token
           raise Error.new("param:'access_token' is required.'") if @access_token.nil?
+
+          @date_type = date_type
+          raise Error.new("param:'date_type' is invalid.'") unless [DATE_TYPE_REGISTERD_AT, DATE_TYPE_MEASURED_AT].include? date_type
         end
 
         def status(
-          date_type: DATE_MEASURED_AT,
           from: nil,
           to: nil
         )
-          tags = measurement_tags.values.join(',')
+          tags = measurement_tags.values.map { |i| i[:code] }.join(',')
           params = {
             :access_token => @access_token,
-            :date => date_type,
+            :date => @date_type,
             :tag => tags
           }
           params[:from] = time_format(from) unless from.nil?
           params[:to] = time_format(to) unless to.nil?
           res = request(endpoint, params)
-          Result.new(:response => res, :client => self)
+          Result.new(:client => self, :response => res)
         end
 
         def endpoint
@@ -55,6 +58,25 @@ module Tanita
           raise NotImplementedError
         end
 
+        def find_measurement_tag(code:)
+          return @inverted_measurement[code] unless @inverted_measurement.nil?
+
+          @inverted_measurement = {}
+          measurement_tags.each do |m_name, m_info|
+            @inverted_measurement[m_info[:code]] = {:name => m_name, :type => m_info[:type]}
+          end
+          @inverted_measurement[code]
+        end
+
+        def date_key
+          case @date_type
+          when DATE_TYPE_REGISTERD_AT
+            :registered_at
+          when DATE_TYPE_MEASURED_AT
+            :measured_at
+          end
+        end
+
       private
 
         def time_format(time)
@@ -64,39 +86,53 @@ module Tanita
 
       class Result
         include HttpHelper
+
+        # [Date]
         attr_reader :birth_date
+
+        # [Float] (centimeter)
         attr_reader :height
+
+        # [String] 'male' or 'female'
         attr_reader :sex
-        attr_reader :data
 
-        def initialize(response:, client:)
+        # [Array<Hash>]
+        attr_reader :items
+
+        def initialize(client:, response:)
+          @client = client
           result = parse_json(response.body)
-          @birth_date = result[:birth_date]
-          @height = result[:height]
+          @birth_date = Date.parse(result[:birth_date])
+          @height = result[:height].to_f
           @sex = result[:sex]
-
-          mapper = client.measurement_tags.invert
-          set_data(result[:data], mapper)
+          @items = build_items(result[:data])
         end
 
       private
 
-        def set_data(items, mapper)
-          data_dic = {}
-          items.each do |item|
+        def build_items(raw_items)
+          item_dic = {}
+          raw_items.each do |item|
             date = item[:date]
             model = item[:model]
             key = "#{date}_#{model}"
-            measurement = mapper[item[:tag]]
-            value = item[:keydata]
-
-            data_dic[key] ||= {}
-            data_dic[key][:date] = date unless data_dic[key].key? :date
-            data_dic[key][:model] = model unless data_dic[key].key? :model
-            data_dic[key][measurement] = value
+            measurement = @client.find_measurement_tag(:code => item[:tag])
+            value = cast(:value => item[:keydata], :type => measurement[:type])
+            item_dic[key] ||= {}
+            item_dic[key][@client.date_key] = Time.parse("#{date} +09:00").to_i unless item_dic[key].key? :date
+            item_dic[key][:model] = model unless item_dic[key].key? :model
+            item_dic[key][measurement[:name]] = value
           end
           # sort by date in ascending order
-          @data = data_dic.values.sort_by { |dic| dic[:date] }
+          item_dic.values.sort_by { |dic| dic[@client.date_key] }
+        end
+
+        def cast(value:, type:)
+          return value if value.nil?
+          return value.to_i if type == Integer
+          return value.to_f if type == Float
+
+          value
         end
       end
     end

data/lib/tanita/api/client/version.rb

@@ -3,7 +3,7 @@
 module Tanita
   module Api
     module Client
-      VERSION = '0.1.1'
+      VERSION = '0.2.0'
     end
   end
 end

data/tanita-api-client.gemspec

@@ -1,32 +1,36 @@
-lib = File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "tanita/api/client/version"
+require 'tanita/api/client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "tanita-api-client"
+  spec.name          = 'tanita-api-client'
   spec.version       = Tanita::Api::Client::VERSION
-  spec.authors       = ["Kenji Koshikawa"]
-  spec.email         = ["koshikawa2009@gmail.com"]
+  spec.authors = ['Kenji Koshikawa']
+  spec.email         = ['koshikawa2009@gmail.com']
 
   spec.description   = 'Client for accessing Tanita Health Planet APIs'
   spec.summary       = spec.description
   spec.homepage      = 'https://github.com/koshilife/tanita-api-ruby-client'
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/koshilife/tanita-api-ruby-client"
-  spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/blob/master/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/koshilife/tanita-api-ruby-client'
+  spec.metadata['changelog_uri'] = "#{spec.metadata['source_code_uri']}/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.7.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tanita-api-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-06 00:00:00.000000000 Z
+date: 2020-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.6
 description: Client for accessing Tanita Health Planet APIs
 email:
 - koshikawa2009@gmail.com
@@ -62,9 +76,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
 - ".travis.yml"
-- ".vscode/settings.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -95,14 +107,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Client for accessing Tanita Health Planet APIs

data/.ruby-version

@@ -1 +0,0 @@
-2.6.3

data/.vscode/settings.json

@@ -1,14 +0,0 @@
-{
-    "ruby.format": "rubocop",
-    "ruby.lint": {
-      "rubocop": true
-    },
-    "[ruby]": {
-      "editor.formatOnSave": true,
-      "editor.formatOnSaveTimeout": 10000,
-  },
-  "[javascript]": {
-      "editor.formatOnSave": true,
-      "editor.formatOnSaveTimeout": 10000,
-  }
-}