github_api2 1.0.0

data/lib/github_api2/client/search.rb

@@ -0,0 +1,133 @@
+# encoding: utf-8
+
+require_relative '../api'
+require_relative '../utils/url'
+
+module Github
+  # The Search API is optimized to help you find the specific item
+  # you're looking for (e.g., a specific user, a specific file
+  # in a repository, etc.).
+  class Client::Search < API
+    include Github::Utils::Url
+
+    require_all 'github_api2/client/search', 'legacy'
+
+    # Access to Search::Legacy API
+    namespace :legacy
+
+    # Search issues
+    #
+    # Find issues by state and keyword.
+    # (This method returns up to 100 results per page.)
+    #
+    # @param [Hash] params
+    # @option params [String] :q
+    #   The search terms. This can be any combination of the supported
+    #   issue search parameters.
+    # @option params [String] :sort
+    #   Optional sort field. One of comments, created, or updated.
+    #   If not provided, results are sorted by  best match.
+    # @option params [String] :order
+    #  The sort order if sort parameter is provided.
+    #  One of asc or desc. Default: desc
+    #
+    # @example
+    #   github = Github.new
+    #   github.search.issues 'query'
+    #
+    # @example
+    #   github.search.issues q: 'query'
+    #
+    # @api public
+    def issues(*args)
+      params = arguments(args, required: [:q]).params
+      params['q']      ||= arguments.q
+
+      get_request('/search/issues' , params)
+    end
+
+    # Search repositories
+    #
+    # Find repositories via various criteria.
+    # (This method returns up to 100 results per page.)
+    #
+    # @param [Hash] params
+    # @option params [String] :q
+    #   The search keywords, as well as any qualifiers.
+    # @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 order if sort parameter is provided.
+    #   One of asc or desc. Default: desc
+    #
+    # @example
+    #   github = Github.new
+    #   github.search.repos 'query'
+    #
+    # @example
+    #   github.search.repos q: 'query'
+    #
+    # @api public
+    def repos(*args)
+      params = arguments(args, required: [:q]).params
+      params['q'] ||= arguments.q
+
+      get_request('/search/repositories', arguments.params)
+    end
+    alias :repositories :repos
+
+    # Search users
+    #
+    # Find users by keyword.
+    #
+    # @param [Hash] params
+    # @option params [String] :q
+    #   The search terms. This can be any combination of the supported
+    #   issue search parameters.
+    # @option params [String] :sort
+    #   Optional sort field. One of comments, created, or updated.
+    #   If not provided, results are sorted by  best match.
+    # @option params [String] :order
+    #  The sort order if sort parameter is provided.
+    #  One of asc or desc. Default: desc
+    #
+    # @example
+    #   github = Github.new
+    #   github.search.users q: 'wycats'
+    #
+    # @api public
+    def users(*args)
+      params = arguments(args, required: [:q]).params
+      params['q'] ||= arguments.q
+
+      get_request('/search/users', arguments.params)
+    end
+
+    # Find file contents via various criteria.
+    # (This method returns up to 100 results per page.)
+    #
+    # @param [Hash] params
+    # @option params [String] :q
+    #   The search terms. This can be any combination of the supported
+    #   issue search parameters.
+    # @option params [String] :sort
+    #   Optional sort field. One of comments, created, or updated.
+    #   If not provided, results are sorted by  best match.
+    # @option params [String] :order
+    #  The sort order if sort parameter is provided.
+    #  One of asc or desc. Default: desc
+    #
+    # @example
+    #   github = Github.new
+    #   github.search.code q: 'wycats'
+    #
+    # @api public
+    def code(*args)
+      params = arguments(args, required: [:q]).params
+      params['q'] ||= arguments.q
+
+      get_request('/search/code', params)
+    end
+  end # Search
+end # Github

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

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+require 'cgi'
+
+require_relative '../../api'
+
+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_api2/client/users/followers.rb

