octokit 1.2.1 → 1.3.0

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 # CHANGELOG
 
+* [1.3.0 - May 17, 2012](https://github.com/pengwynn/octokit/compare/v1.2.1...v1.3.0)
 * [1.2.0 - May 17, 2012](https://github.com/pengwynn/octokit/compare/v1.1.1...v1.2.0)
 * [1.1.1 - May 15, 2012](https://github.com/pengwynn/octokit/compare/v1.1.0...v1.1.1)
 * [1.1.0 - May 13, 2012](https://github.com/pengwynn/octokit/compare/v1.0.7...v1.1.0)

data/lib/octokit/client.rb

@@ -20,6 +20,7 @@ require 'octokit/client/repositories'
 require 'octokit/client/timelines'
 require 'octokit/client/users'
 require 'octokit/client/events'
+require 'octokit/client/authorizations'
 
 module Octokit
   class Client
@@ -52,5 +53,6 @@ module Octokit
     include Octokit::Client::Timelines
     include Octokit::Client::Users
     include Octokit::Client::Events
+    include Octokit::Client::Authorizations
   end
 end

data/lib/octokit/client/authorizations.rb

@@ -0,0 +1,101 @@
+module Octokit
+  class Client
+    module Authorizations
+
+      # List a users authorizations
+      #
+      # API for users to manage their own tokens. 
+      # You can only access your own tokens, and only through 
+      # Basic Authentication.
+      #
+      # @return [Array] A list of authorizations for the authenticated user
+      # @see http://developer.github.com/v3/oauth/#list-your-authorizations
+      # @example List authorizations for user ctshryock
+      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
+      #  client.authorizations
+      def authorizations
+        get('/authorizations')
+      end
+
+
+      # Get a single authorization for the authenticated user.
+      #
+      # You can only access your own tokens, and only through 
+      # Basic Authentication.
+      #
+      # @return [Authorization] A single authorization for the authenticated user
+      # @see http://developer.github.com/v3/oauth/#get-a-single-authorization
+      # @example Show authorization for user ctshryock's Travis auth
+      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
+      #  client.authorization(999999)
+      def authorization(number)
+        get("/authorizations/#{number}")
+      end
+
+      # Create an authorization for the authenticated user.
+      #
+      # You can create your own tokens, and only through 
+      # Basic Authentication.
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] :scopes A list of scopes that this authorization is in.
+      #   See http://developer.github.com/v3/oauth/#scopes for available scopes
+      # @option options [String] :note A note to remind you what the OAuth token is for.
+      # @option options [String] :note_url A URL to remind you what app the OAuth token is for.
+      #
+      # @return [Authorization] A single authorization for the authenticated user
+      # @see http://developer.github.com/v3/oauth/#create-a-new-authorization
+      # @example Create a new authorization for user ctshryock's project Zoidberg
+      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
+      #  client.create_authorization({:scopes => ["public_repo","gist"], :note => "Why not Zoidberg?", :note_url=> "https://en.wikipedia.org/wiki/Zoidberg"})
+      def create_authorization(options={})
+        # Techincally we can omit scopes as GitHub has a default, however the
+        # API will reject us if we send a POST request with an empty body.
+        options = {:scopes => ""}.merge(options)
+        post('/authorizations', options)
+      end
+
+      # Update an authorization for the authenticated user.
+      #
+      # You can update your own tokens, but only through 
+      # Basic Authentication.
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array] :scopes Replace the authorization scopes with these.
+      # @option options [Array] :add_scopes A list of scopes to add to this authorization.
+      # @option options [Array] :remove_scopes A list of scopes to remove from this authorization.
+      # @option options [String] :note A note to remind you what the OAuth token is for.
+      # @option options [String] :note_url A URL to remind you what app the OAuth token is for.
+      #
+      # @return [Authorization] A single (updated) authorization for the authenticated user
+      # @see http://developer.github.com/v3/oauth/#update-a-new-authorization
+      # @see http://developer.github.com/v3/oauth/#scopes for available scopes
+      # @example Update the authorization for user ctshryock's project Zoidberg
+      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
+      #  client.create_authorization({:add_scopes => ["gist", "repo"], :note => "Why not Zoidberg possibly?"})
+      def update_authorization(number, options={})
+        # Techincally we can omit scopes as GitHub has a default, however the
+        # API will reject us if we send a POST request with an empty body.
+        options = {:scopes => ""}.merge(options)
+        patch("/authorizations/#{number}", options)
+      end
+
+      # Delete an authorization for the authenticated user.
+      #
+      # You can delete your own tokens, and only through 
+      # Basic Authentication.
+      #
+      # @param number [Number] An existing Authorization ID
+      #
+      # @return [Status] A raw status response
+      # @see http://developer.github.com/v3/oauth/#delete-an-authorization
+      # @example Delete an authorization 
+      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
+      #  client.delete_authorization(999999)
+      def delete_authorization(number)
+        delete("/authorizations/#{number}", {}, 3, true, true)
+      end
+
+    end
+  end
+end

data/lib/octokit/request.rb

@@ -22,6 +22,18 @@ module Octokit
       request(:put, path, options, version, authenticate, raw, force_urlencoded)
     end
 
+    def ratelimit
+      headers = get("/rate_limit",{}, api_version, true, true).headers
+      return headers["X-RateLimit-Limit"].to_i
+    end
+    alias rate_limit ratelimit
+
+    def ratelimit_remaining
+      headers = get("/rate_limit",{}, api_version, true, true).headers
+      return headers["X-RateLimit-Remaining"].to_i
+    end
+    alias rate_limit_remaining ratelimit_remaining
+
     private
 
     def request(method, path, options, version, authenticate, raw, force_urlencoded)

data/lib/octokit/version.rb

@@ -1,3 +1,3 @@
 module Octokit
-  VERSION = "1.2.1" unless defined?(Octokit::VERSION)
+  VERSION = "1.3.0" unless defined?(Octokit::VERSION)
 end

data/spec/fixtures/v3/authorization.json

@@ -0,0 +1,16 @@
+{
+  "created_at": "2012-02-08T01:47:27Z",
+  "note_url": null,
+  "scopes": [
+    "public_repo"
+  ],
+  "url": "https://api.github.com/authorizations/999999",
+  "updated_at": "2012-03-08T14:26:36Z",
+  "app": {
+    "url": "http://travis-ci.org",
+    "name": "Travis"
+  },
+  "token": "eCx/G1S8O2YuoNp72qrCRPur+k4tUr20hiEs9UjfvS9aHs2x",
+  "note": null,
+  "id": 999999
+}

data/spec/fixtures/v3/authorizations.json

@@ -0,0 +1,66 @@
+[
+  {
+    "created_at": "2011-08-23T15:56:09Z",
+    "scopes": [
+      "user"
+    ],
+    "url": "https://api.github.com/authorizations/999999",
+    "updated_at": "2011-12-14T13:15:47Z",
+    "app": {
+      "url": "http://calendaraboutnothing.com",
+      "name": "Calendar About Nothing"
+    },
+    "note_url": null,
+    "token": "eCx/G1S8O2YuoNp72qrCRPur+k4tUr20hiEs9UjfvS9aHs2x",
+    "note": null,
+    "id": 999999
+  },
+  {
+    "created_at": "2011-09-16T03:17:07Z",
+    "scopes": [
+      "repo"
+    ],
+    "url": "https://api.github.com/authorizations/999999",
+    "updated_at": "2011-09-16T21:08:16Z",
+    "app": {
+      "url": "http://forrst.com",
+      "name": "Forrst"
+    },
+    "note_url": null,
+    "token": "eCx/G1S8O2YuoNp72qrCRPur+k4tUr20hiEs9UjfvS9aHs2x",
+    "note": null,
+    "id": 999999
+  },
+  {
+    "created_at": "2011-09-16T13:26:32Z",
+    "scopes": [
+
+    ],
+    "url": "https://api.github.com/authorizations/999999",
+    "updated_at": "2012-03-13T12:40:36Z",
+    "app": {
+      "url": "http://coderwall.com",
+      "name": "coderwall.com"
+    },
+    "note_url": null,
+    "token": "eCx/G1S8O2YuoNp72qrCRPur+k4tUr20hiEs9UjfvS9aHs2x",
+    "note": null,
+    "id": 999999
+  },
+  {
+    "created_at": "2012-02-08T01:47:27Z",
+    "scopes": [
+      "public_repo"
+    ],
+    "url": "https://api.github.com/authorizations/999999",
+    "updated_at": "2012-03-08T14:26:36Z",
+    "app": {
+      "url": "http://travis-ci.org",
+      "name": "Travis"
+    },
+    "note_url": null,
+    "token": "eCx/G1S8O2YuoNp72qrCRPur+k4tUr20hiEs9UjfvS9aHs2x",
+    "note": null,
+    "id": 999999
+  }
+]

data/spec/helper.rb

@@ -60,7 +60,7 @@ def github_url(url)
   if url =~ /^http/
     url
   elsif @client && @client.authenticated?
-    "https://pengwynn%2Ftoken:OU812@api.github.com#{url}"
+    "https://#{@client.login}:#{@client.password}@api.github.com#{url}"
   elsif @client && @client.oauthed?
     "https://api.github.com#{url}?access_token=#{@client.oauth_token}"
   else

data/spec/octokit/client/authorizations_spec.rb

@@ -0,0 +1,59 @@
+# -*- encoding: utf-8 -*-
+require 'helper'
+
+describe Octokit::Client::Authorizations do
+
+  before do
+    @client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
+  end
+
+
+  it "should list existing authorizations" do
+    stub_get("/authorizations").
+      to_return(:body => fixture("v3/authorizations.json"))
+    authorizations = @client.authorizations
+    authorizations.first.app.name.should == "Calendar About Nothing" 
+  end
+
+  it "should return a single authorization" do
+    stub_get("/authorizations/999999").
+      to_return(:body => fixture("v3/authorization.json"))
+    authorization = @client.authorization(999999)
+    authorization.app.name.should == "Travis" 
+  end
+
+  it "should create a new default authorization" do
+    stub_post('/authorizations').
+      with(:body => {"scopes" => ""},
+           :headers => {'Content-Type'=>'application/json'}).
+      to_return(:body => fixture("v3/authorization.json"))
+    authorization = @client.create_authorization
+    authorization.app.name.should == "Travis" 
+  end
+
+  it "should create a new authorization with options" do
+    stub_post('/authorizations').
+      with(:body => {"scopes" => ["public_repo"],"note" => "admin script", "note_url" => "https://github.com/pengwynn/octokit"},
+           :headers => {'Content-Type'=>'application/json'}).
+      to_return(:body => fixture("v3/authorization.json"))
+    authorization = @client.create_authorization({:scopes => ["public_repo"], :note => "admin script", :note_url => "https://github.com/pengwynn/octokit"})
+    authorization.scopes.should include("public_repo")
+  end
+
+  it "should update and existing authorization" do
+    stub_patch('/authorizations/999999').
+      with(:body => {"scopes"=>"", "add_scopes" => ["public_repo", "gist"]},
+           :headers => {'Content-Type'=>'application/json'}).
+      to_return(:body => fixture("v3/authorization.json"))
+    authorization = @client.update_authorization(999999, {:add_scopes => ['public_repo', 'gist']})
+    authorization.scopes.should include("public_repo")
+  end
+
+  it "should delete an existing authorization" do
+    stub_delete('/authorizations/999999').
+      to_return(:status => 204)
+    authorization = @client.delete_authorization(999999)
+    authorization.status.should == 204
+  end
+
+end

data/spec/octokit/client/gists_spec.rb

@@ -72,7 +72,7 @@ describe Octokit::Client::Gists do
     it "should edit an existing gist" do
       gist_content = JSON.parse(fixture("v3/gist.json").read)
       gist_id = gist_content['id']
-      updated_gist = gist_content.merge(:description => 'updated')
+      updated_gist = gist_content.merge('description' => 'updated')
 
       stub_patch("/gists/#{gist_id}").
         to_return(:body => updated_gist)

data/spec/octokit/client_spec.rb

@@ -43,4 +43,23 @@ describe Octokit::Client do
 
   end
 
+  describe "ratelimit" do
+
+    before(:each) do
+      stub_request(:get, "https://api.github.com/rate_limit").
+        to_return(:status => 200, :body => '', :headers =>
+          { 'X-RateLimit-Limit' => 5000, 'X-RateLimit-Remaining' => 5000})
+      @client = Octokit::Client.new()
+    end
+
+    it "should get the ratelimit-limit from the header" do
+      @client.ratelimit.should == 5000
+    end
+
+    it "should get the ratelimit-remaining using header" do
+      @client.ratelimit_remaining.should == 5000
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-20 00:00:00.000000000 Z
+date: 2012-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70239311442360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,15 +23,10 @@ dependencies:
         version: '2.2'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.2'
+  version_requirements: *70239311442360
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70239311441620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -39,15 +34,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.8'
+  version_requirements: *70239311441620
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70239311440380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,15 +45,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.8'
+  version_requirements: *70239311440380
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70239311438260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -71,15 +56,10 @@ dependencies:
         version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
+  version_requirements: *70239311438260
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70239311436780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,15 +67,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
+  version_requirements: *70239311436780
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70239311433780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -103,15 +78,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70239311433780
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70239311411840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -119,15 +89,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70239311411840
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70239311410940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -135,15 +100,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70239311410940
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70239311407980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -151,15 +111,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70239311407980
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70239311406460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -167,15 +122,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70239311406460
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70239311405000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -183,15 +133,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70239311405000
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70239311403620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -199,12 +144,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70239311403620
 description: Simple wrapper for the GitHub v3 API
 email:
 - wynn.netherland@gmail.com
@@ -228,6 +168,7 @@ files:
 - lib/octokit.rb
 - lib/octokit/authentication.rb
 - lib/octokit/client.rb
+- lib/octokit/client/authorizations.rb
 - lib/octokit/client/commits.rb
 - lib/octokit/client/downloads.rb
 - lib/octokit/client/events.rb
@@ -264,6 +205,8 @@ files:
 - spec/fixtures/v2/tree_metadata.json
 - spec/fixtures/v2/user.json
 - spec/fixtures/v2/users.json
+- spec/fixtures/v3/authorization.json
+- spec/fixtures/v3/authorizations.json
 - spec/fixtures/v3/blob.json
 - spec/fixtures/v3/branches.json
 - spec/fixtures/v3/collaborators.json
@@ -324,6 +267,7 @@ files:
 - spec/fixtures/v3/watched.json
 - spec/fixtures/v3/watchers.json
 - spec/helper.rb
+- spec/octokit/client/authorizations_spec.rb
 - spec/octokit/client/commits_spec.rb
 - spec/octokit/client/downloads_spec.rb
 - spec/octokit/client/events_spec.rb
@@ -365,7 +309,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Simple wrapper for the GitHub v3 API
@@ -382,6 +326,8 @@ test_files:
 - spec/fixtures/v2/tree_metadata.json
 - spec/fixtures/v2/user.json
 - spec/fixtures/v2/users.json
+- spec/fixtures/v3/authorization.json
+- spec/fixtures/v3/authorizations.json
 - spec/fixtures/v3/blob.json
 - spec/fixtures/v3/branches.json
 - spec/fixtures/v3/collaborators.json
@@ -442,6 +388,7 @@ test_files:
 - spec/fixtures/v3/watched.json
 - spec/fixtures/v3/watchers.json
 - spec/helper.rb
+- spec/octokit/client/authorizations_spec.rb
 - spec/octokit/client/commits_spec.rb
 - spec/octokit/client/downloads_spec.rb
 - spec/octokit/client/events_spec.rb