oura 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cf18722f90faf6d2b0d1acce65578d0dbb30010b6f988ff653c49aa71966c68
-  data.tar.gz: 2b77f9ee865df714c3873ddca410034cc2c7dfea4fe40d962ac44b858c2bfa7a
+  metadata.gz: 2845af3c9e89fbd8e210bbeb5445c34dc7e925564ce9b9ab170010a7b1e2db72
+  data.tar.gz: 1828efd8469eee2115025fb3a34beb60517167bc617a9e28862336cb1017fa04
 SHA512:
-  metadata.gz: 722dd141536d78da2ca46dbcc4a9eab3621dbc78d679fce15f96c15568cb9c4e51020c652978f43801c9e93462fea3e81cf76c51426cb0255c53cf78ab439081
-  data.tar.gz: 562ef9f29cfa19282696c4f12583542043d6533589edcc93cb8529a12bf6de5ac16e4f56e69bcbdbb4c98b0f02f71a120681ff2d4d235645038ac19fbac03a31
+  metadata.gz: 218f859ab28ecb3576267bcb5cebb896fe4f1d8ca8e7f91b32beb31142b1bdef16191510e1a9698ae50c25d11bdf424dea541e0a061651db7ac827e6428f6d3e
+  data.tar.gz: f37c6d6bc9275bcdb86e8dc00986c35c2ebfce1957f13c171ccf8dc406e2ca163630e4ba318faf35dc122aac07ca57795142c977c0744cd055198c46d2af3da7

data/.rubocop.yml

@@ -19,3 +19,6 @@ Metrics/LineLength:
 
 Metrics/MethodLength:
   Max: 15
+
+RSpec/MultipleExpectations:
+  Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 Change Log
 ===
 
+## v0.1.2
+
+- Capsulize ( Add apis module )
+
 ## v0.1.1
 
 - development mode

data/README.md

@@ -29,7 +29,7 @@ Or install it yourself as:
 
 ```irb
 $ DEVELOPMENT=true bundle console
-$ client = Oura::Client.new(access_token: your_token)
+$ client = ::Oura::Client.new(access_token: your_token)
 $ # <input your code>
 $ response = client.user_info # or sleep_period, activity, readiness
 $ response.body
@@ -38,12 +38,27 @@ $ => "{\"weight\": 50, \"age\": 22, \"gender\": \"male\", \"email\": \"oura@exam
 
 ### not in develop-mode
 
+#### Set Environment
+
+|Environment|Explanation|
+|:---:|:---:|
+| `OURA_CLIENT_ID` | client id |
+| `OURA_CLEINT_SECRET` | client secret |
+| `AUTHORIZE_HEADER_CODE` | authrize header code |
+| `OURA_CALLBACK_URI` | callback uri |
+
+
 ```bash
 $ bundle console
-$ > client = Oura::Client.new(access_token: <your token>)
+$ > client = ::Oura::Client.new(access_token: <your token>)
 $ > client.user_info # or sleep_period, activity, readiness
 ```
 
+## References
+
+- [Official Site](https://ouraring.com/)
+- [API Document](https://cloud.ouraring.com/docs/)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. 

data/lib/oura.rb

@@ -3,6 +3,8 @@
 require 'oura/version'
 require 'oura/constants'
 require 'oura/client'
+require 'active_support'
+require 'active_support/core_ext'
 
 module Oura
   class Error < StandardError; end

data/lib/oura/apis/activity.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'oura/utils/api'
+
+module Oura
+  module Apis
+    # Activity summary contains daily activity summary values and detailed activity levels.
+    module Activity
+      include ::Oura::Api
+
+      REQUEST_PATH = '/v1/activity'
+
+      # @param [Date] start_date
+      # @param [Date] end_date
+      # @example
+      # {
+      #   "activity": [{"summary_date": "2016-10-11", ...}, {"summary_date": "2016-10-12", ...}, ...]
+      # }
+      # @return [OAuth2::Response]
+      def activity(start_date:, end_date:)
+        sdate, edate = [start_date, end_date].map { |date| transform_date(date) }
+        get(REQUEST_PATH, params: { start: sdate, end: edate })
+      end
+    end
+  end
+end

data/lib/oura/apis/readiness.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'oura/utils/api'
+
+module Oura
+  module Apis
+    # Readiness tells how ready you are for the day.
+    # example data
+    # {
+    #     "readiness": {
+    #         "summary_date": "2016-09-03",
+    #         "period_id": 0,
+    #         "score": 62,
+    #         "score_previous_night": 5,
+    #         "score_sleep_balance": 75,
+    #         "score_previous_day": 61,
+    #         "score_activity_balance": 77,
+    #         "score_resting_hr": 98,
+    #         "score_recovery_index": 45,
+    #         "score_temperature": 86
+    #     }
+    # }
+    module Readiness
+      include ::Oura::Api
+
+      REQUEST_PATH = '/v1/readiness'
+
+      # @param [Date] start_date
+      # @param [Date] end_date
+      # @example
+      # {
+      #   "readiness": [{"summary_date": "2016-10-11", ...}, {"summary_date": "2016-10-12", ...}, ...]
+      # }
+      # @return [OAuth2::Response]
+      def readiness(start_date:, end_date:)
+        sdate, edate = [start_date, end_date].map { |date| transform_date(date) }
+        get(REQUEST_PATH, params: { start: sdate, end: edate })
+      end
+    end
+  end
+end

data/lib/oura/apis/sleep_period.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'oura/utils/api'
+
+module Oura
+  module Apis
+    # SleepPeriod is a nearly continuous, longish period of time spent lying down in bed.
+    module SleepPeriod
+      include ::Oura::Api
+
+      REQUEST_PATH = '/v1/sleep'
+
+      # @param [Date] start_date
+      # @param [Date] end_date
+      # example response
+      # {
+      #   "sleep": [{"summary_date": "2016-10-11", ...}, {"summary_date": "2016-10-12", ...}, ...]
+      # }
+      # @return [OAuth2::Response]
+      def sleep_period(start_date:, end_date:)
+        sdate, edate = [start_date, end_date].map { |date| transform_date(date) }
+        get(REQUEST_PATH, params: { start: sdate, end: edate })
+      end
+    end
+  end
+end

data/lib/oura/apis/user_information.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'oura/utils/api'
+
+module Oura
+  module Apis
+    # UserInformation is user information.
+    module UserInformation
+      include ::Oura::Api
+
+      REQUEST_PATH = '/v1/userinfo'
+      # @example
+      # {
+      #   "age": 27,
+      #   "weight": 80,
+      #   "gender": "male",
+      #   "email": "john.doe@the.domain"
+      # }
+      # @return [OAuth2::Response]
+      def userinfo
+        get(REQUEST_PATH)
+      end
+    end
+  end
+end

data/lib/oura/client.rb

@@ -1,20 +1,29 @@
 # frozen_string_literal: true
 
 require 'oauth2'
+require 'oura/apis/user_information'
+require 'oura/apis/activity'
+require 'oura/apis/sleep_period'
+require 'oura/apis/readiness'
+
 module Oura
-  # Oura::Client is client class.
+  # ::Oura::Client is client class.
   class Client
+    include ::Oura::Apis::UserInformation
+    include ::Oura::Apis::SleepPeriod
+    include ::Oura::Apis::Activity
+    include ::Oura::Apis::Readiness
+
     attr_reader :access_token, :oauth_client
 
+    # @param [String] access_token
+    # @return [Object<Oura::Client>]
     def initialize(access_token: nil)
       @oauth_client = OAuth2::Client.new(
-        ENV['OURA_CLIENT_ID'],
-        ENV['OURA_CLIENT_SECRET'],
-        Oura::Constants::OAUTH_OPTIONS
+        ENV['OURA_CLIENT_ID'], ENV['OURA_CLIENT_SECRET'], ::Oura::Constants::OAUTH_OPTIONS
       )
-
       @access_token = if ENV['DEVELOPMENT']
-                        puts @oauth_client.auth_code.authorize_url(redirect_uri: ::Oura::Constants::CALLBACK_URL)
+                        puts @oauth_client.auth_code.authorize_url(redirect_uri: ::Oura::Constants::CALLBACK_URI)
                         puts 'Please, input your secret'
                         code = gets.chomp
                         token(code)
@@ -25,28 +34,16 @@ module Oura
                       end
     end
 
+    private
+
+    # @param [String] code
+    # @return [OAuth2::AccessToken]
     def token(code)
       @oauth_client.auth_code.get_token(
         code,
-        redirect_uri: ::Oura::Constants::CALLBACK_URL,
+        redirect_uri: ::Oura::Constants::CALLBACK_URI,
         headers: { 'Authorization' => "Bearer #{ENV['AUTHORIZE_HEADER_CODE']}" }
       )
     end
-
-    def user_info
-      @access_token.get('/v1/userinfo')
-    end
-
-    def sleep_period(start_date:, end_date:)
-      @access_token.get('/v1/sleep', params: { start: start_date.to_s, end: end_date.to_s })
-    end
-
-    def activity(start_date:, end_date:)
-      @access_token.get('/v1/activity', params: { start: start_date.to_s, end: end_date.to_s })
-    end
-
-    def readiness(start_date:, end_date:)
-      @access_token.get('/v1/readiness', params: { start: start_date.to_s, end: end_date.to_s })
-    end
   end
 end

data/lib/oura/constants.rb

@@ -4,7 +4,7 @@ module Oura
   module Constants
     API_ENDPOINT = 'https://api.ouraring.com'
     OAUTH_ENDPOINT = 'https://cloud.ouraring.com'
-    CALLBACK_URL = ENV['CALLBACK_URL'] || 'http://localhost:8080/oauth2/callback'
+    CALLBACK_URI = ENV['OURA_CALLBACK_URI'] || 'http://localhost:8080/oauth2/callback'
     OAUTH_OPTIONS = {
       authorize_url: "#{OAUTH_ENDPOINT}/oauth/authorize",
       token_url: "#{API_ENDPOINT}/oauth/token",

data/lib/oura/model/base.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Oura
+  class Base
+    # TODO: Implementation
+  end
+end

data/lib/oura/utils/api.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Oura
+  # ::Oura::Api is utility api module.
+  module Api
+    private
+
+    # @param [<String>] date
+    # @param [<Date>] date
+    # @return [String] date string
+    def transform_date(date)
+      return Date.parse(date).strftime('%Y-%m-%d') if date.is_a?(String)
+      return date.strftime('%Y-%m-%d') if date.is_a?(Date)
+
+      raise ArgumentError, 'invalid date'
+    end
+
+    # @param [String] path
+    # @param [Hash] params
+    # @return [OAuth2::Response]
+    def get(path, params = {})
+      @access_token.get(path, params)
+    end
+  end
+end

data/lib/oura/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Oura
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/oura.gemspec

@@ -6,7 +6,7 @@ require 'oura/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'oura'
-  spec.version       = Oura::VERSION
+  spec.version       = ::Oura::VERSION
   spec.authors       = ['Ryota Ikezawa']
   spec.email         = ['pavegy@gmail.com']
 
@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'oauth2'
+  spec.add_development_dependency 'activesupport'
   spec.add_development_dependency 'bundler', '~> 1.17'
   spec.add_development_dependency 'codecov'
   spec.add_development_dependency 'danger'
@@ -39,4 +40,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oura
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ryota Ikezawa
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +234,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: unofficial API client of oura-cloud for ruby.
 email:
 - pavegy@gmail.com
@@ -242,8 +284,14 @@ files:
 - bin/console
 - bin/setup
 - lib/oura.rb
+- lib/oura/apis/activity.rb
+- lib/oura/apis/readiness.rb
+- lib/oura/apis/sleep_period.rb
+- lib/oura/apis/user_information.rb
 - lib/oura/client.rb
 - lib/oura/constants.rb
+- lib/oura/model/base.rb
+- lib/oura/utils/api.rb
 - lib/oura/version.rb
 - oura.gemspec
 homepage: https://github.com/paveg/oura