github-v3-api 0.0.1 → 0.0.2

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/github-v3-api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{github-v3-api}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Wilger"]
-  s.date = %q{2011-06-23}
+  s.date = %q{2011-06-24}
   s.description = %q{Ponies}
   s.email = %q{johnwilger@gmail.com}
   s.extra_rdoc_files = [
@@ -30,11 +30,16 @@ Gem::Specification.new do |s|
     "github-v3-api.gemspec",
     "lib/github-v3-api.rb",
     "lib/github_v3_api.rb",
+    "lib/github_v3_api/entity.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/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}

data/lib/github_v3_api/entity.rb

@@ -0,0 +1,58 @@
+class GitHubV3API
+  # This is the base class used for value objects returned by the API. See
+  # descendent classes for more details.
+  class Entity
+    def self.new_with_all_data(api, data) #:nodoc:
+      entity = allocate
+      entity.initialize_fetched(api, data)
+      entity
+    end
+
+    # +api+:: an instance of the API class associated with the subclass of
+    #         Entity being instantiated.
+    # +data+:: a Hash with keys corresponding to the data fields for the
+    #          subclass of Entity being instantiated
+    def initialize(api, data)
+      @api = api
+      @data = data
+    end
+
+    def initialize_fetched(api, data) #:nodoc:
+      initialize(api, data)
+      @fetched = true
+    end
+
+    def [](key) #:nodoc:
+      fetch_data unless @fetched
+      @data[key]
+    end
+
+    def self.attr_reader(*fields) #:nodoc:
+      fields.each do |field|
+        define_method field do
+          self[field.to_s]
+        end
+      end
+    end
+
+    protected
+
+    # Provides access to the raw data hash for subclasses.
+    def data
+      @data
+    end
+
+    private
+
+    def fetch_data #:nodoc:
+      result = @api.get(*natural_key)
+      @data = result.data
+      @fetched = true
+    end
+
+    # Provides access to the api object for subclasses
+    def api
+      @api
+    end
+  end
+end

data/lib/github_v3_api/org.rb

@@ -1,58 +1,23 @@
 # See GitHubV3API documentation in lib/github_v3_api.rb
 class GitHubV3API
   # Represents a single GitHub Org and provides access to its data attributes.
-  class Org
-    def self.new_with_all_data(api, org_data) #:nodoc:
-      org = self.allocate
-      org.initialize_fetched(api, org_data)
-      org
-    end
-
-    # +api+:: an instance of GitHubV3API::OrgsAPI
-    # +org_data+:: a Hash with keys corresponding to the org data supported by
-    #              GitHub
-    #
-    def initialize(api, org_data)
-      @api = api
-      @org_data = org_data
-    end
-
-    def initialize_fetched(api, org_data) #:nodoc:
-      initialize(api, org_data)
-      @fetched = true
-    end
-
-    def [](key) #:nodoc:
-      fetch_data unless @fetched
-      @org_data[key]
-    end
-
-    def self.attr_reader(*fields) #:nodoc:
-      fields.each do |field|
-        define_method field do
-          self[field.to_s]
-        end
-      end
-    end
-
+  class Org < Entity
     attr_reader :avatar_url, :billing_email, :blog, :collaborators,
       :company, :created_at, :disk_usage, :email, :followers, :following,
       :html_url, :id, :location, :login, :name, :owned_private_repos, :plan,
       :private_gists, :private_repos, :public_gists, :public_repos, :space,
       :total_private_repos, :type, :url
 
-    protected
-
-    def org_data #:nodoc:
-      @org_data
+    # Returns an array of GitHubV3API::Repo instances representing the repos
+    # that belong to this org
+    def repos
+      api.list_repos(login)
     end
 
-    private
+    private 
 
-    def fetch_data #:nodoc:
-      result = @api.get(@org_data['login'])
-      @org_data = result.org_data
-      @fetched = true
+    def natural_key
+      [data['login']]
     end
   end
 end

data/lib/github_v3_api/orgs_api.rb

@@ -39,5 +39,15 @@ class GitHubV3API
       org_data = @connection.get("/orgs/#{org_login}")
       GitHubV3API::Org.new_with_all_data(self, org_data)
     end
+
+    # Returns an array of GitHubV3API::Repo instances representing the repos
+    # that belong to the specified org.
+    #
+    # +org_login+:: the string ID of the organization, e.g. "github"
+    def list_repos(org_login)
+      @connection.get("/orgs/#{org_login}/repos").map do |repo_data|
+        GitHubV3API::Repo.new(@connection.repos, repo_data)
+      end
+    end
   end
 end

data/lib/github_v3_api/repo.rb

@@ -0,0 +1,16 @@
+# See GitHubV3API documentation in lib/github_v3_api.rb
+class GitHubV3API
+  # Represents a single GitHub Repo and provides access to its data attributes.
+  class Repo < Entity
+    attr_reader :created_at, :description, :fork, :forks, :has_downloads,
+      :has_issues, :has_wiki, :homepage, :html_url, :language, :master_branch,
+      :name, :open_issues, :organization, :owner, :parent, :private, :pushed_at,
+      :size, :source, :url, :watchers
+
+    private
+
+    def natural_key
+      [data['owner']['login'], data['name']]
+    end
+  end
+end

data/lib/github_v3_api/repos_api.rb

@@ -0,0 +1,45 @@
+# See GitHubV3API documentation in lib/github_v3_api.rb
+class GitHubV3API
+  # Provides access to the GitHub Repos API (http://developer.github.com/v3/repos/)
+  #
+  # example:
+  #
+  #   api = GitHubV3API.new(ACCESS_TOKEN)
+  #
+  #   # get list of all of the user's public and private repos
+  #   repos = api.repos.list
+  #   #=> returns an array of GitHubV3API::Repo instances
+  #
+  #   repo = api.repo.get('octocat', 'hello-world')
+  #   #=> returns an instance of GitHubV3API::Repo
+  #
+  #   repo.name
+  #   #=> 'hello-world'
+  #
+  class ReposAPI
+    # Typically not used directly. Use GitHubV3API#repos instead.
+    #
+    # +connection+:: an instance of GitHubV3API
+    def initialize(connection)
+      @connection = connection
+    end
+
+    # Returns an array of GitHubV3API::Repo instances representing the
+    # user's public and private repos
+    def list
+      @connection.get('/user/repos').map do |repo_data|
+        GitHubV3API::Repo.new(self, repo_data)
+      end
+    end
+
+    # Returns a GitHubV3API::Repo instance for 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 get(user, repo_name)
+      org_data = @connection.get("/repos/#{user}/#{repo_name}")
+      GitHubV3API::Repo.new_with_all_data(self, org_data)
+    end
+  end
+end

data/lib/github_v3_api.rb

@@ -1,7 +1,10 @@
 require 'rest-client'
 require 'json'
+require 'github_v3_api/entity'
 require 'github_v3_api/orgs_api'
 require 'github_v3_api/org'
+require 'github_v3_api/repos_api'
+require 'github_v3_api/repo'
 
 # This is the main entry-point to the GitHub v3 API.
 #
@@ -30,6 +33,14 @@ class GitHubV3API
     OrgsAPI.new(self)
   end
 
+  # Entry-point for access to the GitHub Repos API
+  #
+  # Returns an instance of GitHubV3API::ReposAPI that will use the access_token
+  # associated with this instance.
+  def repos
+    ReposAPI.new(self)
+  end
+
   def get(path) #:nodoc:
     result = RestClient.get("https://api.github.com" + path,
                             {:accept => :json,

data/spec/github_v3_api_spec.rb

@@ -12,6 +12,13 @@ describe GitHubV3API do
     end
   end
 
+  describe '#repos' do
+    it 'returns an instance of GitHubV3API::ReposAPI' do
+      api = GitHubV3API.new('abcde')
+      api.repos.should be_kind_of GitHubV3API::ReposAPI
+    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) \

data/spec/org_spec.rb

@@ -35,4 +35,13 @@ describe GitHubV3API::Org do
       org['foo'].should be_nil
     end
   end
+
+  describe '#repos' do
+    it 'returns an array of Repo objects that belong to this org' do
+      api = mock(GitHubV3API::OrgsAPI)
+      api.should_receive(:list_repos).with('github').and_return([:repo1, :repo2])
+      org = GitHubV3API::Org.new_with_all_data(api, 'login' => 'github')
+      org.repos.should == [:repo1, :repo2]
+    end
+  end
 end

data/spec/orgs_api_spec.rb

@@ -22,4 +22,21 @@ describe GitHubV3API::OrgsAPI do
       api.get('octocat').should == :org
     end
   end
+
+  describe '#list_repos' do
+    it 'returns the public and private repos for the specified org' do
+      connection = mock(GitHubV3API, :repos => :repos_api)
+      connection.should_receive(:get) \
+        .with('/orgs/github/repos') \
+        .and_return([:repo1_hash, :repo2_hash])
+      GitHubV3API::Repo.should_receive(:new) \
+        .with(:repos_api, :repo1_hash) \
+        .and_return(:repo1)
+      GitHubV3API::Repo.should_receive(:new) \
+        .with(:repos_api, :repo2_hash) \
+        .and_return(:repo2)
+      api = GitHubV3API::OrgsAPI.new(connection)
+      api.list_repos('github').should == [:repo1, :repo2]
+    end
+  end
 end

data/spec/repo_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe GitHubV3API::Repo do
+  describe 'attr_readers' do
+    it 'should define attr_readers that pull values from the repo data' do
+      fields = %w(created_at description fork forks has_downloads has_issues
+          has_wiki homepage html_url language master_branch name open_issues
+          organization owner parent private pushed_at size source url watchers)
+      fields.each do |f|
+        repo = GitHubV3API::Repo.new_with_all_data(stub('api'), {f.to_s => 'foo'})
+        repo.methods.should include(f)
+        repo.send(f).should == 'foo'
+      end
+    end
+  end
+
+  describe '#[]' do
+    it 'returns the repo data for the specified key' do
+      api = stub(GitHubV3API::ReposAPI)
+      repo = GitHubV3API::Repo \
+        .new_with_all_data(api, 'name' => 'hello-world', 'owner' => {'login' => 'octocat'})
+      repo['name'].should == 'hello-world'
+    end
+
+    it 'only fetches the data once' do
+      api = mock(GitHubV3API::ReposAPI)
+      api.should_receive(:get).once.with('octocat', 'hello-world') \
+        .and_return(GitHubV3API::Repo.new(api, 'name' => 'hello-world', 'owner' => {'login' => 'octocat'}, 'private' => true))
+      repo = GitHubV3API::Repo.new(api, 'name' => 'hello-world', 'owner' => {'login' => 'octocat'})
+      repo['name'].should == 'hello-world'
+      repo['owner'].should == {'login' => 'octocat'}
+      repo['private'].should == true
+    end
+  end
+end

data/spec/repos_api_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe GitHubV3API::ReposAPI do
+  describe '#list' do
+    it 'returns the public and private repos for the authenticated user' do
+      connection = mock(GitHubV3API)
+      connection.should_receive(:get).with('/user/repos').and_return([:repo_hash1, :repo_hash2])
+      api = GitHubV3API::ReposAPI.new(connection)
+      GitHubV3API::Repo.should_receive(:new).with(api, :repo_hash1).and_return(:repo1)
+      GitHubV3API::Repo.should_receive(:new).with(api, :repo_hash2).and_return(:repo2)
+      repos = api.list
+      repos.should == [:repo1, :repo2]
+    end
+  end
+
+  describe '#get' do
+    it 'returns a fully-hydrated Repo object for the specified user and repo name' do
+      connection = mock(GitHubV3API)
+      connection.should_receive(:get).with('/repos/octocat/hello-world').and_return(:repo_hash)
+      api = GitHubV3API::ReposAPI.new(connection)
+      GitHubV3API::Repo.should_receive(:new_with_all_data).with(api, :repo_hash).and_return(:repo)
+      api.get('octocat', 'hello-world').should == :repo
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: github-v3-api
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - John Wilger
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-23 00:00:00 -07:00
+date: 2011-06-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -167,11 +167,16 @@ files:
 - github-v3-api.gemspec
 - lib/github-v3-api.rb
 - lib/github_v3_api.rb
+- lib/github_v3_api/entity.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/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