octopoller 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f208e25fceb01c8bfaa93d95fa6c9f7ea7fa3f364c1edc0e6560e21e60eab713
-  data.tar.gz: 55bb40825baf87505dcd14385c526bedb7cc60f0fcd105b9288daec4e1711042
+  metadata.gz: 7803ffccc51d051d2f3b5d0a7da4e8d7fea88eb9595e62308696c494944f7060
+  data.tar.gz: d155ec22668921f66bc68f47fdbea39f1c903a55930b4beb783d1008205a36fb
 SHA512:
-  metadata.gz: 0fbddcca87baec1bf16d14c34e0b92bfbace2050bad8d67d479ad41af76563bf7716f3b45e3cba31d8989a3517bdddcfcbdf39e7cb455c3d6ce8c35a3b973632
-  data.tar.gz: e926410535fa00cbc7f8d6247536f8faaba79fb2477e411a45028b0705d1ec982d09c264c4bab510aca63b51c9306864dc167e73a19d40d7ea4cf5ed4566f7c5
+  metadata.gz: fe21b8ace849f3ac2cffeb18654c656a661072d59bc79ff10b3566cd7d1dd02ff0d569b9cf4070762eb87142bcd79f933d4e07d049e9c41b1a336d03aa0043cf
+  data.tar.gz: e89c735142719ce6dcba23c4c631991825d57c8f2f6d50d88fa8941e712794812a648a2d7894522f7fc32fd157a460e72e38609b8401cb2455b2db9fbe7dc19e

