cdr-fetcher 1.0.1

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Carl Hicks
+
+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.rdoc

@@ -0,0 +1,51 @@
+= cdr-fetcher
+
+A rubygem for fetching CDR's from a remote system via SSH/SFTP.  
+Supports fetching all files, or a delta from a given offset.
+
+== FEATURES/PROBLEMS:
+
+* Supports asterisk cdr-csv output format
+* Supports multiple directories
+* Returns a format-neutral data structure
+
+== SYNOPSIS:
+
+  require 'cdr-fetcher'
+  require 'pp'
+  
+  cdrs = CDR::Fetcher.new(
+  	'hostname', 
+	'username',
+	:password => 'password',
+	:base_dir => '/var/log/asterisk/cdr-csv',
+	:last_dir => 'old-cdrs',
+	:last_file => 'old-cdr.csv')
+	
+  cdrs.each do |cdr|
+    pp cdr
+  end
+
+== REQUIREMENTS:
+
+* net-ssh gem
+* net-sftp gem
+
+== INSTALL:
+
+* sudo gem install cdr-fetcher
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Carl Hicks. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cdr-fetcher"
+    gem.summary = %Q{A gem for fetching CDR's from a remote system.}
+    gem.description = %Q{A gem for fetching CDR data from a remote system via SSH/SFTP.  Supports fetching all files, or a delta from a given offset.}
+    gem.email = "carl.hicks@gmail.com"
+    gem.homepage = "http://github.com/chicks/cdr-fetcher"
+    gem.authors = ["Carl Hicks"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency 'net-sftp'
+    gem.add_dependency 'net-ssh'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cdr-fetcher #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/cdr-fetcher.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cdr-fetcher}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Carl Hicks"]
+  s.date = %q{2010-07-15}
+  s.description = %q{A gem for fetching CDR data from a remote system via SSH/SFTP.  Supports fetching all files, or a delta from a given offset.}
+  s.email = %q{carl.hicks@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cdr-fetcher.gemspec",
+     "lib/cdr-fetcher.rb",
+     "test/helper.rb",
+     "test/test_cdr-fetcher.rb"
+  ]
+  s.homepage = %q{http://github.com/chicks/cdr-fetcher}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A gem for fetching CDR's from a remote system.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_cdr-fetcher.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<net-sftp>, [">= 0"])
+      s.add_runtime_dependency(%q<net-ssh>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<net-sftp>, [">= 0"])
+      s.add_dependency(%q<net-ssh>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<net-sftp>, [">= 0"])
+    s.add_dependency(%q<net-ssh>, [">= 0"])
+  end
+end
+

data/lib/cdr-fetcher.rb

@@ -0,0 +1,210 @@
+module CDR
+
+require 'csv'
+require 'rubygems'
+require 'net/ssh'
+require 'net/sftp'
+
+# Fetch CDR's from a remote server.
+#
+# :base_dir defaults to "/var/log/asterisk/cdr-csv".
+# :last_dir defaults to the first sub-directory
+# in :base_dir.
+# :last_file defaults to the first file in :last_dir.
+# 
+# Usage:
+#
+#  require 'cdr-fetcher'
+#  require 'pp'
+#  
+#  cdrs = CDR::Fetcher.new(
+#    'hostname', 
+#	   'username',
+#	   :password => 'password',
+#	   :base_dir => '/var/log/asterisk/cdr-csv',
+#	   :last_dir => 'old-cdrs',
+#	   :last_file=> 'old-cdr.csv')  
+#
+#  cdrs.each do |cdr|
+#    pp cdr
+#  end
+#  
+class Fetcher
+  attr :hostname, false
+  attr :username, false
+  attr :password, false
+  attr :base_dir, false
+  attr :last_dir, true
+  attr :last_file, true
+  
+  # Create a new instance of Fetcher
+  #
+  #  :base_dir defaults to "/var/log/asterisk/cdr-csv".
+  #  :last_dir defaults to the first sub-directory
+  #   in :base_dir.
+  #  :last_file defaults to the first file in :last_dir.
+  def initialize(hostname, username, opts={})
+    # Process options and arguments
+    opts = { :password => nil,
+             :base_dir => nil,
+             :last_dir => nil,
+             :last_file=> nil
+           }.merge!(opts)
+    @hostname   = hostname
+    @username   = username
+    @password   = opts[:password]
+    @base_dir   = opts[:base_dir]
+    @base_dir ||= '/var/log/asterisk/cdr-csv'
+
+    # Setup SSH and SFTP Connection
+    @ssh      = Net::SSH.start(@hostname, @username, :password => @password)
+    @sftp     = Net::SFTP::Session.new(@ssh).connect!
+
+    # Grab the list of directories, and the current directory attributes
+    @directories  = directories
+    @cur_dir      = directory(opts[:last_dir]) 
+    # If we weren't passed an argument, use the first file in the list
+    @cur_dir    ||= @directories[0]
+        
+    # Grab the list of files from the current directory
+    @files      = files
+    @cur_file   = file(opts[:last_file])
+    # If we weren't passed an argument, use the first file in the list
+    @cur_file ||= @files[0]
+  end
+  
+  # Iterator for Files.  Returns one file path at a time, automatically
+  # moving to the next file or directory until all CDRs have been
+  # returned.
+  def each_file
+    while true
+      file = @cur_file
+      if file
+        yield [@base_dir,@cur_dir.name,@cur_file.name].join("/")
+        next_file!
+      else
+        break
+      end
+    end        
+  end
+  
+  # Iterator for CDRs.  Returns one CDR at a time, automatically
+  # moving to the next file or directory until all CDRs have been
+  # returned.
+  #
+  # CDR files are read into memory one at a time.
+  #
+  # Line numbers are NOT zero indexed (i.e. line 1 == line 1 NOT line 0)
+  def each
+    each_file do |file|
+      @sftp.download!(file).split(/\n/).each_with_index do |line,i|
+        cdr = {
+          :hostname => @hostname, 
+          :file => file, 
+          :line => i+1,
+          :cdr  => CSV.parse_line(line)
+          }
+        yield cdr
+      end
+    end
+  end
+  
+  protected
+
+    # Set @cur_file to the next file.
+    # Changes to next directory if all files in the current directory
+    # have been read.
+    def next_file!
+      @files.each_with_index { |file,i|
+        # find our current location
+        if @cur_file == file
+          next_file = @files[i+1]
+          # If we dont hit the end of the array, everything is good.
+          if next_file != nil
+            @cur_file = next_file
+            return @cur_file
+          # if we hit the end of the array, we need to go to the next directory
+          else
+            # If we run out of directories, we need to exit properly.
+            dir = next_dir!
+            if dir
+              return @cur_file
+            else
+              return false
+            end
+          end
+        end
+      }
+    end
+  
+    # Set @cur_dir to the next directory.  
+    # Updates @cur_file to the first file in that directory
+    def next_dir!
+      @directories.each_with_index {|dir,i|
+        # find our current location
+        if @cur_dir == dir
+          next_dir = @directories[i+1]
+          if next_dir != nil
+            @cur_dir = next_dir
+            @files   = files
+            @cur_file = @files[0]
+            return @cur_dir
+          else
+            return false
+          end
+        end
+      }
+    end
+  
+    # Return an Array of subdirectories in the @base_dir
+    def directories
+      directories = []
+      @sftp.dir.foreach(@base_dir) do |entry|
+        # skip parent, or hidden files/directories
+        next if entry.name =~ /^\.+$/
+        # skip files
+        next unless entry.directory?
+        # store everything else
+        directories << entry
+      end
+      # Sort directories by modification time
+      directories.sort! {|a,b| a.attributes.mtime <=> b.attributes.mtime}
+      directories
+    end
+    
+    # Searches for a directory entry by name
+    # Returns a directory object from the list of directories
+    def directory(dir_name)
+      @directories.each do |dir|
+        return dir if dir.name == dir_name
+      end
+      false
+    end
+    
+    # Return a list of files in @cur_dir
+    def files
+      files = []
+      @sftp.dir.foreach(@base_dir + "/" + @cur_dir.name) do |file|
+        # ignore directories
+        next unless file.file?
+        files << file
+      end
+      # Sort each file by modification time
+      files.sort! {|a,b| a.attributes.mtime <=> b.attributes.mtime }
+      files
+    end
+    
+    # Searches for a file entry by name
+    # Returns a file object from the list of files
+    def file(file_name)
+      @files.each do |file|
+        return file if file.name == file_name
+      end
+      false
+    end
+   
+end
+
+end
+
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cdr-fetcher'
+
+class Test::Unit::TestCase
+end

data/test/test_cdr-fetcher.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestCdrFetcher < Test::Unit::TestCase
+  #should "probably rename this file and start testing for real" do
+  #  flunk "hey buddy, you should probably rename this file and start testing for real"
+  #end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: cdr-fetcher
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Carl Hicks
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: net-sftp
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: net-ssh
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: A gem for fetching CDR data from a remote system via SSH/SFTP.  Supports fetching all files, or a delta from a given offset.
+email: carl.hicks@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- cdr-fetcher.gemspec
+- lib/cdr-fetcher.rb
+- test/helper.rb
+- test/test_cdr-fetcher.rb
+has_rdoc: true
+homepage: http://github.com/chicks/cdr-fetcher
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A gem for fetching CDR's from a remote system.
+test_files: 
+- test/helper.rb
+- test/test_cdr-fetcher.rb