lingfennan-github_api 0.18.2

data/lib/github_api/client/repos/releases/assets.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+
+require_relative '../../../api'
+
+module Github
+  # The Release Assets API
+  class Client::Repos::Releases::Assets < API
+
+    VALID_ASSET_PARAM_NAMES = %w[
+      name
+      label
+      content_type
+    ].freeze # :nodoc:
+
+    # List assets for a release
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.releases.assets.list 'owner', 'repo', 'id'
+    #   github.repos.releases.assets.list 'owner', 'repo', 'id' { |asset| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:owner, :repo, :id]).params
+
+      response = get_request("/repos/#{arguments.owner}/#{arguments.repo}/releases/#{arguments.id}/assets", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single release asset
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.releases.assets.get 'owner', 'repo', 'id'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:owner, :repo, :id]).params
+
+      get_request("/repos/#{arguments.owner}/#{arguments.repo}/releases/assets/#{arguments.id}" , arguments.params)
+    end
+    alias :find :get
+
+    # Upload a release asset
+    #
+    # @param [Hash] params
+    # @input params [String] :name
+    #   Required string. The file name of the asset
+    # @input params [String] :content_type
+    #   Required string. The content type of the asset.
+    #   Example: “application/zip”.
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.releases.assets.upload 'owner', 'repo', 'id', 'file-path'
+    #     name: "batman.jpg",
+    #     content_type: "application/octet-stream"
+    #
+    # @api public
+    def upload(*args)
+      arguments(args, required: [:owner, :repo, :id, :filepath]) do
+        permit VALID_ASSET_PARAM_NAMES
+      end
+      params = arguments.params
+
+      unless type = params['content_type']
+        type = infer_media(arguments.filepath)
+      end
+
+      file = Faraday::UploadIO.new(arguments.filepath, type)
+      options = {
+        headers: { content_type: type },
+        endpoint: upload_endpoint,
+        query: {'name' => params['name']}
+      }
+      params['data']    = file.read
+      params['options'] = options
+
+      post_request("/repos/#{arguments.owner}/#{arguments.repo}/releases/#{arguments.id}/assets", params)
+    ensure
+      file.close if file
+    end
+
+    # Infer media type of the asset
+    #
+    def infer_media(filepath)
+      require 'mime/types'
+      types = MIME::Types.type_for(filepath)
+      types.empty? ? 'application/octet-stream' : types.first
+    rescue LoadError
+      raise Github::Error::UnknownMedia.new(filepath)
+    end
+
+    # Edit a release asset
+    #
+    # Users with push access to the repository can edit a release asset.
+    #
+    # @param [Hash] params
+    # @input params [String] :name
+    #   Required. The file name of the asset.
+    # @input params [String] :label
+    #   An alternate short description of the asset.
+    #   Used in place of the filename.
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.releases.assets.edit 'owner', 'repo', 'id',
+    #     name: "foo-1.0.0-osx.zip",
+    #     label: "Mac binary"
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:owner, :repo, :id]) do
+        permit VALID_ASSET_PARAM_NAMES
+      end
+
+      patch_request("/repos/#{arguments.owner}/#{arguments.repo}/releases/assets/#{arguments.id}", arguments.params)
+    end
+    alias :update :edit
+
+    # Delete a release asset
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.releases.assets.delete 'owner', 'repo', 'id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:owner, :repo, :id])
+
+      delete_request("/repos/#{arguments.owner}/#{arguments.repo}/releases/assets/#{arguments.id}", arguments.params)
+    end
+  end # Client::Repos::Releases::Assets
+end # Github

data/lib/github_api/client/repos/releases/tags.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require_relative '../../../api'
+
+module Github
+  # The Releases API
+  class Client::Repos::Releases::Tags < API
+    # Get a published release with the specified tag.
+    #
+    # @see https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.releases.tags.get 'owner', 'repo', 'tag'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:owner, :repo, :tag]).params
+
+      get_request("/repos/#{arguments.owner}/#{arguments.repo}/releases/tags/#{arguments.tag}" , arguments.params)
+    end
+    alias_method :find, :get
+  end # Client::Repos::Releases::Tags
+end # Github

