octokit 0.6.3 → 0.6.4

data/lib/octokit/client/milestones.rb

@@ -0,0 +1,87 @@
+module Octokit
+  class Client
+    module Milestones
+
+      # List milestones for a repository
+      #
+      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :milestone Milestone number.
+      # @option options [String] :state (open) State: <tt>open</tt> or <tt>closed</tt>.
+      # @option options [String] :sort (created) Sort: <tt>created</tt>, <tt>updated</tt>, or <tt>comments</tt>.
+      # @option options [String] :direction (desc) Direction: <tt>asc</tt> or <tt>desc</tt>.
+      # @return [Array] A list of milestones for a repository.
+      # @see http://developer.github.com/v3/issues/milestones/#List-Milestones-for-an-Issue
+      # @example List milestones for a repository
+      #   Octokit.list_milestones("pengwynn/octokit")
+      def list_milestones(repository, options={})
+        get("/repos/#{Repository.new(repository)}/milestones", options, 3)
+      end
+      alias :milestones :list_milestones
+
+      # Get a single milestone for a repository
+      #
+      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :milestone Milestone number.
+      # @option options [String] :state (open) State: <tt>open</tt> or <tt>closed</tt>.
+      # @option options [String] :sort (created) Sort: <tt>created</tt>, <tt>updated</tt>, or <tt>comments</tt>.
+      # @option options [String] :direction (desc) Direction: <tt>asc</tt> or <tt>desc</tt>.
+      # @return [Milestone] A single milestone from a repository.
+      # @see http://developer.github.com/v3/issues/milestones/#get-a-single-milestone
+      # @example Get a single milestone for a repository
+      #   Octokit.milestone("pengwynn/octokit", 1)
+      def milestone(repository, number, options={})
+        get("/repos/#{Repository.new(repository)}/milestones/#{number}", options, 3)
+      end
+
+      # Create a milestone for a repository
+      #
+      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param title [String] A unique title.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :state (open) State: <tt>open</tt> or <tt>closed</tt>.
+      # @option options [String] :description A meaningful description
+      # @option options [Time] :due_on Set if the milestone has a due date
+      # @return [Milestone] A single milestone object
+      # @see http://developer.github.com/v3/issues/milestones/#create-a-milestone
+      # @example Create a milestone for a repository
+      #   Octokit.create_milestone("pengwynn/octokit", "0.7.0", {:description => 'Add support for v3 of Github API'})
+      def create_milestone(repository, title, options={})
+        post("/repos/#{Repository.new(repository)}/milestones", options.merge({:title => title}), 3)
+      end
+
+      # Update a milestone for a repository
+      #
+      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param number [String, Integer] Number ID of a milestone
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :title A unique title.
+      # @option options [String] :state (open) State: <tt>open</tt> or <tt>closed</tt>.
+      # @option options [String] :description A meaningful description
+      # @option options [Time] :due_on Set if the milestone has a due date
+      # @return [Milestone] A single milestone object
+      # @see http://developer.github.com/v3/issues/milestones/#update-a-milestone
+      # @example Update a milestone for a repository
+      #   Octokit.update_milestone("pengwynn/octokit", 1, {:description => 'Add support for v3 of Github API'})
+      def update_milestone(repository, number, options={})
+        post("/repos/#{Repository.new(repository)}/milestones/#{number}", options, 3)
+      end
+      alias :edit_milestone :update_milestone
+
+      # Delete a single milestone for a repository
+      #
+      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :milestone Milestone number.
+      # @return [Response] Response with status 204, no content
+      # @see http://developer.github.com/v3/issues/milestones/#delete-a-milestone
+      # @example Delete a single milestone from a repository
+      #   Octokit.delete_milestone("pengwynn/octokit", 1)
+      def delete_milestone(repository, number, options={})
+        delete("/repos/#{Repository.new(repository)}/milestones/#{number}", options, 3, true, true)
+      end
+
+    end
+  end
+end

data/lib/octokit/client/network.rb

@@ -1,15 +1,13 @@
 module Octokit
   class Client
     module Network
-
       def network_meta(repo, options={})
-        get("#{Repository.new(repo)}/network_meta", options, 2, false)
+        get("/#{Repository.new(repo)}/network_meta", options, 2, false)
       end
 
       def network_data(repo, options={})
