record_me 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in record_me.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marco Gallardo
+
+MIT License
+
+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,89 @@
+# RecordMe
+
+record_me gem is a very simple gem that allows you to record user's audio input by using a simple javascript interface and an already built flash object. If you have questions about why I opted using flash and other info, you might want to take a look to my post [What? Rails can't hear you? Use Flash!](http://www.tangosource.com/blog/What-rails-cant-hear-you-use-flash/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'record_me'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install record_me
+
+Run generators:
+
+    $ rails generate record_me:install
+    $ rails generate record_me:initialize
+
+## Usage
+
+## Configuration file
+
+Specify default settings:
+
+* __top__: sets top absolute position of flash object window. Default is 40%.
+* __left__: sets left absolute position of flash object window. Default is 40%.
+* __time__: sets recording limit of seconds; maximum available are 180 seconds (3 minutes). Default is 30 seconds.
+* __name__: sets name of the record. Default is record.wav.
+* __destination__: the folder where all your records will be placed. Default is public/records.
+
+__top__, __left__, __time__, and __name__ can be overridden in your views as you will see next.
+
+### In your view
+
+Add next CSS class selectors to your HTML elements:
+
+* __.record\_me\_timer__: attaches a counter in seconds to the element
+* __.record\_me\_start__: when element with this selector is clicked, it triggers recording action
+* __.record\_me\_stop__: when element with this selector is clicked, recording stops
+* __.record\_me\_reproduce__: when element with this selector is clicked, recorded audio is reproduced
+* __.record\_me\_save__: when element with this selector is clicked, recorded audio is sent to server
+
+Then add next function to your view (since it will embed js code in your view you may want to add it at the bottom of your view/layout):
+
+__record\_me\_js({save\_path: some\_path})__
+
+where __save\_path__ is the path of the action where the recorded audio will be sent once element with .record\_me\_save class is clicked.
+
+Also, you can pass *time, name, top, and left* values to override config/record_me.yml settings.
+
+Example of how the code would look:
+
+`<%= link_to 'Save', '#', :class => 'record_me_save'%>`  
+`<div class='record_me_timer'></div>`  
+`<div class='record_me_start'>Start</div>`  
+`<div class='record_me_stop'>Stop</div>`  
+`<div class='record_me_reproduce'>Reproduce</div>`  
+`<%= record_me_js({save_path: audios_save_path, time: 3, name:'my_record.wav'}) %>`
+
+### In your controller
+
+Go to the action defined for __save\_path__ and add just add __record\_me\_save__. 'true' will be returned if file was successfully created.
+
+### Flash warning message
+
+Additionally you can display a message asking to install Flash if it is not installed, just call .flash\_warning\_message method and pass it the class of the html element you want to display the message:
+
+`<div class='flash_warning'></div>`
+`<%= flash_warning_message('flash_warning') %>`
+
+That's it! 
+
+## Wish list
+
+* Add tests
+* Ensure Rails 4.x compatibility
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config/initializer/record_me.rb

@@ -0,0 +1,23 @@
+module RecordMe
+
+  # the Authorization configuration file path
+  @file = Dir.pwd + '/config/record_me.yml' 
+
+  # Configure
+  def self.configure
+    if @file
+      # interpret it using YAML using the current environment to extract the configuration
+      @config = YAML.load( File.read(@file) )[ Rails.env ] 
+    end 
+
+    # creates directory where all records will be saved
+    directory = Dir.pwd + "/#{@config['destination']}"
+    Dir.mkdir(directory) unless File.directory?(directory)
+  end
+
+  def self.configuration
+    @config
+  end
+end
+
+RecordMe.configure

data/config/record_me.yml

@@ -0,0 +1,27 @@
+# set custom configuration for record_me
+# top  => sets absolute top position 
+# left => sets absolute top position 
+# time => sets the time to record expressed in seconds; max 3 minutes (180 sec.)
+# destination => the directory where records will be saved
+
+development:
+  top: 40%
+  left: 40%
+  time: 30
+  name: record.wav
+  destination: public/records
+
+#staging:
+#  top: 40%
+#  left: 40%
+#  time: 30
+#  name: record.wav
+#  destination: public/records
+
+#production:
+#  top: 40%
+#  left: 40%
+#  time: 30
+#  name: record.wav
+#  destination: public/records
+

data/lib/assets/javascripts/jRecorder.js

@@ -0,0 +1,245 @@
+/*
+ * jRecorder Plugin for jQuery JavaScript Library (Alpha)
+ * http://www.sajithmr.me/jrecorder
+ *
+ * Copyright (c) 2011 - 2013 Sajithmr.ME
+ * Dual licensed under the MIT and GPL licenses.
+ *  - http://www.opensource.org/licenses/mit-license.php
+ *  - http://www.gnu.org/copyleft/gpl.html
+ *
+ * Author: Sajith Amma
+ * Version: 1.1
+ * Date: 14 December 2011
+ */
+
+/* Code is not verified using http://www.jshint.com/ */
+
+
+(function ($){
+	
+	
+	var methods = {
+    	play : function( options ) { 
+					
+					alert(options);
+				
+	 			},
+    	pause : function( ) { }
+    
+  	};
+
+	
+	var jRecorderSettings = {} ;
+	
+	$.jRecorder = function( options, element ) {
+		// allow instantiation without initializing for simple inheritance
+		
+		
+		if(typeof(options) == "string")
+		{
+			if ( methods[options] ) 
+			{
+				return methods[ options ].apply( this, Array.prototype.slice.call( arguments, 1 ));
+				
+			}
+			return false;
+		}
+		
+		//if the element to be appended is not defind, append to body
+		if(element == undefined)
+		{
+			element = $("body");
+		}
+			
+		//default settings
+						var settings = {
+		
+						'rec_width': '300',
+						'rec_height': '200',
+						'rec_top': '0px',
+						'rec_left': '0px',
+						'recorderlayout_id' : 'flashrecarea',
+						'recorder_id' : 'audiorecorder',
+						'recorder_name': 'audiorecorder',
+						'wmode' : 'transparent',
+						'bgcolor': '#ff0000',
+						'swf_path': 'jRecorder.swf',
+						'host': 'acceptfile.php?filename=hello.wav',
+						'callback_started_recording' : function(){},
+						'callback_finished_recording' : function(){},
+						'callback_stopped_recording': function(){},
+						'callback_error_recording' : function(){},
+						'callback_activityTime': function(time){},
+						'callback_activityLevel' : function(level){}
+						
+						
+						
+		
+		
+						};
+	
+	
+						//if option array is passed, merget the values
+						if ( options ) { 
+					        $.extend( settings, options );
+					     }
+		
+						jRecorderSettings = settings;
+						
+						
+					                var myNav = navigator.userAgent.toLowerCase();
+                                                        var ie = (myNav.indexOf('msie') != -1) ? true : false;
+							if(ie && parseInt(myNav.split('msie')[1]) <= 8) {
+							var objStr = '<object  name="'+ settings['recorder_name'] +'" id="' + settings['recorder_id'] + '" classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" width="'+ settings['rec_width'] +'" height="'+ settings['rec_height']+'"></object>';
+
+							var paramStr = [
+								'<param name="movie" value="'+ settings['swf_path'] + '?host=' + settings['host'] +  '" />',
+								
+								'<param name="allowScriptAccess" value="always" />',
+								'<param name="bgcolor" value="' + settings['bgcolor'] + '" />',
+								'<param name="wmode" value="' +  settings['wmode'] + '" />'
+							];
+
+							htmlObj = document.createElement(objStr);
+							for(var i=0; i < paramStr.length; i++) {
+								htmlObj.appendChild(document.createElement(paramStr[i]));
+							}
+							
+							
+							//var divStr = ' <div id="'+ settings['recorderlayout_id'] +'" style="position:absolute;top:0px;left:0px;z-index:-1" ></div>';
+							//var divObj = document.createElement(divStr);
+							
+							
+						} else {
+							var createParam = function(el, n, v) {
+								var p = document.createElement("param");
+								p.setAttribute("name", n);	
+								p.setAttribute("value", v);
+								el.appendChild(p);
+							};
+
+							htmlObj = document.createElement("object");
+							htmlObj.setAttribute("id", settings['recorder_id'] );
+							htmlObj.setAttribute("name", settings['recorder_name'] );
+							htmlObj.setAttribute("data",  settings['swf_path'] + '?host=' + settings['host'] );
+							htmlObj.setAttribute("type", "application/x-shockwave-flash");
+							htmlObj.setAttribute("width", settings['rec_width']); // Non-zero
+							htmlObj.setAttribute("height", settings['rec_height']); // Non-zero
+							
+							createParam(htmlObj, "allowscriptaccess", "always");
+							createParam(htmlObj, "bgcolor", settings['bgcolor']);
+							createParam(htmlObj, "wmode", settings['wmode'] );
+							
+							
+							
+							
+						}
+
+
+						var divObj = document.createElement("div");
+						
+						divObj.setAttribute("id", settings['recorderlayout_id']);
+						divObj.setAttribute("style", "position:absolute;top:"+ settings['rec_top'] +";left:"+ settings['rec_left'] +";z-index:-1");
+						
+						divObj.appendChild(htmlObj);
+						
+						
+						element.append(divObj);
+						
+		
+		
+		
+		
+		
+		
+		
+	};
+	
+	//function call to start a recording
+	$.jRecorder.record = function(max_time){
+		
+		
+								//change z-index to make it top
+								$(  '#' + jRecorderSettings['recorderlayout_id'] ).css('z-index', 1000);
+								getFlashMovie(jRecorderSettings['recorder_name']).jStartRecording(max_time);
+							
+							
+		
+						} 
+
+	//function call to stop recording					
+	$.jRecorder.stop = function(){
+					
+		getFlashMovie(jRecorderSettings['recorder_name']).jStopRecording();
+							
+	} 
+		
+	//function call to send wav data to server url from the init configuration					
+	$.jRecorder.sendData = function(){
+					
+		getFlashMovie(jRecorderSettings['recorder_name']).jSendFileToServer();
+							
+	} 
+	
+	$.jRecorder.callback_started_recording = function(){
+		
+	
+		jRecorderSettings['callback_started_recording']();
+		
+	}
+	
+	
+	$.jRecorder.callback_finished_recording  = function(){
+		
+		jRecorderSettings['callback_finished_recording']();
+		
+	}
+	
+	$.jRecorder.callback_error_recording = function(){
+		
+		jRecorderSettings['callback_error_recording']();
+		
+	}
+	
+	$.jRecorder.callback_stopped_recording = function(){
+		
+		jRecorderSettings['callback_stopped_recording']();
+	}
+	
+	
+	$.jRecorder.callback_finished_sending = function(){
+		
+		jRecorderSettings['callback_finished_sending']();
+		
+	}
+	
+	$.jRecorder.callback_activityLevel = function(level){
+		
+		jRecorderSettings['callback_activityLevel'](level);	
+		
+	}
+	
+	$.jRecorder.callback_activityTime = function(time){
+		
+		//put back flash while recording
+		$(  '#' + jRecorderSettings['recorderlayout_id'] ).css('z-index', -1);
+		
+		jRecorderSettings['callback_activityTime'](time);
+		
+	}
+	
+		
+					
+	
+	//function to return flash object from name
+	function getFlashMovie(movieName) {
+       var isIE = navigator.appName.indexOf("Microsoft") != -1;
+       return (isIE) ? window[movieName] : document[movieName];
+     }
+
+
+	
+})(jQuery);
+
+
+

data/lib/generators/initialize_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module RecordMe
+  class InitializeGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('..', __FILE__)
+
+    desc "This generator adds all RecordMe configuration files to your app"
+
+    # copy config files
+    def copy_initializer_file
+
+      copy_file "../../config/initializer/record_me.rb", "config/initializers/record_me.rb"
+      copy_file "../../config/record_me.yml", "config/record_me.yml"
+    end
+  end
+end

data/lib/generators/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+module RecordMe
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('../assets', __FILE__)
+
+    desc "This generator adds all RecordMe required files to your assets"
+
+    # all public methods in here will be run in order
+    def copy_assets
+      copy_file "../../assets/javascripts/jRecorder.js", "app/assets/javascripts/jRecorder.js"
+      copy_file "../../assets/swfs/jRecorder.swf", "app/assets/swfs/jRecorder.swf"
+    end
+  end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,4 @@
+Rails.application.configure do
+  # Uncomment this to turn on verbose mode
+  # config.my_gem.verbose = true
+end

data/lib/record_me.rb

@@ -0,0 +1,13 @@
+require "record_me/controller.rb"
+require "record_me/helpers.rb"
+require "generators/install_generator.rb"
+require "generators/initialize_generator.rb"
+
+ActiveSupport.on_load(:action_controller) do
+  include RecordMe::Controller
+end
+
+ActiveSupport.on_load(:action_view) do
+  include RecordMe::Helpers
+end
+

data/lib/record_me/controller.rb

@@ -0,0 +1,20 @@
+module RecordMe
+  module Controller
+    def record_me_save(filename = params[:filename])
+      audio           = request.raw_post
+      file_with_path = RecordMe.configuration["destination"] + "/" + filename
+
+      return save_file(file_with_path, audio)
+    end 
+
+    private
+
+    def save_file(file_with_path, audio)
+      File.open(file_with_path, 'w+b'){|file| file.puts audio}
+
+      File.exist?(file_with_path) ? true : false  
+    end
+
+  end
+end
+

data/lib/record_me/helpers.rb

@@ -0,0 +1,77 @@
+module RecordMe
+  module Helpers
+    
+    def flash_warning_message(html_element)
+      javascript_tag do
+       (" 
+          $(function() {\n\
+            var flash_supported = (typeof navigator.plugins != \"undefined\" && typeof navigator.plugins[\"Shockwave Flash\"] == \"object\");\n\
+            if(!flash_supported){\n\
+              var append_message = \".#{html_element || '.flash_warning_message'}\";\n\
+              $(append_message).append(\"Please install <a href='https://get.adobe.com/flashplayer/' target='_blank'>Adobe Flash Player</a> to use RecordMe.\");\n\
+            }\n\
+          })\n\
+        ").html_safe
+      end
+    end
+    
+    def record_me_js(options = {})
+      javascript_tag do
+        ("\n\
+          $(function(){\n\
+            $('body').prepend('<div id=record_me_location></div>');\n\
+            var recorderLocation = $('#record_me_location')[0];\n\
+            var recorderStart = $('.record_me_start')[0];\n\
+            var recorderStop = $('.record_me_stop')[0];\n\
+            var recorderSendData = $('.record_me_save')[0];\n\
+            var recorderReproduce = $('.record_me_reproduce')[0];\n\
+            $.jRecorder(\n\
+            {\n\
+              rec_top: \"#{options[:top] || RecordMe.configuration['top']}\",\n\
+              rec_left: \"#{options[:left] || RecordMe.configuration['left']}\",\n\
+              host: \"#{options[:save_path] || ''}?filename=#{options[:name] || RecordMe.configuration['name']}\",\n\
+              callback_started_recording: function(){callback_started(); },\n\
+              callback_stopped_recording: function(){callback_stopped(); },\n\
+              callback_activityLevel: function(level){callback_activityLevel(level); },\n\
+              callback_activityTime: function(time){callback_activityTime(time);},\n\
+              callback_finished_sending: function(time){ callback_finished_sending() },\n\
+              swf_path : \"/assets/jRecorder.swf\",\n\
+            }, $(recorderLocation));\n\
+
+            $(recorderStart).click(function(){\n\
+              $.jRecorder.record(#{options[:time] || 30});\n\
+            });\n\
+
+            $(recorderStop).click(function(){\n\
+              $.jRecorder.stop();\n\
+            });\n\
+
+            $(recorderReproduce).click(function(){\n\
+              //jRecorder doesn't have an option to reproduce the clip, by stopping it we can accomplish that\n\
+              $.jRecorder.stop();\n\
+            });\n\
+
+            $(recorderSendData).click(function(){\n\
+              $.jRecorder.sendData();
+            });\n\
+
+            function callback_activityTime(time)\n\
+            {\n\
+              var time = parseInt(time);\n\
+              var minutes = Math.floor(time/60);\n\
+              var seconds = time % 60;\n\
+              timer(time, minutes, seconds);\n\
+            };\n\
+
+            function timer(time, minutes, seconds){\n\
+              seconds = ((time % 60) < 10) ? ('0' + seconds.toString()) : seconds.toString();\n\
+              $('.record_me_timer').html(minutes.toString() + ':' + seconds.toString());\n\
+            };\n\
+          })\n\
+
+        ").html_safe
+      end
+    end
+
+  end
+end

data/lib/record_me/version.rb

@@ -0,0 +1,3 @@
+module RecordMe
+  VERSION = "0.0.1"
+end

data/record_me.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'record_me/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "record_me"
+  spec.version       = RecordMe::VERSION
+  spec.authors       = ["Marco Gallardo"]
+  spec.email         = ["marco.gallardo@tangosource.com"]
+  spec.description   = %q{Record sounds}
+  spec.summary       = %q{Record sounds}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: record_me
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Marco Gallardo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2015-01-22 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Record sounds
+email: 
+- marco.gallardo@tangosource.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/initializer/record_me.rb
+- config/record_me.yml
+- lib/assets/javascripts/jRecorder.js
+- lib/assets/swfs/jRecorder.swf
+- lib/generators/initialize_generator.rb
+- lib/generators/install_generator.rb
+- lib/generators/templates/initializer.rb
+- lib/record_me.rb
+- lib/record_me/controller.rb
+- lib/record_me/helpers.rb
+- lib/record_me/version.rb
+- record_me.gemspec
+has_rdoc: true
+homepage: ""
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Record sounds
+test_files: []
+