Class: Github::Client::Projects::Columns

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/client/projects/columns.rb

Constant Summary collapse

REQUIRED_COLUMN_PARAMS = 
%w(name).freeze
REQUIRED_MOVE_COLUMN_PARAMS = 
%w(position).freeze

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Constants included from Github::Constants

Github::Constants::ACCEPT, Github::Constants::ACCEPTED_OAUTH_SCOPES, Github::Constants::ACCEPT_CHARSET, Github::Constants::CACHE_CONTROL, Github::Constants::CONTENT_LENGTH, Github::Constants::CONTENT_TYPE, Github::Constants::DATE, Github::Constants::ETAG, Github::Constants::HEADER_LAST, Github::Constants::HEADER_LINK, Github::Constants::HEADER_NEXT, Github::Constants::LOCATION, Github::Constants::META_FIRST, Github::Constants::META_LAST, Github::Constants::META_NEXT, Github::Constants::META_PREV, Github::Constants::META_REL, Github::Constants::OAUTH_SCOPES, Github::Constants::PARAM_PAGE, Github::Constants::PARAM_PER_PAGE, Github::Constants::PARAM_START_PAGE, Github::Constants::RATELIMIT_LIMIT, Github::Constants::RATELIMIT_REMAINING, Github::Constants::RATELIMIT_RESET, Github::Constants::SERVER, Github::Constants::USER_AGENT

Instance Attribute Summary

Attributes inherited from API

#current_options

Instance Method Summary collapse

Methods inherited from API

after_callbacks, after_request, #api_methods_in, #arguments, before_callbacks, before_request, clear_request_methods!, #disable_redirects, #execute, extend_with_actions, extra_methods, #extract_basic_auth, extract_class_name, #filter_callbacks, inherited, #initialize, internal_methods, method_added, #method_missing, #module_methods_in, namespace, request_methods, require_all, #respond_to?, root!, #run_callbacks, #set, #yield_or_eval

Methods included from Request::Verbs

#delete_request, #get_request, #head_request, #options_request, #patch_request, #post_request, #put_request

Methods included from RateLimit

#ratelimit, #ratelimit_remaining, #ratelimit_reset

Methods included from MimeType

#lookup_media, #parse

Methods included from Authorization

#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token

Constructor Details

This class inherits a constructor from Github::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Github::API

Instance Method Details

#create(*args) ⇒ Object

Create a project column

Examples:

github = Github.new
github.projects.columns.create :project_id, name: 'column-name'

Parameters:

See Also:



65
66
67
68
69
70
71
72
73
74
 
# File 'lib/github_api/client/projects/columns.rb', line 65

def create(*args)
  arguments(args, required: [:project_id]) do
    assert_required REQUIRED_COLUMN_PARAMS
  end
  params = arguments.params

  params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA

  post_request("/projects/#{arguments.project_id}/columns", params)
end

#delete(*args) ⇒ Object Also known as: remove

Delete a project column

Examples:

github = Github.new
github.projects.columns.delete :column_id

See Also:



110
111
112
113
114
115
116
117
 
# File 'lib/github_api/client/projects/columns.rb', line 110

def delete(*args)
  arguments(args, required: [:column_id])
  params = arguments.params

  params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA

  delete_request("/projects/columns/#{arguments.column_id}", params)
end

#get(*args) ⇒ Object Also known as: find

Get a project columns

Examples:

github = Github.new
github.projects.columns.get :column_id

See Also:



42
43
44
45
46
47
48
49
 
# File 'lib/github_api/client/projects/columns.rb', line 42

def get(*args)
  arguments(args, required: [:column_id])
  params = arguments.params

  params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA

  get_request("/projects/columns/#{arguments.column_id}", params)
end

#list(*args) ⇒ Object Also known as: all

List a project’s columns

Examples:

github = Github.new
github.projects.columns.list :project_id

See Also:



20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/github_api/client/projects/columns.rb', line 20

def list(*args)
  arguments(args, required: [:project_id])
  params = arguments.params

  params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA

  response = get_request("/projects/#{arguments.project_id}/columns", params)

  return response unless block_given?
  response.each { |el| yield el }
end

#move(*args) ⇒ Object

Move a project column

Examples:

github = Github.new
github.projects.columns.move :column_id, position: 'first'

Parameters:

See Also:



135
136
137
138
139
140
141
142
143
144
 
# File 'lib/github_api/client/projects/columns.rb', line 135

def move(*args)
  arguments(args, required: [:column_id]) do
    assert_required REQUIRED_MOVE_COLUMN_PARAMS
  end
  params = arguments.params

  params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA

  post_request("/projects/columns/#{arguments.column_id}/moves", params)
end

#update(*args) ⇒ Object Also known as: edit

Update a project column

Examples:

github = Github.new
github.repos.projects.update :column_id, name: 'new-column-name'

Parameters:

See Also:



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/github_api/client/projects/columns.rb', line 89

def update(*args)
  arguments(args, required: [:column_id]) do
    assert_required REQUIRED_COLUMN_PARAMS
  end
  params = arguments.params

  params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA

  patch_request("/projects/columns/#{arguments.column_id}", params)
end