sbire 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23a66e9330db17e711a672a9f27b315383b4adbb
-  data.tar.gz: ccfd9923fbf7e9eef0f4c6dbba29a7c58d6076ca
+  metadata.gz: 1b95928f61c106d66ace43ecd8cb62f90aaa719f
+  data.tar.gz: 3fb14d64359c679e08c4d4369243c4aa603f13d8
 SHA512:
-  metadata.gz: 6a41d6e3dc882502f8bddc81076342196557bca4a603ee9120cd4a8e0e171c168c402b8351a10da4ec2a447581566e9bfb2d7530ddefdee93e677fea8391cad2
-  data.tar.gz: 55a55882ec81f07801d7353c5ef21a5c7bc92646535d123e9d51fec82e00ce1561b4cabe89101b08617423814430a88e9540ab5f48f98b132818ca589215be41
+  metadata.gz: bb710a9f522f51769f9f5e1b9324f7ddf90e0bacc9279d07f6f570575c507f4bd56824dae8d19070a9226b9bec13fe304f4221620af7dcd3e68461c8ec9fa6d4
+  data.tar.gz: 55d2c350688d2339d9758f3b5e8acda7c6d606bd075c863fcad9fb1cf665963bdd0a3e023c1e81529476b43927668cd1294ac2c029be3dfdef47e3bd06d571c6

data/README.md

@@ -1,22 +1,23 @@
 # Sbire
 
-In french, a "Sbire" is a henchman. It's the guy who do what you say. Sbire is program which is capable to listen what you said and execute the command associated.
+"Sbire" is the French word for henchman. Sbire is program which is capable to listen what you said and execute the command associated.
 
 ## Installation
 
-On linux :
+Linux :
 
-    sudo apt-get install sox notify-osd ruby1.9.1
+    sudo apt-get install sox notify-osd ruby1.9.1 xdotool
     gem install sbire
     sbire install
 
-On mac :
+OSX:
 
     brew install sox
+    sudo port install xdotool
     gem install sbire
     sbire install
 
-On windows :
+Windows :
 
     Install ruby with [RubyInstall](http://rubyinstaller.org/)
     gem install sbire
@@ -24,38 +25,53 @@ On windows :
 
 ## Usage
 
-To execute a command :
+To run a command :
 
   - Open a terminal
   - Type `sbire start`
-  - Say the command you want ("Firefox" for example)
-  - Type `sbire stop`
+  - Say the command ("Firefox" for example)
   - The command will be executed
 
+To write where your cursor is :
+
+  - Open a terminal
+  - Type `sbire pipe`
+  - Say the text ("This project rocks" for example)
+  - It will write the text where your cursor is
+
 To write a text file :
 
   - Open a terminal
-  - Type `sbire start`
-  - Say what you want ("This project rocks" for example)
   - Type `sbire save`
+  - Say the text ("This project rocks" for example)
   - A file will be created in `~\.sbire\text`
 
-If you want to see what is put in the file in real time, you can do `tail -f ~\.sbire\text`.
+To stop sbire, type `sbire stop`.
+
+If you want to see what is written in the file in real time, run `tail -f ~\.sbire\text`.
 
 ## Configuration
 
-By default, the language is en-us. You can change it by changing the file `~\.sbire\config.yml` and put `lang: fr-FR` in it.
+By default, the language is en-us. You can change it by changing the value of `lang` by your language. For example, to set it to French, write:
+```
+lang: fr-FR`
+```
 
 ## Bind phrase and commands
 
-You can bind more complexe phrases with commands by adding a file`~\.sbire\commands.yml` and put in it something like this :
-
+You can bind more complexe phrases with commands by adding a `~\.sbire\commands.yml` file and write for example:
+```
     "chromium-browser": ["open chrome", "chrome"]
     "skype": "open skype"
+```
+
+## Pipe the text with a custom command
+
+By default, when you use `sbire pipe`, it will use a command to emulate the keyboard. You can change it by editing the file `~\.sbire\config.yml` and change the value of `pipe_command` by anything you want.
 
-## Make a shortcut
+## Add a shortcut
 
-For an obscure reason, Ubuntu does not execute ruby commands binded with a keyboard shortcut. You must to install [xbindkeys](http://doc.ubuntu-fr.org/xbindkeys) to make it working.
+For some obscure reason, Ubuntu does not run ruby commands binded with a keyboard shortcut. You must install [xbindkeys](http://doc.ubuntu-fr.org/xbindkeys) to make it work.
 
 ## Contributing
 

data/bin/sbire

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require_relative '../lib/sbire'
-Sbire::Command.new(ARGV).call
+Sbire::Command.start

data/files/config_linux.yml

@@ -1,2 +1,3 @@
 lang: "en-us"
 notify_command: "notify-send '%{message}'"
+pipe_command: "xdotool type '%{text}'"

data/files/config_mac.yml

@@ -1,2 +1,3 @@
 lang: "en-us"
 notify_command: "terminal-notifier -sender com.apple.Terminal -message %{message}"
+pipe_command: "xdotool type '%{text}'"

data/files/config_win.yml

@@ -1,2 +1,3 @@
 lang: "en-us"
 notify_command: "echo '%{message}'"
+pipe_command: "echo '%{text}'"

data/lib/sbire.rb

@@ -1,10 +1,18 @@
+require 'rest_client'
+require 'thor'
+require 'json'
+require 'fileutils'
+require 'rest_client'
+require 'yaml'
+
+require_relative 'sbire/sbire_config'
 require_relative 'sbire/command'
 require_relative 'sbire/notifier'
 require_relative 'sbire/audio_converter'
 require_relative 'sbire/command_manager'
 require_relative 'sbire/audio_recorder'
 require_relative 'sbire/save_manager'
-require_relative 'sbire/sbire_config'
+require_relative 'sbire/pipe_manager'
+require_relative 'sbire/stream_manager'
 require_relative 'sbire/pid_manager'
 require_relative 'sbire/os'
-require 'rest_client'

data/lib/sbire/audio_converter.rb

@@ -1,7 +1,3 @@
-require 'json'
-require 'fileutils'
-require 'rest_client'
-
 module Sbire
   class AudioConverter
     attr_accessor :pid_manager
@@ -47,7 +43,12 @@ module Sbire
         response = RestClient.post url,
           file,
           content_type: 'audio/x-flac; rate=16000'
-        read_response(response.to_str) if response.code == 200
+        response = read_response(response.to_str) if response.code == 200
+        if response
+          return response
+        else
+          return empty_result
+        end
       rescue => e
         puts e
         return [""]
@@ -60,8 +61,16 @@ module Sbire
     end
 
     def read_response(text)
-      data = JSON.parse(text)
-      data['hypotheses'].map {|ut| [ut['utterance'], ut['confidence']] }.first
+      if text && text.empty?
+        empty_result
+      else
+        data = JSON.parse(text)
+        data['hypotheses'].map {|ut| [ut['utterance'], ut['confidence']] }.first
+      end
+    end
+
+    def empty_result
+      ['', 0]
     end
 
     def url

data/lib/sbire/audio_recorder.rb

@@ -17,7 +17,7 @@ module Sbire
 
     private
     def record_audio
-      fork { exec "sox -t alsa -r 22050 default #{path}.flac -q silence -l 1 0 1% 1 1.0 1% rate 16k : newfile : restart" }
+      fork { exec "sox -t alsa -r 22050 default #{path}.flac -q silence -l 1 0 2% 1 1.0 2% rate 16k : newfile : restart" }
     end
   end
 end

data/lib/sbire/command.rb

@@ -1,25 +1,10 @@
 module Sbire
-  class Command
+  class Command < Thor
+    package_name "Sbire"
 
     attr_accessor :command
 
-    def self.run(argv)
-      self.new(argv).call
-    end
-
-    def initialize(argv)
-      @command = argv.first
-    end
-
-    def call
-      if ["start", "stop", "save", "install"].include?(command)
-        send(command)
-      else
-        show("Command not found")
-      end
-    end
-
-    private
+    desc "start", "Start to listening your voice and execute associated commands"
     def start
       stop
       show("Sbire is listening your voice")
@@ -29,11 +14,13 @@ module Sbire
       end
     end
 
+    desc "stop", "Stop all dependencies of Sbire"
     def stop
       audio_recorder.stop
       audio_converter.stop
     end
 
+    desc "save", "Save what you say in ~/.sbire/text. You can customize the path by edition ~/.sbire/config.yml"
     def save
       stop
       show("Sbire is listening your voice")
@@ -44,6 +31,17 @@ module Sbire
       end
     end
 
+    desc "pipe", "Send what you say to another command. You can customize the commd by editing ~/.sbire/config.yml"
+    def pipe
+      stop
+      show("Sbire is listening your voice")
+      audio_recorder.start
+      audio_converter.start do |results, index|
+        pipe_manager.pipe(results, index) if results
+      end
+    end
+
+    desc "install", "Install Sbire"
     def install
       home = Dir.home
       config_file = "config_#{OS.familly}.yml"
@@ -53,6 +51,8 @@ module Sbire
       FileUtils.copy(path, "#{home}/.sbire/config.yml")
     end
 
+    private
+
     def recreate_text_file
       File.write(SbireConfig.text_file, '')
     end
@@ -73,6 +73,10 @@ module Sbire
       @save_manager ||= SaveManager.new
     end
 
+    def pipe_manager
+      @pipe_manager ||= PipeManager.new
+    end
+
     def show(message)
       Notifier.call(message)
     end

data/lib/sbire/command_manager.rb

@@ -1,5 +1,3 @@
-require 'yaml'
-
 module Sbire
   class CommandManager
     attr_accessor :commands

data/lib/sbire/notifier.rb

@@ -1,5 +1,3 @@
-require_relative 'sbire_config'
-
 module Sbire
   class Notifier
     def self.call(message)

data/lib/sbire/pipe_manager.rb

@@ -0,0 +1,20 @@
+module Sbire
+  class PipeManager
+    def pipe(hypotheses, index)
+      stream_manager.execute(hypotheses, index) do |result|
+        send_command(result)
+      end
+    end
+
+    private
+
+    def stream_manager
+      @stream_manager ||= StreamManager.new
+    end
+
+    def send_command(text)
+      command = SbireConfig.pipe_command % { text: text }
+      system(command)
+    end
+  end
+end

data/lib/sbire/save_manager.rb

@@ -1,36 +1,19 @@
 module Sbire
   class SaveManager
-    attr_accessor :last_index, :max_index
-
-    def initialize
-      @last_index = 0
-      @max_index = 0
-    end
-
     def save(hypotheses, index)
-      compute_max_index(index)
-      hypotheses = current_hypotheses(hypotheses)
-      unless hypotheses.include?(nil)
-        append_to_file(hypotheses)
-        @last_index = index + 1
+      stream_manager.execute(hypotheses, index) do |result|
+        append_to_file(result)
       end
     end
 
     private
 
-    def compute_max_index(index)
-      @max_index = index if @max_index < index
+    def stream_manager
+      @stream_manager ||= StreamManager.new
     end
 
-    def current_hypotheses(hypotheses)
-      hypotheses.map { |hypothese| hypothese.first }[last_index..max_index]
-    end
-
-    def append_to_file(hypotheses)
-      text = hypotheses.join(" ") + " "
-      if text != " "
-        File.open(SbireConfig.text_file, 'ab+') {|file| file.write(text)}
-      end
+    def append_to_file(text)
+      File.open(SbireConfig.text_file, 'ab+') {|file| file.write(text)}
     end
   end
 end

data/lib/sbire/sbire_config.rb

@@ -1,5 +1,3 @@
-require 'yaml'
-
 module Sbire
   class SbireConfig
     def self.config_path
@@ -7,7 +5,11 @@ module Sbire
     end
 
     def self.base_directory
-      "#{Dir.home}/.sbire"
+      if ENV["mode"] == "test"
+        "./spec/fixtures"
+      else
+        "#{Dir.home}/.sbire"
+      end
     end
 
     def self.lang
@@ -34,6 +36,10 @@ module Sbire
       config["notify_command"]
     end
 
+    def self.pipe_command
+      config["pipe_command"]
+    end
+
     private
 
     def self.config

data/lib/sbire/stream_manager.rb

@@ -0,0 +1,38 @@
+module Sbire
+  class StreamManager
+    attr_accessor :last_index, :max_index
+
+    def initialize
+      @last_index = 0
+      @max_index = 0
+    end
+
+    def execute(hypotheses, index, &block)
+      compute_max_index(index)
+      hypotheses = current_hypotheses(hypotheses)
+      unless hypotheses.include?(nil)
+        send_result(hypotheses, block)
+        @last_index = index + 1
+      end
+    end
+
+    private
+
+    def compute_max_index(index)
+      @max_index = index if @max_index < index
+    end
+
+    def current_hypotheses(hypotheses)
+      hypotheses.map { |hypothese| hypothese.first }[last_index..max_index]
+    end
+
+    def send_result(hypotheses, block)
+      text = sanitize(hypotheses.join(" ")) + " "
+      block.call(text) if text != " "
+    end
+
+    def sanitize(text)
+      text.gsub('"', '\"')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sbire
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Guirec Corbel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2013-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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'
 description: Sbire is a command line tool that recognize your voice and execute commands
   linked
 email: guirec.corbel@gmail.com
@@ -34,8 +48,10 @@ extra_rdoc_files: []
 files:
 - bin/sbire
 - lib/sbire.rb
+- lib/sbire/pipe_manager.rb
 - lib/sbire/audio_converter.rb
 - lib/sbire/audio_recorder.rb
+- lib/sbire/stream_manager.rb
 - lib/sbire/os.rb
 - lib/sbire/command_manager.rb
 - lib/sbire/save_manager.rb