github_api 0.11.3 → 0.12.0

data/lib/github_api/client/search/legacy.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+
+module Github
+  class Client::Search::Legacy < API
+    include Github::Utils::Url
+
+    # Search issues
+    #
+    # Find issues by state and keyword.
+    #
+    # @param [Hash] params
+    # @option params [String] :state
+    #   Indicates the state of the issues to return. Can be either open or closed.
+    # @option params [String] :keyword
+    #   The search term
+    #
+    # @example
+    #   github = Github.new
+    #   github.search.legacy.issues 'owner', 'repo-name', 'open','api'
+    #   github.search.legacy.issues owner: 'owner', repo: 'repo-name', state: 'open', keyword: 'api'
+    #
+    # @api public
+    def issues(*args)
+      required = %w[ owner repo state keyword ]
+      arguments(args, required: required)
+
+      get_request("/legacy/issues/search/#{arguments.owner}/#{arguments.repo}/#{arguments.state}/#{escape_uri(arguments.keyword)}", arguments.params)
+    end
+
+    # Search repositories
+    #
+    # Find repositories by keyword.
+    #
+    # @param [Hash] params
+    # @option params [String] :keyword
+    #   The search term
+    # @option params [String] :language
+    #   Filter results by language
+    # @option params [String] :start_page
+    #   The page number to fetch
+    # @option params [String] :sort
+    #   The sort field. One of stars, forks, or updated.
+    #   Default: results are sorted by best match.
+    # @option params [String] :order
+    #   The sort field. if sort param is provided.
+    #   Can be either asc or desc.
+    #
+    # @example
+    #   github = Github.new
+    #   github.search.legacy.repos 'api'
+    #   github.search.legacy.repos keyword: 'api'
+    #
+    # @api public
+    def repos(*args)
+      arguments(args, required: [:keyword])
+
+      get_request("/legacy/repos/search/#{escape_uri(arguments.keyword)}", arguments.params)
+    end
+    alias :repositories :repos
+
+    # Search users
+    #
+    # Find users by keyword.
+    #
+    # @param [Hash] params
+    # @option params [String] :keyword
+    #   The search term
+    # @option params [String] :start_page
+    #   The page number to fetch
+    # @option params [String] :sort
+    #   The sort field. One of stars, forks, or updated.
+    #   Default: results are sorted by best match.
+    # @option params [String] :order
+    #   The sort field. if sort param is provided.
+    #   Can be either asc or desc.
+    #
+    # @example
+    #   github = Github.new
+    #   github.search.legacy.users 'user'
+    #   github.search.legacy.users keyword: 'user'
+    #
+    # @api public
+    def users(*args)
+      arguments(args, required: [:keyword])
+
+      get_request("/legacy/user/search/#{escape_uri(arguments.keyword)}", arguments.params)
+    end
+
+    # Search email
+    #
+    # This API call is added for compatibility reasons only. There’s no
+    # guarantee that full email searches will always be available.
+    #
+    # @param [Hash] params
+    # @option params [String] :email
+    #   The email address
+    #
+    # @example
+    #  github = Github.new
+    #  github.search.email 'email-address'
+    #  github.search.email email: 'email-address'
+    #
+    # @api public
+    def email(*args)
+      arguments(args, required: [:email])
+      get_request("/legacy/user/email/#{arguments.email}", arguments.params)
+    end
+  end # Search::Legacy
+end # Github

data/lib/github_api/client/users.rb

