bugsnag-api 3.0.0 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
 - data/.github/ISSUE_TEMPLATE/A.md +4 -4
 - data/.github/ISSUE_TEMPLATE/bug_report.md +1 -1
 - data/.github/ISSUE_TEMPLATE/feature_request.md +1 -1
 - data/.github/SUPPORT.md +19 -0
 - data/CHANGELOG.md +7 -0
 - data/README.md +2 -2
 - data/SECURITY.md +5 -0
 - data/lib/bugsnag/api/client/errors.rb +1 -1
 - data/lib/bugsnag/api/version.rb +1 -1
 - data/spec/bugsnag/api/client/errors_spec.rb +2 -2
 - metadata +8 -7
 - data/.github/support.md +0 -19
 
    
        checksums.yaml
    CHANGED
    
    | 
         @@ -1,7 +1,7 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            ---
         
     | 
| 
       2 
2 
     | 
    
         
             
            SHA256:
         
     | 
| 
       3 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       4 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 3 
     | 
    
         
            +
              metadata.gz: aeb56132e45bd00fe643a35e955ecebd8d98eeb8ec3dd8f0e5f5cd7523b6573e
         
     | 
| 
      
 4 
     | 
    
         
            +
              data.tar.gz: d508f930c10ba5a9e8afcea2dc4c7395762da65fb6d5427ff03737c6d5fdfec0
         
     | 
| 
       5 
5 
     | 
    
         
             
            SHA512:
         
     | 
| 
       6 
     | 
    
         
            -
              metadata.gz:  
     | 
| 
       7 
     | 
    
         
            -
              data.tar.gz:  
     | 
| 
      
 6 
     | 
    
         
            +
              metadata.gz: d04bc0203ad87c1a25e96669d802150d080119b6275231d13d87d72e741d78a823aec246ae9fd5abad5520c4f6c9568ca3f0062efc8ad6b43bf650dcb62c58db
         
     | 
| 
      
 7 
     | 
    
         
            +
              data.tar.gz: a29144268e0157098236a3ad9915d20f027b8551b79fb82015eb739e44844834b187bbe10f8de9c5d67debee1629a466b4236775d7d007bb29e1aec5ede9bf8d
         
     | 
    
        data/.github/ISSUE_TEMPLATE/A.md
    CHANGED
    
    | 
         @@ -1,14 +1,14 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            ---
         
     | 
| 
       2 
2 
     | 
    
         
             
            name: Having trouble getting started?
         
     | 
| 
       3 
     | 
    
         
            -
            about: Please contact us at support@bugsnag.com for assistance with integrating  
     | 
| 
      
 3 
     | 
    
         
            +
            about: Please contact us at support@bugsnag.com for assistance with integrating BugSnag
         
     | 
| 
       4 
4 
     | 
    
         
             
              into your application.
         
     | 
| 
       5 
5 
     | 
    
         
             
            title: ''
         
     | 
| 
       6 
6 
     | 
    
         
             
            labels: ''
         
     | 
| 
       7 
7 
     | 
    
         
             
            assignees: ''
         
     | 
| 
       8 
8 
     | 
    
         | 
| 
       9 
9 
     | 
    
         
             
            ---
         
     | 
| 
       10 
     | 
    
         
            -
            Please  
     | 
| 
      
 10 
     | 
    
         
            +
            Please check out our [documentation](https://docs.bugsnag.com/api/data-access/#ruby-api-toolkit) for guides, references and tutorials.
         
     | 
| 
       11 
11 
     | 
    
         | 
| 
       12 
     | 
    
         
            -
            If you have questions about your integration please contact us at [support@bugsnag.com](mailto:support@bugsnag.com).
         
     | 
| 
      
 12 
     | 
    
         
            +
            If you have questions about your integration, please contact us at [support@bugsnag.com](mailto:support@bugsnag.com).
         
     | 
| 
       13 
13 
     | 
    
         | 
| 
       14 
     | 
    
         
            -
            Alternatively, view additional options at [ 
     | 
| 
      
 14 
     | 
    
         
            +
            Alternatively, view additional options at [SUPPORT.md](../SUPPORT.md).
         
     | 
| 
         @@ -7,7 +7,7 @@ assignees: '' 
     | 
|
| 
       7 
7 
     | 
    
         | 
| 
       8 
8 
     | 
    
         
             
            ---
         
     | 
| 
       9 
9 
     | 
    
         | 
| 
       10 
     | 
    
         
            -
            <!-- Before raising, please check  
     | 
| 
      
 10 
     | 
    
         
            +
            <!-- Before raising, please check whether somebody else has already reported your issue. -->
         
     | 
| 
       11 
11 
     | 
    
         | 
| 
       12 
12 
     | 
    
         
             
            ### Describe the bug
         
     | 
| 
       13 
13 
     | 
    
         
             
            A clear and concise description of what the bug is.
         
     | 
| 
         @@ -7,7 +7,7 @@ assignees: '' 
     | 
|
| 
       7 
7 
     | 
    
         | 
| 
       8 
8 
     | 
    
         
             
            ---
         
     | 
| 
       9 
9 
     | 
    
         | 
| 
       10 
     | 
    
         
            -
            <!-- Before creating, please check  
     | 
| 
      
 10 
     | 
    
         
            +
            <!-- Before creating, please check whether somebody else has already reported your feature request. -->
         
     | 
| 
       11 
11 
     | 
    
         | 
| 
       12 
12 
     | 
    
         
             
            ### Description
         
     | 
| 
       13 
13 
     | 
    
         
             
            <!-- Is your feature request related to a problem? Please describe.
         
     | 
    
        data/.github/SUPPORT.md
    ADDED
    
    | 
         @@ -0,0 +1,19 @@ 
     | 
|
| 
      
 1 
     | 
    
         
            +
            ## Are you having trouble getting started?
         
     | 
| 
      
 2 
     | 
    
         
            +
            If you haven't already, please check out our [documentation](https://docs.bugsnag.com/api/data-access/#ruby-api-toolkit) for guides, references and tutorials.
         
     | 
| 
      
 3 
     | 
    
         
            +
             
     | 
| 
      
 4 
     | 
    
         
            +
            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 if you have a question about our supported features.
         
     | 
| 
      
 5 
     | 
    
         
            +
             
     | 
| 
      
 6 
     | 
    
         
            +
            When contacting support, please include as much information as necessary, including:
         
     | 
| 
      
 7 
     | 
    
         
            +
             
     | 
| 
      
 8 
     | 
    
         
            +
            - example code snippet
         
     | 
| 
      
 9 
     | 
    
         
            +
            - steps to reproduce
         
     | 
| 
      
 10 
     | 
    
         
            +
            - expected/actual behaviour 
         
     | 
| 
      
 11 
     | 
    
         
            +
             
     | 
| 
      
 12 
     | 
    
         
            +
            * Ruby version:
         
     | 
| 
      
 13 
     | 
    
         
            +
             
     | 
| 
      
 14 
     | 
    
         
            +
            ## Bug or Feature Requests
         
     | 
| 
      
 15 
     | 
    
         
            +
            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.
         
     | 
| 
      
 16 
     | 
    
         
            +
            Please note: we cannot promise that we will fulfil all requests
         
     | 
| 
      
 17 
     | 
    
         
            +
             
     | 
| 
      
 18 
     | 
    
         
            +
            ## Pull Requests
         
     | 
| 
      
 19 
     | 
    
         
            +
            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/CHANGELOG.md
    CHANGED
    
    
    
        data/README.md
    CHANGED
    
    | 
         @@ -117,7 +117,7 @@ account.rels[:upgrade].href 
     | 
|
| 
       117 
117 
     | 
    
         
             
            Resources returned by Bugsnag API methods contain not only data but hypermedia link relations:
         
     | 
| 
       118 
118 
     | 
    
         | 
| 
       119 
119 
     | 
    
         
             
            ```ruby
         
     | 
| 
       120 
     | 
    
         
            -
            project = Bugsnag::Api.projects("organization-id")
         
     | 
| 
      
 120 
     | 
    
         
            +
            project = Bugsnag::Api.projects("organization-id").first
         
     | 
| 
       121 
121 
     | 
    
         | 
| 
       122 
122 
     | 
    
         
             
            # Get the users rel, returned from the API as users_url in the resource
         
     | 
| 
       123 
123 
     | 
    
         
             
            project.rels[:errors].href
         
     | 
| 
         @@ -166,7 +166,7 @@ end 
     | 
|
| 
       166 
166 
     | 
    
         | 
| 
       167 
167 
     | 
    
         
             
            ### Filtering
         
     | 
| 
       168 
168 
     | 
    
         | 
| 
       169 
     | 
    
         
            -
            Events and Errors can be filtered to return a subset of data. Any of the filters usable in the Bugsnag  
     | 
| 
      
 169 
     | 
    
         
            +
            Events and Errors can be filtered to return a subset of data. Any of the filters usable in the Bugsnag dashboard 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.
         
     | 
| 
       170 
170 
     | 
    
         | 
| 
       171 
171 
     | 
    
         
             
            | `type` | Description | Multiple value combination logic |
         
     | 
| 
       172 
172 
     | 
    
         
             
            |-|-|-|
         
     | 
    
        data/SECURITY.md
    ADDED
    
    
| 
         @@ -42,7 +42,7 @@ module Bugsnag 
     | 
|
| 
       42 
42 
     | 
    
         
             
                      when String
         
     | 
| 
       43 
43 
     | 
    
         
             
                        patch "projects/#{project_id}/errors/#{ids}", options.merge({:operation => operation})
         
     | 
| 
       44 
44 
     | 
    
         
             
                      when Array
         
     | 
| 
       45 
     | 
    
         
            -
                        defaults = {:operation => operation, :query => {:error_ids => ids 
     | 
| 
      
 45 
     | 
    
         
            +
                        defaults = {:operation => operation, :query => {:error_ids => ids}}
         
     | 
| 
       46 
46 
     | 
    
         
             
                        merged_opts = deep_merge(defaults, options)
         
     | 
| 
       47 
47 
     | 
    
         
             
                        patch "projects/#{project_id}/errors", merged_opts
         
     | 
| 
       48 
48 
     | 
    
         
             
                      else
         
     | 
    
        data/lib/bugsnag/api/version.rb
    CHANGED
    
    
| 
         @@ -42,11 +42,11 @@ describe Bugsnag::Api::Client::Errors do 
     | 
|
| 
       42 
42 
     | 
    
         
             
                end
         
     | 
| 
       43 
43 
     | 
    
         | 
| 
       44 
44 
     | 
    
         
             
                it "updates and returns the updated errors" do
         
     | 
| 
       45 
     | 
    
         
            -
                  errors = @client.update_errors @project_id, [@error_id], "fix", {:severity => "warn"}
         
     | 
| 
      
 45 
     | 
    
         
            +
                  errors = @client.update_errors @project_id, [@error_id, @error_id], "fix", {:severity => "warn"}
         
     | 
| 
       46 
46 
     | 
    
         
             
                  expect(errors.operation).to_not be_nil
         
     | 
| 
       47 
47 
     | 
    
         
             
                  expect(errors[@error_id].status).to eq("fixed")
         
     | 
| 
       48 
48 
     | 
    
         | 
| 
       49 
     | 
    
         
            -
                  assert_requested :patch, bugsnag_url("/projects/#{@project_id}/errors?error_ids=#{@error_id}")
         
     | 
| 
      
 49 
     | 
    
         
            +
                  assert_requested :patch, bugsnag_url("/projects/#{@project_id}/errors?error_ids[]=#{@error_id}&error_ids[]=#{@error_id}")
         
     | 
| 
       50 
50 
     | 
    
         
             
                end
         
     | 
| 
       51 
51 
     | 
    
         
             
              end
         
     | 
| 
       52 
52 
     | 
    
         | 
    
        metadata
    CHANGED
    
    | 
         @@ -1,14 +1,14 @@ 
     | 
|
| 
       1 
1 
     | 
    
         
             
            --- !ruby/object:Gem::Specification
         
     | 
| 
       2 
2 
     | 
    
         
             
            name: bugsnag-api
         
     | 
| 
       3 
3 
     | 
    
         
             
            version: !ruby/object:Gem::Version
         
     | 
| 
       4 
     | 
    
         
            -
              version: 3.0. 
     | 
| 
      
 4 
     | 
    
         
            +
              version: 3.0.1
         
     | 
| 
       5 
5 
     | 
    
         
             
            platform: ruby
         
     | 
| 
       6 
6 
     | 
    
         
             
            authors:
         
     | 
| 
       7 
7 
     | 
    
         
             
            - James Smith
         
     | 
| 
       8 
     | 
    
         
            -
            autorequire: 
     | 
| 
      
 8 
     | 
    
         
            +
            autorequire:
         
     | 
| 
       9 
9 
     | 
    
         
             
            bindir: bin
         
     | 
| 
       10 
10 
     | 
    
         
             
            cert_chain: []
         
     | 
| 
       11 
     | 
    
         
            -
            date:  
     | 
| 
      
 11 
     | 
    
         
            +
            date: 2025-01-27 00:00:00.000000000 Z
         
     | 
| 
       12 
12 
     | 
    
         
             
            dependencies:
         
     | 
| 
       13 
13 
     | 
    
         
             
            - !ruby/object:Gem::Dependency
         
     | 
| 
       14 
14 
     | 
    
         
             
              name: sawyer
         
     | 
| 
         @@ -148,7 +148,7 @@ files: 
     | 
|
| 
       148 
148 
     | 
    
         
             
            - ".github/ISSUE_TEMPLATE/bug_report.md"
         
     | 
| 
       149 
149 
     | 
    
         
             
            - ".github/ISSUE_TEMPLATE/feature_request.md"
         
     | 
| 
       150 
150 
     | 
    
         
             
            - ".github/PULL_REQUEST_TEMPLATE.md"
         
     | 
| 
       151 
     | 
    
         
            -
            - ".github/ 
     | 
| 
      
 151 
     | 
    
         
            +
            - ".github/SUPPORT.md"
         
     | 
| 
       152 
152 
     | 
    
         
             
            - ".github/workflows/tests.yml"
         
     | 
| 
       153 
153 
     | 
    
         
             
            - ".gitignore"
         
     | 
| 
       154 
154 
     | 
    
         
             
            - ".rspec"
         
     | 
| 
         @@ -161,6 +161,7 @@ files: 
     | 
|
| 
       161 
161 
     | 
    
         
             
            - LICENSE.txt
         
     | 
| 
       162 
162 
     | 
    
         
             
            - README.md
         
     | 
| 
       163 
163 
     | 
    
         
             
            - Rakefile
         
     | 
| 
      
 164 
     | 
    
         
            +
            - SECURITY.md
         
     | 
| 
       164 
165 
     | 
    
         
             
            - bugsnag-api.gemspec
         
     | 
| 
       165 
166 
     | 
    
         
             
            - config/.gitignore
         
     | 
| 
       166 
167 
     | 
    
         
             
            - docker-compose.yml
         
     | 
| 
         @@ -249,7 +250,7 @@ homepage: https://github.com/bugsnag/bugsnag-api-ruby 
     | 
|
| 
       249 
250 
     | 
    
         
             
            licenses:
         
     | 
| 
       250 
251 
     | 
    
         
             
            - MIT
         
     | 
| 
       251 
252 
     | 
    
         
             
            metadata: {}
         
     | 
| 
       252 
     | 
    
         
            -
            post_install_message: 
     | 
| 
      
 253 
     | 
    
         
            +
            post_install_message:
         
     | 
| 
       253 
254 
     | 
    
         
             
            rdoc_options: []
         
     | 
| 
       254 
255 
     | 
    
         
             
            require_paths:
         
     | 
| 
       255 
256 
     | 
    
         
             
            - lib
         
     | 
| 
         @@ -264,8 +265,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement 
     | 
|
| 
       264 
265 
     | 
    
         
             
                - !ruby/object:Gem::Version
         
     | 
| 
       265 
266 
     | 
    
         
             
                  version: '0'
         
     | 
| 
       266 
267 
     | 
    
         
             
            requirements: []
         
     | 
| 
       267 
     | 
    
         
            -
            rubygems_version: 3. 
     | 
| 
       268 
     | 
    
         
            -
            signing_key: 
     | 
| 
      
 268 
     | 
    
         
            +
            rubygems_version: 3.5.22
         
     | 
| 
      
 269 
     | 
    
         
            +
            signing_key:
         
     | 
| 
       269 
270 
     | 
    
         
             
            specification_version: 4
         
     | 
| 
       270 
271 
     | 
    
         
             
            summary: Bugsnag API toolkit for ruby
         
     | 
| 
       271 
272 
     | 
    
         
             
            test_files:
         
     | 
    
        data/.github/support.md
    DELETED
    
    | 
         @@ -1,19 +0,0 @@ 
     | 
|
| 
       1 
     | 
    
         
            -
            ## Are you having trouble getting started?
         
     | 
| 
       2 
     | 
    
         
            -
            If you haven't already, please checkout our [documentation](https://docs.bugsnag.com/api/data-access/#ruby-api-toolkit) for guides, references and tutorials.
         
     | 
| 
       3 
     | 
    
         
            -
             
     | 
| 
       4 
     | 
    
         
            -
            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.
         
     | 
| 
       5 
     | 
    
         
            -
             
     | 
| 
       6 
     | 
    
         
            -
            When contacting support, please include as much information as necessary, including:
         
     | 
| 
       7 
     | 
    
         
            -
             
     | 
| 
       8 
     | 
    
         
            -
            - example code snippet
         
     | 
| 
       9 
     | 
    
         
            -
            - steps to reproduce
         
     | 
| 
       10 
     | 
    
         
            -
            - expected/actual behaviour 
         
     | 
| 
       11 
     | 
    
         
            -
             
     | 
| 
       12 
     | 
    
         
            -
            * Ruby version:
         
     | 
| 
       13 
     | 
    
         
            -
             
     | 
| 
       14 
     | 
    
         
            -
            ## Bug or Feature Requests
         
     | 
| 
       15 
     | 
    
         
            -
            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.
         
     | 
| 
       16 
     | 
    
         
            -
            Please note: we cannot promise that we will fulfil all requests
         
     | 
| 
       17 
     | 
    
         
            -
             
     | 
| 
       18 
     | 
    
         
            -
            ## Pull Requests
         
     | 
| 
       19 
     | 
    
         
            -
            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.
         
     |