github_api 0.8.8 → 0.8.9

data/lib/github_api/connection.rb

@@ -26,10 +26,10 @@ module Github
     def default_options(options={})
       {
         :headers => {
-          ACCEPT           =>  "application/json" \
-                               "application/vnd.github+json;q=0.7" \
-                               "application/vnd.github.v3.raw+json;q=0.5" \
-                               "application/vnd.github.beta.raw+json;q=0.1",
+          ACCEPT           => "application/vnd.github.v3.full+json," \
+                              "application/vnd.github.beta.full+json;q=0.7," \
+                              "application/vnd.github+json;q=0.5," \
+                              "application/json;q=0.1",
           ACCEPT_CHARSET   => "utf-8",
           USER_AGENT       => user_agent,
           CONTENT_TYPE     => 'application/json'

data/lib/github_api/orgs/members.rb

@@ -16,26 +16,50 @@ module Github
     #  github.orgs.members.list 'org-name'
     #  github.orgs.members.list 'org-name' { |memb| ... }
     #
+    # List public members
+    #
+    # Members of an organization can choose to have their membership publicized or not.
+    # = Examples
+    #  github = Github.new
+    #  github.orgs.members.list 'org-name', :public => true
+    #  github.orgs.members.list 'org-name', :public => true { |memb| ... }
+    #
     def list(org_name, params={})
       assert_presence_of org_name
       normalize! params
-      response = get_request("/orgs/#{org_name}/members", params)
+
+      response = if params.delete('public')
+        get_request("/orgs/#{org_name}/public_members", params)
+      else
+        get_request("/orgs/#{org_name}/members", params)
+      end
       return response unless block_given?
       response.each { |el| yield el }
     end
     alias :all :list
 
-    # Check if user is a member of an organization
+    # Check if user is, publicly or privately, a member of an organization
     #
     # = Examples
     #  github = Github.new
     #  github.orgs.members.member? 'org-name', 'member-name'
     #
+    # Check if a user is a public member of an organization
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.orgs.members.member? 'org-name', 'member-name', :public => true
+    #
     def member?(org_name, member_name, params={})
       assert_presence_of org_name, member_name
       normalize! params
-      get_request("/orgs/#{org_name}/members/#{member_name}", params)
-      true
+
+      response = if params.delete('public')
+        get_request("/orgs/#{org_name}/public_members/#{member_name}", params)
+      else
+        get_request("/orgs/#{org_name}/members/#{member_name}", params)
+      end
+      response.status == 204
     rescue Github::Error::NotFound
       false
     end
@@ -55,37 +79,6 @@ module Github
     end
     alias :remove :delete
 
-    # List public members
-    # Members of an organization can choose to have their membership publicized or not.
-    # = Examples
-    #  github = Github.new
-    #  github.orgs.members.list_public 'org-name'
-    #  github.orgs.members.list_public 'org-name' { |memb| ... }
-    #
-    def list_public(org_name, params={})
-      assert_presence_of org_name
-      normalize! params
-      response = get_request("/orgs/#{org_name}/public_members", params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :public_members :list_public
-
-    # Get if a user is a public member of an organization
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.orgs.members.public_member? 'org-name', 'member-name'
-    #
-    def public_member?(org_name, member_name, params={})
-      assert_presence_of org_name, member_name
-      normalize! params
-      get_request("/orgs/#{org_name}/public_members/#{member_name}", params)
-      true
-    rescue Github::Error::NotFound
-      false
-    end
-
     # Publicize a user’s membership
     #
     # = Examples

data/lib/github_api/orgs/teams.rb

@@ -135,11 +135,11 @@ module Github
     #  github = Github.new :oauth_token => '...'
     #  github.orgs.teams.team_member? 'team-id', 'user-name'
     #
-    def team_member?(team_id, member_name, params={})
-      assert_presence_of team_id, member_name
+    def team_member?(team_id, user_name, params={})
+      assert_presence_of team_id, user_name
       normalize! params
-      get_request("/teams/#{team_id}/members/#{member_name}", params)
-      true
+      response = get_request("/teams/#{team_id}/members/#{user_name}", params)
+      response.status == 204
     rescue Github::Error::NotFound
       false
     end
@@ -151,14 +151,15 @@ module Github
     #  github = Github.new :oauth_token => '...'
     #  github.orgs.teams.add_member 'team-id', 'user-name'
     #
-    def add_member(team_id, member_name, params={})
-      assert_presence_of team_id, member_name
+    def add_member(team_id, user_name, params={})
+      assert_presence_of team_id, user_name
       normalize! params
-      put_request("/teams/#{team_id}/members/#{member_name}", params)
+      put_request("/teams/#{team_id}/members/#{user_name}", params)
     end
     alias :add_team_member :add_member
 
     # Remove a team member
+    #
     # In order to remove a user from a team, the authenticated user must
     # have ‘admin’ permissions to the team or be an owner of the org that
     # the team is associated with.
@@ -166,12 +167,12 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.remove_member 'team-id', 'member-name'
+    #  github.orgs.teams.remove_member 'team-id', 'user-name'
     #
-    def remove_member(team_id, member_name, params={})
-      assert_presence_of team_id, member_name
+    def remove_member(team_id, user_name, params={})
+      assert_presence_of team_id, user_name
       normalize! params
-      delete_request("/teams/#{team_id}/members/#{member_name}", params)
+      delete_request("/teams/#{team_id}/members/#{user_name}", params)
     end
     alias :remove_team_member :remove_member
 
@@ -200,8 +201,8 @@ module Github
     def team_repo?(team_id, user_name, repo_name, params={})
       assert_presence_of team_id, user_name, repo_name
       normalize! params
-      get_request("/teams/#{team_id}/repos/#{user_name}/#{repo_name}", params)
-      true
+      response = get_request("/teams/#{team_id}/repos/#{user_name}/#{repo_name}", params)
+      response.status == 204
     rescue Github::Error::NotFound
       false
     end

data/lib/github_api/version.rb

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

data/spec/github/gists/create_spec.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Gists, '#create' do
+  let(:request_path) { "/gists" }
+
+  let(:inputs) {
+    {
+      "description" => "the description for this gist",
+      "public" => true,
+      "files" => {
+        "file1.txt" => {
+          "content" => "String file contents"
+        }
+      },
+    }
+  }
+
+  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('gists/gist.json') }
+    let(:status) { 201 }
+
+    it "should fail to create resource if 'files' input is missing" do
+      expect {
+        subject.create inputs.except('files')
+      }.to raise_error(Github::Error::RequiredParams)
+    end
+
+    it "should fail to create resource if 'public' input is missing" do
+      expect {
+        subject.create inputs.except('public')
+      }.to raise_error(Github::Error::RequiredParams)
+    end
+
+    it "should create resource successfully" do
+      subject.create inputs
+      a_post(request_path).with(inputs).should have_been_made
+    end
+
+    it "should return the resource" do
+      gist = subject.create inputs
+      gist.should be_a Hashie::Mash
+    end
+
+    it "should get the gist information" do
+      gist = subject.create inputs
+      gist.user.login.should == 'octocat'
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.create inputs }
+  end
+
+end # create

data/spec/github/gists/delete_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Gists, '#delete' do
+  let(:gist_id)   { 1 }
+  let(:request_path) { "/gists/#{gist_id}" }
+  let(:body) { fixture('gists/gist.json') }
+  let(:status) { 204 }
+
+  before {
+    stub_delete(request_path).to_return(:body => body, :status => status,
+      :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  it 'should raise error if gist id not present' do
+    expect { subject.delete nil }.to raise_error(ArgumentError)
+  end
+
+  it "should remove resource successfully" do
+    subject.delete gist_id
+    a_delete(request_path).should have_been_made
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.delete gist_id }
+  end
+
+end # delete

data/spec/github/gists/edit_spec.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Gists, '#edit' do
+  let(:gist_id) { 1 }
+  let(:request_path) { "/gists/#{gist_id}" }
+
+  let(:inputs) {
+    {
+      "description" => "the description for this gist",
+      "files" => {
+        "file1.txt" => {
+          "content" => "updated file contents"
+        },
+        "old_name.txt" => {
+          "filename" => "new_name.txt",
+          "content" => "modified contents"
+        },
+        "new_file.txt" => {
+          "content" => "a new file"
+        },
+        "delete_this_file.txt" => nil
+      }
+    }
+  }
+
+  before {
+    stub_patch(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 edited" do
+    let(:body) { fixture('gists/gist.json') }
+    let(:status) { 200 }
+
+    it "should edit resource successfully" do
+      subject.edit gist_id, inputs
+      a_patch(request_path).with(inputs).should have_been_made
+    end
+
+    it "should return the resource" do
+      gist = subject.edit gist_id, inputs
+      gist.should be_a Hashie::Mash
+    end
+
+    it "should get the gist information" do
+      gist = subject.edit gist_id, inputs
+      gist.user.login.should == 'octocat'
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.edit gist_id, inputs }
+  end
+
+end # edit

data/spec/github/gists/fork_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Gists, '#star' do
+  let(:gist_id) { 1 }
+  let(:request_path) { "/gists/#{gist_id}/fork" }
+  let(:body) { fixture('gists/gist.json') }
+  let(:status) { 201 }
+
+  before {
+    stub_post(request_path).to_return(:body => body, :status => status,
+      :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  it "should fail to fork gist without gist id" do
+    expect { subject.fork(nil) }.to raise_error(ArgumentError)
+  end
+
+  it "should fork resource successfully" do
+    subject.fork gist_id
+    a_post(request_path).should have_been_made
+  end
+
+  it "should return the resource" do
+    gist = subject.fork gist_id
+    gist.should be_a Hashie::Mash
+  end
+
+  it "should get the gist information" do
+    gist = subject.fork gist_id
+    gist.user.login.should == 'octocat'
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.fork gist_id }
+  end
+
+end # fork

data/spec/github/gists/get_spec.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Gists, '#get' do
+  let(:gist_id) { 1 }
+  let(:request_path) { "/gists/#{gist_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('gists/gist.json') }
+    let(:status) { 200 }
+
+    it { should respond_to :find }
+
+    it "should fail to get resource without gist id" do
+      expect { subject.get nil }.to raise_error(ArgumentError)
+    end
+
+    it "should get the resource" do
+      subject.get gist_id
+      a_get(request_path).should have_been_made
+    end
+
+    it "should get gist information" do
+      gist = subject.get gist_id
+      gist.id.to_i.should eq gist_id
+      gist.user.login.should == 'octocat'
+    end
+
+    it "should return mash" do
+      gist = subject.get gist_id
+      gist.should be_a Hashie::Mash
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.get gist_id }
+  end
+
+end # get

data/spec/github/gists/gists_spec.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Gists do
+
+end # Github::Gists

data/spec/github/gists/is_starred_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Gists, '#unstar' do
+  let(:gist_id) { 1 }
+  let(:request_path) { "/gists/#{gist_id}/star" }
+  let(:body) { '' }
+  let(:status) { 204 }
+
+  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 'when gist is starred' do
+    let(:status) { 204 }
+
+    it 'should raise error if gist id not present' do
+      expect { subject.starred? nil }.to raise_error(ArgumentError)
+    end
+
+    it 'should perform request' do
+      subject.starred? gist_id
+      a_get(request_path).should have_been_made
+    end
+
+    it 'should return true if gist is already starred' do
+      subject.starred?(gist_id).should be_true
+    end
+  end
+
+  context 'when gist is not starred' do
+    let(:status) { 404 }
+
+    it 'should return false if gist is not starred' do
+      subject.starred?(gist_id).should be_false
+    end
+  end
+end # starred?