shellcast 0.0.1 → 0.0.4

data/Gemfile

@@ -1,13 +1,14 @@
 source "http://rubygems.org"
 
 gem 'xdg'
-gem 'ohai'
+gem 'colored'
+#gem 'artii'
+#gem 'ohai'
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.1.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.1"
-  gem "rcov", ">= 0"
+  gem "rspec"
+  gem "mocha"
+  gem "bundler"
+  gem "jeweler"
+  gem "rcov"
 end

data/Gemfile.lock

@@ -1,24 +1,15 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    colored (1.2)
     diff-lcs (1.1.2)
-    extlib (0.9.15)
     git (1.2.5)
     jeweler (1.5.1)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    json (1.4.6)
-    mixlib-cli (1.2.0)
-    mixlib-config (1.1.2)
-    mixlib-log (1.2.0)
-    ohai (0.5.8)
-      extlib
-      json (>= 1.4.4, <= 1.4.6)
-      mixlib-cli
-      mixlib-config
-      mixlib-log
-      systemu
+    mocha (0.9.9)
+      rake
     rake (0.8.7)
     rcov (0.9.9)
     rspec (2.1.0)
@@ -29,16 +20,16 @@ GEM
     rspec-expectations (2.1.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.1.0)
-    systemu (1.2.0)
     xdg (1.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.1)
-  ohai
+  bundler
+  colored
+  jeweler
+  mocha
   rcov
-  rspec (~> 2.1.0)
+  rspec
   xdg

data/README.md

@@ -0,0 +1,22 @@
+# ShellCast
+
+Screencasting for [Shell Ninjas](http://shell.heroku.com/).
+
+## Usage
+
+    gem install shellcast
+    shellcast record
+    ...
+    exit
+    shellcash push ID
+    shellcast play 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.

data/Rakefile

@@ -13,9 +13,9 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "shellcast"
-  gem.homepage = "http://github.com/antono/shellcast"
+  gem.homepage = "http://shell.heroku.com/"
   gem.license = "GPL"
-  gem.summary = %Q{Record and distribute shellcasts}
+  gem.summary = %Q{Screencasts for Shell Ninjas}
   gem.description = %Q{Screencast utility for unix shell junkies :)}
   gem.email = "antono.vasiljev@gmail.com"
   gem.authors = ["Antono Vasiljev"]

data/TODO

@@ -0,0 +1,3 @@
+- Port Figlet from artii gem to ruby 1.9.2 and use
+  instead hardcoded headers and footers
+- Think about console setup before shellcasting

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.4

data/bin/shellcast

@@ -5,7 +5,20 @@ $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 require 'rubygems'
 require 'shellcast'
 
+BASENAME = File.basename(__FILE__)
+
 case ARGV[0]
+when '-h', '--help'
+  puts <<-HELP
+    #{BASENAME} option [arg]
+    
+      Options:
+        setup API_KEY - setup
+        record - record new shellcast
+        push RECORD_ID - publish
+        list - print list of records
+        play RECORD_ID - play local record
+  HELP
 when 'record'
 	ShellCast::Recorder.record!
 when 'list'
@@ -19,7 +32,23 @@ when 'play'
     puts "Select one..."
     exit
   end
+when 'push'
+  if ARGV[1]
+    ShellCast::Publisher.new.publish(ARGV[1])
+  else
+    puts "What do you want to publish"
+    ShellCast::Player.list
+    puts "Select one..."
+    exit
+  end
+when 'setup'
+  if ARGV[1]
+    ShellCast.api_key = ARGV[1]
+  else
+    puts "\n\tUsage: #{BASENAME} setup API_KEY\n\n"
+    exit
+  end
 else
-  puts "Usage: #{__FILE__} command [shellcast_id]"
+  puts "Usage: #{BASENAME} command [shellcast_id]"
   puts "Commands: record, list, play, publish, get"
 end

data/lib/shellcast/player.rb

@@ -1,13 +1,48 @@
+# encoding: utf-8
 module ShellCast
   class Player
+
+    HEADER = <<-EOH
+                                                               
+            █             ███    ███                               
+      ▓███▒ █               █      █     ░███▒                 █   
+     █▓  ░█ █               █      █    ░█▒ ░█                 █   
+     █      █▒██▒   ███     █      █    █▒     ░███░  ▒███▒  █████ 
+     █▓░    █▓ ▒█  ▓▓ ▒█    █      █    █      █▒ ▒█  █▒ ░█    █   
+      ▓██▓  █   █  █   █    █      █    █          █  █▒░      █   
+         ▓█ █   █  █████    █      █    █      ▒████  ░███▒    █   
+          █ █   █  █        █      █    █▒     █▒  █     ▒█    █   
+     █░  ▓█ █   █  ▓▓  █    █░     █░   ░█▒ ░▓ █░ ▓█  █░ ▒█    █░  
+     ▒████░ █   █   ███▒    ▒██    ▒██   ▒███▒ ▒██▒█  ▒███▒    ▒██ 
+
+
+                         .----------------.
+                        ' Playback started '
+    EOH
+
+    FOOTER = <<-EOF
+            █                                      █ 
+    ███████ █                    ██████            █ 
+       █    █                    █                 █ 
+       █    █▒██▒   ███          █      █▒██▒   ██▓█ 
+       █    █▓ ▒█  ▓▓ ▒█         █      █▓ ▒█  █▓ ▓█ 
+       █    █   █  █   █         ██████ █   █  █   █ 
+       █    █   █  █████         █      █   █  █   █ 
+       █    █   █  █             █      █   █  █   █ 
+       █    █   █  ▓▓  █         █      █   █  █▓ ▓█ 
+       █    █   █   ███▒         ██████ █   █   ██▓█ 
+
+    EOF
+
+
     def self.play(id)
       new(id).play
     end
 
     def self.list
       Dir[File.join(ShellCast::DATA_DIR, "**", 'meta')].each do |path|
-        metadata = YAML.load_file(path)
-        puts "#{metadata["id"]}: #{metadata["title"]}"
+        metadata = JSON.parse(IO.read(path))
+        puts "#{metadata["created_at"]}: #{metadata["title"]}"
       end
     end
 
@@ -16,13 +51,11 @@ module ShellCast
     end
 
     def play
-      puts ""
-      puts "Playback started"
-      puts "-" * 80
+      puts HEADER.black_on_white
+      puts
       system(scriptreplay_cmd)
       puts
-      puts "-" * 80
-      puts "Playback finished"
+      puts FOOTER.black_on_white
     end
 
     private

data/lib/shellcast/publisher.rb

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

data/lib/shellcast/recorder.rb

@@ -1,6 +1,37 @@
+# encoding: utf-8
 module ShellCast
   class Recorder
 
+    HEADER = <<-EOH
+                                            █    █                               
+     █████                                  █                                    
+     █   ▓█                                 █                                    
+     █    █  ███    ▓██▒   ███    █▒██▒  ██▓█  ███    █▒██▒   ██▓█               
+     █   ▒█ ▓▓ ▒█  ▓█  ▓  █▓ ▓█   ██  █ █▓ ▓█    █    █▓ ▒█  █▓ ▓█               
+     █████  █   █  █░     █   █   █     █   █    █    █   █  █   █               
+     █  ░█▒ █████  █      █   █   █     █   █    █    █   █  █   █               
+     █   ░█ █      █░     █   █   █     █   █    █    █   █  █   █               
+     █    █ ▓▓  █  ▓█  ▓  █▓ ▓█   █     █▓ ▓█    █    █   █  █▓ ▓█    █      █   
+     █    ▒  ███▒   ▓██▒   ███    █      ██▓█  █████  █   █   ██▒█    █      █   
+                                                                 █               
+                                                              ▓ ▒█               
+                                                              ▒██░              
+    EOH
+
+    FOOTER = <<-EOF
+              █             █           █                 █        
+     ██████                             █                 █    █   
+     █                                  █                 █    █   
+     █      ███    █▒██▒  ███    ▒███▒  █▒██▒   ███    ██▓█    █   
+     █        █    █▓ ▒█    █    █▒ ░█  █▓ ▒█  ▓▓ ▒█  █▓ ▓█    █   
+     ██████   █    █   █    █    █▒░    █   █  █   █  █   █    █   
+     █        █    █   █    █    ░███▒  █   █  █████  █   █    █   
+     █        █    █   █    █       ▒█  █   █  █      █   █        
+     █        █    █   █    █    █░ ▒█  █   █  ▓▓  █  █▓ ▓█    █   
+     █      █████  █   █  █████  ▒███▒  █   █   ███▒   ██▓█    █   
+
+    EOF
+
     def self.record!
       new.record!
     end
@@ -10,32 +41,34 @@ module ShellCast
     end
 
     def record!
-      FileUtils.mkdir_p(shellcast_dir) unless File.exists?(shellcast_dir)
+      test_shellcast_data_dir
       request_metadata
+      puts HEADER.black_on_white
       puts "Your session started"
       puts "Type Ctrl+D or exit to finish recording"
-      puts "-" * 80
       init_terminal
       system(script_cmd)
       restore_terminal
-      puts "-" * 80
-      puts "Session finihed!"
-      puts "Shellcast ID:\t #{shellcast_id}"
-      puts "Shellcast path:\t #{shellcast_dir}"
+      puts FOOTER.black_on_white
+      puts "hint $ shellcast play #{shellcast_id}".green
     end
 
     def request_metadata
-      puts "Provide name for Your shellcast: "
+      print "Provide name for Your shellcast: "
       @meta["title"] = STDIN.gets.strip
-      @meta["id"] = shellcast_id
+      @meta["created_at"] = shellcast_id
       puts shellcast_file('meta')
       File.open(shellcast_file('meta'), 'w+') do |meta|
-        meta.puts @meta.to_yaml
+        meta.puts @meta.to_json
       end
     end
 
     private
 
+    def test_shellcast_data_dir
+      FileUtils.mkdir_p(shellcast_dir) unless File.exists?(shellcast_dir)
+    end
+
     def init_terminal
       stty_data = `stty -a`
       @user_columns = stty_data.match(/columns (\d+)/)[1]
@@ -61,7 +94,7 @@ module ShellCast
     end
 
     def script_cmd
-      "script -c 'bash' #{shellcast_file('data')} -t 2> #{shellcast_file('timing')}"
+      "script -c 'bash' #{shellcast_file('typescript')} -t 2> #{shellcast_file('timing')}"
     end
   end
 end

data/lib/shellcast.rb

@@ -1,17 +1,34 @@
 require 'rubygems'
 require 'fileutils'
+require 'colored'
 require 'xdg'
 require 'yaml'
+require 'json'
 
 module ShellCast
 
-  APP_NAME = 'shellcast'
-  DATA_DIR = File.join(XDG::Data.home, APP_NAME)
+  APP_NAME   = 'shellcast'
+  DATA_DIR   = File.join(XDG::Data.home,   APP_NAME)
+  CONFIG_DIR = File.join(XDG::Config.home, APP_NAME)
+  API_KEY    = File.join(CONFIG_DIR, 'api_key')
 
-  def shellcast_dir(shellcast_id)
-    File.join(ShellCast::DATA_DIR, shellcast_id)
+  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+') do |f|
+        f.puts(key.strip)
+      end
+    end
+
+    def shellcast_dir(shellcast_id)
+      File.join(ShellCast::DATA_DIR, shellcast_id.to_s)
+    end
   end
-  module_function :shellcast_dir
 
   autoload :Recorder,  'shellcast/recorder.rb'
   autoload :Player,    'shellcast/player.rb'

data/spec/shellcast/publisher_spec.rb

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

data/spec/shellcast/recorder_spec.rb

@@ -1,10 +1,41 @@
 require 'spec_helper'
 
 describe ShellCast::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.should_receive("system").with(anything)
+      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/shellcast_spec.rb

@@ -8,4 +8,8 @@ describe ShellCast do
   it "should provide XDG and APP_NAME based ::DATA_DIR" do
     ShellCast::DATA_DIR.should == File.join(XDG::Data.home, ShellCast::APP_NAME)
   end
+
+  it "should provide XDG config path" do
+    ShellCast::CONFIG_DIR.should == File.join(XDG::Config.home, ShellCast::APP_NAME)
+  end
 end

data/spec/spec_helper.rb

@@ -8,5 +8,5 @@ require 'shellcast'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  
+  config.mock_with :mocha
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Antono Vasiljev
@@ -14,12 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-06 00:00:00 +02:00
+date: 2010-12-30 00:00:00 +02:00
 default_executable: shellcast
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: xdg
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -29,10 +28,10 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: ohai
-  prerelease: false
+  name: colored
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -42,55 +41,49 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rspec
-  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 2
-        - 1
         - 0
-        version: 2.1.0
+        version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: bundler
-  prerelease: false
+  name: mocha
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
-        - 0
         - 0
-        version: 1.0.0
+        version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: jeweler
-  prerelease: false
+  name: bundler
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
+        - 0
+        version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: rcov
-  prerelease: false
+  name: jeweler
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -100,7 +93,21 @@ dependencies:
         - 0
         version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
 description: Screencast utility for unix shell junkies :)
 email: antono.vasiljev@gmail.com
 executables: 
@@ -109,15 +116,17 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.md
+- TODO
 files: 
 - .document
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
+- TODO
 - VERSION
 - bin/shellcast
 - lib/shellcast.rb
@@ -130,7 +139,7 @@ files:
 - spec/shellcast_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/antono/shellcast
+homepage: http://shell.heroku.com/
 licenses: 
 - GPL
 post_install_message: 
@@ -143,6 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: -466564625
       segments: 
       - 0
       version: "0"
@@ -160,7 +170,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Record and distribute shellcasts
+summary: Screencasts for Shell Ninjas
 test_files: 
 - spec/shellcast/player_spec.rb
 - spec/shellcast/publisher_spec.rb

data/README.rdoc

@@ -1,19 +0,0 @@
-= shellcast
-
-Description goes here.
-
-== Contributing to shellcast
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2010 Antono Vasiljev. See LICENSE.txt for
-further details.
-