faraday_error 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 1ba848c0c1805086776b1368110caa30db4030af
4
+ data.tar.gz: 3cb424b67ae19f0c6f27bb1fe7416583ee9e22b1
5
+ SHA512:
6
+ metadata.gz: b3c5765c9c7daba82f2c6e918ea2ad003af8966f363a3502078cafff30a781483e57d7cd37f8b9e1b7fd1c786b77524b3a40d640ff3f5a6945a600821a7d655b
7
+ data.tar.gz: d4c681bc076f3b9388c82521a7984fce2693a972fd838109319caaf775b9b014ae96562fdbe3958aaa8583b367107f7f06e831c0e679aab7cdbb294bf2a4a3fe
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at jacob@boundless.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in faraday_error.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Jacob Elder
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,78 @@
1
+ # FaradayError
2
+
3
+ A [Faraday](https://github.com/lostisland/faraday) middleware for adding request parameters to your exception tracker.
4
+
5
+ ### Supports
6
+ - [Honeybadger](https://www.honeybadger.io/)
7
+ - [NewRelic](http://newrelic.com/)
8
+ - Your favorite thing, as soon as you make a pull request!
9
+
10
+ ## Installation
11
+
12
+ Add this line to your application's Gemfile:
13
+
14
+ ```ruby
15
+ gem 'faraday_error'
16
+ ```
17
+
18
+ And then execute:
19
+
20
+ $ bundle
21
+
22
+ Or install it yourself as:
23
+
24
+ $ gem install faraday_error
25
+
26
+ ## Usage
27
+
28
+ Configure your Faraday connection to use this middleware. You can optionally specify a name; defaults to `faraday`. It is expected that you also use `Faraday::Response::RaiseError` somewhere in your stack.
29
+ ```ruby
30
+ connection = Faraday.new(url: 'http://localhost:4567') do |faraday|
31
+ faraday.use FaradayError::Middleware, name: "example_request"
32
+ faraday.use Faraday::Response::RaiseError
33
+ faraday.adapter Faraday.default_adapter
34
+ end
35
+ ```
36
+
37
+ And that's it. Make a request as you normally would.
38
+ ```ruby
39
+ connection.post do |req|
40
+ req.url '/503' # Demo server included.
41
+ req.headers['Content-Type'] = 'application/json'
42
+ req.body = JSON.generate(abc: "xyz")
43
+ end
44
+ ```
45
+
46
+ If any request fails, Honeybadger's "context" for this error will include your request parameters. If sending JSON or `application/x-www-form-urlencoded`, these will be included in parsed form.
47
+ ```json
48
+ {
49
+ "example_request": {
50
+ "method": "post",
51
+ "url": "http://localhost:4567/503",
52
+ "request_headers": {
53
+ "User-Agent": "Faraday v0.9.2",
54
+ "Content-Type": "application/json"
55
+ },
56
+ "body_length": 13,
57
+ "body": {
58
+ "abc": "xyz"
59
+ }
60
+ }
61
+ }```
62
+
63
+
64
+ ## Development
65
+
66
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
67
+
68
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
69
+
70
+ ## Contributing
71
+
72
+ Bug reports and pull requests are welcome on GitHub at https://github.com/jelder/faraday_error. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
73
+
74
+
75
+ ## License
76
+
77
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
78
+
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "faraday_error"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,30 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'faraday_error/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "faraday_error"
8
+ spec.version = FaradayError::VERSION
9
+ spec.authors = ["Jacob Elder"]
10
+ spec.email = ["jacob.elder@gmail.com"]
11
+
12
+ spec.summary = %q{A Faraday middleware for adding request parameters to your exception tracker.}
13
+ spec.description = File.read("README.md")
14
+ spec.homepage = "https://github.com/jelder/faraday_error/"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_dependency "faraday", "~> 0.9.2"
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.11"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+ spec.add_development_dependency 'sinatra', '~> 1.4', '>= 1.4.7'
28
+ spec.add_development_dependency 'honeybadger', '~> 2.4', '>= 2.4.1'
29
+ spec.add_development_dependency 'newrelic_rpm', '~> 3.14', '>= 3.14.0'
30
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+ require 'faraday'
3
+ require "faraday_error/version"
4
+
5
+ module FaradayError
6
+ autoload :Middleware, "faraday_error/middleware"
7
+
8
+ def self.handlers
9
+ @@handlers ||= {}
10
+ @@handlers
11
+ end
12
+ end
13
+
14
+ require 'faraday_error/newrelic'
15
+ require 'faraday_error/honeybadger'
@@ -0,0 +1,4 @@
1
+ if Kernel.const_defined?("Honeybadger")
2
+ FaradayError.handlers[:honeybadger] ||= -> (context) { Honeybadger.context(context) }
3
+ end
4
+
@@ -0,0 +1,40 @@
1
+ module FaradayError
2
+ class Middleware
3
+
4
+ def initialize(app, options = {})
5
+ @app = app
6
+ @name = options.fetch(:name, 'faraday')
7
+ end
8
+
9
+ def call(env)
10
+ set_context(@name => context_from_env(env))
11
+ result = @app.call(env)
12
+ return result
13
+ end
14
+
15
+ private
16
+
17
+ def set_context(context = {})
18
+ FaradayError.handlers.each_pair do |name, proc|
19
+ proc.call(context)
20
+ end
21
+ end
22
+
23
+ def context_from_env(env)
24
+ context = {
25
+ method: env[:method],
26
+ url: env[:url],
27
+ request_headers: env[:request_headers],
28
+ body_length: env[:body].length
29
+ }
30
+ case env[:request_headers]["Content-Type"]
31
+ when "application/json"
32
+ context[:body] = JSON.parse(env[:body])
33
+ when "application/x-www-form-urlencoded"
34
+ context[:body] = URI.decode_www_form(env[:body]).to_h
35
+ end
36
+ return context
37
+ end
38
+
39
+ end
40
+ end
@@ -0,0 +1,3 @@
1
+ if Kernel.const_defined?("NewRelic")
2
+ FaradayError.handlers[:newrelic] ||= -> (context) { NewRelic::Agent.add_custom_attributes(context) }
3
+ end
@@ -0,0 +1,3 @@
1
+ module FaradayError
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,253 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: faraday_error
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Jacob Elder
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-02-18 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: faraday
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 0.9.2
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 0.9.2
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.11'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.11'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: sinatra
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '1.4'
76
+ - - ">="
77
+ - !ruby/object:Gem::Version
78
+ version: 1.4.7
79
+ type: :development
80
+ prerelease: false
81
+ version_requirements: !ruby/object:Gem::Requirement
82
+ requirements:
83
+ - - "~>"
84
+ - !ruby/object:Gem::Version
85
+ version: '1.4'
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: 1.4.7
89
+ - !ruby/object:Gem::Dependency
90
+ name: honeybadger
91
+ requirement: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - "~>"
94
+ - !ruby/object:Gem::Version
95
+ version: '2.4'
96
+ - - ">="
97
+ - !ruby/object:Gem::Version
98
+ version: 2.4.1
99
+ type: :development
100
+ prerelease: false
101
+ version_requirements: !ruby/object:Gem::Requirement
102
+ requirements:
103
+ - - "~>"
104
+ - !ruby/object:Gem::Version
105
+ version: '2.4'
106
+ - - ">="
107
+ - !ruby/object:Gem::Version
108
+ version: 2.4.1
109
+ - !ruby/object:Gem::Dependency
110
+ name: newrelic_rpm
111
+ requirement: !ruby/object:Gem::Requirement
112
+ requirements:
113
+ - - "~>"
114
+ - !ruby/object:Gem::Version
115
+ version: '3.14'
116
+ - - ">="
117
+ - !ruby/object:Gem::Version
118
+ version: 3.14.0
119
+ type: :development
120
+ prerelease: false
121
+ version_requirements: !ruby/object:Gem::Requirement
122
+ requirements:
123
+ - - "~>"
124
+ - !ruby/object:Gem::Version
125
+ version: '3.14'
126
+ - - ">="
127
+ - !ruby/object:Gem::Version
128
+ version: 3.14.0
129
+ description: |+
130
+ # FaradayError
131
+
132
+ A [Faraday](https://github.com/lostisland/faraday) middleware for adding request parameters to your exception tracker.
133
+
134
+ ### Supports
135
+ - [Honeybadger](https://www.honeybadger.io/)
136
+ - [NewRelic](http://newrelic.com/)
137
+ - Your favorite thing, as soon as you make a pull request!
138
+
139
+ ## Installation
140
+
141
+ Add this line to your application's Gemfile:
142
+
143
+ ```ruby
144
+ gem 'faraday_error'
145
+ ```
146
+
147
+ And then execute:
148
+
149
+ $ bundle
150
+
151
+ Or install it yourself as:
152
+
153
+ $ gem install faraday_error
154
+
155
+ ## Usage
156
+
157
+ Configure your Faraday connection to use this middleware. You can optionally specify a name; defaults to `faraday`. It is expected that you also use `Faraday::Response::RaiseError` somewhere in your stack.
158
+ ```ruby
159
+ connection = Faraday.new(url: 'http://localhost:4567') do |faraday|
160
+ faraday.use FaradayError::Middleware, name: "example_request"
161
+ faraday.use Faraday::Response::RaiseError
162
+ faraday.adapter Faraday.default_adapter
163
+ end
164
+ ```
165
+
166
+ And that's it. Make a request as you normally would.
167
+ ```ruby
168
+ connection.post do |req|
169
+ req.url '/503' # Demo server included.
170
+ req.headers['Content-Type'] = 'application/json'
171
+ req.body = JSON.generate(abc: "xyz")
172
+ end
173
+ ```
174
+
175
+ If any request fails, Honeybadger's "context" for this error will include your request parameters. If sending JSON or `application/x-www-form-urlencoded`, these will be included in parsed form.
176
+ ```json
177
+ {
178
+ "example_request": {
179
+ "method": "post",
180
+ "url": "http://localhost:4567/503",
181
+ "request_headers": {
182
+ "User-Agent": "Faraday v0.9.2",
183
+ "Content-Type": "application/json"
184
+ },
185
+ "body_length": 13,
186
+ "body": {
187
+ "abc": "xyz"
188
+ }
189
+ }
190
+ }```
191
+
192
+
193
+ ## Development
194
+
195
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
196
+
197
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
198
+
199
+ ## Contributing
200
+
201
+ Bug reports and pull requests are welcome on GitHub at https://github.com/jelder/faraday_error. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
202
+
203
+
204
+ ## License
205
+
206
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
207
+
208
+ email:
209
+ - jacob.elder@gmail.com
210
+ executables: []
211
+ extensions: []
212
+ extra_rdoc_files: []
213
+ files:
214
+ - ".gitignore"
215
+ - ".rspec"
216
+ - CODE_OF_CONDUCT.md
217
+ - Gemfile
218
+ - LICENSE.txt
219
+ - README.md
220
+ - Rakefile
221
+ - bin/console
222
+ - bin/setup
223
+ - faraday_error.gemspec
224
+ - lib/faraday_error.rb
225
+ - lib/faraday_error/honeybadger.rb
226
+ - lib/faraday_error/middleware.rb
227
+ - lib/faraday_error/newrelic.rb
228
+ - lib/faraday_error/version.rb
229
+ homepage: https://github.com/jelder/faraday_error/
230
+ licenses:
231
+ - MIT
232
+ metadata: {}
233
+ post_install_message:
234
+ rdoc_options: []
235
+ require_paths:
236
+ - lib
237
+ required_ruby_version: !ruby/object:Gem::Requirement
238
+ requirements:
239
+ - - ">="
240
+ - !ruby/object:Gem::Version
241
+ version: '0'
242
+ required_rubygems_version: !ruby/object:Gem::Requirement
243
+ requirements:
244
+ - - ">="
245
+ - !ruby/object:Gem::Version
246
+ version: '0'
247
+ requirements: []
248
+ rubyforge_project:
249
+ rubygems_version: 2.5.1
250
+ signing_key:
251
+ specification_version: 4
252
+ summary: A Faraday middleware for adding request parameters to your exception tracker.
253
+ test_files: []