octokit 1.25.0 → 2.0.0.pre

data/lib/octokit/client/organizations.rb

@@ -1,17 +1,21 @@
 module Octokit
   class Client
+
+    # Methods for the Organizations API
+    #
+    # @see http://developer.github.com/v3/orgs/
     module Organizations
       # Get an organization
       #
       # @param org [String] Organization GitHub username.
-      # @return [Hashie::Mash] Hash representing GitHub organization.
+      # @return [Sawyer::Resource] Hash representing GitHub organization.
       # @see http://developer.github.com/v3/orgs/#get-an-organization
       # @example
       #   Octokit.organization('github')
       # @example
       #   Octokit.org('github')
       def organization(org, options={})
-        get("orgs/#{org}", options)
+        get "orgs/#{org}", options
       end
       alias :org :organization
 
@@ -26,8 +30,7 @@ module Octokit
       # @option values [String] :email Publicly visible email address.
       # @option values [String] :location Location of organization.
       # @option values [String] :name GitHub username for organization.
-      # @return [Hashie::Mash] Hash representing GitHub organization.
-      # @see Octokit::Client
+      # @return [Sawyer::Resource] Hash representing GitHub organization.
       # @see http://developer.github.com/v3/orgs/#edit-an-organization
       # @example
       #   @client.update_organization('github', {
@@ -40,7 +43,7 @@ module Octokit
       # @example
       #   @client.update_org('github', {:company => 'Unicorns, Inc.'})
       def update_organization(org, values, options={})
-        patch("orgs/#{org}", options.merge({:organization => values}))
+        patch "orgs/#{org}", options.merge({:organization => values})
       end
       alias :update_org :update_organization
 
@@ -56,8 +59,7 @@ module Octokit
       # Private organizations are included only if the `@client` is authenticated.
       # 
       # @param user [String] Username of the user to get list of organizations.
-      # @return [Array<Hashie::Mash>] Array of hashes representing organizations.
-      # @see Octokit::Client
+      # @return [Array<Sawyer::Resource>] Array of hashes representing organizations.
       # @see http://developer.github.com/v3/orgs/#list-user-organizations
       # @example
       #   Octokit.organizations('pengwynn')
@@ -73,9 +75,9 @@ module Octokit
       #   @client.organizations
       def organizations(user=nil, options={})
         if user
-          get("users/#{user}/orgs", options)
+          get "users/#{user}/orgs", options
         else
-          get("user/orgs", options)
+          get "user/orgs", options
         end
       end
       alias :list_organizations :organizations
@@ -91,8 +93,7 @@ module Octokit
       # @option options [String] :type ('all') Filter by repository type.
       #   `all`, `public`, `member`, `sources`, `forks`, or `private`.
       #
-      # @return [Array<Hashie::Mash>] List of repositories
-      # @see Octokit::Client
+      # @return [Array<Sawyer::Resource>] List of repositories
       # @see http://developer.github.com/v3/repos/#list-organization-repositories
       # @example
       #   Octokit.organization_repositories('github')
@@ -103,7 +104,7 @@ module Octokit
       # @example
       #   @client.org_repos('github', {:type => 'private'})
       def organization_repositories(org, options={})
-        get("orgs/#{org}/repos", options)
+        get "orgs/#{org}/repos", options
       end
       alias :org_repositories :organization_repositories
       alias :org_repos :organization_repositories
@@ -115,8 +116,7 @@ module Octokit
       # is required to get private members.
       #
       # @param org [String] Organization GitHub username.
-      # @return [Array<Hashie::Mash>] Array of hashes representing users.
-      # @see Octokit::Client
+      # @return [Array<Sawyer::Resource>] Array of hashes representing users.
       # @see http://developer.github.com/v3/orgs/members/#list-members
       # @example
       #   Octokit.organization_members('github')
@@ -125,7 +125,7 @@ module Octokit
       # @example
       #   Octokit.org_members('github')
       def organization_members(org, options={})
-        get("orgs/#{org}/members", options)
+        get "orgs/#{org}/members", options
       end
       alias :org_members :organization_members
 
@@ -146,7 +146,12 @@ module Octokit
       #   @client.organization_member?('your_organization', 'pengwynn')
       #   => false
       def organization_member?(org, user, options={})
-        boolean_from_response(:get, "orgs/#{org}/members/#{user}", options)
+        result = boolean_from_response(:get, "orgs/#{org}/members/#{user}", options)
+        if last_response.status == 302
+          boolean_from_response :get, last_response.headers['Location']
+        else
+          result
+        end
       end
       alias :org_member? :organization_member?
 
@@ -166,7 +171,7 @@ module Octokit
       #   @client.organization_public_member?('github', 'pengwynn')
       #   => true
       def organization_public_member?(org, user, options={})
-        boolean_from_response(:get, "orgs/#{org}/public_members/#{user}", options)
+        boolean_from_response :get, "orgs/#{org}/public_members/#{user}", options
       end
       alias :org_public_member? :organization_public_member?
 
@@ -175,15 +180,14 @@ module Octokit
       # Requires authenticated organization member.
       #
       # @param org [String] Organization GitHub username.
-      # @return [Array<Hashie::Mash>] Array of hashes representing teams.
-      # @see Octokit::Client
+      # @return [Array<Sawyer::Resource>] Array of hashes representing teams.
       # @see http://developer.github.com/v3/orgs/teams/#list-teams
       # @example
       #   @client.organization_teams('github')
       # @example
       #   @client.org_teams('github')
       def organization_teams(org, options={})
-        get("orgs/#{org}/teams", options)
+        get "orgs/#{org}/teams", options
       end
       alias :org_teams :organization_teams
 
@@ -200,8 +204,7 @@ module Octokit
       #   `pull` - team members can pull, but not push to or administer these repositories.    
       #   `push` - team members can pull and push, but not administer these repositories.  
       #   `admin` - team members can pull, push and administer these repositories. 
-      # @return [Hashie::Mash] Hash representing new team.
-      # @see Octokit::Client
+      # @return [Sawyer::Resource] Hash representing new team.
       # @see http://developer.github.com/v3/orgs/teams/#create-team
       # @example
       #   @client.create_team('github', {
@@ -210,7 +213,7 @@ module Octokit
       #     :permission => 'push'
       #   })
       def create_team(org, options={})
-        post("orgs/#{org}/teams", options)
+        post "orgs/#{org}/teams", options
       end
 
       # Get team
@@ -218,13 +221,12 @@ module Octokit
       # Requires authenticated organization member.
       #
       # @param team_id [Integer] Team id.
-      # @return [Hashie::Mash] Hash representing team.
-      # @see Octokit::Client
+      # @return [Sawyer::Resource] Hash representing team.
       # @see http://developer.github.com/v3/orgs/teams/#get-team
       # @example
       #   @client.team(100000)
       def team(team_id, options={})
-        get("teams/#{team_id}", options)
+        get "teams/#{team_id}", options
       end
 
       # Update team
@@ -238,8 +240,7 @@ module Octokit
       #   `pull` - team members can pull, but not push to or administer these repositories.    
       #   `push` - team members can pull and push, but not administer these repositories.  
       #   `admin` - team members can pull, push and administer these repositories.
-      # @return [Hashie::Mash] Hash representing updated team.
-      # @see Octokit::Client
+      # @return [Sawyer::Resource] Hash representing updated team.
       # @see http://developer.github.com/v3/orgs/teams/#edit-team
       # @example
       #   @client.update_team(100000, {
@@ -247,7 +248,7 @@ module Octokit
       #     :permission => 'push'
       #   })
       def update_team(team_id, options={})
-        patch("teams/#{team_id}", options)
+        patch "teams/#{team_id}", options
       end
 
       # Delete team
@@ -256,12 +257,11 @@ module Octokit
       #
       # @param team_id [Integer] Team id.
       # @return [Boolean] True if deletion successful, false otherwise.
-      # @see Octokit::Client
       # @see http://developer.github.com/v3/orgs/teams/#delete-team
       # @example
       #   @client.delete_team(100000)
       def delete_team(team_id, options={})
-        boolean_from_response(:delete, "teams/#{team_id}", options)
+        boolean_from_response :delete, "teams/#{team_id}", options
       end
 
       # List team members
@@ -269,13 +269,12 @@ module Octokit
       # Requires authenticated organization member.
       #
       # @param team_id [Integer] Team id.
-      # @return [Array<Hashie::Mash>] Array of hashes representing users.
-      # @see Octokit::Client
+      # @return [Array<Sawyer::Resource>] Array of hashes representing users.
       # @see http://developer.github.com/v3/orgs/teams/#list-team-members
       # @example
       #   @client.team_members(100000)
       def team_members(team_id, options={})
-        get("teams/#{team_id}/members", options)
+        get "teams/#{team_id}/members", options
       end
 
       # Add team member
@@ -286,7 +285,6 @@ module Octokit
       # @param team_id [Integer] Team id.
       # @param user [String] GitHub username of new team member.
       # @return [Boolean] True on successful addition, false otherwise.
-      # @see Octokit::Client
       # @see http://developer.github.com/v3/orgs/teams/#add-team-member
       # @example
       #   @client.add_team_member(100000, 'pengwynn')
@@ -294,7 +292,7 @@ module Octokit
         # There's a bug in this API call. The docs say to leave the body blank,
         # but it fails if the body is both blank and the content-length header
         # is not 0.
-        boolean_from_response(:put, "teams/#{team_id}/members/#{user}", options.merge({:name => user}))
+        boolean_from_response :put, "teams/#{team_id}/members/#{user}", options.merge({:name => user})
       end
 
       # Remove team member
@@ -305,12 +303,11 @@ module Octokit
       # @param team_id [Integer] Team id.
       # @param user [String] GitHub username of the user to boot.
       # @return [Boolean] True if user removed, false otherwise.
-      # @see Octokit::Client
       # @see http://developer.github.com/v3/orgs/teams/#remove-team-member
       # @example
       #   @client.remove_team_member(100000, 'pengwynn')
       def remove_team_member(team_id, user, options={})
-        boolean_from_response(:delete, "teams/#{team_id}/members/#{user}", options)
+        boolean_from_response :delete, "teams/#{team_id}/members/#{user}", options
       end
 
       # Check if a user is a member of a team.
@@ -329,7 +326,7 @@ module Octokit
       #   @client.team_member?('your_team', 'pengwynn')
       #   => false
       def team_member?(team_id, user, options={})
-        boolean_from_response(:get, "teams/#{team_id}/members/#{user}", options)
+        boolean_from_response :get, "teams/#{team_id}/members/#{user}", options
       end
 
       # List team repositories
@@ -337,15 +334,14 @@ module Octokit
       # Requires authenticated organization member.
       #
       # @param team_id [Integer] Team id.
-      # @return [Array<Hashie::Mash>] Array of hashes representing repositories.
-      # @see Octokit::Client
+      # @return [Array<Sawyer::Resource>] Array of hashes representing repositories.
       # @see http://developer.github.com/v3/orgs/teams/#list-team-repos
       # @example
       #   @client.team_repositories(100000)
       # @example
       #   @client.team_repos(100000)
       def team_repositories(team_id, options={})
-        get("teams/#{team_id}/repos", options)
+        get "teams/#{team_id}/repos", options
       end
       alias :team_repos :team_repositories
 
@@ -358,7 +354,6 @@ module Octokit
       # @param team_id [Integer] Team id.
       # @param repo [String, Hash, Repository] A GitHub repository.
       # @return [Boolean] True if successful, false otherwise.
-      # @see Octokit::Client
       # @see Octokit::Repository
       # @see http://developer.github.com/v3/orgs/teams/#add-team-repo
       # @example
