telegram_workflow 1.0.0

data/lib/telegram_workflow/session.rb

@@ -0,0 +1,46 @@
+class TelegramWorkflow::Session
+  def initialize(params)
+    @session_id = params.user_id
+    @store = TelegramWorkflow.config.session_store
+
+    @session = if serialized_session = @store.read(@session_id)
+      Marshal.load(serialized_session)
+    else
+      {}
+    end
+  end
+
+  def read(key)
+    @session[key]
+  end
+
+  def write(key, value)
+    @session[key] = value
+  end
+
+  def delete(key)
+    @session.delete(key)
+  end
+
+  def clear
+    @session.clear
+  end
+
+  def dump
+    @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] ||= {}
+  end
+
+  # this is a temporary per-action store
+  def flash
+    @session[:flash] ||= {}
+  end
+
+  def reset_flash
+    flash.clear
+  end
+end

data/lib/telegram_workflow/stores/file.rb

@@ -0,0 +1,18 @@
+require "dbm"
+
+class TelegramWorkflow::Stores::File
+  StorePath = Pathname.new("tmp/telegram_workflow/file_store")
+
+  def initialize
+    StorePath.dirname.mkpath unless StorePath.exist?
+    @store = DBM.open(StorePath.to_s)
+  end
+
+  def read(key)
+    @store[key.to_s]
+  end
+
+  def write(key, value)
+    @store[key.to_s] = value
+  end
+end

data/lib/telegram_workflow/stores/in_memory.rb

@@ -0,0 +1,13 @@
+class TelegramWorkflow::Stores::InMemory
+  def initialize
+    @store = {}
+  end
+
+  def read(key)
+    @store[key]
+  end
+
+  def write(key, value)
+    @store[key] = value
+  end
+end

data/lib/telegram_workflow/updates.rb

@@ -0,0 +1,18 @@
+class TelegramWorkflow::Updates
+  def initialize(params)
+    @params = params
+  end
+
+  def enum
+    Enumerator.new do |y|
+      loop do
+        updates = TelegramWorkflow::Client.new.get_updates(@params)["result"]
+        updates.each do |update|
+          y << update
+        end
+
+        @params.merge! offset: updates.last["update_id"] + 1
+      end
+    end
+  end
+end

data/lib/telegram_workflow/version.rb

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

data/lib/telegram_workflow/workflow.rb

@@ -0,0 +1,95 @@
+class TelegramWorkflow::Workflow
+  attr_reader :params, :client
+
+  def initialize(raw_params)
+    @params  = TelegramWorkflow::Params.new(raw_params)
+    @session = TelegramWorkflow::Session.new(@params)
+    @logger = TelegramWorkflow.config.logger
+
+    if @params.start?
+      @session.clear
+    end
+
+    chat_id = @session.read(:chat_id) || @session.write(:chat_id, @params.chat_id)
+    @client = TelegramWorkflow.config.client.new(chat_id)
+  end
+
+  def process
+    # run the shared step
+    shared_step_result = current_action.shared
+
+    if shared_step_result == :__continue
+      @logger.info "[TelegramWorkflow] Processing by #{current_action.class.name}##{current_step}"
+      current_action.public_send(current_step) # setup callbacks
+      current_action.__run_on_message # run a callback
+    else
+      @logger.info "[TelegramWorkflow] Processing by shared handler"
+    end
+
+    while @redirect_to
+      do_redirect
+    end
+
+    @session.dump
+  end
+
+  def redirect_to(action_or_step, session_params = nil)
+    raise TelegramWorkflow::Errors::DoubleRedirect if @redirect_to
+    raise TelegramWorkflow::Errors::SharedRedirect if action_or_step == :shared
+
+    @redirect_to = action_or_step
+    @session_params = session_params
+  end
+
+  private
+
+  def current_action
+    @current_action ||= begin
+      action_class = if action = @session.read(:current_action)
+        Object.const_get(action)
+      else
+        TelegramWorkflow.config.start_action
+      end
+
+      action_class.new(self, @session.user_session, @session.flash)
+    end
+  end
+
+  def set_current_action(action_class)
+    @session.write(:current_action, action_class.to_s)
+    set_current_step(nil)
+    @session.reset_flash
+
+    @current_action = action_class.new(self, @session.user_session, @session.flash)
+  end
+
+  def current_step
+    @session.read(:current_step) || :initial
+  end
+
+  def set_current_step(step)
+    @session.write(:current_step, step)
+  end
+
+  def do_redirect
+    action_or_step = @redirect_to
+    session_params = @session_params
+    @redirect_to = @session_params = nil
+
+    # reset on_message and on_redirect callbacks
+    current_action.__reset_callbacks
+
+    if action_or_step.is_a?(Class)
+      set_current_action(action_or_step)
+    else
+      set_current_step(action_or_step)
+    end
+
+    if session_params
+      @session.flash.merge!(session_params)
+    end
+
+    current_action.public_send(current_step) # setup callbacks
+    current_action.__run_on_redirect # run a callback
+  end
+end

data/telegram_workflow.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/telegram_workflow/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "telegram_workflow"
+  spec.version       = TelegramWorkflow::VERSION
+  spec.authors       = ["Roman Samoilov"]
+
+  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.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"
+
+  # 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)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: telegram_workflow
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Roman Samoilov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/telegram_workflow.rb
+- lib/telegram_workflow/action.rb
+- lib/telegram_workflow/client.rb
+- lib/telegram_workflow/config.rb
+- lib/telegram_workflow/errors.rb
+- lib/telegram_workflow/params.rb
+- lib/telegram_workflow/rspec.rb
+- lib/telegram_workflow/session.rb
+- lib/telegram_workflow/stores/file.rb
+- lib/telegram_workflow/stores/in_memory.rb
+- lib/telegram_workflow/updates.rb
+- lib/telegram_workflow/version.rb
+- lib/telegram_workflow/workflow.rb
+- telegram_workflow.gemspec
+homepage: https://github.com/rsamoilov/telegram_workflow
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rsamoilov/telegram_workflow
+  source_code_uri: https://github.com/rsamoilov/telegram_workflow
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A simple library to create Telegram Bots in Ruby.
+test_files: []