octokit 1.21.0 → 1.22.0

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+# 1.22.0
+
+* Patch from @[gonzoyumo][] to fix service hooks
+
+[gonzoyumo]: https://github.com/gonzoyumo
+
+View [the full changelog][1.22.0].
+[1.22.0]: https://github.com/pengwynn/octokit/compare/v1.21.0...v1.22.0
+
 # 1.21.0
 
 [@joeyw](https://github.com/joeyw) added:

data/lib/faraday/response/raise_octokit_error.rb

@@ -19,22 +19,7 @@ module Faraday
 
     def on_complete(response)
       key = response[:status].to_i
-      raise ERROR_MAP[key], error_message(response) if ERROR_MAP.has_key? key
-    end
-
-    def error_message(response)
-      message = if (body = response[:body]) && !body.empty?
-        if body.is_a?(String)
-          body = MultiJson.load(body, :symbolize_keys => true)
-        end
-        ": #{body[:error] || body[:message] || ''}"
-      else
-        ''
-      end
-      errors = unless message.empty?
-        body[:errors] ?  ": #{body[:errors].map{|e|e[:message]}.join(', ')}" : ''
-      end
-      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{message}#{errors}"
+      raise ERROR_MAP[key].new(response) if ERROR_MAP.has_key? key
     end
   end
 end

data/lib/octokit/client/pub_sub_hubbub.rb

@@ -14,9 +14,9 @@ module Octokit
           :"hub.mode" => "subscribe",
           :"hub.topic" => topic,
           :"hub.callback" => callback,
+          :force_urlencoded => true
         }
-        post("hub", options)
-        true
+        boolean_from_response(:post, "hub", options)
       end
 
       # Unsubscribe from a pubsub topic
@@ -32,9 +32,9 @@ module Octokit
           :"hub.mode" => "unsubscribe",
           :"hub.topic" => topic,
           :"hub.callback" => callback,
+          :force_urlencoded => true
         }
-        post("hub", options)
-        true
+        boolean_from_response(:post, "hub", options)
       end
     end
   end

data/lib/octokit/client/pub_sub_hubbub/service_hooks.rb

@@ -16,7 +16,6 @@ module Octokit
           topic = "#{Octokit.web_endpoint}#{Repository.new(repo)}/events/push"
           callback = "github://#{service_name}?#{service_arguments.collect{ |k,v| [ k,v ].join("=") }.join("&") }"
           subscribe(topic, callback)
-          true
         end
 
         # Unsubscribe repository through pubsub
@@ -31,7 +30,6 @@ module Octokit
           topic = "#{Octokit.web_endpoint}#{Repository.new(repo)}/events/push"
           callback = "github://#{service_name}"
           unsubscribe(topic, callback)
-          true
         end
       end
     end

data/lib/octokit/connection.rb

@@ -25,7 +25,11 @@ module Octokit
       # TODO: Don't build on every request
       connection = Faraday.new(options) do |builder|
 
-        builder.request :json
+        if options[:force_urlencoded]
+          builder.request :url_encoded
+        else
+          builder.request :json
+        end
 
         builder.use Faraday::Response::RaiseOctokitError
         builder.use FaradayMiddleware::FollowRedirects

data/lib/octokit/error.rb

@@ -1,6 +1,38 @@
 module Octokit
   # Custom error class for rescuing from all GitHub errors
-  class Error < StandardError; end
+  class Error < StandardError
+    def initialize(response)
+      @response = response
+      super(build_error_message)
+    end
+
+    def response_body
+      @response_body ||=
+        if (body = @response[:body]) && !body.empty?
+          if body.is_a?(String)
+            MultiJson.load(body, :symbolize_keys => true)
+          else
+            body
+          end
+        else
+          nil
+        end
+    end
+
+    private
+
+    def build_error_message
+      message = if response_body
+        ": #{response_body[:error] || response_body[:message] || ''}"
+      else
+        ''
+      end
+      errors = unless message.empty?
+        response_body[:errors] ?  ": #{response_body[:errors].map{|e|e[:message]}.join(', ')}" : ''
+      end
+      "#{@response[:method].to_s.upcase} #{@response[:url].to_s}: #{@response[:status]}#{message}#{errors}"
+    end
+  end
 
   # Raised when GitHub returns a 400 HTTP status code
   class BadRequest < Error; end

data/lib/octokit/request.rb

@@ -51,8 +51,11 @@ module Octokit
               options.delete(:oauth_token)  ||
               oauth_token
 
+      force_urlencoded = options.delete(:force_urlencoded) || false
+
       conn_options = {
-        :authenticate => token.nil?
+        :authenticate => token.nil?,
+        :force_urlencoded => force_urlencoded
       }
 
       response = connection(conn_options).send(method) do |request|
@@ -74,7 +77,11 @@ module Octokit
           request.url(path, options)
         when :patch, :post, :put
           request.path = path
-          request.body = MultiJson.dump(options) unless options.empty?
+          if force_urlencoded
+            request.body = options unless options.empty?
+          else
+            request.body = MultiJson.dump(options) unless options.empty?
+          end
         end
 
         if Octokit.request_host

data/lib/octokit/version.rb

@@ -1,3 +1,3 @@
 module Octokit
-  VERSION = "1.21.0" unless defined?(Octokit::VERSION)
+  VERSION = "1.22.0" unless defined?(Octokit::VERSION)
 end

data/spec/faraday/response_spec.rb

@@ -49,6 +49,14 @@ describe Faraday::Response do
           @client.user('sferik')
         }.to raise_error(Octokit::BadRequest, /#{body.values.first}/)
       end
+
+      it "includes the body on the error" do
+        expect {
+          @client.user('sferik')
+        }.to raise_error { |error|
+          error.response_body.should == body
+        }
+      end
     end
   end
 

data/spec/octokit/client/pub_sub_hubbub/service_hooks_spec.rb

@@ -16,10 +16,12 @@ describe Octokit::Client::PubSubHubbub::ServiceHooks do
     it "subscribes to pull events on specified topic" do
       stub_post("/hub").
         with(subscribe_request_body).
-        to_return(:body => nil)
+        to_return(:status => 204)
 
       expect(client.subscribe_service_hook("joshk/completeness-fu", "Travis", { :token => 'travistoken' })).to eq(true)
-      assert_requested :post, "https://api.github.com/hub", :body => subscribe_request_body, :times => 1
+      assert_requested :post, "https://api.github.com/hub", :body => subscribe_request_body, :times => 1,
+        :headers => {'Content-type' => 'application/x-www-form-urlencoded'}
+
     end
   end
 
@@ -35,10 +37,11 @@ describe Octokit::Client::PubSubHubbub::ServiceHooks do
     it "unsubscribes to stop receiving events on specified topic" do
       stub_post("/hub").
         with(unsubscribe_request_body).
-        to_return(:body => nil)
+        to_return(:status => 204)
 
       expect(client.unsubscribe_service_hook("joshk/completeness-fu", "Travis")).to eq(true)
-      assert_requested :post, "https://api.github.com/hub", :body => unsubscribe_request_body, :times => 1
+      assert_requested :post, "https://api.github.com/hub", :body => unsubscribe_request_body, :times => 1,
+        :headers => {'Content-type' => 'application/x-www-form-urlencoded'}
     end
   end
 end

data/spec/octokit/client/pub_sub_hubbub_spec.rb

@@ -5,44 +5,63 @@ describe Octokit::Client::PubSubHubbub do
   let(:client) { Octokit::Client.new(:oauth_token => 'myfaketoken') }
 
   describe ".subscribe" do
-    it "subscribes to pull events" do
-      stub_post("/hub").
-        with({
+    context "with valid params" do
+      let(:subscribe_request_body) {
+        {
           :"hub.callback" => 'github://Travis?token=travistoken',
           :"hub.mode" => 'subscribe',
           :"hub.topic" => 'https://github.com/joshk/completeness-fu/events/push'
-        }).
-        to_return(:body => nil)
+        }
+      }
+      it "subscribes to pull events" do
+        stub_post("/hub").
+          with(subscribe_request_body).
+          to_return(:status => 204)
 
-      expect(client.subscribe("https://github.com/joshk/completeness-fu/events/push", "github://Travis?token=travistoken")).to eq(true)
+        expect(client.subscribe("https://github.com/joshk/completeness-fu/events/push", "github://Travis?token=travistoken")).to eq(true)
+        assert_requested :post, "https://api.github.com/hub", :body => subscribe_request_body, :times => 1,
+          :headers => {'Content-type' => 'application/x-www-form-urlencoded'}
+      end
     end
-
-    it "raises an error if the topic is not recognized" do
-      stub_post("/hub").
-        with({
+    context "when topic is not recognized" do
+      let(:subscribe_request_body) {
+        {
           :"hub.callback" => 'github://Travis?token=travistoken',
           :"hub.mode" => 'subscribe',
-          :"hub.topic" => 'https://github.com/joshk/completeness-fud/events/push'
-        }).
-        to_return(:status => 422)
+          :"hub.topic" => 'https://github.com/joshk/not_existing_project/events/push'
+        }
+      }
+      it "raises an error" do
+        stub_post("/hub").
+          with(subscribe_request_body).
+          to_return(:status => 422)
 
-      expect {
-        client.subscribe("https://github.com/joshk/completeness-fud/events/push", "github://Travis?token=travistoken")
-      }.to raise_exception
+        expect {
+          client.subscribe("https://github.com/joshk/not_existing_project/events/push", "github://Travis?token=travistoken")
+        }.to raise_exception
+        assert_requested :post, "https://api.github.com/hub", :body => subscribe_request_body, :times => 1,
+          :headers => {'Content-type' => 'application/x-www-form-urlencoded'}
+      end
     end
   end
 
   describe ".unsubscribe" do
-    it "unsubscribes from pull events" do
-      stub_post("/hub").
-      with({
+    let(:unsubscribe_request_body) {
+      {
         :"hub.callback" => 'github://Travis?token=travistoken',
         :"hub.mode" => 'unsubscribe',
         :"hub.topic" => 'https://github.com/joshk/completeness-fu/events/push'
-      }).
-      to_return(:body => nil)
+      }
+    }
+
+    it "unsubscribes from pull events" do
+      stub_post("/hub").
+        with(unsubscribe_request_body).
+        to_return(:status => 204)
 
       expect(client.unsubscribe("https://github.com/joshk/completeness-fu/events/push", "github://Travis?token=travistoken")).to eq(true)
+      assert_requested :post, "https://api.github.com/hub", :body => unsubscribe_request_body, :times => 1,
+        :headers => {'Content-type' => 'application/x-www-form-urlencoded'}
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.22.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-10 00:00:00.000000000 Z
+date: 2013-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable