https://github.com/deanpcmad/vimeorb
Ruby library for interacting with the Vimeo v3.4 API
https://github.com/deanpcmad/vimeorb
Last synced: about 2 months ago
JSON representation
Ruby library for interacting with the Vimeo v3.4 API
- Host: GitHub
- URL: https://github.com/deanpcmad/vimeorb
- Owner: deanpcmad
- License: mit
- Created: 2023-01-08T22:29:35.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-08T22:29:50.000Z (over 2 years ago)
- Last Synced: 2025-03-04T05:21:47.838Z (2 months ago)
- Language: Ruby
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# VimeoRB
**This library is a work in progress**
VimeoRB is a Ruby library for interacting with the Vimeo v3.4 API.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'vimeorb'
```
## Usage
### Set Client Details
Firstly you'll need to set an Access Token.
An Access Token will be an OAuth2 token generated after authentication.
```ruby
@client = Vimeo::Client.new(access_token: "")
```
### Videos
```ruby
# Retrieve a Video's details
@client.videos.retrieve(id: "abc123")
# Edit a Video
params = {title: "New Title"}
@client.videos.edit(id: "abc123", params)
# Delete a Video
@client.videos.delete(id: "abc123")
# Upload a Video using resumable uploads
# This splits the file into 128MB chunks while uploading
@client.videos.upload(file: File.new("my_video.mp4"))
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/vimeorb.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).