github-v3-api 0.0.3 → 0.0.4

data/.rvmrc

@@ -1,2 +1,2 @@
-rvm use ree-1.8.7-2011.03@github-v3-api --create --install
+rvm use ruby-1.9.2-p180@github-v3-api --create --install
 bundle check

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/bin/github-v3-api-get-token

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+puts <<EOF
+This script will start a sinatra web app on your machine that can log you in to
+GitHub and show you your access token. This access token can then be used with
+the GitHubV3API.
+
+Once the server has started, just browse to http://localhost:4567. You may be
+prompted to log in to GitHub and/or authorize the app.  After that, your access
+token will be displayed to you.
+
+You will need to create a GitHub Application in order to use this. Just go to
+https://github.com/account/applications/new and fill out the form. Pick any name
+you want, and use http://localhost:4567 and
+http://localhost:4567/auth/github/callback for the Main and Callback URLs,
+respectively. After creating the application, use the generated client id and
+client secret by running this script with the OAUTH_GITHUB_CLIENT_ID and
+OATH_GITHUB_CLIENT_SECRET environment variables set.
+EOF
+
+print "Ready to go? (y/N): "
+
+answer = STDIN.gets.chomp
+
+unless answer =~ /^y(es)?$/i
+  exit(1)
+end
+
+unless ENV['OAUTH_GITHUB_CLIENT_ID'] && ENV['OAUTH_GITHUB_CLIENT_SECRET']
+  raise "Please set the OAUTH_GITHUB_CLIENT_ID and OAUTH_GITHUB_CLIENT_SECRET " \
+    + "environment variables before running this."
+end
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.setup(:sinatra)
+require 'sinatra'
+require 'openssl'
+require 'omniauth'
+
+enable :sessions
+
+use OmniAuth::Builder do
+  provider :github, ENV['OAUTH_GITHUB_CLIENT_ID'], ENV['OAUTH_GITHUB_CLIENT_SECRET'],
+    :scope => 'user,repo,gist'
+end
+
+get '/' do
+  redirect '/auth/github'
+end
+
+get '/auth/github/callback' do
+  token = request.env['omniauth.auth']['credentials']['token']
+  "Your GitHub Access Token is #{token}"
+end

data/github-v3-api.gemspec

@@ -5,13 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{github-v3-api}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Wilger"]
-  s.date = %q{2011-06-24}
+  s.date = %q{2011-07-03}
+  s.default_executable = %q{github-v3-api-get-token}
   s.description = %q{Ponies}
   s.email = %q{johnwilger@gmail.com}
+  s.executables = ["github-v3-api-get-token"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -26,7 +28,7 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
-    "get_access_token_sinatra_app.rb.template",
+    "bin/github-v3-api-get-token",
     "github-v3-api.gemspec",
     "lib/github-v3-api.rb",
     "lib/github_v3_api.rb",

data/lib/github_v3_api.rb

@@ -17,6 +17,12 @@ require 'github_v3_api/repo'
 #   #=> an instance of GitHubV3API::OrgsAPI
 #
 class GitHubV3API
+  # Raised when an API request returns a 404 error
+  NotFound = Class.new(RuntimeError)
+
+  # Raised when an API request uses an invalid access token
+  Unauthorized = Class.new(RuntimeError)
+
   # Returns a GitHubV3API instance that is able to access github with the
   # +access_token+ owner's authorization.
   #
@@ -46,5 +52,7 @@ class GitHubV3API
                             {:accept => :json,
                              :authorization => "token #{@access_token}"})
     JSON.parse(result)
+  rescue RestClient::Unauthorized
+    raise Unauthorized, "The access token is invalid according to GitHub"
   end
 end

data/lib/github_v3_api/repo.rb

@@ -7,6 +7,10 @@ class GitHubV3API
       :name, :open_issues, :organization, :owner, :parent, :private, :pushed_at,
       :size, :source, :url, :watchers
 
+    def owner_login
+      owner['login']
+    end
+
     private
 
     def natural_key

data/lib/github_v3_api/repos_api.rb

@@ -40,6 +40,8 @@ class GitHubV3API
     def get(user, repo_name)
       org_data = @connection.get("/repos/#{user}/#{repo_name}")
       GitHubV3API::Repo.new_with_all_data(self, org_data)
+    rescue RestClient::ResourceNotFound
+      raise NotFound, "The repository #{user}/#{repo_name} does not exist or is not visible to the user."
     end
   end
 end

data/spec/github_v3_api_spec.rb

@@ -33,5 +33,11 @@ describe GitHubV3API do
       api = GitHubV3API.new('abcde')
       api.get('/something').should == [{"foo" => "bar"}]
     end
