telegram_workflow 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f33398c3b33397236392a5b645e39b58827df8e453727fd06496ce0b4479e11
-  data.tar.gz: 9155e202748c8242adc4f4789623b8c42156658616e545d1aafd2aa4f2f776f7
+  metadata.gz: b9e4c2c5c0d7ee686ea3961a0af8c50ae6511c26cbf5ee704f1c3e27dad82e65
+  data.tar.gz: 80ce424f3627fb918810020c7811dbbe98713bd87e59280815ca6f7e37d6550f
 SHA512:
-  metadata.gz: 4f85e7ab9b297deab054185d03863c8183bf7fbd6a7f1325ec612fa0042ee0999a700e80d91cb5cbed3b945605595904ec1716192b341d39f2402df805ea69f1
-  data.tar.gz: 67bf8b6d8abc59f26c2e302f989aaa17777303bc3efdfb29844686d35f62994a2257557e7838188292e2fbbecc7eb7d1ad872c3f123eb9eb1b61b686b046a5ba
+  metadata.gz: 9ff7be3ead93112c1cb5debbe5f8a62399948057b445b896c4d3a585b660dfa9707569a5e214faa5fa75230b180db76b27167ae4c097ff687f7cec297dda5fa8
+  data.tar.gz: 04b307ae0e32fc0a5a76019372d8fed3fc5e70229818a90dbc134da3a5a9da1ce7d01e5ee50f3c41f905931f2fe5157b8bcff5d4c93a59009d9c6ce29dc4ea13

data/lib/telegram_workflow.rb

@@ -39,6 +39,6 @@ require "telegram_workflow/stores/file"
 
 TelegramWorkflow.__after_configuration do |config|
   if config.webhook_url
-    TelegramWorkflow::Client.new.__setup_webhook
+    TelegramWorkflow::Client.new.__setup_webhook(config.webhook_url, config.webhook_params)
   end
 end

data/lib/telegram_workflow/client.rb

@@ -1,6 +1,6 @@
 class TelegramWorkflow::Client
   API_VERSION = "4.9"
-  WebhookFilePath = Pathname.new("tmp/telegram_workflow/webhook_url.txt")
+  WebhookConfigPath = Pathname.new("tmp/telegram_workflow/webhook_config.txt")
 
   AVAILABLE_ACTIONS = %i(
     getUpdates
@@ -90,45 +90,46 @@ class TelegramWorkflow::Client
 
   def initialize(chat_id = nil)
     @chat_id = chat_id
-    @webhook_url = TelegramWorkflow.config.webhook_url
     @api_url = "https://api.telegram.org/bot#{TelegramWorkflow.config.api_token}"
   end
 
   def set_webhook(params = {})
     make_request("setWebhook", params)
-    cached_webhook_url(new_url: @webhook_url)
+    cached_webhook_config(params)
   end
 
   def delete_webhook
-    make_request("deleteWebhook", {})
-    cached_webhook_url(new_url: "")
+    make_request("deleteWebhook")
+    cached_webhook_config({})
   end
 
-  def __setup_webhook
+  def __setup_webhook(webhook_url = TelegramWorkflow.config.webhook_url, params = {})
     TelegramWorkflow.config.logger.info "[TelegramWorkflow] Checking webhook setup..."
 
-    if cached_webhook_url != @webhook_url
+    webhook_params = { url: webhook_url, allowed_updates: [], **params }
+
+    if cached_webhook_config != webhook_params
       TelegramWorkflow.config.logger.info "[TelegramWorkflow] Setting up a new webhook..."
-      set_webhook(url: @webhook_url)
+      set_webhook(webhook_params)
     end
   end
 
   private
 
-  def cached_webhook_url(new_url: nil)
-    unless WebhookFilePath.exist?
-      WebhookFilePath.dirname.mkpath
-      WebhookFilePath.write("")
+  def cached_webhook_config(new_config = nil)
+    unless WebhookConfigPath.exist?
+      WebhookConfigPath.dirname.mkpath
+      WebhookConfigPath.write(Marshal.dump({}))
     end
 
-    if new_url.nil?
-      WebhookFilePath.read
+    if new_config.nil?
+      Marshal.load(WebhookConfigPath.read)
     else
-      WebhookFilePath.write(new_url)
+      WebhookConfigPath.write(Marshal.dump(new_config))
     end
   end
 
-  def make_request(action, params)
+  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/config.rb

@@ -21,12 +21,14 @@ module TelegramWorkflow
   end
 
   class Configuration
-    attr_accessor :session_store, :logger, :client, :start_action, :webhook_url, :api_token
+    attr_accessor :session_store, :logger, :client, :start_action, :webhook_url, :api_token,
+                  :webhook_params
 
     REQUIRED_PARAMS = %i(session_store start_action api_token)
 
     def initialize
       @client = TelegramWorkflow::Client
+      @webhook_params = {}
 
       if defined?(Rails)
         @session_store = Rails.cache

data/lib/telegram_workflow/version.rb

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

data/telegram_workflow.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   # 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.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|example)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram_workflow
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Roman Samoilov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -82,17 +82,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- example/Gemfile
-- example/README.md
-- example/actions/create_appointment.rb
-- example/actions/list_actions.rb
-- example/actions/list_appointments.rb
-- example/actions/select_doctor.rb
-- example/actions/start.rb
-- example/client.rb
-- example/environment.rb
-- example/flow.jpg
-- example/main.rb
 - lib/telegram_workflow.rb
 - lib/telegram_workflow/action.rb
 - lib/telegram_workflow/client.rb

data/example/Gemfile

@@ -1,2 +0,0 @@
-source "https://rubygems.org"
-gem "telegram_workflow"

data/example/README.md

@@ -1,79 +0,0 @@
-## Description
-
-This is a fully working example of a bot which allows you to book an appointment with a doctor.
-
-The following diagram will help you understand the bot's flow:
-<p>
-  <img src="https://github.com/rsamoilov/telegram_workflow/blob/master/example/flow.jpg" width="400">
-</p>
-
-## Running the bot
-
-First, open [main.rb](main.rb) and configure the bot with your API token:
-
-```diff
-TelegramWorkflow.configure do |config|
-- config.api_token = <YOUR_TOKEN>
-+ config.api_token = "123456780:ABCDE_my-token"
-end
-```
-
-Next, run the bot:
-
-```
-bundle
-ruby main.rb
-```
-
-## Configuration
-
-Every Bot workflow begins with **`on_message`** callback in a `start_action`.
-There's no need to store current user data in session in this example, so we simply redirect to the `ListActions` action, which will be our "main" action.
-
-```ruby
-class Actions::Start < TelegramWorkflow::Action
-  def initial
-    on_message do
-      redirect_to Actions::ListActions
-    end
-  end
-end
-```
-
-Next, the Telegram client can be customized. We want to use Telegram's [InlineKeyboard](https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) to provide a user with a list of available actions.
-
-Let's encapsulate this inside our custom client class:
-
-```ruby
-class Client < TelegramWorkflow::Client
-  def send_actions(message, actions)
-    send_message text: message, reply_markup: { inline_keyboard: actions }
-  end
-end
-```
-
-Now, let's configure the gem:
-
-```ruby
-TelegramWorkflow.configure do |config|
-  config.start_action = Actions::Start
-  config.client = Client
-  config.session_store = TelegramWorkflow::Stores::File.new
-end
-```
-
-The last configuration parameter here is `session_store`. We are using `TelegramWorkflow::Stores::File` - a built-in implementation of persistent file store.
-
-[getUpdates](https://core.telegram.org/bots/api#getupdates) method is used in this example to receive the updates:
-
-```ruby
-TelegramWorkflow.updates.each do |params|
-  TelegramWorkflow.process(params)
-end
-```
-
-After a user has sent a message, `TelegramWorkflow.process` will initialize the last processed action and step and then call `on_message` callback on it.
-
-## Actions
-
-Check out the bot's code under [actions](actions) folder.

data/example/actions/create_appointment.rb

@@ -1,56 +0,0 @@
-#
-# this is an action to create an appointment;
-# each method represents one of the steps for appointment creation;
-# for the sake of simplicity, all created appointments are stored in the session
-#
-class Actions::CreateAppointment < TelegramWorkflow::Action
-  def initial
-    on_redirect do
-      client.send_message text: "Enter patient's name:"
-    end
-
-    on_message do
-      flash[:name] = params.message_text
-      redirect_to :reason
-    end
-  end
-
-  def reason
-    on_redirect do
-      client.send_message text: "What is the reason for visit?"
-    end
-
-    on_message do
-      flash[:reason] = params.message_text
-      redirect_to :date
-    end
-  end
-
-  def date
-    on_redirect do
-      client.send_message text: "What date works best for you?"
-    end
-
-    on_message do
-      date = Date.parse(params.message_text) rescue nil
-
-      # there's no redirect in case the date is invalid;
-      # this means that next time a user sends a message, the current action will be executed again
-      if date
-        flash[:date] = date
-        redirect_to :done
-      else
-        client.send_message text: "Invalid date format. Please try again."
-      end
-    end
-  end
-
-  # `specialty` parameter is added to flash in previous `Actions::SelectDoctor` action
-  def done
-    on_redirect do
-      (session[:appointments] ||= []) << flash.slice(:name, :reason, :date, :specialty)
-      client.send_message text: "Your appointment has been created!"
-      redirect_to Actions::ListActions
-    end
-  end
-end

data/example/actions/list_actions.rb

@@ -1,28 +0,0 @@
-class Actions::ListActions < TelegramWorkflow::Action
-  def initial
-    on_redirect do
-      available_actions = [
-        [{ text: "Make an appointment", callback_data: "create" }]
-      ]
-
-      if session[:appointments]&.any?
-        available_actions.unshift [{ text: "List my appointments", callback_data: "list" }]
-      end
-
-      # this is the customized client object
-      client.send_actions "Select an action:", available_actions
-    end
-
-    # `params.callback_data` here will be one of the identifiers defined as `callback_data` in `available_actions` array
-    # refer to https://core.telegram.org/bots/api#inlinekeyboardbutton
-    on_message do
-      next_action = if params.callback_data == "create"
-        Actions::SelectDoctor
-      elsif params.callback_data == "list"
-        Actions::ListAppointments
-      end
-
-      redirect_to next_action
-    end
-  end
-end

data/example/actions/list_appointments.rb

@@ -1,13 +0,0 @@
-class Actions::ListAppointments < TelegramWorkflow::Action
-  def initial
-    on_redirect do
-      appointments = session[:appointments].map do |app|
-        "<b>#{app[:name]}</b> on #{app[:date].to_s}"
-      end
-
-      # refer to https://core.telegram.org/bots/api#sendmessage for the list of available parameters
-      client.send_message text: appointments.join("\n"), parse_mode: "HTML"
-      redirect_to Actions::ListActions
-    end
-  end
-end

data/example/actions/select_doctor.rb

@@ -1,19 +0,0 @@
-class Actions::SelectDoctor < TelegramWorkflow::Action
-  def initial
-    on_redirect do
-      available_doctors = [
-        [{ text: "Family Medicine", callback_data: "family" }],
-        [{ text: "Emergency Medicine", callback_data: "emergency" }],
-        [{ text: "Pediatrics", callback_data: "pediatrics" }]
-      ]
-
-      client.send_actions "Select a doctor:", available_doctors
-    end
-
-    on_message do
-      # pass `specialty` parameter to the next action
-      # https://github.com/rsamoilov/telegram_workflow#redirect_toaction_or_class-flash_params--
-      redirect_to Actions::CreateAppointment, specialty: params.callback_data
-    end
-  end
-end

data/example/actions/start.rb

@@ -1,9 +0,0 @@
-class Actions::Start < TelegramWorkflow::Action
-  def initial
-    # we don't need to store current user id in session or make any other setup,
-    # so just redirect to the `ListActions` action
-    on_message do
-      redirect_to Actions::ListActions
-    end
-  end
-end

data/example/client.rb

@@ -1,5 +0,0 @@
-class Client < TelegramWorkflow::Client
-  def send_actions(message, actions)
-    send_message text: message, reply_markup: { inline_keyboard: actions }
-  end
-end

data/example/environment.rb

@@ -1,13 +0,0 @@
-require "telegram_workflow"
-require "date"
-
-module Actions
-end
-
-dependencies = %w(
-  ./actions/*.rb
-  ./client.rb
-)
-dependencies.each do |path|
-  Dir[path].each { |path| require_relative path }
-end

data/example/main.rb

@@ -1,17 +0,0 @@
-require_relative "environment"
-
-TelegramWorkflow.configure do |config|
-  config.start_action = Actions::Start
-  config.client = Client
-  config.session_store = TelegramWorkflow::Stores::File.new
-  config.api_token = <YOUR_TOKEN>
-end
-
-trap "SIGINT" do
-  puts "Exiting..."
-  TelegramWorkflow.stop_updates
-end
-
-TelegramWorkflow.updates(timeout: 5).each do |params|
-  TelegramWorkflow.process(params)
-end