github_api 0.1.2 → 0.2.0

data/README.rdoc

@@ -12,7 +12,7 @@ Grab the gem by issuing
 
 or in your Gemfile
 
-  gem "github_api", "~> 0.1.1"
+  gem "github_api", "~> 0.2.0"
 
 == Usage
 

data/lib/github_api/core_ext/hash.rb

@@ -35,4 +35,8 @@ class Hash # :nodoc:
     return hash
   end unless method_defined?(:symbolize_keys!)
 
+  def serialize # :nodoc:
+    self.map { |key, val| [key, val].join("=") }.join("&")
+  end unless method_defined?(:serialize)
+
 end # Hash

data/lib/github_api/repos.rb

@@ -12,7 +12,8 @@ module Github
       :Forks         => 'forks',
       :Hooks         => 'hooks',
       :Keys          => 'keys',
-      :Watching      => 'watching'
+      :Watching      => 'watching',
+      :PubSubHubbub  => 'pub_sub_hubbub'
 
     include Github::Repos::Collaborators
     include Github::Repos::Commits
@@ -21,6 +22,7 @@ module Github
     include Github::Repos::Hooks
     include Github::Repos::Keys
     include Github::Repos::Watching
+    include Github::Repos::PubSubHubbub
 
     DEFAULT_REPO_OPTIONS = {
       "homepage"   => "https://github.com",
@@ -28,7 +30,7 @@ module Github
       "has_issues" => true,
       "has_wiki"   => true,
       "has_downloads" => true
-    }
+    }.freeze
 
     VALID_REPO_OPTIONS = %w[
       name
@@ -40,7 +42,7 @@ module Github
       has_downloads
     ].freeze
 
-    VALID_REPO_TYPES = %w[ all public private member ]
+    VALID_REPO_TYPES = %w[ all public private member ].freeze
 
     # Creates new Repositories API
     def initialize(options = {})

data/lib/github_api/repos/pub_sub_hubbub.rb

@@ -3,10 +3,100 @@
 module Github
   class Repos
     module PubSubHubbub
-      
-      def subscribe(topic, callback)
-        post("/hub")
+
+      # Subscribe to existing topic through pubsubhubbub
+      #
+      # = Parameters
+      # * topic - Required string - The URI of the GitHub repository to subscribe to. The path must be in the format of /:user/:repo/events/:event.
+      # * callback - Required string - The URI to receive the updates to the topic.
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.subscribe 'https://github.com/:user/:repo/events/push',
+      #    'github://Email?address=peter-murach@gmail.com',
+      #    :verify => 'sync',
+      #    :secret => '...'
+      #
+      def subscribe(topic, callback, params={})
+        _validate_presence_of topic, callback
+        _normalize_params_keys(params)
+        _merge_action!("subscribe", topic, callback, params)
+
+        post("/hub", params)
+      end
+
+      # Unsubscribe from existing topic though pubsubhubbub
+      #
+      #
+      def unsubscribe(topic, callback, params={})
+        _validate_presence_of topic, callback
+        _normalize_params_keys(params)
+        _merge_action!("unsubscribe", topic, callback, params)
+
+        post("/hub", params)
+      end
+
+      # Subscribe repository to service hook through pubsubhubbub
+      #
+      # = Parameters
+      # * repo-name - Required string,
+      # * service-name - Required string
+      # * <tt>:event</tt> - Required hash key for the type of event. The default event is <tt>push</tt>
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.repos.subscribe_service 'user-name', 'repo-name', 'campfire',
+      #    :subdomain => 'github',
+      #    :room => 'Commits',
+      #    :token => 'abc123',
+      #    :event => 'watch'
+      #
+      def subscribe_service(user_name, repo_name, service_name, params={})
+        _validate_presence_of user_name, repo_name, service_name
+        _normalize_params_keys(params)
+        event = params.delete('event') || 'push'
+        topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"
+        callback = "github://#{service_name}?#{params.serialize}"
+
+        subscribe(topic, callback)
       end
+      alias :subscribe_repository :subscribe_service
+
+      # Subscribe repository to service hook through pubsubhubbub
+      #
+      # = Parameters
+      # * repo-name - Required string,
+      # * service-name - Required string
+      # * <tt>:event</tt> - Optional hash key for the type of event. The default event is <tt>push</tt>
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.repos.unsubscribe_service 'user-name', 'repo-name', 'campfire'
+      #
+      def unsubscribe_service(user_name, repo_name, service_name, params={})
+        _validate_presence_of user_name, repo_name, service_name
+        _normalize_params_keys(params)
+        event = params.delete('event') || 'push'
+        topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"
+        callback = "github://#{service_name}"
+
+        unsubscribe(topic, callback)
+      end
+      alias :unsubscribe_repository :unsubscribe_service
+
+    private
+
+      def _merge_action!(action, topic, callback, params) # :nodoc:
+        options = {
+          "hub.mode"     => action.to_s,
+          "hub.topic"    => topic.to_s,
+          "hub.callback" => callback,
+          "hub.verify"   => params.delete('verify') || 'sync',
+          "hub.secret"   => params.delete('secret') || ''
+        }
+        params.merge! options
+      end
+
     end # PubSubHubbub
   end # Repos
 end # Github

data/lib/github_api/version.rb

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

data/spec/github/core_ext/hash_spec.rb

@@ -4,6 +4,8 @@ describe Hash do
 
   before do
     Github.new
