github_api 0.11.3 → 0.12.0

data/lib/github_api/issues/milestones.rb

@@ -1,125 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class Issues::Milestones < API
-
-    VALID_MILESTONE_OPTIONS = {
-     'state' => %w[ open closed ],
-     'sort'  => %w[ due_date completeness ],
-     'direction' => %w[ desc asc ]
-    }.freeze # :nodoc:
-
-    VALID_MILESTONE_INPUTS = %w[
-      title
-      state
-      description
-      due_on
-    ].freeze # :nodoc:
-
-    # List milestones for a repository
-    #
-    # = Parameters
-    # <tt>:state</tt> - <tt>open</tt>, <tt>closed</tt>, default: <tt>open</tt>
-    # <tt>:sort</tt> - <tt>due_date</tt>, <tt>completeness</tt>, default: <tt>due_date</tt>
-    # <tt>:direction</tt> - <tt>asc</tt>, <tt>desc</tt>, default: <tt>desc</tt>
-    #
-    # = Examples
-    #  github = Github.new user: 'user-name', repo: 'repo-name'
-    #  github.issues.milestones.list
-    #
-    #  or
-    #
-    #  github.issues.milestones.list state: 'open', sort: 'due_date',
-    #    direction: 'asc'
-    #
-    def list(*args)
-      arguments(args, :required => [:user, :repo]) do
-        sift VALID_MILESTONE_OPTIONS.keys
-        assert_values VALID_MILESTONE_OPTIONS
-      end
-      params = arguments.params
-
-      response = get_request("/repos/#{user}/#{repo}/milestones", params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all :list
-
-    # Get a single milestone
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.issues.milestones.get 'user-name', 'repo-name', 'milestone-id'
-    #
-    def get(*args)
-      arguments(args, :required => [:user, :repo, :milestone_id])
-      params = arguments.params
-
-      get_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
-    end
-    alias :find :get
-
-    # Create a milestone
-    #
-    # = Inputs
-    #  <tt>:title</tt> - Required string
-    #  <tt>:state</tt> - Optional string - <tt>open</tt> or <tt>closed</tt>
-    #  <tt>:description</tt> - Optional string
-    #  <tt>:due_on</tt> - Optional string - ISO 8601 time
-    #
-    # = Examples
-    #  github = Github.new :user => 'user-name', :repo => 'repo-name'
-    #  github.issues.milestones.create :title => 'hello-world',
-    #    :state => "open or closed",
-    #    :description => "String",
-    #    :due_on => "Time"
-    #
-    def create(*args)
-      arguments(args, :required => [:user, :repo]) do
-        sift VALID_MILESTONE_INPUTS
-        assert_required %w[ title ]
-      end
-
-      post_request("/repos/#{user}/#{repo}/milestones", arguments.params)
-    end
-
-    # Update a milestone
-    #
-    # = Inputs
-    #  <tt>:title</tt> - Required string
-    #  <tt>:state</tt> - Optional string - <tt>open</tt> or <tt>closed</tt>
-    #  <tt>:description</tt> - Optional string
-    #  <tt>:due_on</tt> - Optional string - ISO 8601 time
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.issues.milestones.update 'user-name', 'repo-name', 'milestone-id',
-    #    :title => 'hello-world',
-    #    :state => "open or closed",
-    #    :description => "String",
-    #    :due_on => "Time"
-    #
-    def update(*args)
-      arguments(args, :required => [:user, :repo, :milestone_id]) do
-        sift VALID_MILESTONE_INPUTS
-      end
-      params = arguments.params
-
-      patch_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
-    end
-
-    # Delete a milestone
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.issues.milestones.delete 'user-name', 'repo-name', 'milestone-id'
-    #
-    def delete(*args)
-      arguments(args, :required => [:user, :repo, :milestone_id])
-      params = arguments.params
-
-      delete_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
-    end
-
-  end # Issues::Milestones
-end # Github

data/lib/github_api/markdown.rb

@@ -1,60 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class Markdown < API
-
-    # Render an arbritrary Markdown document
-    #
-    # = Parameters
-    #  <tt>:text</tt> - Required string - The Markdown text to render
-    #  <tt>:mode<tt> - Optional string - The rendering mode
-    #    * <tt>markdown</tt> to render a document as plain Markdown, just
-    #                        like README files are rendered.
-    #    * <tt>gfm</tt> to render a document as user-content, e.g. like user
-    #      comments or issues are rendered. In GFM mode, hard line breaks are
-    #      always taken into account, and issue and user mentions are
-    #      linked accordingly.
-    #  <tt>:context<tt> - Optional string - The repository context, only taken
-    #                     into account when rendering as <tt>gfm</tt>
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.markdown.render
-    #    "text": "Hello world github/linguist#1 **cool**, and #1!",
-    #    "mode": "gfm",
-    #    "context": "github/gollum"
-    #
-    def render(*args)
-      arguments(args) do
-        assert_required ['text']
-      end
-      params = arguments.params
-      params['raw'] = true
-
-      post_request("markdown", arguments.params)
-    end
-
-    # Render a Markdown document in raw mode
-    #
-    # = Input
-    #  The raw API it not JSON-based. It takes a Markdown document as plaintext
-    #  <tt>text/plain</tt> or <tt>text/x-markdown</tt> and renders it as plain
-    #  Markdown without a repository context (just like a README.md file is
-    #  rendered – this is the simplest way to preview a readme online)
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.markdown.render_raw "Hello github/linguist#1 **cool**, and #1!",
-    #    "accept": "text/plain",
-    #
-    def render_raw(*args)
-      params = arguments(args).params
-      mime_type, params['data'] = params['mime'], args.shift
-      params['raw'] = true
-      params['accept'] = params.fetch('accept') { 'text/plain' }
-
-      post_request("markdown/raw", params)
-    end
-
-  end # Markdown
-end # Github

data/lib/github_api/meta.rb

@@ -1,19 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class Meta < API
-
-    # Get meta information about GitHub.com, the service.
-    #
-    # = Examples
-    #
-    #   Github.meta.get
-    #
-    def get(*args)
-      arguments(*args)
-
-      get_request("/meta", arguments.params)
-    end
-
-  end # Meta
-end # Github

data/lib/github_api/orgs.rb

@@ -1,94 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class Orgs < API
-
-    Github::require_all 'github_api/orgs',
-      'members',
-      'teams'
-
-    VALID_ORG_PARAM_NAMES = %w[
-      billing_email
-      company
-      email
-      location
-      name
-    ].freeze
-
-    # Access to Orgs::Members API
-    def members(options={}, &block)
-      @members ||= ApiFactory.new('Orgs::Members', current_options.merge(options), &block)
-    end
-
-    # Access to Orgs::Teams API
-    def teams(options={}, &block)
-      @teams ||= ApiFactory.new('Orgs::Teams', current_options.merge(options), &block)
-    end
-
-    # List all public organizations for a user.
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.orgs.list user: 'user-name'
-    #
-    # List public and private organizations for the authenticated user.
-    #
-    #  github = Github.new oauth_token: '..'
-    #  github.orgs.list
-    #
-    def list(*args)
-      params = arguments(args).params
-
-      response = if (user_name = params.delete("user"))
-        get_request("/users/#{user_name}/orgs", params)
-      else
-        # For the authenticated user
-        get_request("/user/orgs", params)
-      end
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all :list
-
-    # Get properties for a single organization
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.orgs.get 'github'
-    #
-    def get(*args)
-      arguments(args, :required => [:org_name])
-
-      get_request("/orgs/#{org_name}", arguments.params)
-    end
-    alias :find :get
-
-    # Edit organization
-    #
-    # = Parameters
-    # <tt>:billing_email</tt> - Optional string - Billing email address. This address is not publicized.
-    # <tt>:company</tt> - Optional string
-    # <tt>:email</tt> - Optional string
-    # <tt>:location</tt> - Optional string
-    # <tt>:name</tt> - Optional string
-    #
-    # = Examples
-    #  github = Github.new oauth_token: '...'
-    #  github.orgs.edit 'github',
-    #    "billing_email": "support@github.com",
-    #    "blog": "https://github.com/blog",
-    #    "company": "GitHub",
-    #    "email": "support@github.com",
-    #    "location": "San Francisco",
-    #    "name": "github"
-    #
-    def edit(*args)
-      arguments(args, :required => [:org_name]) do
-        sift VALID_ORG_PARAM_NAMES
-      end
-
-      patch_request("/orgs/#{org_name}", arguments.params)
-    end
-
-  end # Orgs
-end # Github

data/lib/github_api/orgs/members.rb

@@ -1,108 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class Orgs::Members < API
-
-    # List members
-    #
-    # List all users who are members of an organization. A member is a user
-    # that belongs to at least 1 team in the organization.
-    # If the authenticated user is also a member of this organization then
-    # both concealed and public members will be returned.
-    # Otherwise only public members are returned.
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.orgs.members.list 'org-name'
-    #  github.orgs.members.list 'org-name' { |memb| ... }
-    #
-    # List public members
-    #
-    # Members of an organization can choose to have their membership publicized or not.
-    # = Examples
-    #  github = Github.new
-    #  github.orgs.members.list 'org-name', public: true
-    #  github.orgs.members.list 'org-name', public: true { |memb| ... }
-    #
-    def list(*args)
-      params = arguments(args, :required => [:org_name]).params
-
-      response = if params.delete('public')
-        get_request("/orgs/#{org_name}/public_members", params)
-      else
-        get_request("/orgs/#{org_name}/members", params)
-      end
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all :list
-
-    # Check if user is, publicly or privately, a member of an organization
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.orgs.members.member? 'org-name', 'member-name'
-    #
-    # Check if a user is a public member of an organization
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.orgs.members.member? 'org-name', 'member-name', :public => true
-    #
-    def member?(*args)
-      params = arguments(args, :required => [:org_name, :user]).params
-
-      response = if params.delete('public')
-        get_request("/orgs/#{org_name}/public_members/#{user}", params)
-      else
-        get_request("/orgs/#{org_name}/members/#{user}", params)
-      end
-      response.status == 204
-    rescue Github::Error::NotFound
-      false
-    end
-
-    # Remove a member
-    # Removing a user from this list will remove them from all teams and
-    # they will no longer have any access to the organization’s repositories.
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.orgs.members.remove 'org-name', 'member-name'
-    #
-    def delete(*args)
-      arguments(args, :required => [:org_name, :user])
-
-      delete_request("/orgs/#{org_name}/members/#{user}", arguments.params)
-    end
-    alias :remove :delete
-
-    # Publicize a user’s membership
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.members.publicize 'org-name', 'member-name'
-    #
-    def publicize(*args)
-      arguments(args, :required => [:org_name, :user])
-
-      put_request("/orgs/#{org_name}/public_members/#{user}", arguments.params)
-    end
-    alias :make_public :publicize
-    alias :publicize_membership :publicize
-
-    # Conceal a user’s membership
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.members.conceal 'org-name', 'member-name'
-    #
-    def conceal(*args)
-      arguments(args, :required => [:org_name, :user])
-
-      delete_request("/orgs/#{org_name}/public_members/#{user}", arguments.params)
-    end
-    alias :conceal_membership :conceal
-
-  end # Orgs::Members
-end # Github

data/lib/github_api/orgs/teams.rb

@@ -1,243 +0,0 @@
-# encoding: utf-8
-
-module Github
-  class Orgs::Teams < API
-    # All actions against teams require at a minimum an authenticated user
-    # who is a member of the owner’s team in the :org being managed.
-    # Api calls that require explicit permissions are noted.
-
-    VALID_TEAM_PARAM_NAMES = %w[ name repo_names permission ].freeze
-    VALID_TEAM_PARAM_VALUES = {
-      'permission' => %w[ pull push admin ].freeze
-    }
-
-    # List teams
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.list 'org-name'
-    #
-    def list(*args)
-      arguments(args, :required => [:org_name])
-
-      response = get_request("/orgs/#{org_name}/teams", arguments.params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all :list
-
-    # Get a team
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.get 'team-id'
-    #
-    def get(*args)
-      arguments(args, :required => [:team_id])
-
-      get_request("/teams/#{team_id}", arguments.params)
-    end
-    alias :find :get
-
-    # Create a team
-    #
-    # In order to create a team, the authenticated user must be an owner of<tt>:org</tt>.
-    # = Inputs
-    #  <tt>:name</tt> - Required string
-    #  <tt>:repo_names</tt> - Optional array of strings
-    #  <tt>:permission</tt> - Optional string
-    #    * <tt>pull</tt> - team members can pull, but not push or administor this repositories. Default
-    #    * <tt>push</tt> - team members can pull and push, but not administor this repositores.
-    #    * <tt>admin</tt> - team members can pull, push and administor these repositories.
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.create 'org-name',
-    #    "name" => "new team",
-    #    "permission" => "push",
-    #    "repo_names" => [
-    #      "github/dotfiles"
-    #     ]
-    #
-    def create(*args)
-      arguments(args, :required => [:org_name]) do
-        sift VALID_TEAM_PARAM_NAMES
-        assert_values VALID_TEAM_PARAM_VALUES
-        assert_required %w[name]
-      end
-
-      post_request("/orgs/#{org_name}/teams", arguments.params)
-    end
-
-    # Edit a team
-    # In order to edit a team, the authenticated user must be an owner of the org that the team is associated with.
-    #
-    # = Inputs
-    #  <tt>:name</tt> - Required string
-    #  <tt>:permission</tt> - Optional string
-    #    * <tt>pull</tt> - team members can pull, but not push or administor this repositories. Default
-    #    * <tt>push</tt> - team members can pull and push, but not administor this repositores.
-    #    * <tt>admin</tt> - team members can pull, push and administor these repositories.
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.edit 'team-id',
-    #    "name" => "new team name",
-    #    "permission" => "push"
-    #
-    def edit(*args)
-      arguments(args, :required => [:team_id]) do
-        sift VALID_TEAM_PARAM_NAMES
-        assert_values VALID_TEAM_PARAM_VALUES
-        assert_required %w[name]
-      end
-
-      patch_request("/teams/#{team_id}", arguments.params)
-    end
-
-    # Delete a team
-    # In order to delete a team, the authenticated user must be an owner of the org that the team is associated with
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.delete 'team-id'
-    #
-    def delete(*args)
-      arguments(args, :required => [:team_id])
-
-      delete_request("/teams/#{team_id}", arguments.params)
-    end
-    alias :remove :delete
-
-    # List team members
-    # In order to list members in a team, the authenticated user must be a member of the team.
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.list_members 'team-id'
-    #  github.orgs.teams.list_members 'team-id' { |member| ... }
-    #
-    def list_members(*args)
-      arguments(args, :required => [:team_id])
-
-      response = get_request("/teams/#{team_id}/members", arguments.params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all_members :list_members
-
-    # Check if a user is a member of a team
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.team_member? 'team-id', 'user-name'
-    #
-    def team_member?(*args)
-      arguments(args, :required => [:team_id, :user])
-
-      response = get_request("/teams/#{team_id}/members/#{user}", arguments.params)
-      response.status == 204
-    rescue Github::Error::NotFound
-      false
-    end
-
-    # Add a team member
-    # In order to add a user to a team, the authenticated user must have ‘admin’ permissions to the team or be an owner of the org that the team is associated with.
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.add_member 'team-id', 'user-name'
-    #
-    def add_member(*args)
-      arguments(args, :required => [:team_id, :user])
-
-      put_request("/teams/#{team_id}/members/#{user}", arguments.params)
-    end
-    alias :add_team_member :add_member
-
-    # Remove a team member
-    #
-    # In order to remove a user from a team, the authenticated user must
-    # have ‘admin’ permissions to the team or be an owner of the org that
-    # the team is associated with.
-    # note: This does not delete the user, it just remove them from the team.
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.remove_member 'team-id', 'user-name'
-    #
-    def remove_member(*args)
-      arguments(args, :required => [:team_id, :user])
-
-      delete_request("/teams/#{team_id}/members/#{user}", arguments.params)
-    end
-    alias :remove_team_member :remove_member
-
-    # List team repositories
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.list_repos 'team-id'
-    #
-    def list_repos(*args)
-      arguments(args, :required => [:team_id])
-
-      response = get_request("/teams/#{team_id}/repos", arguments.params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :repos :list_repos
-
-    # Check if a repository belongs to a team
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.team_repo? 'team-id', 'user-name', 'repo-name'
-    #
-    def team_repo?(*args)
-      arguments(args, :required => [:team_id, :user, :repo])
-
-      response = get_request("/teams/#{team_id}/repos/#{user}/#{repo}", arguments.params)
-      response.status == 204
-    rescue Github::Error::NotFound
-      false
-    end
-    alias :team_repository? :team_repo?
-
-    # Add a team repository
-    #
-    # In order to add a repo to a team, the authenticated user must be
-    # an owner of the org that the team is associated with. Also, the repo
-    # must be owned by the organization, or a direct for of a repo owned
-    # by the organization.
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.add_repo 'team-id', 'user-name', 'repo-name'
-    #
-    def add_repo(*args)
-      arguments(args, :required => [:team_id, :user, :repo])
-
-      put_request("/teams/#{team_id}/repos/#{user}/#{repo}", arguments.params)
-    end
-    alias :add_repository :add_repo
-
-    # Remove a team repository
-    #
-    # In order to add a repo to a team, the authenticated user must be
-    # an owner of the org that the team is associated with.
-    # note: This does not delete the repo, it just removes it from the team.
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.remove_repo 'team-id', 'user-name', 'repo-name'
-    #
-    def remove_repo(*args)
-      arguments(args, :required => [:team_id, :user, :repo])
-
-      delete_request("/teams/#{team_id}/repos/#{user}/#{repo}", arguments.params)
-    end
-    alias :remove_repository :remove_repo
-
-  end # Orgs::Teams
-end # Github