chili_logger 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0baddcb177c1e5a6676aa3a60040e37b17397958348944ff4f0b980b4c37bef2
-  data.tar.gz: 8511fd8734a086ec0b8fd82dea6329aa8e4bd351f6daa0405fa519d29b401c2c
+  metadata.gz: 343e9ca7482069bf214252cd550112502f9187f65182d5aaadd5bfde3d61fe8a
+  data.tar.gz: cee89f157a89466d67f558a2a86adbb174b4c4a866cb1eb607650465ed1a8e88
 SHA512:
-  metadata.gz: 90f1f25ebd08ea66819dd74b86d05a073de1d317b7df3428e4bcda6ecfd5f94f7db5d907acbeed7a2ba5b7555a50e07e9a2d12d1a1217ab0571a4b03f8012318
-  data.tar.gz: 9319b3f0ffb1daf8800615873068bd96a4502424452009ca4a3683c776a3a4cd7231ff162c7bb68ec563898202436062d0cea0da3c4a9361db432a3b260e9527
+  metadata.gz: 54a9ac360ac8b8df8cec30451c061af1fabb935b5cfa7be55eb315b8b40f55fd36d939d6c75f5f7f7817025be9c000e3f75c6877e0e2261287a527d0704389a2
+  data.tar.gz: bbd90e9561f1fffbdd56e5e784ae2e665220f83a4adf38b6bd0a733ef355004a656fadb30ce5d0991699393f60bba6453cde7cc373385ddfa3bfd51dc8e0414d

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    chili_logger (0.0.5)
-      aws-sdk
+    chili_logger (0.0.6)
+      aws-sdk (~> 2.9, >= 2.9.0)
       bunny
       httparty
 

data/README.md

@@ -1,8 +1,10 @@
 # ChiliLogger
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chili_logger`. To experiment with that code, run `bin/console` for an interactive prompt.
+ChiliLogger is gem developed for internal use in Chiligum Creatives. It is used to monitor our applications and generate logs with some uniformization.
 
-TODO: Delete this and the text above, and describe your gem
+## How it works
+
+---
 
 ## Installation
 
@@ -60,18 +62,42 @@ You ALSO MUST set error_handler and error_handler_config. The error handler is t
 Please note that if ChiliLogger tries to publish a log and both the Message Broker and the Error Handler are simultaneously down, the log will be discarded. This behavior makes sure logging problems never cause the app to break.
 
 
+---
+
+## Basic Usage
+The easiest way to use ChiliLogger is with the `publish_instant_log` method. It requires three arguments: `desc`, `agent` and `main_content`, which are used to create the log. All of them are optional arguments and have default values:
+```ruby
+desc = { type: }
+ChiliLogger.instance.publish_instant_log(desc, agent, log)
+
+
+ChiliLogger.instance.publish_instant_log
+```
+
+
+
+Notice that ChiliLogger uses the Singleton pattern. So, to call its methods, you must first access the instance method. Calling ChiliLogger.new will return an error:
+```ruby
+ChiliLogger.publish_instant_log(desc, agent, log)
+# NoMethodError: private method `new' called for ChiliLogger:Class
 
+ChiliLogger.instance.publish_instant_log(desc, agent, log)
+# works fine
+```
 
-## Usage
+---
 
-TODO: Write usage instructions here
+## Advanced Usage
 
+---
 ## 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]/chili_logger.

data/chili_logger.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://gitlab.com/chiligumdev/chili_logger'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
-  spec.add_dependency 'aws-sdk'
+  spec.add_dependency 'aws-sdk', '~> 2.9', '>= 2.9.0'
   spec.add_dependency 'bunny'
   spec.add_dependency 'httparty'
 

data/lib/chili_logger/version.rb

@@ -1,3 +1,3 @@
 class ChiliLogger
-  VERSION = '0.0.5'
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chili_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - lucas sandeville
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.9.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.9.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
@@ -71,8 +77,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- chili_logger-0.0.1.gem
-- chili_logger-0.0.3.gem
 - chili_logger.gemspec
 - lib/brokers/rabbit_broker.rb
 - lib/chili_logger.rb