+
+    it 'raises GitHubV3API::Unauthorized instead of RestClient::Unauthorized' do
+      RestClient.stub!(:get).and_raise(RestClient::Unauthorized)
+      api = GitHubV3API.new('abcde')
+      lambda { api.get('/something') }.should raise_error(GitHubV3API::Unauthorized)
+    end
   end
 end

data/spec/org_spec.rb

@@ -10,7 +10,7 @@ describe GitHubV3API::Org do
         total_private_repos type url)
       fields.each do |f|
         org = GitHubV3API::Org.new_with_all_data(stub('api'), {f.to_s => 'foo'})
-        org.methods.should include(f)
+        org.methods.should include(f.to_sym)
         org.send(f).should == 'foo'
       end
     end

data/spec/repo_spec.rb

@@ -8,7 +8,7 @@ describe GitHubV3API::Repo do
           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.methods.should include(f.to_sym)
         repo.send(f).should == 'foo'
       end
     end
@@ -32,4 +32,12 @@ describe GitHubV3API::Repo do
       repo['private'].should == true
     end
   end
+
+  describe '#owner_login' do
+    it 'returns the login name of the repo owner' do
+      api = stub(GitHubV3API::ReposAPI)
+      repo = GitHubV3API::Repo.new_with_all_data(api, 'owner' => {'login' => 'octocat'})
+      repo.owner_login.should == 'octocat'
+    end
+  end
 end

data/spec/repos_api_spec.rb

@@ -21,5 +21,13 @@ describe GitHubV3API::ReposAPI do
       GitHubV3API::Repo.should_receive(:new_with_all_data).with(api, :repo_hash).and_return(:repo)
       api.get('octocat', 'hello-world').should == :repo
     end
+
+    it 'raises GitHubV3API::NotFound instead of a RestClient::ResourceNotFound' do
+      connection = mock(GitHubV3API)
+      connection.should_receive(:get) \
+        .and_raise(RestClient::ResourceNotFound)
+      api = GitHubV3API::ReposAPI.new(connection)
+      lambda { api.get('octocat', 'hello-world') }.should raise_error(GitHubV3API::NotFound)
+    end
   end
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: github-v3-api
 version: !ruby/object:Gem::Version 
-  hash: 25
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - John Wilger
@@ -15,139 +10,101 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-24 00:00:00 -07:00
-default_executable: 
+date: 2011-07-03 00:00:00 -07:00
+default_executable: github-v3-api-get-token
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  name: rest-client
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 6
-        - 3
         version: 1.6.3
-  name: rest-client
-  version_requirements: *id001
+  type: :runtime
   prerelease: false
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  name: json
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 5
-        - 3
         version: 1.5.3
-  name: json
-  version_requirements: *id002
+  type: :runtime
   prerelease: false
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: rspec
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 3
-        - 0
         version: 2.3.0
-  name: rspec
-  version_requirements: *id003
+  type: :development
   prerelease: false
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: bundler
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
         version: 1.0.0
-  name: bundler
-  version_requirements: *id004
+  type: :development
   prerelease: false
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: jeweler
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 6
-        - 0
         version: 1.6.0
-  name: jeweler
-  version_requirements: *id005
+  type: :development
   prerelease: false
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: rcov
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  name: rcov
-  version_requirements: *id006
+  type: :development
   prerelease: false
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: reek
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 2
-        - 8
         version: 1.2.8
-  name: reek
-  version_requirements: *id007
+  type: :development
   prerelease: false
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: roodi
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 1
-        - 0
         version: 2.1.0
-  name: roodi
-  version_requirements: *id008
+  type: :development
   prerelease: false
+  version_requirements: *id008
 description: Ponies
 email: johnwilger@gmail.com
-executables: []
-
+executables: 
+- github-v3-api-get-token
 extensions: []
 
 extra_rdoc_files: 
@@ -163,7 +120,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- get_access_token_sinatra_app.rb.template
+- bin/github-v3-api-get-token
 - github-v3-api.gemspec
 - lib/github-v3-api.rb
 - lib/github_v3_api.rb
@@ -192,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 1496179745078912717
       segments: 
       - 0
       version: "0"
@@ -201,9 +158,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 

data/get_access_token_sinatra_app.rb.template

@@ -1,25 +0,0 @@
-require 'rubygems'
-require 'bundler/setup'
-Bundler.setup(:sinatra)
-require 'sinatra'
-require 'openssl'
-require 'omniauth'
-
-# Because fuck you, Apple
-OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
-
-enable :sessions
-
-use OmniAuth::Builder do
-  provider :github, YOUR_APP_ID, YOUR_APP_SECRET,
-    :scope => 'user,repo,gist'
-end
-
-get '/' do
-  redirect '/auth/github'
-end
-
-get '/auth/github/callback' do
-  token = request.env['omniauth.auth']['credentials']['token']
-  "Your GitHub Access Token is #{token}"
-end