rails-audio_glue 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46ff6190f4a333acbf050210d81979c661b03565
+  data.tar.gz: 89092439964b81c63dfeaab121484cf6819d6727
+SHA512:
+  metadata.gz: 8fa6393352e06977ff0e3d88f3e7f5cd617588fd0cf9f7bd4e16731a4c04e945bba46fad21a7dbc29aa0dc490622ff26bfd3d4862545cfaf521d6933e903ad40
+  data.tar.gz: c09b95ef746dada28417636201bd6bef7cb135a38ce6e236a2fbcba21596fc46c5a1f8531b1ce750c4d8d12afe4334d8b876610797726de808971e640dc5b30b

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 TMX Credit, author Potapov Sergey
+
+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.markdown

@@ -0,0 +1,122 @@
+# Rails AudioGlue
+[![Build Status](https://travis-ci.org/TMXCredit/rails-audio_glue.png)](https://travis-ci.org/TMXCredit/rails-audio_glue)
+
+A Rails plugin which integrates AudioGlue - a library used to assemble audio
+from snippets using templates.
+
+## Usage
+
+### Install
+
+After adding `gem 'rails-audio_glue'` to `Gemfile` and running `bundle`,
+run the generator to install the basic stuff:
+
+```sh
+rails g rails_audio_glue:install
+
+    create  config/initializers/audio_glue.rb
+    create  app/audio_templates/audio_glue_helper.rb
+```
+
+### Audio templates
+
+Now generate your first audio template:
+
+```sh
+rails g rails_audio_glue:template hello_world
+
+    create  app/audio_templates/hello_world.glue
+```
+
+To get more info about `.glue` templates read
+[AudioGlue's README](https://github.com/TMXCredit/audio_glue/).
+
+Ensure you have the following `hello_world.glue` in `app/audio_templates`:
+
+```ruby
+head {
+  format :mp3
+  rate 44100
+  channels 1
+}
+
+body {
+  - file("/path/to/audio/hello.wav")
+  if @say_bye
+    - url("http://some-server.com/say/bye.mp3")
+  end
+}
+```
+
+The output file parameters are described in the `head` section. And
+the content is described in the `body` section. It's all pure ruby code.
+
+### Sending audio from controller
+
+To build an audio file using a template and send it to a user, use the
+`send_glued_audio` controller method. It receives a template name and template
+variables as arguments and is built upon the `send_data` method:
+
+```ruby
+class HelloController < ApplicationController
+  # Convert hello.wav to mp3 and send it as hello_world.mp3:
+  def hi
+    send_glued_audio('hello_world', :say_bye => false)
+  end
+
+  # Concatenate hello.wav and bye.mp3, convert to mp3, and send
+  # as hello_world.mp3:
+  def hi_and_bye
+    send_glued_audio('hello_world', :say_bye => true)
+  end
+end
+```
+
+### Using helpers
+
+To extend the `body` template section with custom methods, you need
+to define them in `AudioGlueHelper`. Usually, they are supposed to based
+upon the `file` and `url` methods.
+
+```ruby
+module AudioGlueHelper
+  # The some-speaking-service is supposed to return audio file:
+  def say(text)
+    url("http://some-speaking-service.com/say/#{text}")
+  end
+end
+```
+
+Now you can use the `say` method in the `body` template section:
+
+```ruby
+body {
+  - file("/path/to/audio/hello.wav")
+  - say("What's up?")
+}
+```
+
+
+## Testing
+
+### Requirements
+
+You must have the `sqlite3` package installed.
+
+### Running the Tests
+
+```sh
+  bundle
+  cd spec/dummy
+  rake db:setup db:migrate
+  cd -
+  rake spec
+```
+
+## Credits
+
+* [Sergey Potapov](https://github.com/greyblake)
+
+## Copyright
+
+Copyright (c) 2013 TMX Credit.

data/lib/generators/rails_audio_glue/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Create initial files for AudioGlue engine.
+
+Example:
+    rails generate rails_audio_glue:install
+
+    This will:
+        Create initializer: config/initializers/audio_glue.rb
+        Create helper:      app/audio_templates/audio_glue_helper.rb

data/lib/generators/rails_audio_glue/install/install_generator.rb

@@ -0,0 +1,21 @@
+module RailsAudioGlue
+  # :nodoc:
+  module Generators
+    # :nodoc:
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      # :nodoc:
+      def create_initializer_file
+        template 'initializer.rb.erb', 'config/initializers/audio_glue.rb'
+      end
+
+      # :nodoc:
+      def create_audio_glue_helper
+        template 'audio_glue_helper.rb.erb',
+                 "#{RailsAudioGlue::TEMPLATES_PATH}/audio_glue_helper.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/rails_audio_glue/install/templates/audio_glue_helper.rb.erb

@@ -0,0 +1,6 @@
+# A helper providing methods that can be executed in the +body+ section
+# of +.glue+ templates.
+# Methods are supposed to be based upon the +file+ and +url+ methods.
+module AudioGlueHelper
+
+end

data/lib/generators/rails_audio_glue/install/templates/initializer.rb.erb

@@ -0,0 +1,21 @@
+RailsAudioGlue.setup do |config|
+  begin
+    require 'audio_glue/sox_adapter'
+  rescue LoadError
+    abort "You need to add `gem \"audio_glue-sox_adapter\"'" \
+          "to your Gemfile to use AudioGlue::SoxAdapter"
+  end
+
+
+  # Create AudioGlue adapter and builder:
+  adapter        = ::AudioGlue::SoxAdapter.new
+  config.builder = ::AudioGlue::Builder.new(adapter)
+
+  # Create template loader
+  templates_path = Rails.application.root.
+                         join(RailsAudioGlue::TEMPLATES_PATH).to_s
+  config.loader  = ::AudioGlue::TemplateLoader.new(
+                      templates_path,
+                      :helper => AudioGlueHelper
+                    )
+end

data/lib/generators/rails_audio_glue/template/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create audio glue template
+
+Example:
+    rails generate rails_audio_glue:template hello_world
+
+    This will:
+        Create template: app/audio_templates/hello_world.glue

data/lib/generators/rails_audio_glue/template/template_generator.rb

@@ -0,0 +1,18 @@
+module RailsAudioGlue
+  # :nodoc:
+  module Generators
+    # :nodoc:
+    class TemplateGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :template_name, :type => :string
+
+      # :nodoc:
+      def create_template
+        template 'template.glue.erb',
+                 "#{RailsAudioGlue::TEMPLATES_PATH}/#{template_name}.glue"
+      end
+
+    end
+  end
+end

data/lib/generators/rails_audio_glue/template/templates/template.glue.erb

@@ -0,0 +1,10 @@
+head {
+  format :mp3
+  rate 44100
+  channels 1
+}
+
+body {
+  - file('/path/to/file.wav')
+  - url('http://server.com/audio.mp3')
+}

data/lib/rails-audio_glue.rb

@@ -0,0 +1 @@
+require File.expand_path('../rails_audio_glue', __FILE__)

data/lib/rails_audio_glue.rb

@@ -0,0 +1,21 @@
+require 'audio_glue'
+
+require 'rails_audio_glue/controller_methods'
+require 'rails_audio_glue/engine'
+
+# Rails plugin which integrates the AudioGlue library.
+module RailsAudioGlue
+  # The path to the directory where audio templates are supposed to be located.
+  TEMPLATES_PATH = 'app/audio_templates'
+
+  # Instance of AuduoGlue::Builder:
+  mattr_accessor :builder
+
+  # Instance of AuduoGlue::TemplateLoader:
+  mattr_accessor :loader
+
+  # Should be called from initializer to configure RailsAudioGlue.
+  def self.setup
+    yield self
+  end
+end

data/lib/rails_audio_glue/controller_methods.rb

@@ -0,0 +1,41 @@
+module RailsAudioGlue
+  # Provides the +send_glued_audio+ method for ApplicationController.
+  module ControllerMethods
+    # Mapper for audio formats and mime types. If the format is unknown,
+    # it will generate it dynamically using a proc.
+    GLUE_MIME_TYPES = {
+      :mp3   => 'audio/mpeg',
+      :m4a   => 'audio/mp4',
+      :ogg   => 'audio/ogg',
+      :oga   => 'audio/ogg',
+      :webma => 'audio/webm',
+      :wav   => 'audio/wav',
+    }
+    GLUE_MIME_TYPES.default_proc = lambda { |hash, key| "audio/#{key}"}
+
+    # Assemble the audio using the passed template and variables.
+    # And send it as data.
+    #
+    # @param template_name [String] name of template in app/audio_templates
+    # @param variables [Hash] instance variables to initiate template.
+    #
+    # @return [void]
+    def send_glued_audio(template_name, variables = {})
+      loader  = RailsAudioGlue.loader
+      builder = RailsAudioGlue.builder
+
+      # Reset the cache in development so we don't need to restart the server
+      # to see changes in the glue template.
+      loader.reset_cache! if Rails.env.development?
+
+      template = loader.get(template_name).new(variables)
+      data     = builder.build(template)
+
+      format    = template.format
+      filename  = "#{File.basename(template_name)}.#{format}"
+      mime_type = GLUE_MIME_TYPES[format]
+
+      send_data(data, :filename => filename, :type => mime_type)
+    end
+  end
+end

data/lib/rails_audio_glue/engine.rb

@@ -0,0 +1,12 @@
+module RailsAudioGlue
+  # :nodoc:
+  class Engine < ::Rails::Engine
+    initializer 'audio_glue' do
+
+      ::ActionController::Base.class_eval do
+        include RailsAudioGlue::ControllerMethods
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: rails-audio_glue
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- TMX Credit
+- Potapov Sergey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: audio_glue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: audio_glue-sox_adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: metric_fu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails-AudioGlue is an audio template engine (aka ERB/HAML for sounds)
+email:
+- rubygems@tmxcredit.com
+- blake131313@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- LICENSE.txt
+- README.markdown
+- lib/generators/rails_audio_glue/install/USAGE
+- lib/generators/rails_audio_glue/install/install_generator.rb
+- lib/generators/rails_audio_glue/install/templates/audio_glue_helper.rb.erb
+- lib/generators/rails_audio_glue/install/templates/initializer.rb.erb
+- lib/generators/rails_audio_glue/template/USAGE
+- lib/generators/rails_audio_glue/template/template_generator.rb
+- lib/generators/rails_audio_glue/template/templates/template.glue.erb
+- lib/rails-audio_glue.rb
+- lib/rails_audio_glue.rb
+- lib/rails_audio_glue/controller_methods.rb
+- lib/rails_audio_glue/engine.rb
+homepage: http://github.com/TMXCredit/rails-audio_glue
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: AudioGlue plugin for Rails
+test_files: []
+has_rdoc: