octokit 1.18.0 → 1.19.0

data/lib/octokit/client/markdown.rb

@@ -14,7 +14,8 @@ module Octokit
       def markdown(text, options={})
         options[:text] = text
         options[:repo] = Repository.new(options[:repo]) if options[:repo]
-        post("markdown", options, 3, true, true).body
+        options[:accept] = 'application/vnd.github.raw'
+        request(:post, "markdown", options).body
       end
 
     end

data/lib/octokit/client/milestones.rb

@@ -15,7 +15,7 @@ module Octokit
       # @example List milestones for a repository
       #   Octokit.list_milestones("pengwynn/octokit")
       def list_milestones(repository, options={})
-        get("repos/#{Repository.new(repository)}/milestones", options, 3)
+        get("repos/#{Repository.new(repository)}/milestones", options)
       end
       alias :milestones :list_milestones
 
@@ -32,7 +32,7 @@ module Octokit
       # @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)
+        get("repos/#{Repository.new(repository)}/milestones/#{number}", options)
       end
 
       # Create a milestone for a repository
@@ -48,7 +48,7 @@ module Octokit
       # @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)
+        post("repos/#{Repository.new(repository)}/milestones", options.merge({:title => title}))
       end
 
       # Update a milestone for a repository
@@ -65,7 +65,7 @@ module Octokit
       # @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)
+        post("repos/#{Repository.new(repository)}/milestones/#{number}", options)
       end
       alias :edit_milestone :update_milestone
 
@@ -74,12 +74,12 @@ module Octokit
       # @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
+      # @return [Boolean] Success
       # @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)
+        request(:delete, "repos/#{Repository.new(repository)}/milestones/#{number}", options).status == 204
       end
 
     end

data/lib/octokit/client/notifications.rb

@@ -0,0 +1,222 @@
+module Octokit
+  class Client
+    module Notifications
+
+      # List your notifications
+      #
+      # @param options [Hash] Optional parameters
+      #
+      # @option options [Boolean] :all 'true' to show notifications marked as
+      #   read.
+      #
+      # @option options [Boolean] :participating 'true' to show only
+      #   notifications in which the user is directly participating or
+      #   mentioned.
+      #
+      # @option options [String] :since Time filters out any notifications
+      #   updated before the given time. The time should be passed in as UTC in
+      #   the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Ex. '2012-10-09T23:39:01Z'
+      #
+      # @return [Array<Hashie::Mash>] Array of notifications.
+      #
+      # @see http://developer.github.com/v3/activity/notifications/#list-your-notifications
+      #
+      # @example Get users notifications
+      #   @client.notifications
+      #
+      # @example Get all notifications since a certain time.
+      #   @client.notifications({all: true, since: '2012-10-09T23:39:01Z'})
+      def notifications(options={})
+        get("notifications", options)
+      end
+
+      # List your notifications in a repository
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param options [Hash] Optional parameters
+      #
+      # @option options [Boolean] :all 'true' to show notifications marked as
+      #   read.
+      #
+      # @option options [Boolean] :participating 'true' to show only
+      #   notifications in which the user is directly participating or
+      #   mentioned.
+      #
+      # @option options [String] :since Time filters out any notifications
+      #   updated before the given time. The time should be passed in as UTC in
+      #   the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Ex. '2012-10-09T23:39:01Z'
+      #
+      # @return [Array<Hashie::Mash>] Array of notifications.
+      #
+      # @see http://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository
+      #
+      # @example Get your notifications for pengwynn/octokit
+      #   @client.repository_notifications('pengwynn/octokit')
+      #
+      # @example Get your notifications for pengwynn/octokit since a time.
+      #   @client.repository_notifications({since: '2012-10-09T23:39:01Z'})
+      def repository_notifications(repo, options={})
+        get("repos/#{Repository.new repo}/notifications", options)
+      end
+      alias :repo_notifications :repository_notifications
+
+      # Mark notifications as read
+      #
+      # @param options [Hash] Optional parameters
+      #
+      # @option options [Boolean] :unread Changes the unread status of the
+      #   threads.
+      #
+      # @option options [Boolean] :read Inverse of 'unread'.
+      #
+      # @option options [String] :last_read_at ('Now') Describes the last point
+      #   that notifications were checked. Anything updated since this time
+      #   will not be updated. The time should be passed in as UTC in the
+      #   ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Ex. '2012-10-09T23:39:01Z'
+      #
+      # @return [Boolean] True if marked as read, false otherwise
+      #
+      # @see http://developer.github.com/v3/activity/notifications/#mark-as-read
+      #
+      # @example
+      #   @client.mark_notifications_as_read
+      def mark_notifications_as_read(options={})
+        begin
+          request(:put, "notifications", options).status == 205
+        rescue
+          false
+        end
+      end
+
+      # Mark notifications from a specific repository as read
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param options [Hash] Optional parameters
+      #
+      # @option options [Boolean] :unread Changes the unread status of the
+      #   threads.
+      #
+      # @option options [Boolean] :read Inverse of 'unread'.
+      #
+      # @option options [String] :last_read_at ('Now') Describes the last point
+      #   that notifications were checked. Anything updated since this time
+      #   will not be updated. The time should be passed in as UTC in the
+      #   ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Ex. '2012-10-09T23:39:01Z'
+      #
+      # @return [Boolean] True if marked as read, false otherwise
+      #
+      # @see http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository
+      #
+      # @example
+      #   @client.mark_notifications_as_read("pengwynn/octokit")
+      def mark_repository_notifications_as_read(repo, options={})
+        begin
+          request(:put, "repos/#{Repository.new repo}/notifications", options).status == 205
+        rescue
+          false
+        end
+      end
+      alias :mark_repo_notifications_as_read :mark_repository_notifications_as_read
+
+      # List notifications for a specific thread
+      #
+      # @param thread_id [Integer] Id of the thread.
+      #
+      # @return [Array<Hashie::Mashie>] Array of notifications.
+      #
+      # @see http://developer.github.com/v3/activity/notifications/#view-a-single-thread
+      #
+      # @example
+      #   @client.notification_thread(1000)
+      def thread_notifications(thread_id, options={})
+        get("notifications/threads/#{thread_id}", options)
+      end
+
+      # Mark thread as read
+      #
+      # @param thread_id [Integer] Id of the thread to update.
+      # @param options [Hash] Optional parameters.
+      #
+      # @option options [Boolean] :unread Changes the unread status of the
+      #   threads.
+      #
+      # @option options [Boolean] :read Inverse of 'unread'.
+      #
+      # @return [Boolean] True if updated, false otherwise.
+      #
+      # @see http://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read
+      #
+      # @example
+      #   @client.mark_thread_as_ready(1, :read => false)
+      def mark_thread_as_read(thread_id, options={})
+        begin
+          request(:patch, "notifications/threads/#{thread_id}", options).status == 205
+        rescue
+          false
+        end
+      end
+
+      # Get thread subscription
+      #
+      # @param thread_id [Integer] Id of the thread.
+      #
+      # @return [Hashie::Mash] Subscription.
+      #
+      # @see http://developer.github.com/v3/activity/notifications/#get-a-thread-subscription
+      #
+      # @example
+      #   @client.thread_subscription(1)
+      def thread_subscription(thread_id, options={})
+        get("notifications/threads/#{thread_id}/subscription", options)
+      end
+
+      # Update 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).
+      #
+      # @param thread_id [Integer] Id of the thread.
+      # @param options
+      #
+      # @option options [Boolean] :subscribed Determines if notifications
+      #   should be received from this repository.
+      #
+      # @option options [Boolean] :ignored Deterimines if all notifications
+      #   should be blocked from this repository.
+      #
+      # @return [Hashie::Mash] Updated subscription.
+      #
+      # @see http://developer.github.com/v3/activity/notifications/#set-a-thread-subscription
+      #
+      # @example Subscribe to notifications
+      #   @client.update_thread_subscription(1, :subscribed => true)
+      #
+      # @example Ignore notifications from a repo
+      #   @client.update_thread_subscription(1, :ignored => true)
+      def update_thread_subscription(thread_id, options={})
+        put("notifications/threads/#{thread_id}/subscription", options)
+      end
+
+      # Delete a thread subscription
+      #
+      # @param thread_id [Integer] Id of the thread.
+      #
+      # @return [Boolean] True if delete successful, false otherwise.
+      #
+      # @see http://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription
+      #
+      # @example
+      #   @client.delete_thread_subscription(1)
+      def delete_thread_subscription(thread_id, options={})
+        begin
+          request(:delete, "notifications/threads/#{thread_id}", options).status == 204
+        rescue
+          false
+        end
+      end
+
+    end
+  end
+end

data/lib/octokit/client/objects.rb

@@ -33,7 +33,7 @@ module Octokit
       #   tree.tree.first.path # => "file.rb"
       def create_tree(repo, tree, options={})
         parameters = { :tree => tree }
-        post("repos/#{Repository.new(repo)}/git/trees", options.merge(parameters), 3)
+        post("repos/#{Repository.new(repo)}/git/trees", options.merge(parameters))
       end
 
       # Get a single blob, fetching its content and encoding
@@ -73,7 +73,7 @@ module Octokit
           :content => content,
           :encoding => encoding
         }
-        post("repos/#{Repository.new(repo)}/git/blobs", options.merge(parameters), 3).sha
+        post("repos/#{Repository.new(repo)}/git/blobs", options.merge(parameters)).sha
       end
 
       # Get a tag
@@ -85,7 +85,7 @@ module Octokit
       # @example Fetch a tag
       #   Octokit.tag('pengwynn/octokit', '23aad20633f4d2981b1c7209a800db3014774e96')
       def tag(repo, tag_sha, options={})
-        get("repos/#{Repository.new repo}/git/tags/#{tag_sha}", options, 3)
+        get("repos/#{Repository.new repo}/git/tags/#{tag_sha}", options)
       end
 
       # Create a tag
@@ -127,7 +127,7 @@ module Octokit
             :date => tagger_date
           }
         )
-        post("repos/#{Repository.new repo}/git/tags", options, 3)
+        post("repos/#{Repository.new repo}/git/tags", options)
       end
     end
   end

data/lib/octokit/client/organizations.rb

@@ -11,7 +11,7 @@ module Octokit
       # @example
       #   Octokit.org('github')
       def organization(org, options={})
-        get("orgs/#{org}", options, 3)
+        get("orgs/#{org}", options)
       end
       alias :org :organization
 
@@ -40,7 +40,7 @@ module Octokit
       # @example
       #   @client.update_org('github', {:company => 'Unicorns, Inc.'})
       def update_organization(org, values, options={})
-        patch("orgs/#{org}", options.merge({:organization => values}), 3)
+        patch("orgs/#{org}", options.merge({:organization => values}))
       end
       alias :update_org :update_organization
 
@@ -73,9 +73,9 @@ module Octokit
       #   @client.organizations
       def organizations(user=nil, options={})
         if user
-          get("users/#{user}/orgs", options, 3)
+          get("users/#{user}/orgs", options)
         else
-          get("user/orgs", options, 3)
+          get("user/orgs", options)
         end
       end
       alias :list_organizations :organizations
@@ -103,7 +103,7 @@ module Octokit
       # @example
       #   @client.org_repos('github', {:type => 'private'})
       def organization_repositories(org, options={})
-        get("orgs/#{org}/repos", options, 3)
+        get("orgs/#{org}/repos", options)
       end
       alias :org_repositories :organization_repositories
       alias :org_repos :organization_repositories
@@ -125,10 +125,55 @@ module Octokit
       # @example
       #   Octokit.org_members('github')
       def organization_members(org, options={})
-        get("orgs/#{org}/members", options, 3)
+        get("orgs/#{org}/members", options)
       end
       alias :org_members :organization_members
 
+      # Check if a user is a member of an organization.
+      #
+      # Use this to check if another user is a member of an organization that
+      # you are a member. If you are not in the organization you are checking,
+      # use .organization_public_member? instead.
+      #
+      # @param org [String] Organization GitHub username.
+      # @param user [String] GitHub username of the user to check.
+      #
+      # @return [Boolean] Is a member?
+      #
+      # @see http://developer.github.com/v3/orgs/members/#check-membership
+      #
+      # @example Check if a user is in your organization
+      #   @client.organization_member?('your_organization', 'pengwynn')
+      #   => false
+      def organization_member?(org, user, options={})
+        request(:get, "orgs/#{org}/members/#{user}", options).status == 204
+      rescue Octokit::NotFound
+        false
+      end
+      alias :org_member? :organization_member?
+
+      # Check if a user is a public member of an organization.
+      #
+      # If you are checking for membership of a user of an organization that
+      # you are in, use .organization_member? instead.
+      #
+      # @param org [String] Organization GitHub username.
+      # @param user [String] GitHub username of the user to check.
+      #
+      # @return [Boolean] Is a public member?
+      #
+      # @see http://developer.github.com/v3/orgs/members/#check-public-membership
+      #
+      # @example Check if a user is a hubbernaut
+      #   @client.organization_public_member?('github', 'pengwynn')
+      #   => true
+      def organization_public_member?(org, user, options={})
+        request(:get, "orgs/#{org}/public_members/#{user}", options).status == 204
+      rescue Octokit::NotFound
+        false
+      end
+      alias :org_public_member? :organization_public_member?
+
       # List teams
       #
       # Requires authenticated organization member.
@@ -142,7 +187,7 @@ module Octokit
       # @example
       #   @client.org_teams('github')
       def organization_teams(org, options={})
-        get("orgs/#{org}/teams", options, 3)
+        get("orgs/#{org}/teams", options)
       end
       alias :org_teams :organization_teams
 
@@ -169,7 +214,7 @@ module Octokit
       #     :permission => 'push'
       #   })
       def create_team(org, options={})
-        post("orgs/#{org}/teams", options, 3)
+        post("orgs/#{org}/teams", options)
       end
 
       # Get team
@@ -183,7 +228,7 @@ module Octokit
       # @example
       #   @client.team(100000)
       def team(team_id, options={})
-        get("teams/#{team_id}", options, 3)
+        get("teams/#{team_id}", options)
       end
 
       # Update team
@@ -206,7 +251,7 @@ module Octokit
       #     :permission => 'push'
       #   })
       def update_team(team_id, options={})
-        patch("teams/#{team_id}", options, 3)
+        patch("teams/#{team_id}", options)
       end
 
       # Delete team
@@ -220,7 +265,7 @@ module Octokit
       # @example
       #   @client.delete_team(100000)
       def delete_team(team_id, options={})
-        delete("teams/#{team_id}", options, 3, true, true)
+        request(:delete, "teams/#{team_id}", options).status == 204
       end
 
       # List team members
@@ -234,7 +279,7 @@ module Octokit
       # @example
       #   @client.team_members(100000)
       def team_members(team_id, options={})
-        get("teams/#{team_id}/members", options, 3)
+        get("teams/#{team_id}/members", options)
       end
 
       # Add team member
@@ -253,7 +298,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.
-        put("teams/#{team_id}/members/#{user}", options.merge({:name => user}), 3, true, raw=true).status == 204
+        request(:put, "teams/#{team_id}/members/#{user}", options.merge({:name => user})).status == 204
       end
 
       # Remove team member
@@ -269,7 +314,7 @@ module Octokit
       # @example
       #   @client.remove_team_member(100000, 'pengwynn')
       def remove_team_member(team_id, user, options={})
-        delete("teams/#{team_id}/members/#{user}", options, 3, true, raw=true).status == 204
+        request(:delete, "teams/#{team_id}/members/#{user}", options).status == 204
       end
 
       # List team repositories
@@ -285,7 +330,7 @@ module Octokit
       # @example
       #   @client.team_repos(100000)
       def team_repositories(team_id, options={})
-        get("teams/#{team_id}/repos", options, 3)
+        get("teams/#{team_id}/repos", options)
       end
       alias :team_repos :team_repositories
 
@@ -306,7 +351,7 @@ module Octokit
       # @example
       #   @client.add_team_repo(100000, 'github/developer.github.com')
       def add_team_repository(team_id, repo, options={})
-        put("teams/#{team_id}/repos/#{Repository.new(repo)}", options.merge(:name => Repository.new(repo)), 3, true, raw=true).status == 204
+        request(:put, "teams/#{team_id}/repos/#{Repository.new(repo)}", options.merge(:name => Repository.new(repo))).status == 204
       end
       alias :add_team_repo :add_team_repository
 
@@ -327,7 +372,7 @@ module Octokit
       # @example
       #   @client.remove_team_repo(100000, 'github/developer.github.com')
       def remove_team_repository(team_id, repo, options={})
-        delete("teams/#{team_id}/repos/#{Repository.new(repo)}", options, 3, true, raw=true).status == 204
+        request(:delete, "teams/#{team_id}/repos/#{Repository.new(repo)}").status == 204
       end
       alias :remove_team_repo :remove_team_repository
 
@@ -347,7 +392,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
-        delete("orgs/#{org}/members/#{user}", options, 3, true, raw=true).status == 204
+        request(:delete, "orgs/#{org}/members/#{user}", options).status == 204
       end
       alias :remove_org_member :remove_organization_member
 
@@ -363,7 +408,7 @@ module Octokit
       # @example
       #   @client.publicize_membership('github', 'pengwynn')
       def publicize_membership(org, user, options={})
-        put("orgs/#{org}/public_members/#{user}", options, 3, true, raw=true).status == 204
+        request(:put, "orgs/#{org}/public_members/#{user}", options).status == 204
       end
 
       # Conceal a user's membership of an organization.
@@ -380,7 +425,7 @@ module Octokit
       # @example
       #   @client.conceal_membership('github', 'pengwynn')
       def unpublicize_membership(org, user, options={})
-        delete("orgs/#{org}/public_members/#{user}", options, 3, true, raw=true).status == 204
+        request(:delete, "orgs/#{org}/public_members/#{user}", options).status == 204
       end
       alias :conceal_membership :unpublicize_membership