lens 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 668eb65c8f06feb60eb761ab9dde6a5812c2ab59
-  data.tar.gz: 936d0eb1621ca3ffdee9d42946017691836d87fb
+  metadata.gz: 9832b9e9d921f59bf9a46776e523c6d020f572a6
+  data.tar.gz: e328be7d6b3763760d75a510d128010b2e941a34
 SHA512:
-  metadata.gz: 0aad6dbde95515dff8c8f064dce10858911d7ddb1a23ca6601e77040dff452fb76454337a2e48e107478ac634cb2a5b290c24b50979649c407d67849dda0fc69
-  data.tar.gz: 14fc6b41e208e8604c2edc2ff0d8249b7869b72e1ed8fc3720898b176b324ecce0e3f053fd91186fb9878e044317e8c32074cdbcab6d87d005db17c1fa46fe01
+  metadata.gz: 5f8df18f130382daa10fa8e5abbe20f3d456ad8cb67fbfe2caffff1a8a9dbb597ae07a5f816ed447df840257e886c9ee846a16ac15d44841e02eb6a5f141cd54
+  data.tar.gz: 1accd8c65979e589951b7d4de4f1f1c3c5b9086dec8ef4d1c58173248e2388a9ce1cb94b4f7efb1006e3d0a18ab6e58d96e97ef2d43c9965f27a650198149d66

data/.gitignore

@@ -1,2 +1,4 @@
 *.swp
 *.swo
+coverage
+/Gemfile.lock

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,237 @@
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+    - "db/schema.rb"
+    - "spec/*_helper.rb"
+    - "bin/*"
+  UseCache: false
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: leading
+  SupportedStyles:
+  - leading
+  - trailing
+Style/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: true
+  MinBodyLength: 5
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: true
+  MaxLineLength: 100
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: true
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/TrailingComma:
+  Description: Checks for trailing comma in parameter lists and literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: true
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - no_comma
+Metrics/LineLength:
+  Max: 100
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: true
+  CountComments: false
+  Max: 20
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: true
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: true
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: true
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.2
+  - 2.2.3
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-2
+env:
+  global:
+    - JRUBY_OPTS="-J-Xmx1024M --debug"
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: jruby-head
+    - rvm: rbx-2
+script: bundle exec rspec spec

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
-gem 'rails', '>= 3.0'
 
 gemspec
+
+group :test do
+  gem 'simplecov', require: false
+  gem 'codeclimate-test-reporter', require: false
+end

data/README.md

