stackify-api-ruby 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3058e14cea1be8ce39a5f5d8d76c6dd914421dba
-  data.tar.gz: 95d0089689b0fc904b05ac1cc8dedd4f3be392cc
+  metadata.gz: efb9ae31688a8c3d49b8f246e92f060dee8d6197
+  data.tar.gz: 639356cd72dc686ed88d215de3c29c8de9bc8f26
 SHA512:
-  metadata.gz: f0705aeca8ccfad2067d6ccb429a451a58f86e2d039f48d3de30fe9999f76746b8ce1f87e3ccedd85f9e1b16deaee50884ca47e124d69d96b26daec050b20854
-  data.tar.gz: c0a6af825600cb6c52ac130bd14b9841ecea688be13c25779ccc65275329b564982ad322f014bb1db62b319402f4293b817eebcee9e94460713575a067b2797b
+  metadata.gz: 7e9358be11527f83d43d7d63c310b71f954c4aed97c6a83cdeccd8dc040e501c394e028eb662e08bc876a6710f395b185b9eecf96e8e92d06e97376f532674d5
+  data.tar.gz: 5287da9dc805e5bf78fddb3bb1c0d47b46cf4702b1be881fea00c8d319bde17b59c140d2544fc01d737e611849334acf56a542fe30d8ba50525410549d59c9b0

data/Gemfile.lock

@@ -1,25 +1,12 @@
 PATH
   remote: .
   specs:
-    stackify-api-ruby (1.0.0)
-      activesupport (~> 4.1, >= 4.1.1)
+    stackify-api-ruby (1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.1.4)
-      i18n (~> 0.6, >= 0.6.9)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.1)
-      tzinfo (~> 1.1)
-    i18n (0.6.11)
-    json (1.8.1)
-    minitest (5.4.0)
     rake (0.9.6)
-    thread_safe (0.3.4)
-    tzinfo (1.2.1)
-      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -24,14 +24,13 @@ After you install stackify-api-ruby you need to run the generator:
 
     $ rails g stackify --api_key=your_api_key
 
-The generator creates a file under config/initializers/stackify.rb configuring stackify-api-ruby with your API key. You can change default settings there.
+The generator creates a file 'config/initializers/stackify.rb' configuring stackify-api-ruby with your API key. You can change default settings there.
 
 Usage: Logging
 ------------------
-
 ### Rails Environment
 
-stackify-api-ruby starts working with start of Rails. Every occured error will be cought and sent to Stackify automatically. The same situation with logs - you just use the Rails logger as usual:
+stackify-api-ruby starts with start of Rails. Every error, which occurs within your application, will be cought and sent to Stackify automatically. The same situation with logs - you just use the Rails logger as usual:
 
     Rails.logger.info "Some log message"
 
@@ -46,8 +45,8 @@ After that you need to make base configuration:
     Stackify.setup do |config|
       config.api_key = "your_api_key"
       config.env = :development
-      config.app_name =  "Your's app name"
-      config.app_location =  "/somewhere/public"
+      config.app_name = "Your's app name"
+      config.app_location = "/somewhere/public"
     end
 
 "api_key" - it's you key for Stackify. "app-location" - it's location of your application for Nginx/Apache(for Nginx it's value of 'root', for Apache it's value of 'DocumentRoot' at config files).
@@ -61,18 +60,6 @@ You can set minimal level of logs, which should be caught by gem:
 
     config.log_level = :error
 
-By default, gem sends logs to Stackify every 60 seconds, you can increase this value to higher if need:
-
-    config.send_interval = 60 #value in seconds, could not be less than 60 seconds
-
-All logs, errors, and metrics are queued within the gem and uploaded on a background thread. By default, the maximum amount of logs is 1,000 log items, you can decrease this value:
-
-    config.queue_max_size = 600
-
-To help prevent flooding the system there is a parameter - max amount of the same error per minute:
-
-    config.flood_limit = 100
-
 If you want to use proxy for sendig request, you can do it in such way:
 
     config.with_proxy = true
@@ -81,7 +68,7 @@ If you want to use proxy for sendig request, you can do it in such way:
     config.proxy_user = nil
     config.proxy_pass = nil
 
-For logging own work stackify-api-rubystackify-api-rubygem uses such logger:
+For logging own work stackify-api-ruby uses such logger:
 
     config.logger = Logger.new(File.join(Rails.root, "log", "stackify.log"))
 
@@ -124,7 +111,7 @@ There are four different types of metrics:
 
 We can configure every metric with settings:
 
-        settings  = MetricSettings.new
+        settings = MetricSettings.new
         settings.autoreport_zero_if_nothing_reported = true
         # or
         settings.autoreport_last_value_if_nothing_reported = true