@@ -366,7 +361,7 @@ module Octokit
       # @example
       #   @client.add_team_repo(100000, 'github/developer.github.com')
       def add_team_repository(team_id, repo, options={})
-        boolean_from_response(:put, "teams/#{team_id}/repos/#{Repository.new(repo)}", options.merge(:name => Repository.new(repo)))
+        boolean_from_response :put, "teams/#{team_id}/repos/#{Repository.new(repo)}", options.merge(:name => Repository.new(repo))
       end
       alias :add_team_repo :add_team_repository
 
@@ -379,7 +374,6 @@ module Octokit
       # @param team_id [Integer] Team id.
       # @param repo [String, Hash, Repository] A GitHub repository.
       # @return [Boolean] Return true if repo removed from team, false otherwise.
-      # @see Octokit::Client
       # @see Octokit::Repository
       # @see http://developer.github.com/v3/orgs/teams/#remove-team-repo
       # @example
@@ -387,7 +381,7 @@ module Octokit
       # @example
       #   @client.remove_team_repo(100000, 'github/developer.github.com')
       def remove_team_repository(team_id, repo, options={})
-        boolean_from_response(:delete, "teams/#{team_id}/repos/#{Repository.new(repo)}")
+        boolean_from_response :delete, "teams/#{team_id}/repos/#{Repository.new(repo)}"
       end
       alias :remove_team_repo :remove_team_repository
 
@@ -398,7 +392,6 @@ module Octokit
       # @param org [String] Organization GitHub username.
       # @param user [String] GitHub username of user to remove.
       # @return [Boolean] True if removal is successful, false otherwise.
-      # @see Octokit::Client
       # @see http://developer.github.com/v3/orgs/teams/#remove-team-member
       # @example
       #   @client.remove_organization_member('github', 'pengwynn')
@@ -407,7 +400,7 @@ module Octokit
       def remove_organization_member(org, user, options={})
         # this is a synonym for: for team in org.teams: remove_team_member(team.id, user)
         # provided in the GH API v3
-        boolean_from_response(:delete, "orgs/#{org}/members/#{user}", options)
+        boolean_from_response :delete, "orgs/#{org}/members/#{user}", options
       end
       alias :remove_org_member :remove_organization_member
 
@@ -418,12 +411,11 @@ module Octokit
       # @param org [String] Organization GitHub username.
       # @param user [String] GitHub username of user to publicize.
       # @return [Boolean] True if publicization successful, false otherwise.
-      # @see Octokit::Client
       # @see http://developer.github.com/v3/orgs/members/#publicize-a-users-membership
       # @example
       #   @client.publicize_membership('github', 'pengwynn')
       def publicize_membership(org, user, options={})
-        boolean_from_response(:put, "orgs/#{org}/public_members/#{user}", options)
+        boolean_from_response :put, "orgs/#{org}/public_members/#{user}", options
       end
 
       # Conceal a user's membership of an organization.
@@ -433,14 +425,13 @@ module Octokit
       # @param org [String] Organization GitHub username.
       # @param user [String] GitHub username of user to unpublicize.
       # @return [Boolean] True of unpublicization successful, false otherwise.
-      # @see Octokit::Client
       # @see http://developer.github.com/v3/orgs/members/#conceal-a-users-membership
       # @example
       #   @client.unpublicize_membership('github', 'pengwynn')
       # @example
       #   @client.conceal_membership('github', 'pengwynn')
       def unpublicize_membership(org, user, options={})
-        boolean_from_response(:delete, "orgs/#{org}/public_members/#{user}", options)
+        boolean_from_response :delete, "orgs/#{org}/public_members/#{user}", options
       end
       alias :conceal_membership :unpublicize_membership
 

data/lib/octokit/client/pub_sub_hubbub.rb

@@ -1,11 +1,15 @@
 module Octokit
   class Client
+
+    # Methods for the PubSubHubbub API
+    #
+    # @see http://developer.github.com/v3/repos/hooks/#pubsubhubbub
     module PubSubHubbub
       # Subscribe to a pubsub topic
       #
       # @param topic [String] A recoginized and supported pubsub topic
       # @param callback [String] A callback url to be posted to when the topic event is fired
-      # @return [boolean] true if the subscribe was successful, otherwise an error is raised
+      # @return [Boolean] true if the subscribe was successful, otherwise an error is raised
       # @example Subscribe to push events from one of your repositories, having an email sent when fired
       #   client = Octokit::Client.new(:oauth_token = "token")
       #   client.subscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com")
@@ -13,17 +17,18 @@ module Octokit
         options = {
           :"hub.mode" => "subscribe",
           :"hub.topic" => topic,
-          :"hub.callback" => callback,
-          :force_urlencoded => true
+          :"hub.callback" => callback
         }
-        boolean_from_response(:post, "hub", options)
+        response = pub_sub_hubbub_request(options)
+
+        response.status == 204
       end
 
       # Unsubscribe from a pubsub topic
       #
       # @param topic [String] A recoginized pubsub topic
       # @param callback [String] A callback url to be unsubscribed from
-      # @return [boolean] true if the unsubscribe was successful, otherwise an error is raised
+      # @return [Boolean] true if the unsubscribe was successful, otherwise an error is raised
       # @example Unsubscribe to push events from one of your repositories, no longer having an email sent when fired
       #   client = Octokit::Client.new(:oauth_token = "token")
       #   client.unsubscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com")
@@ -31,10 +36,65 @@ module Octokit
         options = {
           :"hub.mode" => "unsubscribe",
           :"hub.topic" => topic,
-          :"hub.callback" => callback,
-          :force_urlencoded => true
+          :"hub.callback" => callback
         }
-        boolean_from_response(:post, "hub", options)
+        response = pub_sub_hubbub_request(options)
+
+        response.status == 204
+      end
+
+      # Subscribe to a repository through pubsub
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param service_name [String] service name owner
+      # @param service_arguments [Hash] params that will be passed by subscribed hook.
+      #    List of services is available @ https://github.com/github/github-services/tree/master/docs.
+      #    Please refer Data node for complete list of arguments.
+      # @example Subscribe to push events to one of your repositories to Travis-CI
+      #    client = Octokit::Client.new(:oauth_token = "token")
+      #    client.subscribe_service_hook('joshk/device_imapable', 'Travis', { :token => "test", :domain => "domain", :user => "user" })
+      def subscribe_service_hook(repo, service_name, service_arguments = {})
+        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)
+      end
+
+      # Unsubscribe repository through pubsub
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param service_name [String] service name owner
+      #    List of services is available @ https://github.com/github/github-services/tree/master/docs.
+      # @example Subscribe to push events to one of your repositories to Travis-CI
+      #    client = Octokit::Client.new(:oauth_token = "token")
+      #    client.unsubscribe_service_hook('joshk/device_imapable', 'Travis')
+      def unsubscribe_service_hook(repo, service_name)
+        topic = "#{Octokit.web_endpoint}#{Repository.new(repo)}/events/push"
+        callback = "github://#{service_name}"
+        unsubscribe(topic, callback)
+      end
+
+      private
+
+      def pub_sub_hubbub_request(options = {})
+        # This method is janky, bypass normal stack so we don'tl 
+        # serialize request as JSON
+        conn = Faraday.new(:url => @api_endpoint) do |http|
+          http.headers[:user_agent] = user_agent
+          if basic_authenticated?
+            http.basic_auth(@login, @password)
+          elsif token_authenticated?
+            http.authorization 'token', @access_token
+          end
+          http.request  :url_encoded
+          http.use Octokit::Response::RaiseError
+          http.adapter  Faraday.default_adapter
+        end
+
+        response = conn.post do |req|
+          req.url "hub"
+          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+          req.body = options
+        end
       end
     end
   end