github_api 0.8.3 → 0.8.4

data/features/step_definitions/common_steps.rb

@@ -6,6 +6,11 @@ When /^(.*) within a cassette named "([^"]*)"$/ do |step_to_call, cassette_name|
   VCR.use_cassette(cassette_name) { step step_to_call }
 end
 
+When /^(.*) within a cassette named "([^"]*)" and match on (.*)$/ do |step_to_call, cassette_name, matchers|
+  matches = matchers.split(',').map { |m| m.gsub(/\s*/,'') }.map(&:to_sym)
+  VCR.use_cassette(cassette_name, :match_requests_on => matches) { step step_to_call }
+end
+
 Then /^the response should equal (.*)$/ do |expected_response|
   expected = case expected_response
   when /t/

data/features/support/vcr.rb

@@ -3,7 +3,7 @@ require 'vcr'
 VCR.configure do |conf|
   conf.hook_into :webmock
   conf.cassette_library_dir = 'features/cassettes'
-  conf.default_cassette_options = { :record => :new_episodes }
+  conf.default_cassette_options = { :record => :once }
   conf.filter_sensitive_data('<EMAIL>') { SETTINGS['email'] }
   conf.filter_sensitive_data('<TOKEN>') { SETTINGS['oauth_token'] }
   conf.filter_sensitive_data('<BASIC_AUTH>') { SETTINGS['basic_auth'] }

data/lib/github_api/issues.rb

@@ -29,7 +29,7 @@ module Github
     ].freeze
 
     VALID_ISSUE_PARAM_VALUES = {
-      'filter'    => %w[ assigned created mentioned subscribed ],
+      'filter'    => %w[ assigned created mentioned subscribed all ],
       'state'     => %w[ open closed ],
       'sort'      => %w[ created updated comments ],
       'direction' => %w[ desc asc ],
@@ -98,9 +98,10 @@ module Github
     # = Parameters
     # <tt>:filter</tt>
     #  * <tt>assigned</tt>   Issues assigned to you (default)
-    #  * <tt>created</tt>    Issues assigned to you (default)
-    #  * <tt>mentioned</tt>  Issues assigned to you (default)
-    #  * <tt>subscribed</tt> Issues assigned to you (default)
+    #  * <tt>created</tt>    Issues created by you 
+    #  * <tt>mentioned</tt>  Issues mentioning you 
+    #  * <tt>subscribed</tt> Issues you've subscribed to updates for 
+    #  * <tt>all</tt>        All issues the user can see 
     # <tt>:milestone</tt>
     #  * Integer Milestone number
     #  * <tt>none</tt> for Issues with no Milestone.

data/lib/github_api/issues/labels.rb

@@ -17,12 +17,30 @@ module Github
     #  github.issues.labels.list
     #  github.issues.labels.list { |label| ... }
     #
+    # Get labels for every issue in a milestone
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.labels.list 'user-name', 'repo-name', milestone_id: 'milestone-id'
+    #
+    # List labels on an issue
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.issues.labels.list 'user-name', 'repo-name', issue_id: 'issue-id'
+    #
     def list(user_name, repo_name, params={})
       set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 
-      response = get_request("/repos/#{user}/#{repo}/labels", params)
+      response = if (milestone_id = params.delete('milestone_id'))
+        get_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}/labels", params)
+      elsif (issue_id = params.delete('issue_id'))
+        get_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
+      else
+        get_request("/repos/#{user}/#{repo}/labels", params)
+      end
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -32,14 +50,14 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.issues.labels.find 'user-name', 'repo-name', 'label-id'
+    #  github.issues.labels.find 'user-name', 'repo-name', 'label-name'
     #
-    def get(user_name, repo_name, label_id, params={})
+    def get(user_name, repo_name, label_name, params={})
       set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, label_id
+      assert_presence_of user, repo, label_name
       normalize! params
 
-      get_request("/repos/#{user}/#{repo}/labels/#{label_id}", params)
+      get_request("/repos/#{user}/#{repo}/labels/#{label_name}", params)
     end
     alias :find :get
 
@@ -72,18 +90,18 @@ module Github
     #
     # = Examples
     #  @github = Github.new
-    #  @github.issues.labels.update 'user-name', 'repo-name', 'label-id',
+    #  @github.issues.labels.update 'user-name', 'repo-name', 'label-name',
     #    :name => 'API', :color => "FFFFFF"
     #
-    def update(user_name, repo_name, label_id, params={})
+    def update(user_name, repo_name, label_name, params={})
       set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, label_id
+      assert_presence_of user, repo, label_name
 
       normalize! params
       filter! VALID_LABEL_INPUTS, params
       assert_required_keys(VALID_LABEL_INPUTS, params)
 