+    @hash = { :a => 1, :b => 2, :c => 'e'}
+    @serialized = "a=1&b=2&c=e"
     @nested_hash = { 'a' => { 'b' => {'c' => 1 } } }
     @symbols = { :a => { :b => { :c => 1 } } }
   end
@@ -24,6 +26,10 @@ describe Hash do
     @nested_hash.should respond_to :symbolize_keys
   end
 
+  it "should respond to serialize" do
+    @nested_hash.should respond_to :serialize
+  end
+
   it "should remove key from the hash" do
     @nested_hash.except('a').should be_empty
   end
@@ -31,4 +37,8 @@ describe Hash do
   it "should convert nested keys to symbols" do
     @nested_hash.symbolize_keys!.should == @symbols
   end
+
+  it "should serialize hash" do
+    @hash.serialize.should == @serialized
+  end
 end

data/spec/github/repos/pub_sub_hubbub_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Github::Repos::PubSubHubbub do
+
+  let(:github) { Github.new }
+  let(:topic)  { "https://github.com/peter-murach/github/events/push"}
+  let(:callback) { "github://campfire?subdomain=github&room=Commits&token=abc123" }
+  let(:hub_inputs) {
+    {
+       "hub.mode" => 'subscribe',
+       "hub.topic" => topic,
+       "hub.callback" => callback,
+       "hub.verify"   => 'sync',
+       "hub.secret"   => ''
+    }
+  }
+
+  describe "subscribe" do
+    context "success" do
+      before do
+        github.oauth_token = OAUTH_TOKEN
+        stub_post("/hub?access_token=#{OAUTH_TOKEN}").with(hub_inputs).
+          to_return(:body => '', :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      after do
+        github.oauth_token = nil
+      end
+
+      it "should subscribe to hub" do
+        github.repos.subscribe topic, callback
+        a_post("/hub?access_token=#{OAUTH_TOKEN}").with(hub_inputs).should have_been_made
+      end
+    end
+
+    context "failure" do
+      before do
+        github.oauth_token = OAUTH_TOKEN
+        stub_post("/hub?access_token=#{OAUTH_TOKEN}").with(hub_inputs).
+          to_return(:body => '', :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to subscribe to hub" do
+        expect {
+          github.repos.subscribe topic, callback
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end
+
+  describe "unsubscribe" do
+    context "success" do
+      before do
+        github.oauth_token = OAUTH_TOKEN
+        stub_post("/hub?access_token=#{OAUTH_TOKEN}").with(hub_inputs.merge("hub.mode" => 'unsubscribe')).
+          to_return(:body => '', :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      after do
+        github.oauth_token = nil
+      end
+
+      it "should subscribe to hub" do
+        github.repos.unsubscribe topic, callback
+        a_post("/hub?access_token=#{OAUTH_TOKEN}").with(hub_inputs).should have_been_made
+      end
+    end
+
+    context "failure" do
+      before do
+        github.oauth_token = OAUTH_TOKEN
+        stub_post("/hub?access_token=#{OAUTH_TOKEN}").with(hub_inputs.merge("hub.mode" => 'unsubscribe')).
+          to_return(:body => '', :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should fail to subscribe to hub" do
+        expect {
+          github.repos.unsubscribe topic, callback
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end
+end # Github::Repos::PubSubHubbub

data/spec/spec_helper.rb

@@ -15,35 +15,35 @@ RSpec.configure do |config|
   config.include WebMock::API
 end
 
-def stub_get(path, endpoint = Github.endpoint)
+def stub_get(path, endpoint = Github.endpoint.to_s)
   stub_request(:get, endpoint + path)
 end
 
-def stub_post(path, endpoint = Github.endpoint)
+def stub_post(path, endpoint = Github.endpoint.to_s)
   stub_request(:post, endpoint + path)
 end
 
-def stub_patch(path, endpoint = Github.endpoint)
+def stub_patch(path, endpoint = Github.endpoint.to_s)
   stub_request(:patch, endpoint + path)
 end
 
-def stub_put(path, endpoint = Github.endpoint)
+def stub_put(path, endpoint = Github.endpoint.to_s)
   stub_request(:put, endpoint + path)
 end
 
-def stub_delete(path, endpoint = Github.endpoint)
+def stub_delete(path, endpoint = Github.endpoint.to_s)
   stub_request(:delete, endpoint + path)
 end
 
-def a_get(path, endpoint = Github.endpoint)
+def a_get(path, endpoint = Github.endpoint.to_s)
   a_request(:get, endpoint + path)
 end
 
-def a_post(path, endpoint = Github.endpoint)
+def a_post(path, endpoint = Github.endpoint.to_s)
   a_request(:post, endpoint + path)
 end
 
-def a_patch(path, endpoint = Github.endpoint)
+def a_patch(path, endpoint = Github.endpoint.to_s)
   a_request(:patch, endpoint + path)
 end
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Piotr Murach
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-22 00:00:00 +01:00
+date: 2011-10-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -285,6 +285,7 @@ files:
 - spec/github/repos/forks_spec.rb
 - spec/github/repos/hooks_spec.rb
 - spec/github/repos/keys_spec.rb
+- spec/github/repos/pub_sub_hubbub_spec.rb
 - spec/github/repos/watching_spec.rb
 - spec/github/repos_spec.rb
 - spec/github_spec.rb