Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/corylanou/cloud-elements-demo
Sample projects used for a cloud elements project
https://github.com/corylanou/cloud-elements-demo
Last synced: 21 days ago
JSON representation
Sample projects used for a cloud elements project
- Host: GitHub
- URL: https://github.com/corylanou/cloud-elements-demo
- Owner: corylanou
- Created: 2015-02-22T18:50:34.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-03-10T17:26:01.000Z (almost 10 years ago)
- Last Synced: 2023-03-11T18:02:49.949Z (almost 2 years ago)
- Language: Go
- Size: 211 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cloud Elements Demo
The purpose of this project is to show how to leverage Go to consume API's, specifically, in this case, the [Cloud Elements](http://cloud-elements.com/) API.
## Demo
### Seting up Cloud Elements
Write something about how easy this was
### First pass at a basic connection
When using any api, the first thing I like to do is get my basic connection dance down.
I chose a very simple end point for this (`/folders`) to see if I could just list out the files
in my google drive.
Let's take a look at the [code](https://github.com/corylanou/cloud-elements-demo/blob/master/01_connecting/).
*WARNING*: It's UGLY!
### Creating a Library
The [current library](https://github.com/corylanou/cloud-elements) has some limited functionality around the `Folders` endpoint
#### The CloudFiles Library
Current functionality:
```go
type Folders struct {
// contains filtered or unexported fields
}
```
Folders defines all methods to access/manipulate the Folders endpoint
```go
func (f Folders) Contents(folderPath string, provider Provider) (Files, *Error)
```
Contents will retrieve the contents of a folder
```go
func (f Folders) CreateFile(fileInfo File, overwrite bool, reader io.ReadCloser, provider Provider) (*File, *Error)
```
CreateFile will create a file
```go
func (f Folders) CreateFolder(folderPath string, provider Provider) (*File, *Error)
```
CreateFolder will create a folder
```go
func (f Folders) GetFileById(id string, provider Provider) (io.ReadCloser, *Error)
```
GetFile will retrieve the file and return it as a reader
#### Consuming the File Library
[code](https://github.com/corylanou/cloud-elements-demo/blob/master/02_consuming/).
#### Syncing different sources
[code](https://github.com/corylanou/cloud-elements-demo/blob/master/03_sync/).
Using the basic cli, you can sync files from one folder to another on dropbox and google drive.
## Learning Notes
Whenever I use a new API, I always find it helpful to talk about things that I found challenging, and I think others would too.
These points are not meant to put down the API I'm using, but are to be used for me to give feedback, and maybe even contribute
to their system to makie it easier to adopt for future developers. As an open source developer, this type of feedback
is invaluable.
- I wasn't able to find a "quick start" guide. As someone writing an API, this creates a high barrier to entry. This turned out to be due to me working from the consule, which does not provide links to the developer docs.
- I took me a while to find teh base url. It was at the bottom of the API endpoint documentation for a specific endpoint.
- The session timeout of the site is too short. As a developer, you are trying things constantly. I kept getting logged out while I was developing.
- Finding information on how to authorized took quite some time. Most developers are looking for a curl example right away, and it was buried about 6 pages deep.
- Wrong curl example [here](http://cloud-elements.com/developer/full-api-documentation/):
```sh
curl -X POST
-H 'Authorization: Element , User '
-F [email protected]
'https://api.cloud-elements.com/elements/api-v2/hubs/documents/files?path=/test.txt&description=Test%20file&tags%5B%5D=test'
```
Appears we now need the organization as part of the authorization header as well.
No direction on what to post for creating a folder. Error messages were very unclear as to what exactly they needed.
ex: Folder name provided and folder name in path do not match
Another fairly useless message encountered when trying to create a file:
Message:Failed to update file RequestId:54fb5e3de4b06d3806bf3809
Looking at the logs provided no more information.