data/lib/core_ext/core_ext.rb

@@ -0,0 +1,3 @@
+require 'json'
+require 'core_ext/object'
+require 'core_ext/fixnum'

data/lib/core_ext/fixnum.rb

@@ -0,0 +1,17 @@
+class Fixnum
+  SECONDS_IN_MINUTE = 60
+  SECONDS_IN_HOUR =  60 * SECONDS_IN_MINUTE
+  SECONDS_IN_DAY = 24 * SECONDS_IN_HOUR
+
+  def days
+    self * SECONDS_IN_DAY
+  end
+
+  def minutes
+    self * SECONDS_IN_MINUTE
+  end
+
+  def ago
+    Time.now - self
+  end
+end

data/lib/core_ext/object.rb

@@ -0,0 +1,9 @@
+class Object
+  def try(*a, &b)
+    if a.empty? && block_given?
+      yield self
+    else
+      public_send(*a, &b) if respond_to?(a.first)
+    end
+  end
+end

data/lib/generators/stackify/templates/stackify.rb

@@ -1,11 +1,8 @@
 Stackify.setup do |config|
   config.api_key = '<%= options[:api_key] %>'
   #config.mode = :both
-  #config.app_name =  "Your's app name"
+  #config.app_name = "Your's app name"
   #config.env = :development
-  #config.flood_limit = 100
-  #config.queue_max_size = 1000
-  #config.send_interval = 60 #sec
   #config.log_level = :error
   #config.logger = Logger.new(File.join(Rails.root, 'log', 'stackify.log'))
   #config.logger.level = Logger::INFO

data/lib/stackify-api-ruby.rb

@@ -1,6 +1,6 @@
 require 'stackify/version'
 require 'stackify/utils/methods'
-require 'active_support/core_ext' unless defined? Rails
+require 'core_ext/core_ext' unless defined? Rails
 
 module Stackify
 
@@ -39,14 +39,14 @@ module Stackify
     end
 
     def setup
+      @workers = []
       yield(configuration) if block_given?
       if configuration.is_valid?
         @status = STATUSES[:working]
-        @workers = []
       else
         msg = "Stackify's configuration is not valid!"
         configuration.errors.each do |error_msg|
-          msg += "\n"+error_msg
+          msg += "\n" + error_msg
         end
         raise msg
       end
@@ -70,6 +70,7 @@ module Stackify
     end
 
     def shutdown_all caller_obj=nil
+      Stackify.status = Stackify::STATUSES[:terminating]
       @workers.each do |worker|
         worker.shutdown! unless worker.equal? caller_obj
       end
@@ -116,6 +117,8 @@ module Stackify
           t1.join
           t2.join if t2
         end
+      else
+        Stackify.log_internal_error "Stackify is not properly configured! Errors: #{Stackify.configuration.errors}"
       end
     end
 

data/lib/stackify/authorization/authorizable.rb

@@ -9,7 +9,7 @@ module Stackify::Authorizable
     @@authorized = false
     @@auth_lock = Mutex.new
     @@auth_client = nil
-        
+
     def authorize attempts=3, delay_time = 20
       @@auth_lock.synchronize do
         return unless @@auth_client.nil?
@@ -19,7 +19,7 @@ module Stackify::Authorizable
     end
 
     def authorized?
-      @@auth_lock.synchronize do 
+      @@auth_lock.synchronize do
         @@authorized
       end
     end

data/lib/stackify/authorization/authorization_client.rb

@@ -1,8 +1,7 @@
 module Stackify::Authorizable
-
   class AuthorizationClient < Stackify::HttpClient
 
-    BASE_URI = URI('https://dev.stackify.com/api/Metrics/IdentifyApp')
+    BASE_URI = URI("#{Stackify.configuration.base_api_url}/Metrics/IdentifyApp")
 
     def initialize
       super

data/lib/stackify/env_details.rb

@@ -9,13 +9,13 @@ module Stackify
     def initialize
       rails_info = defined?(Rails) ? Rails::Info.properties.to_h : nil
       @info =  rails_info || { 'Application root' => Dir.pwd, 'Environment' => 'development'}
-      @request_details = nil
+      @request_details = {}
       @app_name = app_name
       app_location = Stackify.configuration.app_location || @info['Application root']
       @details = {
         'DeviceName' => Socket.gethostname,
         'AppLocation' => app_location,
-        'AppName' => @app_name, 
+        'AppName' => @app_name,
         'ConfiguredAppName' => @app_name,
         'ConfiguredEnvironmentName' =>@info['Environment']
       }
@@ -73,7 +73,7 @@ module Stackify
     end
 
     def cookies env
