telegram-loggerbot-ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad51d6a6a10e4869acd082ed262523c5a9d3eea2
-  data.tar.gz: 501f90f90272f72541cf29a0cd3b1bdf6405744a
+  metadata.gz: 28c42ae72e9892aca97bb0685c76f5ad38b5470d
+  data.tar.gz: b33a12d6e1e759432438a940ab4c08e710f68dff
 SHA512:
-  metadata.gz: 130252c67c15d582657ba6b7842f690694b1163b9545ddbf81bfcfaa6f3f6848f010d6d0ce321acebd2f26cc7ab1af14812b8280da769defe44369d5275a60c0
-  data.tar.gz: b4c5c45ec9641d6e34f8f3a8824ced8c615f0dae7858a0a4f46fc50172621605a5d3c4e880f05b8560cfacbbcc466331d9d06c9b98de9f2392447c1792ca9973
+  metadata.gz: 70e4315d2198a49daed350087eaabe0be4e8dd4f3e2c7e867d0289942d9e9ca62728b4b211bab3aa96dcebc6e4331d4de0da7a7a9687d50c5d047f02c4757b1b
+  data.tar.gz: b554b092dd8ea101f78a564a1e11cda2b43edfc806b12af67dec0fae9610c3207ee1a00190eb9b3962333efa9d699aac79e9d4675580bd6c91f1bef4da93173a

data/.gitignore

@@ -1,51 +1,11 @@
-*.gem
-*.rbc
-/.config
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
 /coverage/
-/InstalledFiles
+/doc/
 /pkg/
 /spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
 /tmp/
-.idea/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
+.idea
+.ruby-*

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/{LICENSE → LICENSE.txt}

@@ -1,6 +1,6 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2017 
+Copyright (c) 2017 Anton Osenenko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -4,25 +4,21 @@
 
 Allows to send event logs directly to the telegram chat
 
-##Installation
+## Installation
 
-Add following line to your Gemfile:
+Add this line to your application's Gemfile:
 
 ```ruby
-gem 'telegram-loggerbot-ruby'
+gem 'loggerbot'
 ```
 
 And then execute:
 
-```
-$ bundle
-```
+    $ bundle
 
-Or install it system-wide:
+Or install it yourself as:
 
-```
-gem install telegram-loggerbot-ruby
-```
+    $ gem install telegram-loggerbot-ruby
 
 ##Usage
 
@@ -33,29 +29,40 @@ gem install telegram-loggerbot-ruby
 Require it to your code:
 
 ```ruby
-require 'telegram/logger_bot'
+require 'telegram/loggerbot'
 ```
 
-Configure with obtained TOKEN and TELEGRAM_USER_ID: 
+Initialize with obtained TOKEN and TELEGRAM_USER_ID: 
 
 ```ruby
 Telegram::LoggerBot.configure do |config|
-  config.token = 'TOKEN'
-  config.chat_id = TELEGRAM_USER_ID
+    config.token = TOKEN                                 # required
+    config.chat_id = USER_ID_OR_CHAT_ID                  # required
+    config.level = Logger::INFO                          # optional, default is Logger::DEBUG
+    config.next_logger = App.existing_logger_instance    # optional
+    config.api = App.existing_telegram_bot_api_instance  # optional
 end
+
+logger = Telegram::LoggerBot.new
 ```
 
-Create new logger:
+or in classic style:
 
 ```ruby
-logger = Telegram::LoggerBot.new
+logger = Telegram::LoggerBot.new(
+    token: TOKEN,                                 # required
+    chat_id: USER_ID_OR_CHAT_ID,                  # required
+    level: Logger::INFO,                          # optional, default is Logger::DEBUG
+    next_logger: App.existing_logger_instance,    # optional
+    api: App.existing_telegram_bot_api_instance   # optional
+)
 ```
 
-You can pass events through LoggerBot to your standard logger:
+You can pass events through LoggerBot to any other logger:
 
 ```ruby
 existing_logger = Logger.new(STDOUT)
-logger = Telegram::LoggerBot.new(existing_logger)
+logger = Telegram::LoggerBot.new(..., next_logger: existing_logger)
 ``` 
 
 Log you events:
@@ -68,6 +75,12 @@ logger.error('MyProgram') { "Text of some errors" }
 logger.fatal('MyProgram') { "Text of some errors" }
 ```
 
+## 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`.
+
 ## Contributing
 
 1. Fork it
@@ -75,3 +88,7 @@ logger.fatal('MyProgram') { "Text of some errors" }
 3. Commit your changes (git commit -am 'Add some feature')
 4. Push to the branch (git push origin my-new-feature)
 5. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "telegram/loggerbot"
+
+# 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

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/lib/telegram/{logger_bot.rb → loggerbot.rb}

@@ -1,10 +1,10 @@
 require 'logger'
 require 'telegram/bot'
 
-require 'telegram/logger_bot/logger'
-require 'telegram/logger_bot/logger_bot'
-require 'telegram/logger_bot/version'
-require 'telegram/logger_bot/configuration'
+require 'telegram/loggerbot/logger'
+require 'telegram/loggerbot/loggerbot'
+require 'telegram/loggerbot/version'
+require 'telegram/loggerbot/configuration'
 
 module Telegram
   module LoggerBot

data/lib/telegram/{logger_bot → loggerbot}/configuration.rb

@@ -1,7 +1,7 @@
 module Telegram
   module LoggerBot
     class Configuration
-      attr_accessor :token, :chat_id
+      attr_accessor :token, :chat_id, :level, :next_logger, :api
     end
   end
 end

data/lib/telegram/{logger_bot → loggerbot}/logger.rb

@@ -1,11 +1,19 @@
 module Telegram
   module LoggerBot