-        get("#{Repository.new(repo)}/network_data_chunk", options, 2, false)['commits']
+        get("/#{Repository.new(repo)}/network_data_chunk", options, 2, false)['commits']
       end
-
     end
   end
 end

data/lib/octokit/client/objects.rb

@@ -1,33 +1,31 @@
 module Octokit
   class Client
     module Objects
-
       def tree(repo, tree_sha, options={})
-        get("api/v2/json/tree/show/#{Repository.new(repo)}/#{tree_sha}", options)['tree']
+        get("/api/v2/json/tree/show/#{Repository.new(repo)}/#{tree_sha}", options)['tree']
       end
 
       def blob(repo, tree_sha, path, options={})
-        get("api/v2/json/blob/show/#{Repository.new(repo)}/#{tree_sha}/#{path}", options)['blob']
+        get("/api/v2/json/blob/show/#{Repository.new(repo)}/#{tree_sha}/#{path}", options)['blob']
       end
 
       def blobs(repo, tree_sha, options={})
-        get("api/v2/json/blob/all/#{Repository.new(repo)}/#{tree_sha}", options)['blobs']
+        get("/api/v2/json/blob/all/#{Repository.new(repo)}/#{tree_sha}", options)['blobs']
       end
 
       def blob_metadata(repo, tree_sha, options={})
-        get("api/v2/json/blob/full/#{Repository.new(repo)}/#{tree_sha}", options)['blobs']
+        get("/api/v2/json/blob/full/#{Repository.new(repo)}/#{tree_sha}", options)['blobs']
       end
       alias :blob_meta :blob_metadata
 
       def tree_metadata(repo, tree_sha, options={})
-        get("api/v2/json/tree/full/#{Repository.new(repo)}/#{tree_sha}", options)['tree']
+        get("/api/v2/json/tree/full/#{Repository.new(repo)}/#{tree_sha}", options)['tree']
       end
       alias :tree_meta :tree_metadata
 
       def raw(repo, sha, options={})
-        get("api/v2/json/blob/show/#{Repository.new(repo)}/#{sha}", options, 2, true, true).body
+        get("/api/v2/json/blob/show/#{Repository.new(repo)}/#{sha}", options, 2, true, true).body
       end
-
     end
   end
 end

data/lib/octokit/client/organizations.rb

@@ -1,22 +1,21 @@
 module Octokit
   class Client
     module Organizations
-
       def organization(org, options={})
-        get("api/v2/json/organizations/#{org}", options)['organization']
+        get("/api/v2/json/organizations/#{org}", options)['organization']
       end
       alias :org :organization
 
       def update_organization(org, values, options={})
-        put("api/v2/json/organizations/#{org}", options.merge({:organization => values}))['organization']
+        put("/api/v2/json/organizations/#{org}", options.merge({:organization => values}))['organization']
       end
       alias :update_org :update_organization
 
       def organizations(user=nil, options={})
         if user
-          get("api/v2/json/user/show/#{user}/organizations", options)
+          get("/api/v2/json/user/show/#{user}/organizations", options)
         else
-          get("api/v2/json/organizations", options)
+          get("/api/v2/json/organizations", options)
         end['organizations']
       end
       alias :list_organizations :organizations
@@ -25,64 +24,64 @@ module Octokit
 
       def organization_repositories(org=nil, options={})
         if org
-          get("api/v2/json/organizations/#{org}/public_repositories", options)
+          get("/api/v2/json/organizations/#{org}/public_repositories", options)
         else
-          get("api/v2/json/organizations/repositories", options)
+          get("/api/v2/json/organizations/repositories", options)
         end['repositories']
       end
       alias :org_repositories :organization_repositories
       alias :org_repos :organization_repositories
 
       def organization_members(org, options={})
-        get("api/v2/json/organizations/#{org}/public_members", options)['users']
+        get("/api/v2/json/organizations/#{org}/public_members", options)['users']
       end
       alias :org_members :organization_members
 
       def organization_teams(org, options={})
-        get("api/v2/json/organizations/#{org}/teams", options)['teams']
+        get("/api/v2/json/organizations/#{org}/teams", options)['teams']
       end
       alias :org_teams :organization_teams
 
       def create_team(org, values, options={})
-        post("api/v2/json/organizations/#{org}/teams", options.merge({:team => values}))['team']
+        post("/api/v2/json/organizations/#{org}/teams", options.merge({:team => values}))['team']
       end
 
       def team(team_id, options={})
-        get("api/v2/json/teams/#{team_id}", options)['team']
+        get("/api/v2/json/teams/#{team_id}", options)['team']
       end
 
       def update_team(team_id, values, options={})
-        put("api/v2/json/teams/#{team_id}", options.merge({:team => values}))['team']
+        put("/api/v2/json/teams/#{team_id}", options.merge({:team => values}))['team']
       end
 
       def delete_team(team_id, options={})
-        delete("api/v2/json/teams/#{team_id}", options)['team']
+        delete("/api/v2/json/teams/#{team_id}", options)['team']
       end
 
       def team_members(team_id, options={})
-        get("api/v2/json/teams/#{team_id}/members", options)['users']
+        get("/api/v2/json/teams/#{team_id}/members", options)['users']
       end
 
       def add_team_member(team_id, user, options={})
-        post("api/v2/json/teams/#{team_id}/members", options.merge({:name => user}))['user']
+        post("/api/v2/json/teams/#{team_id}/members", options.merge({:name => user}))['user']
       end
 
       def remove_team_member(team_id, user, options={})
-        delete("api/v2/json/teams/#{team_id}/members", options.merge({:name => user}))['user']
+        delete("/api/v2/json/teams/#{team_id}/members", options.merge({:name => user}))['user']
       end
 
       def team_repositories(team_id, options={})
-        get("api/v2/json/teams/#{team_id}/repositories", options)['repositories']
+        get("/api/v2/json/teams/#{team_id}/repositories", options)['repositories']
       end
       alias :team_repos :team_repositories
 
       def add_team_repository(team_id, repo, options={})
-        post("api/v2/json/teams/#{team_id}/repositories", options.merge(:name => Repository.new(repo)))['repositories']
+        post("/api/v2/json/teams/#{team_id}/repositories", options.merge(:name => Repository.new(repo)))['repositories']
       end
       alias :add_team_repo :add_team_repository
 
       def remove_team_repository(team_id, repo, options={})
-        delete("api/v2/json/teams/#{team_id}/repositories", options.merge(:name => Repository.new(repo)))['repositories']
+        delete("/api/v2/json/teams/#{team_id}/repositories", options.merge(:name => Repository.new(repo)))['repositories']
       end
       alias :remove_team_repo :remove_team_repository
     end

data/lib/octokit/client/pub_sub_hubbub.rb

@@ -0,0 +1,41 @@
+module Octokit
+  class Client
+    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
+      # @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")
+      def subscribe(topic, callback)
+        options = {
+          :"hub.mode" => "subscribe",
+          :"hub.topic" => topic,
+          :"hub.callback" => callback,
+        }
+        post("/hub", options, 3, true, true, true)
+        true
+      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
+      # @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")
+      def unsubscribe(topic, callback)
+        options = {
+          :"hub.mode" => "unsubscribe",
+          :"hub.topic" => topic,
+          :"hub.callback" => callback,
+        }
+        post("/hub", options, 3, true, true, true)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Octokit
+  class Client
+    module PubSubHubbub
+      module ServiceHooks
+        # Subscribe to a repository through pubsub
+        #
+        # @param owner [String] owner of mentioned repository
+        # @param repository [String] repository name
+        # @param service_name [String] service name owner
+        # @param service_arguments [Hash] params that will be passed by subscibed 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 = "https://github.com/#{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
+        #
+        # @param owner [String] owner of mentioned repository
+        # @param repository [String] repository name
+        # @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 = "https://github.com/#{Repository.new(repo)}/events/push"
+          callback = "github://#{service_name}"
+          unsubscribe(topic, callback)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/octokit/client/pulls.rb

@@ -8,16 +8,25 @@ module Octokit
           :title => title,
           :body  => body,
         }
-        post("api/v2/json/pulls/#{Repository.new(repo)}", options.merge({:pull => pull}))['pulls']
+        post("/api/v2/json/pulls/#{Repository.new(repo)}", options.merge({:pull => pull}))['pulls']
+      end
+
+      def create_pull_request_for_issue(repo, base, head, issue, options={})
+        pull = {
+          :base  => base,
+          :head  => head,
+          :issue => issue
+        }
+        post("/api/v2/json/pulls/#{Repository.new(repo)}", options.merge({:pull => pull}))['pulls']
       end
 
       def pull_requests(repo, state='open', options={})