-      patch_request("/repos/#{user}/#{repo}/labels/#{label_id}", params)
+      patch_request("/repos/#{user}/#{repo}/labels/#{label_name}", params)
     end
     alias :edit :update
 
@@ -91,30 +109,16 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.issues.labels.delete 'user-name', 'repo-name', 'label-id'
+    #  github.issues.labels.delete 'user-name', 'repo-name', 'label-name'
     #
-    def delete(user_name, repo_name, label_id, params={})
+    def delete(user_name, repo_name, label_name, params={})
       set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
 
-      assert_presence_of label_id
+      assert_presence_of label_name
       normalize! params
 
-      delete_request("/repos/#{user}/#{repo}/labels/#{label_id}", params)
-    end
-
-    # List labels on an issue
-    #
-    # = Examples
-    #  @github = Github.new
-    #  @github.issues.labels.issue 'user-name', 'repo-name', 'issue-id'
-    #
-    def issue(user_name, repo_name, issue_id, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, issue_id
-      normalize! params
-
-      get_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
+      delete_request("/repos/#{user}/#{repo}/labels/#{label_name}", params)
     end
 
     # Add labels to an issue
@@ -146,19 +150,19 @@ module Github
     #  github = Github.new
     #  github.issues.labels.remove 'user-name', 'repo-name', 'issue-id'
     #
-    def remove(user_name, repo_name, issue_id, label_id=nil, params={})
+    def remove(user_name, repo_name, issue_id, label_name=nil, params={})
       set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, issue_id
       normalize! params
 
-      if label_id
-        delete_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels/#{label_id}", params)
+      if label_name
+        delete_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels/#{label_name}", params)
       else
         delete_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
       end
     end
 
-    # Replace all labels for an issue 
+    # Replace all labels for an issue
     #
     # Sending an empty array ([]) will remove all Labels from the Issue.
     #
@@ -177,21 +181,5 @@ module Github
       put_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
     end
 
-    # Get labels for every issue in a milestone
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.issues.labels. 'user-name', 'repo-name', 'milestone-id'
-    #
-    def milestone(user_name, repo_name, milestone_id, params={})
-      set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, milestone_id
-      normalize! params
-
-      response = get_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}/labels", params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-
   end # Issues::Labels
 end # Github

data/lib/github_api/version.rb

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

data/spec/github/issues/labels/add_spec.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Issues::Labels, '#add' do
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github' }
+  let(:request_path) { "/repos/#{user}/#{repo}/issues/#{issue_id}/labels" }
+
+  before {
+    stub_post(request_path).
+      to_return(:body => body, :status => status,
+      :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  let(:issue_id) { 1 }
+  let(:labels) { "Label 1" }
+
+  context "labels added" do
+    let(:body) { fixture('issues/labels.json') }
+    let(:status) { 200 }
+
+    it "should fail to add labels if issue-id is missing" do
+      expect {
+        subject.add user, repo, nil, labels
+      }.to raise_error(ArgumentError)
+    end
+
+    it "should create resource successfully" do
+      subject.add user, repo, issue_id, labels
+      a_post(request_path).should have_been_made
+    end
+
+    it "should return the resource" do
+      labels = subject.add user, repo, issue_id, labels
+      labels.first.should be_a Hashie::Mash
+    end
+
+    it "should get the label information" do
+      labels = subject.add user, repo, issue_id, labels
+      labels.first.name.should == 'bug'
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.add user, repo, issue_id, labels }
+  end
+end # add

data/spec/github/issues/labels/create_spec.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Issues::Labels, '#create' do
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github' }
+  let(:request_path) { "/repos/#{user}/#{repo}/labels" }
+  let(:inputs) {
+    {
+      "name" => "API",
+      "color" => "FFFFFF",
+    }
+  }
+
+  before {
+    stub_post(request_path).with(inputs).
+      to_return(:body => body, :status => status,
+      :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  context "resouce created" do
+    let(:body) { fixture('issues/label.json') }
+    let(:status) { 200 }
+
+    it "should fail to create resource if 'name' input is missing" do
+      expect {
+        subject.create user, repo, inputs.except('name')
+      }.to raise_error(Github::Error::RequiredParams)
+    end
+
+    it "should fail to create resource if 'color' input is missing" do
+      expect {
+        subject.create user, repo, inputs.except('color')
+      }.to raise_error(Github::Error::RequiredParams)
+    end
+
+    it "should create resource successfully" do
+      subject.create user, repo, inputs
+      a_post(request_path).with(inputs).should have_been_made
+    end
+
+    it "should return the resource" do
+      label = subject.create user, repo, inputs
+      label.should be_a Hashie::Mash
+    end
+
+    it "should get the label information" do
+      label = subject.create user, repo, inputs
+      label.name.should == 'bug'
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.create user, repo, inputs }
+  end
+end # create

data/spec/github/issues/labels/delete_spec.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Issues::Labels, '#delete' do
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github' }
+  let(:label_id) { 1 }
+  let(:request_path) { "/repos/#{user}/#{repo}/labels/#{label_id}" }
+  let(:inputs) {
+    {
+      "name" => "API",
+      "color" => "FFFFFF",
+    }
+  }
+
+  before {
+    stub_delete(request_path).with(inputs).
+      to_return(:body => body, :status => status,
+      :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  context "resouce removed" do
+    let(:body) { fixture('issues/label.json') }
+    let(:status) { 204 }
+
+    it "should remove resource successfully" do
+      subject.delete user, repo, label_id
+      a_delete(request_path).should have_been_made
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.delete user, repo, label_id }
+  end
+
+end # delete

data/spec/github/issues/labels/get_spec.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Issues::Labels, '#get' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:label_id) { 1 }
+  let(:request_path) { "/repos/#{user}/#{repo}/labels/#{label_id}" }
+
+  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 "resource found" do
+    let(:body) { fixture('issues/label.json') }
+    let(:status) { 200 }
+
+    it { should respond_to :get }
+
+    it "should fail to get resource without label id" do
+      expect { subject.get user, repo, nil }.to raise_error(ArgumentError)
+    end
+
+    it "should get the resource" do
+      subject.get user, repo, label_id
+      a_get(request_path).should have_been_made
+    end
+
+    it "should get label information" do
+      label = subject.get user, repo, label_id
+      label.name.should == 'bug'
+    end
+
+    it "should return mash" do
+      label = subject.get user, repo, label_id
+      label.should be_a Hashie::Mash
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.get user, repo, label_id }
+  end
+end # find

data/spec/github/issues/labels/list_spec.rb

@@ -0,0 +1,100 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Issues::Labels, '#list' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:request_path) { "/repos/#{user}/#{repo}/labels" }
+  let(:body) { fixture('issues/labels.json') }
+  let(:status) { 200 }
+
+  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 "for this repository" do
+    it { should respond_to :all }
+
+    it "should fail to get resource without username" do
+      expect { subject.list nil, repo }.to raise_error(ArgumentError)
+    end
+
+    it "should get the resources" do
+      subject.list user, repo
+      a_get(request_path).should have_been_made
+    end
+
+    it_should_behave_like 'an array of resources' do
+      let(:requestable) { subject.list user, repo }
+    end
+
+    it "should get issue information" do
+      labels = subject.list user, repo
+      labels.first.name.should == 'bug'
+    end
+
+    it "should yield to a block" do
+      yielded = []
+      result = subject.list(user, repo) { |obj| yielded << obj }
+      yielded.should == result
+    end
+  end
+
+  context "for this milestone" do
+    let(:milestone_id) { 1 }
+    let(:request_path) { "/repos/#{user}/#{repo}/milestones/#{milestone_id}/labels"}
+    let(:body) { fixture('issues/labels.json') }
+    let(:status) { 200 }
+
+    it "should get the resources" do
+      subject.list user, repo, :milestone_id => milestone_id
+      a_get(request_path).should have_been_made
+    end
+
+    it_should_behave_like 'an array of resources' do
+      let(:requestable) { subject.list user, repo, :milestone_id => milestone_id }
+    end
+
+    it "should get issue information" do
+      labels = subject.list user, repo, :milestone_id => milestone_id
+      labels.first.name.should == 'bug'
+    end
+
+    it "should yield to a block" do
+      yielded = []
+      result = subject.list(user, repo, :milestone_id => milestone_id) { |obj| yielded << obj }
+      yielded.should == result
+    end
+  end
+
+  context "resource found" do
+    let(:issue_id) { 1 }
+    let(:request_path) { "/repos/#{user}/#{repo}/issues/#{issue_id}/labels" }
+    let(:body) { fixture('issues/labels.json') }
+    let(:status) { 200 }
+
+    it "should get the resources" do
+      subject.list user, repo, :issue_id => issue_id
+      a_get(request_path).should have_been_made
+    end
+
+    it "should get issue information" do
+      labels = subject.list user, repo, :issue_id => issue_id
+      labels.first.name.should == 'bug'
+    end
+
+    it "should yield to a block" do
+      yielded = []
+      result = subject.list(user, repo, :issue_id => issue_id) { |obj| yielded << obj }
+      yielded.should == result
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.list user, repo }
+  end
+end # list