github-v3-api 0.0.5 → 0.1.0

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.1.0

data/github-v3-api.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{github-v3-api}
-  s.version = "0.0.5"
+  s.name = "github-v3-api"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Wilger"]
-  s.date = %q{2011-07-03}
-  s.description = %q{Ponies}
-  s.email = %q{johnwilger@gmail.com}
+  s.date = "2011-10-18"
+  s.description = "Ponies"
+  s.email = "johnwilger@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -31,22 +31,26 @@ Gem::Specification.new do |s|
     "lib/github-v3-api.rb",
     "lib/github_v3_api.rb",
     "lib/github_v3_api/entity.rb",
+    "lib/github_v3_api/issue.rb",
+    "lib/github_v3_api/issues_api.rb",
     "lib/github_v3_api/org.rb",
     "lib/github_v3_api/orgs_api.rb",
     "lib/github_v3_api/repo.rb",
     "lib/github_v3_api/repos_api.rb",
     "spec/github_v3_api_spec.rb",
+    "spec/issue_spec.rb",
+    "spec/issues_api_spec.rb",
     "spec/org_spec.rb",
     "spec/orgs_api_spec.rb",
     "spec/repo_spec.rb",
     "spec/repos_api_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/jwilger/github-v3-api}
+  s.homepage = "http://github.com/jwilger/github-v3-api"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Ruby Client for the GitHub v3 API}
+  s.rubygems_version = "1.8.10"
+  s.summary = "Ruby Client for the GitHub v3 API"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/github_v3_api.rb

@@ -1,6 +1,8 @@
 require 'rest-client'
 require 'json'
 require 'github_v3_api/entity'
+require 'github_v3_api/issues_api'
+require 'github_v3_api/issue'
 require 'github_v3_api/orgs_api'
 require 'github_v3_api/org'
 require 'github_v3_api/repos_api'
@@ -23,6 +25,9 @@ class GitHubV3API
   # Raised when an API request uses an invalid access token
   Unauthorized = Class.new(RuntimeError)
 
+  # Raised when an API request is missing required data
+  MissingRequiredData = Class.new(RuntimeError)
+
   # Returns a GitHubV3API instance that is able to access github with the
   # +access_token+ owner's authorization.
   #
@@ -47,8 +52,43 @@ class GitHubV3API
     ReposAPI.new(self)
   end
 
-  def get(path) #:nodoc:
+  # Entry-point for access to the GitHub Issues API
+  #
+  # Returns an instance of GitHubV3API::IssuesAPI that will use the access_token
+  # associated with this instance
+  def issues
+    IssuesAPI.new(self)
+  end
+
+  def get(path, params={}) #:nodoc:
     result = RestClient.get("https://api.github.com" + path,
+                            {:accept => :json,
+                             :authorization => "token #{@access_token}"}.merge({:params => params}))
+    JSON.parse(result)
+  rescue RestClient::Unauthorized
+    raise Unauthorized, "The access token is invalid according to GitHub"
+  end
+
+  def post(path, params={}) #:nodoc:
+    result = RestClient.post("https://api.github.com" + path, JSON.generate(params),
+                            {:accept => :json,
+                             :authorization => "token #{@access_token}"})
+    JSON.parse(result)
+  rescue RestClient::Unauthorized
+    raise Unauthorized, "The access token is invalid according to GitHub"
+  end
+
+  def patch(path, params={}) #:nodoc:
+    result = RestClient.post("https://api.github.com" + path, JSON.generate(params),
+                            {:accept => :json,
+                             :authorization => "token #{@access_token}"})
+    JSON.parse(result)
+  rescue RestClient::Unauthorized
+    raise Unauthorized, "The access token is invalid according to GitHub"
+  end
+
+  def delete(path) #:nodoc:
+    result = RestClient.delete("https://api.github.com" + path,
                             {:accept => :json,
                              :authorization => "token #{@access_token}"})
     JSON.parse(result)

data/lib/github_v3_api/issue.rb

@@ -0,0 +1,11 @@
+# See GitHubV3API documentation in lib/github_v3_api.rb
+class GitHubV3API
+  # Represents a single GitHub Issue and provides access to its data attributes.
+  class Issue < Entity
+    attr_reader :url, :html_url, :number, :state, :title, :body, :user,
+                :labels, :assignee, :milestone, :comments, :pull_request,
+                :closed_at, :created_at, :updated_at
+
+
+  end
+end

