fitbit_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d472e8616f43677a3a28ac7137c7d60a8280721
+  data.tar.gz: 382b88f98061745a339f780cf99d4deb7b33bd41
+SHA512:
+  metadata.gz: 726befa5d90d4248eaedd89ca4136cc8b3a6a598d1471b04b36ae653546ddfbc44ef5a6b1beac7f8a5fd6393c17fc4a4ec3f55412a8a591a2692c7f0ad7796e0
+  data.tar.gz: 7df1adce571fbef32179594713fa3f2f5ad4819a43b82caf0519dac9a81540c1bc5c482cc4d10da74e298fa34483f94d576b71aeb4f6ce7c0bea6afb9aa253af

data/.gitignore

@@ -0,0 +1,22 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Jetbrains files
+/.idea
+
+# OSX Files
+.DS_Store
+
+# Emacs Files
+\#*\#
+*\~
+
+# Gem files
+*.gem

data/.rubocop.yml

@@ -0,0 +1,24 @@
+inherit_from: .rubocop_todo.yml
+AllCops:
+  TargetRubyVersion: 2.3
+
+Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: true
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"

data/.rubocop_todo.yml

@@ -0,0 +1,13 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-06-29 16:54:15 -0500 using RuboCop version 0.49.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 21
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 165

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+addons:
+  code_climate:
+    repo_token: 2ec48f0cac9211d2249786883fd446ecf446c9682ffff4de0345609539ff701e
+rvm:
+  - 2.4.0
+  - 2.3.3
+  - 2.3.1
+after_success:
+  - bundle exec codeclimate-test-reporter

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at michel.ocon@unosquare.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fitbit_client.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Michel Ocon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# FitbitClient
+
+[![Build Status](https://travis-ci.org/sounxrt/fitbit_client.svg?branch=master)](https://travis-ci.org/sounxrt/fitbit_client) [![Code Climate](https://codeclimate.com/github/sounxrt/fitbit_client/badges/gpa.svg)](https://codeclimate.com/github/sounxrt/fitbit_client) [![Test Coverage](https://codeclimate.com/github/sounxrt/fitbit_client/badges/coverage.svg)](https://codeclimate.com/github/sounxrt/fitbit_client/coverage)
+
+Provides access to the Fitbit API using OAuth2
+
+- The version of the API for most endpoints is the 1, and 1.2 for the ones were was available.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fitbit_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fitbit_client
+
+## Usage
+
+To create an instance of the Client
+```
+client = FitbitClient::Client.new(access_token, refresh_token, { client_id: 'fitbit_app_client_id', client_secret: 'fitbit_app_client_secret' })
+```
+
+**Note:** `access_token` and `refresh_token` must come from a valid OAuth2 session. 
+
+### Rails
+
+You can add an initializer to set the client_id and client_secret configuration values:
+
+```
+FitbitClient.configure do |config|
+  config.client_id = ENV['FITBIT_CLIENT_ID']
+  config.client_secret = ENV['FITBIT_CLIENT_SECRET']
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sounxrt/fitbit_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
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FitbitClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fitbit_client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'fitbit_client'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fitbit_client.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fitbit_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fitbit_client'
+  spec.version       = FitbitClient::VERSION
+  spec.authors       = ['Michel Ocon']
+  spec.email         = ['soun.xrt@gmail.com']
+  spec.summary       = 'Connects to Fibit API using OAuth2'
+  spec.description   = 'Client library which connects to the Fibit API using OAuth2 protocol.'
+  spec.homepage      = 'https://github.com/sounxrt/fitbit_client'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 2.3'
+
+  spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0', '>= 1.0.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'simplecov', '~> 0.13.0'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+
+  spec.add_dependency('oauth2', '~> 1.4', '>= 1.4.0')
+end

data/lib/fitbit_client.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'fitbit_client/version'
+require 'fitbit_client/error'
+require 'fitbit_client/util'
+require 'fitbit_client/network/request'
+
+# Resources
+require 'fitbit_client/resources/common'
+require 'fitbit_client/resources/activity'
+require 'fitbit_client/resources/body_and_weight'
+require 'fitbit_client/resources/devices'
+require 'fitbit_client/resources/sleep'
+require 'fitbit_client/resources/subscription'
+require 'fitbit_client/resources'
+
+# The main client
+require 'fitbit_client/client'
+require 'fitbit_client/authorization_grant_flow'
+
+# The authorization grant flow
+module FitbitClient
+  OAUTH2_CLIENT_OPTIONS = { site: 'https://api.fitbit.com',
+                            token_url: 'https://api.fitbit.com/oauth2/token',
+                            authorize_url: 'https://www.fitbit.com/oauth2/authorize',
+                            auth_scheme: :basic_auth }.freeze
+
+  VALID_SCOPES = %w(activity heartrate location nutrition profile settings sleep social weight).freeze
+  VALID_SUBSCRIPTIONS = %i(activities body foods sleep).freeze
+
+  @default_locale = 'en_US'
+  @default_language = 'en_US'
+
+  class << self
+    attr_accessor :client_id, :client_secret
+    attr_accessor :default_language, :default_locale
+  end
+
+  def self.configure
+    yield self
+  end
+end

data/lib/fitbit_client/authorization_grant_flow.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FitbitClient
+  class AuthorizationGrantFlow
+    attr_reader :client_id, :client_secret
+
+    def initialize(options = {})
+      @client_id = options.fetch(:client_id, FitbitClient.client_id)
+      @client_secret = options.fetch(:client_secret, FitbitClient.client_secret)
+    end
+
+    def get_token(code, redirect_url)
+      oauth2_client.get_token(grant_type: 'authorization_code', code: code, redirect_uri: redirect_url)
+    end
+
+    def oauth2_client
+      @oauth2_client ||= OAuth2::Client.new(client_id, client_secret, OAUTH2_CLIENT_OPTIONS)
+    end
+
+    def client_identification_uri(redirect_url, scopes)
+      params = URI.encode("?response_type=code&client_id=#{FitbitClient.client_id}&scope=#{scopes}")
+      "#{FitbitClient::OAUTH2_CLIENT_OPTIONS[:authorize_url]}/#{params}&redirect_uri=#{redirect_uri_param(redirect_url)}"
+    end
+
+    private
+
+    def redirect_uri_param(redirect_url)
+      URI.encode_www_form_component(redirect_url).to_s
+    end
+  end
+end

data/lib/fitbit_client/client.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'oauth2'
+
+module FitbitClient
+  class Client
+    include FitbitClient::Resources
+
+    attr_writer :refresh_token_callback
+    attr_reader :client_id, :client_secret, :access_token, :refresh_token
+
+    def initialize(access_token, refresh_token, options = {})
+      @access_token = access_token
+      @refresh_token = refresh_token
+      @client_id = options.fetch(:client_id, FitbitClient.client_id)
+      @client_secret = options.fetch(:client_secret, FitbitClient.client_secret)
+      raise ArgumentError, 'FitbitClient::Client cannot operate without a client_id and client_secret values' if empty_str?(@client_id) || empty_str?(@client_secret)
+    end
+
+    def debug_mode!(enable)
+      if enable
+        @original_oauth_debug = ENV['OAUTH_DEBUG']
+        ENV['OAUTH_DEBUG'] = 'true'
+      elsif @original_oauth_debug
+        ENV['OAUTH_DEBUG'] = @original_oauth_debug
+      end
+    end
+
+    # Force a refresh token
+    def refresh_token!
+      oauth2_refresh_token!
+    end
+
+    # When a new refresh token is received this method will be called with the
+    # OAuth2::AccessToken instance as argument
+    def refresh_token_callback!(oauth2_token)
+      @access_token = oauth2_token.token
+      @refresh_token = oauth2_token.refresh_token
+      @refresh_token_callback&.call(oauth2_token)
+    end
+  end
+end