checkcheckit 0.0.4 → 0.0.5

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 bin/minitar
 bin/rdebug
 bin/turn
+test/.test.profile*

data/README.md

@@ -8,15 +8,15 @@ use checklists, like a boss
 
 ## TODO
 
-- run on phone
-  - kick off from cmd line
-    - send email to self
-    - click on url in email in phone
+- interactive run
+  - socket.io between page and cmd line
 - save a run
   - to file
   - to service
 - resume a run
-- run to campfire
+  - locally
+
+- post to campfire
 
 ## Usage
 
@@ -76,7 +76,20 @@ For example:
     Check: failures!
     Notes: <enter>
 
+### Live mode
+
+This is fun.  Specify an email (or a comma-separated list) on the command line and
+that address will receive a message with a link to a web version of the checklist.
+
+Right now the cmd line client and web don't interact.  For now.
+
+    $ check start deploy --email me@me.com,another.guy@gmail.com
+    |-------| Step 1: Pull everything from git
+      > git pull origin
+
+    You'll get an email with a link:
 
+    http://checkcheckit.herokuapp.com/1
 
 ## Contributing
 

data/checkcheckit.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'lucy-goosey', '~> 0.2.0'
   gem.add_dependency 'excon'
   gem.add_dependency 'yajl-ruby'
+  gem.add_dependency 'socketio-client'
 end

data/lib/checkcheckit/console.rb

@@ -2,11 +2,12 @@ require 'ostruct'
 
 class CheckCheckIt::Console
   attr_accessor :list_dir
-  attr_accessor :out_stream, :in_stream
+  attr_accessor :out_stream, :in_stream, :web_socket
 
   def initialize(opts = {})
     @out_stream = opts[:out_stream] || $stdout
     @in_stream  = opts[:in_stream]  || $stdin
+    @web_socket = opts[:web_socket] || SocketIO
   end
 
   def dir
@@ -40,13 +41,21 @@ class CheckCheckIt::Console
     list_name = Dir[dir + '/*/*'].find{ |fname| fname.include? target }
     if list_name
       list = List.new(list_name)
-      if emails = @options['email']
-        web_service_url = ENV['CHECKCHECKIT_URL']
-        response = Excon.post(web_service_url, :body => {
-          emails: emails,
-          list: list.to_h
-        }.to_json,
-        :headers => { 'Content-Type' => 'application/json' })
+      web_service_url = ENV['CHECKCHECKIT_URL']
+      client = nil
+      if (emails = @options['email']) || @options['live']
+
+        @list_id = list_id = notify_server_of_start(emails, list)
+
+        puts "Live at URL: #{web_service_url}/#{list_id}"
+
+        if @options['ws']
+          @client = web_socket.connect(web_service_url, sync: true) do
+            after_start do
+              emit('register', {list_id: list_id})
+            end
+          end
+        end
       end
 
       step_through_list(list)
@@ -95,6 +104,13 @@ class CheckCheckIt::Console
         return
       end
 
+      if @client
+        @client.emit 'check', {
+          list_id: @list_id,
+          step_id: i
+        }
+      end
+
       results[i] = {
         step: i + 1,
         name: step.name,
@@ -138,4 +154,18 @@ class CheckCheckIt::Console
     @out_stream.print text
   end
 
+  def web_service_url
+    ENV['CHECKCHECKIT_URL']
+  end
+
+  # Returns id
+  def notify_server_of_start(emails, list)
+    Excon.post(web_service_url, :body => {
+      emails: emails,
+      list: list.to_h
+    }.to_json,
+    :headers => {
+      'Content-Type' => 'application/json'
+    }).body.to_i
+  end
 end

data/lib/checkcheckit/version.rb

@@ -1,3 +1,3 @@
 module CheckCheckIt
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/checkcheckit.rb

@@ -1,6 +1,7 @@
 require 'lucy-goosey'
 require 'excon'
 require 'yajl/json_gem'
+require 'socketio'
 
 require "checkcheckit/version"
 

data/test/start_test.rb

@@ -5,7 +5,8 @@ class StartTest < CheckCheckIt::TestCase
   def setup
     super
     Examples.create_grocery_list(home)
-    console.in_stream = MiniTest::Mock.new
+    console.in_stream  = MiniTest::Mock.new
+    console.web_socket = MiniTest::Mock.new
   end
 
   def test_list_parses_steps
@@ -29,6 +30,7 @@ class StartTest < CheckCheckIt::TestCase
   # The webservice sends you an email with a link to the list so
   # you can run it on the web.
   def test_email_flag_triggers_live_mode
+    client = MiniTest::Mock.new
     Excon.stub({:method => :post, :body => {
       emails: "csquared@heroku.com,thea.lamkin@gmail.com",
       list:   List.new(home + '/personal/groceries').to_h
@@ -37,6 +39,16 @@ class StartTest < CheckCheckIt::TestCase
     check "start groceries --email csquared@heroku.com,thea.lamkin@gmail.com"
   end
 
+  def test_websocket_mode
+    set_env 'CHECKCHECKIT_EMAIL', "csquared@heroku.com,thea.lamkin@gmail.com"
+    client = MiniTest::Mock.new
+    console.web_socket.expect :connect, client, [String, {sync: true}]
+    Excon.stub({:method => :post}, {:status => 200})
+    3.times { console.in_stream.expect :gets, "y" }
+    3.times { client.expect :emit, true, ['check', Hash] }
+    check "start groceries --ws"
+  end
+
   # Same as above but with env set
   def test_reads_email_from_env
     set_env 'CHECKCHECKIT_EMAIL', "csquared@heroku.com,thea.lamkin@gmail.com"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checkcheckit
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-15 00:00:00.000000000 Z
+date: 2012-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lucy-goosey
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: socketio-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Checklists like a boss
 email:
 - christopher.continanza@gmail.com
@@ -98,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2187395605340468974
+      hash: 861194127315958268
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -107,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2187395605340468974
+      hash: 861194127315958268
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23