Class: Github::Client::Projects
- Defined in:
- lib/github_api2/client/projects.rb
Overview
Projects API
Defined Under Namespace
Constant Summary collapse
- PREVIEW_MEDIA =
:nodoc:
"application/vnd.github.inertia-preview+json"
Constants included from MimeType
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
Instance Method Summary collapse
-
#delete(*args) ⇒ Object
(also: #remove)
Delete a project.
-
#edit(*args) ⇒ Object
Edit a project.
-
#get(*args) ⇒ Object
(also: #find)
Get properties for a single project.
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
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
#delete(*args) ⇒ Object Also known as: remove
Delete a project
73 74 75 76 77 78 79 80 |
# File 'lib/github_api2/client/projects.rb', line 73 def delete(*args) arguments(args, required: [:id]) params = arguments.params params["accept"] ||= PREVIEW_MEDIA delete_request("/projects/#{arguments.id}", arguments.params) end |
#edit(*args) ⇒ Object
Edit a project
57 58 59 60 61 62 63 64 |
# File 'lib/github_api2/client/projects.rb', line 57 def edit(*args) arguments(args, required: [:id]) params = arguments.params params["accept"] ||= PREVIEW_MEDIA patch_request("/projects/#{arguments.id}", params) end |
#get(*args) ⇒ Object Also known as: find
Get properties for a single project
30 31 32 33 34 35 36 37 |
# File 'lib/github_api2/client/projects.rb', line 30 def get(*args) arguments(args, required: [:id]) params = arguments.params params["accept"] ||= PREVIEW_MEDIA get_request("/projects/#{arguments.id}", params) end |