octokit 3.1.0 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe2687efdf727fedcb991105d4a5c9e7eb60d0d1
-  data.tar.gz: 16621b1aea7885ca2b4d1f7b508c815bcbaa717e
+  metadata.gz: 9f72cdeb9fbffb817b2077f5bfde2c2c58e1dcbb
+  data.tar.gz: a3d4f0d9868bf8b4d7fbcd9474165e1c20b6a549
 SHA512:
-  metadata.gz: dba5add3cb06441c097b1e02f74cecc55d0502d6a9d726680e3d61fb95d5a13d1d41f82203454abb2b42df7cf6588f26917c45d6a2b7d370e467df223f7a4d1d
-  data.tar.gz: aed860c22d4e46ed8b24c721231cd087d0ff497c36f91182091fa2145730e2c4b56504fd27a06abe83d1503fe7b7c44cb1a767f127690339706bad84c4ee3f05
+  metadata.gz: 5c307f0ae66aab040bb0a404f358dc7f49ae948c3f1a07a463870f62c9bd182fec340bffeb534e2e5c6ea680887456d7395e5e93349f975e1ce8906961b77401
+  data.tar.gz: 2b6e8309bb74397136462e0d3528d05485c672389cda723ac19de02fa6797817ed582e6d48d10dbdc3e010ac23c830175bcf16a8806187b6d15c981d27f6aa21

data/README.md

@@ -33,7 +33,7 @@ Install via Rubygems
 
 ... or add to your Gemfile
 
-    gem "octokit", "~> 2.0"
+    gem "octokit", "~> 3.0"
 
 ### Making requests
 
@@ -111,7 +111,7 @@ user = client.user
 user.login
 # => "defunkt"
 ```
-While Basic Authentication makes it easy to get started quickly, OAuth access
+While Basic Authentication allows you to get started quickly, OAuth access
 tokens are the preferred way to authenticate on behalf of users.
 
 ### OAuth access tokens
@@ -119,14 +119,14 @@ tokens are the preferred way to authenticate on behalf of users.
 [OAuth access tokens][oauth] provide two main benefits over using your username
 and password:
 
-* **Revokable access**. Access tokens can be revoked, removing access for just
+* **Revokable access**. Access tokens can be revoked, removing access for only
   that token without having to change your password everywhere.
 * **Limited access**. Access tokens have [access scopes][] which allow for more
   granular access to API resources. For instance, you can grant a third party
   access to your gists but not your private repositories.
 
-To use an access token with the Octokit client, just pass it in lieu of your
-username and password:
+To use an access token with the Octokit client, pass your token in the
+`:access_token` options parameter in lieu of your username and password:
 
 ```ruby
 client = Octokit::Client.new(:access_token => "<your 40 char token>")
@@ -136,8 +136,17 @@ user.login
 # => "defunkt"
 ```
 
-You can use `.create_authorization` to create a token using Basic Authorization
-that you can use for subsequent calls.
+You can [create access tokens through your GitHub Account Settings](https://help.github.com/articles/creating-an-access-token-for-command-line-use)
+or with a basic authenticated Octokit client:
+
+```ruby
+client = Octokit::Client.new \
+  :login    => 'defunkt',
+  :password => 'c0d3b4ssssss!'
+
+client.create_authorization(:scopes => ["user"], :note => "Name of token")
+# => <your new oauth token>
+```
 
 ### Two-Factor Authentication
 
@@ -160,7 +169,8 @@ client = Octokit::Client.new \
   :login    => 'defunkt',
   :password => 'c0d3b4ssssss!'
 
-client.create_authorization(:scopes => ["user"], :headers => { "X-GitHub-OTP" => "<your 2FA token>" })
+client.create_authorization(:scopes => ["user"], :note => "Name of token",
+                            :headers => { "X-GitHub-OTP" => "<your 2FA token>" })
 # => <your new oauth token>
 ```
 
@@ -208,8 +218,6 @@ client = Octokit::Client.new \
 user = client.user 'defunkt'
 ```
 
-
-
 [auth]: http://developer.github.com/v3/#authentication
 [oauth]: http://developer.github.com/v3/oauth/
 [access scopes]: http://developer.github.com/v3/oauth/#scopes
@@ -326,10 +334,10 @@ rel = repo.rels[:issues]
 # => #<Sawyer::Relation: issues: get https://api.github.com/repos/pengwynn/pingwynn/issues{/number}>
 
 # Get a page of issues
-repo.rels[:issues].get.data
+rel.get.data
 
 # Get issue #2
-repo.rels[:issues].get(:uri => {:number => 2}).data
+rel.get(:uri => {:number => 2}).data
 ```
 
 ### The Full Hypermedia Experience™
@@ -378,8 +386,9 @@ extended via middleware.
 
 ### Debugging
 
-Often, it helps to know what Octokit is doing under the hood. Faraday makes it
-easy to peek into the underlying HTTP traffic:
+Often, it helps to know what Octokit is doing under the hood. You can add a
+logger to the middleware that enables you to peek into the underlying HTTP
+traffic:
 
 ```ruby
 stack = Faraday::RackBuilder.new do |builder|
@@ -440,7 +449,7 @@ resource. See the [project README][cache] for advanced usage.
 ## Hacking on Octokit.rb
 
 If you want to hack on Octokit locally, we try to make [bootstrapping the
-project][bootstrapping] as painless as possible. Just clone and run:
+project][bootstrapping] as painless as possible. To start hacking, clone and run:
 
     script/bootstrap
 
@@ -455,12 +464,29 @@ console`, etc.  ensures your dependencies are up-to-date.
 ### Running and writing new tests
 
 Octokit uses [VCR][] for recording and playing back API fixtures during test
-runs. These fixtures are part of the Git project in the `spec/cassettes`
-folder. For the most part, tests use an authenticated client, using a token
-stored in `ENV['OCTOKIT_TEST_GITHUB_TOKEN']`. If you're not recording new
-cassettes, you don't need to have this set. If you do need to record new
-cassettes, this token can be any GitHub API token because the test suite strips
-the actual token from the cassette output before storing to disk.
+runs. These cassettes (fixtures) are part of the Git project in the `spec/cassettes`
+folder. If you're not recording new cassettes you can run the specs with existing
+cassettes with:
+
+    script/test
+
+Octokit uses environmental variables for storing credentials used in testing.
+If you are testing an API endpoint that doesn't require authentication, you
+can get away without any additional configuration. For the most part, tests
+use an authenticated client, using a token stored in `ENV['OCTOKIT_TEST_GITHUB_TOKEN']`.
+There are several different authenticating method's used accross the api.
+Here is the full list of configurable environmental variables for testing
+Octokit:
+
+ENV Variable | Description |
+:-------------------|:-----------------|
+`OCTOKIT_TEST_GITHUB_LOGIN`| GitHub login name (preferably one created specifically for testing against).
+`OCTOKIT_TEST_GITHUB_PASSWORD`| Password for the test GitHub login.
+`OCTOKIT_TEST_GITHUB_TOKEN` | [Personal Access Token](https://github.com/blog/1509-personal-api-tokens) for the test GitHub login.
+`OCTOKIT_TEST_GITHUB_CLIENT_ID` | Test OAuth application client id.
+`OCTOKIT_TEST_GITHUB_CLIENT_SECRET` | Test OAuth application client secret.
+`OCTOKIT_TEST_GITHUB_REPOSITORY` | Test repository to perform destructive actions against, this should not be set to any repository of importance. **Automatically created by the test suite if nonexistent** Default: `api-sandbox`
+`OCTOKIT_TEST_GITHUB_ORGANIZATION` | Test organization.
 
 Since we periodically refresh our cassettes, please keep some points in mind
 when writing new specs.
@@ -491,7 +517,7 @@ implementations:
 If something doesn't work on one of these Ruby versions, it's a bug.
 
 This library may inadvertently work (or seem to work) on other Ruby
-implementations, however support will only be provided for the versions listed
+implementations, but support will only be provided for the versions listed
 above.
 
 If you would like this library to support another Ruby version, you may
@@ -514,7 +540,7 @@ introduced with new major versions. As a result of this policy, you can (and
 should) specify a dependency on this gem using the [Pessimistic Version
 Constraint][pvc] with two digits of precision. For example:
 
-    spec.add_dependency 'octokit', '~> 2.0'
+    spec.add_dependency 'octokit', '~> 3.0'
 
 [semver]: http://semver.org/
 [pvc]: http://docs.rubygems.org/read/chapter/16#page74

data/lib/octokit/client.rb

@@ -308,6 +308,16 @@ module Octokit
       @client_secret = value
     end
 
+    # Wrapper around Kernel#warn to print warnings unless
+    # OCTOKIT_SILENT is set to true.
+    #
+    # @return [nil]
+    def octokit_warn(*message)
+      unless ENV['OCTOKIT_SILENT']
+        warn message
+      end
+    end
+
     private
 
     def reset_agent
@@ -364,15 +374,5 @@ module Octokit
 
       opts
     end
-
-    # Wrapper around Kernel#warn to print warnings unless
-    # OCTOKIT_SILENT is set to true.
-    #
-    # @return [nil]
-    def octokit_warn(*message)
-      unless ENV['OCTOKIT_SILENT']
-        warn message
-      end
-    end
   end
 end

data/lib/octokit/client/users.rb

@@ -234,12 +234,10 @@ module Octokit
 
       # Get list of public keys for user.
       #
-      # Requires authenticated client.
-      #
       # @return [Array<Sawyer::Resource>] Array of hashes representing public keys.
       # @see https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user
       # @example
-      #   @client.user_keys('pengwynn'
+      #   @client.user_keys('pengwynn')
       def user_keys(user, options = {})
         # TODO: Roll this into .keys
         paginate "users/#{user}/keys", options

data/lib/octokit/response/feed_parser.rb

@@ -7,14 +7,11 @@ module Octokit
     # Parses RSS and Atom feed responses.
     class FeedParser < Faraday::Response::Middleware
 
-      dependency do
-        require 'rss'
-      end
-
       private
 
       def on_complete(env)
         if env[:response_headers]["content-type"] =~ /(\batom|\brss)/
+          require 'rss'
           env[:body] = RSS::Parser.parse env[:body]
         end
       end

data/lib/octokit/version.rb

@@ -2,6 +2,6 @@ module Octokit
 
   # Current version
   # @return [String]
-  VERSION = "3.1.0".freeze
+  VERSION = "3.1.2".freeze
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.2
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-18 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,4 +129,3 @@ signing_key:
 specification_version: 4
 summary: Ruby toolkit for working with the GitHub API
 test_files: []
-has_rdoc: