tanita-api-client 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0273fdeb978d519cf5c9f4dd0cc5c427fdb9b714c71bcf689e926a91abf35ff
-  data.tar.gz: c01bbfd1394beb20f0c840a61ca6e3934d94904590f58749f41ef6b64081eece
+  metadata.gz: 91859c1415a0fc78e01c01c1e615acdca193ce8ec887abaa19ce5d3e1353285f
+  data.tar.gz: 4b875b46afb595f6ccb84fb6776da2f4527ab9b099274131251b0a65c2ceaba9
 SHA512:
-  metadata.gz: 80c45f0e5452087291bf3bd563ae5352a3718c8e9416e1e728b06cff99332b601d77690aaa6a20e3d1ece855300b61394821341e1b6ffb2cf799a0b8891ac375
-  data.tar.gz: 31b49bc20f568776ae04858c87471b6c1cb23b37cabcd772d1ac895553afcbba341cb264d71437f280dede68737e166efaa2fef59c2429eaa210ce7c97840088
+  metadata.gz: bcd9de5af29bcf2c760a501dab1f4165c6a9102960d64ca23c10d3fbbbeadccc96ccdafd92da4bf776b2778f4d65a1f5dd9976c952317b835a8bc8ec934986ad
+  data.tar.gz: 1193a310b0014f32f16cf6b5819960b6326a8ef486582007d0a4a179c9ce8fc0788dea6d0a2c67dbefd61c600a9ed731621d4044e22b955aaef54512c00240f2

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 0.3.0
+
+changed Result hash to be Object.
+
+```
+# before
+result.items[0][:weight]
+# after
+result.items[0].weight
+```
+
+# 0.2.3
+
+remove Gemfile.lock
+
 # 0.2.2
 
 * define constants

data/README.md

@@ -92,7 +92,7 @@ result = api.status
 result = api.status(from: Date.current.ago(1.month), to: Date.current)
 
 # list the body-weight data
-result.items.each{|item| puts "#{Time.at(item[:measured_at]).strftime('%F %R')} => #{item[:weight]}" }
+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
@@ -101,23 +101,27 @@ result.items.each{|item| puts "#{Time.at(item[:measured_at]).strftime('%F %R')}
 
 # 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]
+=> #<Tanita::Api::Client::Result:70199592389780 properties=birth_date,height,sex,items>
+result.items[0]
+=> #<Tanita::Api::Client::InnerscanItem:70199597695880 properties=measured_at,registered_at,model,weight,body_fat,muscle_mass,physique_rating,visceral_fat_rating,basal_metabolic_rate,metabolic_age,bone_mass>
+result.items[0].weight
+=> 66.7
 
 # Result of Sphygmomanometer Api
 result = Tanita::Api::Client::Sphygmomanometer.new.status
-result.items[0].keys
-=> [:measured_at, :model, :maximal_pressure, :minimal_pressure, :pulse]
+result.items[0]
+=> #<Tanita::Api::Client::SphygmomanometerItem:70199592475760 properties=measured_at,registered_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.items[0]
+=> #<Tanita::Api::Client::PedometerItem:70199605021160 properties=measured_at,registered_at,model,steps,exercise,calories>
+
 
 # Result of Smug Api
 result = Tanita::Api::Client::Smug.new.status
-result.items[0].keys
-=> [:measured_at, :model, :urinary_sugar]
+result.items[0]
+=> #<Tanita::Api::Client::SmugItem:70199600803680 properties=measured_at,registered_at,model,urinary_sugar>
 
 # common attributes of Result class
 result.birth_date # [Date]

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

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require 'time'
-require 'tanita/api/client/helpers'
-
 module Tanita
   module Api
     module Client
+
       module Scope
         INNERSCAN = 'innerscan'
         SPHYGMOMANOMETER = 'sphygmomanometer'
@@ -19,122 +17,6 @@ module Tanita
       class Error < StandardError
       end
 
-      DATE_TYPE_REGISTERD_AT = 0
-      DATE_TYPE_MEASURED_AT = 1
-
-      class BaseApiClient
-        include HttpHelper
-
-        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(
-          from: nil,
-          to: nil
-        )
-          tags = measurement_tags.values.map { |i| i[:code] }.join(',')
-          params = {
-            :access_token => @access_token,
-            :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(:client => self, :response => res)
-        end
-
-        def endpoint
-          raise NotImplementedError
-        end
-
-        def measurement_tags
-          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)
-          time.strftime('%Y%m%d%H%M%S')
-        end
-      end
-
-      class Result
-        include HttpHelper
-
-        # [Date]
-        attr_reader :birth_date
-
-        # [Float] (centimeter)
-        attr_reader :height
-
-        # [String] 'male' or 'female'
-        attr_reader :sex
-
-        # [Array<Hash>]
-        attr_reader :items
-
-        def initialize(client:, response:)
-          @client = client
-          result = parse_json(response.body)
-          @birth_date = Date.parse(result[:birth_date])
-          @height = result[:height].to_f
-          @sex = result[:sex]
-          @items = build_items(result[:data])
-        end
-
-      private
-
-        def build_items(raw_items)
-          item_dic = {}
-          raw_items.each do |item|
-            date = item[:date]
-            model = item[:model]
-            key = "#{date}_#{model}"
-            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
-          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
   end
 end

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'tanita/api/client/helpers'
+
+module Tanita
+  module Api
+    module Client
+      DATE_TYPE_REGISTERD_AT = 0
+      DATE_TYPE_MEASURED_AT = 1
+
+      class BaseApiClient
+        include HttpHelper
+
+        def self.endpoint
+          raise NotImplementedError
+        end
+
+        def self.properties
+          raise NotImplementedError
+        end
+
+        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
+
+          ClassBuilder.load
+        end
+
+        def status(
+          from: nil,
+          to: nil
+        )
+          tags = self.class.properties.values.map { |i| i[:code] }.join(',')
+          params = {
+            :access_token => @access_token,
+            :date => @date_type,
+            :tag => tags
+          }
+          params[:from] = time_format(from) unless from.nil?
+          params[:to] = time_format(to) unless to.nil?
+          res = request(self.class.endpoint, params)
+          build_result(res)
+        end
+
+        def inspect
+          "\#<#{self.class}:#{object_id}>"
+        end
+
+      private
+
+        def build_result(res)
+          result = parse_json(res.body)
+          Result.new(
+            :birth_date => Date.parse(result[:birth_date]),
+            :height => result[:height].to_f,
+            :sex => result[:sex],
+            :items => build_result_items(:raw_items => result[:data])
+          )
+        end
+
+        def build_result_items(raw_items:)
+          item_dic = {}
+          raw_items.each do |item|
+            date = item[:date]
+            model = item[:model]
+            key = "#{date}_#{model}"
+            property = find_property_by_code(:code => item[:tag])
+            value = cast(:value => item[:keydata], :type => property[:type])
+            item_dic[key] ||= {}
+            item_dic[key][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][property[:name]] = value
+          end
+          items = item_dic.values.sort_by { |dic| dic[date_key] } # sort by date in ascending order
+          items.map { |_item_dic| eval "#{self.class}Item.new _item_dic" }
+        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
+
+        def find_property_by_code(code:)
+          return @property_code_dic[code] unless @property_code_dic.nil?
+
+          @property_code_dic = {}
+          self.class.properties.each do |m_name, m_info|
+            @property_code_dic[m_info[:code]] = {:name => m_name, :type => m_info[:type]}
+          end
+          @property_code_dic[code]
+        end
+
+        def date_key
+          case @date_type
+          when DATE_TYPE_REGISTERD_AT
+            :registered_at
+          when DATE_TYPE_MEASURED_AT
+            :measured_at
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Tanita
+  module Api
+    module Client
+      class BaseEntity
+        def initialize(property_values = {})
+          @properties = []
+          @cached_property_values = {}
+          @cached_property_values.merge!(property_values)
+        end
+
+        def to_h
+          ret = {}
+          self.class.properties.each do |property|
+            ret[property.to_sym] = eval property.to_s
+          end
+          ret
+        end
+
+        def inspect
+          "\#<#{self.class}:#{object_id} properties=#{self.class.properties.join(',')}>"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Tanita
+  module Api
+    module Client
+      class ClassBuilder
+        def self.load
+          return if loaded
+
+          create_class('Result', %i[birth_date height sex items])
+          base_properties = %i[measured_at registered_at model]
+          [Innerscan, Sphygmomanometer, Pedometer, Smug].each do |klass|
+            klass_name = klass.to_s.split('::')[-1] + 'Item'
+            properties = base_properties + klass.properties.keys
+            create_class(klass_name, properties)
+          end
+          @loaded = true
+        end
+
+        def self.loaded
+          @loaded || false
+        end
+        private_class_method :loaded
+
+        def self.create_class(class_name, property_names = [])
+          super_klass = Class.new(BaseEntity)
+          klass = Tanita::Api::Client.const_set(class_name, super_klass)
+          define_properties_reader(klass)
+          property_names.each do |property_name|
+            klass.properties << property_name if klass.respond_to?(:properties)
+            define_getter_and_setter(klass, property_name)
+          end
+          klass.properties.freeze if klass.respond_to?(:properties)
+        end
+        private_class_method :create_class
+
+        def self.define_properties_reader(klass)
+          klass.class_eval do
+            def self.properties
+              @properties = [] if @properties.nil?
+              @properties
+            end
+          end
+        end
+        private_class_method :define_properties_reader
+
+        def self.define_getter_and_setter(klass, property_name)
+          klass.class_eval do
+            define_method(property_name.to_sym) do
+              @cached_property_values[property_name.to_sym]
+            end
+            define_method("#{property_name}=".to_sym) do |value|
+              @cached_property_values[property_name.to_sym] = value
+            end
+          end
+        end
+        private_class_method :define_getter_and_setter
+      end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ module Tanita
       AUTH_URL_PATH = '/oauth/auth'
       AUTH_URL = "#{BASE_URL}#{AUTH_URL_PATH}"
 
-      TOKEN_URL_PATH =  '/oauth/token'
+      TOKEN_URL_PATH = '/oauth/token'
       TOKEN_URL = "#{BASE_URL}#{TOKEN_URL_PATH}"
 
       DEFAULT_REDIRECT_URI = "#{BASE_URL}/success.html"
@@ -37,6 +37,10 @@ module Tanita
         rescue JSON::ParserError => e
           raise Error.new("JSON::ParseError: '#{e}'\nstr:#{str}")
         end
+
+        def time_format(time)
+          time.strftime('%Y%m%d%H%M%S')
+        end
       end
     end
   end

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

@@ -3,7 +3,7 @@
 module Tanita
   module Api
     module Client
-      VERSION = '0.2.3'
+      VERSION = '0.3.0'
     end
   end
 end

data/lib/tanita/api/client.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
-require 'tanita/api/client/base'
-require 'tanita/api/client/helpers'
-require 'tanita/api/client/configuration'
-require 'tanita/api/client/version'
+Dir[
+  File.join(
+    File.dirname(__FILE__),
+    'client',
+    '*'
+  )
+].sort.each { |f| require f }
 
 module Tanita
   module Api
@@ -67,11 +70,11 @@ module Tanita
       end
 
       class Innerscan < BaseApiClient
-        def endpoint
+        def self.endpoint
           '/status/innerscan.json'
         end
 
-        def measurement_tags
+        def self.properties
           {
             :weight => {:code => '6021', :type => Float},
             :body_fat => {:code => '6022', :type => Float},
@@ -86,11 +89,11 @@ module Tanita
       end
 
       class Sphygmomanometer < BaseApiClient
-        def endpoint
+        def self.endpoint
           '/status/sphygmomanometer.json'
         end
 
-        def measurement_tags
+        def self.properties
           {
             :maximal_pressure => {:code =>  '622E', :type =>  Integer},
             :minimal_pressure => {:code =>  '622F', :type =>  Integer},
@@ -100,11 +103,11 @@ module Tanita
       end
 
       class Pedometer < BaseApiClient
-        def endpoint
+        def self.endpoint
           '/status/pedometer.json'
         end
 
-        def measurement_tags
+        def self.properties
           {
             :steps => {:code =>  '6331', :type =>  Integer},
             :exercise => {:code => '6335', :type => Integer},
@@ -114,11 +117,11 @@ module Tanita
       end
 
       class Smug < BaseApiClient
-        def endpoint
+        def self.endpoint
           '/status/smug.json'
         end
 
-        def measurement_tags
+        def self.properties
           {
             :urinary_sugar => {:code => '6240', :type => Integer}
           }

data/tanita-api-client.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   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['documentation_uri'] = 'https://www.rubydoc.info/gems/tanita-api-client/'
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tanita-api-client
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-12 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,9 @@ files:
 - bin/setup
 - lib/tanita/api/client.rb
 - lib/tanita/api/client/base.rb
+- lib/tanita/api/client/base_api_client.rb
+- lib/tanita/api/client/base_entity.rb
+- lib/tanita/api/client/class_builder.rb
 - lib/tanita/api/client/configuration.rb
 - lib/tanita/api/client/helpers.rb
 - lib/tanita/api/client/version.rb
@@ -98,6 +101,7 @@ metadata:
   homepage_uri: https://github.com/koshilife/tanita-api-ruby-client
   source_code_uri: https://github.com/koshilife/tanita-api-ruby-client
   changelog_uri: https://github.com/koshilife/tanita-api-ruby-client/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tanita-api-client/
 post_install_message: 
 rdoc_options: []
 require_paths: