github_api 0.8.2 → 0.8.3

data/features/step_definitions/common_steps.rb

@@ -30,6 +30,8 @@ Then /^the response should be (.*)$/ do |expected_response|
     true
   when /\d+/
     expected_response.to_i
+  when /empty/
+    []
   else
     expected_response
   end
@@ -62,6 +64,10 @@ Then /^the response should contain (.*)$/ do |item|
   end
 end
 
+Then /^the response should contain:$/ do |string|
+  unescape(@response.body).should include(unescape(string))
+end
+
 Then /^the response (.*) link should contain:$/ do |type, table|
   table.hashes.each do |attributes|
     attributes.each do |key, val|

data/features/support/helpers.rb

@@ -5,3 +5,7 @@ def convert_to_constant(classes)
   end
   return constant
 end
+
+def unescape(string)
+  string.gsub('\n', "\n").gsub('\"', '"').gsub('\e', "\e")
+end

data/lib/github_api.rb

@@ -77,6 +77,8 @@ module Github
     :Users           => 'users',
     :Emojis          => 'emojis',
     :Search          => 'search',
+    :Say             => 'say',
+    :Scopes          => 'scopes',
     :Markdown        => 'markdown',
     :CoreExt         => 'core_ext',
     :MimeType        => 'mime_type',

data/lib/github_api/client.rb

@@ -60,6 +60,14 @@ module Github
     end
     alias :repositories :repos
 
+    def octocat(options = {})
+      @octocat ||= ApiFactory.new 'Say', options
+    end
+
+    def scopes(options = {})
+      @scopes ||= ApiFactory.new 'Scopes', options
+    end
+
     def search(options = {})
       @search ||= ApiFactory.new 'Search', options
     end

data/lib/github_api/constants.rb

@@ -27,6 +27,10 @@ module Github
 
     ACCEPT_CHARSET = 'Accept-Charset'.freeze
 
+    OAUTH_SCOPES = 'X-Oauth-Scopes'.freeze
+
+    ACCEPTED_OAUTH_SCOPES = 'X-Accepted-Oauth-Scopes'.freeze
+
     # Link headers
     HEADER_LINK = "Link".freeze
 

data/lib/github_api/issues.rb

@@ -25,6 +25,7 @@ module Github
       body
       resource
       mime_type
