api_key_manager 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11683c2f8e53a827dc507f85c5a87d4a0cae2a8019dd369831f8aaf3270009fd
+  data.tar.gz: 3a9631cc13a0610c44e52ae852b473aeef854829cccc05bc5bb0d155bdde9248
+SHA512:
+  metadata.gz: 1781509a546e698ecc42f4396d318236cd86b7310581820dc73bc2d3331b4d301856a0de0f1eddc7f469e1f011f587c66f00e9f5d1cf9193ca98b9a26359053e
+  data.tar.gz: 6fc121c1de40e2a2c6d1811bce1745c9d268b974247088961a86b706fcb969ea82964a1dff2d1b056df43fa7c35f8903be600cd60c6f99e985b210e5db5fae32

data/.envrc

@@ -0,0 +1 @@
+export RR=`pwd`

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-29
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Dewayne VanHoozer
+
+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,64 @@
+# ApiKeyManager
+
+Manage one or more API keys to the same resource that are rate limited.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    bundle add api_key_manager
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    gem install api_key_manager
+
+## Usage
+
+```ruby
+API = ApiKeyManager::RateLimited.new(
+            api_keys:    ENV['API_KEYS'],
+            delay:       ENV['API_RATE_DELAY'],
+            rate_count:  EMV['API_RATE_COUNT'],
+            rate_period: ENV['API_RATE_PERIOD']
+        )
+#
+API.key
+```
+
+Now everytime `API.key` is called the ApiKeyManager::RateLimted` class complies with the rate limits.  When `delay:` is set to a TRUE value, if the limited count has already been reached then `API.key` will block until the limit period has been passed.
+
+If you are accessing a rate limited API without a wrpaaer library - for example just using Faraday ...
+
+```ruby
+CONNECTION = Faraday.new(url: "https://example.com")
+CONNECTION.get "/query?apikey=#{API.key}&q='xyzzy'"
+CONNECTION.get "/query?apikey=#{API.key}&q='puff'"
+```
+
+If you are using some kind of bad (e.g. one that does not honor rate limitations) wrapper library around an API resource, you can reset that library's client configuration.
+
+```ruby
+config = BadWrapperLibrary.configuration
+config.api_key = API.key
+response = BadWrapperLibery.get_something
+config.api_key = API.key
+response = BadWrapperLibery.get_something_else
+```
+
+It that weird case you should create your own meta wrapper around the bad wrapper library.
+
+Be a good developer; honor the rate limits.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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/[USERNAME]/api_key_manager.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task default: %i[]
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'tests/**/*_test.rb'
+end

data/checksums/api_key_manager-0.1.0.gem.sha512

@@ -0,0 +1 @@
+e4a1760e61b582a3344b54ff1dc6c3c749f50225af7df997a41ffc2db5242d607c2883a47ca1d8f1c2425edb44b1f449a61beac8c66c7642cf61061c055a06df

data/lib/api_key_manager/rate_limited.rb

@@ -0,0 +1,53 @@
+# api_key_manager/lib/api_key_manager/rate_limited.rb
+
+class ApiKeyManager::RateLimited
+
+  def initialize(api_keys:, delay: false, rate_count: 5, rate_period: 60)
+    @api_keys       = api_keys.is_a?(String)  ? api_keys.split(',') : api_keys
+    @delay          = delay
+    @rate_count     = rate_count.is_a?(String)  ? rate_count.to_i   : rate_count
+    @rate_period    = rate_period.is_a?(String) ? rate_period.to_i  : rate_period
+    @start_timer    = Time.now.to_i
+    @end_timer      = @start_timer - 1 # prevent delay
+    @counter        = @rate_count
+    @current_index  = 0
+  end
+
+
+  def reset_counter
+    @counter  = @rate_count
+  end
+
+
+  def reset_timer
+    now = Time.now.to_i
+
+    if @delay && now < @end_timer
+      delta = @end_timer - now
+      sleep(delta)              # NOTE: Will block IO process
+      now = Time.now.to_i
+    end
+
+    @start_timer  = now
+    @end_timer    = @start_timer + @rate_period
+  end
+
+
+  def api_key
+    now = Time.now.to_i
+
+    if now <= @end_timer && @counter < 1
+      @current_index  = (@current_index + 1) % @api_keys.length
+      reset_timer
+      reset_counter
+    elsif now > @end_timer
+      # Continue using same api key
+      reset_timer
+      reset_counter
+    end
+
+    @counter -= 1
+    @api_keys[@current_index]
+  end
+  alias_method :key, :api_key
+end

data/lib/api_key_manager/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ApiKeyManager
+  VERSION = "0.1.0"
+end

data/lib/api_key_manager.rb

@@ -0,0 +1,6 @@
+# api_key_manager/lib/api_key_manager.rb
+
+module ApiKeyManager; end
+
+require_relative "api_key_manager/version"
+require_relative "api_key_manager/rate_limited"

data/tests/api_key_manager_test.rb

@@ -0,0 +1,71 @@
+# api_key_manager/tests/api_key_manager_test.rb
+
+require 'minitest/autorun'
+require_relative '../lib/api_key_manager'
+
+class TestRate < Minitest::Test
+  def setup
+    @api_keys = ['key1', 'key2', 'key3']
+  end
+
+  def test_api_key_returns_a_key
+    rate = ApiKeyManager::RateLimited.new(api_keys: @api_keys)
+
+    assert_includes @api_keys, rate.api_key
+  end
+
+
+  def test_api_key_returns_a_new_key_after_rate_count
+    rate = ApiKeyManager::RateLimited.new(api_keys: @api_keys, rate_count: 2)
+
+    first_key  = rate.api_key
+    second_key = rate.api_key
+    third_key  = rate.api_key
+
+    assert_equal @api_keys[0], first_key
+    assert_equal @api_keys[0], second_key
+    assert_equal @api_keys[1], third_key
+  end
+
+
+  def test_api_key_returns_a_new_key_after_rate_period
+    rate = ApiKeyManager::RateLimited.new(api_keys: @api_keys, rate_period: 3)
+
+    first_key  = rate.api_key
+    second_key = rate.api_key
+
+    sleep(4)
+
+    third_key = rate.api_key
+
+    assert_equal @api_keys[0], first_key
+    assert_equal @api_keys[0], second_key
+    assert_equal @api_keys[0], third_key
+  end
+
+
+  def test_api_key_returns_different_key_after_period_if_delay_is_true
+    rate_period = 5
+    rate  = ApiKeyManager::RateLimited.new(
+              api_keys:     @api_keys,
+              delay:        true,
+              rate_count:   1,
+              rate_period:  rate_period
+            )
+
+    start_time  = Time.now.to_i
+
+    first_key   = rate.api_key
+    second_key  = rate.api_key
+
+    end_time    = Time.now.to_i
+    delta_time  = end_time - start_time
+
+    # show that the 2nd time was blocked until end of period
+    # has expired.
+    assert delta_time >= rate_period
+
+    assert_equal @api_keys[0], first_key
+    assert_equal @api_keys[1], second_key
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: api_key_manager
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dewayne VanHoozer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Manage one or more API keys to the same resource that is rate limited.
+email:
+- dvanhoozer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- checksums/api_key_manager-0.1.0.gem.sha512
+- lib/api_key_manager.rb
+- lib/api_key_manager/rate_limited.rb
+- lib/api_key_manager/version.rb
+- tests/api_key_manager_test.rb
+homepage: https://github.com/MadBomber/api_key_manager
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/MadBomber/api_key_manager
+  source_code_uri: https://github.com/MadBomber/api_key_manager
+  changelog_uri: https://github.com/MadBomber/api_key_manager
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Manage one or more API keys to the same resource that is rate limited.
+test_files: []