germinate-gist 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2009-07-15
+
+* 1 major enhancement
+  * Birthday!

data/README.txt

@@ -0,0 +1,67 @@
+= germinate-gist
+
+by Avdi Grimm
+
+http://github.com/devver/germinate-gist/
+
+== DESCRIPTION
+
+A Germinate plugin for publishing source code to the Gist service (http://gist.github.com)
+
+See Germinate: http://github.com/devver/germinate/
+
+== FEATURES
+
+* Uses your global github.user/github.token config variables
+* Updates the source file with the Gist ID
+* Publishing again will update the same Gist, won't start a new one
+
+== SYNOPSIS:
+
+  $ cat my_article.rb
+  # :PUBLISHER: source, gist
+  # This is my awesome article
+  puts "Hello, world"
+
+  $ germ publish source my_article.rb
+  INFO -- germinate: Gist published at http://gist.github.com/12345
+
+  $ echo " # more text..." >> my_article.rb
+  $ germ publish source my_article.rb
+  INFO -- germinate: Gist http://gist.github.com/12345 updated
+
+
+== REQUIREMENTS:
+
+* Nokogiri
+* schacon-git
+* RestClient
+
+== INSTALL:
+
+* sudo gem install devver-germinate-gist --source http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009
+
+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/Rakefile

@@ -0,0 +1,44 @@
+require 'rubygems'
+
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+
+require 'germinate'
+require 'germinate/publisher'
+require 'germinate-gist'
+
+task :default => 'spec:run'
+
+PROJ.name = 'germinate-gist'
+PROJ.authors = 'Avdi Grimm'
+PROJ.email = 'avdi@avdi.org'
+PROJ.url = 'http://github.com/devver/germinate-gist/'
+PROJ.version = GerminateGist::VERSION
+PROJ.rubyforge.name = 'germinate-gist'
+PROJ.ignore_file = '.gitignore'
+
+PROJ.spec.opts << '--color'
+
+PROJ.ruby_opts = []
+
+depend_on 'nokogiri',    '~> 1.2.3'
+depend_on 'schacon-git', '~> 1.1.1'
+depend_on 'rest_client', '~> 1.0.3'
+
+PROJ.spec.opts << '--color'
+
+# EOF

data/bin/germinate-gist

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib germinate-gist]))
+
+# Put your code here
+
+# EOF

data/germinate-gist.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{germinate-gist}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Avdi Grimm"]
+  s.date = %q{2009-07-20}
+  s.default_executable = %q{germinate-gist}
+  s.description = %q{A Germinate plugin for publishing source code to the Gist service (http://gist.github.com)  See Germinate: http://github.com/devver/germinate/}
+  s.email = %q{avdi@avdi.org}
+  s.executables = ["germinate-gist"]
+  s.extra_rdoc_files = ["History.txt", "README.txt", "bin/germinate-gist"]
+  s.files = ["History.txt", "README.txt", "Rakefile", "bin/germinate-gist", "lib/germinate-gist.rb", "lib/germinate-gist/errors.rb", "lib/germinate-gist/gist_publisher.rb", "lib/germinate_plugin_v0_init.rb", "spec/germinate-gist/gist_publiser_spec.rb", "spec/germinate-gist/gist_publisher.rb", "spec/germinate-gist_spec.rb", "spec/spec_helper.rb", "tasks/ann.rake", "tasks/bones.rake", "tasks/gem.rake", "tasks/git.rake", "tasks/notes.rake", "tasks/post_load.rake", "tasks/rdoc.rake", "tasks/rubyforge.rake", "tasks/setup.rb", "tasks/spec.rake", "tasks/svn.rake", "tasks/test.rake", "tasks/zentest.rake", "test/test_germinate-gist.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/devver/germinate-gist/}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{germinate-gist}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A Germinate plugin for publishing source code to the Gist service (http://gist}
+  s.test_files = ["test/test_germinate-gist.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.2.3"])
+      s.add_runtime_dependency(%q<schacon-git>, ["~> 1.1.1"])
+      s.add_runtime_dependency(%q<rest_client>, ["~> 1.0.3"])
+      s.add_development_dependency(%q<bones>, [">= 2.5.1"])
+    else
+      s.add_dependency(%q<nokogiri>, ["~> 1.2.3"])
+      s.add_dependency(%q<schacon-git>, ["~> 1.1.1"])
+      s.add_dependency(%q<rest_client>, ["~> 1.0.3"])
+      s.add_dependency(%q<bones>, [">= 2.5.1"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, ["~> 1.2.3"])
+    s.add_dependency(%q<schacon-git>, ["~> 1.1.1"])
+    s.add_dependency(%q<rest_client>, ["~> 1.0.3"])
+    s.add_dependency(%q<bones>, [">= 2.5.1"])
+  end
+end

data/lib/germinate-gist.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+
+module GerminateGist
+
+  # :stopdoc:
+  VERSION = '1.0.0'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+end  # module GerminateGist
+
+GerminateGist.require_all_libs_relative_to(__FILE__)
+
+# EOF

data/lib/germinate-gist/errors.rb

@@ -0,0 +1,16 @@
+module GerminateGist
+  class UserError < RuntimeError
+  end
+
+  class GithubConfigError < UserError
+    MESSAGE = <<END
+No global Github config found.  See
+http://github.com/blog/180-local-github-config for how to set up your login and
+token.
+END
+
+    def initialize(message=MESSAGE)
+      super
+    end
+  end
+end

data/lib/germinate-gist/gist_publisher.rb

@@ -0,0 +1,96 @@
+require 'git'
+require 'rest_client'
+require 'pathname'
+require 'nokogiri'
+
+class GerminateGist::GistPublisher < Germinate::Publisher
+  identifier "gist"
+
+  GISTS_URL         = 'http://gist.github.com/gists'
+  NEW_GIST_URL      = 'http://gist.github.com/api/v1/xml/new'
+  EXISTING_GIST_URL = 'http://gist.github.com/api/v1/xml/'
+  PUBLIC_GIST_URL   = 'http://gist.github.com/'
+
+  def initialize(name, librarian, options={})
+    @resource_class = options.delete(:resource_class) { RestClient::Resource }
+    super
+    @git = Git.init
+    self.selector = "$SOURCE"
+  end
+
+  def publish!(output, extra_options={})
+    if librarian.variables.key?('GIST_ID')
+      put_gist!(librarian.variables['GIST_ID'])
+    else
+      post_gist!
+    end
+
+  rescue RestClient::ExceptionWithResponse => error
+    log.error "Error posting to gist: #{error.message}"
+    log.debug "Response from Gist: #{error.response.message}\n#{error.response.body}"
+    raise UserError, error.message
+  end
+
+  def github_login
+    @git.config('github.user') or raise GerminateGist::GithubConfigError
+  end
+
+  def github_token
+    @git.config('github.token') or raise GerminateGist::GithubConfigError
+  end
+
+  private
+
+  def source_path
+    Pathname(input.source_path)
+  end
+
+  def extname
+    source_path.extname.to_s
+  end
+
+  def basename
+    source_path.basename.to_s
+  end
+
+  def gist_data
+    {
+      'file_ext' => {
+        basename => extname
+      },
+      'file_name' => {
+        basename => basename
+      },
+      'file_contents' => {
+        basename => input.join
+      },
+      'login'                       => github_login,
+      'token'                       => github_token
+    }
+  end
+
+  def post_gist!
+    gists = @resource_class.new(NEW_GIST_URL)
+    response = gists.post(gist_data)
+    log.debug "Gist Response:\n#{response}"
+    gist_id = extract_gist_id(response)
+    log.info "Gist published at #{gist_public_url(gist_id)}"
+    librarian.variables['GIST_ID'] = gist_id
+  end
+
+  # See http://support.github.com/discussions/gist/65-update-gists-in-the-api
+  def put_gist!(gist_id)
+    gist = @resource_class.new('http://gist.github.com/gists/' + gist_id)
+    response = gist.put(gist_data)
+    log.debug "Gist PUT response:\n#{response}"
+    log.info "Gist #{gist_public_url(gist_id)} updated"
+  end
+
+  def extract_gist_id(response)
+    Nokogiri::XML.parse(response).xpath('//repo').first.content
+  end
+
+  def gist_public_url(gist_id)
+    PUBLIC_GIST_URL + gist_id
+  end
+end

data/lib/germinate_plugin_v0_init.rb

@@ -0,0 +1 @@
+require 'germinate-gist'

data/spec/germinate-gist/gist_publiser_spec.rb

@@ -0,0 +1,161 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+module GerminateGist
+  describe GistPublisher do
+    before :each do
+      @git       = stub("Git")
+      @hunk      = Germinate::Hunk.new(["line 1\n", "line 2\n"])
+      @contents  = "line 1\nline 2\n"
+      @variables = {}
+      @librarian = stub("Librarian", 
+        :[]            => @hunk, 
+        :make_pipeline => lambda{|x|x},
+        :variables     => @variables)
+      @output    = stub("Output")
+      @hunk.stub!(:source_path).and_return("/some/path/my_article.c")
+      @post_response = <<'END'
+<?xml version="1.0" encoding="UTF-8"?>
+<gists type="array">
+  <gist>
+    <public type="boolean">true</public>
+    <description nil="true"></description>
+    <repo>12345</repo>
+    <created-at type="datetime">2008-08-06T13:30:32-07:00</created-at>
+  </gist>
+</gists>
+END
+      @gists     = stub("Gists Resource", :post => @post_response)
+      @gist      = stub("Single Gist Resource", :put => @post_response)
+      @gist_id   = "54321"
+      @resource_class = stub("Resource Class")
+      Git.stub!(:init).and_return(@git)
+      @resource_class.stub!(:new).and_return(@gists)
+    end
+
+    it "should be a kind of Publisher" do
+      GistPublisher.should be < Germinate::Publisher
+    end
+
+    it "should identify itself as 'gist'" do
+      GistPublisher.identifier.should == "gist"
+    end
+
+    context "given a name and a librarian" do
+      before :each do
+        @it = GistPublisher.new("source", @librarian, {:resource_class => @resource_class})
+      end
+
+      it "should know its own name" do
+        @it.name.should == "source"
+      end
+
+      it "should have a default selector of $SOURCE" do
+        @it.selector.should == "$SOURCE"
+      end
+    end
+
+    context "given a global git config" do
+
+      before :each do
+        @git = stub("Git")
+        @git.stub!(:config).with('github.user').and_return("johnq")
+        @git.stub!(:config).with('github.token').and_return("abcde")
+        Git.stub!(:init).and_return(@git)
+        
+        @it = GistPublisher.new("source", @librarian, {:resource_class => @resource_class})
+      end
+      
+      it "should know the user's github login" do
+        @it.github_login.should == "johnq"
+      end
+
+      it "should know the user's github token" do
+        @it.github_token.should == "abcde"
+      end
+
+      context "publishing" do
+        it "should be able to post a new gist" do
+          @gists.should_receive(:post).
+            with(
+            {
+              'file_ext' => {
+                'my_article.c' => '.c'
+              },
+              'file_name' => {
+                'my_article.c' => 'my_article.c',
+              },
+              'file_contents' => {
+                'my_article.c' => "line 1\nline 2\n"
+              },
+              'login'                       => 'johnq',
+              'token'                       => 'abcde'
+            })
+          @it.publish!(@output)
+        end
+
+        it "should save the published gist ID in a variable" do
+          @variables.should_receive(:[]=).with('GIST_ID', '12345')
+          @it.publish!(@output)
+        end
+      end
+    end
+
+    context "given a pre-existing gist" do
+      before :each do
+        @git = stub("Git")
+        @git.stub!(:config).with('github.user').and_return("johnq")
+        @git.stub!(:config).with('github.token').and_return("abcde")
+        Git.stub!(:init).and_return(@git)
+        @resource_class = stub("Resource Class")
+        @it = GistPublisher.new("source", @librarian, {:resource_class => @resource_class})
+        @variables['GIST_ID'] = '54321'
+      end
+
+      context "on publish" do
+        it "should update the pre-exsting gist" do
+          @resource_class.should_receive(:new).
+            with("http://gist.github.com/gists/#{@gist_id}").
+            and_return(@gist)
+
+          @gist.should_receive(:put).with(
+            {
+              'file_ext' => {
+                'my_article.c' => '.c'
+              },
+              'file_name' => {
+                'my_article.c' => 'my_article.c',
+              },
+              'file_contents' => {
+                'my_article.c' => "line 1\nline 2\n"
+              },
+              'login'                       => 'johnq',
+              'token'                       => 'abcde'
+            })
+          @it.publish!(@output)
+        end
+      end
+    end
+
+    context "given no global github user config" do
+
+      before :each do
+        @git.stub!(:config).with('github.user').and_return(nil)
+        @git.stub!(:config).with('github.token').and_return(nil)
+        @it = GistPublisher.new("source", @librarian, {:resource_class => @resource_class})
+      end
+      
+      it "should fail fast trying to access github login" do
+        lambda do
+          @it.github_login
+        end.should raise_error(GithubConfigError)
+      end
+
+      it "should fail fast trying to access github token" do
+        lambda do
+          @it.github_token
+        end.should raise_error(GithubConfigError)
+      end
+
+    end
+  end
+end