+    TokenMissed = Class.new(ArgumentError)
+    ChatIdMissed = Class.new(ArgumentError)
+
     class Logger < ::Logger
-      def initialize(next_logger = nil, level = nil)
-        @next_logger = next_logger
-        @level = level || (next_logger.level if next_logger) || DEBUG
-        @default_formatter = Formatter.new
-        @api = Telegram::Bot::Api.new(Telegram::LoggerBot.configuration.token)
+      def initialize(args = {})
+        @default_formatter = args[:default_formatter] || Formatter.new
+
+        @level, @chat_id, @token, @next_logger, @api = args.values_at(:level, :chat_id, :token, :next_logger, :api)
+
+        @level ||= Telegram::LoggerBot.configuration.level || DEBUG
+        @chat_id ||= Telegram::LoggerBot.configuration.chat_id || fail(ChatIdMissed)
+        @token ||= Telegram::LoggerBot.configuration.token || fail(TokenMissed)
+        @next_logger ||= Telegram::LoggerBot.configuration.next_logger
+        @api ||= Telegram::LoggerBot.configuration.api || Telegram::Bot::Api.new(@token)
       end
 
       def clear_markdown(str)
@@ -68,7 +76,15 @@ module Telegram
 
       def add(severity, message = nil, progname = nil, &block)
         severity ||= UNKNOWN
-        return true if severity < @level
+
+        if severity < @level
+          if @next_logger
+            return @next_logger.add(severity, message, progname, &block)
+          else
+            return true
+          end
+        end
+
         if message.nil?
           if block_given?
             message = block.dup.call
@@ -78,19 +94,20 @@ module Telegram
           end
         end
 
-        chat_id = Telegram::LoggerBot.configuration.chat_id
         time = Time.now
 
         text = "#{format_severity_icon(severity)}*#{format_severity(severity)}*"
         text << "   _#{clear_markdown(progname)}_" if progname
         text << "\n#{format_time_icon(time)}#{time}"
 
-        @api.send_message(chat_id: chat_id, text: text, parse_mode: 'Markdown')
-        @api.send_message(chat_id: chat_id, text: message)
-
-        return true unless @next_logger
+        @api.send_message(chat_id: @chat_id, text: text, parse_mode: 'Markdown')
+        @api.send_message(chat_id: @chat_id, text: message)
 
-        @next_logger.add(severity, message, progname, &block)
+        if @next_logger
+          @next_logger.add(severity, message, progname, &block)
+        else
+          true
+        end
       end
     end
   end

data/lib/telegram/loggerbot/loggerbot.rb

@@ -0,0 +1,7 @@
+module Telegram
+  module LoggerBot
+    def self.new(args = {})
+      Telegram::LoggerBot::Logger.new(args)
+    end
+  end
+end

data/lib/telegram/{logger_bot → loggerbot}/version.rb

@@ -1,5 +1,5 @@
 module Telegram
   module LoggerBot
-    VERSION = '0.0.1'.freeze
+    VERSION = '0.0.2'.freeze
   end
 end

data/telegram-loggerbot-ruby.gemspec

@@ -1,22 +1,29 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'telegram/logger_bot/version'
+require "telegram/loggerbot/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'telegram-loggerbot-ruby'
-  spec.version       = Telegram::LoggerBot::VERSION
-  spec.authors       = ['Anton Osenenko']
-  spec.email         = ['anton.osenenko@gmail.com']
+  spec.name = "telegram-loggerbot-ruby"
+  spec.version = Telegram::LoggerBot::VERSION
+  spec.authors = ["Anton Osenenko"]
+  spec.email = ["anton.osenenko@gmail.com"]
 
-  spec.summary       = "Telegram Logger Bot"
-  spec.homepage      = 'https://github.com/a0s/telegram-loggerbot-ruby'
-  spec.license = 'MIT'
+  spec.summary = "Telegram Logger Bot"
+  spec.description = "Log your events directly to the Telegram chat"
+  spec.homepage = "https://github.com/a0s/telegram-loggerbot-ruby"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.require_paths = ['lib']
+  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_dependency 'telegram-bot-ruby'
+  spec.add_dependency "telegram-bot-ruby"
 
-  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram-loggerbot-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Anton Osenenko
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-01-26 00:00:00.000000000 Z
+date: 2017-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: telegram-bot-ruby
@@ -30,15 +30,43 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
-description: 
+        version: '1.13'
+- !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'
+description: Log your events directly to the Telegram chat
 email:
 - anton.osenenko@gmail.com
 executables: []
@@ -46,15 +74,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- LICENSE
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
 - README.md
+- Rakefile
+- bin/console
+- bin/setup
 - img/preview1.jpg
 - img/preview2.jpg
-- lib/telegram/logger_bot.rb
-- lib/telegram/logger_bot/configuration.rb
-- lib/telegram/logger_bot/logger.rb
-- lib/telegram/logger_bot/logger_bot.rb
-- lib/telegram/logger_bot/version.rb
+- lib/telegram/loggerbot.rb
+- lib/telegram/loggerbot/configuration.rb
+- lib/telegram/loggerbot/logger.rb
+- lib/telegram/loggerbot/loggerbot.rb
+- lib/telegram/loggerbot/version.rb
 - telegram-loggerbot-ruby.gemspec
 homepage: https://github.com/a0s/telegram-loggerbot-ruby
 licenses:

data/lib/telegram/logger_bot/logger_bot.rb

@@ -1,14 +0,0 @@
-module Telegram
-  module LoggerBot
-    def self.new(obj = nil)
-      case obj
-        when ::Logger
-          Telegram::LoggerBot::Logger.new(obj)
-        when ::NilClass
-          Telegram::LoggerBot::Logger.new
-        else
-          fail("Unknown type of next logger #{obj.inspect}")
-      end
-    end
-  end
-end