lingfennan-github_api 0.18.2

data/lib/github_api/client/activity/feeds.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Activity::Feeds < API
+    # List all the feeds available to the authenticated user.
+    #
+    # @see https://developer.github.com/v3/activity/feeds/#list-feeds
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.feeds.list
+    #
+    # @api public
+    def list(*args)
+      arguments(args)
+
+      response = get_request("/feeds", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # Get all the items for a named timeline
+    #
+    # @see https://developer.github.com/v3/activity/feeds/#list-feeds
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.feeds.get "timeline"
+    #
+    # @param [String] name
+    #   the name of the timeline resource
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:name])
+
+      name = arguments.name
+      response = list.body._links[name]
+      if response
+        params = arguments.params
+        params['accept'] = response.type
+        get_request(response.href, params)
+      end
+    end
+    alias_method :find, :get
+  end
+end # Github

data/lib/github_api/client/activity/notifications.rb

@@ -0,0 +1,181 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Activity::Notifications < API
+    # List your notifications
+    #
+    # List all notifications for the current user, grouped by repository.
+    #
+    # @see https://developer.github.com/v3/activity/notifications/#list-your-notifications
+    #
+    # @param [Hash] params
+    # @option params [Boolean] :all
+    #   If true, show notifications marked as read.
+    #   Default: false
+    # @option params [Boolean] :participating
+    #   If true, only shows notifications in which the user
+    #   is directly participating or mentioned. Default: false
+    # @option params [String] :since
+    #   Filters out any notifications updated before the given time.
+    #   This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
+    #   Default: Time.now
+    #
+    # @example
+    #   github = Github.new oauth_token: 'token'
+    #   github.activity.notifications.list
+    #
+    # List your notifications in a repository
+    #
+    # @see https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository
+    #
+    # @example
+    #  github = Github.new
+    #  github.activity.notifications.list user: 'user-name', repo: 'repo-name'
+    #
+    # @api public
+    def list(*args)
+      arguments(args)
+      params = arguments.params
+
+      response = if ( (user_name = params.delete('user')) &&
+                      (repo_name = params.delete('repo')) )
+        get_request("/repos/#{user_name}/#{repo_name}/notifications", params)
+      else
+        get_request('/notifications', params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # View a single thread
+    #
+    # @see https://developer.github.com/v3/activity/notifications/#view-a-single-thread
+    #
+    # @example
+    #  github = Github.new oauth_token: 'token'
+    #  github.activity.notifications.get 'thread_id'
+    #  github.activity.notifications.get 'thread_id' { |thread| ... }
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:thread_id])
+
+      response = get_request("/notifications/threads/#{arguments.thread_id}", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :find, :get
+
+    # Mark as read
+    #
+    # Marking a notification as “read” removes it from the default view on GitHub.com.
+    #
+    # @see https://developer.github.com/v3/activity/notifications/#mark-as-read
+    #
+    # @param [Hash] params
+    # @option params [String] :last_read_at
+    #   Describes the last point that notifications were checked.
+    #   Anything updated since this time will not be updated.
+    #   This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
+    #   Default: Time.now
+    #
+    # @example
+    #  github = Github.new oauth_token: 'token'
+    #  github.activity.notifications.mark
+    #
+    # Mark notifications as read in a repository
+    #
+    # @see https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository
+    #
+    # @example
+    #  github.activity.notifications.mark user: 'user-name', repo: 'repo-name'
+    #
+    # Mark a thread as read
+    #
+    # @see https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read
+    #
+    # @example
+    #  github.activity.notifications.mark id: 'thread-id'
+    #
+    # @api public
+    def mark(*args)
+      arguments(args)
+      params = arguments.params
+
+      if ( (user_name = params.delete('user')) &&
+           (repo_name = params.delete('repo')) )
+
+        put_request("/repos/#{user_name}/#{repo_name}/notifications", params)
+      elsif (thread_id = params.delete("id"))
+        patch_request("/notifications/threads/#{thread_id}", params)
+      else
+        put_request('/notifications', params)
+      end
+    end
+
+    # Check to see if the current user is subscribed to a thread.
+    #
+    # @see https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription
+    #
+    # @example
+    #  github = Github.new oauth_token: 'token'
+    #  github.activity.notifications.subscribed? 'thread-id'
+    #
+    # @example
+    #   github.activity.notifications.subscribed? id: 'thread-id'
+    #
+    # @api public
+    def subscribed?(*args)
+      arguments(args, required: [:thread_id])
+
+      get_request("/notifications/threads/#{arguments.thread_id}/subscription", arguments.params)
+    end
+
+    # Create a 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).
+    #
+    # @see https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription
+    #
+    # @param [Hash] params
+    # @option params [Boolean] :subscribed
+    #   Determines if notifications should be received from this thread
+    # @option params [Boolean] :ignored
+    #   Determines if all notifications should be blocked from this thread
+    #
+    # @example
+    #   github = Github.new oauth_token: 'token'
+    #   github.activity.notifications.create 'thread-id',
+    #     subscribed: true
+    #     ignored: false
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:thread_id])
+
+      put_request("/notifications/threads/#{arguments.thread_id}/subscription", arguments.params)
+    end
+
+    # Delete a thread subscription
+    #
+    # @see https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription
+    #
+    # @example
+    #   github = Github.new oauth_token: 'token'
+    #   github.activity.notifications.delete 'thread_id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:thread_id])
+
+      delete_request("/notifications/threads/#{arguments.thread_id}/subscription", arguments.params)
+    end
+    alias_method :remove, :delete
+  end # Client::Activity::Notifications
+end # Github

