faraday-diario_de_bordo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0fc0b4a7ba8ef982faaedacdf981e1c81ed658f
+  data.tar.gz: a30d034cd3514791352460cfec7afd88052808e5
+SHA512:
+  metadata.gz: 7da65dfe1b6103b91cb1fe6dca068d292991f7f95f2813286b8bfda8a95d3304dbe306ef7483742eee97918c694bbd73a19cd41e440daf183e62a17b79951cce
+  data.tar.gz: 5caad7cc2b2fdccbe883227cb857dba22d34c0b0a1ba1431817b006adb227ea9f0510587e2c203d0cd2e1f936f278e3b7756a03314973c93900163713b1741f9

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'diario_de_bordo', git: 'git@github.com:Bidu/diario_de_bordo.git', tag: '0.1.3'

data/README.md

@@ -0,0 +1,53 @@
+# Faraday::DiarioDeBordo
+
+Middleware to save faraday request logs using the [diario_de_bordo](https://github.com/bidu/diario_de_bordo) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-diario_de_bordo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday-diario_de_bordo
+
+## Usage
+
+1: Create a connection with diario_de_bordo. Instructions in diario_de_bordo's [README](https://github.com/bidu/diario_de_bordo/README.md).
+
+2: Add middleware to your Faraday connection:
+
+```ruby
+Faraday.new do |faraday|
+  faraday.response :diario_de_bordo
+end
+```
+
+3: Send informations through your request headers:
+
+```ruby
+connection = Faraday.new do |faraday|
+  faraday.response :diario_de_bordo
+end
+
+connection.post(YOUR_ENDPOINT) do |request|
+  request.headers.merge(susep: 1234, template: 'path_to_your_template', external_id: 583723)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/faraday-diario_de_bordo.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "faraday/diario_de_bordo"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/faraday-diario_de_bordo.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday/diario_de_bordo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'faraday-diario_de_bordo'
+  spec.version       = Faraday::DiarioDeBordo::VERSION
+  spec.authors       = ['Bidu Dev Team', 'Jaya Dev Team']
+  spec.email         = ['dev@bidu.com.br', 'bidu@jaya-apps.com.br']
+
+  spec.summary       = 'Middleware between faraday and diario de bordo'
+  spec.description   = 'Middleware to save logs for faraday requests'
+  spec.homepage      = 'https://github.com/Bidu/faraday-diario_de_bordo'
+
+  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_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'faraday', '~> 0.9'
+end

data/lib/faraday/diario_de_bordo.rb

@@ -0,0 +1,6 @@
+module Faraday
+  module DiarioDeBordo
+    require 'faraday/diario_de_bordo/version'
+    require 'faraday/diario_de_bordo/middleware'
+  end
+end

data/lib/faraday/diario_de_bordo/middleware.rb

@@ -0,0 +1,75 @@
+require 'faraday'
+
+module Faraday
+  class DiarioDeBordo::Middleware < Response::Middleware
+    DEFAULT_OPTIONS = { bodies: true }
+
+    attr_reader :logger, :options, :request_body, :response_body, :started_at, :ended_at
+
+    def initialize(app, logger = nil, options = {})
+      super(app)
+      @logger = logger || begin
+        require 'diario_de_bordo'
+        ::DiarioDeBordo::Loggers::Database
+      end
+      @options = DEFAULT_OPTIONS.merge(options)
+    end
+
+    def call(env)
+      @request_body = dump_body(env[:body]) if env[:body] && log_body?(:request)
+      @started_at = Time.now
+      super
+    end
+
+    def on_complete(env)
+      @ended_at = Time.now
+      @response_body = dump_body(env[:body]) if env[:body] && log_body?(:response)
+      logger.log(response_log(env))
+    end
+
+    private
+
+    def duration
+      (ended_at - started_at)
+    end
+
+    def response_log(env)
+      {
+        request: request_body,
+        response: response_body,
+        susep: env.request_headers.delete('susep'),
+        method: env.request_headers.delete('template'),
+        external_id: env.request_headers.delete('external_id'),
+        status_code: env.status,
+        duration: duration,
+        created_at: Time.now
+      }
+    end
+
+    def dump_headers(headers)
+      headers.map { |k, v| "#{k}: #{v.inspect}" }.join("\n")
+    end
+
+    def dump_body(body)
+      if body.respond_to?(:to_str)
+        body.to_str
+      else
+        pretty_inspect(body)
+      end
+    end
+
+    def pretty_inspect(body)
+      require 'pp' unless body.respond_to?(:pretty_inspect)
+      body.pretty_inspect
+    end
+
+    def log_body?(type)
+      case options[:bodies]
+      when Hash then options[:bodies][type]
+      else options[:bodies]
+      end
+    end
+  end
+end
+
+Faraday::Response.register_middleware(diario_de_bordo: Faraday::DiarioDeBordo::Middleware)

data/lib/faraday/diario_de_bordo/version.rb

@@ -0,0 +1,5 @@
+module Faraday
+  module DiarioDeBordo
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: faraday-diario_de_bordo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bidu Dev Team
+- Jaya Dev Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Middleware to save logs for faraday requests
+email:
+- dev@bidu.com.br
+- bidu@jaya-apps.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- faraday-diario_de_bordo.gemspec
+- lib/faraday/diario_de_bordo.rb
+- lib/faraday/diario_de_bordo/middleware.rb
+- lib/faraday/diario_de_bordo/version.rb
+homepage: https://github.com/Bidu/faraday-diario_de_bordo
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Middleware between faraday and diario de bordo
+test_files: []