virginia 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e78625ca5438a949387b62c725e94cfc029a518
-  data.tar.gz: b0d1bcc626e5e5a25309fb831d25184e74c54351
+  metadata.gz: 03c11488de9354f94fb4fddaafc9eea6edb2ea2a
+  data.tar.gz: ef033861cbc75a27ab882d791609966120516376
 SHA512:
-  metadata.gz: 9934bf594319287b9d00e85956e4c69766ca4d14da5246b36c7ef7578b9873b15f4d313a5fc90da998f294872dc69317787b5e9f9ef66778be0a30fa0fcceec9
-  data.tar.gz: 7d6fc88ad2c32c083b8b34a830a9b85750f94d6ae24b0446f308a6c883c9642018bff5adb9f2df055c1eae0692404ba575e7eaffbd8424c6811b07ece8a2070b
+  metadata.gz: 45abb469c15e4dff5e26d2ea886ebe0c147ed404292db70de9466cc4f7fa656d2d4227712e518cde954f8417c924862d7acfa5e689ebd8bdf7133d8eed81d54f
+  data.tar.gz: fa7668f83f4194cf48c618337a17201866bb060580efb4ab4113c0882859a6fffe83d7e0c703d324e85f705a0e5c1688c2c85e43085411b5d0508c89e3c3cec9

data/.gitignore

@@ -1,2 +1,4 @@
 .bundle
 pkg
+Gemfile.lock
+.*.sw*

data/CHANGELOG.md

@@ -1,4 +1,5 @@
-# develop
+# Version 0.3.0
+  * Switch to Rackup-style app management
 
 # Version 0.2.1
   * Removed Octarine from dependencies

data/README.md

@@ -1,8 +1,8 @@
 # Virginia
 
-Virginia is a Reel interface to Adhearsion, named after a dance originating in the 17th century, the Virginia Reel.
+Virginia is a Reel interface to Adhearsion, named after a dance originating in the 17th century, the Virginia Reel. Now your web apps can dance with your voice apps!
 
-It allows you to bundle a simple, Sinatra-style web interface with your Adhearsion application, enabling use of all the available APIs.
+Virginia allows you to bundle a simple web interface in your Adhearsion application. You can use any Rack-compatible framework with Reel.
 
 ## Configuration
 
@@ -10,33 +10,54 @@ The plugin defines three configuration keys.
 
 * host: Which IP to bind on (defaults to 0.0.0.0)
 * port: Which port to listen on (defaults to 8080)
-* handler: the Reel::Server class to use (see below)
-
-## Handler
-Virginia bundles a simple logging handler class that will answer to GET on "/" with OK and prints a log message in the Adhearsion console.
-
-An example handler, implementing click-to-call, would be built as follows:
-
-```ruby
-require 'reel'
-
-class RequestHandler
-  def initialize(host, port)
-    Reel::Server.supervise(host, port) do |connection|
-      connection.each_request do |request|
-        Adhearsion::OutboundCall.originate "SIP/100"  do
-          invoke ConnectingController
-        end
-        [200, {}, "200 OK"]
-      end
-    end
-  end
+* rackup: Location of the Rackup configuration file (defaults to config.ru)
+
+## Sinatra Example
+
+This example uses Sinatra, but this should work with any Rack-compatible framework.
+
+### Update Gemfile
+
+Add the framework gem to your Gemfile, in our case, Sinatra:
+
+```Ruby
+gem 'sinatra'
+```
+
+Don't forget to run `bundle install`.
+
+### Create the app
+
+Here is a simple "Hello World" app in Sinatra. Place this in `lib/sinatra_app.rb`:
+
+```Ruby
+require 'sinatra'
+
+get '/' do
+  'Hello world!'
+end
 ```
 
-### Author
+### Configure Rack
+
+Finally, tell Rack how to start your web app. Place this in `config.ru`:
+
+```Ruby
+require "#{Adhearsion.root}/lib/sinatra_app.rb"
+run Sinatra::Application
+```
+
+### Test the app
+
+Start Adhearsion.  You should be able to visit `http://localhost:8080/` in your browser and see "Hello world!"
+
+### Contributors
 
 Original author: [Luca Pradovera](https://github.com/polysics)
 
+Contributors:
+* [Ben Klang](https://github.com/bklang)
+
 ### Links
 
 * [Adhearsion](http://adhearsion.com)
@@ -55,4 +76,4 @@ Original author: [Luca Pradovera](https://github.com/polysics)
 
 ### Copyright
 
-Copyright (c) 2012 Adhearsion Foundation Inc. MIT license (see LICENSE for details).
+Copyright (c) 2012-2014 Adhearsion Foundation Inc. MIT license (see LICENSE for details).

data/Rakefile

@@ -1 +1,11 @@
+# encoding: utf-8
 require "bundler/gem_tasks"
+
+require "rspec/core"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = '--color'
+end
+
+task :default => :spec

data/lib/virginia.rb

@@ -1,7 +1,6 @@
 require "adhearsion"
 require "active_support/dependencies/autoload"
 require "virginia/version"
-require "virginia/logging_handler"
 require "virginia/plugin"
 
 module Virginia

data/lib/virginia/plugin.rb

@@ -1,15 +1,17 @@
+# encoding: utf-8
+
 module Virginia
   class Plugin < Adhearsion::Plugin
 
-    init :virginia do
-      logger.warn "Virginia has been loaded"
+    run :virginia do
+      logger.info "Virginia has been loaded"
       Service.start
     end
 
     config :virginia do
       host "0.0.0.0", :desc => "IP to bind the listener to"
       port "8080", :desc => "The port to bind the listener to"
-      handler Virginia::LoggingHandler, :desc => "The object that will be handling the requests.  Must be a Reel:App."
+      rackup 'config.ru', desc: 'Rack configuration file (relative to Adhearsion application root)'
     end
   end
 end

data/lib/virginia/service.rb

@@ -1,9 +1,25 @@
+# encoding: utf-8
 require 'reel'
+require 'reel/rack'
 
 module Virginia
   class Service
     def self.start
-      Adhearsion.config[:virginia].handler.new Adhearsion.config[:virginia].host, Adhearsion.config[:virginia].port
+      config = Adhearsion.config.virginia
+
+      # Rack-compatible options
+      app, options = ::Rack::Builder.parse_file File.join(Adhearsion.root, config[:rackup])
+      options = {
+        Host: config[:host],
+        Port: config[:port]
+      }.merge(options)
+
+      app = Rack::CommonLogger.new(app, Adhearsion.logger)
+      supervisor = ::Reel::Rack::Server.supervise_as(:reel_rack_server, app, options)
+
+      Adhearsion::Events.register_callback :shutdown do
+        supervisor.terminate
+      end
     end
   end
 end

data/lib/virginia/version.rb

@@ -1,3 +1,3 @@
 module Virginia
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/fixtures/config.ru

@@ -0,0 +1 @@
+run TestApp

data/spec/virginia/service_spec.rb

@@ -6,17 +6,24 @@ describe Virginia::Service do
     end
   end
 
-  let(:host) { "127.0.0.1" }
-  let(:port) { 8989 }
-  let(:handler) { DummyHandler }
+  let(:host)    { "127.0.0.1" }
+  let(:port)    { 8989 }
+  let(:options) { {Host: host, Port: port} }
+
   before :each do
-    Adhearsion.config.virginia.host = host
-    Adhearsion.config.virginia.port = port
-    Adhearsion.config.virginia.handler = handler
+    Adhearsion.stub(:root).and_return '.'
+    Adhearsion.config.virginia.host   = host
+    Adhearsion.config.virginia.port   = port
+    Adhearsion.config.virginia.rackup = 'spec/fixtures/config.ru'
   end
 
   it "should instantiate the handler" do
-    handler.should_receive(:new).with(host, port)
+    rack_logger = mock 'Rack::CommonLogger'
+    ::Rack::CommonLogger.should_receive(:new).once.with(TestApp, Adhearsion.logger).and_return rack_logger
+    ::Reel::Rack::Server.should_receive(:supervise_as).once.with(:reel_rack_server, rack_logger, options)
     Virginia::Service.start
   end
 end
+
+class TestApp
+end

data/virginia.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency %q<adhearsion>, ["~> 2.4"]
   s.add_runtime_dependency %q<activesupport>, [">= 3.0"]
-  s.add_runtime_dependency %q<reel>
+  s.add_runtime_dependency %q<reel>, ["~> 0.5.0"]
+  s.add_runtime_dependency %q<reel-rack>
 
   s.add_development_dependency %q<bundler>, ["~> 1.0"]
   s.add_development_dependency %q<rspec>, ["~> 2.5"]

metadata

@@ -1,111 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: virginia
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Luca Pradovera
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-18 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adhearsion
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
 - !ruby/object:Gem::Dependency
   name: activesupport
   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: reel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: reel-rack
+  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'
 - !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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 description: Gives an Adhearsion app the ability to be controlled and interact over
@@ -116,19 +130,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/virginia.rb
-- lib/virginia/logging_handler.rb
 - lib/virginia/plugin.rb
 - lib/virginia/service.rb
 - lib/virginia/version.rb
+- spec/fixtures/config.ru
 - spec/spec_helper.rb
 - spec/virginia/service_spec.rb
 - tmp/dsl.rb
@@ -143,20 +156,21 @@ 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: virginia
-rubygems_version: 2.1.9
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Reel interface to Adhearsion
 test_files:
+- spec/fixtures/config.ru
 - spec/spec_helper.rb
 - spec/virginia/service_spec.rb

data/Gemfile.lock

@@ -1,162 +0,0 @@
-PATH
-  remote: .
-  specs:
-    virginia (0.2.1)
-      activesupport (>= 3.0)
-      adhearsion (~> 2.4)
-      reel
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activesupport (4.0.0)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
-      thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    adhearsion (2.4.0)
-      activesupport (>= 3.0.0, < 5.0.0)
-      adhearsion-loquacious (~> 1.9)
-      bundler (~> 1.0)
-      celluloid (~> 0.14)
-      countdownlatch
-      deep_merge
-      ffi (~> 1.0)
-      girl_friday
-      has-guarded-handlers (~> 1.5)
-      logging (~> 1.8)
-      pry
-      punchblock (~> 2.0)
-      rake
-      ruby_speech (~> 2.0)
-      thor (~> 0.18.0)
-    adhearsion-loquacious (1.9.3)
-    atomic (1.1.14)
-    backports (3.3.5)
-    blather (0.8.8)
-      activesupport (>= 2.3.11)
-      eventmachine (>= 1.0.0)
-      girl_friday
-      niceogiri (~> 1.0)
-      nokogiri (~> 1.5, >= 1.5.6)
-    celluloid (0.15.2)
-      timers (~> 1.1.0)
-    celluloid-io (0.15.0)
-      celluloid (>= 0.15.0)
-      nio4r (>= 0.5.0)
-    coderay (1.0.9)
-    connection_pool (1.1.0)
-    countdownlatch (1.0.0)
-    deep_merge (1.0.0)
-    descendants_tracker (0.0.3)
-    diff-lcs (1.2.4)
-    eventmachine (1.0.3)
-    ffi (1.9.0)
-    formatador (0.2.4)
-    future-resource (1.1.0)
-    girl_friday (0.11.2)
-      connection_pool (~> 1.0)
-      rubinius-actor
-    guard (2.1.1)
-      formatador (>= 0.2.4)
-      listen (~> 2.1)
-      lumberjack (~> 1.0)
-      pry (>= 0.9.12)
-      thor (>= 0.18.1)
-    guard-rspec (4.0.3)
-      guard (>= 2.1.1)
-      rspec (~> 2.14)
-    has-guarded-handlers (1.5.0)
-    http (0.5.0)
-      http_parser.rb
-    http_parser.rb (0.6.0.beta.2)
-    i18n (0.6.5)
-    json (1.8.1)
-    listen (2.1.1)
-      celluloid (>= 0.15.2)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    little-plugger (1.1.3)
-    logging (1.8.1)
-      little-plugger (>= 1.1.3)
-      multi_json (>= 1.3.6)
-    lumberjack (1.0.4)
-    method_source (0.8.2)
-    mini_portile (0.5.1)
-    minitest (4.7.5)
-    multi_json (1.8.2)
-    niceogiri (1.1.2)
-      nokogiri (~> 1.5)
-    nio4r (0.5.0)
-    nokogiri (1.6.0)
-      mini_portile (~> 0.5.0)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    punchblock (2.0.2)
-      activesupport (>= 3.0.0, < 5.0.0)
-      blather (>= 0.7.0)
-      celluloid (~> 0.14)
-      future-resource (~> 1.0)
-      has-guarded-handlers (~> 1.5)
-      nokogiri (~> 1.5, >= 1.5.6)
-      ruby_ami (~> 2.0)
-      ruby_fs (~> 1.1)
-      ruby_jid (~> 1.0)
-      ruby_speech (~> 2.0)
-      state_machine (~> 1.0)
-      virtus (~> 0.5)
-    rake (10.1.0)
-    rb-fsevent (0.9.3)
-    rb-inotify (0.9.2)
-      ffi (>= 0.5.0)
-    reel (0.4.0)
-      celluloid (>= 0.15.1)
-      celluloid-io (>= 0.15.0)
-      http (>= 0.5.0)
-      http_parser.rb (>= 0.6.0.beta.2)
-      websocket_parser (>= 0.1.4)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.6)
-    rspec-expectations (2.14.3)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
-    rubinius-actor (0.0.2)
-      rubinius-core-api
-    rubinius-core-api (0.0.1)
-    ruby_ami (2.1.0)
-      celluloid-io (~> 0.13)
-    ruby_fs (1.1.0)
-      celluloid-io (~> 0.13)
-      json
-    ruby_jid (1.0.0)
-    ruby_speech (2.3.0)
-      activesupport (>= 3.0.7, < 5.0.0)
-      nokogiri (~> 1.6)
-    slop (3.4.6)
-    state_machine (1.2.0)
-    thor (0.18.1)
-    thread_safe (0.1.3)
-      atomic
-    timers (1.1.0)
-    tzinfo (0.3.38)
-    virtus (0.5.5)
-      backports (~> 3.3)
-      descendants_tracker (~> 0.0.1)
-    websocket_parser (0.1.4)
-      http
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0)
-  guard-rspec
-  rake
-  rspec (~> 2.5)
-  virginia!

data/lib/virginia/logging_handler.rb

@@ -1,13 +0,0 @@
-require 'reel'
-
-module Virginia
-	class LoggingHandler
-		def initialize(host, port)
-			Reel::Server.supervise(host, port) do |connection|
-				connection.each_request do |request|
-					request.respond :ok, "Hello, world!"
-				end
-			end
-		end
-	end
-end