-      env['action_dispatch.cookies'].to_h
+      env['action_dispatch.cookies'].try(:to_h)
     end
 
     def headers env

data/lib/stackify/error.rb

@@ -40,14 +40,14 @@ module Stackify
           'Message' => message,
           'ErrorType' => error_type.to_s,
           'ErrorTypeCode' => nil,
-          'Data' => { user_id: '1'},
+          'Data' => {},
           'SourceMethod' => source_method,
         },
         'EnvironmentDetail' => env.auth_info,
-        'WebRequestDetail' => env.request_details.try{ |d| d['webrequest_details'] },
-        'ServerVariables' => env.request_details.try{ |d| d['server_variables'] },
+        'WebRequestDetail' => env.request_details.try{ |d| d.fetch('webrequest_details', '') },
+        'ServerVariables' => env.request_details.try{ |d| d.fetch('server_variables', '') },
         'CustomerName' => 'Customer',
-        'UserName' => @context['user']
+        'UserName' => @context.fetch('user', '')
       }
     end
 

data/lib/stackify/http_client.rb

@@ -11,9 +11,6 @@ module Stackify
     }
     attr_reader :response, :errors
 
-    def initialize
-    end
-
     private
 
     def send_request uri, body, headers = HEADERS

data/lib/stackify/logger_client.rb

@@ -7,23 +7,27 @@ module Stackify
     end
 
     def log level, msg
-      if acceptable? level, msg && Stackify.working?
-        worker = Stackify::AddMsgWorker.new
-        task = log_message_task level, msg
-        worker.async_perform PERIOD, task
+      Stackify::Utils.do_only_if_authorized_and_mode_is_on Stackify::MODES[:logging] do
+        if acceptable? level, msg && Stackify.working?
+          worker = Stackify::AddMsgWorker.new
+          task = log_message_task level, msg
+          worker.async_perform PERIOD, task
+        end
       end
     end
 
     def log_exception level= :error, ex
       if ex.is_a?(Stackify::StackifiedError)
-        if acceptable? level, ex.message && Stackify.working?
-          if @@errors_governor.can_send? ex
-            worker = Stackify::AddMsgWorker.new
-            task = log_exception_task level, ex
-            worker.async_perform PERIOD, task
-          else
-            Stackify.internal_log :warn,
-            "LoggerClient: logging of exception with message \"#{ex.message}\" is skipped - flood_limit is exceeded"
+        Stackify::Utils.do_only_if_authorized_and_mode_is_on Stackify::MODES[:logging] do
+          if acceptable? level, ex.message && Stackify.working?
+            if @@errors_governor.can_send? ex
+              worker = Stackify::AddMsgWorker.new
+              task = log_exception_task level, ex
+              worker.async_perform PERIOD, task
+            else
+              Stackify.internal_log :warn,
+              "LoggerClient: logging of exception with message \"#{ex.message}\" is skipped - flood_limit is exceeded"
+            end
           end
         end
       else
@@ -34,7 +38,9 @@ module Stackify
     private
 
     def acceptable? level, msg
-      Stackify.is_valid? && is_correct_log_level?(level) && is_not_internal_log_message?(msg) && is_appropriate_env?
+      Stackify.is_valid? && is_correct_log_level?(level) &&
+        is_not_internal_log_message?(msg) &&
+        is_appropriate_env?
     end
 
     def is_not_internal_log_message? msg

data/lib/stackify/logger_proxy.rb

@@ -27,7 +27,7 @@ module Stackify
       if block
         block.call
       else
-        args[0]
+        args.flatten[0]
       end
     end
 

data/lib/stackify/logs_sender.rb

@@ -1,7 +1,7 @@
 module Stackify
   class LogsSender < HttpClient
 
-    LOGS_URI = URI('https://dev.stackify.com/api/Log/Save')
+    LOGS_URI = URI("#{Stackify.configuration.base_api_url}/Log/Save")
 
     def start
       worker = Stackify::Worker.new 'Main sending thread'
@@ -67,7 +67,9 @@ module Stackify
         'Logger' => 'Rails logger',
         'AppName' => details['AppName'],
         'AppNameID' => details['AppNameID'],
+        'Env' => details['Env'],
         'EnvID' => details['EnvID'],
+        'AppEnvID' => details['AppEnvID'],
         'ServerName' => details['DeviceName'],
         'Msgs' => msgs,
         'AppLoc' => details['AppLocation'],

data/lib/stackify/metrics/metrics_sender.rb

@@ -1,10 +1,7 @@
 module Stackify::Metrics
   class MetricsSender < Stackify::HttpClient
-    SUBMIT_METRIS_URI = URI('https://dev.stackify.com/api/Metrics/SubmitMetricsByID')
-    GET_METRIC_INFO_URI = URI('https://dev.stackify.com/api/Metrics/GetMetricInfo')
-
-    def initialize
-    end
+    SUBMIT_METRIS_URI = URI("#{Stackify.configuration.base_api_url}/Metrics/SubmitMetricsByID")
+    GET_METRIC_INFO_URI = URI("#{Stackify.configuration.base_api_url}/Metrics/GetMetricInfo")
 
     def monitor_info aggr_metric
       if Stackify.authorized?

data/lib/stackify/metrics/monitor.rb

@@ -26,8 +26,6 @@ module Stackify::Metrics
 
   class GetMetricResponse
     attr_accessor :monitor_id
-    def initialize
-    end
   end
 
 

data/lib/stackify/msgs_queue.rb

@@ -33,8 +33,7 @@ module Stackify
           @current_chunk_weight += msg['Ex'].nil? ? LOG_SIZE : ERROR_SIZE
           @current_chunk << msg
           if @current_chunk_weight >= CHUNK_MIN_WEIGHT
-            self.old_push(@current_chunk)
-            reset_current_chunk
+            push_current_chunk
           end
         else
           Stackify.log_internal_error "MsgsQueue: add_msg should get hash, but not a #{msg.class}"

data/lib/stackify/utils/configuration.rb

@@ -2,13 +2,13 @@ module Stackify
 
   class Configuration
 
-    attr_accessor :api_key, :app_name, :app_location, :env, :log_level, :flood_limit,
-                  :queue_max_size, :logger, :send_interval, :with_proxy,
-                  :proxy_host, :proxy_port, :proxy_user, :proxy_pass, :mode
+    attr_accessor :api_key, :app_name, :app_location, :env, :log_level, :logger, :with_proxy,
+                  :proxy_host, :proxy_port, :proxy_user, :proxy_pass, :mode, :base_api_url
 
-    attr_reader :errors
+    attr_reader :errors, :send_interval, :flood_limit, :queue_max_size
 
     def initialize
+      @base_api_url = 'https://api.stackify.com'
       @errors = []
       @api_key = ''
       @env = :production
@@ -27,19 +27,14 @@ module Stackify
 
     def is_valid?
       @errors = []
-      validate_send_interval && validate_mode if validate_config_types
+      validate_mode if validate_config_types
       @errors.empty?
     end
 
     private
-    def validate_send_interval
-      return true if 60 <= @send_interval && @send_interval <= 60000
-      @errors << 'Send interval is not correct!'
-    end
 
     def validate_config_types
       validate_api_key &&
-      validate_flood_limit_queue_max_size_and_send_interval &&
       validate_log_level &&
       validate_mode_type
     end
@@ -50,19 +45,8 @@ module Stackify
     end
 
     def validate_api_key
-      return true if  @api_key.is_a? String
-      @errors << 'API_KEY should be a String'
-    end
-
-    def validate_flood_limit_queue_max_size_and_send_interval
-      answer = true
-      { 'Flood limit' => @flood_limit, "Queue's max size" => @queue_max_size, 'Send interval' => @send_interval }.each_pair do |k, v|
-        unless v.is_a? Integer
-          answer = false
-          @errors << "#{k} should be an Integer"
-        end
-      end
-      answer
+      return true if  @api_key.is_a?(String) && !@api_key.empty?
+      @errors << 'API_KEY should be a String and not empty'
     end
 
     def validate_log_level

data/lib/stackify/version.rb

@@ -1,3 +1,3 @@
 module Stackify
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/stackify-api-ruby.gemspec

@@ -5,7 +5,7 @@ require 'stackify/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'stackify-api-ruby'
-  spec.version       = '1.0.0'
+  spec.version       = '1.0.1'
   spec.authors       = ['Stackify']
   spec.email         = ['support@stackify.com']
   spec.summary       = 'Stackify API for Ruby'
@@ -18,8 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.6' 
+  spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 0'
-  spec.add_runtime_dependency 'activesupport', '~> 4.1', '>= 4.1.1'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackify-api-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Stackify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-05 00:00:00.000000000 Z
+date: 2014-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,26 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.1
 description: Stackify Logs and Metrics API for Ruby
 email:
 - support@stackify.com
@@ -65,15 +45,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
 - README.md
 - Rakefile
+- lib/core_ext/core_ext.rb
+- lib/core_ext/fixnum.rb
+- lib/core_ext/object.rb
 - lib/generators/stackify/stackify_generator.rb
 - lib/generators/stackify/templates/stackify.rb
 - lib/stackify-api-ruby.rb

data/.rspec

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

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 Dolgishev Victor
-
-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.