faraday_error 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ba848c0c1805086776b1368110caa30db4030af
+  data.tar.gz: 3cb424b67ae19f0c6f27bb1fe7416583ee9e22b1
+SHA512:
+  metadata.gz: b3c5765c9c7daba82f2c6e918ea2ad003af8966f363a3502078cafff30a781483e57d7cd37f8b9e1b7fd1c786b77524b3a40d640ff3f5a6945a600821a7d655b
+  data.tar.gz: d4c681bc076f3b9388c82521a7984fce2693a972fd838109319caaf775b9b014ae96562fdbe3958aaa8583b367107f7f06e831c0e679aab7cdbb294bf2a4a3fe

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jacob@boundless.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faraday_error.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jacob Elder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# FaradayError
+
+A [Faraday](https://github.com/lostisland/faraday) middleware for adding request parameters to your exception tracker.
+
+### Supports
+ - [Honeybadger](https://www.honeybadger.io/)
+ - [NewRelic](http://newrelic.com/)
+ - Your favorite thing, as soon as you make a pull request!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday_error'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday_error
+
+## Usage
+
+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.
+```ruby
+connection = Faraday.new(url: 'http://localhost:4567') do |faraday|
+  faraday.use       FaradayError::Middleware, name: "example_request"
+  faraday.use       Faraday::Response::RaiseError
+  faraday.adapter   Faraday.default_adapter
+end
+```
+
+And that's it. Make a request as you normally would.
+```ruby
+connection.post do |req|
+  req.url '/503' # Demo server included.
+  req.headers['Content-Type'] = 'application/json'
+  req.body = JSON.generate(abc: "xyz")
+end
+```
+
+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.
+```json
+{
+  "example_request": {
+    "method": "post",
+    "url": "http://localhost:4567/503",
+    "request_headers": {
+      "User-Agent": "Faraday v0.9.2",
+      "Content-Type": "application/json"
+    },
+    "body_length": 13,
+    "body": {
+      "abc": "xyz"
+    }
+  }
+}```
+
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "faraday_error"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/faraday_error.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday_error/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday_error"
+  spec.version       = FaradayError::VERSION
+  spec.authors       = ["Jacob Elder"]
+  spec.email         = ["jacob.elder@gmail.com"]
+
+  spec.summary       = %q{A Faraday middleware for adding request parameters to your exception tracker.}
+  spec.description   = File.read("README.md")
+  spec.homepage      = "https://github.com/jelder/faraday_error/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.9.2"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'sinatra', '~> 1.4', '>= 1.4.7'
+  spec.add_development_dependency 'honeybadger', '~> 2.4', '>= 2.4.1'
+  spec.add_development_dependency 'newrelic_rpm', '~> 3.14', '>= 3.14.0'
+end

data/lib/faraday_error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require 'faraday'
+require "faraday_error/version"
+
+module FaradayError
+  autoload :Middleware, "faraday_error/middleware"
+
+  def self.handlers
+    @@handlers ||= {}
+    @@handlers
+  end
+end
+
+require 'faraday_error/newrelic'
+require 'faraday_error/honeybadger'

data/lib/faraday_error/honeybadger.rb

@@ -0,0 +1,4 @@
+if Kernel.const_defined?("Honeybadger")
+  FaradayError.handlers[:honeybadger] ||= -> (context) { Honeybadger.context(context) }
+end
+

data/lib/faraday_error/middleware.rb

@@ -0,0 +1,40 @@
+module FaradayError
+  class Middleware
+
+    def initialize(app, options = {})
+      @app = app
+      @name = options.fetch(:name, 'faraday')
+    end
+
+    def call(env)
+      set_context(@name => context_from_env(env))
+      result = @app.call(env)
+      return result
+    end
+
+    private
+
+      def set_context(context = {})
+        FaradayError.handlers.each_pair do |name, proc|
+          proc.call(context)
+        end
+      end
+
+      def context_from_env(env)
+        context = {
+          method: env[:method],
+          url: env[:url],
+          request_headers: env[:request_headers],
+          body_length: env[:body].length
+        }
+        case env[:request_headers]["Content-Type"]
+        when "application/json"
+          context[:body] = JSON.parse(env[:body])
+        when "application/x-www-form-urlencoded"
+          context[:body] = URI.decode_www_form(env[:body]).to_h
+        end
+        return context
+      end
+
+  end
+end

data/lib/faraday_error/newrelic.rb

@@ -0,0 +1,3 @@
+if Kernel.const_defined?("NewRelic")
+  FaradayError.handlers[:newrelic] ||= -> (context) { NewRelic::Agent.add_custom_attributes(context) }
+end

data/lib/faraday_error/version.rb

@@ -0,0 +1,3 @@
+module FaradayError
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,253 @@
+--- !ruby/object:Gem::Specification
+name: faraday_error
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jacob Elder
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+- !ruby/object:Gem::Dependency
+  name: honeybadger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.14.0
+description: |+
+  # FaradayError
+
+  A [Faraday](https://github.com/lostisland/faraday) middleware for adding request parameters to your exception tracker.
+
+  ### Supports
+   - [Honeybadger](https://www.honeybadger.io/)
+   - [NewRelic](http://newrelic.com/)
+   - Your favorite thing, as soon as you make a pull request!
+
+  ## Installation
+
+  Add this line to your application's Gemfile:
+
+  ```ruby
+  gem 'faraday_error'
+  ```
+
+  And then execute:
+
+      $ bundle
+
+  Or install it yourself as:
+
+      $ gem install faraday_error
+
+  ## Usage
+
+  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.
+  ```ruby
+  connection = Faraday.new(url: 'http://localhost:4567') do |faraday|
+    faraday.use       FaradayError::Middleware, name: "example_request"
+    faraday.use       Faraday::Response::RaiseError
+    faraday.adapter   Faraday.default_adapter
+  end
+  ```
+
+  And that's it. Make a request as you normally would.
+  ```ruby
+  connection.post do |req|
+    req.url '/503' # Demo server included.
+    req.headers['Content-Type'] = 'application/json'
+    req.body = JSON.generate(abc: "xyz")
+  end
+  ```
+
+  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.
+  ```json
+  {
+    "example_request": {
+      "method": "post",
+      "url": "http://localhost:4567/503",
+      "request_headers": {
+        "User-Agent": "Faraday v0.9.2",
+        "Content-Type": "application/json"
+      },
+      "body_length": 13,
+      "body": {
+        "abc": "xyz"
+      }
+    }
+  }```
+
+
+  ## Development
+
+  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.
+
+  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).
+
+  ## Contributing
+
+  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.
+
+
+  ## License
+
+  The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+email:
+- jacob.elder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- faraday_error.gemspec
+- lib/faraday_error.rb
+- lib/faraday_error/honeybadger.rb
+- lib/faraday_error/middleware.rb
+- lib/faraday_error/newrelic.rb
+- lib/faraday_error/version.rb
+homepage: https://github.com/jelder/faraday_error/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A Faraday middleware for adding request parameters to your exception tracker.
+test_files: []