hubload 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Hunter Gillane
+
+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.rdoc

@@ -0,0 +1,76 @@
+= Hubload
+Parses post-receive payloads from GitHub
+
+== Install
+
+One day I will get around to packaging this up as a gem. For now, I guess you can just clone it.
+
+== Usage
+
+To use a post-receive hook for your repo, you'll need to go into the admin section (or ask someone that has access to it) and click on Post-Receive URLs. See http://help.github.com/post-receive-hooks/ for more on setting one up.
+
+Largely, this just parses and wraps the values sent from GitHub. However, it adds a couple convenience methods as well for formatting and more intuitive naming( ie - private? method for a repo, etc).
+
+When any commits are pushed to that repo, GitHub will wrap up the commit info in a JSON payload and POST it to the URL you specify. At your post-receive URL, you'll then be able to parse the payload:
+
+  @parsed_load = Hubload.new(params[:payload])
+
+This will give you a Hubload object, which has references to the commits details, namely: before, after, ref, repo, and commits.
+
+=== Ref
+  ref = @parsed_load.ref # => Hubload::Ref object
+  ref.value # => 'refs/heads/master' (or whatever branch)
+
+
+=== After / Before
+
+  before = @parsed_load.before # => Hubload::After object
+  before.value # => 027fa2043b65e7d4092ba310966980db5d36a265
+
+  after = @parsed_load.after # => Hubload::After object
+  after.value # => 027fa2043b65e7d4092ba310966980db5d36a264
+
+=== Repo
+
+You also get info about the commit's repo
+
+  repo = @parsed_load.repo # => Hubload::Repo object
+
+Check out the source for all the info provided by Hubload::Repo. A few examples:
+
+  repo.fork? # => false
+  repo.publicly_visible? # => true
+  repo.owner # => Hunter Gillane
+
+=== Commits
+GitHub's post-receive payload can potentially more than one commit. For that reason you'll get an array of commits in the payload.
+
+  commits = @parsed_load.commits # => Hubload::Commit []
+
+Here are some of the methods available for a single commit:
+
+  commit_1 = commits[0]
+  commit_1.pretty_time # => "07:48 PM"
+  commit_1.pretty_date # => "Jan 1, 2010"
+  commit_1.message => "added some stuff"
+
+etc.
+
+== One More Thing
+
+Enjoy!
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Hunter Gillane. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "hubload"
+    gemspec.summary = "Parses post-receive payloads from GitHub"
+    gemspec.description = "Parses post-receive payloads from GitHub"
+    gemspec.email = "hunter.gillane@gmail.com"
+    gemspec.homepage = "http://github.com/pinecon3/hubload"
+    gemspec.authors = ["Hunter Gillane"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ["--color"]
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/hubload.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'json'
+require 'pathname'
+
+dir = Pathname(__FILE__).dirname.expand_path
+
+class Hubload
+
+  attr_accessor :ref, :before, :after, :repo, :commits
+
+  def initialize(payload)
+    load_data = JSON.parse(payload)
+    @ref = Hubload::Ref.new(load_data['ref'])
+    @before = Hubload::Before.new(load_data['before'])
+    @after = Hubload::After.new(load_data['after'])
+    @repo = Hubload::Repo.new(load_data['repository'])
+    @commits = parse_commits(load_data['commits'])
+  end
+  
+  def parse_commits(commits)
+    payload_commits = []
+    commits.each do |c|
+      payload_commits << Commit.new(c)
+    end
+    payload_commits
+  end
+  
+  private :parse_commits
+end
+
+require dir + 'hubload/ref'
+require dir + 'hubload/before'
+require dir + 'hubload/after'
+require dir + 'hubload/repo'
+require dir + 'hubload/commit'

data/lib/hubload/after.rb

@@ -0,0 +1,9 @@
+class Hubload
+  class After
+    attr_accessor :value
+    
+    def initialize(val)
+      @value = val
+    end
+  end
+end

data/lib/hubload/before.rb

@@ -0,0 +1,9 @@
+class Hubload
+  class Before
+    attr_accessor :value
+    
+    def initialize(val)
+      @value = val
+    end
+  end
+end

data/lib/hubload/commit.rb

@@ -0,0 +1,49 @@
+require 'time'
+
+class Hubload
+  class Commit
+
+    attr_accessor :message, :commit_id, :timestamp, :url, :author, :modified_files,
+                  :removed_files, :added_files
+
+    def initialize(commit)
+      @message = commit['message']
+      @commit_id = commit['id']
+      @timestamp = commit['timestamp']
+      @url = commit['url']
+      @author = Hubload::Commit::Author.new(commit['author']['name'], 
+                                            commit['author']['email'])
+      @modified_files = commit['modified']
+      @removed_files = commit['removed']
+      @added_files = commit['added']
+    end
+
+    # Returns the commit's time in a nice format and normalizes
+    # AM and PM times
+    #  
+    def pretty_time
+      time = Time.parse(@timestamp)
+      if time.hour > 12
+        (time - 43200).strftime("%H:%M") << " PM"
+      else
+        time.strftime("%H:%M") << " AM"
+      end
+    end
+
+    # Returns the commit's date in a nice format
+    # Month Day, Year
+    def pretty_date
+      Date.parse(@timestamp).strftime("%b%e, %Y")
+    end
+
+    class Author
+      
+      attr_accessor :email, :name
+      
+      def initialize(name, email)
+        @name = name
+        @email = email
+      end
+    end
+  end
+end

data/lib/hubload/ref.rb

@@ -0,0 +1,9 @@
+class Hubload
+  class Ref
+    attr_accessor :value
+    
+    def initialize(ref)
+      @value = ref
+    end
+  end
+end

data/lib/hubload/repo.rb

@@ -0,0 +1,39 @@
+class Hubload
+  class Repo
+    
+    attr_accessor :forks, :description, :watchers, :open_issues, :url, :fork,
+                  :publicly_visible, :homepage, :owner, :name
+    
+    def initialize(repo)
+      @forks = repo['forks']
+      @description = repo['description']
+      @watchers = repo['watchers']
+      @open_issues = repo['open_issues']
+      @url = repo['url']
+      @fork = repo['fork']
+      @publicly_visible = !repo['private']
+      @homepage = repo['homepage']
+      @owner = Owner.new(repo['owner']['name'], repo['owner']['email'])
+      @name = repo['name']
+    end
+    
+    # Returns true if the repo is public, false otherwise
+    def publicly_visible?
+      @publicly_visible
+    end
+    
+    # Returns true if the repo is a fork, false otherwise
+    def fork?
+      @fork
+    end
+    
+    class Owner
+      attr_accessor :name, :email
+      
+      def initialize(name, email)
+        @name = name
+        @email = email
+      end
+    end
+  end
+end

data/spec/hubload_spec.rb

@@ -0,0 +1,174 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+describe Hubload do
+  describe "parse single commit payload" do
+    before(:each) do
+      @parsed_load = Hubload.new(single_commit_payload)
+    end
+    
+    describe "should parse the payload's ref" do
+      it "should return a Hubload::Ref object" do
+        @parsed_load.ref.class.should == Hubload::Ref
+      end
+    
+      it "should correctly parse the ref value" do
+        @parsed_load.ref.value.should == "refs/heads/master"
+      end
+    end
+    
+    describe "should parse the payload's before" do
+      it "should return a Hubload::Before object" do
+        @parsed_load.before.class.should == Hubload::Before
+      end
+      
+      it "should correctly parse the payload's before value" do
+        @parsed_load.before.value.should == "34891069f142cbfc80cc880e963b41a0104305c7"
+      end
+    end
+    
+    describe "should parse the payload's after" do      
+      it "should return a Hubload::After object" do
+        @parsed_load.after.class.should == Hubload::After
+      end
+      
+      it "should correctly parse the payload's after value" do
+        @parsed_load.after.value.should == "027fa2043b65e7d4092ba310966980db5d36a264"
+      end
+    end
+    
+    describe "should parse the payload's repository" do
+      it "should return a Hubload::Repo object" do
+        @parsed_load.repo.class.should == Hubload::Repo
+      end
+      
+      it "should parse the number of forks for the repo" do
+        @parsed_load.repo.forks.should == 0
+      end
+      
+      it "should parse the repo's descriptions" do
+        @parsed_load.repo.description.should == "just for testing"
+      end
+      
+      it "should parse the repo's watchers" do
+        @parsed_load.repo.watchers.should == 1
+      end
+      
+      it "should parse the repo's open issues" do
+        @parsed_load.repo.open_issues.should == 0
+      end
+      
+      it "should parse the repo's url" do
+        @parsed_load.repo.url.should == "http://github.com/hunt3131/post-receive-testing"
+      end
+      
+      it "should determine if this repo is a fork" do
+        @parsed_load.repo.fork?.should == false
+      end
+      
+      it "should parse the visibility of the repo" do
+        @parsed_load.repo.publicly_visible?.should == true
+      end
+      
+      it "should parse the repo's homepage" do
+        @parsed_load.repo.homepage.should == "http://homepage.net"
+      end
+      
+      it "should parse the repo's owner" do
+        @parsed_load.repo.owner.email.should == "hunter.gillane@gmail.com"
+        @parsed_load.repo.owner.name.should == "hunt3131"
+      end
+      
+      it "should parse the repo's name" do
+        @parsed_load.repo.name.should == "repo_1"
+      end
+    end
+    
+    describe "should parse the payloads single commit" do
+      it "should return an array of Hubload::Commit objects" do
+        commits = @parsed_load.commits
+        commits.each do |c|
+          c.class.should == Hubload::Commit
+        end
+      end
+
+      it "should return a commit array with size 1" do
+        @parsed_load.commits.size.should == 1
+      end
+      
+      describe "should correctly parse the values of the first commit" do
+      
+        before(:each) do
+          @commit = @parsed_load.commits[0]
+        end
+
+        it "should parse the commit's message" do
+          @commit.message.should == "a text file"
+        end
+        
+        it "should parse the commit's id" do
+          @commit.commit_id.should == "027fa2043b65e7d4092ba310966980db5d36a264"
+        end
+        
+        it "should parse the commit's timestamp" do
+          @commit.timestamp.should == "2010-01-03T19:48:03-08:00"
+        end
+        
+        describe "parsing the commits time and date" do
+          it "should return a formatted time for the commit" do
+            @commit.pretty_time.should == "07:48 PM"
+          end
+          
+          it "should return a formatted date for the commit" do
+            @commit.pretty_date.should == "Jan 3, 2010"
+          end
+        end
+        
+        it "should parse the commit's url" do
+          @commit.url.should == "http://github.com/hunt3131/post-receive-testing/commit/027fa2043b65e7d4092ba310966980db5d36a264"
+        end
+        
+        describe "it should parse the commit's author" do
+          it "return a Hubload::Commit::Author object" do
+            @commit.author.class.should == Hubload::Commit::Author
+          end
+          
+          it "should parse the author's name" do
+            @commit.author.name.should == "Hunter Gillane"
+          end
+          
+          it "should parse the author's email" do
+            @commit.author.email.should == "hunter.gillane@gmail.com"
+          end
+        end
+        
+        it "should create a list of the files changed" do
+          @commit.modified_files.should == ["modified_file_1.txt", "modified_file_2.txt"]
+        end
+        
+        it "should create a list of the files removed" do
+          @commit.removed_files.should == ["removed_file_1.txt", "removed_file_2.txt"]
+        end
+        
+        it "should create a list of the files added" do
+          @commit.added_files.should == ["new_file_1.txt", "new_file_2.txt"]
+        end
+      end
+    end
+  end
+  
+  describe "parse a multi-commit payload" do
+    before(:each) do
+      @parsed_load = Hubload.new(multi_commit_payload)
+      @commit_1 = @parsed_load.commits[0]
+      @commit_2 = @parsed_load.commits[1]
+    end
+    
+    it "should return an array of two commits" do
+      @parsed_load.commits.size.should == 2
+    end
+    
+    it "should return a unique commit id for both commits" do
+      @commit_1.commit_id.should_not == @commit_2.commit_id
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'hubload')
+
+def single_commit_payload
+  '{"commits":[{"removed":["removed_file_1.txt", "removed_file_2.txt"],"message":"a text file","modified":["modified_file_1.txt", "modified_file_2.txt"],"url":"http://github.com/hunt3131/post-receive-testing/commit/027fa2043b65e7d4092ba310966980db5d36a264","added":["new_file_1.txt", "new_file_2.txt"],"author":{"email":"hunter.gillane@gmail.com","name":"Hunter Gillane"},"timestamp":"2010-01-03T19:48:03-08:00","id":"027fa2043b65e7d4092ba310966980db5d36a264"}],"repository":{"forks":0,"description":"just for testing","watchers":1,"open_issues":0,"url":"http://github.com/hunt3131/post-receive-testing","fork":false,"private":false,"homepage":"http://homepage.net","owner":{"email":"hunter.gillane@gmail.com","name":"hunt3131"},"name":"repo_1"},"ref":"refs/heads/master","before":"34891069f142cbfc80cc880e963b41a0104305c7","after":"027fa2043b65e7d4092ba310966980db5d36a264"}'
+end
+
+def multi_commit_payload
+  '{"commits":[{"removed":["removed_file_1.txt", "removed_file_2.txt"],"message":"a text file","modified":["modified_file_1.txt", "modified_file_2.txt"],"url":"http://github.com/hunt3131/post-receive-testing/commit/027fa2043b65e7d4092ba310966980db5d36a264","added":["new_file_1.txt", "new_file_2.txt"],"author":{"email":"hunter.gillane@gmail.com","name":"Hunter Gillane"},"timestamp":"2010-01-03T19:48:03-08:00","id":"027fa2043b65e7d4092ba310966980db5d36a264"}, {"removed": [], "message": "second commit", "modified": [],"url": "http://github.com/hunt3131/post-receive-testing/commit/027fa2043b65e7d4092ba310966980db5d36a265","added": ["commit_2_file.txt" ], "author": { "email": "someoneelse@gmail.com", "name": "Some guy" }, "timestamp": "2010-01-03T19:48:03-09:00", "id": "027fa2043b65e7d4092ba310966980db5d36a265" }],"repository":{"forks":0,"description":"just for testing","watchers":1,"open_issues":0,"url":"http://github.com/hunt3131/post-receive-testing","fork":false,"private":false,"homepage":"http://homepage.net","owner":{"email":"hunter.gillane@gmail.com","name":"hunt3131"},"name":"repo_1"},"ref":"refs/heads/master","before":"34891069f142cbfc80cc880e963b41a0104305c7","after":"027fa2043b65e7d4092ba310966980db5d36a264"}'  
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: hubload
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Hunter Gillane
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-09 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Parses post-receive payloads from GitHub
+email: hunter.gillane@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/hubload.rb
+- lib/hubload/after.rb
+- lib/hubload/before.rb
+- lib/hubload/commit.rb
+- lib/hubload/ref.rb
+- lib/hubload/repo.rb
+- spec/hubload_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/pinecon3/hubload
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Parses post-receive payloads from GitHub
+test_files: 
+- spec/hubload_spec.rb
+- spec/spec_helper.rb