-        get("api/v2/json/pulls/#{Repository.new(repo)}/#{state}", options)['pulls']
+        get("/api/v2/json/pulls/#{Repository.new(repo)}/#{state}", options)['pulls']
       end
       alias :pulls :pull_requests
 
       def pull_request(repo, number, options={})
-        get("api/v2/json/pulls/#{Repository.new(repo)}/#{number}", options)['pull']
+        get("/api/v2/json/pulls/#{Repository.new(repo)}/#{number}", options)['pull']
       end
       alias :pull :pull_request
     end

data/lib/octokit/client/repositories.rb

@@ -1,49 +1,48 @@
 module Octokit
   class Client
     module Repositories
-
       def search_repositories(q, options={})
-        get("api/v2/json/repos/search/#{q}", options)['repositories']
+        get("/api/v2/json/repos/search/#{q}", options)['repositories']
       end
       alias :search_repos :search_repositories
 
       def repository(repo, options={})
-        get("api/v2/json/repos/show/#{Repository.new(repo)}", options)['repository']
+        get("/api/v2/json/repos/show/#{Repository.new(repo)}", options)['repository']
       end
       alias :repo :repository
 
       def update_repository(repo, values, options={})
-        post("api/v2/json/repos/show/#{Repository.new(repo)}", options.merge({:values => values}))['repository']
+        post("/api/v2/json/repos/show/#{Repository.new(repo)}", options.merge({:values => values}))['repository']
       end
       alias :update_repo :update_repository
 
       def repositories(username=login, options={})
-        get(["api/v2/json/repos/show", username].compact.join('/'), options)['repositories']
+        get(["/api/v2/json/repos/show", username].compact.join('/'), options)['repositories']
       end
       alias :list_repositories :repositories
       alias :list_repos :repositories
       alias :repos :repositories
 
       def watch(repo, options={})
-        post("api/v2/json/repos/watch/#{Repository.new(repo)}", options)['repository']
+        post("/api/v2/json/repos/watch/#{Repository.new(repo)}", options)['repository']
       end
 
       def unwatch(repo, options={})
-        post("api/v2/json/repos/unwatch/#{Repository.new(repo)}", options)['repository']
+        post("/api/v2/json/repos/unwatch/#{Repository.new(repo)}", options)['repository']
       end
 
       def fork(repo, options={})
-        post("api/v2/json/repos/fork/#{Repository.new(repo)}", options)['repository']
+        post("/api/v2/json/repos/fork/#{Repository.new(repo)}", options)['repository']
       end
 
       def create_repository(name, options={})
-        post("api/v2/json/repos/create", options.merge(:name => name))['repository']
+        post("/api/v2/json/repos/create", options.merge(:name => name))['repository']
       end
       alias :create_repo :create_repository
       alias :create :create_repository
 
       def delete_repository(repo, options={})
-        response = post("api/v2/json/repos/delete/#{Repository.new(repo)}", options)
+        response = post("/api/v2/json/repos/delete/#{Repository.new(repo)}", options)
         if response.respond_to?(:delete_token)
           response['delete_token']
         else
@@ -53,86 +52,85 @@ module Octokit
       alias :delete_repo :delete_repository
 
       def delete_repository!(repo, options={})
-        delete_token = post("api/v2/json/repos/delete/#{Repository.new(repo)}", options)
-        post("api/v2/json/repos/delete/#{Repository.new(repo)}", options.merge(:delete_token => delete_token))
+        delete_token = post("/api/v2/json/repos/delete/#{Repository.new(repo)}", options)
+        post("/api/v2/json/repos/delete/#{Repository.new(repo)}", options.merge(:delete_token => delete_token))
       end
       alias :delete_repo! :delete_repository!
 
       def set_private(repo, options={})
-        post("api/v2/json/repos/set/private/#{Repository.new(repo)}", options)['repository']
+        post("/api/v2/json/repos/set/private/#{Repository.new(repo)}", options)['repository']
       end
 
       def set_public(repo, options={})