@@ -0,0 +1,115 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Users::Followers < API
+
+    # List a user's followers
+    #
+    # @example
+    #  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_api2/client/users/keys.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+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

data/lib/github_api2/client/users.rb

@@ -0,0 +1,117 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  class Client::Users < API
+    # Load all the modules after initializing Repos to avoid superclass mismatch
+    require_all 'github_api2/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_api2/client.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+require_relative 'api'
+
+module Github
+  class Client < API
+    require_all 'github_api2/client',
+                'activity',
+                'authorizations',
+                'emojis',
+                'gists',
+                'gitignore',
+                'git_data',
+                'issues',
+                'markdown',
+                'meta',
+                'orgs',
+                'projects',
+                'pull_requests',
+                'repos',
+                'say',
+                'scopes',
+                'search',
+                'users'
+
+    # Serving up the 'social' in Social Coding, the Activity APIs
+    # provide access to notifications, subscriptions, and timelines.
+    namespace :activity
+
+    namespace :emojis
+
+    namespace :gists
+
+    namespace :gitignore
+    alias :git_ignore :gitignore
+
+    # The Git Database API gives you access to read and write raw Git objects
+    # to your Git database on GitHub and to list and update your references
+    # (branch heads and tags).
+    namespace :git_data
+    alias :git :git_data
+
+    namespace :issues
+
+    namespace :markdown
+
+    namespace :meta
+
+    # An API for users to manage their own tokens. You can only access your own
+    # tokens, and only through Basic Authentication.
+    namespace :authorizations
+    alias :oauth :authorizations
+    alias :auth :authorizations
+
+    namespace :orgs
+    alias :organizations :orgs
+
+    namespace :projects
+
+    namespace :pull_requests
+    alias :pulls :pull_requests
+
+    namespace :repos
+    alias :repositories :repos
+
+    namespace :say
+    alias :octocat :say
+
+    namespace :scopes
+
+    namespace :search
+
+    # Many of the resources on the users API provide a shortcut for getting
+    # information about the currently authenticated user.
+    namespace :users
+  end # Client
+end # Github

data/lib/github_api2/configuration.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+require_relative 'api/config'
+require_relative 'version'
+
+module Github
+  # Stores the configuration
+  class Configuration < API::Config
+
+    # Other adapters are :typhoeus, :patron, :em_synchrony, :excon, :test
+    property :adapter, default: :net_http
+
+    # By default, don't traverse the page links
+    property :auto_pagination, default: false
+
+    property :follow_redirects, default: true
+
+    # Basic authentication
+    property :basic_auth
+
+    # By default, don't set an application key
+    property :client_id
+
+    # By default, don't set an application secret
+    property :client_secret
+
+    # By default, don't set a user oauth access token
+    property  :oauth_token
+
+    # The api endpoint used to connect to GitHub if none is set
+    property  :endpoint, default: 'https://api.github.com'.freeze
+
+    # The web endpoint used to connect to GitHub if none is set
+    property  :site, default: 'https://github.com'.freeze
+
+    # The web endpoint used to upload release assets to GitHub if none is set
+    property  :upload_endpoint, default: 'https://uploads.github.com'.freeze
+
+    # The default SSL configuration
+    property  :ssl, default: {
+      :ca_file => File.expand_path('../ssl_certs/cacerts.pem', __FILE__)
+    }
+
+    # By default the Accept header will make a request for JSON
+    property  :mime_type
+
+    # The value sent in the http header for 'User-Agent' if none is set
+    property  :user_agent, default: "Github API Ruby Gem #{Github::VERSION}".freeze
+
+    # By default uses the Faraday connection options if none is set
+    property  :connection_options, default: {}
+
+    # Global repository name
+    property :repo
+
+    property :user
+
+    property :org
+
+    property :login
+
+    property :password
+
+    # By default display 30 resources
+    property :per_page, default: 30
+
+    # Add Faraday::RackBuilder to overwrite middleware
+    property :stack
+  end # Configuration
+end # Github