botomizer 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c1a5a4ee8958a6a09d95aeb162d7a4764517ab7
-  data.tar.gz: 5cf1ce012b8cbf801fb2497b7bb5afd330bcf542
+  metadata.gz: 668bddf9110bdaf607ec33797816f10989c7d88f
+  data.tar.gz: 4e4e2c7f4eb1a2ea2b16e28dda3cbb2d69685640
 SHA512:
-  metadata.gz: a6c659da8c336410d4a79b61ee5ea94cef54c7c0e8b5cdcfb9f728d865181a2007cb7550ca744edef46f76b79d315a55bd1679293a057212556735caf443c28a
-  data.tar.gz: 407b0966d92e3c6142e4706eed5c614038c4466a519b4bfc3a882cc357bb51f23931a2be5de663ecfdec520e508d60493c79e238f7527530e453bff49bc54e8f
+  metadata.gz: 274cd5bdb089d643de8ad0629e6a8fc088ad128cae60d8b9b85717b0d14db5b9e0ce5613cc7eaa5829b61363bfd0422f22379a50f3bb7d174d0901273a607cfc
+  data.tar.gz: 0afb77c72d1d79ac8d7d45552987caaf3d4235af2d44f586218b729ac5bc639db05a0f20ff55b276c3bce3a0a5e728cf1664552af11af2163110f3f075e9d08b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alex.b@matomy.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in botomizer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    botomizer (0.1.0)
+      httparty (>= 0.15.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    httparty (0.15.6)
+      multi_xml (>= 0.5.2)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.10.3)
+    multi_xml (0.6.0)
+    rake (12.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 5.1)
+  botomizer!
+  bundler (~> 1.16)
+  rake (> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alex Belenky
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Gem::Botomizer
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gem/botomizer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gem-botomizer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gem-botomizer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gem-botomizer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Gem::Botomizer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gem-botomizer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gem/botomizer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/botomizer.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "botomizer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "botomizer"
+  spec.version       = Botomizer::VERSION
+  spec.authors       = ["Alex Belenky"]
+  spec.email         = ["alex.b@matomy.com"]
+
+  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/Stajor/botomizer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activesupport", "~> 5.1"
+  
+  spec.add_dependency 'httparty', "~> 0.15.6"
+end

data/examples/telegram.rb

@@ -0,0 +1,44 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require File.join(dir, 'botomizer')
+require 'active_support/cache'
+
+request  = {
+    "update_id" => 430379297,
+    "message" => {
+        "message_id" => 27167,
+        "from" => {
+            "id" => 42858,
+            "is_bot" => false,
+            "first_name" => "Alex",
+            "last_name" => "B",
+            "username" => "AlexBel",
+            "language_code" => "en"
+        }, "chat" => {
+            "id" => 42858,
+            "first_name" => "Alex",
+            "last_name" => "B",
+            "username" => "AlexBel",
+            "type" => "private"
+        },
+        "date" => 1510219771,
+        "text" => "/test bla"
+    }
+}
+
+class CmdHandler < Botomizer::Handler
+  def cmd_test
+    puts "test message " + @client.message.text
+    @client.send_message(@client.message.text)
+  end
+
+  def cmd_fallback
+    puts "fallback"
+  end
+end
+
+client = Botomizer::Client.new(:telegram, {
+    token: '405249984:AAFCELndVU1H-wUeI6jkRGNuP0CTFpDgn-Y',
+    cache: ActiveSupport::Cache::MemoryStore.new
+})
+
+client.handle(request, CmdHandler)

data/lib/botomizer/cache.rb

@@ -0,0 +1,20 @@
+class Botomizer::Cache
+  attr_reader :prefix
+
+  def initialize(cache, prefix)
+    @cache = cache
+    @prefix = prefix
+  end
+
+  def fetch(key)
+    @cache.fetch("#{@prefix}_#{key}") if @cache
+  end
+
+  def write(key, value)
+    @cache.write("#{@prefix}_#{key}", value, expires_in: 1.hour) if @cache
+  end
+
+  def delete(key)
+    @cache.delete("#{@prefix}_#{key}") if @cache
+  end
+end

data/lib/botomizer/chat.rb

@@ -0,0 +1,12 @@
+class Botomizer::Chat
+  attr_reader :id, :type, :first_name, :last_name, :username, :title
+
+  def initialize(params)
+    @id         = params[:id]
+    @type       = params[:type]
+    @first_name = params[:first_name]
+    @last_name  = params[:last_name]
+    @title      = params[:title]
+    @username   = params[:username]
+  end
+end

data/lib/botomizer/client.rb

@@ -0,0 +1,77 @@
+class Botomizer::Client
+  def initialize(client, options = {})
+    begin
+      require "botomizer/#{client}".downcase
+
+      @bot    = Object.const_get("Botomizer::#{client.capitalize}")
+      @cache  = Botomizer::Cache.new(options[:cache] || nil, :botomizer_cmd)
+      @name   = client
+      @bot.options = options
+      @bot.client = self
+    rescue LoadError
+      raise Botomizer::UnsupportedClient.new("Unsupported client #{client}")
+    end
+  end
+
+  def name
+    @name
+  end
+
+  def webhook
+    @bot.webhook
+  end
+
+  def message
+    bot.message
+  end
+
+  def chat
+    bot.chat
+  end
+
+  def bot
+    @bot
+  end
+
+  def handle(request, handler)
+    @bot.parse_request(request)
+
+    handler = handler.new(@bot)
+
+    if @bot.message.cmd?
+      @cache.write(@bot.chat.id, @bot.message.cmd)
+    else
+      @bot.message.cmd = @cache.fetch(@bot.chat.id)
+    end
+
+    if handler.respond_to? "cmd_#{@bot.message.cmd}"
+      handler.public_send("cmd_#{@bot.message.cmd}")
+    else
+      handler.cmd_fallback
+    end
+  end
+
+  def clean_history
+    @cache.cache.delete(@bot.chat.id)
+  end
+
+  def send(method, query = {})
+    @bot.send(method, query)
+  end
+
+  def send!(method, query = {})
+    result = send(method, query)
+    raise Botomizer::ResponseError.new(result[:message]) if result[:status] == :failed
+    result
+  end
+
+  def send_message(text, options = {})
+    @bot.send_message(text, options)
+  end
+
+  def send_message!(text, options = {})
+    result = send_message(text, options)
+    raise Botomizer::ResponseError.new(result[:message]) if result[:status] == :failed
+    result
+  end
+end

data/lib/botomizer/exceptions.rb

@@ -0,0 +1,31 @@
+module Botomizer
+  # @abstact Exceptions raised by Botomizer inherit from Error
+  class Error < StandardError; end
+
+  # Exception raised when you attempt to set a non-existent client
+  class UnsupportedClient < Error; end
+
+  class WebhookError < Error; end
+
+  class ChatError < Error; end
+
+  class MessageError < Error; end
+
+  class BotError < Error; end
+
+  # @abstract Exceptions which inherit from ResponseError contain the Net::HTTP
+  # response object accessible via the {#response} method.
+  class ResponseError < Error
+    # Returns the response of the last request
+    # @return [Net::HTTPResponse] A subclass of Net::HTTPResponse, e.g.
+    # Net::HTTPOK
+    attr_reader :response
+
+    # Instantiate an instance of ResponseError with a Net::HTTPResponse object
+    # @param [Net::HTTPResponse]
+    def initialize(response)
+      @response = response
+      super(response)
+    end
+  end
+end

data/lib/botomizer/handler.rb

@@ -0,0 +1,11 @@
+class Botomizer::Handler
+  attr_reader :client
+
+  def initialize(client)
+    @client = client
+  end
+
+  def cmd_fallback
+    @client.message.send('Command not found or incorrect. Type /help for more information.')
+  end
+end

data/lib/botomizer/message.rb

@@ -0,0 +1,22 @@
+class Botomizer::Message
+  attr_accessor :id, :text, :cmd
+
+  def initialize(params)
+    @id   = params[:id]
+    @text = params[:text]
+
+    if @text.index('/') == 0
+      sp    = @text.split(' ')
+      @cmd  = sp.first.downcase.gsub!('/', '')
+      @text = sp.drop(1).join(' ')
+    end
+  end
+
+  def cmd?
+    !@cmd.nil?
+  end
+
+  def text?
+    !@text.blank?
+  end
+end

data/lib/botomizer/telegram/webhook.rb

@@ -0,0 +1,33 @@
+class Botomizer::Telegram::Webhook
+  def initialize(client)
+    @client = client
+  end
+
+  def set(url)
+    @client.send('setWebhook', {url: url})
+  end
+
+  def set!(url)
+    begin
+      @client.send!('setWebhook', {url: url})
+    rescue Botomizer::ResponseError => e
+      raise Botomizer::WebhookError.new(e)
+    end
+  end
+
+  def info
+    @client.send('getWebhookInfo')
+  end
+
+  def delete
+    @client.send('deleteWebhook')
+  end
+
+  def delete!
+    begin
+      @client.send!('deleteWebhook')
+    rescue Botomizer::ResponseError => e
+      raise Botomizer::WebhookError.new(e)
+    end
+  end
+end

data/lib/botomizer/telegram.rb

@@ -0,0 +1,51 @@
+module Botomizer::Telegram
+  API_URL = 'https://api.telegram.org/bot'.freeze
+
+  class << self
+    attr_accessor :options, :message, :chat, :client
+
+    def webhook
+      Webhook.new(@client)
+    end
+
+    def parse_request(request)
+      message_key = ['message', 'edited_message', 'channel_post', 'edited_channel_post'].detect do |key|
+        request.has_key? key
+      end
+
+      if message_key
+        message = request[message_key]
+        @message = Botomizer::Message.new({
+            id: message['message_id'],
+            text: message['text']
+        })
+        @chat = Botomizer::Chat.new({
+            id: message['chat']['id'],
+            type: message['chat']['type'],
+            title: message['chat']['title'] || nil,
+            first_name: message['chat']['first_name'] || nil,
+            last_name: message['chat']['last_name'] || nil,
+            username: message['chat']['username']
+        })
+      else
+        raise Botomizer::BotError.new("Can't parse request")
+      end
+    end
+
+    def send(method, query = {})
+      response = HTTParty.get("#{API_URL}#{@options[:token]}/#{method}", {query: query}).parsed_response
+
+      if response['ok']
+        {status: :success, result: response['result'], message: response['description']}
+      else
+        {status: :failed, error: response['error_code'], message: response['description']}
+      end
+    end
+
+    def send_message(text, options = {})
+      send(:sendMessage, {chat_id: @chat.id, text: text, parse_mode: 'HTML'}.merge(options))
+    end
+  end
+end
+
+require 'botomizer/telegram/webhook'

data/lib/botomizer/version.rb

@@ -0,0 +1,3 @@
+module Botomizer
+  VERSION = '0.1.3'
+end

data/lib/botomizer.rb

@@ -0,0 +1,11 @@
+require 'httparty'
+
+require 'botomizer/version'
+require 'botomizer/exceptions'
+require 'botomizer/client'
+require 'botomizer/handler'
+require 'botomizer/cache'
+require 'botomizer/message'
+require 'botomizer/chat'
+
+module Botomizer end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: botomizer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Alex Belenky
@@ -28,14 +28,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -70,14 +70,14 @@ dependencies:
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.15.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.15.6
 description: Write a longer description or delete this line.
@@ -86,8 +86,34 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: 
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- botomizer-0.1.0.gem
+- botomizer-0.1.1.gem
+- botomizer-0.1.2.gem
+- botomizer.gemspec
+- examples/telegram.rb
+- lib/botomizer.rb
+- lib/botomizer/cache.rb
+- lib/botomizer/chat.rb
+- lib/botomizer/client.rb
+- lib/botomizer/exceptions.rb
+- lib/botomizer/handler.rb
+- lib/botomizer/message.rb
+- lib/botomizer/telegram.rb
+- lib/botomizer/telegram/webhook.rb
+- lib/botomizer/version.rb
+homepage: https://github.com/Stajor/botomizer
 licenses:
 - MIT
 metadata: {}