-        post("api/v2/json/repos/set/public/#{Repository.new(repo)}", options)['repository']
+        post("/api/v2/json/repos/set/public/#{Repository.new(repo)}", options)['repository']
       end
 
       def deploy_keys(repo, options={})
-        get("api/v2/json/repos/keys/#{Repository.new(repo)}", options)['public_keys']
+        get("/api/v2/json/repos/keys/#{Repository.new(repo)}", options)['public_keys']
       end
       alias :list_deploy_keys :deploy_keys
 
       def add_deploy_key(repo, title, key, options={})
-        post("api/v2/json/repos/key/#{Repository.new(repo)}/add", options)['public_keys']
+        post("/api/v2/json/repos/key/#{Repository.new(repo)}/add", options)['public_keys']
       end
 
       def remove_deploy_key(repo, id, options={})
-        post("api/v2/json/repos/key/#{Repository.new(repo)}/remove", options.merge(:id => id))['public_keys']
+        post("/api/v2/json/repos/key/#{Repository.new(repo)}/remove", options.merge(:id => id))['public_keys']
       end
 
       def collaborators(repo, options={})
-        get("api/v2/json/repos/show/#{Repository.new(repo)}/collaborators", options)['collaborators']
+        get("/api/v2/json/repos/show/#{Repository.new(repo)}/collaborators", options)['collaborators']
       end
       alias :collabs :collaborators
 
       def add_collaborator(repo, collaborator, options={})
-        post("api/v2/json/repos/collaborators/#{Repository.new(repo)}/add/#{collaborator}")['collaborators']
+        post("/api/v2/json/repos/collaborators/#{Repository.new(repo)}/add/#{collaborator}")['collaborators']
       end
       alias :add_collab :add_collaborator
 
       def remove_collaborator(repo, collaborator, options={})
-        post("api/v2/json/repos/collaborators/#{Repository.new(repo)}/remove/#{collaborator}")['collaborators']
+        post("/api/v2/json/repos/collaborators/#{Repository.new(repo)}/remove/#{collaborator}")['collaborators']
       end
       alias :remove_collab :remove_collaborator
 
       def pushable(options={})
-        get("api/v2/json/repos/pushable", options)['repositories']
+        get("/api/v2/json/repos/pushable", options)['repositories']
       end
 
       def repository_teams(repo, options={})
-        get("api/v2/json/repos/show/#{Repository.new(repo)}/teams", options)['teams']
+        get("/api/v2/json/repos/show/#{Repository.new(repo)}/teams", options)['teams']
       end
       alias :repo_teams :repository_teams
       alias :teams :repository_teams
 
       def contributors(repo, anon=false, options={})
         if anon
-          get("api/v2/json/repos/show/#{Repository.new(repo)}/contributors/anon", options)
+          get("/api/v2/json/repos/show/#{Repository.new(repo)}/contributors/anon", options)
         else
-          get("api/v2/json/repos/show/#{Repository.new(repo)}/contributors", options)
+          get("/api/v2/json/repos/show/#{Repository.new(repo)}/contributors", options)
         end['contributors']
       end
       alias :contribs :contributors
 
       def watchers(repo, options={})
-        get("api/v2/json/repos/show/#{Repository.new(repo)}/watchers", options)['watchers']
+        get("/api/v2/json/repos/show/#{Repository.new(repo)}/watchers", options)['watchers']
       end
 
       def network(repo, options={})
-        get("api/v2/json/repos/show/#{Repository.new(repo)}/network", options)['network']
+        get("/api/v2/json/repos/show/#{Repository.new(repo)}/network", options)['network']
       end
 
       def languages(repo, options={})
-        get("api/v2/json/repos/show/#{Repository.new(repo)}/languages", options)['languages']
+        get("/api/v2/json/repos/show/#{Repository.new(repo)}/languages", options)['languages']
       end
 
       def tags(repo, options={})
-        get("api/v2/json/repos/show/#{Repository.new(repo)}/tags", options)['tags']
+        get("/api/v2/json/repos/show/#{Repository.new(repo)}/tags", options)['tags']
       end
 
       def branches(repo, options={})
-        get("api/v2/json/repos/show/#{Repository.new(repo)}/branches", options)['branches']
+        get("/api/v2/json/repos/show/#{Repository.new(repo)}/branches", options)['branches']
       end
-
     end
   end
 end