data/lib/github_api/client/repos/statistics.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  # The Repository Statistics API allows you to fetch the data that GitHub uses
+  # for visualizing different types of repository activity.
+  class Client::Repos::Statistics < API
+
+    # Get contributors list with additions, deletions, and commit counts
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.stats.contributors user: '...', repo: '...'
+    #   github.repos.stats.contributors user: '...', repo: '...' { |stat| ... }
+    #
+    # @api public
+    def contributors(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/stats/contributors", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Get the last year of commit activity data
+    #
+    # Returns the last year of commit activity grouped by week.
+    # The days array is a group of commits per day, starting on Sunday
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.stats.commit_activity user: '...', repo: '...'
+    #   github.repos.stats.commit_activity user: '...', repo: '...' { |stat| ... }
+    #
+    # @api public
+    def commit_activity(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/stats/commit_activity", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Get the number of additions and deletions per week
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.stats.code_frequency user: '...', repo: '...'
+    #  github.repos.stats.code_frequency user: '...', repo: '...' { |stat| ... }
+    #
+    # @api public
+    def code_frequency(*args)
+      arguments(args, required: [:user, :repo])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/stats/code_frequency", arguments.params)
+    end
+
+    # Get the weekly commit count for the repo owner and everyone else
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.stats.participation user: '...', repo: '...'
+    #   github.repos.stats.participation user: '...', repo: '...' { |stat| ... }
+    #
+    # @api public
+    def participation(*args)
+      arguments(args, required: [:user, :repo])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/stats/participation", arguments.params)
+    end
+
+    # Get the number of commits per hour in each day
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.stats.punch_card user: '...', repo: '...'
+    #   github.repos.stats.punch_card user: '...', repo: '...' { |stat| ... }
+    #
+    # @api public
+    def punch_card(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/stats/punch_card", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end # Client::Repos::Statistics
+end # Github

data/lib/github_api/client/repos/statuses.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  # 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.
+  class Client::Repos::Statuses < API
+
+    VALID_STATUS_PARAM_NAMES = %w[
+      state
+      target_url
+      description
+      context
+    ].freeze # :nodoc:
+
+    REQUIRED_PARAMS = %w[ state ].freeze # :nodoc:
+
+    # List Statuses for a specific SHA
+    #
+    # @param [String] :ref
+    #   Ref to fetch the status for. It can be a SHA, a branch name,
+    #   or a tag name.
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.statuses.list 'user-name', 'repo-name', 'ref'
+    #   github.repos.statuses.list 'user-name', 'repo-name', 'ref' { |status| ... }
+    #
+    # Get the combined Status for a specific Ref
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.statuses.list 'user', 'repo', 'ref', combined: true
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo, :ref])
+      params = arguments.params
+      user, repo, ref = arguments.user, arguments.repo, arguments.ref
+
+      response = if params.delete('combined')
+        get_request("/repos/#{user}/#{repo}/commits/#{ref}/status", params)
+      else
+        get_request("/repos/#{user}/#{repo}/commits/#{ref}/statuses", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Create a status
+    #
+    # @param [Hash] params
+    # @input params [String] :state
+    #   Required. The state of the status. Can be one of pending,
+    #   success, error, or failure.
+    # @input params [String] :target_url
+    #   The 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.
+    #
+    #   For example, if your Continuous Integration system is posting
+    #   build status, you would want to provide the deep link for
+    #   the build output for this specific SHA:
+    #   http://ci.example.com/user/repo/build/sha.
+    # @input params [String] :description
+    #   A short description of the status
+    # @input params [String] :context
+    #   A string label to differentiate this status from the
+    #   status of other systems. Default: "default"
+    #
+    # @example
+    #   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"
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo, :sha]) do
+        permit VALID_STATUS_PARAM_NAMES, recursive: false
+        assert_required REQUIRED_PARAMS
+      end
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/statuses/#{arguments.sha}", arguments.params)
+    end
+  end # Client::Repos::Statuses
+end # Github

data/lib/github_api/client/say.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  class Client::Say < API
+
+    # Generate ASCII octocat with speech bubble.
+    #
+    # @example
+    #  Github::Client::Say.new.say "My custom string..."
+    #
+    # @example
+    #  github = Github.new
+    #  github.octocat.say "My custom string..."
+    #
+    def say(*args)
+      params = arguments(*args).params
+      params[:s] = args.shift unless args.empty?
+      params['raw'] = true
+
+      get_request('/octocat', params)
+    end
+  end # Say
+end # Github

data/lib/github_api/client/scopes.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  class Client::Scopes < API
+    # Check what OAuth scopes you have.
+    #
+    # @see https://developer.github.com/v3/oauth/#scopes
+    #
+    # @example
+    #   github = Github.new oauth_token: 'e72e16c7e42f292c6912e7710c838347ae17'
+    #   github.scopes.all
+    #
+    # @example
+    #   github = Github.new
+    #   github.scopes.list 'e72e16c7e42f292c6912e7710c838347ae17'
+    #
+    # @example
+    #   github = Github.new
+    #   github.scopes.list token: 'e72e16c7e42f292c6912e7710c838347ae17'
+    #
+    # @api public
+    def list(*args)
+      arguments(args)
+      params = arguments.params
+      token = args.shift
+
+      if token.is_a?(Hash) && !params['token'].nil?
+        token = params.delete('token')
+      elsif token.nil?
+        token = oauth_token
+      end
+
+      if token.nil?
+        raise ArgumentError, 'Access token required'
+      end
+
+      headers = { 'Authorization' => "token #{token}" }
+      params['headers'] = headers
+      response = get_request("/user", params)
+      response.headers.oauth_scopes.split(',').map(&:strip)
+    end
+    alias all list
+  end # Client::Scopes
+end # Github

data/lib/github_api/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_api/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