gasoline 0.0.1

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,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gasoline.gemspec
+gemspec
+
+group :test do
+  # minitest provides a complete suite of testing facilities...
+  # [minitest](https://github.com/seattlerb/minitest)
+  gem 'minitest', '~> 3.3.0'
+
+  # Adds color to your MiniTest output
+  gem "minitest-rg", "~> 1.0.0"
+
+  # [mocha](http://gofreerange.com/mocha/docs)
+  gem 'mocha', '~> 0.12.2'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 pjaspers
+
+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,21 @@
+# Gasoline makes Campfire better
+
+I'm an avid [Campfire](http://campfirenow.com) user and [Propane](http://propaneapp.com) is still my go to app for talking to it. At least on OSX, on iOS I'm using <plug>[Butane](http://getbutane.com)</plug>.
+
+Since Propane 1.1.2 they've added a way to add some javascript, to augment the experience even more. Like adding avatars:
+
+[Fancy screenshot](http://cl.ly/image/1r0T3h1q460I)
+
+The only downside to that approach was managing the file. So that's where Gasoline comes in. It's a gem that installs the command line utility `gasoline` which can download gists and append them to the patch file.
+
+## Installation
+
+`gem install gasoline`
+
+## Usage
+
+`gasoline ignite` will download the default drops and install them to the patch file.
+
+## Contributing
+
+Fork it! Improve it! Test it! Rewrite it! (technology)

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc 'Run Devise unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test
+
+desc "Open an pry session with Gasoline loaded"
+task :console do
+  sh "pry -I lib -r gasoline.rb"
+end

data/bin/gasoline

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'gasoline'
+
+Gasoline::CLI.start

data/example_drops.yml

@@ -0,0 +1,14 @@
+---
+:drops:
+- :name: Avatars
+  :url: https://gist.github.com/065d1dc1906c153e4edc
+  :description: Adds avatars to friendly faces
+- :name: Cloud App
+  :url: https://gist.github.com/431f7c803ddb0d751a40
+  :description: Adds support for Cloud.ly links
+- :name: Flickr
+  :url: https://gist.github.com/6dcf1366df5203157fda
+  :description: Adds support for Flickr links
+- :name: Instagram
+  :url: https://gist.github.com/3258692
+  :description: Instagram support

data/gasoline.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gasoline/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["pjaspers"]
+  gem.email         = ["piet@jaspe.rs"]
+  gem.description   = %q{Gasoline makes Campfire even brighter}
+  gem.summary       = %q{Gasoline aims to make managing the patch file easier.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "gasoline"
+  gem.require_paths = ["lib"]
+  gem.version       = Gasoline::VERSION
+
+  gem.add_runtime_dependency("thor", ["~> 0.15.4"])
+end

data/lib/gasoline/cli.rb

@@ -0,0 +1,39 @@
+require "thor"
+
+module Gasoline
+  # [thor](http://github.com/wycats/thor)
+  class CLI < Thor
+    include Thor::Actions
+
+    map "-i" => :ignite
+    map "-a" => :add
+    map "-l" => :list
+    map "-c" => :config
+
+    desc "ignite", "Downloads and patches the file"
+    def ignite
+      Gasoline::Patchor.new.patch_it_chewie!
+      say_status :ok,  "I have patched the patch file"
+    end
+
+    desc "list", "-l, Current installed drops of gasoline"
+    def list
+      first_line = ["Currently using these drops of gasoline:"]
+      installed_drops = Gasoline::Patchor.new.drops.collect(&:to_s)
+      say (first_line + installed_drops).join("\n\t- ")
+    end
+
+    desc "add NAME URL description", "-a, Adds a drop to the config"
+    def add(name, url, description)
+      can = Gasoline::Jerrycan.new
+      can.add_drops([{:name => name, :url => url, :description => description}])
+      can.save
+      say "Added #{name} - #{url}"
+    end
+
+    desc "config", "-c, Shows current config"
+    def config
+      say File.open(Gasoline::Jerrycan::YAML_FILE).read
+    end
+  end
+end

data/lib/gasoline/drop.rb

@@ -0,0 +1,80 @@
+module Gasoline
+  # A drop of Gasoline is a glorified hash that knows how to
+  # retrieve the javascript needed to make the Campfire even
+  # shinier.
+  #
+  # Since Github's gists are pretty much the easiest way to
+  # share pieces of code, Drop uses them for all things JS.
+  class Drop
+
+    attr_accessor :name, :url, :description
+
+    def initialize(name, url, description)
+      @name = name
+      @url = url
+      @description = description
+    end
+
+    def to_s
+      "%s: %s" % [@name, @description]
+    end
+
+    def to_hash
+      {:name => @name, :url => @url, :description => @description}
+    end
+
+    # Takes the hash as usually found in the Jerrycan and
+    # creates a drop from it.
+    #
+    # Returns a Drop
+    def self.new_from_yml(hash)
+      new(hash[:name], hash[:url], hash[:description])
+    end
+
+    # Returns the raw url for the specified gist
+    def raw_gist_url
+      @url.gsub("gist.github.com/", "raw.github.com/gist/")
+    end
+
+    # Returns the javascript from the gist URL.
+    def download_content
+      puts "Downloading #{@name} (#{@url})"
+      open(raw_gist_url).read
+    end
+
+    # The header that will be displayed above the drop in the
+    # patched file.
+    #
+    # Returns a String
+    def header
+  <<HEADER
+/*
+ * #{@name}
+ * #{@description}
+ *
+ */
+HEADER
+end
+
+    # Fetches the JS content and adds a header to it, ready to be
+    # inserted in the patchor file.
+    #
+    # force_refresh - true will redownload the JS
+    #
+    # Returns a String
+    def patch(force_refresh = false)
+      @js ||= download_content
+      @js = download_content if force_refresh
+
+      <<PATCH
+
+#{header}
+#{@js}
+
+
+PATCH
+    end
+
+  end
+
+end

data/lib/gasoline/jerrycan.rb

@@ -0,0 +1,88 @@
+module Gasoline
+  # Gasoline drops are stored in a Jerrycan (safety first), in this case
+  # it is disguised as a yaml file, stored in the users' home folder.
+  #
+  # Not directly in the home folder but in the `.config/gasoline` folder,
+  # since [Rob doesn't like them there](https://plus.google.com/101960720994009339267/posts/R58WgWwN9jp)
+  # and he seems to know this UNIX thingie.
+
+  class Jerrycan
+    YAML_FILE = "#{ENV['HOME']}/.config/gasoline/drops.yml"
+
+    attr_writer :drops
+
+    def initialize
+      @drops = []
+      bootstrap
+      add_drops(YAML.load_file(yaml_file)[:drops]) rescue nil
+    end
+
+    # Adds a drop of gasoline to the jerrycan
+    #
+    # drop - A Gasoline::Drop instance
+    #
+    # Returns the current list of drops
+    def add_drop(drop)
+      @drops << drop
+    end
+
+    # Takes an array of hashes and fills the can with `Drop`s
+    #
+    # Hash should be:
+    #       {:name => "k", :url => "url", :description => "desc"}
+    #
+    # Returns nothing
+    def add_drops(array)
+      array.each do |h|
+        add_drop Gasoline::Drop.new_from_yml(h)
+      end
+    end
+
+    def yaml_file
+      YAML_FILE
+    end
+
+    # Will create the config file (if needed)
+    def bootstrap
+      return if File.exist?(yaml_file)
+
+      FileUtils.mkdir_p(File.split(yaml_file).first)
+      FileUtils.cp(example_config, yaml_file)
+    end
+
+    def example_config
+      File.join(File.dirname(__FILE__), "../../example_drops.yml")
+    end
+
+    # All the `Drop`s in this Jerrycan.
+    #
+    # Returns an array of `Drop`s
+    def drops
+      @drops
+    end
+
+    # Goes through all the drops and squeezes a hash out of them
+    # then cunningly makes a yaml out of those.
+    #
+    # Returns a yaml (as a String)
+    def to_yaml
+      {:drops => drops.collect(&:to_hash)}.to_yaml
+    end
+
+    # Writes the can to the yaml config file.
+    def save
+      File.open(yaml_file, 'w') {|f| f.write(to_yaml) }
+    end
+
+    # Mainly used to quickly load the hash I used previously back
+    # when this was just a onefile script. Those were the days.
+    #
+    # Returns a Jerrycan
+    def self.load_from_array(array)
+      can = new
+      can.add_drops(array)
+      can
+    end
+
+  end
+end

data/lib/gasoline/patchor.rb

@@ -0,0 +1,90 @@
+module Gasoline
+  # The Patchor will do all the patching on the Propane support
+  # file, it finds (and creates if needed) the file, adds the
+  # Propane header, and then adds all the drops from the jerrycan.
+  class Patchor
+    PATCHOR_FILE = "#{ENV['HOME']}/Library/Application Support/Propane/unsupported/caveatPatchor.js"
+
+    def initialize
+      @lines = []
+      bootstrap
+      load_lines
+    end
+
+    def patchor_file
+      PATCHOR_FILE
+    end
+
+    # Will create the Propane, caveatPatchor.js file
+    def bootstrap
+      return if File.exist?(patchor_file)
+
+      FileUtils.mkdir_p(File.split(patchor_file).first)
+      FileUtils.touch(patchor_file)
+      File.open(patchor_file, "w") do |f|
+        f.write(Gasoline::Texts::propane_header)
+      end
+    end
+
+    # Current lines in memory
+    #
+    # Returns an array of lines
+    def lines
+      @lines
+    end
+
+    # Loads the entire file into memory
+    def load_lines
+      @lines = File.readlines(patchor_file)
+    end
+
+    # The index of the line matching the cut snippet, if it can't
+    # be found we'll take the last line.
+    #
+    # Returns an int
+    def cut_line_index
+      @lines.find_index{|line| line =~ /#{Gasoline::Texts::cut_here_line}/} || @lines.length
+    end
+
+    # An instance of the Jerrycan, mainly added to have quick
+    # access to it, while developing.
+    #
+    # Returns a `Jerrycan` instance
+    def jerrycan
+      @jerrycan ||= Gasoline::Jerrycan.new
+    end
+
+    # The contents of our Jerrycan, laid bare to be patched.
+    #
+    # Returns an array of `Drop`s
+    def drops
+      jerrycan.drops
+    end
+
+    # Transform the @lines to have:
+    #
+    #     1. All the lines above the cut
+    #     2. The cut here snippet
+    #     3. All patches from the drops. (will download them)
+    #
+    # Returns an array of lines
+    def patch_it_chewie
+      to_keep = @lines[0...cut_line_index]
+      snippet = [Gasoline::Texts::cut_here_snippet]
+      to_add = drops.collect {|d| d.patch}
+      @lines = (to_keep + snippet + to_add)
+    end
+
+    # First fills up the @lines instance, then saves the file
+    def patch_it_chewie!
+      patch_it_chewie
+      save
+    end
+
+    # Writes the file to disk.
+    def save
+      File.open("file.tmp", "w") {|f| f.write(@lines.join(""))}
+      FileUtils.mv("file.tmp", patchor_file)
+    end
+  end
+end

data/lib/gasoline/texts.rb

@@ -0,0 +1,41 @@
+module Gasoline
+  module Texts
+    class << self
+      def cut_here_line
+        "_.:Gasoline Snippet:._"
+      end
+
+      def cut_here_snippet
+        <<SNIPPET
+//#{cut_here_line}
+//
+// Anything below this line will be replaced by the gasoline gem.
+//
+
+SNIPPET
+      end
+
+      def propane_header
+        <<HEADER
+/*
+ As of version 1.1.2, Propane will load and execute the contents of
+ ~Library/Application Support/Propane/unsupported/caveatPatchor.js
+ immediately following the execution of its own enhancer.js file.
+
+ You can use this mechanism to add your own customizations to Campfire
+ in Propane.
+
+ 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.
+ */
+
+HEADER
+      end
+    end
+  end
+end

data/lib/gasoline/version.rb

@@ -0,0 +1,3 @@
+module Gasoline
+  VERSION = "0.0.1"
+end

data/lib/gasoline.rb

@@ -0,0 +1,14 @@
+require "fileutils"
+require 'open-uri'
+require "yaml"
+
+require "gasoline/version"
+require "gasoline/jerrycan"
+require "gasoline/drop"
+require "gasoline/patchor"
+require "gasoline/texts"
+require "gasoline/cli"
+
+module Gasoline
+
+end

data/test/drop_test.rb

@@ -0,0 +1,63 @@
+require "helper"
+
+describe Gasoline::Drop do
+
+  describe "basic setup" do
+    before do
+      @drop = Gasoline::Drop.new("Fire", "http://water.com", "Burn")
+    end
+
+    it "should have a name" do
+      assert_equal "Fire", @drop.name
+    end
+
+    it "should have a url" do
+      assert_equal "http://water.com", @drop.url
+    end
+
+    it "should have a description" do
+      assert_equal "Burn", @drop.description
+    end
+  end
+
+  describe "loading from hash" do
+    before do
+      @h = {
+      :name => "Fire",
+      :url => "http://water.com",
+      :description => "Desc"
+      }
+      @drop = Gasoline::Drop.new_from_yml(@h)
+    end
+
+    [:name, :url, :description].each do |s|
+      it "should have a #{s}" do
+        assert_equal @h[s], @drop.send(s)
+      end
+    end
+  end
+
+  describe "getting the content" do
+    before do
+      @url = "https://gist.github.com/3258692"
+      @drop = Gasoline::Drop.new("xyz", @url, "zyx")
+    end
+
+    it "should get the raw gist url" do
+      assert_equal "https://raw.github.com/gist/3258692", @drop.raw_gist_url
+    end
+
+    it "should set header with name" do
+      assert_match "xyz", @drop.header
+    end
+
+    it "should set header with description" do
+      assert_match "zyx", @drop.description
+    end
+
+    it "should try to download when asked for patch" do
+      @drop.expects(:download_content).returns("ZE JS CONTENT")
+      assert_match "ZE JS", @drop.patch
+    end
+  end
+end

data/test/example_drops.yml

@@ -0,0 +1,4 @@
+:drops:
+- :name: Sounds
+  :url: https://gist.github.com/686d56fcc7d7081232c6
+  :description: Adds some extra sounds to Campfire

data/test/helper.rb

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+require "minitest/autorun"
+require "mocha"
+
+begin
+  # [turn](http://rubygems.org/gems/turn)
+  require 'turn/autorun'
+rescue LoadError
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'gasoline'

data/test/jerrycan_test.rb

@@ -0,0 +1,25 @@
+require "helper"
+
+describe Gasoline::Jerrycan do
+
+  before do
+    Gasoline::Jerrycan.any_instance.stubs(:save).returns(true)
+    Gasoline::Jerrycan.any_instance.stubs(:bootstrap).returns(true)
+    yaml = File.join(File.dirname(__FILE__), "example_drops.yml")
+    Gasoline::Jerrycan.any_instance.stubs(:yaml_file).returns(yaml)
+  end
+
+  describe "loading drops" do
+    before do
+      @jerry = Gasoline::Jerrycan.new
+    end
+
+    it "should load drops from config file on init" do
+      assert_equal 1, @jerry.drops.count
+    end
+
+    it "should load name for drops from config" do
+      assert_equal "Sounds", @jerry.drops.first.name
+    end
+  end
+end

data/test/patchor_test.rb

@@ -0,0 +1,38 @@
+require "helper"
+
+describe Gasoline::Patchor do
+
+  before do
+    Gasoline::Patchor.any_instance.stubs(:save).returns(true)
+    Gasoline::Patchor.any_instance.stubs(:bootstrap).returns(true)
+
+    js = File.join(File.dirname(__FILE__), "patchor.js")
+    Gasoline::Patchor.any_instance.stubs(:patchor_file).returns(js)
+  end
+
+  describe "loading patchor" do
+    before do
+      @patchor = Gasoline::Patchor.new
+    end
+
+    it "should load the js file into lines" do
+      assert @patchor.lines.count > 1
+    end
+
+  end
+
+  describe "patching the patch" do
+    before do
+      @patchor = Gasoline::Patchor.new
+      drop = mock()
+      drop.expects(:patch).returns("ZE PATCH")
+      @patchor.expects(:drops).returns([drop])
+    end
+
+    it "should download the patches and add them to lines" do
+      @patchor.patch_it_chewie
+      assert @patchor.lines.include?("ZE PATCH")
+    end
+
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: gasoline
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- pjaspers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+description: Gasoline makes Campfire even brighter
+email:
+- piet@jaspe.rs
+executables:
+- gasoline
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/gasoline
+- example_drops.yml
+- gasoline.gemspec
+- lib/gasoline.rb
+- lib/gasoline/cli.rb
+- lib/gasoline/drop.rb
+- lib/gasoline/jerrycan.rb
+- lib/gasoline/patchor.rb
+- lib/gasoline/texts.rb
+- lib/gasoline/version.rb
+- test/drop_test.rb
+- test/example_drops.yml
+- test/helper.rb
+- test/jerrycan_test.rb
+- test/patchor_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Gasoline aims to make managing the patch file easier.
+test_files:
+- test/drop_test.rb
+- test/example_drops.yml
+- test/helper.rb
+- test/jerrycan_test.rb
+- test/patchor_test.rb