github_api 0.6.5 → 0.7.0

data/lib/github_api/repos.rb

@@ -6,7 +6,6 @@ module Github
 
     # Load all the modules after initializing Repos to avoid superclass mismatch
     autoload_all 'github_api/repos',
-      :Assignees     => 'assignees',
       :Collaborators => 'collaborators',
       :Commits       => 'commits',
       :Contents      => 'contents',
@@ -14,8 +13,11 @@ module Github
       :Forks         => 'forks',
       :Hooks         => 'hooks',
       :Keys          => 'keys',
-      :Watching      => 'watching',
-      :PubSubHubbub  => 'pub_sub_hubbub'
+      :Merging       => 'merging',
+      :PubSubHubbub  => 'pub_sub_hubbub',
+      :Starring      => 'starring',
+      :Statuses      => 'statuses',
+      :Watching      => 'watching'
 
     DEFAULT_REPO_OPTIONS = {
       "homepage"   => "https://github.com",
@@ -43,11 +45,6 @@ module Github
       super(options)
     end
 
-    # Access to Repos::Collaborators API
-    def assignees
-      @assignees ||= ApiFactory.new 'Repos::Assignees'
-    end
-
     # Access to Repos::Collaborators API
     def collaborators
       @collaborators ||= ApiFactory.new 'Repos::Collaborators'
@@ -83,9 +80,9 @@ module Github
       @keys ||= ApiFactory.new 'Repos::Keys'
     end
 
-    # Access to Repos::Watchin API
-    def watching
-      @watching ||= ApiFactory.new 'Repos::Watching'
+    # Access to Repos::Merging API
+    def merging
+      @mergin ||= ApiFactory.new 'Repos::Merging'
     end
 
     # Access to Repos::Watchin API
@@ -93,6 +90,21 @@ module Github
       @pubsubhubbub ||= ApiFactory.new 'Repos::PubSubHubbub'
     end
 
+    # Access to Repos::Starring API
+    def starring
+      @starring ||= ApiFactory.new 'Repos::Starring'
+    end
+
+    # Access to Repos::Statuses API
+    def statuses
+      @statuses ||= ApiFactory.new 'Repos::Statuses'
+    end
+
+    # Access to Repos::Watching API
+    def watching
+      @watching ||= ApiFactory.new 'Repos::Watching'
+    end
+
     # List branches
     #
     # = Examples

data/lib/github_api/repos/commits.rb

@@ -77,8 +77,9 @@ module Github
       # List commits on a repository
       #
       # = Parameters
-      # * <tt>:sha</tt>   Optional string. Sha or branch to start listing commits from.
-      # * <tt>:path</tt>  Optional string. Only commits containing this file path will be returned
+      # * <tt>:sha</tt>     Optional string. Sha or branch to start listing commits from.
+      # * <tt>:path</tt>    Optional string. Only commits containing this file path will be returned.
+      # * <tt>:author</tt>  GitHub login, name, or email by which to filter by commit author.
       #
       # = Examples
       #  github = Github.new
@@ -89,7 +90,7 @@ module Github
         _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless user? && repo?
         normalize! params
-        filter! %w[ sha path], params
+        filter! %w[sha path author], params
 
         response = get_request("/repos/#{user}/#{repo}/commits", params)
         return response unless block_given?

data/lib/github_api/repos/merging.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module Github
+  # The Repo Merging API supports merging branches in a repository. This
+  # accomplishes essentially the same thing as merging one branch into another
+  # in a local repository and then pushing to GitHub.
+  class Repos::Merging < API
+
+    VALID_MERGE_PARAM_NAMES = %w[
+      base
+      head
+      commit_message
+    ].freeze # :nodoc:
+
+    REQUIRED_MERGE_PARAMS = %w[ base head ].freeze # :nodoc:
+
+    # Perform a merge
+    #
+    # = Inputs
+    # * <tt>:base</tt> - Required String - The name of the base branch that the head will be merged into.
+    # * <tt>:head</tt> - Required String - The head to merge. This can be a branch name or a commit SHA1.
+    # * <tt>:commit_message</tt> - Optional String - Commit message to use for the merge commit. If omitted, a default message will be used.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.merging.merge 'user', 'repo',
+    #    "base": "master",
+    #    "head": "cool_feature",
+    #    "commit_message": "Shipped cool_feature!"
+    #
+    def merge(user_name, repo_name, params={})
+      normalize! params
+      filter! VALID_MERGE_PARAM_NAMES, params
+      assert_required_keys REQUIRED_MERGE_PARAMS, params
+
+      post_request("/repos/#{user_name}/#{repo_name}/merges", params)
+    end
+
+  end # Repos::Merging
+end # Github

data/lib/github_api/repos/starring.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+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 Repos::Starring < API
+
+    # List stargazers
+    #
+    # = Examples
+    #  github = Github.new :user => 'user-name', :repo => 'repo-name'
+    #  github.repos.starring.list
+    #  github.repos.starring.list { |star| ... }
+    #
+    def list(user_name, repo_name, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = get_request("/repos/#{user}/#{repo}/stargazers", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # List repos being starred by a user
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.starring.starred :user => 'user-name'
+    #
+    # List repos being starred by the authenticated user
+    #
+    # = Examples
+    #  github = Github.new :oauth_token => '...'
+    #  github.repos.starring.starred
+    #
+    def starred(*args)
+      params = args.extract_options!
+      normalize! 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
+    #
+    # Returns <tt>true</tt> if this repo is starred by you,<tt>false</tt> otherwise
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.starring.starring? 'user-name', 'repo-name'
+    #
+    def starring?(user_name, repo_name, params={})
+      _validate_presence_of user_name, repo_name
+      normalize! params
+      get_request("/user/starred/#{user_name}/#{repo_name}", params)
+      true
+    rescue Github::Error::NotFound
+      false
+    end
+
+    # Star a repository
+    #
+    # You need to be authenticated to star a repository
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.starring.star 'user-name', 'repo-name'
+    #
+    def star(user_name, repo_name, params={})
+      _validate_presence_of user_name, repo_name
+      normalize! params
+      put_request("/user/starred/#{user_name}/#{repo_name}", params)
+    end
+
+    # Unstar a repository
+    #
+    # You need to be authenticated to unstar a repository.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.starring.unstar 'user-name', 'repo-name'
+    #
+    def unstar(user_name, repo_name, params={})
+      _validate_presence_of user_name, repo_name
+      normalize! params
+      delete_request("/user/starred/#{user_name}/#{repo_name}", params)
+    end
+
+  end # Repos::Starring
+end # Github

data/lib/github_api/repos/statuses.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+module Github
+  class Repos::Statuses < API
+    # The Status API allows external services to mark commits with a success,
+    # failure, error, or pending state, which is then reflected in pull requests
+    # involving those commits.
+
+    VALID_STATUS_PARAM_NAMES = %w[
+      state
+      target_url
+      description
+    ].freeze # :nodoc:
+
+    REQUIRED_PARAMS = %w[ state ].freeze # :nodoc:
+
+    # List Statuses for a specific SHA
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.statuses.list 'user-name', 'repo-name', 'sha'
+    #  github.repos.statuses.list 'user-name', 'repo-name', 'sha' { |status| ... }
+    #
+    def list(user_name, repo_name, sha, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = get_request("/repos/#{user}/#{repo}/statuses/#{sha}", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Create a status
+    #
+    # = Inputs
+    # * <tt>:state</tt> - Required string - State of the status - can be one of
+    #                                       pending, success, error, or failure.
+    # * <tt>:target_url</tt> - Optional string - Target url to associate with this
+    #         status. This URL will be linked from the GitHub UI to allow users
+    #         to easily see the ‘source’ of the Status.
+    # * <tt>:description</tt> - Optional string - Short description of the status
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.statuses.create 'user-name', 'repo-name', 'sha',
+    #    "state" =>  "success",
+    #    "target_url" => "http://ci.example.com/johndoe/my-repo/builds/sha",
+    #    "description" => "Successful build #3 from origin/master"
+    #
+    def create(user_name, repo_name, sha, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+
+      normalize! params
+      filter! VALID_STATUS_PARAM_NAMES, params, :recursive => false
+      assert_required_keys(REQUIRED_PARAMS, params)
+
+      post_request("/repos/#{user}/#{repo}/statuses/#{sha}", params)
+    end
+
+  end # Repos::Statuses
+end # Github

data/lib/github_api/repos/watching.rb

@@ -1,24 +1,27 @@
 # encoding: utf-8
 
 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 Repos::Watching < API
 
     # List repo watchers
     #
     # = Examples
     #  github = Github.new :user => 'user-name', :repo => 'repo-name'
-    #  github.repos.watching.watchers
-    #  github.repos.watching.watchers { |watcher| ... }
+    #  github.repos.watching.list
+    #  github.repos.watching.list { |watcher| ... }
     #
-    def watchers(user_name, repo_name, params={})
+    def list(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
       normalize! params
 
-      response = get_request("/repos/#{user}/#{repo}/watchers", params)
+      response = get_request("/repos/#{user}/#{repo}/subscribers", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
+    alias :all :list
 
     # List repos being watched by a user
     #
@@ -37,9 +40,9 @@ module Github
       normalize! params
 
       response = if (user_name = params.delete('user'))
-        get_request("/users/#{user_name}/watched", params)
+        get_request("/users/#{user_name}/subscriptions", params)
       else
-        get_request("/user/watched", params)
+        get_request("/user/subscriptions", params)
       end
       return response unless block_given?
       response.each { |el| yield el }
@@ -55,7 +58,7 @@ module Github
     def watching?(user_name, repo_name, params={})
       _validate_presence_of user_name, repo_name
       normalize! params
-      get_request("/user/watched/#{user_name}/#{repo_name}", params)
+      get_request("/user/subscriptions/#{user_name}/#{repo_name}", params)
       true
     rescue Github::Error::NotFound
       false
@@ -67,12 +70,12 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.repos.watching.start_watching 'user-name', 'repo-name'
+    #  github.repos.watching.watch 'user-name', 'repo-name'
     #
-    def start_watching(user_name, repo_name, params={})
+    def watch(user_name, repo_name, params={})
       _validate_presence_of user_name, repo_name
       normalize! params
-      put_request("/user/watched/#{user_name}/#{repo_name}", params)
+      put_request("/user/subscriptions/#{user_name}/#{repo_name}", params)
     end
 
     # Stop watching a repository
@@ -80,12 +83,12 @@ module Github
     # You need to be authenticated to stop watching a repository.
     # = Examples
     #  github = Github.new
-    #  github.repos.watching.start_watching 'user-name', 'repo-name'
+    #  github.repos.watching.unwatch 'user-name', 'repo-name'
     #
-    def stop_watching(user_name, repo_name, params={})
+    def unwatch(user_name, repo_name, params={})
       _validate_presence_of user_name, repo_name
       normalize! params
-      delete_request("/user/watched/#{user_name}/#{repo_name}", params)
+      delete_request("/user/subscriptions/#{user_name}/#{repo_name}", params)
     end
 
   end # Repos::Watching

data/lib/github_api/response.rb

@@ -6,6 +6,7 @@ module Github
   # Contains methods and attributes that act on the response returned from the 
   # request
   class Response < Faraday::Response::Middleware
+
     CONTENT_TYPE = 'Content-Type'.freeze
 
     class << self

data/lib/github_api/response/jsonize.rb

@@ -1,17 +1,16 @@
 # encoding: utf-8
 
 require 'faraday'
+require 'github_api/jsonable'
 
 module Github
   class Response::Jsonize < Response
+    include Github::Jsonable
+
     dependency 'multi_json'
 
     define_parser do |body|
-      if MultiJson.respond_to?(:load)
-        MultiJson.load body
-      else
-        MultiJson.decode body
-      end
+      Github::Jsonable.decode body
     end
 
     def parse(body)

data/lib/github_api/version.rb

@@ -3,8 +3,8 @@
 module Github
   module VERSION
     MAJOR = 0
-    MINOR = 6
-    PATCH = 5
+    MINOR = 7
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/spec/fixtures/repos/merge.json

@@ -0,0 +1,48 @@
+{
+  "commit": {
+    "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+    "commit": {
+      "author": {
+        "name": "The Octocat",
+        "date": "2012-03-06T15:06:50-08:00",
+        "email": "octocat@nowhere.com"
+      },
+      "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+      "message": "Shipped cool_feature!",
+      "tree": {
+        "sha": "b4eecafa9be2f2006ce1b709d6857b07069b4608",
+        "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"
+      },
+      "committer": {
+        "name": "The Octocat",
+        "date": "2012-03-06T15:06:50-08:00",
+        "email": "octocat@nowhere.com"
+      }
+    },
+    "author": {
+      "gravatar_id": "7ad39074b0584bc555d0417ae3e7d974",
+      "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+      "url": "https://api.github.com/users/octocat",
+      "id": 583231,
+      "login": "octocat"
+    },
+    "parents": [
+      {
+        "sha": "553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
+        "url": "https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"
+      },
+      {
+        "sha": "762941318ee16e59dabbacb1b4049eec22f0d303",
+        "url": "https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303"
+      }
+    ],
+    "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
+    "committer": {
+      "gravatar_id": "7ad39074b0584bc555d0417ae3e7d974",
+      "avatar_url": "https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+      "url": "https://api.github.com/users/octocat",
+      "id": 583231,
+      "login": "octocat"
+    }
+  }
+}