data/lib/github_v3_api/issues_api.rb

@@ -0,0 +1,82 @@
+# See GitHubV3API documentation in lib/github_v3_api.rb
+class GitHubV3API
+  # Provides access to the GitHub Issues API (http://developer.github.com/v3/issues/)
+  #
+  # example:
+  #
+  #   api = GitHubV3API.new(ACCESS_TOKEN)
+  #
+  #   # get list of your issues
+  #   my_issues = api.issues.list
+  #   #=> returns an array of GitHubV3API::Issue instances
+  #
+  #   # get list of issues for a repo
+  #   repo_issues = api.issues.list({:user => 'octocat', :repo => 'hello-world'})
+  #   #=> returns an array of GitHubV3API::Issue instances
+  #
+  #   issue = api.issues.get('octocat', 'hello-world', '1234')
+  #   #=> returns an instance of GitHubV3API::Issue
+  #
+  #   issue.title
+  #   #=> 'omgbbq'
+  #
+  class IssuesAPI
+    # Typically not used directly. Use GitHubV3API#issues instead.
+    #
+    # +connection+:: an instance of GitHubV3API
+    def initialize(connection)
+      @connection = connection
+    end
+
+    # Returns an array of GitHubV3API::Issue instances representing a
+    # user's issues or issues for a repo
+    def list(options=nil, params={})
+      path = if options && options[:user] && options[:repo]
+        "/repos/#{options[:user]}/#{options[:repo]}/issues"
+      else
+        '/issues'
+      end
+
+      @connection.get(path, params).map do |issue_data|
+        GitHubV3API::Issue.new(self, issue_data)
+      end
+    end
+
+    # Returns a GitHubV3API::Issue instance for the specified +user+,
+    # +repo_name+, and +id+.
+    #
+    # +user+:: the string ID of the user, e.g. "octocat"
+    # +repo_name+:: the string ID of the repository, e.g. "hello-world"
+    # +id+:: the integer ID of the issue, e.g. 42
+    def get(user, repo_name, id, params={})
+      issue_data = @connection.get("/repos/#{user}/#{repo_name}/issues/#{id.to_s}", params)
+      GitHubV3API::Issue.new_with_all_data(self, issue_data)
+    rescue RestClient::ResourceNotFound
+      raise NotFound, "The issue #{user}/#{repo_name}/issues/#{id} does not exist or is not visible to the user."
+    end
+
+    # Returns a GitHubV3API::Issue instance representing the issue
+    # that it creates
+    #
+    # +user+:: the string ID of the user, e.g. "octocat"
+    # +repo_name+:: the string ID of the repository, e.g. "hello-world"
+    # +data+:: the hash DATA with attributes for the issue, e.g. {:title => "omgbbq"}
+    def create(user, repo_name, data={})
+      raise MissingRequiredData, "Title is required to create a new issue" unless data[:title]
+      issue_data = @connection.post("/repos/#{user}/#{repo_name}/issues", data)
+      GitHubV3API::Issue.new_with_all_data(self, issue_data)
+    end
+
+    # Returns a GitHubV3API::Issue instance representing the issue
+    # that it updated
+    #
+    # +user+:: the string ID of the user, e.g. "octocat"
+    # +repo_name+:: the string ID of the repository, e.g. "hello-world"
+    # +id+:: the integer ID of the issue, e.g. 42
+    # +data+:: the hash with attributes for the issue, e.g. {:body => "lol, wtf"}
+    def update(user, repo_name, id, data={})
+      issue_data = @connection.patch("/repos/#{user}/#{repo_name}/issues/#{id.to_s}", data)
+      GitHubV3API::Issue.new_with_all_data(self, issue_data)
+    end
+  end
+end

data/lib/github_v3_api/repos_api.rb

@@ -10,7 +10,7 @@ class GitHubV3API
   #   repos = api.repos.list
   #   #=> returns an array of GitHubV3API::Repo instances
   #
-  #   repo = api.repo.get('octocat', 'hello-world')
+  #   repo = api.repos.get('octocat', 'hello-world')
   #   #=> returns an instance of GitHubV3API::Repo
   #
   #   repo.name

data/spec/github_v3_api_spec.rb

@@ -19,10 +19,17 @@ describe GitHubV3API do
     end
   end
 
+  describe "#issues" do
+    it "returns an instance of GitHubV3API::IssuesAPI" do
+      api = GitHubV3API.new('abcde')
+      api.issues.should be_kind_of GitHubV3API::IssuesAPI
+    end
+  end
+
   describe '#get' do
     it 'does a get request to the specified path at the GitHub API server and adds the access token' do
       RestClient.should_receive(:get) \
-        .with('https://api.github.com/some/path', {:accept => :json, :authorization => 'token abcde'}) \
+        .with('https://api.github.com/some/path', {:accept => :json, :authorization => 'token abcde', :params => {}}) \
         .and_return('{}')
       api = GitHubV3API.new('abcde')
       api.get('/some/path')
@@ -40,4 +47,38 @@ describe GitHubV3API do
       lambda { api.get('/something') }.should raise_error(GitHubV3API::Unauthorized)
     end
   end
+
+  describe "#post" do
+    it "does a post request to the specified path at the github server, adds token, and payload as json" do
+      data = {:title => 'omgbbq'}
+      json = JSON.generate(data)
+      RestClient.should_receive(:post) \
+        .with('https://api.github.com/some/path', json, {:accept => :json, :authorization => 'token abcde'}) \
+        .and_return('{}')
+      api = GitHubV3API.new('abcde')
+      api.post('/some/path', data)
+    end
+  end
+
+  describe "#patch" do
+    it "does a post request to the specified path at the github server, adds token, and payload as json" do
+      data = {:title => 'omgbbq'}
+      json = JSON.generate(data)
+      RestClient.should_receive(:post) \
+        .with('https://api.github.com/some/path', json, {:accept => :json, :authorization => 'token abcde'}) \
+        .and_return('{}')
+      api = GitHubV3API.new('abcde')
+      api.patch('/some/path', data)
+    end
+  end
+
+  describe "#delete" do
+    it 'does a delete request to the specified path at the GitHub API server and adds the access token' do
+      RestClient.should_receive(:delete) \
+        .with('https://api.github.com/some/path', {:accept => :json, :authorization => 'token abcde'}) \
+        .and_return('{}')
+      api = GitHubV3API.new('abcde')
+      api.delete('/some/path')
+    end
+  end
 end

data/spec/issue_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe GitHubV3API::Issue do
+  describe 'attr_readers' do
+    it 'should define attr_readers that pull values from the issue data' do
+      fields = %w(url html_url number state title body user labels assignee
+                  milestone comments pull_request closed_at created_at updated_at)
+      fields.each do |f|
+        repo = GitHubV3API::Issue.new_with_all_data(stub('api'), {f.to_s => 'foo'})
+        repo.methods.should include(f.to_sym)
+        repo.send(f).should == 'foo'
+      end
+    end
+  end
+end

