github_api 0.7.2 → 0.8.0

data/lib/github_api/{repos → activity}/starring.rb

@@ -3,14 +3,14 @@
 module Github
   # Repository Starring is a feature that lets users bookmark repositories.
   # Stars are shown next to repositories to show an approximate level of interest.  # Stars have no effect on notifications or the activity feed.
-  class Repos::Starring < API
+  class Activity::Starring < API
 
     # List stargazers
     #
     # = Examples
     #  github = Github.new :user => 'user-name', :repo => 'repo-name'
-    #  github.repos.starring.list
-    #  github.repos.starring.list { |star| ... }
+    #  github.activity.starring.list
+    #  github.activity.starring.list { |star| ... }
     #
     def list(user_name, repo_name, params={})
       set :user => user_name, :repo => repo_name
@@ -27,13 +27,13 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.repos.starring.starred :user => 'user-name'
+    #  github.activity.starring.starred :user => 'user-name'
     #
     # List repos being starred by the authenticated user
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.repos.starring.starred
+    #  github.activity.starring.starred
     #
     def starred(*args)
       params = args.extract_options!
@@ -54,7 +54,7 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.repos.starring.starring? 'user-name', 'repo-name'
+    #  github.activity.starring.starring? 'user-name', 'repo-name'
     #
     def starring?(user_name, repo_name, params={})
       assert_presence_of user_name, repo_name
@@ -71,7 +71,7 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.repos.starring.star 'user-name', 'repo-name'
+    #  github.activity.starring.star 'user-name', 'repo-name'
     #
     def star(user_name, repo_name, params={})
       set :user => user_name, :repo => repo_name
@@ -86,7 +86,7 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.repos.starring.unstar 'user-name', 'repo-name'
+    #  github.activity.starring.unstar 'user-name', 'repo-name'
     #
     def unstar(user_name, repo_name, params={})
       set :user => user_name, :repo => repo_name
@@ -95,5 +95,5 @@ module Github
       delete_request("/user/starred/#{user_name}/#{repo_name}", params)
     end
 
-  end # Repos::Starring
+  end # Activity::Starring
 end # Github

data/lib/github_api/{repos → activity}/watching.rb

@@ -3,14 +3,14 @@
 module Github
   # Watching a Repository registers the user to receive notificactions on new
   # discussions, as well as events in the user’s activity feed.
-  class Repos::Watching < API
+  class Activity::Watching < API
 
     # List repo watchers
     #
     # = Examples
     #  github = Github.new :user => 'user-name', :repo => 'repo-name'
-    #  github.repos.watching.list
-    #  github.repos.watching.list { |watcher| ... }
+    #  github.activity.watching.list
+    #  github.activity.watching.list { |watcher| ... }
     #
     def list(user_name, repo_name, params={})
       set :user => user_name, :repo => repo_name
@@ -27,13 +27,13 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.repos.watching.watched :user => 'user-name'
+    #  github.activity.watching.watched :user => 'user-name'
     #
     # List repos being watched by the authenticated user
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.repos.watching.watched
+    #  github.activity.watching.watched
     #
     def watched(*args)
       params = args.extract_options!
@@ -53,7 +53,7 @@ module Github
     # Returns <tt>true</tt> if this repo is watched by you, <tt>false</tt> otherwise
     # = Examples
     #  github = Github.new
-    #  github.repos.watching.watching? 'user-name', 'repo-name'
+    #  github.activity.watching.watching? 'user-name', 'repo-name'
     #
     def watching?(user_name, repo_name, params={})
       assert_presence_of user_name, repo_name
@@ -70,7 +70,7 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.repos.watching.watch 'user-name', 'repo-name'
+    #  github.activity.watching.watch 'user-name', 'repo-name'
     #
     def watch(user_name, repo_name, params={})
       assert_presence_of user_name, repo_name
@@ -83,7 +83,7 @@ module Github
     # You need to be authenticated to stop watching a repository.
     # = Examples
     #  github = Github.new
-    #  github.repos.watching.unwatch 'user-name', 'repo-name'
+    #  github.activity.watching.unwatch 'user-name', 'repo-name'
     #
     def unwatch(user_name, repo_name, params={})
       assert_presence_of user_name, repo_name
@@ -91,5 +91,5 @@ module Github
       delete_request("/user/subscriptions/#{user_name}/#{repo_name}", params)
     end
 
-  end # Repos::Watching
+  end # Activity::Watching
 end # Github

data/lib/github_api/client.rb

@@ -3,10 +3,11 @@
 module Github
   class Client < API
 
-    # This is a read-only API to the GitHub events.
-    # These events power the various activity streams on the site.
-    def events(options = {})
-      @events ||= ApiFactory.new 'Events', options
+    # Serving up the ‘social’ in Social Coding™, the Activity APIs
+    # provide access to notifications, subscriptions, and timelines.
+    #
+    def activity(options = {})
+      @activity ||= ApiFactory.new 'Activity', options
     end
 
     def emojis(options = {})
@@ -60,6 +61,7 @@ module Github
 
     # Many of the resources on the users API provide a shortcut for getting 
     # information about the currently authenticated user.
+    #
     def users(options = {})
       @users ||= ApiFactory.new 'Users', options
     end

data/lib/github_api/repos.rb

@@ -16,9 +16,7 @@ module Github
       :Keys          => 'keys',
       :Merging       => 'merging',
       :PubSubHubbub  => 'pub_sub_hubbub',
-      :Starring      => 'starring',
-      :Statuses      => 'statuses',
-      :Watching      => 'watching'
+      :Statuses      => 'statuses'
 
     DEFAULT_REPO_OPTIONS = {
       "homepage"   => "https://github.com",
@@ -96,21 +94,11 @@ module Github
       @pubsubhubbub ||= ApiFactory.new 'Repos::PubSubHubbub'
     end
 
-    # Access to Repos::Starring API
-    def starring
-      @starring ||= ApiFactory.new 'Repos::Starring'
-    end
-
     # Access to Repos::Statuses API
     def statuses
       @statuses ||= ApiFactory.new 'Repos::Statuses'
     end
 
-    # Access to Repos::Watching API
-    def watching
-      @watching ||= ApiFactory.new 'Repos::Watching'
-    end
-
     # List branches
     #
     # = Examples
@@ -162,7 +150,7 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.repos.create "name" => 'repo-name'
+    #  github.repos.create "name": 'repo-name'
     #    "description": "This is your first repo",
     #    "homepage": "https://github.com",
     #    "private": false,

data/lib/github_api/response.rb

@@ -6,7 +6,6 @@ module Github
   # Contains methods and attributes that act on the response returned from the 
   # request
   class Response < Faraday::Response::Middleware
-
     CONTENT_TYPE = 'Content-Type'.freeze
 
     class << self

data/lib/github_api/version.rb

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

data/spec/fixtures/activity/notifications.json

@@ -0,0 +1,32 @@
+[
+  {
+    "id": 1,
+    "repository": {
+      "id": 1296269,
+      "owner": {
+        "login": "octocat",
+        "id": 1,
+        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+        "gravatar_id": "somehexcode",
+        "url": "https://api.github.com/users/octocat"
+      },
+      "name": "Hello-World",
+      "full_name": "octocat/Hello-World",
+      "description": "This your first repo!",
+      "private": false,
+      "fork": false,
+      "url": "https://api.github.com/repos/octocat/Hello-World",
+      "html_url": "https://github.com/octocat/Hello-World"
+    },
+    "subject": {
+      "title": "Greetings",
+      "url": "https://api.github.com/repos/pengwynn/octokit/issues/123",
+      "latest_comment_url": "https://api.github.com/repos/pengwynn/octokit/issues/comments/123"
+    },
+    "reason": "subscribed",
+    "unread": true,
+    "updated_at": "2012-09-25T07:54:41-07:00",
+    "last_read_at": "2012-09-25T07:54:41-07:00",
+    "url": "https://api.github.com/notifications/threads/1"
+  }
+]

data/spec/fixtures/activity/subscribed.json

@@ -0,0 +1,8 @@
+{
+  "subscribed": true,
+  "ignored": false,
+  "reason": null,
+  "created_at": "2012-10-06T21:34:12Z",
+  "url": "https://api.github.com/notifications/threads/1/subscription",
+  "thread_url": "https://api.github.com/notifications/threads/1"
+}

data/spec/fixtures/activity/threads.json

@@ -0,0 +1,32 @@
+[
+  {
+    "id": 1,
+      "repository": {
+        "id": 1296269,
+        "owner": {
+          "login": "octocat",
+          "id": 1,
+          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+          "gravatar_id": "somehexcode",
+          "url": "https://api.github.com/users/octocat"
+        },
+      "name": "Hello-World",
+      "full_name": "octocat/Hello-World",
+      "description": "This your first repo!",
+      "private": false,
+      "fork": false,
+      "url": "https://api.github.com/repos/octocat/Hello-World",
+      "html_url": "https://github.com/octocat/Hello-World"
+    },
+    "subject": {
+      "title": "Greetings",
+      "url": "https://api.github.com/repos/pengwynn/octokit/issues/123",
+      "latest_comment_url": "https://api.github.com/repos/pengwynn/octokit/issues/comments/123"
+    },
+    "reason": "subscribed",
+    "unread": true,
+    "updated_at": "2012-09-25T07:54:41-07:00",
+    "last_read_at": "2012-09-25T07:54:41-07:00",
+    "url": "https://api.github.com/notifications/threads/1"
+  }
+]

data/spec/github/activity/activity_spec.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Activity, 'integration' do
+
+  after { reset_authentication_for subject }
+
+  its(:events)        { should be_a Github::Activity::Events }
+
+  its(:notifications) { should be_a Github::Activity::Notifications }
+
+  its(:starring)      { should be_a Github::Activity::Starring }
+
+  its(:watching)      { should be_a Github::Activity::Watching }
+end

data/spec/github/activity/events/issue_spec.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Activity::Events, '#issue' do
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github' }
+  let(:request_path) { "/repos/#{user}/#{repo}/issues/events" }
+  let(:body) { fixture('events/events.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 "resource found" do
+    it { should respond_to :issue_events }
+
+    it "should fail to get resource without username" do
+      expect { subject.issue nil, repo }.to raise_error(ArgumentError)
+    end
+
+    it "should get the resources" do
+      subject.issue user, repo
+      a_get(request_path).should have_been_made
+    end
+
+    it "should return array of resources" do
+      events = subject.issue user, repo
+      events.should be_an Array
+      events.should have(1).items
+    end
+
+    it "should be a mash type" do
+      events = subject.issue user, repo
+      events.first.should be_a Hashie::Mash
+    end
+
+    it "should get event information" do
+      events = subject.issue user, repo
+      events.first.type.should == 'Event'
+    end
+
+    it "should yield to a block" do
+      subject.should_receive(:issue).with(user, repo).and_yield('web')
+      subject.issue(user, repo) { |param| 'web' }
+    end
+  end
+
+  context "resource not found" do
+    let(:body) { '' }
+    let(:status) { [404, "Not Found"] }
+
+    it "should return 404 with a message 'Not Found'" do
+      expect {
+        subject.issue user, repo
+      }.to raise_error(Github::Error::NotFound)
+    end
+  end
+end # issue

data/spec/github/activity/events/network_spec.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Activity::Events, '#network' do
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github' }
+  let(:request_path) { "/networks/#{user}/#{repo}/events" }
+  let(:body) { fixture('events/events.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 "resource found" do
+    it "should fail to get resource without username" do
+      expect { subject.network nil, repo }.to raise_error(ArgumentError)
+    end
+
+    it "should get the resources" do
+      subject.network user, repo
+      a_get(request_path).should have_been_made
+    end
+
+    it "should return array of resources" do
+      events = subject.network user, repo
+      events.should be_an Array
+      events.should have(1).items
+    end
+
+    it "should be a mash type" do
+      events = subject.network user, repo
+      events.first.should be_a Hashie::Mash
+    end
+
+    it "should get event information" do
+      events = subject.network user, repo
+      events.first.type.should == 'Event'
+    end
+
+    it "should yield to a block" do
+      subject.should_receive(:network).with(user, repo).and_yield('web')
+      subject.network(user, repo) { |param| 'web' }
+    end
+  end
+
+  context "resource not found" do
+    let(:body) { '' }
+    let(:status) { [404, "Not Found"] }
+
+    it "should return 404 with a message 'Not Found'" do
+      expect {
+        subject.network user, repo
+      }.to raise_error(Github::Error::NotFound)
+    end
+  end
+end # network

data/spec/github/activity/events/org_spec.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Activity::Events, '#org' do
+  let(:org) { 'github' }
+  let(:request_path) { "/orgs/#{org}/events" }
+  let(:body) { fixture('events/events.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 "resource found" do
+    it { should respond_to :organization }
+
+    it "should fail to get resource without orgname" do
+      expect { subject.org nil }.to raise_error(ArgumentError)
+    end
+
+    it "should get the resources" do
+      subject.org org
+      a_get(request_path).should have_been_made
+    end
+
+    it "should return array of resources" do
+      events = subject.org org
+      events.should be_an Array
+      events.should have(1).items
+    end
+
+    it "should be a mash type" do
+      events = subject.org org
+      events.first.should be_a Hashie::Mash
+    end
+
+    it "should get event information" do
+      events = subject.org org
+      events.first.type.should == 'Event'
+    end
+
+    it "should yield to a block" do
+      subject.should_receive(:org).with(org).and_yield('web')
+      subject.org(org) { |param| 'web' }
+    end
+  end
+
+  context "resource not found" do
+    let(:body) { '' }
+    let(:status) { [404, "Not Found"] }
+
+    it "should return 404 with a message 'Not Found'" do
+      expect { subject.org org }.to raise_error(Github::Error::NotFound)
+    end
+  end
+end # org