grape_db_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fd89ca9b602318e973d3b624b3ae12e7a86fae8
+  data.tar.gz: 0d47503374344070a054065269dfd029e0545bb4
+SHA512:
+  metadata.gz: 17b4fa936967215eeb0dea34958bd86228e7b9924b1ac0fc952d61b7844065bb0012940a05346eefc15d6dbbe9555d70b9d3d8386e216737685082a1e818c8d3
+  data.tar.gz: 71f49c0768c0f5109c991b9d694e4edbaf37e9680ff3d78d72e80d28252e9e3017885124ffb3a22abb23c312c25036cc7f92208792b4c6a450cb55c2eb447321

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/.rubocop.yml

@@ -0,0 +1,43 @@
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - 'bin/*'
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Metrics/LineLength:
+  Max: 120
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Lint/Eval:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Rails:
+  Enabled: true
+
+Metrics/ModuleLength:
+  Max: 200

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

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 m.mignini@wepush.org. 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 grape_db_logger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mirko Mignini
+
+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,50 @@
+# GrapeDbLogger
+
+Database logger for Grape.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape_db_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape_db_logger
+
+## Usage
+
+Execute the following commands to generate the required migration:
+
+    $ rails generate grape_db_logger
+    $ rake db:migrate
+
+Then tell Grape to use the log middleware and start logging follow the next step or read the [grape documentation](https://github.com/ruby-grape/grape#grape-middleware) for detailed instructions:
+```ruby
+class API < Grape::API
+  # Add this line
+  use GrapeDbLogger::Logger
+
+  # Your code...
+end
+```
+
+## 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/MirkoMignini/grape_db_logger. 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 "grape_db_logger"
+
+# 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/grape_db_logger.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape_db_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grape_db_logger'
+  spec.version       = GrapeDbLogger::VERSION
+  spec.authors       = ['Mirko Mignini']
+  spec.email         = ['mirko.mignini@gmail.com']
+
+  spec.summary       = 'Database logger for Grape.'
+  spec.homepage      = 'https://github.com/MirkoMignini/grape_db_logger'
+  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 'grape', '> 0.15.0'
+  spec.add_dependency 'activerecord', '>= 4.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rack-test'
+end

data/lib/generators/grape_db_logger_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+class GrapeDbLoggerGenerator < ActiveRecord::Generators::Base
+  argument :name, type: :string, default: 'random_name'
+
+  class_option: 'skip-migration', type: boolean, desc: "Don't generate a migration for the logs table"
+
+  source_root File.expand_path('../../grape_db_logger', __FILE__)
+
+  def copy_files
+    return if options['skip-migration']
+    migration_template 'migration.rb', 'db/migrate/create_grape_db_logger.rb'
+  end
+end

data/lib/grape_db_logger/grape_log.rb

@@ -0,0 +1,4 @@
+module GrapeDbLogger
+  class GrapeLog < ActiveRecord::Base
+  end
+end

data/lib/grape_db_logger/logger.rb

@@ -0,0 +1,36 @@
+require 'grape'
+
+module GrapeDbLogger
+  class Logger < ::Grape::Middleware::Base
+    def after
+      @request = ::Rack::Request.new(@env)
+      options = {
+        request_method: @request.request_method,
+        path: @request.path,
+        params: params,
+        referer: @request.referer,
+        user_agent: @request.user_agent,
+        ip: @request.ip,
+        created_at: DateTime.current,
+      }
+      log(options)
+      super
+    end
+
+    def filter_params
+      %w(password password_confirmation)
+    end
+
+    def params
+      params = @request.params.clone
+      filter_params.each do |key|
+        params[key] = 'FILTERED' if params.key?(key)
+      end
+      params.to_json
+    end
+
+    def log(options)
+      GrapeLog.create(options)
+    end
+  end
+end

data/lib/grape_db_logger/migration.rb

@@ -0,0 +1,16 @@
+class CreateGrapeLog < ActiveRecord::Migration
+  def change
+    create_table :grape_logs do |t|
+      t.string   :request_method
+      t.string   :path
+      t.text     :params
+      t.string   :referer
+      t.string   :user_agent
+      t.string   :ip
+      t.datetime :created_at
+    end
+    add_index :grape_logs, :created_at
+    add_index :grape_logs, :request_method
+    add_index :grape_logs, :path
+  end
+end

data/lib/grape_db_logger/version.rb

@@ -0,0 +1,3 @@
+module GrapeDbLogger
+  VERSION = '0.1.0'.freeze
+end

data/lib/grape_db_logger.rb

@@ -0,0 +1,6 @@
+require 'grape_db_logger/version'
+require 'grape_db_logger/logger'
+require 'grape_db_logger/grape_log'
+
+module GrapeDbLogger
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: grape_db_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mirko Mignini
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rubocop
+  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: rack-test
+  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'
+description: 
+email:
+- mirko.mignini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- grape_db_logger.gemspec
+- lib/generators/grape_db_logger_generator.rb
+- lib/grape_db_logger.rb
+- lib/grape_db_logger/grape_log.rb
+- lib/grape_db_logger/logger.rb
+- lib/grape_db_logger/migration.rb
+- lib/grape_db_logger/version.rb
+homepage: https://github.com/MirkoMignini/grape_db_logger
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Database logger for Grape.
+test_files: []