tars 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4415bd1f9dad1a5098a8c955b2de1ca1c35c0751
-  data.tar.gz: 48a9bbe84eda7225d1aeea31e8f9995d833f2627
+  metadata.gz: 9f5fe67b91d5d033d41f2c7123050a323a782ec8
+  data.tar.gz: 3af01b0411e8767080be738b85def34a2b609907
 SHA512:
-  metadata.gz: cd216d5161e618153bd580b866b817e4ef0186c105d3c8674af62faa0b1874dfe55c4fb02bcc247092108cd25348471805383185212dfbc6e48d6a1742d7369b
-  data.tar.gz: 416ed95b264aa835ff58190406a543f5cc9c87fe32811a57ce4a09e2ceb9773a2fc4d1a4538e6b800d8f42bc7e4f294f908578ca109c12a24682bb1de94adc6c
+  metadata.gz: aff30a532f45666f69df07c54d3175e5abb15006648320babcc05268e9cad62c036c908792bd93da0334c77b96b1eabaca1efee9bc4debb39907f179b975d86e
+  data.tar.gz: 6f908bef3686853813d73f3f107803416d69ff7396593d8c9209a6a7a885747b154ccfdcf78fc2c21be64e6d0e16d9e78858e8659ed6011a1bfb5eff7c5b8340

data/README.md

@@ -43,6 +43,32 @@ end
 
 TARS.bootstrap
 ```
+## API
+
+`TARS.configure`:
+This configuration block allow you to specify your bot settings. Options are:
+
+- `token`: This is your bot token, keep it private. To obtain your bot token you should talk to the @botFather and register your bot.
+
+- `webhook`: The URL that telegram will use to send you update each time your bot receive a message. This URL should point to this bot server where you run TARS. It's should be in HTTPS with a valid SSL certificate. See *How to run TARS behind Nginx* below for more information about configuring SSL.
+
+- `server.port`: The port of the local TARS server. This can be anything if you don't want to use TARS behind a reverse proxy. However it should be a valid port handled by Telegram Bot API (Currently 80, 443, 8443)
+
+- `server.path`: The prefix of the URL to access TARS server. This could be anything
+
+*Note:* The server Hash can contain any WEBrick params so you can set SSL directly with TARS. See *How to run TARS with WEBrick and SSL* for more informations.
+
+## Todo
+
+- [x] Create a check list 
+- [ ] Write documentation 
+- [ ] Add unit and fonctionnal test
+- [ ] Add option to deamonize/fork in backgrounds 
+- [ ] Handle telegram API errors 
+- [ ] Allow to pass a RegEx to `on` as first parameter
+- [ ] Implement a Logger 
+- [ ] Clean WEBrick output to stdout 
+- [ ] Colored output 
 
 ## Contributing
 

data/lib/tars.rb

@@ -3,6 +3,8 @@ require 'tars/api'
 require 'tars/update'
 require 'tars/bot'
 
+require 'logger'
+
 module TARS
   class << self
     attr_accessor :config, :bot
@@ -19,13 +21,11 @@ module TARS
   end
 
   def self.bootstrap
-    me = TARS::API.me
-
-    puts "Setting webhook for Bot to #{TARS.config.webhook} ..."
+    puts "Setting webhook for Bot to #{TARS.config.webhook}"
     TARS::API.webhook
 
-    puts 'Running local server..'
-
-    TARS::Server.new
+    puts 'Launch TARS server'
+    server = TARS::Server.new
+    server.run!
   end
 end

data/lib/tars/api.rb

@@ -1,10 +1,15 @@
 require 'json'
 require 'httparty'
+require 'rest-client'
+require 'pp'
+require 'open-uri'
+
+BASE_URI = 'api.telegram.org'
 
 module TARS
   class API
     include HTTParty
-    base_uri 'api.telegram.org'
+    base_uri BASE_URI
 
     def self.me
       request 'getMe'
@@ -22,6 +27,15 @@ module TARS
       request 'sendMessage', chat_id: chat_id, text: text
     end
 
+    def self.reply_with_photo(chat_id, photo)
+      uri = "https://#{BASE_URI}/bot#{TARS.config.token}/sendPhoto"
+      random = "/tmp/#{Digest::MD5.hexdigest(photo)}#{File.extname(photo)}"
+
+      IO.copy_stream(open(photo), random)
+      RestClient.post(uri, chat_id: chat_id, photo: open(random))
+      File.delete(random)
+    end
+
     def self.request(endpoint, options = {})
       post("/bot#{TARS.config.token}/#{endpoint}", query: options)
     end

data/lib/tars/bot.rb

@@ -15,10 +15,17 @@ module TARS
   end
 
   class Server
+    class << self
+      attr_reader :server
+    end
+
     def initialize
-      server = WEBrick::HTTPServer.new Port: TARS.config.server[:port]
-      server.mount TARS.config.server[:path], TARS::PostHandler
-      server.start
+      @server = WEBrick::HTTPServer.new Port: TARS.config.server[:port]
+      @server.mount TARS.config.server[:path], TARS::PostHandler
+    end
+
+    def run!
+      @server.start
     end
   end
 
@@ -31,13 +38,14 @@ module TARS
       @cmds = {}
     end
 
-    def on(message, &block)
-      @cmds[message] = block
+    def on(command, &block)
+      @cmds[command] = block
     end
 
-    def execute(command, message)
+    def execute(command, update)
       return unless @cmds.key?(command)
-      @cmds[command].call(message)
+      message = update.instance_variable_get('@message')
+      @cmds[command].call(message, message['chat']['id'])
     end
   end
 end

data/lib/tars/version.rb

@@ -1,3 +1,3 @@
 module TARS
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/tars.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "json", "~> 1.8"
   spec.add_dependency "httparty", "~> 0.13.5"
+  spec.add_dependency "rest-client", "~> 1.8.0"
 
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tars
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Felix Yadomi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-26 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.5
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,11 +89,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
 - Rakefile
-- bin/console
 - bin/setup
 - lib/tars.rb
 - lib/tars/api.rb

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "TARS"
-
-# 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