github_api 0.11.3 → 0.12.0

data/lib/github_api/repos/pages.rb

@@ -1,49 +0,0 @@
-# encoding: utf-8
-
-module Github
-
-  # The Pages API retrieves information about your GitHub Pages configuration,
-  # and the statuses of your builds. Information about the site and the builds
-  # can only be accessed by authenticated owners, even though the websites
-  # are public.
-  class Repos::Pages < API
-
-    # List Pages builds
-    #
-    # @example
-    #  github = Github.new
-    #  github.repos.pages.list owner: 'owner-name', repo: 'repo-name'
-    #
-    #  github = Github.new
-    #  github.repos.pages.list :latest, owner: 'owner-name', repo: 'repo-name'
-    # @api public
-    def list(*args)
-      arguments(args, required: [:owner, :repo])
-      params = arguments.params
-
-      response = if args.map(&:to_s).include?('latest')
-        get_request("/repos/#{owner}/#{repo}/pages/builds/latest", params)
-      else
-        get_request("/repos/#{owner}/#{repo}/pages/builds", params)
-      end
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all :list
-
-    # Get information about a Pages site
-    #
-    # @example
-    #  github = Github.new
-    #  github.repos.pages.get owner: 'owner-name', repo: 'repo-name'
-    #
-    # @api public
-    def get(*args)
-      arguments(args, required: [:owner, :repo])
-
-      get_request("/repos/#{owner}/#{repo}/pages", arguments.params)
-    end
-    alias :find :get
-
-  end # Pages
-end # Github

data/lib/github_api/repos/pub_sub_hubbub.rb

@@ -1,117 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class Repos::PubSubHubbub < API
-    OPTIONS = {
-      :headers => {
-        CONTENT_TYPE => 'application/x-www-form-urlencoded'
-      }
-    }
-
-    # Subscribe to existing topic/event through pubsubhubbub
-    #
-    # = Parameters
-    # * topic - Required string - The URI of the GitHub repository to subscribe to. The path must be in the format of /:user/:repo/events/:event.
-    # * callback - Required string - The URI to receive the updates to the topic.
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.repos.pubsubhubbub.subscribe
-    #    'https://github.com/:user/:repo/events/push',
-    #    'github://Email?address=peter-murach@gmail.com',
-    #    :verify => 'sync',
-    #    :secret => '...'
-    #
-    def subscribe(*args)
-      params = arguments(args, :required => [:topic, :callback]).params
-      _merge_action!("subscribe", topic, callback, params)
-      params['options'] = OPTIONS
-
-      post_request("/hub", params)
-    end
-
-    # Unsubscribe from existing topic/event through pubsubhubbub
-    #
-    # = Parameters
-    # * topic - Required string - The URI of the GitHub repository to unsubscribe from. The path must be in the format of /:user/:repo/events/:event.
-    # * callback - Required string - The URI to unsubscribe the topic from.
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.repos.pubsubhubbub.unsubscribe
-    #    'https://github.com/:user/:repo/events/push',
-    #    'github://Email?address=peter-murach@gmail.com',
-    #    :verify => 'sync',
-    #    :secret => '...'
-    #
-    def unsubscribe(*args)
-      params = arguments(args, :required => [:topic, :callback]).params
-      _merge_action!("unsubscribe", topic, callback, params)
-      params['options'] = OPTIONS
-
-      post_request("/hub", params)
-    end
-
-    # Subscribe repository to service hook through pubsubhubbub
-    #
-    # = Parameters
-    # * repo-name - Required string,
-    # * service-name - Required string
-    # * <tt>:event</tt> - Required hash key for the type of event. The default event is <tt>push</tt>
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.repos.pubsubhubbub.subscribe_service 'user-name', 'repo-name', 'campfire',
-    #    :subdomain => 'github',
-    #    :room => 'Commits',
-    #    :token => 'abc123',
-    #    :event => 'watch'
-    #
-    def subscribe_service(*args)
-      params   = arguments(args, :required => [:user, :repo, :service]).params
-      event    = params.delete('event') || 'push'
-      topic    = "#{site}/#{user}/#{repo}/events/#{event}"
-      callback = "github://#{service}?#{params.serialize}"
-
-      subscribe(topic, callback)
-    end
-    alias :subscribe_repository :subscribe_service
-    alias :subscribe_repo :subscribe_service
-
-    # Subscribe repository to service hook through pubsubhubbub
-    #
-    # = Parameters
-    # * repo-name - Required string,
-    # * service-name - Required string
-    # * <tt>:event</tt> - Optional hash key for the type of event. The default event is <tt>push</tt>
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.repos.pubsubhubbub.unsubscribe_service 'user-name', 'repo-name', 'campfire'
-    #
-    def unsubscribe_service(*args)
-      params   = arguments(args, :required => [:user, :repo, :service]).params
-      event    = params.delete('event') || 'push'
-      topic    = "#{site}/#{user}/#{repo}/events/#{event}"
-      callback = "github://#{service}"
-
-      unsubscribe(topic, callback)
-    end
-    alias :unsubscribe_repository :unsubscribe_service
-    alias :unsubscribe_repo :unsubscribe_service
-
-  private
-
-    def _merge_action!(action, topic, callback, params) # :nodoc:
-      options = {
-        "hub.mode"     => action.to_s,
-        "hub.topic"    => topic.to_s,
-        "hub.callback" => callback,
-        "hub.verify"   => params.delete('verify') || 'sync',
-        "hub.secret"   => params.delete('secret') || ''
-      }
-      params.merge! options
-    end
-
-  end # Repos::PubSubHubbub
-end # Github

