elastic_activities 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f44113f950f887cae6e0cb4400893c088eb8132
+  data.tar.gz: d9b05ed5c7e84f8822b67bfa53e7fa3e4096933a
+SHA512:
+  metadata.gz: 5de1e3c92f4d99486c517ef112c59e8f87264ad6c63ce9604db283464d9c767cd140fa66d5de39ff4bb98057722f6b12149e239023d6eb0175beb32b3f70c196
+  data.tar.gz: 4ee88a388176dd1808274c55a0427b968da9ee912f2036fbe7c7aa9b8e1dc8cb435b638d26d1fe5917765e85cd04ae3c523cb2222d848531b789825400e6a12b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at akshatha.bhat4@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in elastic_activities.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Akshatha Bhat
+
+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,52 @@
+# ElasticActivities
+
+This gem is used to store your application logs in ElasticSearch
+Before using this gem please make sure ElasticSearch is installed in your matchine. You can download it from "https://www.elastic.co/products/elasticsearch"
+Requred rails version is 5.1
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elastic_activities'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install elastic_activities
+
+## Usage
+
+Execute following command to generate the initializers
+
+    $ rails g elastic_index
+
+You will be prompted to enter 'Enter elastic index name' & 'Enter elastic url'
+The details which you will enter will be the locations wher your application logs will be stored.
+
+Add following inside your ApplicationController
+
+    before_action :add_logs
+
+## 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/[USERNAME]/elastic_activities. 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).
+
+## Code of Conduct
+
+Everyone interacting in the ElasticActivities project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/elastic_activities/blob/master/CODE_OF_CONDUCT.md).

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 "elastic_activities"
+
+# 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(__FILE__)

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/elastic_activities.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "elastic_activities/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "elastic_activities"
+  spec.version       = ElasticActivities::VERSION
+  spec.authors       = ["Akshatha Bhat"]
+  spec.email         = ["akshatha.bhat4@gmail.com"]
+
+  spec.summary       = %q{Store Application Logs In ElasticSearch}
+  spec.description   = %q{Store Application Logs In ElasticSearch}
+  spec.homepage      = "https://github.com/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'rails', "~> 5.1"
+  spec.add_dependency 'useragent'
+end

data/lib/elastic_activities.rb

@@ -0,0 +1,50 @@
+require "elastic_activities/version"
+require "elastic_activities/geo_location"
+require "user_agent"
+
+module ElasticActivities
+  # Your code goes here...
+  mattr_accessor :index_name, :elastic_url
+
+  def self.setup
+    yield self
+  end
+
+  def add_logs
+    `curl -XPOST http://#{self.elastic_url}/#{self.index_name}/logs -d '#{log_json.to_json}'`
+  end
+
+  private
+
+  def log_json
+    geo_location = GeoLocation.new(ip: request.remote_ip)
+    geo_location.get_details
+    user_agent = UserAgent.parse(request.env['HTTP_USER_AGENT'])
+    json_data = {
+      url: request.url,
+      action: params[:action],
+      controller: params[:controller],
+      parameters: params.except(*[:action, :controller]),
+      ip_address: request.remote_ip,
+      browser: user_agent.browser,
+      browser_version: user_agent.version.to_s,
+      platform: user_agent.platform,
+      os: user_agent.os,
+      datetime: DateTime.now.utc.strftime("%Y-%m-%d %H:%M"),
+      as: geo_location.as,
+      city: geo_location.city,
+      country: geo_location.country,
+      country_code: geo_location.country_code,
+      isp: geo_location.isp,
+      org: geo_location.org,
+      region: geo_location.region,
+      region_name: geo_location.region_name,
+      timezone: geo_location.timezone,
+      zip: geo_location.zip,
+      geo_points: geo_location.geo_points
+    }
+    json_data.merge!({user_email: current_user.email}) if self.respond_to?(:current_user) && current_user.present?
+    json_data
+  end
+
+end

data/lib/elastic_activities/geo_location.rb

@@ -0,0 +1,28 @@
+module ElasticActivities
+  class GeoLocation
+    attr_accessor :as, :city, :country, :country_code, :isp, :org, :region, :region_name, :timezone, :zip, :geo_points
+    attr_reader :ip_address
+    def initialize(args={})
+      @ip_address = args[:ip] == '127.0.0.1' ? '' : args[:ip]
+    end
+
+    def get_details
+      data = `curl -XGET http://ip-api.com/json/#{ip_address}`
+      json_data = JSON.parse(data)
+      @as = json_data['as']
+      @city = json_data['city']
+      @country = json_data['country']
+      @country_code = json_data['countryCode']
+      @isp = json_data['isp']
+      @org = json_data['org']
+      @region = json_data['region']
+      @region_name = json_data['regionName']
+      @timezone = json_data['timezone']
+      @zip = json_data['zip']
+      @geo_points = {
+        lat: json_data['lat'],
+        lon: json_data['lon']
+      }
+    end
+  end
+end

data/lib/elastic_activities/version.rb

@@ -0,0 +1,3 @@
+module ElasticActivities
+  VERSION = "1.0.0"
+end

data/lib/generators/elastic_index.json

@@ -0,0 +1,35 @@
+{
+    "settings": {
+        "number_of_shards": 10,
+        "number_of_replicas": 0
+    },
+    "mappings": {
+        "logs": {
+            "_all" : {"enabled": false},
+            "properties": {
+                "url": {"type": "keyword"},
+                "action": {"type": "keyword"},
+                "controller": {"type": "keyword"},
+                "parameters": {"type": "object"},
+                "ip_address": {"type": "ip", "index": true },
+                "browser": {"type": "keyword" },
+                "browser_version": {"type": "keyword" },
+                "platform": {"type": "keyword" },
+                "os": {"type": "keyword" },
+                "user_email": {"type": "keyword" },
+                "datetime": {"type": "date", "format": "yyyy-MM-dd HH:mm", "index": true},
+                "geo_points": {"type": "geo_point"},
+                "as": {"type": "keyword"},
+                "city": {"type": "keyword"},
+                "country": {"type": "keyword"},
+                "country_code": {"type": "keyword"},
+                "isp": {"type": "keyword"},
+                "org": {"type": "keyword"},
+                "region": {"type": "keyword"},
+                "region_name": {"type": "keyword"},
+                "timezone": {"type": "keyword"},
+                "zip": {"type": "keyword"}
+            }
+        }
+    }
+}

data/lib/generators/elastic_index_generator.rb

@@ -0,0 +1,20 @@
+class ElasticIndexGenerator < Rails::Generators::Base
+  def create_initializer_file
+    puts "Enter elastic index name"
+    index_name = gets.gsub("\n", '')
+    puts "Enter elastic url"
+    elastic_url = gets.gsub("\n", '')
+
+    dir_name = File.dirname(__FILE__)
+    `curl -XPUT http://#{elastic_url}/#{index_name} -d @#{dir_name}/elastic_index.json`
+
+    create_file "config/initializers/elastic_activities.rb", <<-FILE
+ElasticActivities.setup do |config|
+  config.index_name = '#{index_name}'
+  config.elastic_url = '#{elastic_url}'
+end
+    FILE
+
+    inject_into_file "config/environment.rb", "include ElasticActivities\n", before: "# Initialize the Rails application."
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: elastic_activities
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Akshatha Bhat
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: useragent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Store Application Logs In ElasticSearch
+email:
+- akshatha.bhat4@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- elastic_activities.gemspec
+- lib/elastic_activities.rb
+- lib/elastic_activities/geo_location.rb
+- lib/elastic_activities/version.rb
+- lib/generators/elastic_index.json
+- lib/generators/elastic_index_generator.rb
+homepage: https://github.com/
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Store Application Logs In ElasticSearch
+test_files: []