githubapi.rb

#
# Copyright (c) 2013 zunda <zunda at freeshell.org>
#
# 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.
#

require 'open-uri'
require 'yajl'

# APIs referred from
# http://developer.github.com/v3/activity/events/types/
module GitHubApi
	# Error from JSON parser - code needs fixed
	class ParseError < StandardError; end

	# Error from reading JSON - impossible to fix
	class ReadError < StandardError; end

	class Base
		HOST = 'https://api.github.com'
		VERSION = '0.2.0'
		AGENT = "zundan@gmail.com - GitHubApi - #{VERSION}"
		ACCEPT = "application/vnd.github.v3+json"	# http://developer.github.com/v3/media/#beta-v3-and-the-future

		attr_reader :json_url
		attr_reader :js
		attr_accessor :timestamp

		# From GitHub API
		attr_reader :comment
		attr_reader :html_url

		# From parent JSON from GitHub Archive
		attr_accessor :location
		attr_accessor :avatar
		attr_accessor :type

		def initialize(json_url, opts = {auth: []})
			@json_url = json_url
			@auth = opts[:auth]
		end

		def read_and_parse
			begin
				@js = Yajl::Parser.parse(open(@json_url, 'User-Agent' => AGENT, :http_basic_authentication => @auth, 'Accept' => ACCEPT).read)
			rescue EOFError, Zlib::BufError, Errno::ECONNRESET, Net::ReadTimeout, Zlib::DataError => e
				message = "#{e.message} (#{e.class}) for #{@json_url} as #{self.class}"
				raise ReadError.new(message)
			rescue Yajl::ParseError => e
				message = "#{e.message} (#{e.class}) for #{@json_url} as #{self.class}"
				raise ParseError.new(message)
			end
			@timestamp = Time.parse(@js['created_at']) if @js['created_at']
		end
	end

	class SingleCommitComment < Base
		def initialize(owner, repo, comment_id, opts = {auth: []})
			super("#{HOST}/repos/#{owner}/#{repo}/comments/#{comment_id}", auth: opts[:auth])
		end

		def read_and_parse
			super
			@comment = @js['body']
			@html_url = @js['html_url']
		end
	end

	class Download < Base
		def initialize(owner, repo, id, opts = {auth: []})
			super("#{HOST}/repos/#{owner}/#{repo}/downloads/#{id}", auth: opts[:auth])
		end

		def read_and_parse
			super
			@comment = @js['body']
			@html_url = @js['html_url']
		end
	end

	class  Gist < Base
		def initialize(id, opts = {auth: []})
			super("#{HOST}/gists/#{id}", auth: opts[:auth])
		end

		def read_and_parse
			super
			@comment = @js['description']
			@html_url = @js['html_url']
		end
	end

	class SinglePullRequest < Base
		def initialize(owner, repo, number, opts = {auth: []})
			super("#{HOST}/repos/#{owner}/#{repo}/pulls/#{number}", auth: opts[:auth])
		end

		def read_and_parse
			super
			@comment = @js['body']
			@html_url = @js['html_url']
		end
	end

	class Commit < Base
		def initialize(owner, repo, sha, opts = {auth: []})
			super("#{HOST}/repos/#{owner}/#{repo}/commits/#{sha}", auth: opts[:auth])
		end

		def read_and_parse
			super
			@timestamp = Time.parse(@js['commit']['author']['date'])
			@comment = @js['commit']['message']
			@html_url = @js['html_url']
		end
	end
end