Change issues find call to get.

piotrmurach · piotrmurach · commit 476e89d97349 · 2012-05-16T22:25:19.000+01:00
diff --git a/lib/github_api/issues.rb b/lib/github_api/issues.rb
@@ -124,6 +124,7 @@ def list(params={})
     #    :sort   => 'comments',
     #    :direction => 'asc'
     #
+    # TODO: remove default nils from params
     def list_repo(user_name=nil, repo_name=nil, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
@@ -143,9 +144,9 @@ def list_repo(user_name=nil, repo_name=nil, params={})
     #
     # = Examples
     #  github = Github.new
-    #  github.issues.find 'user-name', 'repo-name', 'issue-id'
+    #  github.issues.get 'user-name', 'repo-name', 'issue-id'
     #
-    def find(user_name, repo_name, issue_id, params={})
+    def get(user_name, repo_name, issue_id, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
       _validate_presence_of issue_id
@@ -155,6 +156,7 @@ def find(user_name, repo_name, issue_id, params={})
 
       get_request("/repos/#{user}/#{repo}/issues/#{issue_id}", params)
     end
+    alias :find :get
 
     # Create an issue
     #
diff --git a/spec/github/issues_spec.rb b/spec/github/issues_spec.rb
@@ -122,7 +122,8 @@
     end
   end # list_repo
 
-  describe "#find" do
+  describe "#get" do
+    it { github.issues.should respond_to :find }
 
     context "resource found" do
       before do
@@ -133,22 +134,22 @@
       end
 
       it "should fail to get resource without issue id" do
-        expect { github.issues.find(user, repo, nil)}.to raise_error(ArgumentError)
+        expect { github.issues.get(user, repo, nil)}.to raise_error(ArgumentError)
       end
 
       it "should get the resource" do
-        github.issues.find user, repo, issue_id
+        github.issues.get user, repo, issue_id
         a_get("/repos/#{user}/#{repo}/issues/#{issue_id}").should have_been_made
       end
 
       it "should get issue information" do
-        issue = github.issues.find user, repo, issue_id
+        issue = github.issues.get user, repo, issue_id
         issue.number.should == issue_id
         issue.title.should == 'Found a bug'
       end
 
       it "should return mash" do
-        issue = github.issues.find user, repo, issue_id
+        issue = github.issues.get user, repo, issue_id
         issue.should be_a Hashie::Mash
       end
     end
@@ -163,7 +164,7 @@
 
       it "should fail to retrive resource" do
         expect {
-          github.issues.find user, repo, issue_id
+          github.issues.get user, repo, issue_id
         }.to raise_error(Github::Error::NotFound)
       end
     end

Original file line number	Diff line number	Diff line change
`@@ -124,6 +124,7 @@ def list(params={})`
`124`	`124`	`# :sort => 'comments',`
`125`	`125`	`# :direction => 'asc'`
`126`	`126`	`#`
	`127`	`+ # TODO: remove default nils from params`
`127`	`128`	`def list_repo(user_name=nil, repo_name=nil, params={})`
`128`	`129`	`_update_user_repo_params(user_name, repo_name)`
`129`	`130`	`_validate_user_repo_params(user, repo) unless user? && repo?`
`@@ -143,9 +144,9 @@ def list_repo(user_name=nil, repo_name=nil, params={})`
`143`	`144`	`#`
`144`	`145`	`# = Examples`
`145`	`146`	`# github = Github.new`
`146`		`- # github.issues.find 'user-name', 'repo-name', 'issue-id'`
	`147`	`+ # github.issues.get 'user-name', 'repo-name', 'issue-id'`
`147`	`148`	`#`
`148`		`- def find(user_name, repo_name, issue_id, params={})`
	`149`	`+ def get(user_name, repo_name, issue_id, params={})`
`149`	`150`	`_update_user_repo_params(user_name, repo_name)`
`150`	`151`	`_validate_user_repo_params(user, repo) unless user? && repo?`
`151`	`152`	`_validate_presence_of issue_id`
`@@ -155,6 +156,7 @@ def find(user_name, repo_name, issue_id, params={})`
`155`	`156`
`156`	`157`	`get_request("/repos/#{user}/#{repo}/issues/#{issue_id}", params)`
`157`	`158`	`end`
	`159`	`+ alias :find :get`
`158`	`160`
`159`	`161`	`# Create an issue`
`160`	`162`	`#`