telegram_workflow 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73a03ae1f9bea58f5cdc6bd1917107795429c95c2a54b98bd9ae3e8d95dd5bfe
-  data.tar.gz: 762fbb323b0e4529118e7af5c1f5f35b1bad859fcc0b7b036fdc60d57a791f59
+  metadata.gz: edd8db5bb9937c5ae2154339550dc286f10e94c4b8290419ba9795d3e92a0f23
+  data.tar.gz: 26e421252440cbc137c6b25529e1c6cb8746aa63df41afc212724cd5229b8cc5
 SHA512:
-  metadata.gz: 2c1b7bc39edcd1e4c133939aa3c7289b887a9540ba8ff64415b7428f9841e86b0f1f42b46734ba6f1359657e3dc4607e468b5d1a68720c76961a0c66fd80a788
-  data.tar.gz: 5049a58f13c5717412ecd524a7219b8bdbf8d77d24447c5e0471f60c9256fc363b23c95639aed0d97ca0352edc10d1fa349cbc36690fe373da8919de5830d8fa
+  metadata.gz: 827dae61b2e7a63b2f4a36809e72fb79e67e619c8ec3570b11b6a1a1f0fdecb19d445a5ac91005ca3020d2baea9c8eb145311e59f449c411c023b09679be8978
+  data.tar.gz: 83d320d61b074092d6bf6a7783d73a88bed3b04f0ba83e2261108bbf5fc80760694d25736ff01693a4c3f81ce3fe7ed816ebb5298400cb19a3a39fa70255a718

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/.travis.yml

@@ -2,5 +2,8 @@
 language: ruby
 cache: bundler
 rvm:
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
   - 2.7.0
-before_install: gem install bundler -v 2.1.4
+before_install: gem install bundler

data/Gemfile

@@ -5,3 +5,7 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+
+group :test do
+  gem "coveralls", require: false
+end

data/README.md

@@ -1,5 +1,9 @@
 # TelegramWorkflow
 
+[![Build Status](https://travis-ci.org/rsamoilov/telegram_workflow.svg?branch=master)](https://travis-ci.org/rsamoilov/telegram_workflow)
+[![Coverage Status](https://coveralls.io/repos/github/rsamoilov/telegram_workflow/badge.svg?branch=master)](https://coveralls.io/github/rsamoilov/telegram_workflow?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/fd13239262e3550c2193/maintainability)](https://codeclimate.com/github/rsamoilov/telegram_workflow/maintainability)
+
 TelegramWorkflow is a simple utility to help you organize the code to create Telegram bots.
 
 It includes the HTTP client, which implements the complete Telegram API and a set of helpers to improve
@@ -237,6 +241,14 @@ end
 
 Be aware that `TelegramWorkflow.updates.each` call is blocking.
 
+`TelegramWorkflow` accepts all the parameters [getUpdates](https://core.telegram.org/bots/api#getupdates) does.
+
+```ruby
+TelegramWorkflow.updates(timeout: 60, allowed_updates: %w(channel_post edited_channel_post)).each do |params|
+  ...
+end
+```
+
 Since most of the time will be spent on waiting for the Telegram API to respond, you might also want to process the updates in parallel:
 
 ```ruby
@@ -249,6 +261,20 @@ TelegramWorkflow.updates.each do |params|
 end
 ```
 
+Use `stop_updates` call to exit the updates loop:
+
+```ruby
+trap "SIGINT" do
+  TelegramWorkflow.stop_updates
+end
+
+# decrease the timeout to wait no more than 10 seconds when exiting
+TelegramWorkflow.updates(timeout: 10).each do |params|
+  TelegramWorkflow.process(params)
+end
+
+```
+
 ## Customization
 
 Object | Customization
@@ -300,7 +326,21 @@ end
 
 ## Testing
 
-Testing utility provides `send_message` helper to emulate messages sent into the chat. Currently it accepts either `message_text` or `callback_data` as arguments.
+Testing utility provides `send_message` helper to emulate messages sent into the chat.
+
+```ruby
+# send a message
+send_message message_text: "text"
+
+# send CallbackQuery data
+send_message callback_data: "data"
+
+# send InlineQuery data
+send_message inline_data: "data"
+
+# customize the params
+send_message { |params| params[:edited_channel_post] = { text: "message" } }
+```
 
 Also, `subject.client` and `subject.flow` spies are available to track redirects and calls to the API client inside your actions.
 Store your tests under `spec/telegram_actions` or tag them with `type: :telegram_action`.

data/lib/telegram_workflow.rb

@@ -15,7 +15,11 @@ module TelegramWorkflow
     params[:timeout] = timeout if timeout
     params[:allowed_updates] = allowed_updates if allowed_updates
 
-    Updates.new(params).enum
+    (@updates = Updates.new(params)).enum
+  end
+
+  def self.stop_updates
+    @updates && @updates.stop = true
   end
 end
 

data/lib/telegram_workflow/errors.rb

@@ -11,6 +11,12 @@ module TelegramWorkflow::Errors
     end
   end
 
+  class NoSession < StandardError
+    def initialize(msg = "Session could not be fetched for this update.")
+      super
+    end
+  end
+
   class ApiError < StandardError
   end
 

data/lib/telegram_workflow/params.rb

@@ -10,24 +10,25 @@ class TelegramWorkflow::Params
   end
 
   def user
-    @user ||= @params.dig("message", "from") ||
+    @user ||= message&.dig("from") ||
       @params.dig("callback_query", "from") ||
       @params.dig("pre_checkout_query", "from") ||
       @params.dig("shipping_query", "from") ||
       @params.dig("inline_query", "from") ||
-      @params.dig("chosen_inline_result", "from")
+      @params.dig("chosen_inline_result", "from") ||
+      @params.dig("poll_answer", "user")
   end
 
   def language_code
-    user["language_code"]
+    user&.dig("language_code") || "en"
   end
 
   def user_id
-    user["id"]
+    user&.dig("id")
   end
 
   def username
-    user["username"]
+    user&.dig("username")
   end
 
   def chat_id
@@ -38,14 +39,25 @@ class TelegramWorkflow::Params
       @params.dig("edited_channel_post", "chat", "id")
   end
 
+  def message
+    @params["message"] ||
+      @params["edited_message"] ||
+      @params["channel_post"] ||
+      @params["edited_channel_post"]
+  end
+
   def message_text
-    @params.dig("message", "text")
+    message&.dig("text")
   end
 
   def callback_data
     @params.dig("callback_query", "data")
   end
 
+  def inline_data
+    @params.dig("inline_query", "query")
+  end
+
   def start?
     !!message_text&.start_with?("/start")
   end

data/lib/telegram_workflow/rspec.rb

@@ -18,6 +18,9 @@ module TelegramActionExampleGroup
           },
           "callback_query" => {
             "data" => ""
+          },
+          "inline_query" => {
+            "query" => ""
           }
         }
       end
@@ -33,9 +36,11 @@ module TelegramActionExampleGroup
   end
 
   module InstanceMethods
-    def send_message(message_text: "", callback_data: "")
+    def send_message(message_text: "", callback_data: "", inline_data: "")
       action_params["message"]["text"] = message_text
       action_params["callback_query"]["data"] = callback_data
+      action_params["inline_query"]["query"] = inline_data
+      yield action_params if block_given?
 
       workflow = TestFlow.new(action_params)
       workflow.example_group = self

data/lib/telegram_workflow/session.rb

@@ -27,20 +27,34 @@ class TelegramWorkflow::Session
   end
 
   def dump
-    @store.write(@session_id, Marshal.dump(@session))
+    @session_id && @store.write(@session_id, Marshal.dump(@session))
   end
 
   # this is a user space to store some session data separately from the gem session
   def user_session
-    @session[:user_session] ||= {}
+    @session_id ?
+      @session[:user_session] ||= {} :
+      NullSession.new
   end
 
   # this is a temporary per-action store
   def flash
-    @session[:flash] ||= {}
+    @session_id ?
+      @session[:flash] ||= {} :
+      NullSession.new
   end
 
   def reset_flash
     flash.clear
   end
+
+  class NullSession < Hash
+    def [](key)
+      raise TelegramWorkflow::Errors::NoSession
+    end
+
+    def []=(key, value)
+      raise TelegramWorkflow::Errors::NoSession
+    end
+  end
 end

data/lib/telegram_workflow/updates.rb

@@ -1,4 +1,6 @@
 class TelegramWorkflow::Updates
+  attr_writer :stop
+
   def initialize(params)
     @params = params
   end
@@ -6,12 +8,16 @@ class TelegramWorkflow::Updates
   def enum
     Enumerator.new do |y|
       loop do
+        break if @stop
+
         updates = TelegramWorkflow::Client.new.get_updates(@params)["result"]
         updates.each do |update|
           y << update
         end
 
-        @params.merge! offset: updates.last["update_id"] + 1
+        if updates.any?
+          @params.merge! offset: updates.last["update_id"] + 1
+        end
       end
     end
   end

data/lib/telegram_workflow/version.rb

@@ -1,3 +1,3 @@
 module TelegramWorkflow
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/telegram_workflow.gemspec

@@ -8,14 +8,14 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{A simple library to create Telegram Bots in Ruby.}
   spec.homepage      = "https://github.com/rsamoilov/telegram_workflow"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
 
   spec.add_dependency "http"
   spec.add_development_dependency "rspec", "~> 3.9"
-  spec.add_development_dependency "activesupport", "~> 6.0.0"
+  spec.add_development_dependency "activesupport", "~> 5.2.0"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram_workflow
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Roman Samoilov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: 5.2.0
 description: 
 email: 
 executables: []
@@ -63,7 +63,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -97,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile.lock

@@ -1,72 +0,0 @@
-PATH
-  remote: .
-  specs:
-    telegram_workflow (0.1.0)
-      http
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.0.2.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    ffi (1.12.2)
-    ffi-compiler (1.0.1)
-      ffi (>= 1.0.0)
-      rake
-    http (4.4.1)
-      addressable (~> 2.3)
-      http-cookie (~> 1.0)
-      http-form_data (~> 2.2)
-      http-parser (~> 1.2.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    http-form_data (2.3.0)
-    http-parser (1.2.1)
-      ffi-compiler (>= 1.0, < 2.0)
-    i18n (1.8.2)
-      concurrent-ruby (~> 1.0)
-    minitest (5.14.0)
-    public_suffix (4.0.4)
-    rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.7)
-    zeitwerk (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport (~> 6.0.0)
-  rake (~> 12.0)
-  rspec (~> 3.0)
-  telegram_workflow!
-
-BUNDLED WITH
-   2.1.4