excon-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48b2039b185df915eed299bd0f926910ff7c0ca7
+  data.tar.gz: d8a9c2fb80a6530de30a13f5e99e83501424c4da
+SHA512:
+  metadata.gz: ed778ec90ae6c9d5c6036e5267d4642c1771f59c0fe78b827444229bc628b3316e8902320421683d6de233397833e2d63ba8d42d80a9956fe247a5306f8e9d74
+  data.tar.gz: acfe782ebac451de2727f0cef718c3039de64186cc6ee2cfdeefcf2d689a98e4bf930e1cb3b4c5b2615f2e75eb69ed4f05750eeb47b362db85eeaae31961eee5

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.2
+matrix:
+  include:
+    - rvm: jruby
+      env: JRUBY_OPTS="--2.0"

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ville Lautanala
+
+MIT License
+
+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,38 @@
+# Excon::Rails [![Build Status](https://travis-ci.org/lautis/excon-rails.svg?branch=master)](https://travis-ci.org/lautis/excon-rails)
+
+Railtie to include Excon HTTP requests in Rails logging.
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+    gem 'excon-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install excon-rails
+
+After you've started your Rails application, your Rails logs should include
+Excon HTTP requests.
+
+If you have debug logging enabled, individual requests are printed out:
+
+      Excon Request (105.66ms)  GET https://google.com/
+      Excon Response (0.02ms)  302 Found (259 Bytes)
+
+
+A total runtime is also included per each request:
+
+      Completed 200 OK in 132ms (Views: 0.2ms | ActiveRecord: 0.4ms | excon: 105.7ms)
+
+## Contributing
+
+1. Fork it ( https://github.com/lautis/excon-rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/excon-rails.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'excon/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "excon-rails"
+  spec.version       = Excon::Rails::VERSION
+  spec.authors       = ["Ville Lautanala"]
+  spec.email         = ["lautis@gmail.com"]
+  spec.summary       = %q{Railtie to include Excon HTTP requests in Rails logging.}
+  spec.description   = %q{Log HTTP requests made via Excon and their total runtime in Rails request log.}
+  spec.homepage      = "https://github.com/lautis/excon-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "excon", ">= 0.18.0"
+  spec.add_dependency "activesupport", ">= 3.0"
+  spec.add_dependency "sweet_notifications", "~> 0.2"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.18"
+end

data/lib/excon-rails.rb

@@ -0,0 +1 @@
+require 'excon/rails'

data/lib/excon/rails.rb

@@ -0,0 +1,58 @@
+require 'excon/rails/version'
+require 'excon/rails/middleware'
+require 'sweet_notifications'
+require 'active_support/number_helper'
+require 'active_support/core_ext/string/inflections'
+require 'excon'
+
+module Excon
+  module Rails
+    Middleware.install
+
+    Railtie, LogSubscriber = SweetNotifications.subscribe :excon, label: 'Excon' do
+      color ActiveSupport::LogSubscriber::BLUE
+
+      event :request do |event|
+        next unless logger.debug?
+        debug request_info(event)
+      end
+
+      event :response do |event|
+        next unless logger.debug?
+        debug message(event, 'Excon Response', "#{status(event)} (#{length(event)})")
+      end
+
+      event :retry do |event|
+        next unless logger.debug?
+        debug request_info(event)
+      end
+
+      event :error do |event|
+        next unless logger.info?
+        info message(event, 'Excon Error', event.payload[:error])
+      end
+
+      private
+
+      def length(event)
+        ActiveSupport::NumberHelper::NumberToHumanSizeConverter
+          .convert(event.payload[:body].length, {})
+      end
+
+      def status(event)
+        status_code = event.payload[:status]
+        status_message = Rack::Utils::HTTP_STATUS_CODES[status_code]
+        "#{status_code} #{status_message}"
+      end
+
+      def request_info(event)
+        payload = event.payload
+        url = "#{payload[:scheme]}://#{payload[:host]}#{payload[:path]}"
+        type = event.name.split('.').first.titleize
+        method = event.payload[:method].try(:upcase)
+        message(event, "Excon #{type}", [method, url].compact.join(' '))
+      end
+    end
+
+  end
+end

data/lib/excon/rails/middleware.rb

@@ -0,0 +1,35 @@
+require 'excon'
+
+module Excon
+  module Rails
+    class Middleware < Excon::Middleware::Base
+      class << self
+        def install
+          index = ::Excon.defaults[:middlewares].index(::Excon::Middleware::Instrumentor)
+          ::Excon.defaults[:middlewares].insert(index || -1, self)
+        end
+      end
+
+      def error_call(datum)
+        ActiveSupport::Notifications.instrument('error.excon', error: datum[:error])
+        @stack.error_call(datum)
+      end
+
+      def request_call(datum)
+        event_name = if datum[:retries_remaining] < datum[:retry_limit]
+          'retry.excon'
+        else
+          'request.excon'
+        end
+        ActiveSupport::Notifications.instrument(event_name, datum) do
+          @stack.request_call(datum)
+        end
+      end
+
+      def response_call(datum)
+        ActiveSupport::Notifications.instrument('response.excon', datum[:response])
+        @stack.response_call(datum)
+      end
+    end
+  end
+end

data/lib/excon/rails/version.rb

@@ -0,0 +1,5 @@
+module Excon
+  module Rails
+    VERSION = '0.1.0'
+  end
+end

data/spec/excon/rails/middleware_spec.rb

@@ -0,0 +1,54 @@
+describe Excon::Rails::Middleware do
+  before :each do
+    stub_request(:any, 'example.com').to_return(body: 'abc', status: 200)
+    stub_request(:any, 'example.com/timeout').to_timeout
+    stub_request(:any, 'example.com/retry').to_return(status: 400)
+  end
+
+  it 'emits events for requests' do
+    received = 0
+    ActiveSupport::Notifications.subscribe 'request.excon' do
+      received += 1
+    end
+    Excon.get('http://example.com')
+    ActiveSupport::Notifications.unsubscribe 'request.excon'
+    expect(received).to eq(1)
+  end
+
+  it 'emits events for responses' do
+    statuses = []
+    ActiveSupport::Notifications.subscribe 'response.excon' do |name, start, finish, id, payload|
+      statuses << payload[:status]
+    end
+    Excon.get('http://example.com')
+    ActiveSupport::Notifications.unsubscribe 'response.excon'
+    expect(statuses).to eq([200])
+  end
+
+  it 'emits events for retried requests' do
+    retries = 0
+    ActiveSupport::Notifications.subscribe 'retry.excon' do
+      retries += 1
+    end
+    connection = Excon.new('http://example.com/retry')
+    begin
+      connection.request(expects: [200], idempotent: true, retry_limit: 3)
+    rescue Excon::Errors::BadRequest
+    end
+    expect(retries).to eq(2)
+    ActiveSupport::Notifications.unsubscribe 'retry.excon'
+  end
+
+  it 'emits events for errors' do
+    errors = 0
+    ActiveSupport::Notifications.subscribe 'error.excon' do
+      errors += 1
+    end
+    begin
+      Excon.get('http://example.com/timeout')
+    rescue Excon::Errors::Timeout
+    end
+    expect(errors).to eq(1)
+    ActiveSupport::Notifications.unsubscribe 'error.excon'
+  end
+end

data/spec/excon/rails_spec.rb

@@ -0,0 +1,54 @@
+module Excon
+  describe Rails do
+    before do
+      stub_request(:any, 'example.com').to_return(body: 'OK')
+    end
+
+    after do
+      if Rails::Railtie.instance.send(:instance_variable_defined?, :@ran)
+        Rails::Railtie.instance.send(:remove_instance_variable, :@ran)
+      end
+    end
+
+    it 'registers Excon middleware' do
+      middlewares = ::Excon.defaults[:middlewares]
+      expect(middlewares).to include(Excon::Rails::Middleware)
+    end
+
+    it 'initializes a Railtie' do
+      expect(Excon::Rails::Railtie.superclass).to eq(::Rails::Railtie)
+    end
+
+    it 'logs runtimes' do
+      stub_request(:any, 'example.com').to_return(body: 'OK')
+      Rails::Railtie.run_initializers
+      Excon.get('http://example.com')
+      expect(Rails::LogSubscriber.runtime).to be > 0
+    end
+
+    it 'logs requests to logger' do
+      @logger.level = Logger::DEBUG
+      Rails::Railtie.run_initializers
+      Excon.get('http://example.com')
+      expect(@logger.logged(:debug)[0])
+        .to match(%r{Excon Request \(\d+\.\d+ms\)  GET http://example\.com/})
+    end
+
+    it 'deals with missing method' do
+      @logger.level = Logger::DEBUG
+      Rails::Railtie.run_initializers
+      Excon.new('http://example.com').request
+      expect(@logger.logged(:debug)[0])
+        .to match(%r{Excon Request \(\d+\.\d+ms\)  http://example\.com/})
+    end
+
+    it 'omits debug logging in production' do
+      @logger.level = Logger::ERROR
+      Rails::Railtie.run_initializers
+      Excon.new('http://example.com').request
+      expect(@logger.logged(:debug)).to be_empty
+      expect(@logger.logged(:info)).to be_empty
+      expect(@logger.logged(:error)).to be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'webmock/rspec'
+require 'active_support/log_subscriber/test_helper'
+require 'excon-rails'
+
+RSpec.configure do |config|
+  config.include ActiveSupport::LogSubscriber::TestHelper
+  config.profile_examples = 10
+  config.order = :random
+  Kernel.srand config.seed
+
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+
+  config.before do
+    setup # Setup LogSubscriber::TestHelper
+    allow(Excon::Rails::LogSubscriber).to receive(:logger)
+      .and_return(ActiveSupport::LogSubscriber::TestHelper::MockLogger.new)
+  end
+
+  config.after do
+    teardown # Tear down LogSubscriber::TestHelper
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: excon-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ville Lautanala
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sweet_notifications
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+description: Log HTTP requests made via Excon and their total runtime in Rails request
+  log.
+email:
+- lautis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- excon-rails.gemspec
+- lib/excon-rails.rb
+- lib/excon/rails.rb
+- lib/excon/rails/middleware.rb
+- lib/excon/rails/version.rb
+- spec/excon/rails/middleware_spec.rb
+- spec/excon/rails_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lautis/excon-rails
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Railtie to include Excon HTTP requests in Rails logging.
+test_files:
+- spec/excon/rails/middleware_spec.rb
+- spec/excon/rails_spec.rb
+- spec/spec_helper.rb