@@ -0,0 +1,115 @@
+# encoding: utf-8
+
+module Github
+  class Client::Users < API
+    # Load all the modules after initializing Repos to avoid superclass mismatch
+    require_all 'github_api/client/users',
+      'emails',
+      'followers',
+      'keys'
+
+    VALID_USER_PARAMS_NAMES = %w[
+      name
+      email
+      blog
+      company
+      location
+      hireable
+      bio
+    ].freeze
+
+    # Access to Users::Emails API
+    namespace :emails
+
+    # Access to Users::Followers API
+    namespace :followers
+
+    # Access to Users::Keys API
+    namespace :keys
+
+    # List all users.
+    #
+    # This provides a dump of every user, in the order that they signed up
+    # for GitHub.
+    #
+    # @param [Hash] params
+    # @option [Integer] :since
+    #   The integer ID of the last User that you’ve seen.
+    #
+    # @example
+    #  users = Github::Users.new
+    #  users.list
+    #
+    # @api public
+    def list(*args)
+      arguments(args)
+
+      response = get_request("/users", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single unauthenticated user
+    #
+    # @example
+    #  github = Github.new
+    #  github.users.get user: 'user-name'
+    #
+    # Get the authenticated user
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.users.get
+    #
+    # @api public
+    def get(*args)
+      params = arguments(args).params
+
+      if user_name = params.delete('user')
+        get_request("/users/#{user_name}", params)
+      else
+        get_request("/user", params)
+      end
+    end
+    alias :find :get
+
+    # Update the authenticated user
+    #
+    # @param [Hash] params
+    # @option params [String] :name
+    #   Optional string
+    # @option params [String] :email
+    #   Optional string - publically visible email address
+    # @option params [String] :blog
+    #   Optional string
+    # @option params [String] :company
+    #   Optional string
+    # @option params [String] :location
+    #   Optional string
+    # @option params [String] :hireable
+    #   Optional boolean
+    # @option params [String] :bio
+    #   Optional string
+    #
+    # @example
+    #  github = Github.new oauth_token: '..'
+    #  github.users.update
+    #    name: "monalisa octocat",
+    #    email: "octocat@github.com",
+    #    blog: "https://github.com/blog",
+    #    company: "GitHub",
+    #    location: "San Francisco",
+    #    hireable: true,
+    #    bio: "There once..."
+    #
+    # @api public
+    def update(*args)
+      arguments(args) do
+        permit VALID_USER_PARAMS_NAMES
+      end
+
+      patch_request("/user", arguments.params)
+    end
+  end # Users
+end # Github

data/lib/github_api/client/users/emails.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+require 'cgi'
+
+module Github
+  class Client::Users::Emails < API
+
+    # List email addresses for the authenticated user
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.users.emails.list
+    #  github.users.emails.list { |email| ... }
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def list(*args)
+      arguments(args)
+      response = get_request("/user/emails", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Add email address(es) for the authenticated user
+    #
+    # @param [Array[String]] emails
+    #   You can include a single email address or an array of addresses
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.users.emails.add "octocat@github.com", "support@github.com"
+    #
+    # @api public
+    def add(*args)
+      arguments(args)
+      params = arguments.params
+      params['data'] = arguments.remaining unless arguments.remaining.empty?
+
+      post_request("/user/emails", params)
+    end
+    alias :<< :add
+
+    # Delete email address(es) for the authenticated user
+    #
+    # @param [Array[String]] emails
+    #   You can include a single email address or an array of addresses
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.users.emails.delete "octocat@github.com", "support@github.com"
+    #
+    # @api public
+    def delete(*args)
+      arguments(args)
+      params = arguments.params
+      params['data'] = arguments.remaining unless arguments.remaining.empty?
+
+      delete_request("/user/emails", params)
+    end
+  end # Users::Emails
+end # Github

data/lib/github_api/client/users/followers.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+
+module Github
+  class Client::Users::Followers < API
+
+    # List a user's followers
+    #
+    # @xample
+    #  github = Github.new
+    #  github.users.followers.list 'user-name'
+    #  github.users.followers.list 'user-name' { |user| ... }
+    #
+    # List the authenticated user's followers
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.users.followers
+    #  github.users.followers { |user| ... }
+    #
+    # @api public
+    def list(*args)
+      params = arguments(args).params
+
+      response = if user_name = arguments.remaining.first
+        get_request("/users/#{user_name}/followers", params)
+      else
+        get_request("/user/followers", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # List who a user is following
+    #
+    # @example
+    #  github = Github.new
+    #  github.users.followers.following 'user-name'
+    #  github.users.followers.following 'user-name' { |user| ... }
+    #
+    # List who the authenicated user is following
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.users.followers.following
+    #
+    # @api public
+    def following(*args)
+      params = arguments(args).params
+
+      response = if user_name = arguments.remaining.first
+        get_request("/users/#{user_name}/following", params)
+      else
+        get_request("/user/following", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Check if you are following a user
+    #
+    # @example
+    #   github = Github.new oauth_token: '...'
+    #   github.users.followers.following? 'user-name'
+    #   github.users.followers.following? username: 'user-name'
+    #
+    # Check if one user follows another
+    #
+    # @example
+    #   github = Github.new oauth_token: '...'
+    #   github.users.followers.following? username: 'user-name',
+    #     target_user: 'target-user-name'
+    #
+    # @api public
+    def following?(*args)
+      arguments(args, required: [:username])
+      params = arguments.params
+      if target_user = params.delete('target_user')
+        get_request("/users/#{arguments.username}/following/#{target_user}", params)
+      else
+        get_request("/user/following/#{arguments.username}", params)
+      end
+      true
+    rescue Github::Error::NotFound
+      false
+    end
+
+    # Follow a user
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.users.followers.follow 'user-name'
+    #  github.users.followers.follow username: 'user-name'
+    #
+    # @api public
+    def follow(*args)
+      arguments(args, required: [:username])
+      put_request("/user/following/#{arguments.username}", arguments.params)
+    end
+
+    # Unfollow a user
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.users.followers.unfollow 'user-name'
+    #  github.users.followers.unfollow username: 'user-name'
+    #
+    def unfollow(*args)
+      arguments(args, required: [:username])
+      delete_request("/user/following/#{arguments.username}", arguments.params)
+    end
+  end # Users::Followers
+end # Github

data/lib/github_api/client/users/keys.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+
+module Github
+  class Client::Users::Keys < API
+
+    VALID_KEY_PARAM_NAMES = %w[ title key ].freeze
+
+    # List public keys for the authenticated user
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.users.keys.list
+    #  github.users.keys.list { |key| ... }
+    #
+    # List public keys for the specified user
+    #
+    # @example
+    #  github.users.keys.list user: 'user-name'
+    #  github.users.keys.list user: 'user-name' { |key| ... }
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def list(*args)
+      params = arguments(args).params
+      response = if (user = params.delete('user'))
+        get_request("/users/#{user}/keys", params)
+      else
+        get_request("/user/keys", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single pulic key for the authenticated user
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.users.keys.get 'key-id'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:id])
+      get_request("/user/keys/#{arguments.id}", arguments.params)
+    end
+    alias :find :get
+
+    # Create a public key for the authenticated user
+    #
+    # @param [Hash] params
+    # @option [String] :title
+    #   Required string
+    # @option [String] :key
+    #   Required string. sha key
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.users.keys.create "title": "octocat@octomac", "key": "ssh-rsa AAA..."
+    #
+    # @api public
+    def create(*args)
+      arguments(args) do
+        permit VALID_KEY_PARAM_NAMES
+      end
+      post_request("/user/keys", arguments.params)
+    end
+
+    # Update a public key for the authenticated user
+    #
+    # @param [Hash] params
+    # @option [String] :title
+    #   Required string
+    # @option [String] :key
+    #   Required string. sha key
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.users.keys.update 'key-id', "title": "octocat@octomac",
+    #    "key": "ssh-rsa AAA..."
+    #
+    # @api public
+    def update(*args)
+      arguments(args, required: [:id]) do
+        permit VALID_KEY_PARAM_NAMES
+      end
+      patch_request("/user/keys/#{arguments.id}", arguments.params)
+    end
+
+    # Delete a public key for the authenticated user
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.users.keys.delete 'key-id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:id])
+      delete_request("/user/keys/#{arguments.id}", arguments.params)
+    end
+  end # Users::Keys
+end # Github