data/.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,41 @@
+name: Bug
+description: File a bug report
+title: "[BUG]: "
+labels: ["Type: Bug", "Status: Triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: What did you do? What happened? What did you expect to happen?
+      placeholder: Put your description of the bug here.
+    validations:
+      required: true
+  - type: textarea
+    id: versions
+    attributes:
+      label: Versions
+      description: What versions of the relevant software are you running?
+      placeholder: Octokit.js v2.0.10, Node v16.18.0
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: |
+        Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+        Please check your logs before submission to ensure sensitive information is redacted.
+      render: shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

data/.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,49 @@
+name: Documentation
+description: Update or add documentation
+title: "[DOCS]: "
+labels: ["Type: Documentation", "Status: Triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill this out!
+  - type: textarea
+    id: describe-need
+    attributes:
+      label: Describe the need
+      description: What do you wish was different about our docs?
+      placeholder: Describe the need for documentation updates here.
+    validations:
+      required: true
+  - type: input
+    id: sdk_version
+    attributes:
+      label: SDK Version
+      description: Do these docs apply to a specific SDK version?
+      placeholder: Octokit.NET v4.0.1
+    validations:
+      required: false
+  - type: input
+    id: api_version
+    attributes:
+      label: API Version
+      description: Do these docs apply to a specific version of the GitHub REST API or GraphQL API?
+      placeholder: ex. v1.1.1
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: |
+        Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+        Please check your logs before submission to ensure sensitive information is redacted.
+      render: shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

data/.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,49 @@
+name: Feature
+description: Suggest an idea for a new feature or enhancement
+title: "[FEAT]: "
+labels: ["Type: Feature", "Status: Triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill this out!
+  - type: textarea
+    id: describe-need
+    attributes:
+      label: Describe the need
+      description: What do you want to happen? What problem are you trying to solve?
+      placeholder: Describe the need for the feature.
+    validations:
+      required: true
+  - type: input
+    id: sdk_version
+    attributes:
+      label: SDK Version
+      description: Does this feature suggestion apply to a specific SDK version?
+      placeholder: Octokit.rb v6.0.0
+    validations:
+      required: false
+  - type: input
+    id: api_version
+    attributes:
+      label: API Version
+      description: Does this feature suggestion apply to a specific version of the GitHub REST API or GraphQL API?
+      placeholder: ex. v1.1.1
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: |
+        Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+        Please check your logs before submission to ensure sensitive information is redacted.
+      render: shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

data/.github/ISSUE_TEMPLATE/maintenance.yml

@@ -0,0 +1,49 @@
+name: Maintenance
+description: Dependencies, cleanup, refactoring, reworking of code
+title: "[MAINT]: "
+labels: ["Type: Maintenance", "Status: Triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill this out!
+  - type: textarea
+    id: describe-need
+    attributes:
+      label: Describe the need
+      description: What do you want to happen?
+      placeholder: Describe the maintenance need here.
+    validations:
+      required: true
+  - type: input
+    id: sdk_version
+    attributes:
+      label: SDK Version
+      description: Does this maintenance apply to a specific SDK version?
+      placeholder: terraform-provider-github v5.7.0
+    validations:
+      required: false
+  - type: input
+    id: api_version
+    attributes:
+      label: API Version
+      description: Does this maintenance apply to a specific version of the GitHub REST API or GraphQL API?
+      placeholder: ex. v1.1.1
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: |
+        Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+        Please check your logs before submission to ensure sensitive information is redacted.
+      render: shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

data/.github/pull_request_template.md

@@ -0,0 +1,30 @@
+<!-- Please refer to our contributing docs for any questions on submitting a pull request -->
+<!-- Issues are required for both bug fixes and features. -->
+Resolves #ISSUE_NUMBER
+
+----
+
+### Before the change?
+<!-- Please describe the current behavior that you are modifying. -->
+
+* 
+
+### After the change?
+<!-- Please describe the behavior or changes that are being added by this PR. -->
+
+* 
+
+### Pull request checklist
+- [ ] Tests for the changes have been added (for bug fixes / features)
+- [ ] Docs have been reviewed and added / updated if needed (for bug fixes / features)
+
+### Does this introduce a breaking change?
+<!-- If this introduces a breaking change make sure to note it here any what the impact might be -->
+
+Please see our docs on [breaking changes](https://github.com/octokit/.github/blob/master/community/breaking_changes.md) to help!
+
+- [ ] Yes
+- [ ] No
+
+----
+

data/.github/workflows/add_to_octokit_project.yml

@@ -0,0 +1,20 @@
+name: Add PRs and issues to Octokit org project
+
+on:
+  issues:
+    types: [reopened, opened]
+  pull_request_target:
+    types: [reopened, opened]
+
+jobs:
+  add-to-project:
+    name: Add issue to project
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - uses: actions/add-to-project@v0.4.0
+        with:
+          project-url: https://github.com/orgs/octokit/projects/10
+          github-token: ${{ secrets.OCTOKITBOT_PROJECT_ACTION_TOKEN }}
+          labeled: "Status: Stale"
+          label-operator: NOT

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '44 8 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.github/workflows/immediate-response.yml

@@ -0,0 +1,28 @@
+name: Issue/PR response
+permissions:
+  issues: write
+  pull-requests: write
+on:
+  issues:
+    types:
+      - opened
+  pull_request:
+    types:
+      - opened
+jobs:
+  respond-to-issue:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Determine issue or PR number
+        id: extract
+        run: echo "NUMBER=${{ github.event.issue.number || github.event.pull_request.number }}" >> "$GITHUB_OUTPUT"
+
+      - name: Respond to issue or PR
+        uses: peter-evans/create-or-update-comment@6534843181fc2aeb7f9f1cd3cd4a7b956cada2db
+        with:
+          issue-number: ${{ steps.extract.outputs.NUMBER }}
+          body: >
+            👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday!
+            We have a [process in place](https://github.com/octokit/.github/blob/main/community/prioritization_response.md#overview) for prioritizing and responding to your input. 
+            Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with `Status: Up for grabs`.
+            You & others like you are the reason all of this works! So thank you & happy coding! 🚀

data/.github/workflows/ruby.yml

@@ -8,11 +8,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
     - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: 2.6
     - name: Build and test with Rake
       run: |
         gem install bundler:2.2.33

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    octopoller (0.3.0)
+    octopoller (0.3.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -43,6 +43,7 @@ Octopoller exposes a single function `poll`. Here is what the API looks like:
 #
 # wait      - The time delay in seconds between polls (default is 1 second)
 #           - When given the argument `:exponentially` the action will be retried with exponetial backoff
+#           - When given 0, false or nil, the action will be retried without wait
 # timeout   - The maximum number of seconds the poller will execute
 # retries   - The maximum number of times the action will be retried
 # yield     - A block that will execute, and if `:re_poll` is returned it will re-run
@@ -70,7 +71,7 @@ Here's what using Octpoller is like for each of the use cases listed above:
   # => "🦑"
   # => "🦑"
   # ... (for 15 seconds)
-  # Timed out patiently (Octopoller::TimeOutError)
+  # Timed out patiently (Octopoller::TimeoutError)
   ```
 
 * Poll with retries:
@@ -118,4 +119,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Octopoller project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/octokit/octopoller.rb/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Octopoller project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/octokit/octopoller.rb/blob/main/CODE_OF_CONDUCT.md).

data/RELEASE.md

@@ -1,13 +1,13 @@
 # Releasing a new version of octopoller.rb
 
 1. Create a list of all the changes since the prior release
-    1. Compare the previous release to `master` using `https://github.com/octokit/octopoller.rb/compare/`v1.3.3.7...master` (assuming that the last release was `v1.3.3.7`)
+    1. Compare the previous release to `main` using `https://github.com/octokit/octopoller.rb/compare/`v1.3.3.7...main` (assuming that the last release was `v1.3.3.7`)
 2. Ensure there are no breaking changes _(if there are breaking changes you'll need to create a release branch without those changes or bump the major version)_
 3. Update the version
-    1. Checkout `master`
+    1. Checkout `main`
     2. Update the constant in `lib/octopoller/version.rb` (when `bundle` is executed the version in the `Gemfile.lock` will be updated)
     3. Run `bin/setup` so that `Gemfile.lock` will be updated with the new version
-    4. Commit and push directly to `master`
+    4. Commit and push directly to `main`
 5. (Optional) Run `script/release` with no parameters to execute a dry run of a release
 6. Run the `script/release -r` script to cut a release (this will also run `script/validate` to perform the permission check)
 7. Draft a new release at <https://github.com/octokit/octopoller.rb/releases/new> containing the changelog from step 1

data/SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+Thanks for helping make GitHub Open Source Software safe for everyone.
+
+GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as [Octokit](https://github.com/octokit).
+
+Even though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we want to make sure that your finding gets passed along to the maintainers of this project for remediation. 
+
+
+## Reporting a Vulnerability
+
+Since octopoller is part of [Octokit](https://github.com/octokit) (a GitHub organization) we ask that you follow the guidelines [here](https://github.com/github/.github/blob/master/SECURITY.md#reporting-security-issues) to report anything that you might've found.
+

data/lib/octopoller/version.rb

@@ -1,3 +1,3 @@
 module Octopoller
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/octopoller.rb

@@ -16,6 +16,8 @@ module Octopoller
   # raise     - Raises an Octopoller::TimeoutError if the timeout is reached
   # raise     - Raises an Octopoller::TooManyAttemptsError if the retries is reached
   def poll(wait: 1, timeout: nil, retries: nil)
+    wait = 0 if [nil, false].include?(wait)
+
     Octopoller.validate_arguments(wait, timeout, retries)
     exponential_backoff = (wait == :exponentially)
 
@@ -45,7 +47,7 @@ module Octopoller
       raise ArgumentError, "Must pass an argument to either `timeout` or `retries`"
     end
     exponential_backoff = wait == :exponentially
-    raise ArgumentError, "Cannot wait backwards in time" unless exponential_backoff || wait.positive?
+    raise ArgumentError, "Cannot wait backwards in time" if !exponential_backoff && wait.negative?
     raise ArgumentError, "Timed out without even being able to try" if timeout&.negative?
     raise ArgumentError, "Cannot retry something a negative number of times" if retries&.negative?
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopoller
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - BenEmdon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2023-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,8 +60,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/ISSUE_TEMPLATE/bug.yml"
+- ".github/ISSUE_TEMPLATE/documentation.yml"
+- ".github/ISSUE_TEMPLATE/feature.yml"
+- ".github/ISSUE_TEMPLATE/maintenance.yml"
+- ".github/pull_request_template.md"
+- ".github/workflows/add_to_octokit_project.yml"
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/immediate-response.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
@@ -74,6 +80,7 @@ files:
 - README.md
 - RELEASE.md
 - Rakefile
+- SECURITY.md
 - bin/console
 - bin/setup
 - lib/octopoller.rb
@@ -101,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: A Ruby gem for polling and retrying actions

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,35 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.