github-issues 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    github-issues (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  github-issues!
+  rspec (~> 2.1)

data/README.md

@@ -0,0 +1,45 @@
+# Github Issues
+
+This is a little API that gives easy access to the github issues. I started the project because I had to move tickets from github to redmine.
+
+The API is called using ``URI.open`` and YAML for serialization.
+
+**Note: this is currently a read-only API, also this just covers version 2 of the API**
+
+## Installing
+
+    gem install github-issues
+    
+## Usage
+    
+### Connecting to the issues host
+
+In order to access the information on the github repository one has to make a connection to the remote repository.
+
+    repo = Github.connect("threez", "github-issues")
+
+### Reading all issues
+
+This will return all issues found on the repository.
+
+    repo.issues.all # => [Github::Issue, ...]
+    
+### Reading just open or closed issues
+
+Filter which issues should be displayed.
+
+    repo.issues.all(:open) # => [Github::Issue, ...]
+    repo.issues.all(:closed) # => [Github::Issue, ...]
+    
+### Getting informations about a issue
+
+access all the information of an issue easily:
+
+    issue.number # => 64
+    issue.createt_at # => Time
+    issue.comments # => [Github::Issue::Comment, ...]
+
+### Comments in an issue
+
+    comment.user # => "threez"
+    comment.body # => "close #34 (implemented read-only part)"

data/Rakefile

@@ -0,0 +1,7 @@
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rspec_opts = ['--backtrace']
+end
+
+task :default => :spec

data/github-issues.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+$:.push('lib')
+require "github-issues/version"
+
+Gem::Specification.new do |s|
+  s.name     = "github-issues"
+  s.version  = Github::Issues::VERSION.dup
+  s.date     = "2011-12-04"
+  s.summary  = "An api to githubs issues system"
+  s.email    = "vilandgr+github@googlemail.com "
+  s.homepage = "https://github.com/threez/github-issues"
+  s.authors  = ['Vincent Landgraf']
+  
+  s.description = <<-EOF
+This is a little API that gives easy access to the github issues. It is 
+currently a read-only API.
+EOF
+  
+  dependencies = [
+    # Examples:
+    # [:runtime,     "rack",  "~> 1.1"],
+    [:development, "rspec", "~> 2.1"],
+  ]
+  
+  s.files         = Dir['**/*']
+  s.test_files    = Dir['test/**/*'] + Dir['spec/**/*']
+  s.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  
+  ## Make sure you can build the gem on older versions of RubyGems too:
+  s.rubygems_version = "1.8.9"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.specification_version = 3 if s.respond_to? :specification_version
+  
+  dependencies.each do |type, name, version|
+    if s.respond_to?("add_#{type}_dependency")
+      s.send("add_#{type}_dependency", name, version)
+    else
+      s.add_dependency(name, version)
+    end
+  end
+end

data/lib/github-issues.rb

@@ -0,0 +1,7 @@
+lib = File.join(File.dirname(__FILE__), "github-issues")
+
+require "open-uri"
+require "yaml"
+require File.join(lib, "github")
+require File.join(lib, "issue")
+require File.join(lib, "comment")

data/lib/github-issues/comment.rb

@@ -0,0 +1,9 @@
+class Github::Issue::Comment
+  attr_accessor :gravatar_id, :created_at, :body, :updated_at, :id, :user
+  
+  # Initialize the comment using the passed fields.
+  # @param [Hash] fields the fields that will initialize the comment.
+  def initialize(fields = {})
+    fields.each { |name, value| self.send("#{name}=", value) }
+  end
+end

data/lib/github-issues/github.rb

@@ -0,0 +1,67 @@
+class Github < Struct.new(:username, :repository_name, :protocol)
+  # Connects to the remote repository
+  # @param [String, Symbol] username the name of the user or organization
+  # @param [String, Symbol] repository_name the name of the repository
+  # @param [Boolean] secure the connection using https
+  # @return a new github instance for that repository
+  def self.connect(username, repository_name, secure = false)
+    new(username.to_s, repository_name.to_s, secure ? "https" : "http")
+  end
+  
+  # This class handles the requests on the list of issues
+  # @visibility private
+  class IssuesProxy
+    # Initializes the issues proxy with the passed repository.
+    # @param [Github] repository the repository to connect to
+    def initialize(repository)
+      @repository = repository
+    end
+    
+    # Returns all the tickets of a repository. A filter can be passed to reduce
+    # the number of tickets.
+    # @param [Symbol] state the state to filter for (:open or :close)
+    def all(state = :all)
+      if state == :all
+        all(:open) + all(:closed)
+      else
+        @repository.load(:list, state, :issues).map do |fields| 
+          issue = Github::Issue.new(fields)
+          issue.repository = @repository
+          issue
+        end
+      end
+    end
+    
+    # Returns the issue identified by the passed id.
+    # @param [Fixnum] issue_id the issue to find
+    def find(issue_id)
+      issue = Github::Issue.new(@repository.load(:show, issue_id, :issue))
+      issue.repository = @repository
+      issue
+    end
+  end
+  
+  # Returns the general url to the repository.
+  # @param [String] action the action that should be inserted into the url
+  # @param [String, Fixnum, Symbol] filter the filter for the url
+  # @return [String] the url for the issue
+  def url(action, filter = nil)
+    "#{protocol}://github.com/api/v2/yaml/issues/#{action}/" \
+    "#{username}/#{repository_name}" + (filter ? "/#{filter}" : "")
+  end
+  
+  # Returns the structure (the hash) found by the resource criteria.
+  # @param [String] action the action that should be inserted into the url
+  # @param [String, Fixnum, Symbol] filter the filter for the url
+  # @param [Symbol] name of the resource by default the action name
+  # @return [Hash] the structure of the remote resource
+  def load(action, filter = nil, name = nil)
+    YAML.load(open(url(action, filter)))[(name || action).to_s]
+  end
+  
+  # Returns an issues proxy object
+  # @return [IssuesProxy] the proxy
+  def issues
+    IssuesProxy.new(self)
+  end
+end

data/lib/github-issues/issue.rb

@@ -0,0 +1,47 @@
+class Github::Issue
+  attr_accessor :position, :number, :votes, :created_at, :body, :labels, :state,
+                :title, :updated_at, :closed_at, :gravatar_id, :html_url, :user,
+                :comments_count, :diff_url, :patch_url, :pull_request_url,
+                :repository
+  
+  # Initialize the issue using the passed fields.
+  # @param [Hash] fields the fields that will initialize the comment.   
+  def initialize(fields = {})
+    fields.each { |name, value| self.send("#{name}=", value) }
+  end
+  
+  # Returns true if the issue is closed
+  def closed?
+    state == "closed"
+  end
+  
+  # Returns true if the issue is open
+  def open?
+    state == "open"
+  end
+  
+  # This updates the comments on an issue. The API returns here the number of 
+  # comments. Not the actual comments.
+  # @param [Fixnum] count the count of existing comments
+  def comments=(count)
+    @comments_count = count
+  end
+  
+  # Returns true if the issue has comments.
+  def has_comments?
+    @comments_count > 0
+  end
+  
+  # Fetches the comments only if the issue has some.
+  # @return [Array<Github::Issue::Comment>] the comments that belong to that 
+  # issue
+  def comments
+    if has_comments?
+      @repository.load(:comments, number).map do |item|
+        Github::Issue::Comment.new(item)
+      end
+    else  
+      []
+    end
+  end
+end

data/lib/github-issues/version.rb

@@ -0,0 +1,5 @@
+module Github
+  module Issues
+    VERSION = '0.0.1'
+  end
+end

data/spec/comment_spec.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Github::Issue::Comment do
+  it "should be possible to parse a comment" do
+    comment = Github::Issue::Comment.new(
+      "gravatar_id" => "8194993afda83d34c94928134b729276",
+      "created_at" => Time.parse("2010/05/05 15:15:53 -0700"),
+      "body" => "Showing off the issues app.",
+      "updated_at" => Time.parse("2010/05/05 15:15:53 -0700"),
+      "id" => 230935,
+      "user" => "280north"
+    )
+    comment.user.should == "280north"
+    comment.body.should == "Showing off the issues app."
+  end
+end

data/spec/github_spec.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Github do
+  it "should connect to the remote rails repository" do
+    repo = Github.connect(USERNAME, REPO)
+    repo.username.should == USERNAME
+    repo.repository_name.should == REPO
+  end
+  
+  context "with rails repo" do
+    before(:each) do
+      @repo = Github.connect(USERNAME, REPO)
+    end
+    
+    it "should return the correct repo path" do
+      @repo.url(:list).should == \
+        "http://github.com/api/v2/yaml/issues/list/#{USERNAME}/#{REPO}"
+    end
+    
+    it "should return an issues proxy object" do
+      @repo.issues.should be_a(Github::IssuesProxy)
+    end
+
+    it "should find tickets" do
+      @repo.issues.all.should_not be_empty
+    end
+    
+    it "should filter tickets by state" do
+      open = @repo.issues.all(:open)
+      closed = @repo.issues.all(:closed)
+      open.should_not be_empty
+      closed.should_not be_empty
+      open.should_not == closed
+    end
+    
+    it "should be possible to fetch an issue" do
+      issue = @repo.issues.find(10)
+      issue.has_comments?.should be_true
+      issue.comments_count.should > 0
+      issue.comments.should_not be_empty
+    end
+  end
+end

data/spec/issue_spec.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Github::Issue do
+  it "should be possible to parse an issue" do
+    issue = Github::Issue.new("position" => 1.0,
+      "number" => 1,
+      "votes" => 0,
+      "created_at" => Time.parse("2011-04-18 21:00:31 +0200"),
+      "comments" => 0,
+      "body" => "",
+      "title" => "General Layout",
+      "updated_at" => Time.parse("2011-04-18 22:56:17 +0200"),
+      "closed_at" => Time.parse("2011-04-18 22:56:17 +0200"),
+      "gravatar_id" => "e372514c922684dfb07578aa59e5a2b8",
+      "html_url" => "https://github.com/inovex/inovex.de/issues/1",
+      "user" => "threez",
+      "labels" => [],
+      "state" => "closed")
+    issue.title.should == "General Layout"
+    issue.closed?.should == true
+  end
+  
+  it "should be possible to handle the comments correctly" do
+    issue = Github::Issue.new("position" => 1.0,
+      "number" => 1,
+      "votes" => 0,
+      "created_at" => Time.parse("2011-04-18 21:00:31 +0200"),
+      "comments" => 0,
+      "body" => "",
+      "title" => "General Layout",
+      "updated_at" => Time.parse("2011-04-18 22:56:17 +0200"),
+      "closed_at" => Time.parse("2011-04-18 22:56:17 +0200"),
+      "gravatar_id" => "e372514c922684dfb07578aa59e5a2b8",
+      "html_url" => "https://github.com/inovex/inovex.de/issues/1",
+      "user" => "threez",
+      "labels" => [],
+      "state" => "closed")
+    issue.comments_count.should == 0
+    issue.comments.should == []
+    issue.has_comments?.should be_false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+USERNAME = "rails"
+REPO = "arel"
+
+require "github-issues"

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: github-issues
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+  - Vincent Landgraf
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-04 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: "2.1"
+    type: :development
+    version_requirements: *id001
+description: |
+  This is a little API that gives easy access to the github issues. It is 
+  currently a read-only API.
+
+email: "vilandgr+github@googlemail.com "
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - Gemfile
+  - Gemfile.lock
+  - github-issues.gemspec
+  - Rakefile
+  - README.md
+  - lib/github-issues.rb
+  - lib/github-issues/comment.rb
+  - lib/github-issues/github.rb
+  - lib/github-issues/issue.rb
+  - lib/github-issues/version.rb
+  - spec/comment_spec.rb
+  - spec/github_spec.rb
+  - spec/issue_spec.rb
+  - spec/spec_helper.rb
+homepage: https://github.com/threez/github-issues
+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.9
+signing_key: 
+specification_version: 3
+summary: An api to githubs issues system
+test_files: 
+  - spec/comment_spec.rb
+  - spec/github_spec.rb
+  - spec/issue_spec.rb
+  - spec/spec_helper.rb