rate-limited-jira-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f974fc0246b6865d25b39323815e3bf13443b40a242d58dc1c6fd3a2a8f6585a
+  data.tar.gz: df93cdcddc729ea281903252440d1f9f15bff60b23e10c6d26c7aef25c21c244
+SHA512:
+  metadata.gz: 0b4d577f477bb76a68b789170ebbe9ca85b29e42f80c1f000b5a088580ee12d0f572ceccf108940c7cd148a38be3d4eb83a92ab80a71f8e69b68bcf949ab915c
+  data.tar.gz: 104eff897e1ef2252152988e081c6031d95d1f517e0d5b7595f8068edb7b238cc5297fa57b108b9127ff14fc52ee0bc535c202c3009425ca9084390ab279a7b9

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  NewCops: enable
+
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
+RSpec/ExampleLength:
+  Enabled: true
+  Max: 10
+
+RSpec/MessageExpectation:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: true
+  Max: 4
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-05-18
+
+- Initial release: transparent rate-limiting wrapper around jira-ruby's JIRA::Client
+- In-process implementation using ruby-limiter
+- Redis-based implementation using ratelimit + redis
+- `RateLimitedJira::Client.build` factory; blank/nil implementation normalised to `:in_process`

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "aruba"
+  gem "cucumber"
+  gem "rake"
+  gem "rake-gem-maintenance"
+  gem "rspec"
+  gem "rubocop"
+  gem "rubocop-rake", require: false
+  gem "rubocop-rspec", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,306 @@
+PATH
+  remote: .
+  specs:
+    rate-limited-jira-ruby (0.1.0)
+      jira-ruby
+      ratelimit
+      redis
+      ruby-limiter
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (8.1.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    aruba (2.4.1)
+      bundler (>= 1.17)
+      contracts (>= 0.16.0, < 0.18.0)
+      cucumber (>= 8.0, < 12.0)
+      irb (~> 1.16)
+      rspec-expectations (>= 3.4, < 5.0)
+      thor (~> 1.0)
+    ast (2.4.3)
+    atlassian-jwt (0.2.1)
+      jwt (~> 2.1)
+    base64 (0.3.0)
+    bigdecimal (4.1.2)
+    builder (3.3.0)
+    bundler-audit (0.9.3)
+      bundler (>= 1.2.0)
+      thor (~> 1.0)
+    cgi (0.5.1)
+    concurrent-ruby (1.3.6)
+    connection_pool (3.0.2)
+    contracts (0.17.3)
+    cucumber (11.0.0)
+      base64 (~> 0.2)
+      builder (~> 3.2)
+      cucumber-ci-environment (> 9, < 12)
+      cucumber-core (>= 16.2.0, < 17)
+      cucumber-cucumber-expressions (> 17, < 20)
+      cucumber-html-formatter (> 21, < 24)
+      diff-lcs (~> 1.5)
+      logger (~> 1.6)
+      mini_mime (~> 1.1)
+      multi_test (~> 1.1)
+      sys-uname (~> 1.5)
+    cucumber-ci-environment (11.0.0)
+    cucumber-core (16.2.0)
+      cucumber-gherkin (> 36, < 40)
+      cucumber-messages (> 31, < 33)
+      cucumber-tag-expressions (> 6, < 9)
+    cucumber-cucumber-expressions (19.0.0)
+      bigdecimal
+    cucumber-gherkin (39.1.0)
+      cucumber-messages (>= 31, < 33)
+    cucumber-html-formatter (23.1.0)
+      cucumber-messages (> 23, < 33)
+    cucumber-messages (32.3.1)
+    cucumber-tag-expressions (8.1.0)
+    date (3.5.1)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    erb (6.0.4)
+    ffi (1.17.4)
+    ffi (1.17.4-x86_64-linux-gnu)
+    gem-release (2.2.4)
+    hashie (5.1.0)
+      logger
+    i18n (1.14.8)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.2)
+    irb (1.18.0)
+      pp (>= 0.6.0)
+      prism (>= 1.3.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    jira-ruby (3.1.0)
+      activesupport
+      atlassian-jwt
+      cgi
+      multipart-post
+      oauth (~> 1.0)
+    json (2.19.4)
+    jwt (2.10.2)
+      base64
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    memoist3 (1.0.0)
+    mini_mime (1.1.5)
+    minitest (6.0.5)
+      drb (~> 2.0)
+      prism (~> 1.5)
+    multi_test (1.1.0)
+    multipart-post (2.4.1)
+    oauth (1.1.3)
+      base64 (~> 0.1)
+      oauth-tty (~> 1.0, >= 1.0.6)
+      snaky_hash (~> 2.0)
+      version_gem (~> 1.1, >= 1.1.9)
+    oauth-tty (1.0.6)
+      version_gem (~> 1.1, >= 1.1.9)
+    parallel (2.1.0)
+    parser (3.3.11.1)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    psych (5.3.1)
+      date
+      stringio
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.4.2)
+    rake-gem-maintenance (0.2.0)
+      bundler-audit
+      gem-release
+      rake
+      rotp
+    ratelimit (1.1.0)
+      redis (>= 3.0.0)
+      redis-namespace (>= 1.0.0)
+    rdoc (7.2.0)
+      erb
+      psych (>= 4.0.0)
+      tsort
+    redis (5.4.1)
+      redis-client (>= 0.22.0)
+    redis-client (0.28.0)
+      connection_pool
+    redis-namespace (1.11.0)
+      redis (>= 4)
+    regexp_parser (2.12.0)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rotp (6.3.0)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    rubocop (1.86.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (>= 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.9.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
+    ruby-limiter (2.3.0)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    snaky_hash (2.0.3)
+      hashie (>= 0.1.0, < 6)
+      version_gem (>= 1.1.8, < 3)
+    stringio (3.2.0)
+    sys-uname (1.5.1)
+      ffi (~> 1.1)
+      memoist3 (~> 1.0.0)
+    thor (1.5.0)
+    tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
+    version_gem (1.1.9)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  aruba
+  cucumber
+  rake
+  rake-gem-maintenance
+  rate-limited-jira-ruby!
+  rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+
+CHECKSUMS
+  activesupport (8.1.3) sha256=21a5e0dfbd4c3ddd9e1317ec6a4d782fa226e7867dc70b0743acda81a1dca20e
+  aruba (2.4.1) sha256=c6821949136bd9c953b3cf553971c4780faa26bb40082ac5ce631c541e0caf0d
+  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
+  atlassian-jwt (0.2.1) sha256=2fd2d87418773f2e140c038cb22e049069708aff2bd0a423a7e1740574e97823
+  base64 (0.3.0) sha256=27337aeabad6ffae05c265c450490628ef3ebd4b67be58257393227588f5a97b
+  bigdecimal (4.1.2) sha256=53d217666027eab4280346fba98e7d5b66baaae1b9c3c1c0ffe89d48188a3fbd
+  builder (3.3.0) sha256=497918d2f9dca528fdca4b88d84e4ef4387256d984b8154e9d5d3fe5a9c8835f
+  bundler-audit (0.9.3) sha256=81c8766c71e47d0d28a0f98c7eed028539f21a6ea3cd8f685eb6f42333c9b4e9
+  cgi (0.5.1) sha256=e93fcafc69b8a934fe1e6146121fa35430efa8b4a4047c4893764067036f18e9
+  concurrent-ruby (1.3.6) sha256=6b56837e1e7e5292f9864f34b69c5a2cbc75c0cf5338f1ce9903d10fa762d5ab
+  connection_pool (3.0.2) sha256=33fff5ba71a12d2aa26cb72b1db8bba2a1a01823559fb01d29eb74c286e62e0a
+  contracts (0.17.3) sha256=e72e626413ea47099becb7b5683beb1c2ea902c69f5bad55c9258fe2b48314d7
+  cucumber (11.0.0) sha256=14bb964cc172999e9010fece2fad9f104044b055b3199230091894637a2a784c
+  cucumber-ci-environment (11.0.0) sha256=0df79a9e1d0b015b3d9def680f989200d96fef206f4d19ccf86a338c4f71d1e2
+  cucumber-core (16.2.0) sha256=592b58a95cf42feef8e5a349f68e363784ba3b6568ffbcf6776e38e136cf970b
+  cucumber-cucumber-expressions (19.0.0) sha256=33208ff204732ac9bed42b46993a0a243054f71ece08579d57e53df6a1c9d93a
+  cucumber-gherkin (39.1.0) sha256=aed12a0c955d8563d80a012633c1a72075525f4d64d4cc983001df2181b379ed
+  cucumber-html-formatter (23.1.0) sha256=7789b4a792c876394b9604aeb66aa5cf4c61514473b7e712c76d5eaedcdd8cdf
+  cucumber-messages (32.3.1) sha256=ddc88e4c1cf7afb96c06005b92a4a6f221a2fa435a8b4ca04677d215fd82771c
+  cucumber-tag-expressions (8.1.0) sha256=9bd8c4b6654f8e5bf2a9c99329b6f32136a75e50cd39d4cfb3927d0fa9f52e21
+  date (3.5.1) sha256=750d06384d7b9c15d562c76291407d89e368dda4d4fff957eb94962d325a0dc0
+  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
+  drb (2.2.3) sha256=0b00d6fdb50995fe4a45dea13663493c841112e4068656854646f418fda13373
+  erb (6.0.4) sha256=38e3803694be357fe2bfe312487c74beaf9fb4e5beb3e22498952fe1645b95d9
+  ffi (1.17.4) sha256=bcd1642e06f0d16fc9e09ac6d49c3a7298b9789bcb58127302f934e437d60acf
+  ffi (1.17.4-x86_64-linux-gnu) sha256=9d3db14c2eae074b382fa9c083fe95aec6e0a1451da249eab096c34002bc752d
+  gem-release (2.2.4) sha256=2f11124c1580c811507c3b47e875e420cf3ed792a98105b49df11971e6e94db3
+  hashie (5.1.0) sha256=c266471896f323c446ea8207f8ffac985d2718df0a0ba98651a3057096ca3870
+  i18n (1.14.8) sha256=285778639134865c5e0f6269e0b818256017e8cde89993fdfcbfb64d088824a5
+  io-console (0.8.2) sha256=d6e3ae7a7cc7574f4b8893b4fca2162e57a825b223a177b7afa236c5ef9814cc
+  irb (1.18.0) sha256=de9454a0703a54704b9811a5ef31a60c86949fbf4013fcf244fabc7c775248e3
+  jira-ruby (3.1.0) sha256=45664dac20565155a5fcde514be8820a10fa6c0153d494f7aa38e77b4248ad0b
+  json (2.19.4) sha256=670a7d333fb3b18ca5b29cb255eb7bef099e40d88c02c80bd42a3f30fe5239ac
+  jwt (2.10.2) sha256=31e1ee46f7359883d5e622446969fe9c118c3da87a0b1dca765ce269c3a0c4f4
+  language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
+  lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
+  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
+  memoist3 (1.0.0) sha256=686e42402cf150a362050c23143dc57b0ef88f8c344943ff8b7845792b50d56f
+  mini_mime (1.1.5) sha256=8681b7e2e4215f2a159f9400b5816d85e9d8c6c6b491e96a12797e798f8bccef
+  minitest (6.0.5) sha256=f007d7246bf4feea549502842cd7c6aba8851cdc9c90ba06de9c476c0d01155c
+  multi_test (1.1.0) sha256=e9e550cdd863fb72becfe344aefdcd4cbd26ebf307847f4a6c039a4082324d10
+  multipart-post (2.4.1) sha256=9872d03a8e552020ca096adadbf5e3cb1cd1cdd6acd3c161136b8a5737cdb4a8
+  oauth (1.1.3) sha256=71ca1b534561bf31a9b2aee01147384064b555e796d1a0fe2591806bb4bdd633
+  oauth-tty (1.0.6) sha256=9e8bd1861d367cce18318d8f214f2e1a1d7cb3898de0a9ea79162b4fdecb3152
+  parallel (2.1.0) sha256=b35258865c2e31134c5ecb708beaaf6772adf9d5efae28e93e99260877b09356
+  parser (3.3.11.1) sha256=d17ace7aabe3e72c3cc94043714be27cc6f852f104d81aa284c2281aecc65d54
+  pp (0.6.3) sha256=2951d514450b93ccfeb1df7d021cae0da16e0a7f95ee1e2273719669d0ab9df6
+  prettyprint (0.2.0) sha256=2bc9e15581a94742064a3cc8b0fb9d45aae3d03a1baa6ef80922627a0766f193
+  prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
+  psych (5.3.1) sha256=eb7a57cef10c9d70173ff74e739d843ac3b2c019a003de48447b2963d81b1974
+  racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
+  rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
+  rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
+  rake-gem-maintenance (0.2.0) sha256=d43f2c0387377eb9be78594c7420518379e184a601581506562b3e5fa0f9d89b
+  rate-limited-jira-ruby (0.1.0)
+  ratelimit (1.1.0) sha256=e3fb5086f14f7119a299027a1eb844ad3c8d07f718e90df9f07ba7863b25f551
+  rdoc (7.2.0) sha256=8650f76cd4009c3b54955eb5d7e3a075c60a57276766ebf36f9085e8c9f23192
+  redis (5.4.1) sha256=b5e675b57ad22b15c9bcc765d5ac26f60b675408af916d31527af9bd5a81faae
+  redis-client (0.28.0) sha256=888892f9cd8787a41c0ece00bdf5f556dfff7770326ce40bb2bc11f1bfec824b
+  redis-namespace (1.11.0) sha256=e91a1aa2b2d888b6dea1d4ab8d39e1ae6fac3426161feb9d91dd5cca598a2239
+  regexp_parser (2.12.0) sha256=35a916a1d63190ab5c9009457136ae5f3c0c7512d60291d0d1378ba18ce08ebb
+  reline (0.6.3) sha256=1198b04973565b36ec0f11542ab3f5cfeeec34823f4e54cebde90968092b1835
+  rotp (6.3.0) sha256=75d40087e65ed0d8022c33055a6306c1c400d1c12261932533b5d6cbcd868854
+  rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
+  rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
+  rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
+  rspec-mocks (3.13.8) sha256=086ad3d3d17533f4237643de0b5c42f04b66348c28bf6b9c2d3f4a3b01af1d47
+  rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
+  rubocop (1.86.1) sha256=44415f3f01d01a21e01132248d2fd0867572475b566ca188a0a42133a08d4531
+  rubocop-ast (1.49.1) sha256=4412f3ee70f6fe4546cc489548e0f6fcf76cafcfa80fa03af67098ffed755035
+  rubocop-rake (0.7.1) sha256=3797f2b6810c3e9df7376c26d5f44f3475eda59eb1adc38e6f62ecf027cbae4d
+  rubocop-rspec (3.9.0) sha256=8fa70a3619408237d789aeecfb9beef40576acc855173e60939d63332fdb55e2
+  ruby-limiter (2.3.0) sha256=a8c247e14bc092c749d67bcd2a2def052580447da02b04612a2baa88cb154464
+  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
+  securerandom (0.4.1) sha256=cc5193d414a4341b6e225f0cb4446aceca8e50d5e1888743fac16987638ea0b1
+  snaky_hash (2.0.3) sha256=25a3d299566e8153fb02fa23fd9a9358845950f7a523ddbbe1fa1e0d79a6d456
+  stringio (3.2.0) sha256=c37cb2e58b4ffbd33fe5cd948c05934af997b36e0b6ca6fdf43afa234cf222e1
+  sys-uname (1.5.1) sha256=784d7e6491b0393c25cbbe5ac38324ac7be9fda083a6094832648af669386d7b
+  thor (1.5.0) sha256=e3a9e55fe857e44859ce104a84675ab6e8cd59c650a49106a05f55f136425e73
+  tsort (0.2.0) sha256=9650a793f6859a43b6641671278f79cfead60ac714148aabe4e3f0060480089f
+  tzinfo (2.0.6) sha256=8daf828cc77bcf7d63b0e3bdb6caa47e2272dcfaf4fbfe46f8c3a9df087a829b
+  unicode-display_width (3.2.0) sha256=0cdd96b5681a5949cdbc2c55e7b420facae74c4aaf9a9815eee1087cb1853c42
+  unicode-emoji (4.2.0) sha256=519e69150f75652e40bf736106cfbc8f0f73aa3fb6a65afe62fefa7f80b0f80f
+  uri (1.1.1) sha256=379fa58d27ffb1387eaada68c749d1426738bd0f654d812fcc07e7568f5c57c6
+  version_gem (1.1.9) sha256=0c1a0962ae543c84a00889bb018d9f14d8f8af6029d26b295d98774e3d2eb9a4
+
+BUNDLED WITH
+  4.0.10

data/Rakefile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/gem/maintenance/install_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "cucumber/rake/task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ["--autocorrect"]
+end
+
+Cucumber::Rake::Task.new do |t|
+  t.profile = "rake"
+end
+
+task default: :verify
+
+desc "Run all checks"
+task verify: %i[rubocop spec cucumber]

data/bin/rate-limited-jira-tool

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rate_limited_jira"
+
+begin
+  client = RateLimitedJira::Client.build(
+    {
+      username: ENV.fetch("JIRA_USERNAME"),
+      password: ENV.fetch("JIRA_API_TOKEN"),
+      site: ENV.fetch("JIRA_SITE_URL"),
+      context_path: ENV.fetch("JIRA_CONTEXT_PATH", ""),
+      auth_type: :basic
+    },
+    rate_limit_per_interval: ENV.fetch("JAT_RATE_LIMIT_PER_INTERVAL", "0").to_i,
+    rate_interval_in_seconds: ENV.fetch("JAT_RATE_INTERVAL_IN_SECONDS", "0").to_i,
+    implementation: ENV.fetch("JAT_RATE_LIMIT_IMPLEMENTATION", "")
+  )
+  3.times { client.Board.all }
+rescue StandardError => e
+  warn "#{e.class}: #{e.message}"
+  exit 1
+end

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: --format pretty --publish-quiet
+rake:    --format progress --publish-quiet --tags 'not @wip'

data/features/control_http_request_rate_limit.feature

@@ -0,0 +1,29 @@
+Feature: Control the HTTP request rate limit
+  In order to work against a JIRA instance imposing API rate limits
+  As a user
+  I need the ability to control the HTTP request limit
+
+  Scenario Outline: Limiting the request rate
+    Given the following environment variables are set:
+      | name                          | value                           |
+      | JAT_RATE_INTERVAL_IN_SECONDS  | <rate_interval_in_seconds>      |
+      | JAT_RATE_LIMIT_IMPLEMENTATION | <jat_rate_limit_implementation> |
+      | JAT_RATE_LIMIT_PER_INTERVAL   | <rate_limit_per_interval>       |
+    Then successfully running `rate-limited-jira-tool` takes between <minimal_time> and <maximal_time> seconds
+
+    Examples:
+      | jat_rate_limit_implementation | rate_limit_per_interval | rate_interval_in_seconds | minimal_time | maximal_time |
+      |                               | 0                       | 0                        | 0            | 5            |
+      | in_process                    | 1                       | 1                        | 1            | 20           |
+      | redis                         | 1                       | 2                        | 1            | 20           |
+      | redis                         | 1                       | 10                       | 18           | 120          |
+
+  Scenario: Unexpected rate limiting implementation generates an error
+    Given the following environment variables are set:
+      | name                          | value                  |
+      | JAT_RATE_LIMIT_IMPLEMENTATION | UNKNOWN IMPLEMENTATION |
+    When I run `rate-limited-jira-tool`
+    Then it should fail with:
+      """
+      unknown rate limiting implementation
+      """

data/features/step_definitions/execution_context_steps.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+BUFFER_TIME_IN_SECONDS = 10
+
+Given(/^the following environment variables are set:$/) do |table|
+  table.hashes.each do |row|
+    set_environment_variable(row.fetch("name"), row.fetch("value"))
+  end
+end
+
+Then(/^successfully running `(.*)` takes between (.*) and (.*) seconds$/) do |cmd, min, max|
+  start_time = Time.now
+  run_command_and_stop(cmd, fail_on_error: true, exit_timeout: max.to_i + BUFFER_TIME_IN_SECONDS)
+  end_time = Time.now
+  expect(end_time - start_time).to be_between(min.to_i, max.to_i)
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "aruba/cucumber"
+
+ENV["PATH"] = File.join(__dir__, "..", "..", "bin") + File::PATH_SEPARATOR + ENV.fetch("PATH", nil)

data/features/support/hooks.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+Before do
+  setup_aruba
+  ENV["HOME"] = expand_path(".")
+  cd(".")
+  %w[JIRA_USERNAME JIRA_API_TOKEN JIRA_SITE_URL JIRA_CONTEXT_PATH].each do |var|
+    set_environment_variable(var, ENV[var]) if ENV[var]
+  end
+end

data/lib/rate_limited_jira/client/in_process_based.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "ruby-limiter"
+
+module RateLimitedJira
+  class Client
+    class InProcessBased < Client
+      def rate_limit(&block)
+        rate_queue.shift
+
+        block.call
+      end
+
+      def rate_queue
+        @rate_queue ||=
+          Limiter::RateQueue.new(rate_limit_per_interval, interval: rate_interval_in_seconds)
+      end
+    end
+  end
+end

data/lib/rate_limited_jira/client/redis_based.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "ratelimit"
+require "redis"
+
+module RateLimitedJira
+  class Client
+    class RedisBased < Client
+      RATE_LIMITER_KEY = "rate_limited_jira_api_requests"
+
+      def rate_limit(&block)
+        rate_limiter.exec_within_threshold(RATE_LIMITER_KEY,
+                                           interval: rate_interval_in_seconds,
+                                           threshold: rate_limit_per_interval) do
+          response = block.call
+
+          rate_limiter.add(RATE_LIMITER_KEY)
+
+          response
+        end
+      end
+
+      def rate_limiter
+        self.class.rate_limiter(RATE_LIMITER_KEY, rate_interval_in_seconds)
+      end
+
+      def self.rate_limiter(rate_limiter_key, rate_interval)
+        @rate_limiter ||= Ratelimit.new(rate_limiter_key, bucket_interval: rate_interval)
+      end
+    end
+  end
+end

data/lib/rate_limited_jira/client.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "jira-ruby"
+
+module RateLimitedJira
+  class Client < JIRA::Client
+    NO_RATE_LIMIT_PER_INTERVAL = 0
+    NO_RATE_INTERVAL_IN_SECONDS = 0
+
+    def self.build(jira_options, rate_limit_per_interval: 0, rate_interval_in_seconds: 0, implementation: :in_process)
+      implementation_class_for(implementation)
+        .new(jira_options,
+             rate_limit_per_interval: rate_limit_per_interval,
+             rate_interval_in_seconds: rate_interval_in_seconds)
+    end
+
+    def self.implementation_class_for(implementation)
+      impl = implementation.to_s.then { |s| s.empty? ? :in_process : s.to_sym }
+      case impl
+      when :in_process then InProcessBased
+      when :redis      then RedisBased
+      else
+        raise ArgumentError, "#{implementation.inspect}: unknown rate limiting implementation. " \
+                             "Valid options: :in_process, :redis"
+      end
+    end
+    private_class_method :implementation_class_for
+
+    attr_reader :rate_interval_in_seconds, :rate_limit_per_interval
+
+    def initialize(options, rate_interval_in_seconds: 0, rate_limit_per_interval: 0)
+      super(options)
+      @rate_interval_in_seconds = rate_interval_in_seconds
+      @rate_limit_per_interval = rate_limit_per_interval
+    end
+
+    alias original_request request
+
+    def request(*)
+      if rate_limit_per_interval == NO_RATE_LIMIT_PER_INTERVAL
+        original_request(*)
+      else
+        rate_limit { original_request(*) }
+      end
+    end
+
+    def rate_limit(&)
+      raise NotImplementedError, "rate_limit must be implemented by a subclass"
+    end
+  end
+end
+
+require_relative "client/in_process_based"
+require_relative "client/redis_based"

data/lib/rate_limited_jira/version.rb

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

data/lib/rate_limited_jira.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "rate_limited_jira/version"
+require_relative "rate_limited_jira/client"

data/spec/rate_limited_jira/client/in_process_based_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+RSpec.describe RateLimitedJira::Client::InProcessBased do
+  def build_client
+    described_class.new({}, rate_interval_in_seconds:, rate_limit_per_interval:)
+  end
+
+  let(:client) { build_client }
+  let(:rate_interval_in_seconds) { 2 }
+  let(:rate_limit_per_interval) { 1 }
+
+  describe "#rate_limit" do
+    let(:rate_queue) { instance_double(Limiter::RateQueue) }
+
+    it "properly initializes the rate queue" do
+      allow(Limiter::RateQueue)
+        .to receive(:new).with(rate_limit_per_interval, interval: rate_interval_in_seconds)
+        .and_return(rate_queue)
+
+      allow(rate_queue).to receive(:shift)
+
+      expect(client.rate_limit { :do_nothing }).to eq(:do_nothing)
+    end
+
+    context "when rate limiting multiple requests" do
+      let(:rate_limit_4_calls_to_original_request_code) do
+        4.times { client.rate_limit { client.original_request(:get, "/path/to/resource") } }
+      end
+
+      before do
+        allow(client).to receive(:original_request).with(:get, "/path/to/resource")
+        allow(client).to receive_messages(rate_queue: rate_queue)
+        allow(rate_queue).to receive(:shift)
+      end
+
+      it "shifts the queue and performs the request call" do
+        rate_limit_4_calls_to_original_request_code
+
+        expect(rate_queue).to have_received(:shift).exactly(4).times
+        expect(client).to have_received(:original_request).exactly(4).times
+      end
+    end
+
+    describe "#rate_queue" do
+      let(:another_client) { build_client }
+
+      it "creating a second client returns another queue" do
+        expect(another_client.rate_queue).not_to equal(client.rate_queue)
+      end
+    end
+  end
+end

data/spec/rate_limited_jira/client/redis_based_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+RSpec.describe RateLimitedJira::Client::RedisBased do
+  describe "#rate_limit" do
+    let(:client) { described_class.new({}, rate_interval_in_seconds:, rate_limit_per_interval:) }
+
+    let(:rate_interval_in_seconds) { 2 }
+    let(:rate_limit_per_interval) { 1 }
+    let(:rate_limiter) { instance_double(Ratelimit) }
+
+    let(:rate_limit_4_calls_to_original_request_code) do
+      4.times { client.rate_limit { client.original_request(:get, "/path/to/resource") } }
+    end
+
+    before do
+      allow(described_class).to receive_messages(rate_limiter: rate_limiter)
+      allow(client).to receive(:original_request)
+    end
+
+    it "uses :exec_within_threshold to control rate limiting" do
+      allow(rate_limiter).to receive(:exec_within_threshold)
+
+      rate_limit_4_calls_to_original_request_code
+
+      expect(rate_limiter)
+        .to have_received(:exec_within_threshold)
+        .with(RateLimitedJira::Client::RedisBased::RATE_LIMITER_KEY,
+              { interval: rate_interval_in_seconds, threshold: rate_limit_per_interval })
+        .exactly(4).times
+    end
+
+    it "keeps track of rate limiter key calls" do
+      allow(rate_limiter).to receive(:exec_within_threshold).and_yield
+      allow(rate_limiter).to receive(:add)
+
+      rate_limit_4_calls_to_original_request_code
+
+      expect(rate_limiter)
+        .to have_received(:add)
+        .with(RateLimitedJira::Client::RedisBased::RATE_LIMITER_KEY)
+        .exactly(4).times
+    end
+  end
+end

data/spec/rate_limited_jira/client_spec.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+RSpec.describe RateLimitedJira::Client do
+  describe ".build" do
+    let(:jira_options) { {} }
+
+    context "when implementation is unspecified" do
+      subject(:result) { described_class.build(jira_options) }
+
+      it { expect(result).to be_a(RateLimitedJira::Client::InProcessBased) }
+    end
+
+    context "when implementation is :in_process" do
+      subject(:result) { described_class.build(jira_options, implementation: :in_process) }
+
+      it { expect(result).to be_a(RateLimitedJira::Client::InProcessBased) }
+    end
+
+    context "when implementation is blank" do
+      subject(:result) { described_class.build(jira_options, implementation: "") }
+
+      it { expect(result).to be_a(RateLimitedJira::Client::InProcessBased) }
+    end
+
+    context "when implementation is :redis" do
+      subject(:result) { described_class.build(jira_options, implementation: :redis) }
+
+      it { expect(result).to be_a(RateLimitedJira::Client::RedisBased) }
+    end
+
+    context "when implementation is unknown" do
+      subject(:result) { described_class.build(jira_options, implementation: :unknown) }
+
+      it do
+        expect { result }
+          .to raise_error(ArgumentError, /:unknown.*unknown rate limiting implementation/)
+      end
+    end
+  end
+
+  RSpec.shared_examples "a rate limited client" do
+    before do
+      allow(client).to receive_messages(original_request: :response)
+    end
+
+    it "returns the response" do
+      expect(client.request(:get, "/path/to/resource")).to eq(:response)
+    end
+
+    it "calls the original request method" do
+      client.request(:get, "/path/to/resource")
+
+      expect(client).to have_received(:original_request).with(:get, "/path/to/resource")
+    end
+  end
+
+  describe "#request" do
+    let(:client) { described_class.new({}, rate_interval_in_seconds:, rate_limit_per_interval:) }
+
+    context "when rate limiting is disabled" do
+      let(:rate_interval_in_seconds) { 0 }
+      let(:rate_limit_per_interval) { 0 }
+
+      it_behaves_like "a rate limited client"
+
+      it "does not use the rate limiter" do
+        allow(client).to receive(:original_request).with(:get, "/path/to/resource")
+        expect(client).not_to receive(:rate_limit)
+
+        client.request(:get, "/path/to/resource")
+      end
+    end
+
+    context "when rate limiting is enabled" do
+      let(:rate_interval_in_seconds) { 2 }
+      let(:rate_limit_per_interval) { 1 }
+
+      it_behaves_like "a rate limited client" do
+        before { allow(client).to receive(:rate_limit).and_yield }
+      end
+
+      it "uses the rate limiter" do
+        allow(client).to receive(:original_request).with(:get, "/path/to/resource")
+        expect(client).to receive(:rate_limit).and_yield
+
+        client.request(:get, "/path/to/resource")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rate_limited_jira"
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: rate-limited-jira-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christophe Broult
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jira-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ratelimit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-limiter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email:
+- cbroult@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- bin/rate-limited-jira-tool
+- cucumber.yml
+- features/control_http_request_rate_limit.feature
+- features/step_definitions/execution_context_steps.rb
+- features/support/env.rb
+- features/support/hooks.rb
+- lib/rate_limited_jira.rb
+- lib/rate_limited_jira/client.rb
+- lib/rate_limited_jira/client/in_process_based.rb
+- lib/rate_limited_jira/client/redis_based.rb
+- lib/rate_limited_jira/version.rb
+- spec/rate_limited_jira/client/in_process_based_spec.rb
+- spec/rate_limited_jira/client/redis_based_spec.rb
+- spec/rate_limited_jira/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cbroult/rate-limited-jira-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/cbroult/rate-limited-jira-ruby
+  source_code_uri: https://github.com/cbroult/rate-limited-jira-ruby
+  changelog_uri: https://github.com/cbroult/rate-limited-jira-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Transparent rate-limiting wrapper around jira-ruby's JIRA::Client.
+test_files: []