Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paulmillr/ostio-api
Your open-source talks place. Rails backend.
https://github.com/paulmillr/ostio-api
Last synced: 3 months ago
JSON representation
Your open-source talks place. Rails backend.
- Host: GitHub
- URL: https://github.com/paulmillr/ostio-api
- Owner: paulmillr
- Archived: true
- Created: 2012-05-20T17:45:15.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2022-06-26T15:46:30.000Z (over 2 years ago)
- Last Synced: 2024-08-03T02:09:15.126Z (6 months ago)
- Language: Ruby
- Homepage: http://ost.io
- Size: 138 KB
- Stars: 69
- Watchers: 7
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-open-ror - Ostio - Your open-source talks place. Rails backend. (Dev-help)
README
# Ost.io-api
Your open-source talks place. Backend part.
## Getting started
This is a backend part of [ost.io](http://ost.io/) application.
Ostio api is built with [Rails](http://rubyonrails.org/).
## Deploying
* Copy `nginx.conf` to your nginx dir: `sudo cp nginx.conf /etc/nginx/api.conf`
* Restart nginx: `sudo /etc/init.d/nginx restart`
* Add your GitHub app id / secret to ENV:
```
# This is id / secret of example app. Callback URL for it:
# http://dev.ost.io:3000/auth/github
export GITHUB_APP_ID='b99404045c3917fd6be4'
export GITHUB_APP_SECRET='fedbf022667be7056bcaca9568e55151b219c660'
```
* Restart thin webserver: `sudo killall thin && thin start -C thin.yml`
## API
Current API version is v1. You need to prepend `v1/` to app requests except auth.
* [Users](#users-api)
* [Topics](#repos-api)
* [Repos](#topics-api)
* [Posts](#posts-api)
### Auth
`/auth/github?origin=http://example.com/`
When authenticated, ostio will redirect to your `origin` with params `login` and `accessToken`: `http://example.com?login=paulmillr&accessToken=af952810adbt`
All requests that change state (`POST`, `PUT`, `DELETE`) require authentication. Pass authentication in the `accessToken` query parameter for any requests made to this api.
### Users API
`:username` is a user name user has on GitHub.
#### Get user data
`GET /users/:username`
**Example:** http://api.ost.io/v1/users/paulmillr
#### Delete user
`DELETE /users/:username`
### Repos API
`:repo_name` is a repository name it has on GitHub.
#### List user repos
`GET /users/:username/repos/`
**Example:** http://api.ost.io/v1/users/paulmillr/repos/
#### Sync repos with GitHub
`POST /users/:username/repos/`
#### Get repo data
`GET /users/:username/repos/:repo_name`
**Example:** http://api.ost.io/v1/users/paulmillr/repos/ostio
### Topics API
`:topic_number` is a number, local to current repository.
#### List repo topics
`GET /users/:username/repos/:repo_name/topics/`
**Example:** http://api.ost.io/v1/users/paulmillr/repos/ostio/topics/
#### Create new topic
`POST /users/:username/repos/:repo_name/topics/`
Input:
* **title**: *Required* **string**
#### Get topic data
`GET /users/:username/repos/:repo_name/topics/:topic_number`
**Example:** http://api.ost.io/v1/users/paulmillr/repos/ostio/topics/1
#### Modify topic
`PUT /users/:username/repos/:repo_name/topics/:topic_number`
Input:
* **title**: *Required* **string*&
#### Delete topic
`DELETE /users/:username/repos/:repo_name/topics/:topic_number`
### Posts API
### List topic posts
`GET /users/:username/repos/:repo_name/topics/:topic_number/posts/`
**Example:** http://api.ost.io/v1/users/paulmillr/repos/ostio/topics/1/posts/
#### Create new post
`POST /users/:username/repos/:repo_name/topics/:topic_number/posts/`
Input:
* **text**: *Required* **string*
#### Get post data
`GET /users/:username/repos/:repo_name/topics/:topic_number/posts/:id`
**Example:** http://api.ost.io/v1/users/paulmillr/repos/ostio/topics/1/posts/8
#### Modify post
`PUT /users/:username/repos/:repo_name/topics/:topic_number/posts/:id`
Input:
* **text**: *Required* **string*
#### Delete post
`DELETE /users/:username/repos/:repo_name/topics/:topic_number/posts/:id`
## License
The MIT License (MIT)
Copyright (c) 2012 Paul Miller (http://paulmillr.com/)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.