trakerr_client 1.0.1 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2b434e83d7d3cefa590ff10e187fda178feddea
+  data.tar.gz: d7e76499fdbc5d9d8ee4a9ca7b29adcb2b44e986
+SHA512:
+  metadata.gz: 9a66675d47158159a9a1f25d597fc1e90d8ac302e31fa5aa016952d3ab1800981fba3bcc1829a0e68a78d8cdb4ee86600dc9d64960d6617486c02669433108ff
+  data.tar.gz: 64b2727383dc9e10fed59ca9cb2e3945ad310cd2ea5d8faf6dc3f1409fed1392c02692536bab7e6fa50e246cc8c9819d47b884b75c3e82832fb316fbd8f14d08

data/README.md

@@ -1,8 +1,13 @@
-# trakerr_client
+# Trakerr-ruby API client
 Get your application events and errors to Trakerr via the *Trakerr API*.
 
 You will need your API key to send events to trakerr.
 
+## Overview
+
+- REST API version: 2.0.0
+- Package (SDK) version: 2.0.0
+
 ## Requirements.
 
 Ruby 1.9.3+
@@ -62,22 +67,27 @@ require 'trakerr/lib/trakerr'
 ```
 
 ### Option 1: Sending a default error to Trakerr
-A trivial case would involve calling `SendException` for a caught exception.
+A trivial case would involve calling `log` for a caught exception.
 ```ruby
 def main()
     testApp = Trakerr::TrakerrClient.new("Api key here", "Application version number", "deployment type")
     begin
-        raise ArgumentError
-    rescue Exception => e
-        testApp.SendException(e)
+        raise ZeroDivisionError, "Oh no!"
+    rescue ZeroDivisionError => exception
+        #You can leave the hash empty if you would like to use the default values.
+        #We recommend that you supply a user and a session for all events,
+        #and supplying an "evntname" and "evntmessage" for non errors.
+        testApp.log({"user"=>"jack@trakerr.io", "session"=>"7"}, exception) 
     end
 end
 ```
 
-`SendExecption` may also take in a log_level and a classification, but will otherwise default all of the AppEvent properties.
+Along with the `"user"` and `"session"`; the hash can also take `"evntname"` and `"evntmessage"`. Note that these two will be filled in automatically for errors you rescue if you do not provide them, so we suggest giving them for non-errors.
+
+`log` may also take in a log_level and a classification (We recommend you providing this **especially** if you send a warning or below), but will otherwise default all of the AppEvent properties.
 
 ### Option 2: Sending an error to Trakerr with Custom Data
-If you want to populate the `AppEvent` with custom properties, you can manually create an `AppEvent` and populate it's fields. Pass it to the `SendEvent` to then send the AppEvent to Trakerr. See the `AppEvent` API for more information on it's properties.
+If you want to populate the `AppEvent` fully with custom properties (log only accepts the minimum set of useful custom properties to utilize Trakerr's rich feature set), you can manually create an `AppEvent` and populate it's fields. Pass it to the `SendEvent` to then send the AppEvent to Trakerr. See the `AppEvent` API for more information on it's properties.
 
 ```ruby
 def main()
@@ -95,7 +105,7 @@ end
 ```
 
 ### Option 3: Send a non-exception to Trakerr
-Trakerr accepts events that aren't errors. To do so, pass false to the CreateAppEvent Exception field to not attach a stacktrace to the event (if you don't need it). Be sure to pass values in to the rest of the parameters since the default values will most likely not be useful for you!
+Trakerr accepts events that aren't errors. To do so, pass false to the CreateAppEvent Exception field to not attach a stacktrace to the event (if you don't need it). Be sure to pass values in to the rest of the parameters since the default values will most likely not be useful for you if you don't have a stacktrace!
 ```ruby
 def main()
     testApp = Trakerr::TrakerrClient.new("Api key here", "Application version number", "deployment type")
@@ -118,9 +128,7 @@ TrakerrClient's constructor initalizes the default values to all of TrakerrClien
                    contextDeploymentStage = "development")
 ```
 
-The contextEnvName name is intended to be used as a string identifier as to what your codebase is for; release, development, prototype. You can use it for whatever you denote as useful. The contextAppVersion is useful for a codebase version identifier, or perhaps some other useful metric for the error.
-
-The TrakerrClient struct however has a lot of exposed properties. The benifit to setting these after you create the TrakerrClient is that AppEvent will default it's values against the TrakerClient that created it. This way if there is a value that all your AppEvents uses, and the constructor default value currently doesn't suit you; it may be easier to change it in TrakerrClient as it will become the default value for all AppEvents created after. A lot of these are populated by default value by the constructor, but you can populate them with whatever string data you want. The following table provides an in depth look at each of those.
+The TrakerrClient class however has a lot of exposed properties. The benefit to setting these immediately after after you create the TrakerrClient is that AppEvent will default it's values against the TrakerClient that created it. This way if there is a value that all your AppEvents uses, and the constructor default value currently doesn't suit you; it may be easier to change it in TrakerrClient as it will become the default value for all AppEvents created after. A lot of these are populated by default value by the constructor, but you can populate them with whatever string data you want. The following table provides an in-depth look at each of those.
 
 
 Name | Type | Description | Notes

data/generated/lib/trakerr_client/models/app_event.rb

@@ -1,7 +1,7 @@
 =begin
-#Trakerr API
+Trakerr API
 
-#Get your application events and errors to Trakerr via the *Trakerr API*.
+Get your application events and errors to Trakerr via the *Trakerr API*.
 
 OpenAPI spec version: 1.0.0
 

data/test_app.rb

@@ -1,3 +1,21 @@
+=begin
+Trakerr API Test App
+
+Get your application events and errors to Trakerr via the *Trakerr API*.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
 require 'rubygems'
 require_relative 'trakerr/lib/trakerr'
 
@@ -12,17 +30,23 @@ def main()
     #Send exception to Trakerr with default values.
     begin
         raise ZeroDivisionError, "Oh no!"
-    rescue => exception
-        testApp.SendException(exception) #you can change the log_level and the classification too if you would like to!
+    rescue ZeroDivisionError => exception
+        #You can leave the hash empty if you would like to use the default values.
+        #We recommend that you supply a user and a session for all events,
+        #and supplying an "evntname" and "evntmessage" for non errors.
+        testApp.log({"user"=>"jack@trakerr.io", "session"=>"7"}, exception) 
     end
     
-    #Get an AppEvent to populate the class with custom data and then send it to Trakerr
+    #Get an AppEvent to populate the class with custom data and then send it to Trakerr.
+    #Simple custom data can be send through log.
     begin
         raise ArgumentError
-    rescue Exception => e
+    rescue ArgumentError => e
         appev = testApp.CreateAppEvent(e, "Error")
         appev.event_user = "john@trakerr.io"
         appev.event_session = "5"
+        appev.context_app_browser = "Chrome"
+        appev.context_app_browser_version = "57.x"
 
         testApp.SendEvent(appev)
     end
@@ -31,6 +55,8 @@ def main()
     appev2 = testApp.CreateAppEvent(false, "Info", "User failed auth", "400 err", "User error")
     appev2.event_user = "jill@trakerr.io"
     appev2.event_session = "3"
+    appev2.context_app_browser = "Edge"
+    appev2.context_app_browser_version = "40.15063.0.0"
 
     testApp.SendEvent(appev2)
 

data/trakerr/lib/event_trace_builder.rb

@@ -1,3 +1,21 @@
+=begin
+Trakerr API
+
+Get your application events and errors to Trakerr via the *Trakerr API*.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
 require "trakerr_client"
 
 

data/trakerr/lib/trakerr.rb

@@ -1,3 +1,21 @@
+=begin
+Trakerr API
+
+Get your application events and errors to Trakerr via the *Trakerr API*.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
 require "event_trace_builder"
 require "trakerr_client"
 require "socket"
@@ -52,8 +70,8 @@ module Trakerr
     #contextEnvName:String: Should be the deployment stage of your program.
     ##
     def initialize(apiKey,
-                   contextAppVersion = "1.0",
-                   contextDeploymentStage = "development")
+                   contextAppVersion="1.0",
+                   contextDeploymentStage="development")
 
       default_config = Trakerr::Configuration.default
       default_config.base_path = default_config.base_path
@@ -129,18 +147,14 @@ module Trakerr
     #eventMessage:String: String representation of the message of the error.
     #Defaults to err.message if err is an exception, unknown if not.
     ##
-    def CreateAppEvent(err, log_level="Error", classification = "issue", eventType = "unknown", eventMessage = "unknown")
-      raise ArgumentError, "All non err arguments are expected strings." unless log_level.is_a? String and classification.is_a? String and eventType is_a? String and eventMessage.is_a? String
+    def CreateAppEvent(err = false, log_level="Error", classification="issue", eventType="unknown", eventMessage="unknown")
+      raise ArgumentError, "All non err arguments are expected strings." unless (log_level.is_a? String) && (classification.is_a? String) && (eventType.is_a? String) && (eventMessage.is_a? String)
       if err != false
         raise ArgumentError, "err is expected instance of exception." unless err.is_a? Exception
-
-        if eventType == nil || eventType == "unknown"
-          eventType = err.class.name
-        end
-
-        if eventMessage == nil || eventMessage == "unknown"
-          eventMessage = err.message
-        end
+     
+        eventType = err.class.name if eventType == "unknown"
+    
+        eventMessage = err.message if eventMessage == "unknown"
 
       end
 
@@ -150,7 +164,7 @@ module Trakerr
 
       begin
         app_event_new.log_level = log_level
-      rescue
+      rescue ArgumentError
         app_event_new.log_level = "error"
       end
       
@@ -158,6 +172,40 @@ module Trakerr
 
       return app_event_new
     end
+    
+    ##
+    #A single line method to send an event to trakerr.
+    #Use may it in a begin-rescue and pass in an error,
+    #or set error to false if you don't need a stacktrace.
+    #arg_hash takes in a few common values that you may want to populate
+    #your app event with in a hash.
+    #arg_hash:Hash: A hash with a key value pair for each of the following elements
+    #{"user": "...", "session": "...", "evntname": "...", "evntmessage": "..."}.
+    #Omit any element you don't need to fill in the event.
+    #If you are NOT sending an error it is recommended that you pass in an evntname and evntmessage.
+    #Remember that all keys are expected strings, and so it may be safer to you use the arrow
+    #operator (=>) so you don't forget to add the space.
+    #error:Exception: The exception you may be sending. Set this to false if you are sending a non-error.
+    #This throws an Argument error if error is not an Exception and it's child classes or false.
+    #log_level:String: The string representation of the level of the error.
+    #classification:String: The string representation on the classification of the issue.
+    ##
+    def log(arg_hash, error, log_level = "error", classification = "issue")
+      raise ArgumentError, "arg_hash is expected to be a hash" unless arg_hash.is_a? Hash
+      raise ArgumentError, "log_level and classification is expected strings." unless (log_level.is_a? String) && (classification.is_a? String)
+
+      app_event = nil
+      if error != false
+        raise ArgumentError, "err is expected instance of exception." unless error.is_a? Exception
+        app_event = CreateAppEvent(error, log_level, classification, arg_hash.fetch("evntname", "unknown"), arg_hash.fetch("evntmessage", "unknown"))
+        
+      end
+      app_event = CreateAppEvent(false,log_level, classification, arg_hash.fetch("evntname", "unknown"), arg_hash.fetch("evntmessage", "unknown")) if app_event.nil?
+      app_event.event_user = arg_hash["user"] if arg_hash.has_key? "user"
+      app_event.event_session = arg_hash["session"] if arg_hash.has_key? "session"
+
+      SendEvent(app_event)
+    end
 
     ##
     #Sends the given AppEvent to Trakerr
@@ -167,20 +215,6 @@ module Trakerr
       @events_api.events_post(FillDefaults(appEvent))
     end
 
-    ##
-    #Sends the given error to Trakerr. Simplest use case for Trakerr in a catch, uses the default values when sending.
-    #You can provide an optional log_level or classification.
-    #error:Exception: The exception that is captured or rescued.
-    #log_level:String: Logging level, currently one of 'debug','info','warning','error', 'fatal', defaults to 'error'. See loglevel in AppEvent for an always current list of values.
-    #classification:String: Optional extra descriptor string. Will default to issue if not passed a value.
-    ##
-    def SendException(error, log_level = "error", classification = "issue")
-      raise ArgumentError, "Error is expected type exception." unless error.is_a? Exception
-      raise ArgumentError, "log_level and classification are expected strings" unless log_level.is_a? String and classification.is_a? String
-      
-      SendEvent(CreateAppEvent(Error, log_level, classification))
-    end
-
     ##
     #Populates the given AppEvent with the client level default values
     #RETURNS: The AppEvent with Defaults filled.
@@ -220,7 +254,7 @@ module Trakerr
       #suffix:String: The suffix string to find the ending index for.
       ##
       def GetTextFromLine(text, prefix, suffix)
-        raise ArgumentError, "All arguments are expected strings." unless text.is_a? String and prefix.is_a? String and suffix.is_a? String
+        raise ArgumentError, "All arguments are expected strings." unless (text.is_a? String) && (prefix.is_a? String) && (suffix.is_a? String)
       
         prefixindex = text.index(prefix)
         return nil if prefixindex == nil

data/trakerr_client.gemspec

@@ -29,11 +29,11 @@ $:.push File.expand_path("../trakerr/lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "trakerr_client"
-  s.version     = "1.0.1"
+  s.version     = "2.0.0"
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Swagger-Codegen"]
+  s.authors     = ["Trakerr Dev Team", "Swagger-Codegen"]
   s.email       = [""]
-  s.homepage    = "https://github.com/swagger-api/swagger-codegen"
+  s.homepage    = "https://trakerr.io"
   s.summary     = "Trakerr API Ruby Gem"
   s.description = "Get your application events and errors to Trakerr via the *Trakerr API*."
   s.license     = "Apache-2.0"
@@ -51,6 +51,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
 
   #s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
+  #REQUIRES GIT INSTALLED
   s.files         = `git ls-files`.split("\n").delete_if {|file| file.include? "spec"}
   s.test_files    = `git ls-files`.split("\n").delete_if {|file| not file.include? "spec"}
   s.executables   = []

metadata

@@ -1,212 +1,194 @@
 --- !ruby/object:Gem::Specification
 name: trakerr_client
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
+- Trakerr Dev Team
 - Swagger-Codegen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.24'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.24.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.24'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.24.3
 - !ruby/object:Gem::Dependency
   name: autotest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.4'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.4'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.4.6
 - !ruby/object:Gem::Dependency
   name: autotest-rails-pure
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.2
 - !ruby/object:Gem::Dependency
   name: autotest-growl
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.16
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.16
 - !ruby/object:Gem::Dependency
   name: autotest-fsevent
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.11
 description: Get your application events and errors to Trakerr via the *Trakerr API*.
@@ -216,9 +198,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - README.md
 - generated/.gitignore
+- generated/.rspec
 - generated/.swagger-codegen-ignore
 - generated/LICENSE
 - generated/README.md
@@ -248,11 +231,6 @@ files:
 - generated/lib/trakerr_client/models/stack_trace_lines.rb
 - generated/lib/trakerr_client/models/stacktrace.rb
 - generated/lib/trakerr_client/version.rb
-- mkgem.sh
-- test_app.rb
-- trakerr/lib/event_trace_builder.rb
-- trakerr/lib/trakerr.rb
-- generated/.rspec
 - generated/spec/api/events_api_spec.rb
 - generated/spec/api_client_spec.rb
 - generated/spec/configuration_spec.rb
@@ -267,32 +245,35 @@ files:
 - generated/spec/models/stacktrace_spec.rb
 - generated/spec/spec_helper.rb
 - generated/trakerr_client.gemspec
+- mkgem.sh
+- test_app.rb
+- trakerr/lib/event_trace_builder.rb
+- trakerr/lib/trakerr.rb
 - trakerr_client.gemspec
-homepage: https://github.com/swagger-api/swagger-codegen
+homepage: https://trakerr.io
 licenses:
 - Apache-2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - generated/lib
 - trakerr/lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Trakerr API Ruby Gem
 test_files:
 - generated/.rspec