freno-client 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 808823b23d76b3a540d9d17d2c6e28b428fd3cb387c941f79c749779393ac462
-  data.tar.gz: cf58a8db9c3d7fa2bea92727b3336a62fded79081723ee5e13555a72e6d68c62
+  metadata.gz: d770b3f1d5945dfd32db3e566c8881d0995afd0679e28e4eb1cb6275d0e44ee7
+  data.tar.gz: a16e811393f6a20ab6c8fd0ea75a870a824399d29c7d4051df9ee2801b461845
 SHA512:
-  metadata.gz: 1fb13835bd9d2c9dd64c8bc3ae6e9931e0bd16a82cfa0ffbc4ed276505e453d4cf8a371cd66e6a0da19c2755e1174ce2812c55d0b12ce781b7a52f08add3f838
-  data.tar.gz: 540f2de04000141a1c636ab169e178a99a48dc19fe53557f7afba59dd2ddd2e2c407178e8a4f5e2daeb82b54871eac21f7d369854f1e9d7b87bbde1226289ffc
+  metadata.gz: bc6292fe3c1221bae5ac70f8f67145f5e2db18d23bb1f0c869d0c98e54d388348e9670495280e6f49e86991612a8a01d3109548ba4575cedb4289856751c09f1
+  data.tar.gz: 46d9b541781f7bc250e0cb038177cdf8327cae1090bef229b667309c98b06c9f042d34cc583b9ea091014313bc459849c0dcf4c8544ffef10523828433095399

data/freno-client.gemspec

@@ -3,26 +3,31 @@
 require_relative "lib/freno/client/version"
 
 Gem::Specification.new do |spec|
-  spec.name    = "freno-client"
+  spec.name = "freno-client"
   spec.version = Freno::Client::VERSION
-  spec.author  = "GitHub"
-  spec.email   = "opensource+freno-client@github.com"
-
-  spec.summary     = "A library for interacting with Freno, the throttler service"
+  spec.summary = "A library for interacting with Freno, the throttler service"
   spec.description = <<~DESC.gsub(/\s+/, " ")
     freno-client is a Ruby library that interacts with Freno using HTTP.
     Freno is a throttling service and its source code is available at
     https://github.com/github/freno
   DESC
 
+  spec.author = "GitHub"
+  spec.email = "opensource+freno-client@github.com"
+  spec.license = "MIT"
   spec.homepage = "https://github.com/github/freno-client"
-  spec.license  = "MIT"
-
-  spec.required_ruby_version = ">= 2.7.0"
 
-  spec.files = `git ls-files -z`.split("\x0").grep_v(/^(bin|test)/)
+  spec.metadata = {
+    "allowed_push_host" => "https://rubygems.org",
+    "bug_tracker_uri" => "https://github.com/github/freno-client/issues",
+    "homepage_uri" => "https://github.com/github/freno-client",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/github/freno-client"
+  }
 
+  spec.required_ruby_version = ">= 3.0"
   spec.add_dependency "faraday", "< 3"
 
-  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.files = Dir.glob(["freno-client.gemspec", "lib/**/*.rb", "LICENSE.txt"])
+  spec.extra_rdoc_files = ["README.md"]
 end

data/lib/freno/client/preconditions.rb

@@ -16,9 +16,7 @@ module Freno
 
         def present(args = {})
           args.each do |arg, value|
-            unless value
-              errors << "#{arg} should be present"
-            end
+            errors << "#{arg} should be present" unless value
           end
         end
 

data/lib/freno/client/version.rb

@@ -2,6 +2,6 @@
 
 module Freno
   class Client
-    VERSION = "0.8.2"
+    VERSION = Gem::Version.new("0.9.0")
   end
 end

data/lib/freno/throttler.rb

@@ -166,7 +166,7 @@ module Freno
       instrument(:called, store_names: store_names)
       waited = 0
 
-      loop do
+      while true
         unless circuit_breaker.allow_request?
           instrument(:circuit_open, store_names: store_names, waited: waited)
           raise CircuitOpen
@@ -175,19 +175,21 @@ module Freno
         if all_stores_ok?(store_names, **options)
           instrument(:succeeded, store_names: store_names, waited: waited)
           circuit_breaker.success
-          return yield
+          break
         end
 
-        wait
-        waited += wait_seconds
-        instrument(:waited, store_names: store_names, waited: waited, max: max_wait_seconds)
-
-        next unless waited > max_wait_seconds
-
-        instrument(:waited_too_long, store_names: store_names, waited: waited, max: max_wait_seconds)
-        circuit_breaker.failure
-        raise WaitedTooLong.new(waited_seconds: waited, max_wait_seconds: max_wait_seconds)
+        if waited + wait_seconds > max_wait_seconds
+          instrument(:waited_too_long, store_names: store_names, waited: waited, max: max_wait_seconds)
+          circuit_breaker.failure
+          raise WaitedTooLong.new(waited_seconds: waited, max_wait_seconds: max_wait_seconds)
+        else
+          wait
+          waited += wait_seconds
+          instrument(:waited, store_names: store_names, waited: waited, max: max_wait_seconds)
+        end
       end
+
+      yield
     end
 
     private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freno-client
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - GitHub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2024-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -29,21 +29,12 @@ description: 'freno-client is a Ruby library that interacts with Freno using HTT
 email: opensource+freno-client@github.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
-- ".github/workflows/ruby.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - freno-client.gemspec
-- gemfiles/faraday_0.gemfile
-- gemfiles/faraday_1.gemfile
-- gemfiles/faraday_2.gemfile
 - lib/freno/client.rb
 - lib/freno/client/errors.rb
 - lib/freno/client/preconditions.rb
@@ -62,7 +53,11 @@ homepage: https://github.com/github/freno-client
 licenses:
 - MIT
 metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/github/freno-client/issues
+  homepage_uri: https://github.com/github/freno-client
   rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/github/freno-client
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -71,14 +66,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: A library for interacting with Freno, the throttler service

data/.github/workflows/ruby.yml

@@ -1,35 +0,0 @@
-name: Ruby
-on:
-  push:
-    branches:
-    - main
-  pull_request:
-    branches:
-    - main
-permissions:
-  contents: read
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version:
-        - '2.7'
-        - '3.0'
-        - '3.1'
-        gemfile-path:
-        - Gemfile
-        - gemfiles/faraday_0.gemfile
-        - gemfiles/faraday_1.gemfile
-        - gemfiles/faraday_2.gemfile
-    env:
-      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile-path }}
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-    - name: Run tests
-      run: bundle exec rake

data/.gitignore

@@ -1,13 +0,0 @@
-*.gem
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/gemfiles/*.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/vendor/gems
-.ruby-version

data/.rubocop.yml

@@ -1,44 +0,0 @@
-require:
-- rubocop-minitest
-- rubocop-performance
-- rubocop-rake
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 2.7
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: true
-  EnforcedStyle: indented_relative_to_receiver
-
-Metrics:
-  Enabled: false
-
-Minitest/AssertEmptyLiteral:
-  Enabled: false
-Minitest/AssertEqual:
-  Enabled: false
-Minitest/AssertPredicate:
-  Enabled: false
-Minitest/MultipleAssertions:
-  Enabled: false
-Minitest/RefutePredicate:
-  Enabled: false
-
-Naming/RescuedExceptionsVariableName:
-  Enabled: true
-  PreferredName: error
-
-Style/ClassAndModuleChildren:
-  Enabled: true
-  Exclude:
-  - test/**/*
-Style/Documentation:
-  Enabled: false
-Style/IfUnlessModifier:
-  Enabled: false
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-Style/SymbolArray:
-  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# 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 opensource+freno-client@github.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/CONTRIBUTING.md

@@ -1,32 +0,0 @@
-## Contributing
-
-[fork]: https://github.com/github/freno-client/fork
-[pr]: https://github.com/github/freno-client/compare
-[style]: https://github.com/styleguide/ruby
-[code-of-conduct]: CODE_OF_CONDUCT.md
-
-Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
-
-Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
-
-## Submitting a pull request
-
-0. [Fork][fork] and clone the freno-client repository
-0. Configure and install the dependencies: `bin/setup`
-0. Make sure the tests pass on your machine: `bin/test`
-0. Create a new branch: `git checkout -b my-branch-name`
-0. Make your change, add tests, and make sure the tests still pass
-0. Push to your fork and [submit a pull request][pr]
-0. Pat your self on the back and wait for your pull request to be reviewed and merged.
-
-Here are a few things you can do that will increase the likelihood of your pull request being accepted:
-
-- Write tests.
-- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
-- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
-
-## Resources
-
-- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
-- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
-- [GitHub Help](https://help.github.com)

data/Gemfile

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec
-
-group :development do
-  gem "rake"
-end
-
-group :test do
-  gem "minitest", ">= 5"
-  gem "mocha"
-  gem "rubocop", "~> 1.37", require: false
-  gem "rubocop-minitest", require: false
-  gem "rubocop-performance", require: false
-  gem "rubocop-rake", require: false
-end

data/Rakefile

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

data/gemfiles/faraday_0.gemfile

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec path: ".."
-
-gem "faraday", "~> 0.0"
-
-# Content below copied from Gemfile
-
-group :development do
-  gem "rake"
-end
-
-group :test do
-  gem "minitest", ">= 5"
-  gem "mocha"
-  gem "rubocop", "~> 1.37", require: false
-  gem "rubocop-minitest", require: false
-  gem "rubocop-performance", require: false
-  gem "rubocop-rake", require: false
-end

data/gemfiles/faraday_1.gemfile

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec path: ".."
-
-gem "faraday", "~> 1.0"
-
-# Content below copied from Gemfile
-
-group :development do
-  gem "rake"
-end
-
-group :test do
-  gem "minitest", ">= 5"
-  gem "mocha"
-  gem "rubocop", "~> 1.37", require: false
-  gem "rubocop-minitest", require: false
-  gem "rubocop-performance", require: false
-  gem "rubocop-rake", require: false
-end

data/gemfiles/faraday_2.gemfile

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec path: ".."
-
-gem "faraday", "~> 2.0"
-
-# Content below copied from Gemfile
-
-group :development do
-  gem "rake"
-end
-
-group :test do
-  gem "minitest", ">= 5"
-  gem "mocha"
-  gem "rubocop", "~> 1.37", require: false
-  gem "rubocop-minitest", require: false
-  gem "rubocop-performance", require: false
-  gem "rubocop-rake", require: false
-end