Class: Github::Client::Projects::Cards

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

Constant Summary collapse

REQUIRED_MOVE_CARD_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 card for a column

Examples:

github = Github.new
github.projects.cards.create :column_id, note: 'Card Note'
github = Github.new
github.projects.cards.create :column_id, content_id: <content-id>, content_type: 'content-type'

Parameters:

See Also:


75
76
77
78
79
80
81
82
# File 'lib/github_api/client/projects/cards.rb', line 75

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

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

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

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

Delete a project card

Examples:

github = Github.new
github.projects.cards.delete :card_id

See Also:


118
119
120
121
122
123
124
125
# File 'lib/github_api/client/projects/cards.rb', line 118

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

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

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

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

Get a project card

Examples:

github = Github.new
github.projects.cards.get :card_id

See Also:


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

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

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

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

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

List project cards for a column

Examples:

github = Github.new
github.projects.cards.list :column_id

See Also:


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

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

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

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

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

#move(*args) ⇒ Object

Move a project card

Examples:

github = Github.new
github.projects.cards.move :card_id, position: 'bottom'
github = Github.new
github.projects.cards.move :card_id, position: 'after:<card-id>', column_id: <column-id>

Parameters:

See Also:


147
148
149
150
151
152
153
154
155
156
# File 'lib/github_api/client/projects/cards.rb', line 147

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

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

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

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

Update a project card

Examples:

github = Github.new
github.projects.cards.update :card_id, note: 'New card note'

Parameters:

See Also:


99
100
101
102
103
104
105
106
# File 'lib/github_api/client/projects/cards.rb', line 99

def update(*args)
  arguments(args, required: [:card_id])
  params = arguments.params

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

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