github-v3-api 0.2.0 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/github-v3-api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "github-v3-api"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Wilger"]
-  s.date = "2011-12-05"
+  s.date = "2012-01-20"
   s.description = "Ponies"
   s.email = "johnwilger@gmail.com"
   s.extra_rdoc_files = [

data/lib/github_v3_api/org.rb

@@ -14,6 +14,18 @@ class GitHubV3API
       api.list_repos(login)
     end
 
+    # Returns an array of GitHubV3API::User instances representing the users
+    # who are members of the organization
+    def members
+      api.list_members(login)
+    end
+
+    # Returns an array of GitHubV3API::User instances representing the users
+    # who are public members of the organization
+    def public_members
+      api.list_public_members(login)
+    end
+
     private 
 
     def natural_key

data/lib/github_v3_api/orgs_api.rb

@@ -49,5 +49,26 @@ class GitHubV3API
         GitHubV3API::Repo.new(@connection.repos, repo_data)
       end
     end
+
+    # Returns an array of GitHubV3API::User instances representing the members
+    # who belong to the specified organization.
+    #
+    # +org_login+:: the string ID of the organization, e.g. "github"
+    def list_members(org_login)
+      @connection.get("/orgs/#{org_login}/members").map do |user_data|
+        GitHubV3API::User.new(@connection.users, user_data)
+      end
+    end
+
+    # Returns an array of GitHubV3API::User instances representing the members
+    # who belong to the specified organization who have publicly identified
+    # themselves as members of this organization.
+    #
+    # +org_login+:: the string ID of the organization, e.g. "github"
+    def list_public_members(org_login)
+      @connection.get("/orgs/#{org_login}/public_members").map do |user_data|
+        GitHubV3API::User.new(@connection.users, user_data)
+      end
+    end
   end
 end

data/lib/github_v3_api/repo.rb

@@ -11,6 +11,18 @@ class GitHubV3API
       owner['login']
     end
 
+    def list_collaborators
+      api.list_collaborators(owner_login, name)
+    end
+
+    def list_watchers
+      api.list_watchers(owner_login, name)
+    end
+
+    def list_forks
+      api.list_forks(owner_login, name)
+    end
+
     private
 
     def natural_key

data/lib/github_v3_api/repos_api.rb

@@ -43,5 +43,39 @@ class GitHubV3API
     rescue RestClient::ResourceNotFound
       raise NotFound, "The repository #{user}/#{repo_name} does not exist or is not visible to the user."
     end
+
+    # Returns an array of GitHubV3API::User instances for the collaborators of the
+    # specified +user+ and +repo_name+.
+    #
+    # +user+:: the string ID of the user, e.g. "octocat"
+    # +repo_name+:: the string ID of the repository, e.g. "hello-world"
+    def list_collaborators(user, repo_name)
+      @connection.get("/repos/#{user}/#{repo_name}/collaborators").map do |user_data|
+        GitHubV3API::User.new(@connection.users, user_data)
+      end
+    end
+
+    # Returns an array of GitHubV3API::User instances containing the users who are
+    # watching the repository specified by +user+ and +repo_name+.
+    #
+    # +user+:: the string ID of the user, e.g. "octocat"
+    # +repo_name+:: the string ID of the repository, e.g. "hello-world"
+    def list_watchers(user, repo_name)
+      @connection.get("/repos/#{user}/#{repo_name}/watchers").map do |user_data|
+        GitHubV3API::User.new(@connection.users, user_data)
+      end
+    end
+
+    # Returns an array of GitHubV3API::Repo instances containing the repositories
+    # which were forked from the repository specified by +user+ and +repo_name+.
+    #
+    # +user+:: the string ID of the user, e.g. "octocat"
+    # +repo_name+:: the string ID of the repository, e.g. "hello-world"
+    def list_forks(user, repo_name)
+      @connection.get("/repos/#{user}/#{repo_name}/forks").map do |repo_data|
+        GitHubV3API::Repo.new(self, repo_data)
+      end
+    end
+
   end
 end

data/spec/org_spec.rb

@@ -44,4 +44,25 @@ describe GitHubV3API::Org do
       org.repos.should == [:repo1, :repo2]
     end
   end
+
+  describe '#members'do
+    it 'returns an array of User objects who are members of this org' do
+      api = mock(GitHubV3API::OrgsAPI)
+      api.should_receive(:list_members).with('github').and_return([:user1, :user2])
+
+      org = GitHubV3API::Org.new_with_all_data(api, 'login' => 'github')
+      org.members.should == [:user1, :user2]
+    end
+  end
+
+  describe '#public_members'do
+    it 'returns an array of User objects who are public members of this org' do
+      api = mock(GitHubV3API::OrgsAPI)
+      api.should_receive(:list_public_members).with('github').and_return([:user1, :user2])
+
+      org = GitHubV3API::Org.new_with_all_data(api, 'login' => 'github')
+      org.public_members.should == [:user1, :user2]
+    end
+  end
+
 end

data/spec/orgs_api_spec.rb

@@ -39,4 +39,39 @@ describe GitHubV3API::OrgsAPI do
       api.list_repos('github').should == [:repo1, :repo2]
     end
   end
+
+  describe '#list_members' do
+    it 'returns the list of members for the specified org' do
+      connection = mock(GitHubV3API, :users => :users_api)
+      connection.should_receive(:get).once.with('/orgs/github/members') \
+        .and_return([:user_hash1, :user_hash2])
+
+      GitHubV3API::User.should_receive(:new).with(:users_api, :user_hash1) \
+        .and_return(:user1)
+
+      GitHubV3API::User.should_receive(:new).with(:users_api, :user_hash2) \
+        .and_return(:user2)
+
+      api = GitHubV3API::OrgsAPI.new(connection)
+      api.list_members('github').should == [:user1, :user2]
+    end
+  end
+
+  describe '#list_public_members' do
+    it 'returns the list of public members for the specified org' do
+      connection = mock(GitHubV3API, :users => :users_api)
+      connection.should_receive(:get).once.with('/orgs/github/public_members') \
+        .and_return([:user_hash1, :user_hash2])
+
+      GitHubV3API::User.should_receive(:new).with(:users_api, :user_hash1) \
+        .and_return(:user1)
+
+      GitHubV3API::User.should_receive(:new).with(:users_api, :user_hash2) \
+        .and_return(:user2)
+
+      api = GitHubV3API::OrgsAPI.new(connection)
+      api.list_public_members('github').should == [:user1, :user2]
+    end
+  end
+
 end

data/spec/repo_spec.rb

@@ -40,4 +40,41 @@ describe GitHubV3API::Repo do
       repo.owner_login.should == 'octocat'
     end
   end
+
+  describe '#list_collaborators' do
+    it 'returns an array of User objects who are collaborating on this repo' do
+      api = mock(GitHubV3API::ReposAPI)
+      api.should_receive(:list_collaborators).once.with(
+        'octocat', 'hello-world').and_return([:user1, :user2, :user3])
+
+      repo = GitHubV3API::Repo.new(api, 'name' => 'hello-world',
+                                   'owner' => {'login' => 'octocat'})
+      repo.list_collaborators.should == [:user1, :user2, :user3]
+    end
+  end
+
+  describe '#list_watchers' do
+    it 'returns an array of User objects who are watching this repo' do
+      api = mock(GitHubV3API::ReposAPI)
+      api.should_receive(:list_watchers).once.with(
+        'octocat', 'hello-world').and_return([:user1, :user2, :user3])
+
+      repo = GitHubV3API::Repo.new(api, 'name' => 'hello-world',
+                                   'owner' => {'login' => 'octocat'})
+      repo.list_watchers.should == [:user1, :user2, :user3]
+    end
+  end
+
+  describe '#list_forks' do
+    it 'returns an array of Repo objects which were forked from this repo' do
+      api = mock(GitHubV3API::ReposAPI)
+      api.should_receive(:list_forks).once.with(
+        'octocat', 'hello-world').and_return([:repo1, :repo2, :repo3])
+
+      repo = GitHubV3API::Repo.new(api, 'name' => 'hello-world',
+                                   'owner' => {'login' => 'octocat'})
+      repo.list_forks.should == [:repo1, :repo2, :repo3]
+    end
+  end
+
 end

data/spec/repos_api_spec.rb

@@ -30,4 +30,52 @@ describe GitHubV3API::ReposAPI do
       lambda { api.get('octocat', 'hello-world') }.should raise_error(GitHubV3API::NotFound)
     end
   end
+
+  describe "#list_collaborators" do
+    it 'returns a list of Users who are collaborating on the specified repo' do
+      connection = mock(GitHubV3API)
+      connection.should_receive(:get).with(
+        '/repos/octocat/hello-world/collaborators').and_return([:user_hash1, :user_hash2])
+      connection.should_receive(:users).twice.and_return(:users_api)
+      api = GitHubV3API::ReposAPI.new(connection)
+
+      GitHubV3API::User.should_receive(:new).with(:users_api, :user_hash1).and_return(:user1)
+      GitHubV3API::User.should_receive(:new).with(:users_api, :user_hash2).and_return(:user2)
+
+      collaborators = api.list_collaborators('octocat', 'hello-world')
+      collaborators.should == [:user1, :user2]
+    end
+  end
+
+  describe "#list_watchers" do
+    it 'returns a list of Users who are watching the specified repo' do
+      connection = mock(GitHubV3API)
+      connection.should_receive(:get).with(
+        '/repos/octocat/hello-world/watchers').and_return([:user_hash1, :user_hash2])
+      connection.should_receive(:users).twice.and_return(:users_api)
+      api = GitHubV3API::ReposAPI.new(connection)
+
+      GitHubV3API::User.should_receive(:new).with(:users_api, :user_hash1).and_return(:user1)
+      GitHubV3API::User.should_receive(:new).with(:users_api, :user_hash2).and_return(:user2)
+
+      watchers = api.list_watchers('octocat', 'hello-world')
+      watchers.should == [:user1, :user2]
+    end
+  end
+
+  describe "#list_forks" do
+    it 'returns a list of Repos which were forked from the specified repo' do
+      connection = mock(GitHubV3API)
+      connection.should_receive(:get).with(
+        '/repos/octocat/hello-world/forks').and_return([:repo_hash1, :repo_hash2])
+      api = GitHubV3API::ReposAPI.new(connection)
+
+      GitHubV3API::Repo.should_receive(:new).with(api, :repo_hash1).and_return(:fork1)
+      GitHubV3API::Repo.should_receive(:new).with(api, :repo_hash2).and_return(:fork2)
+
+      forks = api.list_forks('octocat', 'hello-world')
+      forks.should == [:fork1, :fork2]
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-v3-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-05 00:00:00.000000000Z
+date: 2012-01-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2168649880 !ruby/object:Gem::Requirement
+  requirement: &2173811200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.3
   type: :runtime
   prerelease: false
-  version_requirements: *2168649880
+  version_requirements: *2173811200
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2168649400 !ruby/object:Gem::Requirement
+  requirement: &2173810720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *2168649400
+  version_requirements: *2173810720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2168648920 !ruby/object:Gem::Requirement
+  requirement: &2173810240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2168648920
+  version_requirements: *2173810240
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2168648440 !ruby/object:Gem::Requirement
+  requirement: &2173809740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2168648440
+  version_requirements: *2173809740
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2168647960 !ruby/object:Gem::Requirement
+  requirement: &2173809220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.0
   type: :development
   prerelease: false
-  version_requirements: *2168647960
+  version_requirements: *2173809220
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2168663860 !ruby/object:Gem::Requirement
+  requirement: &2173808700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2168663860
+  version_requirements: *2173808700
 - !ruby/object:Gem::Dependency
   name: reek
-  requirement: &2168663380 !ruby/object:Gem::Requirement
+  requirement: &2173808180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.2.8
   type: :development
   prerelease: false
-  version_requirements: *2168663380
+  version_requirements: *2173808180
 - !ruby/object:Gem::Dependency
   name: roodi
-  requirement: &2168662900 !ruby/object:Gem::Requirement
+  requirement: &2173807580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *2168662900
+  version_requirements: *2173807580
 description: Ponies
 email: johnwilger@gmail.com
 executables: []
@@ -154,7 +154,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -423517937058714579
+      hash: -3441059539014864528
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: