strava-ruby-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd3998f1cfc79f2b07fc5ef6b9d25f8717e411c7d6a9066d6eb9e77154ea4cd1
+  data.tar.gz: 82adf5a179351b1d3b410c72710d5ce945bf5f303398e5c21e482b34ce294d95
+SHA512:
+  metadata.gz: 05fe3b3d099ca87559a99d45b33c160a3cf378a094181b462d5a33e43dd871e451e91eba8ce3b119759206865185f28e51a24bed6be77729fc12e2d886132e1c
+  data.tar.gz: bb2b409a5e9d0f1b762f230959721c0efb23e2cfdded64a25df02a618b6f8083134854905d0a728e2f004d01ad3324c82749c75bd8c5082a2c520595afb9c672

data/.gitignore

@@ -0,0 +1,6 @@
+.env
+pkg
+Gemfile.lock
+.DS_Store
+.bundle
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+
+Naming/MethodName:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - 'lib/strava-ruby-client.rb'
+
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,47 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-11-23 11:26:24 -0500 using RuboCop version 0.60.0.
+# 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: 1
+Metrics/AbcSize:
+  Max: 30
+
+# Offense count: 7
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 127
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 18
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/strava/logger.rb'
+
+# Offense count: 19
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 25
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 112

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.5.1
+
+before_script:
+  - bundle exec danger

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0 (2018/11/23)
+
+* Initial public release, OAuth, current Athlete and Athlete Activities - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to Strava-Ruby-Client
+
+This project is work of [many contributors](https://github.com/dblock/strava-ruby-client/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/dblock/strava-ruby-client/pulls), [propose features and discuss issues](https://github.com/dblock/strava-ruby-client/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+### Fork the Project
+
+Fork the [project on Github](https://github.com/dblock/strava-ruby-client) and check out your copy.
+
+```
+git clone https://github.com/contributor/strava-ruby-client.git
+cd strava-ruby-client
+git remote add upstream https://github.com/dblock/strava-ruby-client.git
+```
+
+### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Contribute Code
+
+### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add tests to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
+
+Make sure that `bundle exec rake` completes without errors.
+
+### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Don't remove *Your contribution here*.
+
+Make it look like every other line, including a link to the issue being fixed, your name and link to your Github account.
+
+### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+### Push
+
+```
+git push origin my-feature-branch
+```
+
+### Make a Pull Request
+
+Go to https://github.com/contributor/strava-ruby-client and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/strava-ruby-client/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Dangerfile

@@ -0,0 +1,2 @@
+toc.check
+changelog.check

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'danger-changelog', '~> 0.3.0'
+  gem 'danger-toc', '~> 0.1'
+  gem 'dotenv'
+  gem 'pry'
+  gem 'rake', '~> 10'
+  gem 'rspec'
+  gem 'rubocop', '0.60.0'
+  gem 'vcr'
+  gem 'webmock'
+end

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2018 Daniel Doubrovkine and Contributors
+
+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,231 @@
+Strava Ruby Client
+==================
+
+[![Gem Version](https://badge.fury.io/rb/strava-ruby-client.svg)](https://badge.fury.io/rb/strava-ruby-client)
+[![Build Status](https://travis-ci.org/dblock/strava-ruby-client.svg?branch=master)](https://travis-ci.org/dblock/strava-ruby-client)
+
+A newer Ruby client for the [Strava API v3](https://developers.strava.com).
+
+Unlike [strava-api-v3](https://github.com/jaredholdcroft/strava-api-v3) provides a first class interface to Strava models and more consistent error handling.
+
+# Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [API](#api)
+    - [Athlete](#athlete)
+    - [Athlete Activities](#athlete-activities)
+  - [OAuth](#oauth)
+- [Configuration](#configuration)
+  - [Web Client Options](#web-client-options)
+  - [API Client Options](#api-client-options)
+  - [OAuth Client Options](#oauth-client-options)
+- [Errors](#errors)
+- [Tools](#tools)
+  - [OAuth Token](#oauth-token)
+- [Contributing](#contributing)
+- [Copyright and License](#copyright-and-license)
+
+## Installation
+
+Add to Gemfile.
+
+```
+gem 'strava-ruby-client'
+```
+
+Run `bundle install`.
+
+## Usage
+
+### API
+
+Use an access token obtained from [My API Application](https://www.strava.com/settings/api) in the Strava UI, the [oauth-token tool](#oauth-token) or the [OAuth Workflow](#oauth) in your application.
+
+```ruby
+client = Strava::Api::Client.new(
+  access_token: "12345678987654321"
+)
+```
+
+#### Athlete
+
+Get currently logged-in athlete.
+
+```ruby
+client.athlete # => Strava::Models::Athlete
+```
+
+See [Strava::Models::Athlete](lib/strava/models/athlete.rb) for all available properties.
+
+#### Athlete Activities
+
+Get currently logged-in athlete activities.
+
+```ruby
+client.athlete_activities # => Array[Strava::Models::Activity]
+```
+
+See [Strava::Models::Activity](lib/strava/models/activity.rb) for all available properties.
+
+### OAuth
+
+Obtain a redirect URL.
+
+```ruby
+client = Strava::OAuth::Client.new(
+  client_id: "12345",
+  client_secret: "12345678987654321"
+)
+
+redirect_url = client.authorize_url(
+  redirect_uri: 'https://example.com/oauth',
+  approval_prompt: 'force',
+  response_type: 'code',
+  scope: 'activity:read_all',
+  state: 'magic'
+)
+```
+
+Once the user is redirected to your application, perform a token exchange to obtain a refresh and access token.
+
+```ruby
+response = client.oauth_token(code: '1234556789901234567890')
+
+response # => Strava::Models::Token
+
+response.access_token # access token
+response.refresh_token # refresh token
+response.expires_at # timestamp when the access token expires
+response.athlete # => Strava::Models::Athlete
+```
+
+See [Strava authentication documentation](https://developers.strava.com/docs/authentication/), [Strava::Models::Token](lib/strava/models/token.rb) and [Strava::Models::Athlete](lib/strava/models/athlete.rb) for all available properties in the response.
+
+If the access token is expired, refresh it before making any requests. You will get back all new tokens.
+
+```ruby
+response = client.oauth_token(
+  refresh_token: '...',
+  grant_type: 'refresh_token'
+)
+
+response.access_token # new access token
+response.refresh_token # new refresh token
+response.expires_at # new timestamp when the access token expires
+```
+
+## Configuration
+
+### Web Client Options
+
+You can configure web client options used in the OAuth and API clients, globally.
+
+```ruby
+Strava::Web::Client.configure do |config|
+  config.user_agent = 'Strava Ruby Client/1.0'
+end
+```
+
+The following settings are supported.
+
+setting             | description
+--------------------|------------
+user_agent          | User-agent, defaults to _Strava Ruby Client/version_.
+proxy               | Optional HTTP proxy.
+ca_path             | Optional SSL certificates path.
+ca_file             | Optional SSL certificates file.
+logger              | Optional `Logger` instance that logs HTTP requests.
+timeout             | Optional open/read timeout in seconds.
+open_timeout        | Optional connection open timeout in seconds.
+
+### API Client Options
+
+The API client inherits web client options and provides additional application configuration. These can be configured globally or for a client instance.
+
+```ruby
+Strava::API.configure do |config|
+  config.access_token = "..." # Strava access token
+end
+```
+
+```ruby
+client = Strava::API::Client.new(
+  access_token: "...",
+  user_agent: "..."
+)
+```
+
+The following settings are supported.
+
+setting             | description
+--------------------|------------
+access_token        | Access token to pass in the `Authorization` header.
+endpoint            | Defaults to `https://www.strava.com/api/v3`.
+
+### OAuth Client Options
+
+The OAuth client inherits web client options and provides additional application configuration. These can be configured globally or for a client instance.
+
+```ruby
+Strava::OAuth.configure do |config|
+  config.client_id = "..." # Strava client ID
+  config.client_secret = "..." # Strava client secret
+end
+```
+
+```ruby
+client = Strava::OAuth::Client.new(
+  client_id: "...",
+  client_secret: "...",
+  user_agent: "..."
+)
+```
+
+The following settings are supported.
+
+setting             | description
+--------------------|------------
+client_id           | Application client ID.
+client_secret       | Application client secret.
+endpoint            | Defaults to `https://www.strava.com/oauth`.
+
+## Errors
+
+All errors that return HTTP codes 400-600 result in either `Faraday::Error::ResourceNotFound`, `Faraday::Error::ConnectionFailed` or [Strava::Errors::Fault](lib/strava/errors/fault.rb) exceptions.
+
+```ruby
+begin
+  client.oauth_token(code: 'invalid')
+rescue Strava::Errors::Fault => e
+  e.message # => Bad Request
+  e.errors # => [{ 'code' => 'invalid', 'field' => 'code', 'resource' => 'RequestToken' }]
+end
+```
+
+## Tools
+
+### OAuth Token
+
+Use [bin/oauth-token](bin/outh-token) to obtain a token from the command-line.
+
+```bash
+$ STRAVA_CLIENT_ID=... STRAVA_CLIENT_SECRET=... bundle exec bin/oauth-token.rb
+
+Opening browser at https://www.strava.com/oauth/authorize?...
+Copy paste the code from the redirect URL: 1234556789901234567890
+token_type: Bearer
+refresh_token: 013612374123716234842346234
+access_token: 7348562936591928461923619823
+expires_at: 2018-11-23 16:25:52 -0500
+```
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## Copyright and License
+
+Copyright (c) 2018, [Daniel Doubrovkine](https://twitter.com/dblockdotorg) and [Contributors](CHANGELOG.md).
+
+This project is licensed under the [MIT License](LICENSE.md).