codefusion 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGUwNWU4MDE0Y2QwMmJmOTJkODJkN2RhODA0ZmE1NTNkMWZlZjE2Nw==
+  data.tar.gz: !binary |-
+    ODgxNmRmMzIwMjZlZDZiMDUzM2Q4YWZjODVjYmZlZjY0NWI4Y2ZmNA==
+SHA512:
+  metadata.gz: !binary |-
+    ZTE5Zjg5ODVhZmU2ZDUwZTZkOWRjM2M0ZGQwNTg5ZGU5M2Y5YThkM2NjZDFi
+    ZTEwMzM3N2MyOGEzMGEzMTNlYjY5NzYxYTY1MTRiMmYyMWM1NDMwMjc2OTEz
+    ZjFmNjhmOTY5ZDZiNTExMThjMDRjMmRjOTlhZTEzNWZhZTRiZGU=
+  data.tar.gz: !binary |-
+    YjU2NzFhN2EyNzExZGI5OTdjNzYzYTAyMGZmNTBmYTNmZjRkYzkxOTk2ZTNh
+    ZGRhZDQyMGMxNDU1NTcxM2FmZTkwOWI5YjMyNzBiODdkYTY0MTFkOGM3ZmI5
+    YTgwMmM1NmZiNDA4N2VmYTFiY2ZjNzEzMDc4NzQ5NjJmMzEwMmI=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in codefusion.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+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.md

@@ -0,0 +1,28 @@
+#CodeFusion
+
+CodeFusion allows a user to specify a file to watch. When the text within the target file changes, the CodeFusion gem records the changes and sends them to the CodeFusion web app. The changes can be viewed in real time at http://www.codefusion.io by anyone who navigates to your session's dynamically generated unique url.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'codefusion'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install codefusion
+
+## Usage
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/fusion

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'SecureRandom'
+
+require File.expand_path(File.join('..', 'lib', 'codefusion'), File.dirname(__FILE__))
+
+Application.new(ARGV)

data/codefusion.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'codefusion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "codefusion"
+  spec.version       = Codefusion::VERSION
+  spec.authors       = ["David Stavis, Ben Myhre, Drew West, Aaron Wertman, James Hulley"]
+  spec.email         = ["drewfwest@gmail.com"]
+  spec.description   = %q{Run the fusion command line executable to start a live coding session that can be watched by anyone who has the url printed to the command line.}
+  spec.summary       = %q{Allows teachers to stream copies of their code to many students, live.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+#/*****************Dependencies*********************
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('pry')
+
+  spec.add_runtime_dependency('listen')
+  spec.add_runtime_dependency('json')
+  spec.add_runtime_dependency('httparty')
+
+#*****************Dependencies*********************/
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/codefusion.rb

@@ -0,0 +1,53 @@
+require 'listen'
+require 'rubygems'
+require 'httparty'
+require 'json'
+
+require 'codefusion/classroom'
+require 'codefusion/firebase'
+require 'codefusion/listener'
+require 'codefusion/view'
+require 'codefusion/watch_file'
+
+class Application
+	attr_reader :args, :view, :classroom, :listener
+
+	def initialize(args = [])
+		@args = args
+		@view = View.new
+		check_args
+	end
+
+	private
+	def check_args
+		if !!(@args[0] =~ /^-/)
+			run_utilities(@args[0])
+		elsif !!(@args[0] =~ /^\w/)
+			run_program
+		else
+			display_error_message
+		end
+	end
+
+	def run_utilities(command)
+		if !!(command =~ /^-h$/ || command =~ /^-help$/)
+			@view.display_help_info
+		else
+			display_error_message
+		end
+	end
+
+	def run_program
+		@classroom = Classroom.new( WatchFile.new(get_file_name) )
+		@listener = Listener.new
+		@listener.start( @classroom, @view )
+	end
+
+	def display_error_message
+		@view.display_message("ERROR: invalid arguments, for help information type '$ fusion -help' or '$ fusion -h'")
+	end
+
+	def get_file_name
+		!!(@args[0] =~/^\//) ? @args[0].slice!(0) : @args[0]
+	end
+end

data/lib/codefusion/classroom.rb

@@ -0,0 +1,58 @@
+require 'codefusion/firebase'
+class Classroom
+  attr_reader :code, :file
+
+  include Firebase
+
+  def initialize(file)
+    @code = generate_classroom_code
+    @file = file
+  end
+
+  def self.create(file)
+    Classroom.new(file)
+    Classroom.save
+  end
+
+  def update
+    @file.update
+    save
+  end
+
+  def save
+    request_body = [@code, @file.name, @file.content] #would love to extract this into some other model
+    unless @uuid
+      response = Firebase.create(request_body)
+      @uuid = get_uuid(response)
+    else
+      Firebase.update(request_body, @uuid)
+    end
+  end
+
+  def get_file_name ## reduce
+    @file.name
+  end
+
+  def get_dir ##reduce
+    Dir.pwd
+  end
+
+  def get_watch_url ##reduce
+    generate_watch_url
+  end
+
+  private
+
+  def generate_classroom_code
+    SecureRandom::urlsafe_base64(1)
+  end
+
+  def get_uuid(response)
+    response["name"]
+  end
+
+  def generate_watch_url
+    "http://www.codefusion.io/classrooms/" + @code
+  end
+
+end

data/lib/codefusion/firebase.rb

@@ -0,0 +1,32 @@
+module Firebase
+  include HTTParty
+
+  extend self
+
+  # ENV[:firebase_uri]
+  @firebase_uri = "https://radiant-fire-3325.firebaseio.com/classrooms"
+
+  def create(body)
+    HTTParty.post(make_request_url, get_config(body))
+  end
+
+  def update(body, uuid)
+    HTTParty.put(make_request_url(uuid), get_config(body))
+  end
+
+  private
+
+  def make_request_url(uuid = "")
+    @firebase_uri + '/' + uuid + '.json'
+  end
+
+  def make_json(body)
+    return {classroom_code: body[0], file_name: body[1], file_content: body[2]}.to_json
+  end
+
+  def get_config(body)
+    return {:body => make_json(body), :options => { :headers => { "Content-Type" => "application/json"}}}
+  end
+
+end
+

data/lib/codefusion/listener.rb

@@ -0,0 +1,16 @@
+class Listener
+  def start(classroom, view)
+    file_pattern = Regexp.new(classroom.get_file_name)
+    file_dir = classroom.get_dir
+    # TODO check if file is valid?
+
+    file_listener = Listen.to(file_dir, only: file_pattern) do |modified, added, removed|
+      classroom.update
+      view.display_update_message(classroom.get_file_name, classroom.get_watch_url)
+    end
+
+    view.display_intro_message(classroom.get_file_name, classroom.get_watch_url)
+    file_listener.start
+    sleep
+  end
+end

data/lib/codefusion/version.rb

@@ -0,0 +1,3 @@
+module Codefusion
+  VERSION = "0.1.0"
+end

data/lib/codefusion/view.rb

@@ -0,0 +1,31 @@
+class View
+  def display_message(message)
+    puts "    #{message}"
+  end
+
+  def display_update_message(file_name, url)
+    puts "\n"
+    puts "    Update detected in #{file_name}"
+    puts "    To see live updates, go to #{url}"
+    puts "    To stop sharing updates, press 'ctrl + c'"
+    puts "\n"
+  end
+
+  def display_intro_message(file_name, url)
+    puts "\n"
+    puts "    Now listening to changes in #{file_name}"
+    puts "    To see live updates, go to #{url}"
+    puts "    To stop sharing updates, press 'ctrl + c'"
+    puts "\n"
+  end
+
+  def display_help_info
+    puts "\n"
+    puts "    To use codefusion:"
+    puts "        1. cd into directory with file you want to watch"
+    puts "        2. type '$ fusion <file_name>'"
+    puts "        3. if the file name is valid, fusion will start watching the file for updates and display the URL to go to for updates"
+    puts "        4. to end the process, press 'ctrl + c'"
+    puts "\n"
+  end
+end

data/lib/codefusion/watch_file.rb

@@ -0,0 +1,20 @@
+class WatchFile
+  attr_reader :name, :full_path, :content
+
+  def initialize(filename) #refactor: use actual Ruby file objects so that fusion command supports path-completion in ARGV
+    @name = filename
+    @full_path = Dir.pwd + "/" + @name
+    @content = read_file
+  end
+
+  def update
+    @content = read_file
+  end
+
+  private
+
+  def read_file
+    return File.read(@full_path)
+  end
+
+end

data/spec/application_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Application do
+  before :each do
+    @application = Application.new(["fun"])
+  end
+
+  it "instatiates a new instance" do
+    expect( @application ).to_not eq(nil)
+  end
+
+  it "instatiates with args" do
+    expect( @application.args ).to eq(["fun"])
+  end
+
+  it "instatiates with a view" do
+    expect( @application.view ).to_not eq(nil)
+  end
+
+  it "creates a new classroom if passed valid arguments" do
+    expect( @application.classroom ).to_not eq(nil)
+  end
+
+  it "creates a new listener if passed valid arguments" do
+    expect( @application.listener ).to_not eq(nil)
+  end
+end

data/spec/classroom_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Classroom do
+  before(:each) do
+    @room = Classroom.new(WatchFile.new('README.md'))
+  end
+
+  it "responds to a method called 'code' " do
+    @room.code.should_not be_nil
+  end
+
+  xit "responds to a method called 'root_dir_path' " do
+    @room.root_dir_path.should_not be_nil
+  end
+
+  it "responds to a method called 'file' " do
+    @room.file.should_not be_nil
+  end
+
+  it "returns a WatchFile object when 'file' method is called" do
+    @room.file.should be_a WatchFile
+  end
+
+  context "@room_uuid" do
+    xit "has an instance variable room_uuid" do
+      expect
+    end
+  end
+
+end

data/spec/firebase_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Firebase do
+  it "is a module" do
+    expect(Firebase).to be_a Module
+  end
+
+  context "#create" do
+    it "responds" do
+      expect(Firebase.create).to_not be_nil
+    end
+  end
+
+  context "#update" do
+    it "responds" do
+      expect(Firebase.update).to_not be_nil
+    end
+  end
+
+end

data/spec/listener_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Listener do
+  before :each do
+    File.new( 'new_gem_test_file.txt', 'w+' )
+    @classroom = double(Classroom)
+    @classroom.stub(:get_file_name) { 'new_gem_test_file.txt' }
+    @classroom.stub(:get_dir) { Dir.pwd }
+    @classroom.stub(:update) { puts "file changed" }
+    @view = double(View)
+    @listener = Listener.new()
+    @listener.stub(:sleep) { sleep(3) }
+  end
+
+  after :each do
+    File.delete('new_gem_test_file.txt')
+  end
+
+  it "instatiates a new instance" do
+    expect( @listener).to_not eq(nil)
+  end
+
+  xit "calls update on the classroom on file change" do
+    @listener.start(@classroom, @view)
+    File.open('new_gem_test_file.txt', 'w+') { |f| f.write("test text") }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'codefusion'
+
+RSpec.configure do |config|
+end

data/spec/watch_file_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe WatchFile do
+  before(:each) do
+    @watch_file = WatchFile.new('README.md')
+  end
+
+  context "#name" do
+    it "responds to a method called 'name' " do
+      @watch_file.name.should_not be_nil
+    end
+  end
+
+  context "#full_path" do
+    it "responds to a method called 'full_path' " do
+      @watch_file.full_path.should_not be_nil
+    end
+  end
+
+  context "#content" do
+    it "responds to a method called 'content' " do
+      @watch_file.content.should_not be_nil
+    end
+
+    it "returns a String object when 'content' is called" do
+      @watch_file.content.should be_a String
+    end
+
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: codefusion
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Stavis, Ben Myhre, Drew West, Aaron Wertman, James Hulley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Run the fusion command line executable to start a live coding session
+  that can be watched by anyone who has the url printed to the command line.
+email:
+- drewfwest@gmail.com
+executables:
+- fusion
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/fusion
+- codefusion.gemspec
+- lib/codefusion.rb
+- lib/codefusion/classroom.rb
+- lib/codefusion/firebase.rb
+- lib/codefusion/listener.rb
+- lib/codefusion/version.rb
+- lib/codefusion/view.rb
+- lib/codefusion/watch_file.rb
+- spec/application_spec.rb
+- spec/classroom_spec.rb
+- spec/firebase_spec.rb
+- spec/listener_spec.rb
+- spec/spec_helper.rb
+- spec/watch_file_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Allows teachers to stream copies of their code to many students, live.
+test_files:
+- spec/application_spec.rb
+- spec/classroom_spec.rb
+- spec/firebase_spec.rb
+- spec/listener_spec.rb
+- spec/spec_helper.rb
+- spec/watch_file_spec.rb