tanita-api-client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7276f5bfe20571b5e467cb6723f40df02c52d7287de11dca0eb40009487c3e21
-  data.tar.gz: 44d0295e8ed1d822e5cc2dc60e0b2222fa046970cde0973b1bdc3372d930f0d4
+  metadata.gz: 0325b0624c8b82bbec750574aaf9330352520598be1a35d7992389807477af0d
+  data.tar.gz: d976f86f33c4e72c89009dd5e474d62834c570316ebb4ce712c379aa04b1792c
 SHA512:
-  metadata.gz: b306fa0d89dcfe58209130baf00f0f051cb34c8c6a79ffdee50740f70e29dacf52b8b4d51e01aaa7a3cf0ab03e303c750a8a600a9efa9aa683a3bc32c506d20b
-  data.tar.gz: 43b9326709bf1f594bea7270155730139cd1d7e6d0bec99b3eb01f258e5be97987ca72ade4214f63fb0d9fc622be9cfa063c65f5a99ca3b8aba76ea14a959969
+  metadata.gz: c7a6f768eedd5365e0381162ebe5f40f3dda5ca70b5c7623dd7c5b1d3a99990181ffa27f75a73d41895cbb470b9d40db125885bc86463ff3585e4d845e85745c
+  data.tar.gz: acd0893e68b74525c66b8834df29d00f94c006b0845ec607f773015776612f5f2245432069087306bc0305a333e814bf6896dce44e8f1a9f8814e86c9fb0c34a

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+
+# 0.1.1
+
+* support Tanita::Api::Client.configure
+* wrote spec
+
 # 0.1.0
 
 * Initial release

data/Gemfile

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

data/Gemfile.lock

@@ -1,17 +1,23 @@
 PATH
   remote: .
   specs:
-    tanita-api-client (0.1.0)
+    tanita-api-client (0.1.1)
 
 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)
     rspec (3.9.0)
@@ -35,7 +41,12 @@ GEM
       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)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -46,6 +57,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop
   tanita-api-client!
+  webmock
 
 BUNDLED WITH
    2.1.3

data/README.md

@@ -1,7 +1,18 @@
 # Tanita::Api::Client
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tanita/api/client`. To experiment with that code, run `bin/console` for an interactive prompt.
 
+## About
+
+These client libraries are created for [Tanita Health Planet](https://www.healthplanet.jp/) APIs.
+
+refs: [Health Planet API Doc](https://www.healthplanet.jp/apis/api.html) (only Japanese)
+
+### Setup
+
+There are a few setup steps you need to complete before you can use this library:
+
+1. If you don't already have a Health Planet account, [sign up](https://www.healthplanet.jp/entry_agreement.do).
+2. If you have never created a developer application, read the [API Settings page](https://www.healthplanet.jp/apis_account.do) and be enable API.
 
 ## Installation
 
@@ -21,13 +32,76 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Usage OAuth Helper
 
-## Development
+The library needs to be configured with your account's OAuth settings which is available in your Health Planet Api Settings page.
+Set `client_id` `client_secret` `redirect_uri` `scopes` to its value:
+
+```ruby
+
+# OAuth configuration using configure method
+Tanita::Api::Client.configure do |config|
+  config.client_id = '<YOUR_CLIENT_ID>'
+  config.client_secret = '<YOUR_CLIENT_SECRET>'
+  config.redirect_uri = 'http://your-redirect-uri'
+  config.scopes = [Tanita::Api::Client::Scope::INNERSCAN]
+end
+auth_helper = Tanita::Api::Client::Auth.new
+
+# OAuth configuration using initializer
+auth_helper = Tanita::Api::Client::Auth.new(
+  client_id: '<YOUR_CLIENT_ID>',
+  client_secret: '<YOUR_CLIENT_SECRET>',
+  redirect_uri: 'http://your-redirect-uri',
+  scopes: Tanita::Api::Client::Scope.all
+)
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Below is the sample get an authentication url and exchange access token from an authentication code.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+# get Tanita 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"
+
+# get access token
+token = auth_helper.exchange_token(auth_code: '<AUTHENTICATION_CODE>')
+=> {:access_token=>"hoge_access_token", :expires_in=>12345678, :refresh_token=>"hoge_refresh_token"}
+```
+
+### Usage Apis Client
+
+The Api client needs access token.
+Set `access_token` to the value you got by above:
+
+```ruby
+# using configure
+Tanita::Api::Client.configure do |config|
+  config.access_token = '<YOUR_ACCESS_TOKEN>'
+end
+api = Tanita::Api::Client::Innerscan.new
+
+# using initializer
+api = Tanita::Api::Client::Innerscan.new(access_token: '<YOUR_ACCESS_TOKEN>')
+
+# fetch innerscan data
+result = api.status
+
+# you can specify a period using params(from:, to:)
+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
+```
 
 ## Contributing
 

data/lib/tanita/api/client.rb

@@ -2,19 +2,32 @@
 
 require 'tanita/api/client/base'
 require 'tanita/api/client/helpers'
+require 'tanita/api/client/configuration'
 require 'tanita/api/client/version'
 
 module Tanita
   module Api
     module Client
+      class << self
+        def configure
+          yield configuration
+        end
+
+        def configuration
+          @configuration ||= Tanita::Api::Client::Configuration.new
+        end
+      end
+
       class Auth
         include HttpHelper
 
-        def initialize(client_id:, client_secret:, redirect_uri:, scopes: [Scope::INNERSCAN])
-          @client_id = client_id
-          @client_secret = client_secret
-          @redirect_uri = redirect_uri
-          @scopes = scopes
+        def initialize(client_id: nil, client_secret: nil, redirect_uri: nil, scopes: nil)
+          config = Tanita::Api::Client.configuration
+          @client_id = client_id || config.client_id
+          @client_secret = client_secret || config.client_secret
+          @redirect_uri = redirect_uri || config.redirect_uri
+          @scopes = scopes || config.scopes
+          check_required_arguments
         end
 
         def auth_uri
@@ -42,6 +55,15 @@ module Tanita
 
           token
         end
+
+      private
+
+        def check_required_arguments
+          raise Error.new("param:'client_id' is required.'") if @client_id.nil?
+          raise Error.new("param:'client_secret' is required.'") if @client_secret.nil?
+          raise Error.new("param:'redirect_uri' is required.'") if @redirect_uri.nil?
+          raise Error.new("param:'scopes' is required.'") if @scopes.nil?
+        end
       end
 
       class Innerscan < BaseApiClient

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

@@ -10,6 +10,9 @@ module Tanita
         SPHYGMOMANOMETER = 'sphygmomanometer'
         PEDOMETER = 'pedometer'
         SMUG = 'smug'
+        def self.all
+          constants.map { |name| const_get(name) }
+        end
       end
 
       class Error < StandardError
@@ -21,16 +24,10 @@ module Tanita
         DATE_REGISTERD_AT = 0
         DATE_MEASURED_AT = 1
 
-        def initialize(access_token:)
-          @access_token = access_token
-        end
-
-        def endpoint
-          raise NotImplementedError
-        end
-
-        def measurement_tags
-          raise NotImplementedError
+        def initialize(access_token: nil)
+          config = Tanita::Api::Client.configuration
+          @access_token = access_token || config.access_token
+          raise Error.new("param:'access_token' is required.'") if @access_token.nil?
         end
 
         def status(
@@ -46,11 +43,18 @@ module Tanita
           }
           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)
         end
 
+        def endpoint
+          raise NotImplementedError
+        end
+
+        def measurement_tags
+          raise NotImplementedError
+        end
+
       private
 
         def time_format(time)
@@ -92,7 +96,7 @@ module Tanita
             data_dic[key][measurement] = value
           end
           # sort by date in ascending order
-          @data = data_dic.values { |dic| -dic[:date] }
+          @data = data_dic.values.sort_by { |dic| dic[:date] }
         end
       end
     end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Tanita
+  module Api
+    module Client
+      class Configuration
+        # [String]
+        attr_accessor :client_id
+
+        # [String]
+        attr_accessor :client_secret
+
+        # [String]
+        attr_accessor :redirect_uri
+
+        # [String]
+        attr_accessor :access_token
+
+        # [Array<Tanita::Api::Client::Scope>]
+        attr_accessor :scopes
+      end
+    end
+  end
+end

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

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

data/tanita-api-client.gemspec

@@ -15,7 +15,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"]}/CHANGELOG.md"
+  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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tanita-api-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kenji Koshikawa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-05 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,7 @@ files:
 - bin/setup
 - lib/tanita/api/client.rb
 - lib/tanita/api/client/base.rb
+- lib/tanita/api/client/configuration.rb
 - lib/tanita/api/client/helpers.rb
 - lib/tanita/api/client/version.rb
 - tanita-api-client.gemspec
@@ -85,7 +86,7 @@ licenses:
 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/CHANGELOG.md
+  changelog_uri: https://github.com/koshilife/tanita-api-ruby-client/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: