fitbyte 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6555eefc24b9e91cd915fb06bef4f000a181bb26
-  data.tar.gz: bbe409b11470d88855a748b55bff0ca9d8ef0d42
+  metadata.gz: 32ef68e0f19a55d7faf91fcaca68c7cb51c98ad1
+  data.tar.gz: 1d889dff0e1711e09963e7cb7d16e72d2a8b36b2
 SHA512:
-  metadata.gz: 620ec1e85812a5d9a10a2cf4fbbfc001707511d4e88ffede73e81275ad29ba21dcddf366637d6b320c5835919526d4e1e9e03dfd74ce3d0a031ca001be4d6451
-  data.tar.gz: 0477ab58a7ded7b9f1b13828710dadffdd8f68f9a09794837ccd483cde6d414bed421f59d31ea9da932b5275f89a3f6a2da53a89aa6520f7f297e7da652d2fc0
+  metadata.gz: 89c9338d9898e5f6c31eda652d0996c22fb04213cdb6bb7b9ec9f3696f1d99722a0de857fcb36876cc1e674fae4a082540ce093d97d018ae2e77872ab9326edd
+  data.tar.gz: 706c3c73f71bffd00e2f2a17646a2b1a33e30a8fbf1ee4f2c7e292e9d5d4d546d8d96dd4b12d738495b1c63ca476de98a724c329f674c65b91ff31d32a664b23

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.7.1
+-----
+- Rename `#auth_page_link` to `#auth_url`
+- Rename `snake_case` option to `snake_case_keys`
+- Code cleanup
+
 0.7.0
 -----
 - Add support for Activity and Heart Rate Intraday Time Series endpoints.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Zoran Pesic
+Copyright (c) 2017 Zoran Pesic
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -3,9 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/fitbyte.svg)](https://badge.fury.io/rb/fitbyte)
 [![Build Status](https://travis-ci.org/zokioki/fitbyte.svg?branch=master)](https://travis-ci.org/zokioki/fitbyte)
 
-Fitbyte allows interaction with [Fitbit's REST API](https://dev.fitbit.com/docs/basics/).
-
-It was started as a small personal project to provide a Ruby API interface using OAuth2, after Fitbit announced the eventual drop of OAuth1 support for the developer API.
+Fitbyte provides a Ruby interface to the [Fitbit Web API](https://dev.fitbit.com/reference/web-api/quickstart).
 
 ## Installation
 
@@ -16,7 +14,7 @@ To install the latest release:
 To include in a Rails project, add it to the Gemfile:
 
 ```ruby
-gem "fitbyte"
+gem 'fitbyte'
 ```
 
 ## Usage
@@ -32,15 +30,15 @@ Please reference the [fitbyte-rails repo](https://github.com/zokioki/fitbyte-rai
 - Create a client instance:
 
 ```ruby
-client = Fitbyte::Client.new(client_id: my_client_id,
-                             client_secret: my_client_secret,
-                             redirect_uri: "http://example.com/handle/callback")
+client = Fitbyte::Client.new(client_id: 'XXXXXX',
+                             client_secret: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
+                             redirect_uri: 'http://example.com/handle/callback')
 ```
 
 - Generate a link for the Fitbit authorization page:
 
 ```ruby
-client.auth_page_link
+client.auth_url
 # => https://fitbit.com/oauth2/authorize?client_id=123XYZ&redirect_uri=...
 ```
 
@@ -57,10 +55,10 @@ client.food_logs Date.today
 # => { "foods" => [{ "isFavorite" => true, "logDate" => "2015-06-26", "logId" => 1820, "loggedFood" => { "accessLevel" => "PUBLIC", "amount" => 132.57, "brand" => "", "calories" => 752, ...}] }
 ```
 
-To make the response more easily suited for attribute-assignment, it can be parsed to return a hash whose keys are in snake_case format. This can be done by setting the client's `snake_case` option to `true`, like so:
+To make the response more easily suited for attribute-assignment, it can be parsed to return a hash whose keys are in snake_case format. This can be done by setting the client's `snake_case_keys` option to `true`, like so:
 
 ```ruby
-client.snake_case = true
+client.snake_case_keys = true
 client.food_logs Date.today
 # => { "foods" => [{ "is_favorite" => true, "log_date" => "2015-06-26", "log_id" => 1820, "logged_food" => { "access_level" => "PUBLIC", "amount" => 132.57, "brand" => "", "calories" => 752, ...}] }
 ```
@@ -68,11 +66,11 @@ client.food_logs Date.today
 Similarly, all arguments passed in through a POST request are automatically converted to camelCase before they hit Fitbit's API, making it easy to keep your codebase stylistically consistent. For example, all of the following would result in valid API calls:
 
 ```ruby
-client.log_activity activity_id: 12345, duration_millis: "50000"
-client.log_activity activityId: 54321, durationMillis: "44100"
+client.log_activity activity_id: 12345, duration_millis: '50000'
+client.log_activity activityId: 54321, durationMillis: '44100'
 # If for some reason you had to mix snake and camel case like below,
 # Fitbyte would make sure the result is a validly formatted request
-client.log_activity activity_id: 12345, durationMillis: "683300"
+client.log_activity activity_id: 12345, durationMillis: '683300'
 ```
 
 ### Options
@@ -87,7 +85,7 @@ When initializing a `Fitbyte::Client` instance, you're given access to a handful
 
 - `:scope` - A space-delimited list of the permissions you are requesting (default: "activity nutrition profile settings sleep social weight heartrate" | available: "activity", "heartrate", "location", "nutrition", "profile", "settings" "sleep", "social" and "weight")
 
-- `:snake_case` - Transform returned object's keys to snake case format (default: false)
+- `:snake_case_keys` - Transform returned object's keys to snake case format (default: false)
 
 - `:symbolize_keys` - Transform returned object's keys to symbols (default: false)
 

data/fitbyte.gemspec

@@ -4,25 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fitbyte/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fitbyte"
+  spec.name          = 'fitbyte'
   spec.version       = Fitbyte::VERSION
-  spec.authors       = ["Zoran Pesic"]
-  spec.email         = ["zoran1991@gmail.com"]
+  spec.authors       = ['Zoran']
 
-  spec.summary       = %q{A Ruby interface to the Fitbit API, using OAuth2.}
+  spec.summary       = %q{A Ruby interface to the Fitbit API, using OAuth2 (renamed to fitbit_api)}
   spec.homepage      = Fitbyte::REPO_URL
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  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.required_ruby_version = ">= 1.9.3"
+  spec.required_ruby_version = '>= 1.9.3'
 
-  spec.add_runtime_dependency     "oauth2", "~> 1.0"
+  spec.add_runtime_dependency     'oauth2', '~> 1.0'
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+
+  spec.post_install_message = %q{
+    The fitbyte gem has been renamed to fitbit_api and will no longer be supported.
+    Please switch to using fitbit_api for all versions greater than 0.7.1.
+  }
 end

data/lib/fitbyte.rb

@@ -1,6 +1,6 @@
-require "oauth2"
-require "date"
-require "fitbyte/version"
-require "fitbyte/client"
+require 'oauth2'
+require 'date'
+require 'fitbyte/version'
+require 'fitbyte/client'
 
 module Fitbyte; end

data/lib/fitbyte/activities.rb

@@ -42,7 +42,7 @@ module Fitbyte
     #   the activities catalog as well as private custom activities the user created.
 
     def all_activities(opts={})
-      get("activities.json", opts)
+      get('activities.json', opts)
     end
 
     # Retrieves a list of a user's activity log entries before or after a given day with
@@ -85,7 +85,7 @@ module Fitbyte
       end
 
       if [start_date, period].none?
-        raise Fitbyte::InvalidArgumentError, "A start_date or period is required."
+        raise Fitbyte::InvalidArgumentError, 'A start_date or period is required.'
       end
 
       if period && !PERIODS.include?(period)
@@ -112,7 +112,7 @@ module Fitbyte
       end
 
       if [date, detail_level].any?(&:nil?)
-        raise Fitbyte::InvalidArgumentError, "A date and detail_level are required."
+        raise Fitbyte::InvalidArgumentError, 'A date and detail_level are required.'
       end
 
       unless %(1min 15min).include? detail_level
@@ -120,7 +120,7 @@ module Fitbyte
       end
 
       if (start_time || end_time) && !(start_time && end_time)
-        raise Fitbyte::InvalidArgumentError, "Both start_time and end_time are required if time is being specified."
+        raise Fitbyte::InvalidArgumentError, 'Both start_time and end_time are required if time is being specified.'
       end
 
       if (start_time && end_time)

data/lib/fitbyte/base.rb

@@ -1,6 +1,6 @@
-require "fitbyte/helpers/configuration"
-require "fitbyte/helpers/utils"
-require "fitbyte/helpers/exceptions"
+require 'fitbyte/helpers/configuration'
+require 'fitbyte/helpers/utils'
+require 'fitbyte/helpers/exceptions'
 
 module Fitbyte
   extend Configuration
@@ -9,16 +9,16 @@ module Fitbyte
   define_setting :client_secret
   define_setting :redirect_uri
 
-  define_setting :site_url,       "https://api.fitbit.com"
-  define_setting :authorize_url,  "https://www.fitbit.com/oauth2/authorize"
-  define_setting :token_url,      "https://api.fitbit.com/oauth2/token"
+  define_setting :site_url,        'https://api.fitbit.com'
+  define_setting :authorize_url,   'https://www.fitbit.com/oauth2/authorize'
+  define_setting :token_url,       'https://api.fitbit.com/oauth2/token'
 
-  define_setting :unit_system,    "en_US"
-  define_setting :locale,         "en_US"
-  define_setting :scope,          "activity nutrition profile settings sleep social weight heartrate"
+  define_setting :unit_system,     'en_US'
+  define_setting :locale,          'en_US'
+  define_setting :scope,           'activity nutrition profile settings sleep social weight heartrate'
 
-  define_setting :api_version,    "1"
+  define_setting :api_version,     '1'
 
-  define_setting :snake_case,     false
-  define_setting :symbolize_keys, false
+  define_setting :snake_case_keys, false
+  define_setting :symbolize_keys,  false
 end

data/lib/fitbyte/body.rb

@@ -20,7 +20,7 @@ module Fitbyte
       end
 
       if [period, start_date].none?
-        raise Fitbyte::InvalidArgumentError, "A start_date or period is required."
+        raise Fitbyte::InvalidArgumentError, 'A start_date or period is required.'
       end
 
       if period && !PERIODS.include?(period)

data/lib/fitbyte/client.rb

@@ -1,19 +1,19 @@
-require "fitbyte/base"
-require "fitbyte/activities"
-require "fitbyte/heart_rate"
-require "fitbyte/goals"
-require "fitbyte/alarms"
-require "fitbyte/body"
-require "fitbyte/devices"
-require "fitbyte/food"
-require "fitbyte/friends"
-require "fitbyte/sleep"
-require "fitbyte/user"
-require "fitbyte/water"
+require 'fitbyte/base'
+require 'fitbyte/activities'
+require 'fitbyte/heart_rate'
+require 'fitbyte/goals'
+require 'fitbyte/alarms'
+require 'fitbyte/body'
+require 'fitbyte/devices'
+require 'fitbyte/food'
+require 'fitbyte/friends'
+require 'fitbyte/sleep'
+require 'fitbyte/user'
+require 'fitbyte/water'
 
 module Fitbyte
   class Client
-    attr_accessor :api_version, :unit_system, :locale, :scope, :snake_case, :symbolize_keys
+    attr_accessor :api_version, :unit_system, :locale, :scope, :snake_case_keys, :symbolize_keys
     attr_reader   :user_id
 
     def initialize(opts)
@@ -21,7 +21,7 @@ module Fitbyte
       raise Fitbyte::InvalidArgumentError, "Required arguments: #{missing_args.join(', ')}" if missing_args.size > 0
 
       %w(client_id client_secret redirect_uri site_url authorize_url token_url
-      unit_system locale scope api_version snake_case symbolize_keys).each do |attr|
+      unit_system locale scope api_version snake_case_keys symbolize_keys).each do |attr|
         instance_variable_set("@#{attr}", (opts[attr.to_sym] || Fitbyte.send(attr)))
       end
 
@@ -31,19 +31,19 @@ module Fitbyte
       restore_token(opts[:refresh_token]) if opts[:refresh_token]
     end
 
-    def auth_page_link
+    def auth_url
       @client.auth_code.authorize_url(redirect_uri: @redirect_uri, scope: @scope)
     end
 
     def get_token(auth_code)
       @token = @client.auth_code.get_token(auth_code, redirect_uri: @redirect_uri, headers: auth_header)
-      @user_id = @token.params["user_id"]
+      @user_id = @token.params['user_id']
       return @token
     end
 
     def restore_token(refresh_token)
       @token = OAuth2::AccessToken.from_hash(@client, refresh_token: refresh_token).refresh!(headers: auth_header)
-      @user_id = @token.params["user_id"]
+      @user_id = @token.params['user_id']
       return @token
     end
 
@@ -56,14 +56,14 @@ module Fitbyte
     end
 
     def auth_header
-      {"Authorization" => ("Basic " + Base64.encode64(@client_id + ":" + @client_secret))}
+      { 'Authorization' => ('Basic ' + Base64.encode64(@client_id + ':' + @client_secret)) }
     end
 
     def request_headers
       {
-        "User-Agent" => "fitbyte-#{Fitbyte::VERSION} gem (#{Fitbyte::REPO_URL})",
-        "Accept-Language" => @unit_system,
-        "Accept-Locale" => @locale
+        'User-Agent' => "fitbyte-#{Fitbyte::VERSION} gem (#{Fitbyte::REPO_URL})",
+        'Accept-Language' => @unit_system,
+        'Accept-Locale' => @locale
       }
     end
 
@@ -86,7 +86,7 @@ module Fitbyte
     end
 
     def process_keys!(object, opts={})
-      deep_keys_to_snake_case!(object) if (opts[:snake_case] || snake_case)
+      deep_keys_to_snake_case!(object) if (opts[:snake_case_keys] || snake_case_keys)
       deep_symbolize_keys!(object) if (opts[:symbolize_keys] || symbolize_keys)
       return object
     end

data/lib/fitbyte/food.rb

@@ -32,7 +32,7 @@ module Fitbyte
       end
 
       if [period, start_date].none?
-        raise Fitbyte::InvalidArgumentError, "A start_date or period is required."
+        raise Fitbyte::InvalidArgumentError, 'A start_date or period is required.'
       end
 
       if period && !PERIODS.include?(period)

data/lib/fitbyte/heart_rate.rb

@@ -6,7 +6,7 @@ module Fitbyte
       period     = opts[:period]
 
       if [period, start_date].none?
-        raise Fitbyte::InvalidArgumentError, "A start_date or period is required."
+        raise Fitbyte::InvalidArgumentError, 'A start_date or period is required.'
       end
 
       if period && !PERIODS.include?(period)
@@ -29,7 +29,7 @@ module Fitbyte
       end_time     = opts[:end_time]
 
       if [date, detail_level].any?(&:nil?)
-        raise Fitbyte::InvalidArgumentError, "A date and detail_level are required."
+        raise Fitbyte::InvalidArgumentError, 'A date and detail_level are required.'
       end
 
       unless %(1sec 1min).include? detail_level
@@ -37,7 +37,7 @@ module Fitbyte
       end
 
       if (start_time || end_time) && !(start_time && end_time)
-        raise Fitbyte::InvalidArgumentError, "Both start_time and end_time are required if time is being specified."
+        raise Fitbyte::InvalidArgumentError, 'Both start_time and end_time are required if time is being specified.'
       end
 
       if (start_time && end_time)

data/lib/fitbyte/helpers/utils.rb

@@ -19,7 +19,7 @@ module Fitbyte
 
     def format_time(time)
       if [Time, DateTime].include?(time.class)
-        time.strftime("%H:%M")
+        time.strftime('%H:%M')
       elsif time.is_a? String
         if time =~ /\d{2}\:\d{2}/
           time
@@ -32,7 +32,7 @@ module Fitbyte
     end
 
     def format_scope(scope)
-      scope.is_a?(Array) ? scope.join(" ") : scope
+      scope.is_a?(Array) ? scope.join(' ') : scope
     end
 
     def deep_keys_to_snake_case!(object)
@@ -68,14 +68,14 @@ module Fitbyte
       return string.downcase if string.match(/\A[A-Z]+\z/)
       string.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
       string.gsub!(/([a-z])([A-Z])/, '\1_\2')
-      string.gsub!("-", "_") if opts[:replace_dashes]
+      string.gsub!('-', '_') if opts[:replace_dashes]
       string.downcase
     end
 
     def to_camel_case(word, opts={})
       string = word.to_s
       return string if string.match(/[A-Z]|[a-z]([A-Z0-9]*[a-z][a-z0-9]*[A-Z]|[a-z0-9]*[A-Z][A-Z0-9]*[a-z])[A-Za-z0-9]*/)
-      string = word.to_s.split("_").collect(&:capitalize).join
+      string = word.to_s.split('_').collect(&:capitalize).join
       string.gsub!(/^\w{1}/) { |word| word.downcase } if opts[:lower]
       return string
     end

data/lib/fitbyte/sleep.rb

@@ -17,7 +17,7 @@ module Fitbyte
       end
 
       if [period, start_date].none?
-        raise Fitbyte::InvalidArgumentError, "A start_date or period is required."
+        raise Fitbyte::InvalidArgumentError, 'A start_date or period is required.'
       end
 
       if period && !PERIODS.include?(period)

data/lib/fitbyte/version.rb

@@ -1,4 +1,4 @@
 module Fitbyte
-  VERSION = "0.7.0"
-  REPO_URL = "https://github.com/zokioki/fitbyte"
+  VERSION = '0.7.1'
+  REPO_URL = 'https://github.com/zokioki/fitbyte'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbyte
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
-- Zoran Pesic
+- Zoran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-01 00:00:00.000000000 Z
+date: 2017-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -67,8 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: 
-email:
-- zoran1991@gmail.com
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -104,7 +103,9 @@ homepage: https://github.com/zokioki/fitbyte
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "\n    The fitbyte gem has been renamed to fitbit_api and will
+  no longer be supported.\n    Please switch to using fitbit_api for all versions
+  greater than 0.7.1.\n  "
 rdoc_options: []
 require_paths:
 - lib
@@ -120,8 +121,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: A Ruby interface to the Fitbit API, using OAuth2.
+summary: A Ruby interface to the Fitbit API, using OAuth2 (renamed to fitbit_api)
 test_files: []