data/spec/issues_api_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe GitHubV3API::IssuesAPI do
+  describe "#list" do
+    context "options = nil" do
+      it "returns issues for a user" do
+        connection = mock(GitHubV3API)
+        connection.should_receive(:get).with('/issues', {}).and_return([:issue_hash1, :issue_hash2])
+        api = GitHubV3API::IssuesAPI.new(connection)
+        GitHubV3API::Issue.should_receive(:new).with(api, :issue_hash1).and_return(:issue1)
+        GitHubV3API::Issue.should_receive(:new).with(api, :issue_hash2).and_return(:issue2)
+        issues = api.list
+        issues.should == [:issue1, :issue2]
+      end
+    end
+
+    context "options = {:user => 'octocat', :repo => 'hello-world'}" do
+      it "returns issues for a repo" do
+        connection = mock(GitHubV3API)
+        connection.should_receive(:get).with("/repos/octocat/hello-world/issues", {}).and_return([:issue_hash1, :issue_hash2])
+        api = GitHubV3API::IssuesAPI.new(connection)
+        GitHubV3API::Issue.should_receive(:new).with(api, :issue_hash1).and_return(:issue1)
+        GitHubV3API::Issue.should_receive(:new).with(api, :issue_hash2).and_return(:issue2)
+        issues = api.list({:user => 'octocat', :repo => 'hello-world'})
+        issues.should == [:issue1, :issue2]
+      end
+    end
+  end
+
+  describe '#get' do
+    it 'returns a fully-hydrated Issue object for the specified user, repo, and issue id' do
+      connection = mock(GitHubV3API)
+      connection.should_receive(:get).with('/repos/octocat/hello-world/issues/1234', {}).and_return(:issue_hash)
+      api = GitHubV3API::IssuesAPI.new(connection)
+      GitHubV3API::Issue.should_receive(:new_with_all_data).with(api, :issue_hash).and_return(:issue)
+      api.get('octocat', 'hello-world', 1234).should == :issue
+    end
+
+    it 'raises GitHubV3API::NotFound instead of a RestClient::ResourceNotFound' do
+      connection = mock(GitHubV3API)
+      connection.should_receive(:get) \
+        .and_raise(RestClient::ResourceNotFound)
+      api = GitHubV3API::IssuesAPI.new(connection)
+      lambda { api.get('octocat', 'hello-world', 4321) }.should raise_error(GitHubV3API::NotFound)
+    end
+  end
+
+  describe "#create" do
+    it 'returns a fully-hydrated Issue object for the specified user, repo, and issue that was created' do
+      connection = mock(GitHubV3API)
+      data = {:title => "omgbbq"}
+      connection.should_receive(:post).with('/repos/octocat/hello-world/issues', data).and_return(:issue_hash)
+      api = GitHubV3API::IssuesAPI.new(connection)
+      GitHubV3API::Issue.should_receive(:new_with_all_data).with(api, :issue_hash).and_return(:issue)
+      api.create('octocat', 'hello-world', data).should == :issue
+    end
+
+    it "raises GitHubV3API::MissingRequiredData when data[:title] is missing" do
+      connection = mock(GitHubV3API)
+      connection.should_not_receive(:post)
+      api = GitHubV3API::IssuesAPI.new(connection)
+      lambda { api.create('octocat', 'hello-world', {}) }.should raise_error(GitHubV3API::MissingRequiredData)
+    end
+  end
+
+  describe "#update" do
+    it 'returns a fully-hydrated Issue object for the specified user, repo, and issue that was updated' do
+      connection = mock(GitHubV3API)
+      data = {:body => "lol, wtf"}
+      connection.should_receive(:patch).with('/repos/octocat/hello-world/issues/1234', data).and_return(:issue_hash)
+      api = GitHubV3API::IssuesAPI.new(connection)
+      GitHubV3API::Issue.should_receive(:new_with_all_data).with(api, :issue_hash).and_return(:issue)
+      api.update('octocat', 'hello-world', 1234, data).should == :issue
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,10 +3,6 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'github_v3_api'
 
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
 RSpec.configure do |config|
-  
+
 end

metadata

@@ -1,116 +1,112 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: github-v3-api
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  version: 0.0.5
 platform: ruby
-authors: 
+authors:
 - John Wilger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-03 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2159155400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.6.3
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159155400
+- !ruby/object:Gem::Dependency
   name: json
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &2159154920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159154920
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &2159154440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159154440
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &2159153960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159153960
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &2159153480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.6.0
   type: :development
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159153480
+- !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &2159153000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159153000
+- !ruby/object:Gem::Dependency
   name: reek
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &2159152520 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.2.8
   type: :development
   prerelease: false
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
+  version_requirements: *2159152520
+- !ruby/object:Gem::Dependency
   name: roodi
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &2159152040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *id008
+  version_requirements: *2159152040
 description: Ponies
 email: johnwilger@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
-files: 
+files:
 - .document
 - .rspec
 - .rvmrc
@@ -125,46 +121,46 @@ files:
 - lib/github-v3-api.rb
 - lib/github_v3_api.rb
 - lib/github_v3_api/entity.rb
+- lib/github_v3_api/issue.rb
+- lib/github_v3_api/issues_api.rb
 - lib/github_v3_api/org.rb
 - lib/github_v3_api/orgs_api.rb
 - lib/github_v3_api/repo.rb
 - lib/github_v3_api/repos_api.rb
 - spec/github_v3_api_spec.rb
+- spec/issue_spec.rb
+- spec/issues_api_spec.rb
 - spec/org_spec.rb
 - spec/orgs_api_spec.rb
 - spec/repo_spec.rb
 - spec/repos_api_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/jwilger/github-v3-api
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -4451428935810272395
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 3092793002911622780
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby Client for the GitHub v3 API
 test_files: []
-