bugsnag-api 2.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4616f90142beb5163ce325dee92a393d3b990bac
-  data.tar.gz: 0e1f46dd0c4543abaf73fd39a6bd63fc9028ab80
+SHA256:
+  metadata.gz: 617f27c61db7b75cecc854aeeca930e461ce849c48ce5f9fba4ee072639781c4
+  data.tar.gz: 84358e937d507d8abc75aa9971f99e9bba6a350e8292b8a3bf21d8a03d58ad33
 SHA512:
-  metadata.gz: c5b44534d8d0b639c054ad67402fcd4d25bb8c2f985e06019135c36868cdddc518d2915a88eefc7fed3e0b5da76dc4cba79473fd92ab68f28ea54b7002362557
-  data.tar.gz: fd9c7470df57b829520e4deb9609e1e3414da9e6d4f7e261ca8cb2b1253a596e3bef1668621cc2411eae805d4a765379056092423cd94e4dcaeec9763b37536a
+  metadata.gz: d0779c59b38cc5735a8074489df90f0ca74f34dea5a3e38e2f957ff4735aa396005e5f607c51905107d3f7f848f5226323b84e01a2e3b564ecd01df8b8151b65
+  data.tar.gz: f1db01abc52ef8289b21de312634ecc516214bf0805f4be2063f87deb37ec3fdc70028e435ab93bc9d371e0b84beeff513f4843613c0dc3eb912fc4f9c3e3da6

data/.buildkite/pipeline.yml

@@ -0,0 +1,6 @@
+steps:
+  - name: ':copyright: License Audit'
+    plugins:
+      docker-compose#v3.7.0:
+        run: license_finder
+    command: /bin/bash -lc '/scan/scripts/license_finder.sh'

data/.github/ISSUE_TEMPLATE/A.md

@@ -0,0 +1,14 @@
+---
+name: Having trouble getting started?
+about: Please contact us at support@bugsnag.com for assistance with integrating Bugsnag
+  into your application.
+title: ''
+labels: ''
+assignees: ''
+
+---
+Please checkout our [documentation](https://docs.bugsnag.com/api/data-access/#ruby-api-toolkit) for guides, references and tutorials.
+
+If you have questions about your integration please contact us at [support@bugsnag.com](mailto:support@bugsnag.com).
+
+Alternatively, view additional options at [support.md](../SUPPORT.md).

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,47 @@
+---
+name: Bug report
+about: Create a report to help us improve the library
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!-- Before raising, please check if somebody else has already reported your issue. -->
+
+### Describe the bug
+A clear and concise description of what the bug is.
+
+### Steps to reproduce
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Environment
+* Ruby version:
+
+<!--
+  Below are a few approaches you might take to communicate the issue, in
+  descending order of awesomeness. Please choose one and feel free to delete
+  the others from this template.
+-->
+
+### Example Repo <!-- Option 1 -->
+
+- [ ] Create a minimal repository that can reproduce the issue
+- [ ] Link to it here:
+
+### Example code snippet <!-- Option 2 -->
+
+```
+# (Insert code sample to reproduce the problem)
+```
+
+<!-- Error messages, if any -->
+<details><summary>Error messages:</summary>
+
+```
+
+```
+</details>

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!-- Before creating, please check if somebody else has already reported your feature request. -->
+
+### Description
+<!-- 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 about the feature request here.-->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+## Goal
+
+<!-- Why is this change necessary? -->
+
+## Design
+
+<!-- Why was this approach used? -->
+
+## Changeset
+
+<!-- What changed? -->
+
+## Testing
+
+<!-- How was it tested? What manual and automated tests were
+     run/added? -->

data/.github/support.md

@@ -0,0 +1,19 @@
+## Are you having trouble getting started?
+If you haven't already, please checkout our [documentation](https://docs.bugsnag.com/api/data-access/#ruby-api-toolkit) for guides, references and tutorials.
+
+Or, if you wish you can [contact us directly](mailto:support@bugsnag.com) for assistance on integrating Bugsnag into your application, troubleshooting an issue or a question about our supported features.
+
+When contacting support, please include as much information as necessary, including:
+
+- example code snippet
+- steps to reproduce
+- expected/actual behaviour 
+
+* Ruby version:
+
+## Bug or Feature Requests
+If you would like to raise a bug or feature request please do so by creating a [New Issue](https://github.com/bugsnag/bugsnag-api-ruby/issues/new/choose) and selecting bug or feature.
+Please note: we cannot promise that we will fulfil all requests
+
+## Pull Requests
+If you have made a fix and would like to raise a pull request, please read our [CONTRIBUTING.md](../CONTRIBUTING.md) file before creating the pull request.

data/.github/workflows/tests.yml

@@ -0,0 +1,53 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  specs:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.1', '2.2', '2.3', '2.4', '2.5', '2.6', '2.7', '3.0']
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - run: bundle exec rake spec
+
+  linting:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0'
+          bundler-cache: true
+
+      - run: bundle exec rubocop lib/
+
+  # Ruby 1.9 and 2.0 aren't supported by setup-ruby so we have to use Docker instead
+  legacy:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['1.9', '2.0']
+
+    container: ruby:${{ matrix.ruby-version }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - run: bundle install
+
+      - run: bundle exec rake spec

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/ClassLength:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,271 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-02-20 14:31:40 +0000 using RuboCop version 0.52.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLines:
+  Exclude:
+    - 'lib/bugsnag/api.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Layout/EmptyLinesAroundAccessModifier:
+  Exclude:
+    - 'lib/bugsnag/api.rb'
+    - 'lib/bugsnag/api/client.rb'
+    - 'lib/bugsnag/api/response/raise_error.rb'
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/bugsnag/api/client/collaborators.rb'
+    - 'lib/bugsnag/api/client/comments.rb'
+    - 'lib/bugsnag/api/client/currentuser.rb'
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/eventfields.rb'
+    - 'lib/bugsnag/api/client/events.rb'
+    - 'lib/bugsnag/api/client/organizations.rb'
+    - 'lib/bugsnag/api/client/pivots.rb'
+    - 'lib/bugsnag/api/client/projects.rb'
+    - 'lib/bugsnag/api/client/trends.rb'
+    - 'lib/bugsnag/api/error.rb'
+    - 'lib/bugsnag/api/response/raise_error.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'lib/bugsnag/api.rb'
+    - 'lib/bugsnag/api/client.rb'
+    - 'lib/bugsnag/api/configuration.rb'
+    - 'lib/bugsnag/api/response/raise_error.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: aligned, indented
+Layout/MultilineOperationIndentation:
+  Exclude:
+    - 'lib/bugsnag/api/error.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/SpaceAfterComma:
+  Exclude:
+    - 'lib/bugsnag/api/configuration.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/SpaceAroundEqualsInParameterDefault:
+  Exclude:
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/pivots.rb'
+    - 'lib/bugsnag/api/client/trends.rb'
+    - 'lib/bugsnag/api/error.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: no_space
+
+# Offense count: 34
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'lib/bugsnag/api/client.rb'
+    - 'lib/bugsnag/api/client/collaborators.rb'
+    - 'lib/bugsnag/api/client/comments.rb'
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/eventfields.rb'
+    - 'lib/bugsnag/api/client/organizations.rb'
+    - 'lib/bugsnag/api/client/projects.rb'
+    - 'lib/bugsnag/api/client/trends.rb'
+
+# Offense count: 17
+# Cop supports --auto-correct.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/bugsnag/api/client/collaborators.rb'
+    - 'lib/bugsnag/api/client/currentuser.rb'
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/eventfields.rb'
+    - 'lib/bugsnag/api/client/events.rb'
+    - 'lib/bugsnag/api/client/organizations.rb'
+    - 'lib/bugsnag/api/client/pivots.rb'
+    - 'lib/bugsnag/api/client/projects.rb'
+    - 'lib/bugsnag/api/client/trends.rb'
+
+# Offense count: 1
+Lint/AmbiguousOperator:
+  Exclude:
+    - 'lib/bugsnag/api/configuration.rb'
+
+# Offense count: 4
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/bugsnag/api/client.rb'
+    - 'lib/bugsnag/api/error.rb'
+    - 'lib/bugsnag/api/response/raise_error.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/bugsnag/api/client.rb'
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/eventfields.rb'
+
+# Offense count: 1
+Lint/UriEscapeUnescape:
+  Exclude:
+    - 'lib/bugsnag/api/client.rb'
+
+# Offense count: 2
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/bugsnag/api/error.rb'
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 27
+
+# Offense count: 1
+# Configuration parameters: CountBlocks.
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 127
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 18
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 23
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: braces, no_braces, context_dependent
+Style/BracesAroundHashParameters:
+  Exclude:
+    - 'lib/bugsnag/api/client/collaborators.rb'
+    - 'lib/bugsnag/api/client/comments.rb'
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/eventfields.rb'
+    - 'lib/bugsnag/api/client/organizations.rb'
+    - 'lib/bugsnag/api/client/projects.rb'
+
+# Offense count: 2
+Style/DoubleNegation:
+  Exclude:
+    - 'lib/bugsnag/api/client.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty, nil, both
+Style/EmptyElse:
+  Exclude:
+    - 'lib/bugsnag/api/error.rb'
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/bugsnag/api/response/raise_error.rb'
+
+# Offense count: 26
+# Cop supports --auto-correct.
+# Configuration parameters: UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+# Offense count: 1
+Style/IfInsideElse:
+  Exclude:
+    - 'lib/bugsnag/api/client.rb'
+
+# Offense count: 1
+Style/MethodMissing:
+  Exclude:
+    - 'lib/bugsnag/api.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/bugsnag/api/configuration.rb'
+    - 'lib/bugsnag/api/version.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/bugsnag/api/configuration.rb'
+
+# Offense count: 31
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'lib/bugsnag/api.rb'
+    - 'lib/bugsnag/api/client.rb'
+    - 'lib/bugsnag/api/client/collaborators.rb'
+    - 'lib/bugsnag/api/client/currentuser.rb'
+    - 'lib/bugsnag/api/client/errors.rb'
+    - 'lib/bugsnag/api/client/organizations.rb'
+    - 'lib/bugsnag/api/configuration.rb'
+    - 'lib/bugsnag/api/error.rb'
+    - 'lib/bugsnag/api/response/raise_error.rb'
+    - 'lib/bugsnag/api/version.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: MinSize.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/UnneededInterpolation:
+  Exclude:
+    - 'lib/bugsnag/api/error.rb'
+
+# Offense count: 80
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 146

data/CHANGELOG.md

@@ -1,6 +1,40 @@
 Changelog
 =========
 
+## 2.1.1 (2 November 2021)
+
+### Fixes
+
+* Fix Faraday deprecation warning
+    | [sambostock](https://github.com/sambostock)
+    | [#36](https://github.com/bugsnag/bugsnag-api-ruby/pull/36)
+
+## 2.1.0 (28 July 2021)
+
+### Enhancements
+
+* Add stability and release endpoints
+    |  [#34](https://github.com/bugsnag/bugsnag-api-ruby/pull/34)
+
+## 2.0.3 (11 May 2021)
+
+### Fixes
+
+* Fix error handling middleware compatibility with Faraday v1.2.0 and above
+    | [askreet](https://github.com/askreet)
+    | [#30](https://github.com/bugsnag/bugsnag-api-ruby/pull/30)
+
+* Remove call to deprecated `URI.escape`
+    | [askreet](https://github.com/askreet)
+    | [#28](https://github.com/bugsnag/bugsnag-api-ruby/pull/28)
+
+## 2.0.2 (21 Feb 2018)
+
+### Fixes
+
+* Fixes issue with custom query parameters being overridden
+    | [#13](https://github.com/bugsnag/bugsnag-api-ruby/pull/13)
+
 ## 2.0.1 (15 Nov 2017)
 
 ### Fixes

data/CONTRIBUTING.md

@@ -26,7 +26,7 @@ If you're a member of the core team, follow these instructions for releasing bug
 ### Every time
 
 * Update `CHANGELOG.md`
-* Update the version number in `bugsnag-api.gemspec`
+* Update the version number in [`lib/bugsnag/api/version.rb`](./lib/bugsnag/api/version.rb)
 * Update `README.md` if necessary with changes to the interface or configuration
 * Commit/push your changes
 * Release to rubygems

data/Gemfile

@@ -1,4 +1,13 @@
 source 'https://rubygems.org'
 
+# Any :development dependencies are ignored for license auditing purposes
+group :development do
+end
+
+# Any :test dependencies are ignored for license auditing purposes
+group :test do
+end
+
 # Specify your gem's dependencies in bugsnag-api.gemspec
 gemspec
+

data/README.md

@@ -20,6 +20,7 @@ This library borrows heavily from the code and philosophies of the fantastic [Oc
   - [Accessing Related Resources](#accessing-related-resources)
   - [Authentication](#authentication)
   - [Pagination](#pagination)
+  - [Filtering](#filtering)
   - [Accessing HTTP responses](#accessing-http-responses)
 - [API Methods](#api-methods)
   - [Organizations](#organizations)
@@ -31,6 +32,8 @@ This library borrows heavily from the code and philosophies of the fantastic [Oc
   - [Pivots](#pivots)
   - [Projects](#projects)
   - [Trends](#trends)
+  - [Stability](#stability)
+  - [Releases](#releases)
 - [Advanced Configuration](#advanced-configuration)
 
 
@@ -162,6 +165,33 @@ until last_response.rels[:next].nil?
 end
 ```
 
+### Filtering
+
+Events and Errors can be filtered to return a subset of data. Any of the filters usable in the Bugsnag dashoard can be used in this API. The filter object is a hash of Event Field keys containing an array of filter values. Each filter value has a `type` and a `value` to filter on. The type determines the type of comparison that will be performed.
+
+| `type` | Description | Multiple value combination logic |
+|-|-|-|
+| `eq` | Filter for items that 'match' the value. Some fields require an exact match and some support substring matching. | OR |
+| `ne` | Filter for items that don't match the value. | AND |
+
+:warning: Note that the Event Field `search` can not be used more than once in a call.
+
+You can see the filterable fields for a project using the following snippet, after setting the `project-id` value.
+
+```ruby
+fields = Bugsnag::Api.event_fields("project-id")
+
+puts "List of the searchable fields for this project:"
+fields.each_with_index do |field,idx|
+  puts "  [#{idx}] #{field.display_id}"
+end
+# => List of the searchable fields for this project:
+# =>   [0] event
+# =>   [1] error
+# =>   [2] search
+# =>   [3] user.id
+# => ...
+```
 
 ### Accessing HTTP responses
 
@@ -186,7 +216,7 @@ documentation](http://www.rubydoc.info/gems/bugsnag-api/Bugsnag/Api/Client)
 orgs = Bugsnag::Api.organizations
 
 # Get a single organization
-org = Bugsnag::Api.organizations("organization-id")
+org = Bugsnag::Api.organization("organization-id")
 ```
 
 ### Collaborators
@@ -236,7 +266,13 @@ Bugsnag::Api.delete_comment("comment-id")
 
 ```ruby
 # List project errors
-errors = Bugsnag::Api.errors("project-id", "project-id")
+errors = Bugsnag::Api.errors("project-id", nil)
+
+# List errors with a filter (see Filtering section for more information)
+# Returns errors that match `EXC_BAD_INSTRUCTION`, this could be from the error class, message, context, or stack trace.
+errors = Bugsnag::Api.errors("project-id", nil, direction:"desc", filters: {
+  "search": [{ "type":"eq", "value":"EXC_BAD_INSTRUCTION" }]
+})
 
 # Get a single error
 error = Bugsnag::Api.error("project-id", "error-id")
@@ -261,6 +297,15 @@ events = Bugsnag::Api.events("project-id")
 # List error events
 events = Bugsnag::Api.error_events("project-id", "error-id")
 
+# List events with a filter (see Filtering section for more information)
+# Returns events with
+#   class `EXC_BAD_INSTRUCTION` OR `EXC_BAD_ACCESS`
+#   AND where the device is jailbroken
+events = Bugsnag::Api.events(PROJECT_ID, direction:"desc", filters: {
+  "event.class": [{ "type":"eq", "value":"EXC_BAD_INSTRUCTION" }, { "type":"eq", "value":"EXC_BAD_ACCESS"  }],
+  "device.jailbroken": [{ "type":"eq", "value":"false"}]
+})
+
 # Get the latest event
 event = Bugsnag::Api.latest_event("project-id", "error-id")
 
@@ -321,6 +366,36 @@ Bugsnag::Api.pivots("project-id")
 Bugsnag::Api.pivot_values("project-id", "display id")
 ```
 
+### Trends
+
+```ruby
+# list an error's trends in 5 buckets
+Bugsnag::Api.trends_buckets("project-id", 5, "error-id")
+
+# list a project's trends by resolution
+Bugsnag::Api.trends_resolution("project-id", "2h")
+```
+
+### Stability
+
+```ruby
+# view a project's stability trend
+Bugsnag::Api.stability_trend("project-id")
+```
+
+### Releases
+
+```ruby
+# list the releases in a project
+Bugsnag::Api.releases("project-id")
+
+# view a single release
+Bugsnag::Api.release("project-id", "release-id")
+
+# list the releases in a release group
+Bugsnag::Api.releases_in_group("release-group-id")
+```
+
 ## Advanced Configuration
 
 ### Endpoint