shelr 0.9.7

data/README.md

@@ -0,0 +1,41 @@
+# Shelr -- screencasting for [shell ninjas][TV].
+
+## Installation
+
+You'll need ruby and rubygems installed.
+
+    gem install shelr
+
+See [shellcast](http://shelr.tv/records/4d1c5458905ba77eb7000002) for details :)
+
+## Watching other's records
+
+   shelr play http://shelr.tv/records/4d1c5458905ba77eb7000002
+
+You can watch them online at [http://shelr.tv/][TV]
+
+## Recording
+
+    shelr record
+    ...
+    do something in your shell
+    ..
+    exit
+
+## Publishing
+
+    shelr list
+    <select id of your record>
+    shelr push <ID>
+
+## Dependencies
+
+You need `script` and `scriptreplay` tools from BSD Utils.
+Tey are already installed if You use Debian/Ubuntu/BSD variants.
+Not sure about other OSes.
+
+## Copyright
+
+Copyright (c) 2010 Antono Vasiljev. See LICENSE.txt for further details.
+
+[TV]: http://shelr.tv/ "Shell records from shell ninjas"

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "shelr"
+  gem.homepage = "http://shelr.tv/"
+  gem.license = "GPLv3"
+  gem.summary = %Q{Screencasts for Shell Ninjas}
+  gem.description = %Q{Screencast utility for unix shell junkies :)}
+  gem.email = "self@antono.info"
+  gem.authors = ["Antono Vasiljev", "Pete Clark"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "shelr #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO.org

@@ -0,0 +1,7 @@
+* DONE Remove dependencies for easier packaging
+* TODO Port to termrec or ttyrec
+  git clone http://angband.pl/git/termrec
+  http://angband.pl/termrec.html
+* TODO Port Figlet from artii gem to ruby 1.9.2
+  and use it instead hardcoded headers and footers
+* TODO Think about terminal setup before shellcasting

data/VERSION

@@ -0,0 +1 @@
+0.9.7

data/bin/shelr

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'rubygems'
+require 'shelr'
+
+BASENAME = File.basename(__FILE__)
+HELP     = <<-HELP
+
+  Usage: #{BASENAME} command [arg]
+    
+  Commands:
+    setup API_KEY   - setup
+    record          - record new shellcast
+    push RECORD_ID  - publish
+    list            - print list of records
+    play RECORD_ID  - play local record
+    play RECORD_URL - play remote record
+
+  Visit: http://shelr.tv/ for more info.
+
+HELP
+
+case ARGV[0]
+when '-h', '--help'
+  puts HELP
+when 'record'
+	Shelr::Recorder.record!
+when 'list'
+  Shelr::Player.list
+when 'play'
+  if ARGV[1]
+    if ARGV[1] =~ /^http:.*/
+      Shelr::Player.play_remote(ARGV[1])
+    else
+      Shelr::Player.play(ARGV[1])
+    end
+  else
+    puts "Missing id for shellcast"
+    Shelr::Player.list
+    puts "Select one..."
+    exit
+  end
+when 'push'
+  if ARGV[1]
+    Shelr::Publisher.new.publish(ARGV[1])
+  else
+    puts "What do you want to publish?"
+    Shelr::Player.list
+    puts "Select one..."
+    exit
+  end
+when 'setup'
+  if ARGV[1]
+    Shelr.api_key = ARGV[1]
+  else
+    puts "\n\tUsage: #{BASENAME} setup API_KEY\n\n"
+    exit
+  end
+else
+  puts HELP
+end

data/lib/shelr/player.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+require 'net/http'
+require 'tmpdir'
+require 'fileutils'
+require 'pathname'
+
+module Shelr
+  class Player
+
+    HEADER = <<-EOH
+
+                 ____  _          _ _  ____          _   
+                / ___|| |__   ___| | |/ ___|__ _ ___| |_ 
+                \___ \| '_ \ / _ \ | | |   / _` / __| __|
+                 ___) | | | |  __/ | | |__| (_| \__ \ |_ 
+                |____/|_| |_|\___|_|_|\____\__,_|___/\__|
+
+-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+
+
+    EOH
+
+    FOOTER = <<-EOF
+-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+                 _____ _            _____           _ 
+                |_   _| |__   ___  | ____|_ __   __| |
+                  | | | '_ \ / _ \ |  _| | '_ \ / _` |
+                  | | | | | |  __/ | |___| | | | (_| |
+                  |_| |_| |_|\___| |_____|_| |_|\__,_|
+
+    EOF
+
+
+    def self.play(id)
+      new(id).play
+    end
+
+    def self.play_remote(url)
+      puts ".==> Fetching #{url}"
+      resp = Net::HTTP.get(URI.parse(url))
+      parts = JSON.parse(resp)
+
+      print "Title:\t"
+      puts parts['title']
+      print "Description:\t"
+      puts parts['description']
+
+      Dir.mktmpdir do |dir|
+        %w(typescript timing).each do |type|
+          File.open(File.join(dir, type), 'w') { |f| f.puts(parts[type]) }
+        end
+        puts "+==> Playing... "
+        system "scriptreplay #{File.join(dir, 'timing')} #{File.join(dir, 'typescript')}"
+        puts "+\n+"
+        print "| Title:\t"
+        puts parts['title']
+        print "| Description:\t"
+        puts parts['description']
+        puts "`==> The end... "
+      end
+    end
+
+    def self.list
+      Dir[File.join(Shelr::DATA_DIR, "**", 'meta')].each do |path|
+        metadata = JSON.parse(IO.read(path))
+        puts "#{metadata["created_at"]}: #{metadata["title"]}"
+      end
+    end
+
+    def initialize(id)
+      @record_id = id
+    end
+
+    def play
+      puts HEADER
+      puts
+      system(scriptreplay_cmd)
+      puts
+      puts FOOTER
+    end
+
+    private
+
+    def record_file(name)
+      File.join(Shelr.data_dir(@record_id), name)
+    end
+
+    def scriptreplay_cmd
+      "scriptreplay #{record_file('timing')} #{record_file('typescript')}"
+    end
+  end
+end

data/lib/shelr/publisher.rb

@@ -0,0 +1,44 @@
+require 'net/http'
+require 'uri'
+
+module Shelr
+  class Publisher
+
+    def publish(id)
+      uri = URI.parse(Shelr::API_URL + '/records')
+      params = { 'record' =>  prepare(id) }
+      params.merge!({'api_key' => Shelr.api_key}) if api_key
+      res = Net::HTTP.post_form(uri, params)
+      res = JSON.parse(res.body)
+      if res['ok']
+        puts res['message']
+        puts Shelr::API_URL + '/records/' + res['id']
+      else
+        puts res['message']
+      end
+    end
+
+    def api_key
+      unless Shelr.api_key
+        print 'Paste your API KEY [or Enter to publish as Anonymous]: '
+        key = STDIN.gets.strip
+        Shelr.api_key = key unless key.empty?
+      end
+      Shelr.api_key
+    end
+
+    def prepare(id)
+      out = {}
+      ['meta', 'timing', 'typescript'].each do |file|
+        out[file] = File.read(File.join(Shelr.data_dir(id), file))
+      end
+      meta = JSON.parse(out.delete('meta'))
+      meta.each { |k,v| out[k] = v }
+      print 'Description: '
+      out['description'] = STDIN.gets.strip
+      print 'Tags (ex: howto, linux): '
+      out['tags'] = STDIN.gets.strip
+      return out.to_json
+    end
+  end
+end

data/lib/shelr/recorder.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+module Shelr
+  class Recorder
+
+    HEADER = <<-EOH
+ ____                        _ _             
+|  _ \ ___  ___ ___  _ __ __| (_)_ __   __ _ 
+| |_) / _ \/ __/ _ \| '__/ _` | | '_ \ / _` |
+|  _ <  __/ (_| (_) | | | (_| | | | | | (_| |
+|_| \_\___|\___\___/|_|  \__,_|_|_| |_|\__, |
+                                       |___/ 
+    EOH
+
+    FOOTER = <<-EOF
+ _____ _       _     _              _ 
+|  ___(_)_ __ (_)___| |__   ___  __| |
+| |_  | | '_ \| / __| '_ \ / _ \/ _` |
+|  _| | | | | | \__ \ | | |  __/ (_| |
+|_|   |_|_| |_|_|___/_| |_|\___|\__,_|
+                                      
+    EOF
+
+    def self.record!
+      new.record!
+    end
+
+    def initialize
+      @meta = {}
+    end
+
+    def record!
+      check_record_dir
+      request_metadata
+      puts HEADER
+      puts "Your session started"
+      puts "Type Ctrl+D or exit to finish recording"
+      system(script_cmd)
+      restore_terminal
+      puts FOOTER
+      puts
+      puts "hint $ #{Shelr::APP_NAME} play #{record_id}"
+      puts "hint $ #{Shelr::APP_NAME} push #{record_id}"
+    end
+
+    def request_metadata
+      init_terminal
+      print "Provide HUMAN NAME for Your shellcast: "
+      @meta["title"] = STDIN.gets.strip
+      @meta["created_at"] = record_id
+      @meta["columns"] = @user_columns
+      @meta["rows"] = @user_rows
+      puts record_file('meta')
+      File.open(record_file('meta'), 'w+') do |meta|
+        meta.puts @meta.to_json
+      end
+    end
+
+    private
+
+    def check_record_dir
+      FileUtils.mkdir_p(record_dir) unless File.exists?(record_dir)
+    end
+
+    def init_terminal
+      stty_data = `stty -a`
+      @user_columns = stty_data.match(/columns (\d+)/)[1]
+      @user_rows    = stty_data.match(/rows (\d+)/)[1]
+      puts "Saved terminal size #{@user_columns}X#{@user_rows}"
+      # system("stty columns 80 rows 24")
+    end
+
+    def restore_terminal
+      # system("stty columns #{@user_columns} rows #{@user_rows}")
+    end
+
+    def record_dir
+      @record_dir ||= Shelr.data_dir(record_id)
+    end
+
+    def record_id
+      @record_id ||= Time.now.to_i.to_s
+    end
+
+    def record_file(name)
+      File.join(Shelr.data_dir(record_id), name)
+    end
+
+    def script_cmd
+      "script -c 'bash' #{record_file('typescript')} -t 2> #{record_file('timing')}"
+    end
+
+  end
+end

data/lib/shelr.rb

@@ -0,0 +1,33 @@
+require 'fileutils'
+require 'yaml'
+require 'json'
+
+module Shelr
+
+  APP_NAME   = 'shelr'
+  DATA_DIR   = File.join(ENV['HOME'], '.share', APP_NAME)
+  CONFIG_DIR = File.join(ENV['HOME'], '.config', APP_NAME)
+  API_KEY    = File.join(CONFIG_DIR, 'api_key')
+  API_URL    = ENV['SHELR_LOCAL'] ? 'http://localhost:3000' : 'http://shelr.tv'
+
+  autoload :Recorder,  'shelr/recorder.rb'
+  autoload :Player,    'shelr/player.rb'
+  autoload :Publisher, 'shelr/publisher.rb'
+
+  class << self
+    def api_key
+      return false unless File.exist?(API_KEY)
+      @api_key ||= File.read(API_KEY).strip
+    end
+
+    def api_key=(key)
+      FileUtils.mkdir_p(CONFIG_DIR) unless File.exist?(CONFIG_DIR)
+      File.open(API_KEY, 'w+') { |f| f.puts(key.strip) }
+    end
+
+    def data_dir(record_id)
+      File.join(Shelr::DATA_DIR, record_id.to_s)
+    end
+  end
+
+end

data/shelr.1

@@ -0,0 +1,107 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "SHELR" "1" "August 2011" "" ""
+.
+.SH "NAME"
+\fBshelr\fR \- screencasting for shell junkies
+.
+.SH "SYNOPSIS"
+\fBshelr\fR command [id]
+.
+.SH "DESCRIPTION"
+\fBShelr\fR records terminal output and can replay it
+.
+.SH "COMMANDS"
+.
+.TP
+\fBrecord\fR
+Will record your terminal unless you type \fBexit\fR or Ctrl+D and store it to $HOME/\.local/share/shellcast/
+.
+.TP
+\fBlist\fR
+lists all your shellcasts\.
+.
+.TP
+\fBplay\fR
+plays local or remote shellcast\.
+.
+.TP
+\fBpush\fR
+publish your shellcast
+.
+.SH "EXAMPLES"
+Record your shellcast:
+.
+.IP "" 4
+.
+.nf
+
+$ shelr record
+\.\.\. do something \.\.\.
+$ exit
+.
+.fi
+.
+.IP "" 0
+.
+.P
+List recorded shellcasts:
+.
+.IP "" 4
+.
+.nf
+
+$ shelr list
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Play local shellcast:
+.
+.IP "" 4
+.
+.nf
+
+$ shelr play 1293702847
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Play remote shellcast:
+.
+.IP "" 4
+.
+.nf
+
+$ shelr play http://shelr\.tv/records/4d1f7c3890820d6144000002\.json
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Publish your shellcast:
+.
+.IP "" 4
+.
+.nf
+
+$ shelr push 1293702847
+.
+.fi
+.
+.IP "" 0
+.
+.SH "BUGS"
+\fBshelr\fR is written in Ruby and depends on \fBscript\fR and \fBscriptreplay\fR, commands libraries that are non\-trivial to install on some systems\.
+.
+.SH "COPYRIGHT"
+Shelr is Copyright (C) 2011 Antono Vasiljev \fIhttp://antono\.info/\fR
+.
+.SH "SEE ALSO"
+script(1), scriptreplay(1)

data/shelr.1.ronn

@@ -0,0 +1,63 @@
+shelr(1) -- screencasting for shell junkies
+===============================================
+
+## SYNOPSIS
+
+`shelr` command [id]
+
+## DESCRIPTION
+
+**Shelr** records terminal output and can replay it 
+
+## COMMANDS
+
+  * `record`:
+    Will record your terminal unless you type `exit` or Ctrl+D and
+    store it to $HOME/.local/share/shellcast/
+
+  * `list`:
+    lists all your shellcasts. 
+
+  * `play`:
+    plays local or remote shellcast.
+
+  * `push`:
+    publish your shellcast
+
+## EXAMPLES
+
+Record your shellcast:
+
+    $ shelr record
+    ... do something ...
+    $ exit
+
+List recorded shellcasts:
+
+    $ shelr list
+
+Play local shellcast:
+
+    $ shelr play 1293702847
+
+Play remote shellcast:
+
+    $ shelr play http://shelr.tv/records/4d1f7c3890820d6144000002.json
+
+Publish your shellcast:
+
+    $ shelr push 1293702847
+
+
+## BUGS
+
+**shelr** is written in Ruby and depends on `script` and `scriptreplay`,
+commands libraries that are non-trivial to install on some systems.
+
+## COPYRIGHT
+
+Shelr is Copyright (C) 2011 Antono Vasiljev <http://antono.info/>
+
+## SEE ALSO
+
+script(1), scriptreplay(1)

data/spec/shelr/publisher_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Shelr::Publisher do
+  describe "#publish(id)" do
+    it "should publish shellcast with oauth" do
+      pending
+    end
+  end
+end

data/spec/shelr/recorder_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Shelr::Recorder do
+
+  before(:each) do
+    STDIN.stubs(:gets).returns('my shellcast')
+  end
+
+  describe "#record!" do
+
+    before(:each) do
+      subject.stubs(:system).with(anything).returns(true)
+    end
+
+    it "should set tty to 80x24" do
+      subject.expects("system").with(regexp_matches(/stty columns 80 rows 24/))
+      subject.record!
+    end
+
+    it "should restore tty to user defined values" do
+      subject.expects(:restore_terminal)
+      subject.record!
+    end
+
+    it "should start script session" do
+      subject.expects("system").with(regexp_matches Regexp.compile("script -c 'bash'"))
+      subject.record!
+    end
+  end
+
+  describe "#restore_terminal" do
+    it "should call tty with saved dimensions" do
+      subject.expects(:system).with(
+        all_of(regexp_matches(/stty/),
+               regexp_matches(/columns/),
+               regexp_matches(/rows/))
+      )
+      subject.send :restore_terminal
+    end
+  end
+end

data/spec/shelr_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Shelr do
+  it "should have ::APP_NAME defined" do
+    Shelr::APP_NAME.should == 'shelr'
+  end
+
+  it "should provide XDG and APP_NAME based ::DATA_DIR" do
+    Shelr::DATA_DIR.should == File.join(XDG['DATA_HOME'].to_s, Shelr::APP_NAME)
+  end
+
+  it "should provide XDG config path" do
+    Shelr::CONFIG_DIR.should == File.join(XDG['CONFIG_HOME'].to_s, Shelr::APP_NAME)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'shelr'
+require "rubygems"
+require "bundler/setup"
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end