telegram_workflow 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9e4c2c5c0d7ee686ea3961a0af8c50ae6511c26cbf5ee704f1c3e27dad82e65
-  data.tar.gz: 80ce424f3627fb918810020c7811dbbe98713bd87e59280815ca6f7e37d6550f
+  metadata.gz: f1247dbbe0bc252c17270b86bc003ebd72f4dac8990a3251817cd99ac75fa85e
+  data.tar.gz: 1d1983843ac32770201da9e3c9475a3394c7f37b19e80ed89f8b8da66d5be2d7
 SHA512:
-  metadata.gz: 9ff7be3ead93112c1cb5debbe5f8a62399948057b445b896c4d3a585b660dfa9707569a5e214faa5fa75230b180db76b27167ae4c097ff687f7cec297dda5fa8
-  data.tar.gz: 04b307ae0e32fc0a5a76019372d8fed3fc5e70229818a90dbc134da3a5a9da1ce7d01e5ee50f3c41f905931f2fe5157b8bcff5d4c93a59009d9c6ce29dc4ea13
+  metadata.gz: 6dbf47965a1c443b3e433d649424c2b8d3492da048c978c8bbdae94c79e302030751ccf0ef8f0591d7ff51573cb47907c39626561357d246b9bfcdbb53124d85
+  data.tar.gz: 9ed28f1dc116340f93073d7b164904d352d23547392f4897bc7ba9ea1895de400851d1694f6adea815f71516c4d57f611197ddb3b944bfdcf47377ae7b2d59fe

data/README.md

@@ -110,289 +110,9 @@ end
 Here you can see an example of redirection to another action.
 Having a bot logic split over such small actions improves code maintanability and allows to follow SRP.
 
-## Global Objects
+## Documentation
 
-Each action has a set of globally accessible objects:
-
-Object | Description
--------|------------
-[params](README.md#params) | Instance of `TelegramWorkflow::Params`.
-[client](README.md#client) | Instance of `TelegramWorkflow::Client`. Can be [customized](README.md#client-customization).
-[session](README.md#session) | Persistent store to keep session data. Instance of `Hash`.
-[flash](README.md#flash) | Temporary store to keep some data between different steps. Instance of `Hash`.
-
-## Public API
-
-### params
-
-The `params` object encapsulates the logic to parse Telegram params.
-It implements useful methods, like `message_text`, `callback_data` or `deep_link_payload` to fetch user submitted data from the params.
-
-### client
-
-This is an instance of `TelegramWorkflow::Client` class, which implements a complete Telegram Bot API.
-The methods to access the API are called after raw Telegram API methods.
-For example, if you needed to call a [sendLocation](https://core.telegram.org/bots/api#sendlocation) method, you would use the following code:
-
-```ruby
-client.send_location latitude: 40.748, longitude: -73.985, live_period: 120
-```
-
-`chat_id` parameter should be omitted.
-
-Use `TelegramWorkflow::InputFile` to upload a file:
-
-```ruby
-client.send_photo photo: TelegramWorkflow::InputFile.new("/Users/telegram/images/image1.jpg")
-```
-
-`filename` and `content_type` fields can be customized:
-
-```ruby
-file = StringIO.new("hello!")
-client.send_document document: TelegramWorkflow::InputFile.new(file, filename: "hello.txt")
-```
-
-### session
-
-This is a persistent store to save the data associated with a user, e.g. current user's id, some settings or anything you would store in a session in a regular web application.
-
-### flash
-
-This is a temporary store to save the data between the steps. The data persists while redirecting between the steps, but **gets deleted automatically when redirecting to another action**.
-
-### redirect_to(action_or_class, flash_params = {})
-
-As you already know, this function allows to build complex workflows by redirecting between actions and steps.
-The function expects either a symbol or instance of `Class` as a first argument. Passing a symbol will redirect to another step inside the current action. Passing instance of `Class` will redirect to another action.
-
-```ruby
-# redirect to a step
-redirect_to :suggest
-
-# redirect to an action
-redirect_to RateMovie
-```
-
-Sometimes you will need to share some data between the actions. You could use `session` for this, but a more appropriate solution would be to have `redirect_to` function to preserve the flash between actions.
-Check out this example:
-
-```ruby
-class AskForBirthday < TelegramWorkflow::Action
-  def initial
-    on_redirect do
-      client.send_message text: "What year is your birthday?"
-    end
-
-    on_message do
-      birthday = params.message_text.to_i
-      redirect_to DisplayAge, birthday: birthday
-    end
-  end
-end
-
-class DisplayAge < TelegramWorkflow::Action
-  def initial
-    on_redirect do
-      age = Date.today.year - flash[:birthday]
-      client.send_message text: "You are #{age}!"
-    end
-  end
-end
-```
-
-You can see that despite the fact that flash is being cleared when redirecting to another action, passing `birthday` value to the `redirect_to` call made it accessible via flash in the action we redirected to.
-
-## Configuration
-
-Configure the gem using the `TelegramWorkflow.configure` call.
-The two required parameters are `start_action` and `api_token`.
-
-```ruby
-TelegramWorkflow.configure do |config|
-  config.start_action = <Start Action Class>
-  config.api_token = <Your Token>
-end
-```
-
-Method | Default | Description
--------|---------|------------
-api_token | | This is the token you get from `@botfather` to access the Telegram API.
-start_action | | This is an entry-point action, which is called every time `/start` or `/startgroup` command is sent to the chat.  You cannnot redirect to this action or call it manually. Use it to set the things up, e.g. create a user record or store current user's id in the session.
-session_store | `Rails.cache` or `InMemoryStore.new` | This is the session store. Default implementation stores session in memory, which means it will be reset after server shutdown. Can be [customized](README.md#customization). Use `TelegramWorkflow::Stores::File` for persistent file store.
-logger | `Rails.logger` or `STDOUT` | Logger object. Can be [customized](README.md#customization).
-client | `TelegramWorkflow::Client` | The object which implements Telegram API. Can be [customized](README.md#client-customization).
-webhook_url | nil | The webhook url. Set it only if you are using webhooks for getting updates. TelegramWorkflow will create a webhook subscription automatically.
-
-## Updates
-
-The gem implements both methods of getting updates from the Telegram API.
-
-### Webhooks
-
-* Configure the gem with `webhook_url` value.
-* Process the updates with the following code in your controller:
-
-```ruby
-class TelegramWebhooksController < ApplicationController
-  def create
-    TelegramWorkflow.process(params)
-  end
-end
-```
-
-### Long polling
-
-* Make sure you don't configure the gem with `webhook_url` value.
-* Run the following code:
-
-```ruby
-TelegramWorkflow.updates.each do |params|
-  TelegramWorkflow.process(params)
-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
-require "concurrent-ruby"
-
-pool = Concurrent::CachedThreadPool.new
-
-TelegramWorkflow.updates.each do |params|
-  pool.post { TelegramWorkflow.process(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
--------|--------------
-logger | An object that responds to `info` and `error` methods.
-session_store | An object that responds to `read` and `write` methods. Refer to [InMemoryStore](lib/telegram_workflow/stores/in_memory.rb) class definition.
-client | An object that responds to `new(chat_id)` method.
-
-### Client Customization
-
-Use this customization to abstract your action's code from the Telegram API implementation details.
-
-Create a customized client:
-
-```ruby
-class MyClient < TelegramWorkflow::Client
-  def send_prize_location(user)
-    # this is an example call
-    prize = user.find_last_prize
-
-    send_venue latitude: prize.latitude,
-      longitude: prize.longitude,
-      address: prize.address
-      title: "Collect the last prize here!",
-      reply_markup: { keyboard: [[{ text: "Give me a hint" }], [{ text: "Give me anohter hint" }]] }
-  end
-end
-```
-
-Now, configure the gem to use the customized client:
-
-```ruby
-TelegramWorkflow.configure do |config|
-  config.client = MyClient
-end
-```
-
-Then, in your action:
-
-```ruby
-class FindPrize < TelegramWorkflow::Action
-  def initial
-    on_redirect do
-      client.send_prize_location(current_user)
-    end
-  end
-end
-```
-
-## Testing
-
-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`.
-
-Suppose we have the following action:
-
-```ruby
-class AskForBirthday < TelegramWorkflow::Action
-  def initial
-    on_redirect do
-      client.send_message text: "What year is your birthday?"
-    end
-
-    on_message do
-      Birthday.create! date: params.message_text
-      redirect_to DisplayAge
-    end
-  end
-end
-```
-
-Now, let's add some tests for this action:
-
-```ruby
-require "telegram_workflow/rspec"
-
-RSpec.describe AskForBirthday, type: :telegram_action do
-  it "asks for user's birthday" do
-    expect(subject.client).to have_received(:send_message).with(text: "What year is your birthday?")
-    expect {
-      send_message message_text: "10/10/2000"
-    }.to change { Birthday.count }.by(1)
-
-    expect(subject.flow).to have_received(:redirect_to).with(DisplayAge)
-  end
-end
-```
-
-As you can see, testing utility starts the flow automatically, calling `initial` step on `described_class`.
+Please see the [TelegramWorkflow wiki](https://github.com/rsamoilov/telegram_workflow/wiki) for more detailed documentation.
 
 ## Example
 

data/lib/telegram_workflow/client.rb

@@ -84,10 +84,15 @@ class TelegramWorkflow::Client
     method_name = action.to_s.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
 
     define_method(method_name) do |params = {}|
-      make_request(action, params)
+      @inline ?
+        save_request(action, params) :
+        make_request(action, params)
     end
   end
 
+  attr_accessor :inline, :inline_request
+  attr_reader :api_url
+
   def initialize(chat_id = nil)
     @chat_id = chat_id
     @api_url = "https://api.telegram.org/bot#{TelegramWorkflow.config.api_token}"
@@ -129,6 +134,11 @@ class TelegramWorkflow::Client
     end
   end
 
+  def save_request(action, params = {})
+    raise TelegramWorkflow::Errors::DoubleInlineRequest if @inline_request
+    @inline_request = { method: action, chat_id: @chat_id, **params }
+  end
+
   def make_request(action, params = {})
     has_file_params = params.any? { |_, param| param.is_a?(TelegramWorkflow::InputFile) }
     request_type = has_file_params ? :form : :json

data/lib/telegram_workflow/errors.rb

@@ -23,6 +23,12 @@ module TelegramWorkflow::Errors
     end
   end
 
+  class DoubleInlineRequest < StandardError
+    def initialize(msg = "Cannot send more than one request in a row in inline mode.")
+      super
+    end
+  end
+
   class ApiError < StandardError
   end
 

data/lib/telegram_workflow/version.rb

@@ -1,3 +1,3 @@
 module TelegramWorkflow
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/telegram_workflow/workflow.rb

@@ -31,6 +31,8 @@ class TelegramWorkflow::Workflow
     end
 
     @session.dump
+
+    @client.inline_request
   end
 
   def redirect_to(action_or_step, session_params = nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram_workflow
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Roman Samoilov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http