Draft: adds rate limit class #40

simonneutert · 2021-07-18T09:25:17Z

this may not be exactly what you had in mind, but maybe we can make this work in a way you feel good merging it. let me know what you think and I will add tests and finish the job.

simonneutert · 2021-07-18T12:37:40Z

lib/strava/api/client.rb

@@ -15,6 +15,8 @@ class Client < Strava::Web::Client

      attr_accessor(*Config::ATTRIBUTES)

+      attr_accessor :ratelimit_status


I added the RatelimitStatus class to the client, making it possible to check the limits after each call. Added a boolean flag, too, as not every call gets rate limit in its headers.

dblock

It's a good start. Keeping state on the client will make it definitely not threadsafe, so we shouldn't. Instead, wrap response.body with Response.new(response) and implement rate limit headers on that. Make sure Response#to_s returns response.body. And generally this is more future-proof for other extracts from .headers.

dblock · 2021-07-18T14:35:03Z

lib/strava/api/ratelimit_status.rb

@@ -0,0 +1,59 @@
+module Strava
+  module Api
+    class RatelimitStatus


I think we should call this Ratelimit , to match the headers, or RatelimitHeaders.

i pushed a bit to where it's heading at, please give feedback and I will see where this is going or whether it's going to be a dead end.

similar to paginate model extraction/instantiation is now backend with ratelimits like

def enrich_model_with_headers(model, response) response.ratelimit_headers model._response_headers = response.headers model._response_ratelimit = response.ratelimit_headers model end

duplicating the "body" into the model via Response is not worth it, I'd say ...

lib/strava/api/ratelimit_status.rb

simonneutert · 2021-07-18T18:38:16Z

errors go down with every endpoint I fix, but I still do have some busy work to finish.

but I'd like to get your feedback first. I do like that models do not get instantiated directly anymore, to be honest. it feels a bit cleaner having methods be in charge, just like paginate always did the magic.

dblock · 2021-07-19T13:09:08Z

errors go down with every endpoint I fix, but I still do have some busy work to finish.

but I'd like to get your feedback first. I do like that models do not get instantiated directly anymore, to be honest. it feels a bit cleaner having methods be in charge, just like paginate always did the magic.

So you already see the problem, it's getting messy, so that's probably not the right solution. Try this:

The response is now an object.
Add a different constructor to the Model base class that takes a response. Now models will inherit from a class that is constructed from a response and not a hash, and it should keep a reference to the response object.
Because all models inherit from Model, you can get access to the response object and hence the headers.
Lazy instantiation everywhere so we only parse/construct when needed.

simonneutert · 2021-07-19T14:49:29Z

errors go down with every endpoint I fix, but I still do have some busy work to finish.
but I'd like to get your feedback first. I do like that models do not get instantiated directly anymore, to be honest. it feels a bit cleaner having methods be in charge, just like paginate always did the magic.

So you already see the problem, it's getting messy, so that's probably not the right solution. Try this:

The response is now an object.

Add a different constructor to the Model base class that takes a response. Now models will inherit from a class that is constructed from a response and not a hash, and it should keep a reference to the response object.

Because all models inherit from Model, you can get access to the response object and hence the headers.

Lazy instantiation everywhere so we only parse/construct when needed.

this was my first implementation I tried, but I failed getting it to work with the Hashie::Trash Model class inherits from

I will let this sink in a bit and see what my sub conscience comes up with 😞

dblock · 2021-07-19T15:41:36Z

I will let this sink in a bit and see what my sub conscience comes up with 😞

Let me know if you need help!

dblock · 2021-12-27T16:14:06Z

Want to try finish this up @simonneutert?

simonneutert · 2021-12-28T19:45:11Z

i will give this another try and get back to you with what I come up with ✌️

…nto 11-http-classes

dangerpr-bot · 2021-12-28T19:56:24Z

	1 Error
🚫	The TOC found in README.md doesn't match the sections of the file.

	1 Warning
⚠️	Unless you're refactoring existing code or improving documentation, please update CHANGELOG.md.

Here's the expected TOC for README.md:

# Table of Contents

- [Installation](#installation)
- [Usage](#usage)
  - [Activities](#activities)
    - [Create an Activity](#create-an-activity)
    - [Get Activity](#get-activity)
    - [List Activity Photos](#list-activity-photos)
    - [List Activity Comments](#list-activity-comments)
    - [List Activity Kudoers](#list-activity-kudoers)
    - [List Activity Laps](#list-activity-laps)
    - [List Athlete Activities](#list-athlete-activities)
    - [Get Activity Zones](#get-activity-zones)
    - [Update Activity](#update-activity)
  - [Athletes](#athletes)
    - [Get Authenticated Athlete](#get-authenticated-athlete)
    - [Get Zones](#get-zones)
    - [Get Athlete Stats](#get-athlete-stats)
    - [Update Athlete](#update-athlete)
  - [Clubs](#clubs)
    - [List Club Activities](#list-club-activities)
    - [List Club Events](#list-club-events)
    - [List Club Administrators](#list-club-administrators)
    - [Get Club](#get-club)
    - [List Club Members](#list-club-members)
    - [List Athlete Clubs](#list-athlete-clubs)
  - [Gears](#gears)
    - [Get Equipment](#get-equipment)
  - [Routes](#routes)
    - [Export Route GPX](#export-route-gpx)
    - [Export Route TCX](#export-route-tcx)
    - [Get Route](#get-route)
    - [List Athlete Routes](#list-athlete-routes)
  - [Running Races](#running-races)
    - [Get Running Race](#get-running-race)
    - [List Running Races](#list-running-races)
  - [Segment Efforts](#segment-efforts)
    - [List Segment Efforts](#list-segment-efforts)
    - [Get Segment Effort](#get-segment-effort)
  - [Segments](#segments)
    - [Explore Segments](#explore-segments)
    - [Get Segment Leaderboard](#get-segment-leaderboard)
    - [List Starred Segments](#list-starred-segments)
    - [Get Segment](#get-segment)
    - [Star Segment](#star-segment)
  - [Streams](#streams)
    - [Get Activity Streams](#get-activity-streams)
    - [Get Segment Effort Streams](#get-segment-effort-streams)
    - [Get Segment Streams](#get-segment-streams)
  - [Uploads](#uploads)
    - [Upload Activity](#upload-activity)
    - [Get Upload](#get-upload)
  - [Pagination](#pagination)
  - [OAuth](#oauth)
    - [OAuth Workflow](#oauth-workflow)
    - [Deauthorize](#deauthorize)
    - [Command Line OAuth Workflow](#command-line-oauth-workflow)
  - [Webhooks](#webhooks)
- [Configuration](#configuration)
  - [Web Client Options](#web-client-options)
  - [API Client Options](#api-client-options)
  - [OAuth Client Options](#oauth-client-options)
  - [OAuth Client Ratelimits](#oauth-client-ratelimits)
  - [Webhooks Client Options](#webhooks-client-options)
- [Errors](#errors)
- [Tools](#tools)
  - [Strava OAuth Token](#strava-oauth-token)
- [Users](#users)
- [Resources](#resources)
- [Upgrading](#upgrading)
- [Contributing](#contributing)
- [Copyright and License](#copyright-and-license)

Here's an example of a CHANGELOG.md entry:

* [#40](https://github.com/dblock/strava-ruby-client/pull/40): Draft: adds rate limit class - [@simonneutert](https://github.com/simonneutert).

Generated by 🚫 Danger

…-client into 11-http-classes

simonneutert · 2022-03-06T17:34:55Z

new attempt in PR #50

adds rate limit class

5468b1c

simonneutert changed the title ~~adds rate limit class~~ Draft: adds rate limit class Jul 18, 2021

simonneutert commented Jul 18, 2021

View reviewed changes

dblock requested changes Jul 18, 2021

View reviewed changes

simonneutert added 4 commits July 18, 2021 17:56

removes reliance on exceptions

38dfd90

naming

72f072f

removes stray puts, returns a Boolean now

7f9b855

factors out model extraction

70771e5

simonneutert added 2 commits December 28, 2021 20:55

Merge branch 'dblock:master' into 11-http-classes

2ec3089

Merge branch 'master' of github.com:simonneutert/strava-ruby-client i…

abe9c5f

…nto 11-http-classes

simonneutert added 2 commits December 28, 2021 20:57

Merge branch '11-http-classes' of github.com:simonneutert/strava-ruby…

f99b1b7

…-client into 11-http-classes

runs rubocop

0b7b4fd

simonneutert closed this Mar 6, 2022

simonneutert mentioned this pull request Mar 6, 2022

Implements RateLimit for API Request/Response #50

Closed

dblock mentioned this pull request Dec 29, 2022

Specialize rate limiting errors #11

Closed

simonneutert deleted the 11-http-classes branch September 17, 2024 09:16

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Draft: adds rate limit class #40

Draft: adds rate limit class #40

simonneutert commented Jul 18, 2021

simonneutert Jul 18, 2021

dblock left a comment •

edited

Loading

dblock Jul 18, 2021

simonneutert Jul 18, 2021

simonneutert commented Jul 18, 2021 •

edited

Loading

dblock commented Jul 19, 2021 •

edited

Loading

simonneutert commented Jul 19, 2021

dblock commented Jul 19, 2021

dblock commented Dec 27, 2021

simonneutert commented Dec 28, 2021

dangerpr-bot commented Dec 28, 2021

simonneutert commented Mar 6, 2022

		@@ -15,6 +15,8 @@ class Client < Strava::Web::Client

		attr_accessor(*Config::ATTRIBUTES)

		attr_accessor :ratelimit_status

Draft: adds rate limit class #40

Draft: adds rate limit class #40

Conversation

simonneutert commented Jul 18, 2021

simonneutert Jul 18, 2021

Choose a reason for hiding this comment

dblock left a comment • edited Loading

Choose a reason for hiding this comment

dblock Jul 18, 2021

Choose a reason for hiding this comment

simonneutert Jul 18, 2021

Choose a reason for hiding this comment

simonneutert commented Jul 18, 2021 • edited Loading

dblock commented Jul 19, 2021 • edited Loading

simonneutert commented Jul 19, 2021

dblock commented Jul 19, 2021

dblock commented Dec 27, 2021

simonneutert commented Dec 28, 2021

dangerpr-bot commented Dec 28, 2021

simonneutert commented Mar 6, 2022

dblock left a comment •

edited

Loading

simonneutert commented Jul 18, 2021 •

edited

Loading

dblock commented Jul 19, 2021 •

edited

Loading