github_api 0.8.6 → 0.8.7

data/features/pull_requests.feature

@@ -19,8 +19,8 @@ Feature: Pull Requests API
   Scenario: Get
 
     Given I want to get resource with the following params:
-      | user          | repo   | request_id |
-      | peter-murach  | github | 36         |
+      | user          | repo   | number |
+      | peter-murach  | github | 36     |
     When I make request within a cassette named "pull_requests/get"
     Then the response status should be 200
       And the response type should be JSON

data/lib/github_api/activity/events.rb

@@ -30,8 +30,8 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.events.repository 'user-name', 'repo-name'
-    #  github.events.repository 'user-name', 'repo-name' { |event| ... }
+    #  github.activity.events.repository 'user-name', 'repo-name'
+    #  github.activity.events.repository 'user-name', 'repo-name' { |event| ... }
     #
     def repository(user_name, repo_name, params={})
       set :user => user_name, :repo => repo_name
@@ -51,8 +51,8 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.events.issue 'user-name', 'repo-name'
-    #  github.events.issue 'user-name', 'repo-name' { |event| ... }
+    #  github.activity.events.issue 'user-name', 'repo-name'
+    #  github.activity.events.issue 'user-name', 'repo-name' { |event| ... }
     #
     def issue(user_name, repo_name, params={})
       set :user => user_name, :repo => repo_name
@@ -71,8 +71,8 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.events.network 'user-name', 'repo-name'
-    #  github.events.network 'user-name', 'repo-name' { |event| ... }
+    #  github.activity.events.network 'user-name', 'repo-name'
+    #  github.activity.events.network 'user-name', 'repo-name' { |event| ... }
     #
     def network(user_name, repo_name, params={})
       set :user => user_name, :repo => repo_name
@@ -92,8 +92,8 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.events.org 'org-name'
-    #  github.events.org 'org-name' { |event| ... }
+    #  github.activity.events.org 'org-name'
+    #  github.activity.events.org 'org-name' { |event| ... }
     #
     def org(org_name, params={})
       assert_presence_of org_name
@@ -116,15 +116,15 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.events.received 'user-name'
-    #  github.events.received 'user-name' { |event| ... }
+    #  github.activity.events.received 'user-name'
+    #  github.activity.events.received 'user-name' { |event| ... }
     #
     # List all public events that a user has received
     #
     # = Examples
     #  github = Github.new
-    #  github.events.received 'user-name', :public => true
-    #  github.events.received 'user-name', :public => true { |event| ... }
+    #  github.activity.events.received 'user-name', :public => true
+    #  github.activity.events.received 'user-name', :public => true { |event| ... }
     #
     def received(user_name, params={})
       assert_presence_of user_name
@@ -149,15 +149,15 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.events.performed 'user-name'
-    #  github.events.performed 'user-name' { |event| ... }
+    #  github.activity.events.performed 'user-name'
+    #  github.activity.events.performed 'user-name' { |event| ... }
     #
     # List all public events that a user has performed
     #
     # = Examples
     #  github = Github.new
-    #  github.events.performed 'user-name', :public => true
-    #  github.events.performed 'user-name', :public => true { |event| ... }
+    #  github.activity.events.performed 'user-name', :public => true
+    #  github.activity.events.performed 'user-name', :public => true { |event| ... }
     #
     def performed(user_name, params={})
       assert_presence_of user_name
@@ -182,8 +182,8 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.events.user_org 'user-name', 'org-name'
-    #  github.events.user_org 'user-name', 'org-name' { |event| ... }
+    #  github.activity.events.user_org 'user-name', 'org-name'
+    #  github.activity.events.user_org 'user-name', 'org-name' { |event| ... }
     #
     def user_org(user_name, org_name, params={})
       assert_presence_of user_name, org_name

data/lib/github_api/authorization.rb

@@ -11,7 +11,8 @@ module Github
         {
           :site          => options.fetch(:site) { Github.site },
           :authorize_url => 'login/oauth/authorize',
-          :token_url     => 'login/oauth/access_token'
+          :token_url     => 'login/oauth/access_token',
+          :ssl           => { :verify => false }
         }
       )
     end

data/lib/github_api/connection.rb

@@ -34,7 +34,6 @@ module Github
           USER_AGENT       => user_agent,
           CONTENT_TYPE     => 'application/json'
         },
-        :ssl => { :verify => false },
         :url => options.fetch(:endpoint) { Github.endpoint }
       }.merge(options)
     end

data/lib/github_api/pull_requests.rb

@@ -62,18 +62,17 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.pull_requests.get 'user-name', 'repo-name', 'request-id'
+    #  github.pull_requests.get 'user-name', 'repo-name', 'number'
     #
-    #  @pull_reqs = Github::PullRequests.new
-    #  @pull_reqs.get 'user-name', 'repo-name', 'request-id'
+    #  pull_reqs = Github::PullRequests.new
+    #  pull_reqs.get 'user-name', 'repo-name', 'number'
     #
-    def get(user_name, repo_name, request_id, params={})
+    def get(user_name, repo_name, number, params={})
       set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, request_id
+      assert_presence_of user, repo, number
       normalize! params
-      # _merge_mime_type(:pull_request, params)
 
-      get_request("/repos/#{user}/#{repo}/pulls/#{request_id}", params)
+      get_request("/repos/#{user}/#{repo}/pulls/#{number}", params)
     end
     alias :find :get
 
@@ -101,7 +100,7 @@ module Github
     #
     # alternatively
     #
-    #  @github.pull_requests.create 'user-name', 'repo-name',
+    #  github.pull_requests.create 'user-name', 'repo-name',
     #    "issue" => "5",
     #    "head" => "octocat:new-feature",
     #    "base" => "master"
@@ -111,7 +110,6 @@ module Github
       assert_presence_of user, repo
 
       normalize! params
-      # _merge_mime_type(:pull_request, params)
       filter! VALID_REQUEST_PARAM_NAMES, params
 
       post_request("/repos/#{user}/#{repo}/pulls", params)
@@ -126,37 +124,33 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.pull_requests.update 'user-name', 'repo-name', 'request-id'
+    #  github.pull_requests.update 'user-name', 'repo-name', 'number'
     #    "title" => "Amazing new title",
     #    "body" => "Update body",
     #    "state" => "open",
     #
-    def update(user_name, repo_name, request_id, params={})
+    def update(user_name, repo_name, number, params={})
       set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, request_id
-
+      assert_presence_of user, repo, number
       normalize! params
       filter! VALID_REQUEST_PARAM_NAMES, params
-      # _merge_mime_type(:pull_request, params)
       assert_valid_values(VALID_REQUEST_PARAM_VALUES, params)
 
-      patch_request("/repos/#{user}/#{repo}/pulls/#{request_id}", params)
+      patch_request("/repos/#{user}/#{repo}/pulls/#{number}", params)
     end
 
     # List commits on a pull request
     #
     # = Examples
     #  github = Github.new
-    #  github.pull_requests.commits 'user-name', 'repo-name', 'request-id'
+    #  github.pull_requests.commits 'user-name', 'repo-name', 'number'
     #
-    def commits(user_name, repo_name, request_id, params={})
+    def commits(user_name, repo_name, number, params={})
       set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, request_id
-
+      assert_presence_of user, repo, number
       normalize! params
-      # _merge_mime_type(:pull_request, params)
 
-      response = get_request("/repos/#{user}/#{repo}/pulls/#{request_id}/commits", params)
+      response = get_request("/repos/#{user}/#{repo}/pulls/#{number}/commits", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -165,15 +159,14 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.pull_requests.files 'user-name', 'repo-name', 'request-id'
+    #  github.pull_requests.files 'user-name', 'repo-name', 'number'
     #
-    def files(user_name, repo_name, request_id, params={})
+    def files(user_name, repo_name, number, params={})
       set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, request_id
+      assert_presence_of user, repo, number
       normalize! params
-      # _merge_mime_type(:pull_request, params)
 
-      response = get_request("/repos/#{user}/#{repo}/pulls/#{request_id}/files", params)
+      response = get_request("/repos/#{user}/#{repo}/pulls/#{number}/files", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -182,16 +175,14 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.pull_requests.merged? 'user-name', 'repo-name', 'request-id'
+    #  github.pull_requests.merged? 'user-name', 'repo-name', 'number'
     #
-    def merged?(user_name, repo_name, request_id, params={})
+    def merged?(user_name, repo_name, number, params={})
       set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, request_id
-
+      assert_presence_of user, repo, number
       normalize! params
-      # _merge_mime_type(:pull_request, params)
 
-      get_request("/repos/#{user}/#{repo}/pulls/#{request_id}/merge", params)
+      get_request("/repos/#{user}/#{repo}/pulls/#{number}/merge", params)
       true
     rescue Github::Error::NotFound
       false
@@ -200,21 +191,21 @@ module Github
     # Merge a pull request(Merge Button)
     #
     # = Inputs
-    #  <tt>:commit_message</tt> - Optional string - The message that will be used for the merge commit
+    #  <tt>:commit_message</tt> - Optional string -
+    #                           The message that will be used for the merge commit
     #
     # = Examples
     #  github = Github.new
-    #  github.pull_requests.merge 'user-name', 'repo-name', 'request-id'
+    #  github.pull_requests.merge 'user-name', 'repo-name', 'number'
     #
-    def merge(user_name, repo_name, request_id, params={})
+    def merge(user_name, repo_name, number, params={})
       set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, request_id
+      assert_presence_of user, repo, number
 
       normalize! params
-      # _merge_mime_type(:pull_request, params)
       filter! VALID_REQUEST_PARAM_NAMES, params
 
-      put_request("/repos/#{user}/#{repo}/pulls/#{request_id}/merge", params)
+      put_request("/repos/#{user}/#{repo}/pulls/#{number}/merge", params)
     end
 
   end # PullRequests

data/lib/github_api/repos/commits.rb

@@ -3,6 +3,14 @@
 module Github
   class Repos::Commits < API
 
+    VALID_COMMITS_OPTIONS = %w[
+      sha
+      path
+      author
+      since
+      until
+    ].freeze
+
     # List commits on a repository
     #
     # = Parameters
@@ -19,7 +27,7 @@ module Github
       set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
-      filter! %w[sha path author], params
+      filter! VALID_COMMITS_OPTIONS, params
 
       response = get_request("/repos/#{user}/#{repo}/commits", params)
       return response unless block_given?

data/lib/github_api/version.rb

@@ -4,7 +4,7 @@ module Github
   module VERSION
     MAJOR = 0
     MINOR = 8
-    PATCH = 6
+    PATCH = 7
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/spec/github/pull_requests/comments/list_spec.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::PullRequests::Comments, '#list' do
+  let(:repo) { 'github' }
+  let(:user) { 'peter-murach' }
+  let(:number) { 1 }
+
+  before {
+    stub_get(request_path).to_return(:body => body, :status => status,
+      :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  context 'on a pull request' do
+    let(:request_path) { "/repos/#{user}/#{repo}/pulls/#{number}/comments" }
+    let(:body) { fixture('pull_requests/comments.json') }
+    let(:status) { 200 }
+
+    it { should respond_to :all }
+
+    it "throws error if comment id not provided" do
+      expect { subject.list user, nil }.to raise_error(ArgumentError)
+    end
+
+    it "should get the resources" do
+      subject.list user, repo, :request_id => number
+      a_get(request_path).should have_been_made
+    end
+
+    it_should_behave_like 'an array of resources' do
+      let(:requestable) { subject.list user, repo, :request_id => number }
+    end
+
+    it "should get pull request comment information" do
+      comments = subject.list user, repo, :request_id => number
+      comments.first.id.should == number
+    end
+
+    it "should yield to a block" do
+      yielded = []
+      result = subject.list(user, repo, :request_id => number) {|obj| yielded << obj }
+      yielded.should == result
+    end
+  end
+
+  context 'in a repository' do
+    let(:request_path) { "/repos/#{user}/#{repo}/pulls/comments" }
+    let(:body) { fixture('pull_requests/comments.json') }
+    let(:status) { 200 }
+
+    it "should get the resources" do
+      subject.list user, repo
+      a_get(request_path).should have_been_made
+    end
+
+    it "should get pull request comment information" do
+      comments = subject.list user, repo
+      comments.first.id.should == number
+    end
+
+    it "should yield to a block" do
+      yielded = []
+      result = subject.list(user, repo) { |obj| yielded << obj }
+      yielded.should == result
+    end
+
+    it_should_behave_like 'request failure' do
+      let(:requestable) { subject.list user, repo }
+    end
+  end
+end # list

data/spec/github/pull_requests/comments_spec.rb

@@ -11,102 +11,6 @@ describe Github::PullRequests::Comments do
 
   after { reset_authentication_for github }
 
-  describe "#list" do
-    it { github.pull_requests.comments.should respond_to :all }
-
-    context 'on a pull request' do
-      before do
-        stub_get("/repos/#{user}/#{repo}/pulls/#{pull_request_id}/comments").
-          to_return(:body => fixture('pull_requests/comments.json'),
-            :status => 200,
-            :headers => {:content_type => "application/json; charset=utf-8"})
-      end
-
-      it "throws error if comment id not provided" do
-        expect {
-          github.pull_requests.comments.list user, nil
-        }.to raise_error(ArgumentError)
-      end
-
-      it "should get the resources" do
-        github.pull_requests.comments.list user, repo, :request_id => pull_request_id
-        a_get("/repos/#{user}/#{repo}/pulls/#{pull_request_id}/comments").
-          should have_been_made
-      end
-
-      it "should return array of resources" do
-        comments = github.pull_requests.comments.list user, repo, :request_id => pull_request_id
-        comments.should be_an Array
-        comments.should have(1).items
-      end
-
-      it "should be a mash type" do
-        comments = github.pull_requests.comments.list user, repo, :request_id => pull_request_id
-        comments.first.should be_a Hashie::Mash
-      end
-
-      it "should get pull request comment information" do
-        comments = github.pull_requests.comments.list user, repo, :request_id => pull_request_id
-        comments.first.id.should == pull_request_id
-      end
-
-      it "should yield to a block" do
-        yielded = []
-        result = github.pull_requests.comments.list(user, repo, :request_id => pull_request_id) { |obj| yielded << obj }
-        yielded.should == result
-      end
-    end
-
-    context 'in a repository' do
-      before do
-        stub_get("/repos/#{user}/#{repo}/pulls/comments").
-          to_return(:body => fixture('pull_requests/comments.json'),
-            :status => 200,
-            :headers => {:content_type => "application/json; charset=utf-8"})
-      end
-
-      it "should get the resources" do
-        github.pull_requests.comments.list user, repo
-        a_get("/repos/#{user}/#{repo}/pulls/comments").should have_been_made
-      end
-
-      it "should return array of resources" do
-        comments = github.pull_requests.comments.list user, repo
-        comments.should be_an Array
-        comments.should have(1).items
-      end
-
-      it "should be a mash type" do
-        comments = github.pull_requests.comments.list user, repo
-        comments.first.should be_a Hashie::Mash
-      end
-
-      it "should get pull request comment information" do
-        comments = github.pull_requests.comments.list user, repo
-        comments.first.id.should == pull_request_id
-      end
-
-      it "should yield to a block" do
-        yielded = []
-        result = github.pull_requests.comments.list(user, repo) { |obj| yielded << obj }
-        yielded.should == result
-      end
-    end
-
-    context 'resource not found' do
-      before do
-        stub_get("/repos/#{user}/#{repo}/pulls/#{pull_request_id}/comments").
-          to_return(:body => "", :status => [404, "Not Found"])
-      end
-
-      it "should return 404 with a message 'Not Found'" do
-        expect {
-          github.pull_requests.comments.list user, repo, :request_id => pull_request_id
-        }.to raise_error(Github::Error::NotFound)
-      end
-    end
-  end # list
-
   describe "#get" do
     it { github.pull_requests.comments.should respond_to :find }