telegram-rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32045c7d423551f7c28bf5cb2a2461e70f04cf07
-  data.tar.gz: ae807568c5f7806f718f4177a3bd52b2abb6b6d6
+  metadata.gz: 182d125795a4e088af6c27402934a4fa901a4c06
+  data.tar.gz: aeb4a85c703ab577fbc520727a1afa00d420d8ab
 SHA512:
-  metadata.gz: d77da4d52528321a44a3815f188062f5ef935873c010a1afc869013043ad4af2247b6997fce9602e01f441fe89c5bfb9b866c91ffda4a31f49c723a22b1bb8ab
-  data.tar.gz: e773a1c9ab1dd94de058d7fb3e206bfb360c753f689c7fa88428f9987220f66dc2dd636636ebe963155c08876ae9f1398d35e10c23c3eb08e1caf43f6f0de289
+  metadata.gz: b11c81be68b1188df5afd01b5976f450c602c4bc84c8ab451c9d901514501a196efbbbfb7de86fbdff0a3cc7f8cd7c9cd8aec0006e59874ced2d0cb5488f796d
+  data.tar.gz: 797894a095d7ad53c76fe65a7f706c51c6511800baa8e4055b648d53f41229da9fea0d32b998bff8203737fb9be4fa5a9253272cef2dd164b79060e3c05c8a10

data/README.md

@@ -10,14 +10,14 @@ Gives you http-like routes and controllers. Allows you to write such a code:
 #routes.rb
 Rails.application.routes.draw do
 
-  telegram 'main/start', to: 'telegram/message#start'
-  telegram 'main/stop',  to: 'telegram/message#stop'
-  telegram 'main',       to: 'telegram/message'
+  telegram 'main/start', to: 'telegram/messages#start'
+  telegram 'main/stop',  to: 'telegram/messages#stop'
+  telegram 'main',       to: 'telegram/messages'
 
 end
 
-#message_controller.rb
-class Telegram::MessageController < Telegram::Controller
+#messages_controller.rb
+class Telegram::MessagesController < Telegram::Controller
 
   def start
     respond_with 'received /start'
@@ -33,6 +33,20 @@ class Telegram::MessageController < Telegram::Controller
     respond_with 'other commands'
   end
 
+
+  #rails-like implicit/explicit template rendering (only ERB support now)
+  def show
+    #app/views/telegram/messages/show.(md|html|txt).erb
+    #all instance variables are available in templates, like in rails
+    @v1 = 'some value'
+  end
+
+
+  def explicit
+    #explicit template rendering
+    render 'telegram/path/to/template'
+  end
+
 end
 
 ```

data/lib/telegram/controller/renderer.rb

@@ -0,0 +1,103 @@
+require 'erubis'
+
+require 'telegram/controller/view_object'
+require 'telegram/errors/renderer/bad_template_format_error'
+require 'telegram/errors/renderer/double_render_error'
+require 'telegram/errors/renderer/format_not_supported_error'
+require 'telegram/errors/renderer/multiple_templates_error'
+require 'telegram/errors/renderer/template_not_found_error'
+
+
+module Telegram
+  class Controller
+    class Renderer
+
+      def initialize(controller:, action:)
+        @controller, @action = controller, action
+      end
+
+
+      def render opts = {}
+        options = opts.merge(default_render_options)
+        view    = Controller::ViewObject.new(@controller.expose_instance_variables)
+        template_file_name, response_format = resolve_template(options)
+
+        template_body = File.read template_file_name
+        template      = Erubis::Eruby.new(template_body)
+        response_body = template.evaluate(view)
+
+        [response_body, response_format]
+      end
+
+
+      private
+
+      def default_render_options
+        controller_name = @controller.class.to_s.underscore.gsub(/_controller$/,'')
+        {
+          template: "#{controller_name}/#{@action}"
+        }
+      end
+
+
+      def resolve_template options
+        view_name = options[:template]
+
+        template_name  = File.join "app", "views", view_name
+        template_files = Dir.glob "#{template_name}.*.erb"
+
+        if template_files.length > 1 && options[:format].nil?
+          raise Telegram::Errors::Renderer::MultipleTemplatesError, view_name
+        end
+
+        if template_files.length == 1
+          template_file = template_files[0]
+        else
+          template_file = template_files.find do |t|
+            template_file_format(t) == options[:format]
+          end
+        end
+
+        if template_file
+          template_format = template_file_format(template_file)
+        end
+
+        if !(template_file && template_format) || (options[:format] && template_format != options[:format])
+          raise Telegram::Errors::Renderer::BadTemplateFormatError, view_name
+        end
+
+        unless template_file
+          raise Telegram::Errors::Renderer::TemplateNotFoundError, view_name
+        end
+
+        [template_file, template_format]
+      end
+
+
+      def template_file_format name
+        extension = name.split('.')[-2]
+        template_format = extensions_map[extension] || extension
+        unless extensions_map.values.include? template_format
+          raise Telegram::Errors::Renderer::FormatNotSupportedError, template_format
+        end
+        template_format
+      end
+
+
+      def extensions_map
+        {
+          'txt'  =>  :text,
+          'md'   =>  :markdown,
+          'html' =>  :html,
+        }
+      end
+
+
+      def template_extensions_whitelist
+        extensions_map.keys
+      end
+
+
+    end # Renderer
+  end # Controller
+end #Telegram

data/lib/telegram/controller/session.rb

@@ -0,0 +1,7 @@
+module Telegram
+  class Controller
+    module Session
+      #WIP
+    end #Session
+  end #Controller
+end #Telegram

data/lib/telegram/controller/view_object.rb

@@ -0,0 +1,20 @@
+module Telegram
+  class Controller
+    class ViewObject
+
+      def initialize(variables = {})
+        assign_instance_variables(variables)
+      end
+
+
+      private
+
+      def assign_instance_variables(hash)
+        hash.each do |key,value|
+          instance_variable_set "@#{key}", value
+        end
+      end
+
+    end
+  end # Controller
+end # Telegram

data/lib/telegram/controller.rb

@@ -1,5 +1,8 @@
+require 'active_support/inflector'
+
 require 'telegram/utils/responder'
 require 'telegram/utils/keyboard_builder'
+require 'telegram/controller/renderer'
 
 
 module Telegram
@@ -20,13 +23,69 @@ module Telegram
     end
 
 
-    def explicit_response?
-      @explicit_response
+    def dispatch action
+      @current_action = action
+      self.send action
+
+      render unless @has_response
+
+      @current_action = nil
+
+      # WIP rescue from
+    end
+
+
+    def not_exposed_instance_variables
+      [
+        :bots, :message,
+        :current_action, :rendered,
+        :bot_name, :has_response,
+      ]
+    end
+
+
+    # TEST
+    def expose_instance_variables
+      hash = {}
+      variables  = instance_variables
+      variables -= not_exposed_instance_variables.map { |v| :"@#{v}" }
+
+      variables.each do |name|
+        # cut @
+        var_name = name[1..-1]
+        hash[var_name] = instance_variable_get(name)
+      end
+
+      hash
     end
 
 
     private
 
+    def has_response?
+      @has_response
+    end
+
+
+    def render opts = {}
+      raise Telegram::Errors::Renderer::DoubleRenderError if @rendered
+
+      response, response_format = Renderer.new(controller: self, action: @current_action).render(opts)
+      respond_with response, parse_mode: parse_modes[response_format]
+
+      @rendered = true
+    end
+
+
+    def parse_modes
+      {
+        markdown: 'Markdown',
+        html:     'Html',
+        text:     nil,
+      }
+    end
+
+
     def bot
       @bots[@bot_name]
     end
@@ -44,7 +103,7 @@ module Telegram
 
     def send_message *args
       bot.api.send_message *args
-      @explicit_response = true
+      @has_response = true
     end
 
 
@@ -53,7 +112,7 @@ module Telegram
     end
 
 
-    def respond_with payload
+    def respond_with payload, rest = {}
       response = payload.clone
       # WIP угадывать тип, посмотреть какие есть типы ответа
       unless response.is_a? Hash
@@ -77,7 +136,7 @@ module Telegram
         response.delete :remove_keyboard
       end
 
-      send_message default_response.merge(response)
+      send_message default_response.merge(response).merge(rest)
     end
 
 

data/lib/telegram/errors/renderer/bad_template_format_error.rb

@@ -0,0 +1,13 @@
+require 'telegram/errors/common_error'
+
+module Telegram
+  module Errors
+    module Renderer
+      class BadTemplateFormatError < Telegram::Errors::CommonError
+        def initialize view_name
+          super "Unable to find template for #{view_name}"
+        end
+      end
+    end
+  end
+end

data/lib/telegram/errors/renderer/double_render_error.rb

@@ -0,0 +1,13 @@
+require 'telegram/errors/common_error'
+
+module Telegram
+  module Errors
+    module Renderer
+      class DoubleRenderError < Telegram::Errors::CommonError
+        def initialize
+          super "Response is already rendered"
+        end
+      end
+    end
+  end
+end

data/lib/telegram/errors/renderer/format_not_supported_error.rb

@@ -0,0 +1,13 @@
+require 'telegram/errors/common_error'
+
+module Telegram
+  module Errors
+    module Renderer
+      class FormatNotSupportedError < Telegram::Errors::CommonError
+        def initialize(template_format)
+          super "Format not supported: #{template_format}"
+        end
+      end
+    end
+  end
+end

data/lib/telegram/errors/renderer/multiple_templates_error.rb

@@ -0,0 +1,13 @@
+require 'telegram/errors/common_error'
+
+module Telegram
+  module Errors
+    module Renderer
+      class MultipleTemplatesError < Telegram::Errors::CommonError
+        def initialize view_name
+          super "Multiple templates for #{view_name}. Please specify :format explicitly"
+        end
+      end
+    end
+  end
+end

data/lib/telegram/errors/renderer/template_not_found_error.rb

@@ -0,0 +1,13 @@
+require 'telegram/errors/common_error'
+
+module Telegram
+  module Errors
+    module Renderer
+      class TemplateNotFoundError < Telegram::Errors::CommonError
+        def initialize view_name
+          super "Template not found for #{view_name}"
+        end
+      end
+    end
+  end
+end

data/lib/telegram/rails/action_dispatcher.rb

@@ -65,21 +65,12 @@ module Telegram
           c.message  = message
         end
 
-        begin
-          # WIP check explicit response...
-          controller.send route[:action_name]
-        rescue StandardError => e
-          puts "RESCUE FROM"
-          puts "RESCUE FROM"
-          puts "RESCUE FROM"
-          puts "RESCUE FROM"
-          #HERE rescue_from!!!
-          raise e
-        end
+        controller.dispatch route[:action_name]
+        #HERE args support
       end
 
 
-      #TODO test coverage
+      #TEST
       def parse_route route_data
         route_string = route_data[:route]
         options      = route_data[:options]

data/lib/telegram/rails/version.rb

@@ -1,5 +1,5 @@
 module Telegram
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/telegram/utils/responder.rb

@@ -1,7 +1,6 @@
 require 'active_support/inflector'
 require 'telegram/errors/controller/block_not_given_error'
-#WIP-- `ag byebug`
-require 'byebug'
+
 
 #WIP move to ...::Controller, продумать
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Stanislav E. Govorov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-25 00:00:00.000000000 Z
+date: 2017-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: telegram-bot-ruby
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: erubis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -120,9 +120,17 @@ files:
 - bin/setup
 - lib/telegram/client_adapter.rb
 - lib/telegram/controller.rb
+- lib/telegram/controller/renderer.rb
+- lib/telegram/controller/session.rb
+- lib/telegram/controller/view_object.rb
 - lib/telegram/errors/common_error.rb
 - lib/telegram/errors/configuration/token_missing_error.rb
 - lib/telegram/errors/controller/block_not_given_error.rb
+- lib/telegram/errors/renderer/bad_template_format_error.rb
+- lib/telegram/errors/renderer/double_render_error.rb
+- lib/telegram/errors/renderer/format_not_supported_error.rb
+- lib/telegram/errors/renderer/multiple_templates_error.rb
+- lib/telegram/errors/renderer/template_not_found_error.rb
 - lib/telegram/errors/routing/bad_route_error.rb
 - lib/telegram/errors/routing/bot_not_found_error.rb
 - lib/telegram/rails.rb