data/lib/github_api/client/activity/starring.rb

@@ -0,0 +1,130 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  # Repository Starring is a feature that lets users bookmark repositories.
+  # Stars are shown next to repositories to show an approximate level of interest.
+  # Stars have no effect on notifications or the activity feed.
+  class Client::Activity::Starring < API
+    # List stargazers
+    #
+    # @see https://developer.github.com/v3/activity/starring/#list-stargazers
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.starring.list user: 'user-name', repo: 'repo-name'
+    #   github.activity.starring.list user: 'user-name', repo: 'repo-name' { |star| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/stargazers", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # List repos being starred by a user
+    #
+    # @see https://developer.github.com/v3/activity/starring/#list-repositories-being-starred
+    #
+    # @param [Hash] params
+    # @option params [String] :sort
+    #   One of created (when the repository was starred) or
+    #   updated (when it was last pushed to).
+    #   Default: created
+    # @option params [String] :direction
+    #   One of asc (ascending) or desc (descending).
+    #   Default: desc
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.starring.starred user: 'user-name'
+    #
+    # List repos being starred by the authenticated user
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.activity.starring.starred
+    #
+    # @api public
+    def starred(*args)
+      arguments(args)
+      params = arguments.params
+
+      response = if (user_name = params.delete('user'))
+        get_request("/users/#{user_name}/starred", params)
+      else
+        get_request('/user/starred', params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Check if you are starring a repository
+    #
+    # @see https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.starring.starring? 'user-name', 'repo-name'
+    #
+    # @example
+    #   github.activity.starring.starring? user: 'user-name', repo: 'repo-name'
+    #
+    # @return [Boolean]
+    #   Returns true if this repo is starred by you, false otherwise.
+    #
+    # @api public
+    def starring?(*args)
+      arguments(args, required: [:user, :repo])
+
+      get_request("/user/starred/#{arguments.user}/#{arguments.repo}", arguments.params)
+      true
+    rescue Github::Error::NotFound
+      false
+    end
+
+    # Star a repository
+    #
+    # You need to be authenticated to star a repository
+    #
+    # @see https://developer.github.com/v3/activity/starring/#star-a-repository
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.starring.star 'user-name', 'repo-name'
+    #
+    # @example
+    #   github.activity.starring.star user: 'user-name', repo: 'repo-name'
+    #
+    # @api public
+    def star(*args)
+      arguments(args, required: [:user, :repo])
+
+      put_request("/user/starred/#{arguments.user}/#{arguments.repo}", arguments.params)
+    end
+
+    # Unstar a repository
+    #
+    # You need to be authenticated to unstar a repository.
+    #
+    # @see https://developer.github.com/v3/activity/starring/#unstar-a-repository
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.starring.unstar 'user-name', 'repo-name'
+    #
+    # @example
+    #   github.activit.starring.unstar user: 'user-name', repo: 'repo-name'
+    #
+    # @api public
+    def unstar(*args)
+      arguments(args, required: [:user, :repo])
+
+      delete_request("/user/starred/#{arguments.user}/#{arguments.repo}", arguments.params)
+    end
+  end # Client::Activity::Starring
+end # Github

data/lib/github_api/client/activity/watching.rb

@@ -0,0 +1,176 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  # Watching a Repository registers the user to receive notificactions on new
+  # discussions, as well as events in the user's activity feed.
+  class Client::Activity::Watching < API
+    # List repository watchers
+    #
+    # @see https://developer.github.com/v3/activity/watching/#list-watchers
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.watching.list user: 'user-name', repo: 'repo-name'
+    #   github.activity.watching.list user: 'user-naem', repo: 'repo-name' { |watcher| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/subscribers", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # List repos being watched by a user
+    #
+    # @see https://developer.github.com/v3/activity/watching/#list-repositories-being-watched
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.watching.watched user: 'user-name'
+    #
+    # List repos being watched by the authenticated user
+    #
+    # @example
+    #   github = Github.new oauth_token: '...'
+    #   github.activity.watching.watched
+    #
+    # @api public
+    def watched(*args)
+      arguments(args)
+      params = arguments.params
+
+      response = if (user_name = params.delete('user'))
+        get_request("/users/#{user_name}/subscriptions", params)
+      else
+        get_request('/user/subscriptions', params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Check if you are subscribed to a repository
+    #
+    # @see https://developer.github.com/v3/activity/watching/#get-a-repository-subscription
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.watching.subscribed? 'user-name', 'repo-name'
+    #
+    # @example
+    #   github.activity.watching.subscribed? user: 'user-name', repo: 'repo-name'
+    #
+    # @api public
+    def subscribed?(*args)
+      arguments(args, required: [:user, :repo])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/subscription", arguments.params)
+      true
+    rescue Github::Error::NotFound
+      false
+    end
+
+    # Create subscription to a repository
+    #
+    # @see https://developer.github.com/v3/activity/watching/#set-a-repository-subscription
+    #
+    # @param [Hash] params
+    # @option params [Boolean] :subscribed
+    #   Determines if notifications should be received from this repository.
+    # @option params [Boolean] :ignored
+    #   Determines if all notifications should be blocked from this repository.
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.watching.create 'user-name', 'repo-name'
+    #
+    # @example
+    #   github.activity.watching.create user: 'user-name', repo: 'repo-name'
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo])
+
+      put_request("/repos/#{arguments.user}/#{arguments.repo}/subscription", arguments.params)
+    end
+    alias_method :subscribe, :create
+
+    # Delete a repository subscription
+    #
+    # @see https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription
+    #
+    # @example
+    #   github = Github.new oauth_token: '...'
+    #   github.activity.watching.delete 'user-name', 'repo-name'
+    #
+    # @example
+    #   github.activity.watching.delete user: 'user-name', repo: 'repo-name'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/subscription", arguments.params)
+    end
+    alias_method :unsubscribe, :delete
+
+    # Check if you are watching a repository
+    #
+    # @see https://developer.github.com/v3/activity/watching/#check-if-you-are-watching-a-repository-legacy
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.watching.watching? 'user-name', 'repo-name'
+    #
+    # @return [Boolean]
+    #   Returns true if this repo is watched by you, false otherwise.
+    #
+    # @api public
+    def watching?(*args)
+      arguments(args, required: [:user, :repo])
+
+      get_request("/user/subscriptions/#{arguments.user}/#{arguments.repo}", arguments.params)
+      true
+    rescue Github::Error::NotFound
+      false
+    end
+
+    # Watch a repository
+    #
+    # You need to be authenticated to watch a repository
+    #
+    # @see https://developer.github.com/v3/activity/watching/#watch-a-repository-legacy
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.watching.watch 'user-name', 'repo-name'
+    #
+    # @api public
+    def watch(*args)
+      arguments(args, required: [:user, :repo])
+
+      put_request("/user/subscriptions/#{arguments.user}/#{arguments.repo}", arguments.params)
+    end
+
+    # Stop watching a repository
+    #
+    # You need to be authenticated to stop watching a repository.
+    #
+    # @see https://developer.github.com/v3/activity/watching/#stop-watching-a-repository-legacy
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.watching.unwatch 'user-name', 'repo-name'
+    #
+    # @api public
+    def unwatch(*args)
+      arguments(args, required: [:user, :repo])
+
+      delete_request("/user/subscriptions/#{arguments.user}/#{arguments.repo}", arguments.params)
+    end
+  end # Activity::Watching
+end # Github