@@ -1,29 +1,36 @@
-# Lens
+[![Build Status](https://travis-ci.org/lenshq/lens_client.svg?branch=master)](https://travis-ci.org/lenshq/lens_client)
+[![Code Climate](https://codeclimate.com/github/lenshq/lens_client/badges/gpa.svg)](https://codeclimate.com/github/lenshq/lens_client)
+[![Test Coverage](https://codeclimate.com/github/lenshq/lens_client/badges/coverage.svg)](https://codeclimate.com/github/lenshq/lens_client/coverage)
 
-TODO: Write a gem description
+# Lens ruby gem
 
-## Installation
+### Installation
 
-Add this line to your application's Gemfile:
+Add to your Gemfile
 
-    gem 'lens'
+```ruby
+gem 'lens'
+```
 
-And then execute:
+or, if you want bleeding edge,
 
-    $ bundle
+```ruby
+gem 'lens', github: 'lenshq/lens_client'
+```
 
-Or install it yourself as:
+### Configuration
 
-    $ gem install lens
+* Get your application key at [LensHQ site](http://lenshq.io)
+* Create file `config/initializers/lens.rb`
+* Configure Lens client (sample config below)
+* Start sending your data to Lens =]
 
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/lens/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
+```ruby
+# config/initializers/lens.rb
+Lens.configure do |config|
+  config.app_key = 'super_secret_key'
+  config.protocol = 'http'
+  config.host = 'localhost'
+  config.port = 3001
+end
+```

data/lens.gemspec

@@ -4,22 +4,23 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lens/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "lens"
+  spec.name          = 'lens'
   spec.version       = Lens::VERSION
-  spec.authors       = ["kgorin", "artygus", "zzet"]
-  spec.email         = ["me@kgor.in", "artygus@engineeram.net", "me@zzet.org"]
+  spec.authors       = ['kgorin', 'artygus', 'zzet']
+  spec.email         = ['me@kgor.in', 'artygus@engineeram.net', 'me@zzet.org']
   spec.summary       = %q{Gem to send Rails request stats}
-  spec.homepage      = "https://github.com/lenshq/lens_client"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/lenshq/lens_client'
+  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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"   , '~> 0'
-  spec.add_development_dependency 'rspec'  , '~> 3.2'
-  spec.add_development_dependency "pry"    , '~> 0.10'
-  spec.add_development_dependency "pry-nav", '~> 0'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rails', '>= 3.0'
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'pry-nav', '~> 0'
 end

data/lib/lens/allocations_data.rb

@@ -0,0 +1,52 @@
+module Lens
+  if RUBY_ENGINE == 'ruby' && RUBY_VERSION >= '1.9'
+    require 'objspace'
+
+    class AllocationsData
+      def initialize
+        @enabled        = false
+        @objects_count  = 0
+        @objects_memory = 0
+      end
+
+      def enable
+        @enabled = true
+      end
+
+      def objects_count
+        @objects_count = calculate_objects_count if @enabled
+        @objects_count
+      end
+
+      def objects_memory
+        @objects_memory = calculate_objects_memory if @enabled
+        @objects_memory
+      end
+
+      private
+
+      def calculate_objects_count
+        obj_count = ObjectSpace.count_objects
+        obj_count[:TOTAL] - obj_count[:FREE]
+      end
+
+      def calculate_objects_memory
+        ObjectSpace.count_objects_size[:TOTAL]
+      end
+    end
+  end
+
+  unless defined?(::Lens::AllocationsData)
+    class AllocationsData
+      def enable; end
+
+      def objects_count
+        0
+      end
+
+      def objects_memory
+        0
+      end
+    end
+  end
+end

data/lib/lens/compression.rb

@@ -0,0 +1,13 @@
+module Lens
+  module Compression
+    module Gzip
+      def self.compress(data)
+        GzipUtil.gzip(data)
+      end
+
+      def self.headers
+        { 'Content-Type' => 'gzip/json' }
+      end
+    end
+  end
+end

data/lib/lens/configuration.rb

@@ -14,16 +14,26 @@ module Lens
       @port || default_port
     end
 
+    def compressor
+      default_compressor
+    end
+
+    private
+
     def default_port
       80
     end
 
     def default_host
-      'lens.coub.com'
+      'lenshq.io'
     end
 
     def default_protocol
-      'https'
+      'http'
+    end
+
+    def default_compressor
+      Compression::Gzip
     end
   end
 end

data/lib/lens/core.rb

@@ -1,11 +1,12 @@
-require "lens/version"
-require "lens/configuration"
-require "lens/sender"
-require "lens/event_formatter"
-require "lens/trace"
-
-module Lens
-  if defined?(Rails)
-    require "lens/railtie"
-  end
-end
+require 'lens/version'
+require 'lens/exceptions'
+require 'lens/configuration'
+require 'lens/gzip_util'
+require 'lens/compression'
+require 'lens/sender'
+require 'lens/event_formatter'
+require 'lens/gc'
+require 'lens/event'
+require 'lens/trace'
+require 'lens/worker'
+require 'lens/allocations_data'

data/lib/lens/event.rb

@@ -0,0 +1,27 @@
+module Lens
+  class Event
+    attr_reader :name, :time, :end, :transaction_id, :payload
+
+    def initialize(options = {})
+      raise ArgumentError unless all_params_present?(options)
+
+      @name = options[:name]
+      @time = options[:started]
+      @end = options[:finished]
+      @transaction_id = options[:transaction_id]
+      @payload = options[:payload]
+    end
+
+    def duration
+      1000.0 * (self.end - time)
+    end
+
+    private
+
+    def all_params_present?(options)
+      [:name, :started, :finished, :transaction_id, :payload].all? do |key|
+        options.key? key
+      end
+    end
+  end
+end

data/lib/lens/event_formatter.rb

@@ -1,8 +1,10 @@
 module Lens
   class EventFormatter
-    def initialize(event, records)
+    def initialize(event, records, gc_time = 0.0, allocations_data = Lens::AllocationsData.new)
       @event = event
-      @records = records
+      @records = records.map{|payload| filter_payload(payload)}
+      @gc_time = gc_time
+      @allocations_data = allocations_data
     end
 
     def json_formatted
@@ -16,7 +18,7 @@ module Lens
   private
 
     def event_payload
-      @event_payload ||= @event.payload
+      @event_payload ||= filter_payload(@event.payload)
     end
 
     def event_data
@@ -32,11 +34,38 @@ module Lens
         start: @event.time.to_f,
         end: @event.end.to_f,
         duration: @event.duration,
+        gc_time: @gc_time,
         event_name: @event.name,
         meta: {
-          client_version: VERSION
-        }
+          client_version: VERSION,
+          rails_version: ::Rails.version
+        },
+        objects_count: @allocations_data.objects_count,
+        objects_memory: @allocations_data.objects_memory
       }
     end
+
+    def filter_payload(payload)
+      payload.inject({}) do |res, h|
+        k, v = h
+
+        if v.is_a?(Hash)
+          res[k] = filter_payload(v)
+        elsif v.is_a?(File)
+          res[k] = {type: :file, path: v.path}
+        elsif v.is_a?(ActionDispatch::Http::UploadedFile)
+          res[k] = {
+            content_type: v.content_type,
+            headers: v.headers,
+            original_filename: v.original_filename,
+            tempfile_path: v.tempfile.path
+          }
+        else
+          res[k] = v
+        end
+
+        res
+      end
+    end
   end
 end

data/lib/lens/exceptions.rb

@@ -0,0 +1,3 @@
+module Lens
+  class ConfigurationError < StandardError; end
+end

data/lib/lens/gc.rb

@@ -0,0 +1,30 @@
+module Lens
+  if defined?(::GC::Profiler)
+    class GC
+      def initialize
+        @total = 0
+      end
+
+      def enable
+        ::GC::Profiler.enable
+      end
+
+      def total_time
+        run = ::GC::Profiler.total_time
+
+        if run > 0
+          ::GC::Profiler.clear
+        end
+
+        @total += run
+      end
+    end
+  end
+
+  unless defined?(::Lens::GC)
+    class GC
+      def enable; end
+      def total_time; 0.0; end
+    end
+  end
+end

data/lib/lens/gzip_util.rb

@@ -0,0 +1,12 @@
+require 'zlib'
+require 'stringio'
+
+module GzipUtil
+  def self.gzip(string)
+    io = StringIO.new('w')
+    writer = Zlib::GzipWriter.new(io)
+    writer.write(string)
+    writer.close
+    io.string
+  end
+end