data/lib/github_api/repos/releases.rb

@@ -1,144 +0,0 @@
-# encoding: utf-8
-
-module Github
-
-  # The Releases API
-  class Repos::Releases < API
-
-    Github::require_all 'github_api/repos/releases', 'assets'
-
-    VALID_RELEASE_PARAM_NAMES = %w[
-      tag_name
-      target_commitish
-      name
-      body
-      draft
-      prerelease
-    ].freeze # :nodoc:
-
-    # Access to Repos::Releases::Assets API
-    def assets(options = {}, &block)
-      @assets ||= ApiFactory.new('Repos::Releases::Assets', current_options.merge(options), &block)
-    end
-
-    # List releases for a repository
-    #
-    # Users with push access to the repository will receive all releases
-    # (i.e., published releases and draft releases). Users with pull access
-    # will receive published releases only.
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.repos.releases.list 'owner', 'repo'
-    #  github.repos.releases.list 'owner', 'repo' { |release| ... }
-    #
-    def list(*args)
-      params = arguments(args, required: [:owner, :repo]).params
-      response = get_request("/repos/#{owner}/#{repo}/releases", params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all :list
-
-    # Get a single release
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.repos.releases.get 'owner', 'repo', 'id'
-    #
-    def get(*args)
-      params = arguments(args, required: [:owner, :repo, :id]).params
-      get_request("/repos/#{owner}/#{repo}/releases/#{id}" , params)
-    end
-    alias :find :get
-
-    # Create a release
-    #
-    # = Inputs
-    # * <tt>:tag_name</tt> - Required string
-    # * <tt>:target_commitish</tt> - Optional string - Specifies the commitish
-    #       value that determines where the Git tag is created from. Can be
-    #       any branch or commit SHA. Defaults to the repository's default
-    #       branch (usually 'master'). Unused if the Git tag already exists.
-    # * <tt>:name</tt> - Optional string
-    # * <tt>:body</tt> - Optional string
-    # * <tt>:draft</tt> - Optional boolean - <tt>true</tt> to create a draft
-    #                    (unpublished) release, <tt>false</tt> to create
-    #                     a published one. Default is false.
-    # * <tt>:prerelease</tt> - Optional boolean - <tt>true</tt> to identify
-    #                       the release as a prerelease. false to identify
-    #                       the release as a full release. Default is false.
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.repos.releases.create 'owner', 'repo', 'tag-name',
-    #    "tag_name": "v1.0.0",
-    #    "target_commitish": "master",
-    #    "name": "v1.0.0",
-    #    "body": "Description of the release",
-    #    "draft": false,
-    #    "prerelease": false
-    #
-    def create(*args)
-      arguments(args, required: [:owner, :repo, :tag_name]) do
-        sift VALID_RELEASE_PARAM_NAMES
-      end
-      params = arguments.params
-      params['tag_name'] = tag_name
-
-      post_request("/repos/#{owner}/#{repo}/releases", params)
-    end
-
-    # Edit a release
-    #
-    # = Inputs
-    # * <tt>:tag_name</tt> - Required string
-    # * <tt>:target_commitish</tt> - Optional string - Specifies the commitish
-    #       value that determines where the Git tag is created from. Can be
-    #       any branch or commit SHA. Defaults to the repository's default
-    #       branch (usually 'master'). Unused if the Git tag already exists.
-    # * <tt>:name</tt> - Optional string
-    # * <tt>:body</tt> - Optional string
-    # * <tt>:draft</tt> - Optional boolean - <tt>true</tt> to create a draft
-    #                    (unpublished) release, <tt>false</tt> to create
-    #                     a published one. Default is false.
-    # * <tt>:prerelease</tt> - Optional boolean - <tt>true</tt> to identify
-    #                       the release as a prerelease. false to identify
-    #                       the release as a full release. Default is false.
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.repos.releases.edit 'owner', 'repo', 'id',
-    #    "tag_name": "v1.0.0",
-    #    "target_commitish": "master",
-    #    "name": "v1.0.0",
-    #    "body": "Description of the release",
-    #    "draft": false,
-    #    "prerelease": false
-    #
-    def edit(*args)
-      arguments(args, required: [:owner, :repo, :id]) do
-        sift VALID_RELEASE_PARAM_NAMES
-      end
-      params = arguments.params
-
-      patch_request("/repos/#{owner}/#{repo}/releases/#{id}", params)
-    end
-    alias :update :edit
-
-    # Delete a release
-    #
-    # Users with push access to the repository can delete a release.
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.repos.releases.delete 'owner', 'repo', 'id'
-    #
-    def delete(*args)
-      params = arguments(args, required: [:owner, :repo, :id]).params
-
-      delete_request("/repos/#{owner}/#{repo}/releases/#{id}", params)
-    end
-
-  end # Repos::Statuses
-end # Github

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

@@ -1,126 +0,0 @@
-# encoding: utf-8
-
-module Github
-
-  # The Release Assets API
-  class Repos::Releases::Assets < API
-
-    VALID_ASSET_PARAM_NAMES = %w[
-      name
-      label
-      content_type
-    ].freeze # :nodoc:
-
-    # List assets for a release
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.repos.releases.assets.list 'owner', 'repo', 'id'
-    #  github.repos.releases.assets.list 'owner', 'repo', 'id' { |asset| ... }
-    #
-    def list(*args)
-      params = arguments(args, required: [:owner, :repo, :id]).params
-
-      response = get_request("/repos/#{owner}/#{repo}/releases/#{id}/assets", params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all :list
-
-    # Get a single release asset
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.repos.releases.assets.get 'owner', 'repo', 'id'
-    #
-    def get(*args)
-      params = arguments(args, required: [:owner, :repo, :id]).params
-
-      get_request("/repos/#{owner}/#{repo}/releases/assets/#{id}" , params)
-    end
-    alias :find :get
-
-    # Upload a release asset
-    #
-    # = Inputs
-    # * <tt>:name</tt> - Required string - The file name of the asset
-    # * <tt>:content_type</tt> - Required string - The content type
-    #                            of the asset. Example: “application/zip”.
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.repos.releases.assets.upload 'owner', 'repo', 'id', 'file-path'
-    #    "name": "batman.jpg",
-    #    "content_type": "application/octet-stream"
-    #
-    def upload(*args)
-      arguments(args, required: [:owner, :repo, :id, :filepath]) do
-        sift VALID_ASSET_PARAM_NAMES
-      end
-      params = arguments.params
-
-      unless type = params['content_type']
-        type = infer_media(filepath)
-      end
-
-      file = Faraday::UploadIO.new(filepath, type)
-      options = {
-        headers: { content_type: type },
-        endpoint: 'https://uploads.github.com',
-        query: {'name' => params['name']}
-      }
-      params['data']    = file.read
-      params['options'] = options
-
-      post_request("/repos/#{owner}/#{repo}/releases/#{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
-    #
-    # = Inputs
-    # * <tt>:name</tt>  - Required string - the filename of the asset
-    # * <tt>:label</tt> - Optional string - An alternate short description of
-    #                     the asset. Used in place of the filename.
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.repos.releases.assets.edit 'owner', 'repo', 'id',
-    #    "name": "foo-1.0.0-osx.zip",
-    #    "label": "Mac binary"
-    #
-    def edit(*args)
-      arguments(args, required: [:owner, :repo, :id]) do
-        sift VALID_ASSET_PARAM_NAMES
-      end
-      params = arguments.params
-
-      patch_request("/repos/#{owner}/#{repo}/releases/assets/#{id}", params)
-    end
-    alias :update :edit
-
-    # Delete a release asset
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.repos.releases.assets.delete 'owner', 'repo', 'id'
-    #
-    def delete(*args)
-      params = arguments(args, required: [:owner, :repo, :id]).params
-
-      delete_request("/repos/#{owner}/#{repo}/releases/assets/#{id}", params)
-    end
-
-  end # Repos::Statuses
-end # Github

data/lib/github_api/repos/statistics.rb

@@ -1,94 +0,0 @@
-# encoding: utf-8
-
-module Github
-
-  # The Repository Statistics API allows you to fetch the data that GitHub uses
-  # for visualizing different types of repository activity.
-  class Repos::Statistics < API
-
-    # Get contributors list with additions, deletions, and commit counts
-    #
-    # = Examples
-    #
-    #  github = Github.new
-    #  github.repos.stats.contributors user: '...', repo: '...'
-    #  github.repos.stats.contributors user: '...', repo: '...' { |stat| ... }
-    #
-    def contributors(*args)
-      arguments(args, :required => [:user, :repo])
-      params = arguments.params
-
-      response = get_request("/repos/#{user}/#{repo}/stats/contributors", 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
-    #
-    # = Examples
-    #
-    #  github = Github.new
-    #  github.repos.stats.commit_activity user: '...', repo: '...'
-    #  github.repos.stats.commit_activity user: '...', repo: '...' { |stat| ... }
-    #
-    def commit_activity(*args)
-      arguments(args, :required => [:user, :repo])
-      params = arguments.params
-
-      response = get_request("/repos/#{user}/#{repo}/stats/commit_activity", params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-
-    # Get the number of additions and deletions per week
-    #
-    # = Examples
-    #
-    #  github = Github.new
-    #  github.repos.stats.code_frequency user: '...', repo: '...'
-    #  github.repos.stats.code_frequency user: '...', repo: '...' { |stat| ... }
-    #
-    def code_frequency(*args)
-      arguments(args, :required => [:user, :repo])
-      params = arguments.params
-
-      get_request("/repos/#{user}/#{repo}/stats/code_frequency", params)
-    end
-
-    # Get the weekly commit count for the repo owner and everyone else
-    #
-    # = Examples
-    #
-    #  github = Github.new
-    #  github.repos.stats.participation user: '...', repo: '...'
-    #  github.repos.stats.participation user: '...', repo: '...' { |stat| ... }
-    #
-    def participation(*args)
-      arguments(args, :required => [:user, :repo])
-      params = arguments.params
-
-      get_request("/repos/#{user}/#{repo}/stats/participation", params)
-    end
-
-    # Get the number of commits per hour in each day
-    #
-    # = Examples
-    #
-    #  github = Github.new
-    #  github.repos.stats.punch_card user: '...', repo: '...'
-    #  github.repos.stats.punch_card user: '...', repo: '...' { |stat| ... }
-    #
-    def punch_card(*args)
-      arguments(args, :required => [:user, :repo])
-      params = arguments.params
-
-      response = get_request("/repos/#{user}/#{repo}/stats/punch_card", params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-
-  end # Repos::Statistics
-end # Github