tgbot 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d47acdf7d9efc0bbc1046ec8da783f7275bf2f47
-  data.tar.gz: f5307a153d8b7d040ac8d89f9691ce0bb5d8bba4
+  metadata.gz: f1e994fa95298f4a1c13b770fd4d6f9543ef5711
+  data.tar.gz: 06facef85842d55e084dc662e631e99814119ac1
 SHA512:
-  metadata.gz: 8c89444e9d5716ce16dbd3f4789558e060fb8653d1550d18489430f713341ad43010cec7a3f5d8d050c9e1e72e4640e107a5718ffade5d8541ff4c25457c066c
-  data.tar.gz: 3f25c02feffb114ef4f20e6efa2608fdebe23706df4a0903556679b433194e14e1eff9ff15e7aa600041e033540d67c40c0764fc5cb2e5268e8af75d19bf7eea
+  metadata.gz: f84b17b66ed508c4f18f2df27cdad3e3e4d8db76920feef9173157c41879f5ddc1bc401d5adc0b6456d0238c88f58b6d999337da2bd7b0e8175bd5298aa63922
+  data.tar.gz: 82cc40adf4e468e25135e2e9f31ae4589f0a94a19a3151ab39524fe187083c73071a9970da61b0c57245e35514f3e0416be15e5ac0ce040bef5e5b099f3a47a6

data/.gitignore

@@ -1,9 +1,9 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in tgbot.gemspec
-gemspec
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tgbot.gemspec
+gemspec

data/README.md

@@ -1,6 +1,8 @@
-# `Tgbot`
+# Tgbot
 
 [![Gem Version](https://badge.fury.io/rb/tgbot.svg)](https://badge.fury.io/rb/tgbot)
+![Bot API Version](https://img.shields.io/badge/Bot%20API-3.2-blue.svg?style=flat-square)
+![](https://img.shields.io/badge/License-MIT-lightgrey.svg?style=flat-square)
 
 A tiny but easy-to-use wrapper of [Telegram Bot API](https://core.telegram.org/bots/api).
 
@@ -10,11 +12,14 @@ A tiny but easy-to-use wrapper of [Telegram Bot API](https://core.telegram.org/b
 
 ## Usage
 
-See [example.rb](example.rb).
+See [example.rb](example.rb) or [usage.md](usage.md).
 
 ## Todo
 
 - improve DSL
+- add sqlite, then
+  + add session
+  + add privilege
 
 ## Contribute
 

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "tgbot"
-
-# 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(__FILE__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tgbot"
+
+# 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(__FILE__)

data/bin/setup

@@ -1,8 +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
+#!/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/example.rb

@@ -68,7 +68,7 @@ Tgbot.run TOKEN, proxy: 'https://127.0.0.1:1080' do |bot|
 
   bot.before do |update|
     log ">> Processing ##{update.id}"
-    log "@#{update.message&.from.username}: #{update.text}", 3
+    log "@#{update.message&.from&.first_name}: #{update.text}", 3
   end
   bot.after do |update|
     if update.done?
@@ -101,7 +101,7 @@ Tgbot.run TOKEN, proxy: 'https://127.0.0.1:1080' do |bot|
     send_message Array.new(text&.match(/\d+/)&.to_s.to_i || 1){ ['🌞', '🌚'].sample }.join
   end
   bot.get 'roll' do
-    send_message rand(text&.match(/\d+/)&.to_s.to_i || 100).to_s
+    send_message rand(text&.match(/\d+/)&.to_s.to_i.nonzero? || 100).to_s
   end
 
 end

data/lib/tgbot/dsl.rb

@@ -42,8 +42,7 @@ module Tgbot
       rescue Interrupt
         @procs[:finish]&.call
       rescue => e
-        puts e
-        puts e.backtrace
+        puts e.backtrace.unshift(e.to_s).join("\n")
         retry
       end
     end
@@ -54,4 +53,7 @@ module Tgbot
   def self.run(token, **opts, &blk)
     DSL.new(token, **opts).run(&blk)
   end
+  def self.new(token, **opts)
+    DSL.new(token, **opts)
+  end
 end

data/lib/tgbot/version.rb

@@ -1,3 +1,3 @@
 module Tgbot
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/tgbot.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
 
-  spec.add_dependency 'faraday', '~> 0.12.1'
+  spec.add_dependency 'faraday', '~> 0.13.1'
   spec.add_dependency 'mimemagic', '~> 0.3.2'
   spec.required_ruby_version = '~> 2.4.0'
 end

data/usage.md

@@ -0,0 +1,99 @@
+# Tgbot.Usage
+
+Since the implementation is so tiny, you can just review source
+code to understand usage.
+
+## Example and Explanation
+
+### Hello world
+
+```ruby
+Tgbot.run TOKEN, proxy: 'https://127.0.0.1:1080' do |bot|
+  bot.get 'hello' do reply 'world' end
+end
+```
+
+This can be broken into: (with the same effect)
+
+```ruby
+bot = Tgbot::DSL.new TOKEN, proxy: 'https://127.0.0.1:1080'
+bot.get 'hello' do reply 'world' end
+bot.run
+```
+
+Here the "`bot`" is actually an instance of `Tgbot::DSL`.
+
+### MainLoop Model
+
+Original Model:
+
+```ruby
+loop { updates = get_updates; updates.each { |update| ... } }
+```
+
+Only deal with `Update`:
+
+```ruby
+loop_get_updates { |update| ... }
+```
+
+Which is our `mainloop`: (see [runner.rb#L15](lib/tgbot/runner.rb#L15))
+
+```ruby
+mainloop { |update| ... }
+```
+
+### DSL
+
+```ruby
+bot.start { puts "#{bot.name}, at your service" }
+bot.finish { puts "byebye." }
+bot.before { |update| puts "Processing ##{update.id}." }
+bot.after { |update| puts "Processed ##{update.id}." }
+bot.on /\.r(\d+)?d(\d+)?/ do |matched|
+  p self #=> #<Update id=123456789>
+  t = matched[1]&.to_i || 1
+  n = matched[2]&.to_i || 6
+  reply _ = Array.new(t){rand n}.to_s rescue 'bad roll!'
+end
+bot.get 'cuxia', 'blind' do
+  name = message&.from&.first_name
+  next unless name
+  send_message "#{name} cuxia!"
+  if rand < 0.5
+    self.retry 2 #=> at most retry 2 times, default 1 if not given arg
+  end
+  done! #=> prevent any retry, mark and drop
+end
+bot.alias 'cuxia', 'woc', 'wodemaya'
+```
+
+- start: will be run once when `bot.run`.
+- finish: will be run once when <kbd>Ctrl</kbd><kbd>C</kbd>.
+- before: do something with every `Update` before processing.
+- after: do something with every `Update` after processing.
+- on/get: match text and execute code in `Update` instance.
+
+
+
+As you can see, the dsl is still weak. Wish for your idea!
+
+### Call Bot API
+
+You can call bot API at any place with `bot.`.
+
+```ruby
+p bot.get_me
+bot.get 'debug' do
+  p bot.get_me
+end
+```
+
+Params and returns are Hash.
+
+### Upgrade Bot API
+
+- Edit [types.txt](tools/types.txt) or [methods.txt](tools/methods.txt).
+- `rake json`
+
+Current version of Bot API: 3.2.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tgbot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - hyrious
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-03 00:00:00.000000000 Z
+date: 2017-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.1
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: mimemagic
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +98,7 @@ files:
 - tools/methods.txt
 - tools/types.json
 - tools/types.txt
+- usage.md
 homepage: https://github.com/hyrious/tgbot
 licenses:
 - MIT
@@ -118,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Telegram Bot API