Merge branch 'master' of github.com:peter-murach/github

piotrmurach · piotrmurach · commit 41ccaedb6f39 · 2015-08-02T21:13:00.000+01:00
diff --git a/README.md b/README.md
@@ -596,11 +596,7 @@ A Rails controller that allows a user to authorize their GitHub account and then
 ```ruby
 class GithubController < ApplicationController
 
-  attr_accessor :github
-  private :github
-
   def authorize
-    github  = Github.new client_id: '...', client_secret: '...'
     address = github.authorize_url redirect_uri: 'http://...', scope: 'repo'
     redirect_to address
   end
@@ -610,6 +606,12 @@ class GithubController < ApplicationController
     access_token = github.get_token authorization_code
     access_token.token   # => returns token value
   end
+  
+  private
+  
+   def github
+    @github ||= Github.new client_id: '...', client_secret: '...'
+   end
 end
 ```
 
@@ -621,7 +623,7 @@ In order to be able to create/update/remove files you need to use Contents API l
 contents = Github::Client::Repos::Contents.new oauth_token: '...'
 ```
 
-Having instantiaed the contents, to create a file do:
+Having instantiated the contents, to create a file do:
 
 ```ruby
 contents.create 'username', 'repo_name', 'full_path_to/file.ext',
diff --git a/lib/github_api/client/issues/labels.rb b/lib/github_api/client/issues/labels.rb
@@ -143,7 +143,7 @@ def add(*args)
     # @example
     #   github = Github.new
     #   github.issues.labels.remove 'user-name', 'repo-name', 'issue-number',
-    #     lable_name: 'label-name'
+    #     label_name: 'label-name'
     #
     # Remove all labels from an issue
     #
diff --git a/lib/github_api/client/repos/collaborators.rb b/lib/github_api/client/repos/collaborators.rb
@@ -33,7 +33,7 @@ def list(*args)
     #
     # @example
     #  github = Github.new
-    #  github.collaborators.add 'user', 'repo', 'username'
+    #  github.repos.collaborators.add 'user', 'repo', 'username'
     #
     # @example
     #  collaborators = Github::Repos::Collaborators.new
diff --git a/lib/github_api/client/repos/contents.rb b/lib/github_api/client/repos/contents.rb
@@ -20,7 +20,8 @@ class Client::Repos::Contents < API
     #   github = Github.new
     #   github.repos.contents.readme 'user-name', 'repo-name'
     #
-    #   content = Github::Repos;:Contents.new user: 'user-name', 'repo-name'
+    # @example
+    #   content = Github::Client::Repos::Contents.new user: 'user-name', repo: 'repo-name'
     #   content.readme
     #
     # @api public
diff --git a/lib/github_api/request.rb b/lib/github_api/request.rb
@@ -61,6 +61,7 @@ def call(current_options, params)
       connection_options = current_options.merge(request_options)
       conn               = connection(api, connection_options)
 
+      self.path = Utils::Url.normalize(self.path)
       if conn.path_prefix != '/' && self.path.index(conn.path_prefix) != 0
         self.path = (conn.path_prefix + self.path).gsub(/\/(\/)*/, '/')
       end
diff --git a/lib/github_api/utils/url.rb b/lib/github_api/utils/url.rb
@@ -16,6 +16,8 @@ def escape(s) CGI.escape(s.to_s) end
 
       def unescape(s) CGI.unescape(s.to_s) end
 
+      def normalize(s) Addressable::URI.parse(s.to_s).normalize.path end
+
       def build_query(params)
         params.map { |k, v|
           if v.class == Array
diff --git a/spec/github/request_spec.rb b/spec/github/request_spec.rb
@@ -38,4 +38,23 @@
     expect(request).to receive(:call).with(github.current_options, params)
     github.delete_request path, params
   end
+
+  context "with invalid characters in path" do
+    let(:wrong_path)     { 'github.api/$repos★/!usersÇ' }
+    let(:normalized_url) { 'https://api.github.com/github.api/$repos%E2%98%85/!users%C3%87' }
+
+    before do
+      expect(params).to receive(:options).exactly(5).times        { { raw: false } }
+      expect(params).to receive(:request_params).exactly(2).times { {} }
+    end
+
+    it "removes invalid characters before making a request" do
+      [:get, :patch, :post, :put, :delete].each do |request_type|
+        stub_request(request_type, normalized_url).
+          to_return(:status => 200, :body => "", :headers => {})
+
+        github.send("#{request_type}_request".to_sym, wrong_path, params)
+      end
+    end
+  end
 end # Github::Request
diff --git a/spec/github/utils/url_spec.rb b/spec/github/utils/url_spec.rb
@@ -21,6 +21,12 @@ def eq_query_to(query)
     described_class.unescape('%5C%2F%3F%7D%21%40%23%24%25%5E%26%2A%28%29').should eql '\\/?}!@#$%^&*()'
   end
 
+  it 'normalizes correctly' do
+    described_class.normalize('github.api/$repos★/!usersÇ').should eql 'github.api/$repos%E2%98%85/!users%C3%87'
+    described_class.normalize('123github!@').should eql '123github!@'
+    described_class.normalize('github.api/repos/users').should eql 'github.api/repos/users'
+  end
+
   context 'parses query strings correctly' do
     it { described_class.parse_query("a=b").should eq 'a' => 'b' }
     it { described_class.parse_query("a=b&a=c").should eq 'a' => ['b','c'] }

Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ def add(*args)`
`143`	`143`	`# @example`
`144`	`144`	`# github = Github.new`
`145`	`145`	`# github.issues.labels.remove 'user-name', 'repo-name', 'issue-number',`
`146`		`- # lable_name: 'label-name'`
	`146`	`+ # label_name: 'label-name'`
`147`	`147`	`#`
`148`	`148`	`# Remove all labels from an issue`
`149`	`149`	`#`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ def list(*args)`
`33`	`33`	`#`
`34`	`34`	`# @example`
`35`	`35`	`# github = Github.new`
`36`		`- # github.collaborators.add 'user', 'repo', 'username'`
	`36`	`+ # github.repos.collaborators.add 'user', 'repo', 'username'`
`37`	`37`	`#`
`38`	`38`	`# @example`
`39`	`39`	`# collaborators = Github::Repos::Collaborators.new`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,8 @@ class Client::Repos::Contents < API`
`20`	`20`	`# github = Github.new`
`21`	`21`	`# github.repos.contents.readme 'user-name', 'repo-name'`
`22`	`22`	`#`
`23`		`- # content = Github::Repos;:Contents.new user: 'user-name', 'repo-name'`
	`23`	`+ # @example`
	`24`	`+ # content = Github::Client::Repos::Contents.new user: 'user-name', repo: 'repo-name'`
`24`	`25`	`# content.readme`
`25`	`26`	`#`
`26`	`27`	`# @api public`