Add notifications api thread creation and deletion.

piotrmurach · piotrmurach · commit 66ebb96f72fd · 2012-11-03T21:13:03.000Z
diff --git a/lib/github_api/activity/notifications.rb b/lib/github_api/activity/notifications.rb
@@ -76,5 +76,42 @@ def subscribed?(thread_id, params={})
       get_request("/notifications/threads/#{thread_id}/subscription", params)
     end
 
+    # Create a thread subscription
+    #
+    # This lets you subscribe to a thread, or ignore it. Subscribing to a thread
+    # is unnecessary if the user is already subscribed to the repository. Ignoring
+    # a thread will mute all future notifications (until you comment or get
+    # @mentioned).
+    #
+    # = Parameters
+    # * <tt>:subscribed</tt> - boolean - determines if notifications should be
+    #                          received from this thread.
+    # * <tt>:ignored</tt> - boolean - deterimines if all notifications should be
+    #                       blocked from this thread.
+    # = Examples
+    #  github = Github.new oauth_token: 'token'
+    #  github.activity.notifications.create 'thread-id',
+    #    'subscribed': true
+    #    'ignored': false
+    #
+    def create(thread_id, params={})
+      assert_presence_of thread_id
+      normalize! params
+      put_request("/notifications/threads/#{thread_id}/subscription", params)
+    end
+
+    # Delete a thread subscription
+    #
+    # = Examples
+    #  github = Github.new oauth_token: 'token'
+    #  github.activity.notifications.delete 'thread_id'
+    #
+    def delete(thread_id, params={})
+      assert_presence_of thread_id
+      normalize! params
+      delete_request("/notifications/threads/#{thread_id}/subscription", params)
+    end
+    alias :remove :delete
+
   end # Activity::Notifications
 end # Github
diff --git a/spec/github/activity/notifications/create_spec.rb b/spec/github/activity/notifications/create_spec.rb
@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Activity::Notifications, '#create' do
+  let(:thread_id) { 1 }
+  let(:request_path) { "/notifications/threads/#{thread_id}/subscription" }
+
+  let(:inputs) {{
+    :subscribed => true,
+    :ignored => false
+  }}
+
+  before {
+    subject.oauth_token = OAUTH_TOKEN
+    stub_put(request_path).
+      with(:body => inputs, :query => {:access_token => OAUTH_TOKEN}).
+      to_return(:body => body, :status => status,
+        :headers => {:content_type => "application/json; charset=utf-8"} )
+  }
+
+  after { reset_authentication_for subject }
+
+  context "resource created successfully" do
+    let(:body)  { fixture('activity/subscribed.json') }
+    let(:status) { 200 }
+
+    it 'asserts thread id presence' do
+      expect { subject.create nil }.to raise_error(ArgumentError)
+    end
+
+    it 'should create resource' do
+      subject.create thread_id, inputs
+      a_put(request_path).
+        with(:body => inputs, :query => {:access_token => OAUTH_TOKEN}).
+        should have_been_made
+    end
+
+    it 'should return the resource' do
+      thread = subject.create thread_id, inputs
+      thread.subscribed.should be_true
+    end
+  end
+end # create
diff --git a/spec/github/activity/notifications/delete_spec.rb b/spec/github/activity/notifications/delete_spec.rb
@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Activity::Notifications, '#delete' do
+  let(:thread_id) { 1 }
+  let(:request_path) { "/notifications/threads/#{thread_id}/subscription" }
+  let(:body) { '' }
+  let(:status) { 204 }
+
+  before {
+    subject.oauth_token = OAUTH_TOKEN
+    stub_delete(request_path).with(:query => {:access_token => OAUTH_TOKEN}).
+    to_return(:body => body, :status => status,
+      :headers => { :content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for subject }
+
+  it { should respond_to :remove }
+
+  it "should delete the resource successfully" do
+    subject.delete thread_id
+    a_delete(request_path).with(:query => {:access_token => OAUTH_TOKEN}).
+      should have_been_made
+  end
+
+  it "should fail to delete resource without 'user' parameter" do
+    expect { subject.delete nil }.to raise_error(ArgumentError)
+  end
+
+  context 'failed to delete' do
+    let(:status) { 404 }
+
+    it "should fail to delete resource that is not found" do
+      expect {
+        subject.delete thread_id
+      }.to raise_error(Github::Error::NotFound)
+    end
+  end
+end # delete
