github-v3-api 0.1.0 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/github-v3-api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "github-v3-api"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Wilger"]
-  s.date = "2011-10-18"
+  s.date = "2011-12-05"
   s.description = "Ponies"
   s.email = "johnwilger@gmail.com"
   s.extra_rdoc_files = [
@@ -37,6 +37,8 @@ Gem::Specification.new do |s|
     "lib/github_v3_api/orgs_api.rb",
     "lib/github_v3_api/repo.rb",
     "lib/github_v3_api/repos_api.rb",
+    "lib/github_v3_api/user.rb",
+    "lib/github_v3_api/users_api.rb",
     "spec/github_v3_api_spec.rb",
     "spec/issue_spec.rb",
     "spec/issues_api_spec.rb",
@@ -44,7 +46,9 @@ Gem::Specification.new do |s|
     "spec/orgs_api_spec.rb",
     "spec/repo_spec.rb",
     "spec/repos_api_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/spec_helper.rb",
+    "spec/user_api_spec.rb",
+    "spec/user_spec.rb"
   ]
   s.homepage = "http://github.com/jwilger/github-v3-api"
   s.licenses = ["MIT"]

data/lib/github_v3_api.rb

@@ -3,6 +3,8 @@ require 'json'
 require 'github_v3_api/entity'
 require 'github_v3_api/issues_api'
 require 'github_v3_api/issue'
+require 'github_v3_api/users_api'
+require 'github_v3_api/user'
 require 'github_v3_api/orgs_api'
 require 'github_v3_api/org'
 require 'github_v3_api/repos_api'
@@ -36,6 +38,14 @@ class GitHubV3API
     @access_token = access_token
   end
 
+  # Entry-point for access to the GitHub Users API
+  #
+  # Returns an instance of GitHubV3API::UserAPI that will use the access_token
+  # associated with this instance.
+  def users
+    UsersAPI.new(self)
+  end
+
   # Entry-point for access to the GitHub Orgs API
   #
   # Returns an instance of GitHubV3API::OrgsAPI that will use the access_token

data/lib/github_v3_api/user.rb

@@ -0,0 +1,15 @@
+# See GitHubV3API documentation in lib/github_v3_api.rb
+class GitHubV3API
+  # Represents a single GitHub User and provides access to its data attributes.
+  class User < Entity
+    attr_reader :login, :id, :avatar_url, :gravatar_id, :url, :name, :company, 
+                :blog, :location, :email, :hireable, :bio, :public_repos, :public_gists, 
+                :followers, :following, :html_url, :created_at, :type, :total_private_repos, 
+                :owned_private_repos, :private_gists, :disk_usage, :collaborators
+    private 
+
+    def natural_key
+      [data['login']]
+    end
+  end
+end

data/lib/github_v3_api/users_api.rb

@@ -0,0 +1,40 @@
+# See GitHubV3API documentation in lib/github_v3_api.rb
+class GitHubV3API
+  # Provides access to the GitHub Users API (http://developer.github.com/v3/users/)
+  #
+  # example:
+  #
+  #   api = GitHubV3API.new(ACCESS_TOKEN)
+  #
+  #   # get list of logged-in user
+  #   a_user = api.current
+  #   #=> returns an instance of GitHubV3API::User
+  #
+  #   a_user.login
+  #   #=> 'jwilger'
+  #
+  class UsersAPI
+    # Typically not used directly. Use GitHubV3API#users instead.
+    #
+    # +connection+:: an instance of GitHubV3API
+    def initialize(connection)
+      @connection = connection
+    end
+
+    # Returns a single GitHubV3API::User instance representing the
+    # currently logged in user
+    def current
+      user_data = @connection.get("/user")
+      GitHubV3API::User.new(self, user_data)
+    end
+    
+    # Returns a GitHubV3API::User instance for the specified +username+.
+    #
+    # +username+:: the string login of the user, e.g. "octocat"
+    def get(username)
+      user_data = @connection.get("/users/#{username}")
+      GitHubV3API::User.new_with_all_data(self, user_data)
+    end
+    
+  end
+end

data/spec/user_api_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe GitHubV3API::UsersAPI do
+  describe '#current' do
+    it 'returns the user data for the authenticated user' do
+      connection = mock(GitHubV3API)
+      connection.should_receive(:get).with('/user').and_return(:user_hash1)
+      api = GitHubV3API::UsersAPI.new(connection)
+      GitHubV3API::User.should_receive(:new).with(api, :user_hash1).and_return(:user1)
+      user = api.current
+      user.should == :user1
+    end
+  end
+
+  describe '#get' do
+    it 'returns a fully-hydrated User object for the specified user login' do
+      connection = mock(GitHubV3API)
+      connection.should_receive(:get).with('/users/octocat').and_return(:user_hash)
+      api = GitHubV3API::UsersAPI.new(connection)
+      GitHubV3API::User.should_receive(:new_with_all_data).with(api, :user_hash).and_return(:user)
+      api.get('octocat').should == :user
+    end
+  end
+
+end

data/spec/user_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe GitHubV3API::User do
+  describe 'attr_readers' do
+    it 'should define attr_readers that pull values from the user data' do
+      fields = %w(login id avatar_url gravatar_id url name company blog location 
+                  email hireable bio public_repos public_gists followers following 
+                  html_url created_at type total_private_repos owned_private_repos 
+                  private_gists disk_usage collaborators)
+      fields.each do |f|
+        user = GitHubV3API::User.new_with_all_data(stub('api'), {f.to_s => 'foo'})
+        user.methods.should include(f.to_sym)
+        user.send(f).should == 'foo'
+      end
+    end
+  end
+
+  describe '#[]' do
+    it 'returns the user data for the specified key' do
+      api = mock(GitHubV3API::UsersAPI)
+      api.should_receive(:get).with('github') \
+        .and_return(GitHubV3API::User.new(api, 'login' => 'github', 'name' => 'GitHub'))
+      user = GitHubV3API::User.new(api, 'login' => 'github')
+      user['name'].should == 'GitHub'
+    end
+
+    it 'only fetches the data once' do
+      api = mock(GitHubV3API::UsersAPI)
+      api.should_receive(:get).once.with('github') \
+        .and_return(GitHubV3API::User.new(api, 'login' => 'github', 'name' => 'GitHub'))
+      user = GitHubV3API::User.new(api, 'login' => 'github')
+      user['login'].should == 'github'
+      user['name'].should == 'GitHub'
+      user['foo'].should be_nil
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github-v3-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-18 00:00:00.000000000Z
+date: 2011-12-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2159155400 !ruby/object:Gem::Requirement
+  requirement: &2168649880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.3
   type: :runtime
   prerelease: false
-  version_requirements: *2159155400
+  version_requirements: *2168649880
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2159154920 !ruby/object:Gem::Requirement
+  requirement: &2168649400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *2159154920
+  version_requirements: *2168649400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2159154440 !ruby/object:Gem::Requirement
+  requirement: &2168648920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2159154440
+  version_requirements: *2168648920
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2159153960 !ruby/object:Gem::Requirement
+  requirement: &2168648440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2159153960
+  version_requirements: *2168648440
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2159153480 !ruby/object:Gem::Requirement
+  requirement: &2168647960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.0
   type: :development
   prerelease: false
-  version_requirements: *2159153480
+  version_requirements: *2168647960
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2159153000 !ruby/object:Gem::Requirement
+  requirement: &2168663860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2159153000
+  version_requirements: *2168663860
 - !ruby/object:Gem::Dependency
   name: reek
-  requirement: &2159152520 !ruby/object:Gem::Requirement
+  requirement: &2168663380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.2.8
   type: :development
   prerelease: false
-  version_requirements: *2159152520
+  version_requirements: *2168663380
 - !ruby/object:Gem::Dependency
   name: roodi
-  requirement: &2159152040 !ruby/object:Gem::Requirement
+  requirement: &2168662900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *2159152040
+  version_requirements: *2168662900
 description: Ponies
 email: johnwilger@gmail.com
 executables: []
@@ -127,6 +127,8 @@ files:
 - lib/github_v3_api/orgs_api.rb
 - lib/github_v3_api/repo.rb
 - lib/github_v3_api/repos_api.rb
+- lib/github_v3_api/user.rb
+- lib/github_v3_api/users_api.rb
 - spec/github_v3_api_spec.rb
 - spec/issue_spec.rb
 - spec/issues_api_spec.rb
@@ -135,6 +137,8 @@ files:
 - spec/repo_spec.rb
 - spec/repos_api_spec.rb
 - spec/spec_helper.rb
+- spec/user_api_spec.rb
+- spec/user_spec.rb
 homepage: http://github.com/jwilger/github-v3-api
 licenses:
 - MIT
@@ -150,7 +154,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3092793002911622780
+      hash: -423517937058714579
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: