annyang-rails 0.2.0

data/Manifest

@@ -0,0 +1,9 @@
+README.md
+Rakefile
+app/helpers/annyang_helper.rb
+init.rb
+lib/annyang-rails.rb
+lib/annyang-rails/version.rb
+vendor/assets/javascripts/annyang.js
+vendor/assets/javascripts/annyang.min.js
+Manifest

data/README.md

@@ -0,0 +1,92 @@
+# annyang for Rails Asset Pipeline
+
+[annyang](https://github.com/TalAter/annyang) is a tiny javascript SpeechRecognition library that lets your users control your site with voice commands. ([documentation](https://www.talater.com/annyang/)). 
+
+This gem makes it easy to use it with Rails Asset Pipeline.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "annyang-rails"
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+Add the following to your `app/assets/javascripts/application.js`:
+
+    //= require annyang
+
+To use minified version use this:
+
+    //= require annyang.min
+
+We have created a helper function to make it easy.
+
+    init_annyang
+
+If you want to use voice navigation in complete application then call helper function in application layout or if you want to use voice navigation in some specific pages then call helper function in your specific views.
+
+    <%= init_annyang %>
+
+This helper will generate javascript which will redirect you to specified link for that keyword. You have to speak in microphone with prefix `go to <keyword>` and system will redirect to link which is associated with that keyword.
+
+We have 3 different ways to define voice navigation commands:
+
+    1 - YAML File
+    2 - Function Parameters
+    3 - HTML Attribute
+
+#### 1 - YAML File
+
+You can create file annyang.yml in config directory (config/annyang.yml) where you can define keywords and there links:
+
+    "ruby": "https://www.ruby-lang.org"
+    "rubygems": "http://rubygems.org"
+
+You can also define options for keywords like if you want to open same link for rubygem and rubygems then you can write it OR (|) operator:
+
+    "rubygem|rubygems": "http://rubygems.org"
+    
+In case `rubygem|rubygems` both voice commands `go to rubygem` and `go to rubygems` will take you to `http://rubygems.org`
+
+#### 2 - Function Parameters
+
+You can pass keywords in helper function's parameters:
+
+    <%= init_annyang({"ruby" => "https://www.ruby-lang.org", "rubygem|rubygems" => "http://rubygems.org"}) %>
+
+#### 3 - HTML Attribute
+
+You can specify your keywords in HTML tags with `data-annyang` attribute name.
+You have to specify keyword in `data-annyang` attribute in anchor tag and when someone will speak specified word then system will open href link.
+
+    <a href="https://www.ruby-lang.org" data-annyang="ruby">Ruby</a>
+    <a href="http://rubygems.org" data-annyang="rubygem|rubygems">Ruby Gems</a>
+
+
+
+If you want to use this by your own then try it like this:
+
+````html
+<script>
+if (annyang) {
+  // Let's define a command.
+  var commands = {
+    'show tps report': function() { $('#tpsreport').show(); }
+  };
+
+  // Initialize annyang with our commands
+  annyang.init(commands);
+
+  // Start listening.
+  annyang.start();
+}
+</script>
+
+````
+
+**For more details, [visit the demo and docs site](https://www.talater.com/annyang).**

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('annyang-rails', '0.2.0') do |p|
+  p.description    = "A tiny javascript SpeechRecognition library that lets your users control your site with voice commands."
+  p.url            = "http://github.com/confiz/annyang-rails"
+  p.author         = "Confiz Limited"
+  p.email          = "opensource@confiz.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/annyang-rails.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "annyang-rails"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Confiz Limited"]
+  s.date = "2013-12-09"
+  s.description = "A tiny javascript SpeechRecognition library that lets your users control your site with voice commands."
+  s.email = "opensource@confiz.com"
+  s.extra_rdoc_files = ["README.md", "lib/annyang-rails.rb", "lib/annyang-rails/version.rb"]
+  s.files = ["README.md", "Rakefile", "app/helpers/annyang_helper.rb", "init.rb", "lib/annyang-rails.rb", "lib/annyang-rails/version.rb", "vendor/assets/javascripts/annyang.js", "vendor/assets/javascripts/annyang.min.js", "Manifest", "annyang-rails.gemspec"]
+  s.homepage = "http://github.com/confiz/annyang-rails"
+  s.rdoc_options = ["--line-numbers", "--title", "Annyang-rails", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "annyang-rails"
+  s.rubygems_version = "1.8.24"
+  s.summary = "A tiny javascript SpeechRecognition library that lets your users control your site with voice commands."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/app/helpers/annyang_helper.rb

@@ -0,0 +1,34 @@
+module AnnyangHelper
+  def init_annyang(commands = {})
+    commands = commands.merge(get_annyang_commands)
+      javascript_tag do 
+      raw("var annyang_commands={};
+      var linkAnnyang = function(term){
+        if(annyang_commands[term]){
+           window.location = annyang_commands[term];
+        }
+      }
+      function initAnnyang(){
+	if (annyang) {
+          annyang_commands = {#{commands.collect{|k,v| k.split('|').collect {|key| "'#{key}': '#{v}'"} }.join(', ')}};
+            if($('a[data-annyang]').length > 0){
+              $('a[data-annyang]').each(function( index ) {
+		var link = $(this).attr('href');
+		var split_arr = $(this).attr('data-annyang').split('|');
+		for (var i=0; i < split_arr.length; i++)
+		  annyang_commands[split_arr[i]] = link;
+              });
+            }
+          annyang.init({'go to *term': linkAnnyang});
+          annyang.start();
+        }
+      }
+      $(document).ready(initAnnyang);")
+      end
+  end
+  def get_annyang_commands
+      yml_path = File.join(Rails.root,"config/annyang.yml")
+      commands_hash = YAML.load_file(yml_path) if yml_path && File.exist?(yml_path)
+      commands_hash||{}
+    end
+end

data/init.rb

@@ -0,0 +1,3 @@
+require 'annyang'
+ActionController::Base.helper AnnyangHelper
+

data/lib/annyang-rails.rb

@@ -0,0 +1,8 @@
+require "annyang-rails/version"
+
+module Annyang
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/annyang-rails/version.rb

@@ -0,0 +1,5 @@
+module Annyang
+  module Rails
+    VERSION = "0.2.0"
+  end
+end

data/vendor/assets/javascripts/annyang.js

@@ -0,0 +1,229 @@
+//! annyang
+//! version : 0.2.0
+//! author  : Tal Ater @TalAter
+//! license : MIT
+//! https://www.TalAter.com/annyang/
+(function () {
+  "use strict";
+
+  // Save a reference to the global object (window in the browser)
+  var root = this;
+
+  // Get the SpeechRecognition object, while handling browser prefixes
+  var SpeechRecognition = root.webkitSpeechRecognition ||
+                          root.mozSpeechRecognition ||
+                          root.msSpeechRecognition ||
+                          root.oSpeechRecognition ||
+                          root.SpeechRecognition;
+
+  // Check browser support
+  // This is done as early as possible, to make it as fast as possible for unsupported browsers
+  if ( !SpeechRecognition ) {
+    root.annyang = null;
+    return null;
+  }
+
+  var commandsList;
+  var recognition;
+  var lang = 'en-US';
+  var callbacks = { start: [], error: [], end: [], result: [], resultMatch: [], resultNoMatch: [], errorNetwork: [], errorPermissionBlocked: [], errorPermissionDenied: [] };
+  var autoRestart;
+  var lastStartedAt = 0;
+  var debugState = false;
+  var debugStyle = 'font-weight: bold; color: #00f;';
+
+  // The command matching code is a modified version of Backbone.Router by Jeremy Ashkenas, under the MIT license.
+  var optionalParam = /\s*\((.*?)\)\s*/g;
+  var optionalRegex = /(\(\?:[^)]+\))\?/g;
+  var namedParam    = /(\(\?)?:\w+/g;
+  var splatParam    = /\*\w+/g;
+  var escapeRegExp  = /[\-{}\[\]+?.,\\\^$|#]/g;
+  var commandToRegExp = function(command) {
+    command = command.replace(escapeRegExp, '\\$&')
+                  .replace(optionalParam, '(?:$1)?')
+                  .replace(namedParam, function(match, optional) {
+                    return optional ? match : '([^\\s]+)';
+                  })
+                  .replace(splatParam, '(.*?)')
+                  .replace(optionalRegex, '\\s*$1?\\s*');
+    return new RegExp('^' + command + '$', 'i');
+  };
+
+  // This method receives an array of callbacks to iterate over, and invokes each of them
+  var invokeCallbacks = function(callbacks) {
+    for (var j = 0, l = callbacks.length; j < l; j++) {
+      callbacks[j].callback.apply(callbacks[j].context);
+    }
+  };
+
+  root.annyang = {
+    // Initialize annyang with a list of commands to recognize.
+    // e.g. annyang.init({'hello :name': helloFunction})
+    // annyang understands commands with named variables, splats, and optional words.
+    init: function(commands) {
+
+      // Abort previous instances of recognition already running
+      if (recognition && recognition.abort) {
+        recognition.abort();
+      }
+
+      // initiate SpeechRecognition
+      recognition = new SpeechRecognition();
+
+      // Set the max number of alternative transcripts to try and match with a command
+      recognition.maxAlternatives = 5;
+      recognition.continuous = true;
+      // Sets the language to the default 'en-US'. This can be changed with annyang.setLanguage()
+      recognition.lang = lang;
+
+      recognition.onstart   = function()      { invokeCallbacks(callbacks.start); };
+
+      recognition.onerror   = function(event) {
+        invokeCallbacks(callbacks.error);
+        switch (event.error) {
+        case 'network':
+          invokeCallbacks(callbacks.errorNetwork);
+          break;
+        case 'not-allowed':
+        case 'service-not-allowed':
+          // if permission to use the mic is denied, turn off auto-restart
+          autoRestart = false;
+          // determine if permission was denied by user or automatically.
+          if (new Date().getTime()-lastStartedAt < 200) {
+            invokeCallbacks(callbacks.errorPermissionBlocked);
+          } else {
+            invokeCallbacks(callbacks.errorPermissionDenied);
+          }
+          break;
+        }
+      };
+
+      recognition.onend     = function() {
+        invokeCallbacks(callbacks.end);
+        // annyang will auto restart if it is closed automatically and not by user action.
+        if (autoRestart) {
+          // play nicely with the browser, and never restart annyang automatically more than once per second
+          var timeSinceLastStart = new Date().getTime()-lastStartedAt;
+          if (timeSinceLastStart < 1000) {
+            setTimeout(root.annyang.start, 1000-timeSinceLastStart);
+          } else {
+            root.annyang.start();
+          }
+        }
+      };
+
+      recognition.onresult  = function(event) {
+        invokeCallbacks(callbacks.result);
+        var results = event.results[event.resultIndex];
+        var commandText;
+        // go over each of the 5 results and alternative results received (we've set maxAlternatives to 5 above)
+        for (var i = 0; i<results.length; i++) {
+          // the text recognized
+          commandText = results[i].transcript.trim();
+          if (debugState) {
+            root.console.log('Speech recognized: %c'+commandText, debugStyle);
+          }
+
+          // try and match recognized text to one of the commands on the list
+          for (var j = 0, l = commandsList.length; j < l; j++) {
+            var result = commandsList[j].command.exec(commandText);
+            if (result) {
+              var parameters = result.slice(1);
+              if (debugState) {
+                root.console.log('command matched: %c'+commandsList[j].originalPhrase, debugStyle);
+                if (parameters.length) {
+                  root.console.log('with parameters', parameters);
+                }
+              }
+              // execute the matched command
+              commandsList[j].callback.apply(this, parameters);
+              invokeCallbacks(callbacks.resultMatch);
+              return true;
+            }
+          }
+        }
+        invokeCallbacks(callbacks.resultNoMatch);
+        return false;
+      };
+
+      // build commands list
+      commandsList = [];
+      this.addCommands(commands);
+    },
+
+    // Start listening (asking for permission first, if needed).
+    // Call this after you've initialized annyang with commands.
+    // Receives an optional options object:
+    // { autoRestart: true }
+    start: function(options) {
+      options = options || {};
+      if (options.autoRestart !== void 0) {
+        autoRestart = !!options.autoRestart;
+      } else {
+        autoRestart = true;
+      }
+      lastStartedAt = new Date().getTime();
+      recognition.start();
+    },
+
+    // abort the listening session (aka stop)
+    abort: function() {
+      autoRestart = false;
+      recognition.abort();
+    },
+
+    // Turn on output of debug messages to the console. Ugly, but super-handy!
+    debug: function(newState) {
+      if (arguments.length > 0) {
+        debugState = !!newState;
+      } else {
+        debugState = true;
+      }
+    },
+
+    // Set the language the user will speak in. If not called, defaults to 'en-US'.
+    // e.g. 'fr-FR' (French-France), 'es-CR' (Español-Costa Rica)
+    setLanguage: function(language) {
+      lang = language;
+      if (recognition && recognition.abort) {
+        recognition.lang = language;
+      }
+    },
+
+    // Add additional commands that annyang will respond to. Similar in syntax to annyang.init()
+    addCommands: function(commands) {
+      var cb,
+          command;
+      for (var phrase in commands) {
+        if (commands.hasOwnProperty(phrase)) {
+          cb = root[commands[phrase]] || commands[phrase];
+          if (typeof cb !== 'function') {
+            continue;
+          }
+          //convert command to regex
+          command = commandToRegExp(phrase);
+
+          commandsList.push({ command: command, callback: cb, originalPhrase: phrase });
+        }
+      }
+      if (debugState) {
+        root.console.log('Commands successfully loaded: %c'+commandsList.length, debugStyle);
+      }
+    },
+
+    // Lets the user add a callback of one of 9 types:
+    // start, error, end, result, resultMatch, resultNoMatch, errorNetwork, errorPermissionBlocked, errorPermissionDenied
+    // Can also optionally receive a context for the callback function as the third argument
+    addCallback: function(type, callback, context) {
+      if (callbacks[type]  === void 0) {
+        return;
+      }
+      var cb = root[callback] || callback;
+      if (typeof cb !== 'function') {
+        return;
+      }
+      callbacks[type].push({callback: cb, context: context || this});
+    }
+  };
+
+}).call(this);

data/vendor/assets/javascripts/annyang.min.js

@@ -0,0 +1,6 @@
+//! annyang
+//! version : 0.2.0
+//! author  : Tal Ater @TalAter
+//! license : MIT
+//! https://www.TalAter.com/annyang/
+(function(){"use strict";var a=this,b=a.webkitSpeechRecognition||a.mozSpeechRecognition||a.msSpeechRecognition||a.oSpeechRecognition||a.SpeechRecognition;if(!b)return a.annyang=null,null;var c,d,e,f="en-US",g={start:[],error:[],end:[],result:[],resultMatch:[],resultNoMatch:[],errorNetwork:[],errorPermissionBlocked:[],errorPermissionDenied:[]},h=0,i=!1,j="font-weight: bold; color: #00f;",k=/\s*\((.*?)\)\s*/g,l=/(\(\?:[^)]+\))\?/g,m=/(\(\?)?:\w+/g,n=/\*\w+/g,o=/[\-{}\[\]+?.,\\\^$|#]/g,p=function(a){return a=a.replace(o,"\\$&").replace(k,"(?:$1)?").replace(m,function(a,b){return b?a:"([^\\s]+)"}).replace(n,"(.*?)").replace(l,"\\s*$1?\\s*"),new RegExp("^"+a+"$","i")},q=function(a){for(var b=0,c=a.length;c>b;b++)a[b].callback.apply(a[b].context)};a.annyang={init:function(k){d&&d.abort&&d.abort(),d=new b,d.maxAlternatives=5,d.continuous=!0,d.lang=f,d.onstart=function(){q(g.start)},d.onerror=function(a){switch(q(g.error),a.error){case"network":q(g.errorNetwork);break;case"not-allowed":case"service-not-allowed":e=!1,(new Date).getTime()-h<200?q(g.errorPermissionBlocked):q(g.errorPermissionDenied)}},d.onend=function(){if(q(g.end),e){var b=(new Date).getTime()-h;1e3>b?setTimeout(a.annyang.start,1e3-b):a.annyang.start()}},d.onresult=function(b){q(g.result);for(var d,e=b.results[b.resultIndex],f=0;f<e.length;f++){d=e[f].transcript.trim(),i&&a.console.log("Speech recognized: %c"+d,j);for(var h=0,k=c.length;k>h;h++){var l=c[h].command.exec(d);if(l){var m=l.slice(1);return i&&(a.console.log("command matched: %c"+c[h].originalPhrase,j),m.length&&a.console.log("with parameters",m)),c[h].callback.apply(this,m),q(g.resultMatch),!0}}}return q(g.resultNoMatch),!1},c=[],this.addCommands(k)},start:function(a){a=a||{},e=void 0!==a.autoRestart?!!a.autoRestart:!0,h=(new Date).getTime(),d.start()},abort:function(){e=!1,d.abort()},debug:function(a){i=arguments.length>0?!!a:!0},setLanguage:function(a){f=a,d&&d.abort&&(d.lang=a)},addCommands:function(b){var d,e;for(var f in b)if(b.hasOwnProperty(f)){if(d=a[b[f]]||b[f],"function"!=typeof d)continue;e=p(f),c.push({command:e,callback:d,originalPhrase:f})}i&&a.console.log("Commands successfully loaded: %c"+c.length,j)},addCallback:function(b,c,d){if(void 0!==g[b]){var e=a[c]||c;"function"==typeof e&&g[b].push({callback:e,context:d||this})}}}}).call(this);

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: annyang-rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Confiz Limited
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-09 00:00:00.000000000 Z
+dependencies: []
+description: A tiny javascript SpeechRecognition library that lets your users control
+  your site with voice commands.
+email: opensource@confiz.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- lib/annyang-rails.rb
+- lib/annyang-rails/version.rb
+files:
+- README.md
+- Rakefile
+- app/helpers/annyang_helper.rb
+- init.rb
+- lib/annyang-rails.rb
+- lib/annyang-rails/version.rb
+- vendor/assets/javascripts/annyang.js
+- vendor/assets/javascripts/annyang.min.js
+- Manifest
+- annyang-rails.gemspec
+homepage: http://github.com/confiz/annyang-rails
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --title
+- Annyang-rails
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
+requirements: []
+rubyforge_project: annyang-rails
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A tiny javascript SpeechRecognition library that lets your users control
+  your site with voice commands.
+test_files: []