+      org
     ].freeze
 
     VALID_ISSUE_PARAM_VALUES = {
@@ -67,61 +68,66 @@ module Github
 
     # List your issues
     #
-    # = 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>:state</tt> - <tt>open</tt>, <tt>closed</tt>, default: <tt>open</tt>
-    # <tt>:labels</tt> - String list of comma separated Label names. Example: bug,ui,@high
-    # <tt>:sort</tt> - <tt>created</tt>, <tt>updated</tt>, <tt>comments</tt>, default: <tt>created</tt>
-    # <tt>:direction</tt> - <tt>asc</tt>, <tt>desc</tt>, default: <tt>desc</tt>
-    # <tt>:since</tt> - Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
+    # List all issues across all the authenticated user’s visible repositories
+    # including owned repositories, member repositories,
+    # and organization repositories.
     #
-    # = Examples
+    # = Example
     #  github = Github.new :oauth_token => '...'
-    #  github.issues.list :since => '2011-04-12T12:12:12Z',
-    #    :filter => 'created',
-    #    :state  => 'open',
-    #    :labels => "bug,ui,bla",
-    #    :sort   => 'comments',
-    #    :direction => 'asc'
+    #  github.issues.list
+    #
+    # List all issues across owned and member repositories for the
+    # authenticated user.
+    #
+    # = Example
+    #  github = Github.new :oauth_token => '...'
+    #  github.issues.list :user
+    #
+    # List all issues for a given organization for the authenticated user.
+    #
+    # = Example
+    #  github = Github.new :oauth_token => '...'
+    #  github.issues.list :org => 'org-name'
     #
-    def list(*args)
-      params = args.extract_options!
-      normalize! params
-      filter! VALID_ISSUE_PARAM_NAMES, params
-      # _merge_mime_type(:issue, params)
-      assert_valid_values(VALID_ISSUE_PARAM_VALUES, params)
-
-      response = get_request("/issues", params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all :list
-
     # List issues for a repository
     #
+    # = Example
+    #  github = Github.new
+    #  github.issues.list :user => 'user-name', :repo => 'repo-name'
+    #
     # = 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>:milestone</tt>
     #  * Integer Milestone number
     #  * <tt>none</tt> for Issues with no Milestone.
-    #  * <tt>*</tt> for Issues with any Milestone
-    # <tt>:state</tt> - <tt>open</tt>, <tt>closed</tt>, default: <tt>open</tt>
+    #  * <tt>*</tt>    for Issues with any Milestone
+    # <tt>:state</tt>  - <tt>open</tt>, <tt>closed</tt>, default: <tt>open</tt>
+    # <tt>:labels</tt> - String list of comma separated Label names.
+    #                   Example: bug,ui,@high
     # <tt>:assignee</tt>
     #  * String User login
     #  * <tt>none</tt> for Issues with no assigned User.
-    #  * <tt>*</tt> for Issues with any assigned User.
+    #  * <tt>*</tt>    for Issues with any assigned User.
     # <tt>:mentioned</tt> String User login
-    # <tt>:labels</tt> - String list of comma separated Label names. Example: bug,ui,@high
-    # <tt>:sort</tt> - <tt>created</tt>, <tt>updated</tt>, <tt>comments</tt>, default: <tt>created</tt>
-    # <tt>:direction</tt> - <tt>asc</tt>, <tt>desc</tt>, default: <tt>desc</tt>
-    # <tt>:since</tt> - Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
-    # <tt></tt>, default: <tt>due_date</tt>
+    # <tt>:sort</tt> - <tt>created</tt>, <tt>updated</tt>, <tt>comments</tt>,
+    #                  default: <tt>created</tt>
     # <tt>:direction</tt> - <tt>asc</tt>, <tt>desc</tt>, default: <tt>desc</tt>
+    # <tt>:since</tt>     - Optional string of a timestamp in ISO 8601
+    #                       format: YYYY-MM-DDTHH:MM:SSZ
     #
     # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.issues.list :since => '2011-04-12T12:12:12Z',
+    #    :filter => 'created',
+    #    :state  => 'open',
+    #    :labels => "bug,ui,bla",
+    #    :sort   => 'comments',
+    #    :direction => 'asc'
+    #
     #  github = Github.new :user => 'user-name', :repo => 'repo-name'
     #  github.issues.list_repo :milestone => 1,
     #    :state  => 'open',
@@ -131,20 +137,42 @@ module Github
     #    :sort   => 'comments',
     #    :direction => 'asc'
     #
-    def list_repo(user_name, repo_name, params={})
+    def list(*args)
+      params = args.extract_options!
+      normalize! params
+      # filter! VALID_ISSUE_PARAM_NAMES, params
+      # _merge_mime_type(:issue, params)
+      # assert_valid_values(VALID_ISSUE_PARAM_VALUES, params)
+
+      response = if (org = params.delete('org'))
+        get_request("/orgs/#{org}/issues", params)
+
+      elsif (user_name = params.delete('user')) &&
+            (repo_name = params.delete('repo'))
+
+        list_repo user_name, repo_name, params
+      elsif args.include? :user
+        get_request("/user/issues", params)
+      else
+        get_request("/issues", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # List issues for a repository
+    #
+    def list_repo(user_name, repo_name, params)
       set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
 
-      normalize! params
       filter! VALID_ISSUE_PARAM_NAMES, params
-      # _merge_mime_type(:issue, params)
       assert_valid_values(VALID_ISSUE_PARAM_VALUES, params)
 
-      response = get_request("/repos/#{user}/#{repo}/issues", params)
-      return response unless block_given?
-      response.each { |el| yield el }
+      get_request("/repos/#{user}/#{repo}/issues", params)
     end
-    alias :list_repository :list_repo
+    private :list_repo
 
     # Get a single issue
     #

data/lib/github_api/issues/assignees.rb

@@ -3,7 +3,7 @@
 module Github
   class Issues::Assignees < API
 
-    # lists all the available assignees (owner + collaborators) 
+    # lists all the available assignees (owner + collaborators)
     # to which issues may be assigned.
     #
     # = Examples
@@ -19,6 +19,7 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
+    alias :all :list
 
     # Check to see if a particular user is an assignee for a repository.
     #

data/lib/github_api/issues/events.rb

@@ -12,7 +12,7 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.issues.events.list 'user-name', 'repo-name', 'issue-id'
+    #  github.issues.events.list 'user-name', 'repo-name', issue_id: 'issue-id'
     #
     # List events for a repository
     #
@@ -20,12 +20,12 @@ module Github
     #  github = Github.new
     #  github.issues.events.list 'user-name', 'repo-name'
     #
-    def list(user_name, repo_name, issue_id=nil, params={})
+    def list(user_name, repo_name, params={})
       set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 
-      response = if issue_id
+      response = if (issue_id = params.delete('issue_id'))
         get_request("/repos/#{user}/#{repo}/issues/#{issue_id}/events", params)
       else
         get_request("/repos/#{user}/#{repo}/issues/events", params)

data/lib/github_api/issues/milestones.rb

@@ -115,7 +115,6 @@ module Github
 
       normalize! params
       filter! VALID_MILESTONE_INPUTS, params
-      assert_required_keys(%w[ title ], params)
 
       patch_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
     end

data/lib/github_api/rate_limit.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Github
   module RateLimit
 

data/lib/github_api/result.rb

@@ -6,6 +6,19 @@ module Github
 
     # TODO Add result counts method to check total items looking at result links
 
+    # All request headers
+    def headers
+      loaded? ? @env[:response_headers] : nil
+    end
+
+    def oauth_scopes
+      loaded? ? @env[:response_headers][OAUTH_SCOPES] : nil
+    end
+
+    def accepted_oauth_scopes
+      loaded? ? @env[:response_headers][ACCEPTED_OAUTH_SCOPES] : nil
+    end
+
     # Requests are limited to API v3 to 5000 per hour.
     def ratelimit_limit
       loaded? ? @env[:response_headers][RATELIMIT_LIMIT] : nil

data/lib/github_api/say.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module Github
+  class Say < API
+
+    # Generate ASCII octocat with speech bubble.
+    #
+    # = Examples
+    #  Github::Say.new.say "My custom string..."
+    #
+    #  github = Github.new
+    #  github.octocat.say "My custom string..."
+    #
+    def say(*args)
+      params = args.extract_options!
+      normalize! params
+
+      params[:s] = args.shift unless args.empty?
+
+      get_request('/octocat', params, :raw => true)
+    end
+
+  end # Say
+end # Github

data/lib/github_api/scopes.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Github
+  class Scopes < API
+
+    # Check what OAuth scopes you have.
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => 'token'
+    #  github.scopes.all
+    #
+    def list(params={})
+      response = get_request("/user", params)
+      response.oauth_scopes ? response.oauth_scopes.split(',') : response
+    end
+    alias :all :list
+
+  end
+end # Github

data/lib/github_api/version.rb

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

data/spec/github/git_data/git_data_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Github::GitData, 'integration' do
+
+  after { reset_authentication_for subject }
+
+  it_should_behave_like 'api interface'
+
+  its(:blobs)      { should be_a Github::GitData::Blobs }
+
+  its(:commits)    { should be_a Github::GitData::Commits }
+
+  its(:references) { should be_a Github::GitData::References }
+
+  its(:tags)       { should be_a Github::GitData::Tags }
+
+  its(:trees)      { should be_a Github::GitData::Trees }
+
+end # Github::GitData

data/spec/github/issues/assignees/check_spec.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Issues::Assignees, '#check' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:assignee) { 'octocat' }
+  let(:request_path) { "/repos/#{user}/#{repo}/assignees/#{assignee}" }
+
+  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) { '[]' }
+    let(:status) { 204 }
+
+    it "should fail to get resource without collaborator name" do
+      expect { subject.check user, repo, nil }.to raise_error(ArgumentError)
+    end
+
+    it "should get the resource" do
+      subject.check user, repo, assignee
+      a_get(request_path).should have_been_made
+    end
+
+    it "should find assignee" do
+      subject.should_receive(:check).with(user, repo, assignee) { true }
+      subject.check user, repo, assignee
+    end
+  end
+
+  context "resource not found" do
+    let(:body) { '[]' }
+    let(:status) { 404 }
+
+    it "should fail to retrieve resource" do
+      subject.should_receive(:check).with(user, repo, assignee) { false }
+      subject.check user, repo, assignee
+    end
+  end
+end # check

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

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Issues::Assignees, '#list' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:request_path) { "/repos/#{user}/#{repo}/assignees" }
+
+  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 'resources found' do
+    let(:body) { fixture('repos/assignees.json') }
+    let(:status) { 200 }
+
+    it { should respond_to(:all) }
+
+    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 collaborator information" do
+      assignees = subject.list user, repo
+      assignees.first.login.should == 'octocat'
+    end
+
+    it "should yield to a block" do
+      yielded = []
+      result = subject.list(user, repo) { |obj| yielded << obj }
+      yielded.should == result
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.list user, repo }
+  end
+end # list