bougyman-freeswitcher 0.1.3 → 0.1.4

data/freeswitcher.gemspec

@@ -0,0 +1,155 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{freeswitcher}
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jayson Vaughn", "Michael Fellinger", "Kevin Berry", "TJ Vanderpoel"]
+  s.date = %q{2009-05-11}
+  s.description = %q{========================================================= FreeSWITCHeR Copyright (c) 2009 The Rubyists (Jayson Vaughn, Tj Vanderpoel, Michael Fellinger, Kevin Berry)  Distributed under the terms of the MIT License. ==========================================================  ABOUT ----- A ruby library for interacting with the "FreeSWITCH" (http://www.freeswitch.org) opensource telephony platform  REQUIREMENTS ------------ - ruby (>= 1.8) - eventmachine (If you wish to use Outbound and Inbound listener)  USAGE -----  An Outbound Event Listener Example that reads and returns DTMF input: --------------------------------------------------------------------  Simply just create a subclass of FSR::Listner::Outbound and all new calls/sessions will invoke the "session_initiated" callback method.  * NOTE:  FSR uses blocks within the 'session_inititated' method to ensure  that the next "freeswich command" is not executed until the previous  "Freeswitch command" has finished.  This is kicked off by "answer do"  require 'fsr' require 'fsr/listener/outbound'  class OutboundDemo < FSR::Listener::Outbound  def session_initiated exten = @session.headers[:caller_caller_id_number] FSR::Log.info "*** Answering incoming call from #{exten}"  answer do FSR::Log.info "***Reading DTMF from #{exten}" read("/home/freeswitch/freeswitch/sounds/music/8000/sweet.wav", 4, 10, "input", 7000) do FSR::Log.info "*** Updating session for #{exten}" update_session do FSR::Log.info "***Success, grabbed #{@session.headers[:variable_input].strip} from #{exten}" hangup #Hangup the call end end end  end  end  FSR.start_oes! OutboundDemo, :port => 8084, :host => "127.0.0.1"   An Inbound Event Socket Listener example using FreeSWITCHeR's hook system: --------------------------------------------------------------------------  require 'pp' require 'fsr' require "fsr/listener/inbound"  # EXAMPLE 1  # This adds a hook on CHANNEL_CREATE events. You can also create a method to handle the event you're after. See the next example FSL::Inbound.add_event_hook(:CHANNEL_CREATE) {|event| FSR::Log.info "*** [#{event.content[:unique_id]}] Channel created - greetings from the hook!" }  # EXAMPLE 2 # Define a method to handle CHANNEL_HANGUP events. def custom_channel_hangup_handler(event) FSR::Log.info "*** [#{event.content[:unique_id]}] Channel hangup. The event:" pp event end  # This adds a hook for EXAMPLE 2 FSL::Inbound.add_event_hook(:CHANNEL_HANGUP) {|event| custom_channel_hangup_handler(event) }   # Start FSR Inbound Listener FSR.start_ies!(FSL::Inbound, :host => "localhost", :port => 8021)   An Inbound Event Socket Listener example using the on_event callback method instead of hooks: ---------------------------------------------------------------------------------------------  require 'pp' require 'fsr' require "fsr/listener/inbound"   class IesDemo < FSR::Listener::Inbound  def on_event(event) pp event.headers pp event.content[:event_name] end  end  FSR.start_ies!(IesDemo, :host => "localhost", :port => 8021)   An example of using FSR::CommandSocket to originate a new call in irb: ----------------------------------------------------------------------  irb(main):001:0> require 'fsr' => true  irb(main):002:0> FSR.load_all_commands => [:sofia, :originate]  irb(main):003:0> sock = FSR::CommandSocket.new => #<FSR::CommandSocket:0xb7a89104 @server="127.0.0.1", @socket=#<TCPSocket:0xb7a8908c>, @port="8021", @auth="ClueCon">  irb(main):007:0> sock.originate(:target => 'sofia/gateway/carlos/8179395222', :endpoint => FSR::App::Bridge.new("user/bougyman")).run => {"Job-UUID"=>"732075a4-7dd5-4258-b124-6284a82a5ae7", "body"=>"", "Content-Type"=>"command/reply", "Reply-Text"=>"+OK Job-UUID: 732075a4-7dd5-4258-b124-6284a82a5ae7"}    SUPPORT ------- Home page at http://code.rubyists.com/projects/fs #rubyists on FreeNode}
+  s.email = %q{FreeSWITCHeR@rubyists.com}
+  s.files = [".gitignore", "AUTHORS", "CHANGELOG", "License.txt", "MANIFEST", "NEWS", "README", "Rakefile", "examples/bin/cmd_demo.rb", "examples/bin/dtmf_test.rb", "examples/bin/ies_demo.rb", "examples/bin/ies_demo_with_hook.rb", "examples/bin/oes_demo.rb", "examples/dtmf_test.rb", "examples/ies_demo.rb", "examples/ies_demo_with_hook.rb", "examples/inbound_event_socket.rb", "examples/inbound_socket_events.rb", "examples/outbound_event_socket.rb", "freeswitcher.gemspec", "lib/fsr.rb", "lib/fsr/app.rb", "lib/fsr/app/answer.rb", "lib/fsr/app/bridge.rb", "lib/fsr/app/conference.rb", "lib/fsr/app/fifo.rb", "lib/fsr/app/fs_break.rb", "lib/fsr/app/fs_sleep.rb", "lib/fsr/app/hangup.rb", "lib/fsr/app/limit.rb", "lib/fsr/app/log.rb", "lib/fsr/app/play_and_get_digits.rb", "lib/fsr/app/playback.rb", "lib/fsr/app/read.rb", "lib/fsr/app/set.rb", "lib/fsr/app/speak.rb", "lib/fsr/app/transfer.rb", "lib/fsr/app/uuid_dump.rb", "lib/fsr/app/uuid_getvar.rb", "lib/fsr/app/uuid_setvar.rb", "lib/fsr/cmd.rb", "lib/fsr/cmd/calls.rb", "lib/fsr/cmd/fsctl.rb", "lib/fsr/cmd/originate.rb", "lib/fsr/cmd/sofia.rb", "lib/fsr/cmd/sofia/profile.rb", "lib/fsr/cmd/sofia/status.rb", "lib/fsr/cmd/sofia_contact.rb", "lib/fsr/cmd/status.rb", "lib/fsr/command_socket.rb", "lib/fsr/database.rb", "lib/fsr/database/call_limit.rb", "lib/fsr/database/core.rb", "lib/fsr/database/sofia_reg_external.rb", "lib/fsr/database/sofia_reg_internal.rb", "lib/fsr/database/voicemail_default.rb", "lib/fsr/event_socket.rb", "lib/fsr/fake_socket.rb", "lib/fsr/listener.rb", "lib/fsr/listener/header_and_content_response.rb", "lib/fsr/listener/inbound.rb", "lib/fsr/listener/inbound/event.rb", "lib/fsr/listener/outbound.rb", "lib/fsr/listener/outbound.rb.orig", "lib/fsr/model/call.rb", "lib/fsr/version.rb", "tasks/authors.rake", "tasks/bacon.rake", "tasks/changelog.rake", "tasks/copyright.rake", "tasks/gem.rake", "tasks/gem_installer.rake", "tasks/install_dependencies.rake", "tasks/manifest.rake", "tasks/rcov.rake", "tasks/release.rake", "tasks/reversion.rake", "tasks/setup.rake", "tasks/spec.rake", "tasks/yard.rake", "spec/helper.rb", "spec/fsr/app.rb", "spec/fsr/app/bridge.rb", "spec/fsr/app/conference.rb", "spec/fsr/app/fifo.rb", "spec/fsr/app/hangup.rb", "spec/fsr/app/limit.rb", "spec/fsr/app/log.rb", "spec/fsr/app/play_and_get_digits.rb", "spec/fsr/app/playback.rb", "spec/fsr/app/set.rb", "spec/fsr/app/transfer.rb", "spec/fsr/cmd.rb", "spec/fsr/cmd/calls.rb", "spec/fsr/cmd/originate.rb", "spec/fsr/cmd/sofia.rb", "spec/fsr/cmd/sofia/profile.rb", "spec/fsr/listener.rb", "spec/fsr/listener/inbound.rb", "spec/fsr/listener/outbound.rb", "spec/fsr/loading.rb"]
+  s.homepage = %q{http://code.rubyists.com/projects/fs}
+  s.post_install_message = %q{=========================================================
+FreeSWITCHeR
+Copyright (c) 2009 The Rubyists (Jayson Vaughn, Tj Vanderpoel, Michael Fellinger, Kevin Berry) 
+Distributed under the terms of the MIT License.
+==========================================================
+
+ABOUT
+-----
+A ruby library for interacting with the "FreeSWITCH" (http://www.freeswitch.org) opensource telephony platform
+
+REQUIREMENTS
+------------
+- ruby (>= 1.8)
+- eventmachine (If you wish to use Outbound and Inbound listener)
+
+USAGE
+-----
+
+An Outbound Event Listener Example that reads and returns DTMF input:
+--------------------------------------------------------------------
+
+Simply just create a subclass of FSR::Listner::Outbound and all
+new calls/sessions will invoke the "session_initiated" callback method.
+ 
+  * NOTE:  FSR uses blocks within the 'session_inititated' method to ensure 
+           that the next "freeswich command" is not executed until the previous 
+           "Freeswitch command" has finished.  This is kicked off by "answer do"
+
+    require 'fsr'
+    require 'fsr/listener/outbound'
+
+    class OutboundDemo < FSR::Listener::Outbound
+
+      def session_initiated
+        exten = @session.headers[:caller_caller_id_number]
+        FSR::Log.info "*** Answering incoming call from #{exten}"
+
+        answer do
+          FSR::Log.info "***Reading DTMF from #{exten}"
+          read("/home/freeswitch/freeswitch/sounds/music/8000/sweet.wav", 4, 10, "input", 7000) do
+            FSR::Log.info "*** Updating session for #{exten}"
+            update_session do
+              FSR::Log.info "***Success, grabbed #{@session.headers[:variable_input].strip} from #{exten}"
+              hangup #Hangup the call
+            end
+          end
+        end
+
+      end
+
+    end
+
+    FSR.start_oes! OutboundDemo, :port => 8084, :host => "127.0.0.1"
+
+
+An Inbound Event Socket Listener example using FreeSWITCHeR's hook system:
+--------------------------------------------------------------------------
+
+    require 'pp'
+    require 'fsr'
+    require "fsr/listener/inbound"
+
+    # EXAMPLE 1 
+    # This adds a hook on CHANNEL_CREATE events. You can also create a method to handle the event you're after. See the next example
+    FSL::Inbound.add_event_hook(:CHANNEL_CREATE) {|event| FSR::Log.info "*** [#{event.content[:unique_id]}] Channel created - greetings from the hook!" }
+
+    # EXAMPLE 2
+    # Define a method to handle CHANNEL_HANGUP events.
+    def custom_channel_hangup_handler(event)
+      FSR::Log.info "*** [#{event.content[:unique_id]}] Channel hangup. The event:"
+      pp event
+    end
+
+    # This adds a hook for EXAMPLE 2
+    FSL::Inbound.add_event_hook(:CHANNEL_HANGUP) {|event| custom_channel_hangup_handler(event) }
+
+
+    # Start FSR Inbound Listener
+    FSR.start_ies!(FSL::Inbound, :host => "localhost", :port => 8021)
+
+
+An Inbound Event Socket Listener example using the on_event callback method instead of hooks:
+---------------------------------------------------------------------------------------------
+
+    require 'pp'
+    require 'fsr'
+    require "fsr/listener/inbound"
+
+
+    class IesDemo < FSR::Listener::Inbound
+
+      def on_event(event)
+        pp event.headers
+        pp event.content[:event_name]
+      end
+
+    end
+
+    FSR.start_ies!(IesDemo, :host => "localhost", :port => 8021)
+
+
+An example of using FSR::CommandSocket to originate a new call in irb:
+----------------------------------------------------------------------
+
+    irb(main):001:0> require 'fsr'
+    => true
+
+    irb(main):002:0> FSR.load_all_commands
+    => [:sofia, :originate]
+
+    irb(main):003:0> sock = FSR::CommandSocket.new
+    => #<FSR::CommandSocket:0xb7a89104 @server="127.0.0.1", @socket=#<TCPSocket:0xb7a8908c>, @port="8021", @auth="ClueCon">
+
+    irb(main):007:0> sock.originate(:target => 'sofia/gateway/carlos/8179395222', :endpoint => FSR::App::Bridge.new("user/bougyman")).run
+    => {"Job-UUID"=>"732075a4-7dd5-4258-b124-6284a82a5ae7", "body"=>"", "Content-Type"=>"command/reply", "Reply-Text"=>"+OK Job-UUID: 732075a4-7dd5-4258-b124-6284a82a5ae7"}
+
+
+
+SUPPORT
+-------
+Home page at http://code.rubyists.com/projects/fs
+#rubyists on FreeNode
+}
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{freeswitcher}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A library for interacting with the "FreeSWITCH":http://freeswitch.org telephony platform}
+  s.test_files = ["spec/fsr/app.rb", "spec/fsr/app/bridge.rb", "spec/fsr/app/conference.rb", "spec/fsr/app/fifo.rb", "spec/fsr/app/hangup.rb", "spec/fsr/app/limit.rb", "spec/fsr/app/log.rb", "spec/fsr/app/play_and_get_digits.rb", "spec/fsr/app/playback.rb", "spec/fsr/app/set.rb", "spec/fsr/app/transfer.rb", "spec/fsr/cmd.rb", "spec/fsr/cmd/calls.rb", "spec/fsr/cmd/originate.rb", "spec/fsr/cmd/sofia.rb", "spec/fsr/cmd/sofia/profile.rb", "spec/fsr/listener.rb", "spec/fsr/listener/inbound.rb", "spec/fsr/listener/outbound.rb", "spec/fsr/loading.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+  end
+end

data/lib/fsr.rb

@@ -3,11 +3,15 @@ require 'socket'
 require 'pathname'
 require 'pp'
 
+# Author::    TJ Vanderpoel (mailto:bougy.man@gmail.com)
+# Copyright:: Copyright (c) 2009 The Rubyists (Jayson Vaughn, TJ Vanderpoel, Michael Fellinger, Kevin Berry)
+# License::   Distributes under the terms of the MIT License http://www.opensource.org/licenses/mit-license.php
+
+## This module declares the namespace under which the freeswitcher framework
+## Any constants will be defined here, as well as methods for loading commands and applications
 module FSR
   # Global configuration options
-  #
-  VERSION = '0.1.3'
-  FS_INSTALL_PATHS = ["/usr/local/freeswitch", "/opt/freeswitch", "/usr/freeswitch"]
+  FS_INSTALL_PATHS = ["/usr/local/freeswitch", "/opt/freeswitch", "/usr/freeswitch", "/home/freeswitch/freeswitch"]
   DEFAULT_CALLER_ID_NUMBER = '8675309'
   DEFAULT_CALLER_ID_NAME   = "FSR"
 
@@ -48,8 +52,13 @@ module FSR
   end
   
   # Method to start EM for Inbound Event Socket
+  # @see FSR::Listener::Inbound
+  # @param [FSR::Listener::Inbound] klass An Inbound Listener class, to be started by EM.run
+  # @param [::Hash] args A hash of options, may contain
+  #                       <tt>:host [String]</tt> The host/ip to bind to (Default: "localhost") 
+  #                       <tt>:port [Integer]</tt> the port to listen on (Default: 8021)
   def self.start_ies!(klass, args = {})
-    port = args[:port] || "8021"
+    port = args[:port] || 8021
     host = args[:host] || "localhost"
     EM.run do
       EventMachine::connect(host, port, klass)
@@ -83,4 +92,5 @@ module FSR
     FS_CONFIG_PATH = FS_DB_PATH = nil
   end
 end
+require "fsr/version"
 

data/lib/fsr/listener/outbound.rb

@@ -13,7 +13,13 @@ module FSR
       include FSR::App
 
       # Redefine the FSR::App methods to wrap sendmsg around them
-      SENDMSG_METHOD_DEFINITION = "def %s(*args, &block); sendmsg super; end"
+      SENDMSG_METHOD_DEFINITION = [
+                                   "def %s(*args, &block)",
+                                   "  sendmsg super",
+                                   "  @queue << block if block_given?",
+                                   "end"
+                                  ].join("\n")
+
       APPLICATIONS.each { |app, obj| module_eval(SENDMSG_METHOD_DEFINITION % app.to_s) }
 
       # session_initiated is called when a @session is first created.
@@ -31,7 +37,6 @@ module FSR
       # @param reply This HeaderAndContent instance will have the channel variables
       #              in #content, if the session has been updated
       def receive_reply(reply)
-        FSR::Log.warn "#{self.class.name}#receive_reply not overwritten"
         FSR::Log.debug reply.inspect
       end
 
@@ -49,8 +54,9 @@ module FSR
 
       # Update_session
 
-      def update_session
+      def update_session(&block)
         send_data("api uuid_dump #{@session.headers[:unique_id]}\n\n")
+        @queue << block if block_given?
       end
 
       def next_step
@@ -61,19 +67,20 @@ module FSR
       protected
       def post_init
         @session = nil # holds the session object
+        @queue = [] # Keep track of queue for state machine
         send_data("connect\n\n")
         FSR::Log.debug "Accepting connections."
       end
 
       # receive_request is called each time data is received by the event machine
-      # it will manipulate the received data into either a new session or a reply,
-      # to be picked up by #session_initiated or #receive_reply.
-      # If your listener is listening for events, this will also renew your @session
-      # each time you receive a CHANNEL_DATA event.
+      #  it will manipulate the received data into either a new session or a reply,
+      #  to be picked up by #session_initiated or #receive_reply.
+      #  If your listener is listening for events, this will also renew your @session
+      #  each time you receive a CHANNEL_DATA event.
       # @param header The header of the request, as passed by HeaderAndContentProtocol
       # @param content The content of the request, as passed by HeaderAndContentProtocol
       #
-      # @returns HeaderAndContentResponse
+      # @return [HeaderAndContentResponse] An EventMachine HeaderAndContentResponse
       def receive_request(header, content)
         hash_header = headers_2_hash(header)
         hash_content = headers_2_hash(content)
@@ -82,16 +89,20 @@ module FSR
         if @session.nil?
           @session = session_header_and_content
           @step = 0
+          @state = [:uninitiated]
           session_initiated 
+          @state << :initiated
         elsif session_header_and_content.content[:event_name] # If content includes an event_name, it must be a response from an api command
           if session_header_and_content.content[:event_name].to_s.match(/CHANNEL_DATA/i) # Anytime we see CHANNEL_DATA event, we want to update our @session
             session_header_and_content = HeaderAndContentResponse.new({:headers => hash_header.merge(hash_content.strip_value_newlines), :content => {}})
             @session = session_header_and_content
-            @step += 1
+            @step += 1 if @state.include?(:initiated)
+            @queue.pop.call unless @queue.empty?
             receive_reply(hash_header)
           end
         else
-          @step += 1
+          @step += 1 if @state.include?(:initiated)
+          @queue.pop.call unless @queue.empty?
           receive_reply(session_header_and_content)
         end
       end

data/lib/fsr/version.rb

@@ -0,0 +1,3 @@
+module FSR
+  VERSION = "0.1.4"
+end

data/spec/helper.rb

@@ -1,12 +1,17 @@
 begin
   require 'bacon'
 rescue LoadError
-  puts <<-EOS
-To run these tests you must install bacon.
-Quick and easy install for gem:
-    gem install bacon
-EOS
-  exit(0)
+  begin
+    require "rubygems"
+    require "bacon"
+  rescue LoadError
+    puts <<-EOS
+  To run these tests you must install bacon.
+  Quick and easy install for gem:
+      gem install bacon
+  EOS
+    exit(0)
+  end
 end
 
 Bacon.summary_on_exit

data/tasks/authors.rake

@@ -0,0 +1,30 @@
+# Once git has a fix for the glibc in handling .mailmap and another fix for
+# allowing empty mail address to be mapped in .mailmap we won't have to handle
+# them manually.
+
+desc 'Update AUTHORS'
+task :authors do
+  authors = Hash.new(0)
+
+  `git shortlog -nse`.scan(/(\d+)\s(.+)\s<(.*)>$/) do |count, name, email|
+    case name
+    when "bougyman"
+      name, email = "TJ Vanderpoel", "bougy.man@gmail.com"
+    when /riscfuture/i
+      name, email = "Tim Morgan", "riscfuture@gmail.com"
+    when "Michael Fellinger m.fellinger@gmail.com"
+      name, email = "Michael Fellinger", "m.fellinger@gmail.com"
+    end
+
+    authors[[name, email]] += count.to_i
+  end
+
+  File.open('AUTHORS', 'w+') do |io|
+    io.puts "Following persons have contributed to #{GEMSPEC.name}."
+    io.puts '(Sorted by number of submitted patches, then alphabetically)'
+    io.puts ''
+    authors.sort_by{|(n,e),c| [-c, n.downcase] }.each do |(name, email), count|
+      io.puts("%6d %s <%s>" % [count, name, email])
+    end
+  end
+end

data/tasks/bacon.rake

@@ -0,0 +1,66 @@
+desc 'Run all bacon specs with pretty output'
+task :bacon => :install_dependencies do
+  require 'open3'
+  require 'scanf'
+  require 'matrix'
+
+  specs = PROJECT_SPECS
+
+  some_failed = false
+  specs_size = specs.size
+  len = specs.map{|s| s.size }.sort.last
+  total_tests = total_assertions = total_failures = total_errors = 0
+  totals = Vector[0, 0, 0, 0]
+
+  red, yellow, green = "\e[31m%s\e[0m", "\e[33m%s\e[0m", "\e[32m%s\e[0m"
+  left_format = "%4d/%d: %-#{len + 11}s"
+  spec_format = "%d specifications (%d requirements), %d failures, %d errors"
+
+  specs.each_with_index do |spec, idx|
+    print(left_format % [idx + 1, specs_size, spec])
+
+    Open3.popen3(RUBY, spec) do |sin, sout, serr|
+      out = sout.read.strip
+      err = serr.read.strip
+
+      # this is conventional, see spec/innate/state/fiber.rb for usage
+      if out =~ /^Bacon::Error: (needed .*)/
+        puts(yellow % ("%6s %s" % ['', $1]))
+      else
+        total = nil
+
+        out.each_line do |line|
+          scanned = line.scanf(spec_format)
+
+          next unless scanned.size == 4
+
+          total = Vector[*scanned]
+          break
+        end
+
+        if total
+          totals += total
+          tests, assertions, failures, errors = total_array = total.to_a
+
+          if tests > 0 && failures + errors == 0
+            puts((green % "%6d passed") % tests)
+          else
+            some_failed = true
+            puts(red % "       failed")
+            puts out unless out.empty?
+            puts err unless err.empty?
+          end
+        else
+          some_failed = true
+          puts(red % "       failed")
+          puts out unless out.empty?
+          puts err unless err.empty?
+        end
+      end
+    end
+  end
+
+  total_color = some_failed ? red : green
+  puts(total_color % (spec_format % totals.to_a))
+  exit 1 if some_failed
+end

data/tasks/changelog.rake

@@ -0,0 +1,19 @@
+require 'time'
+desc 'update changelog'
+task :changelog do
+  File.open('CHANGELOG', 'w+') do |changelog|
+    `git log -z --abbrev-commit`.split("\0").each do |commit|
+      next if commit =~ /^Merge: \d*/
+      ref, author, time, _, title, _, message = commit.split("\n", 7)
+      ref    = ref[/commit ([0-9a-f]+)/, 1]
+      author = author[/Author: (.*)/, 1].strip
+      time   = Time.parse(time[/Date: (.*)/, 1]).utc
+      title.strip!
+
+      changelog.puts "[#{ref} | #{time}] #{author}"
+      changelog.puts '', "  * #{title}"
+      changelog.puts '', message.rstrip if message
+      changelog.puts
+    end
+  end
+end

data/tasks/copyright.rake

@@ -0,0 +1,21 @@
+desc "add copyright to all .rb files in the distribution"
+task :copyright do
+  ignore = File.readlines('License.txt').
+    select{|line| line.strip!; File.exist?(line)}.
+    map{|file| File.expand_path(file)}
+
+  puts "adding copyright to files that don't have it currently"
+  puts PROJECT_COPYRIGHT
+  puts
+
+  Dir['{lib,test}/**/*{.rb}'].each do |file|
+    file = File.expand_path(file)
+    next if ignore.include? file
+    lines = File.readlines(file).map{|l| l.chomp}
+    unless lines.first(PROJECT_COPYRIGHT.size) == PROJECT_COPYRIGHT
+      puts "#{file} seems to need attention, first 4 lines:"
+      puts lines[0..3]
+      puts
+    end
+  end
+end