-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add the rest of the API client (#19)
- Loading branch information
Showing
23 changed files
with
1,333 additions
and
1,304 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -188,4 +188,4 @@ Procfile text | |
|
|
||
| ## EXECUTABLES | ||
| *.exe binary | ||
| *.pyc binary | ||
| *.pyc binary | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,28 +1,20 @@ | ||
| # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node | ||
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions | ||
|
|
||
| name: Build | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ master ] | ||
| pull_request: | ||
| branches: [ master ] | ||
| on: [push, pull_request] | ||
|
|
||
| jobs: | ||
| build: | ||
|
|
||
| runs-on: ubuntu-latest | ||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| strategy: | ||
| matrix: | ||
| node-version: [10.x, 12.x, 14.x] | ||
| strategy: | ||
| matrix: | ||
| node-version: [14.x, 16.x] | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: Use Node.js ${{ matrix.node-version }} | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: ${{ matrix.node-version }} | ||
| - run: yarn | ||
| - run: yarn build | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - name: Use Node.js ${{ matrix.node-version }} | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: ${{ matrix.node-version }} | ||
| - run: yarn | ||
| - run: yarn build |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| language: node_js | ||
| sudo: false | ||
| node_js: | ||
| - 'lts/*' | ||
| - 'lts/*' | ||
| install: | ||
| - yarn | ||
| - yarn | ||
| script: | ||
| - yarn build | ||
| - yarn build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,4 +8,4 @@ | |
| "issueSettings": { | ||
| "minSeverityLevel": "LOW" | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,199 @@ | ||
| # TypeScript API for last.fm | ||
| [](https://github.com/scriptex/lastfm-ts-api/actions?query=workflow%3ABuild) | ||
| [](https://www.codacy.com/gh/scriptex/lastfm-ts-api/dashboard?utm_source=github.com&utm_medium=referral&utm_content=scriptex/lastfm-ts-api&utm_campaign=Badge_Grade) | ||
| [](https://codebeat.co/projects/github-com-scriptex-lastfm-ts-api-master) | ||
| [](https://www.codefactor.io/repository/github/scriptex/lastfm-ts-api) | ||
| [](https://deepscan.io/dashboard#view=project&tid=3574&pid=5257&bid=40799) | ||
| [](https://github.com/scriptex/lastfm-ts-api/) | ||
|
|
||
| > A Last.FM API written in TypeScript | ||
| # Last.FM TypeScript API Client | ||
|
|
||
| ## Installation, usage, etc. | ||
| > A API client for the Last.FM API written in TypeScript | ||
| TODO | ||
| See the [Last.FM API](https://www.last.fm/api) for information about the Last.Fm API, including details on how to register an account and get your API key, shared secret, and session key. | ||
|
|
||
| ## Support this project | ||
| ## Visitor stats | ||
|
|
||
| [](https://twitter.com/intent/tweet?text=Checkout%20this%20awesome%20software%20project%3A&url=https%3A%2F%2Fgithub.com%2Fscriptex%2Fatanas.info&via=scriptexbg&hashtags=software%2Cgithub%2Ccode%2Cawesome) | ||
| [](https://www.paypal.me/scriptex) | ||
| [](https://www.patreon.com/atanas) | ||
| [](https://ko-fi.com/scriptex) | ||
| [](https://liberapay.com/scriptex/) | ||
| [](https://issuehunt.io/r/scriptex/atanas.info) | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ## Code stats | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ## Installation | ||
|
|
||
| ```sh | ||
| npm install lastfm-ts-api | ||
|
|
||
| # or | ||
|
|
||
| yarn add lastfm-ts-api | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| `lastfm-ts-api` exposes several classes which interact with different parts of the Last.FM API. These classes can be used to interact with the corresponding parts of the Last.FM API. First, you must instantiate these classes with arguments containing the details of your API account. `apiKey` is required, however since many endpoints of the API do not require authentication, `secret` and `sessionKey` are optional. | ||
|
|
||
| ```js | ||
| // To interact with the Album API: | ||
| import { LastFMAlbum } from 'lastfm-ts-api'; | ||
|
|
||
| const album = new LastFMAlbum('API_KEY', 'SECRET', 'SESSION_KEY'); | ||
|
|
||
| // To interact with the Artist API: | ||
| import { LastFMArtist } from 'lastfm-ts-api'; | ||
|
|
||
| const artist = new LastFMArtist('API_KEY', 'SECRET', 'SESSION_KEY'); | ||
|
|
||
| // To interact with the Auth API: | ||
| import { LastFMAuth } from 'lastfm-ts-api'; | ||
|
|
||
| const auth = new LastFMAuth('API_KEY', 'SECRET', 'SESSION_KEY'); | ||
|
|
||
| // To interact with the Chart API: | ||
| import { LastFMChart } from 'lastfm-ts-api'; | ||
|
|
||
| const chart = new LastFMChart('API_KEY', 'SECRET', 'SESSION_KEY'); | ||
|
|
||
| // To interact with the Geo API: | ||
| import { LastFMGeo } from 'lastfm-ts-api'; | ||
|
|
||
| const geo = new LastFMGeo('API_KEY', 'SECRET', 'SESSION_KEY'); | ||
|
|
||
| // To interact with the Library API: | ||
| import { LastFMLibrary } from 'lastfm-ts-api'; | ||
|
|
||
| const library = new LastFMLibrary('API_KEY', 'SECRET', 'SESSION_KEY'); | ||
|
|
||
| // To interact with the Tag API: | ||
| import { LastFMTag } from 'lastfm-ts-api'; | ||
|
|
||
| const tag = new LastFMTag('API_KEY', 'SECRET', 'SESSION_KEY'); | ||
|
|
||
| // To interact with the Track API: | ||
| import { LastFMTrack } from 'lastfm-ts-api'; | ||
|
|
||
| const track = new LastFMTrack('API_KEY', 'SECRET', 'SESSION_KEY'); | ||
|
|
||
| // To interact with the User API: | ||
| import { LastFMUser } from 'lastfm-ts-api'; | ||
|
|
||
| const user = new LastFMUser('API_KEY', 'SECRET', 'SESSION_KEY'); | ||
| ``` | ||
|
|
||
| ## Making Requests | ||
|
|
||
| Each of the Last.FM classes contains methods which directly correspond to the Last.FM API methods. | ||
| For example, endpoint `User.getRecentTracks` is accessed as `user.getRecentTracks()` (after instantiating the class as described above). | ||
|
|
||
| Parameters can be passed to the API through the `params` argument as an object that will be sent directly with the request, either as a query for a GET request, or a body for a POST request. The property names will not be transformed or abstracted, and so they must match the endpoint parameters exactly. This is where the TypeScript definitions play significant role - they get picked up by the IDE automatically so you don't need to worry about including/importing them. | ||
|
|
||
| ```js | ||
| user.getRecentTracks({ | ||
| user: 'USER' | ||
| }); | ||
| ``` | ||
|
|
||
| ## LICENSE | ||
|
|
||
| MIT | ||
|
|
||
| --- | ||
|
|
||
| <div align="center"> | ||
| Connect with me: | ||
| </div> | ||
|
|
||
| <br /> | ||
|
|
||
| <div align="center"> | ||
| <a href="https://atanas.info"> | ||
| <img src="https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/logo.svg" height="20" alt=""> | ||
| </a> | ||
| | ||
| <a href="mailto:[email protected]"> | ||
| <img src="https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/email.svg" height="20" alt=""> | ||
| </a> | ||
| | ||
| <a href="https://www.linkedin.com/in/scriptex/"> | ||
| <img src="https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/linkedin.svg" height="20" alt=""> | ||
| </a> | ||
| | ||
| <a href="https://github.com/scriptex"> | ||
| <img src="https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/github.svg" height="20" alt=""> | ||
| </a> | ||
| | ||
| <a href="https://gitlab.com/scriptex"> | ||
| <img src="https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/gitlab.svg" height="20" alt=""> | ||
| </a> | ||
| | ||
| <a href="https://twitter.com/scriptexbg"> | ||
| <img src="https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/twitter.svg" height="20" alt=""> | ||
| </a> | ||
| | ||
| <a href="https://www.npmjs.com/~scriptex"> | ||
| <img src="https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/npm.svg" height="20" alt=""> | ||
| </a> | ||
| | ||
| <a href="https://www.youtube.com/user/scriptex"> | ||
| <img src="https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/youtube.svg" height="20" alt=""> | ||
| </a> | ||
| | ||
| <a href="https://stackoverflow.com/users/4140082/atanas-atanasov"> | ||
| <img src="https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/stackoverflow.svg" height="20" alt=""> | ||
| </a> | ||
| | ||
| <a href="https://codepen.io/scriptex/"> | ||
| <img src="https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/codepen.svg" width="20" alt=""> | ||
| </a> | ||
| | ||
| <a href="https://profile.codersrank.io/user/scriptex"> | ||
| <img src="https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/codersrank.svg" height="20" alt=""> | ||
| </a> | ||
| | ||
| <a href="https://linktr.ee/scriptex"> | ||
| <img src="https://raw.githubusercontent.com/scriptex/socials/master/styled-assets/linktree.svg" height="20" alt=""> | ||
| </a> | ||
| </div> | ||
|
|
||
| --- | ||
|
|
||
| <div align="center"> | ||
| Support and sponsor my work: | ||
| <br /> | ||
| <br /> | ||
| <a href="https://twitter.com/intent/tweet?text=Checkout%20this%20awesome%20developer%20profile%3A&url=https%3A%2F%2Fgithub.com%2Fscriptex&via=scriptexbg&hashtags=software%2Cgithub%2Ccode%2Cawesome" title="Tweet"> | ||
| <img src="https://img.shields.io/badge/Tweet-Share_my_profile-blue.svg?logo=twitter&color=38A1F3" /> | ||
| </a> | ||
| <a href="https://paypal.me/scriptex" title="Donate on Paypal"> | ||
| <img src="https://img.shields.io/badge/Donate-Support_me_on_PayPal-blue.svg?logo=paypal&color=222d65" /> | ||
| </a> | ||
| <a href="https://revolut.me/scriptex" title="Donate on Revolut"> | ||
| <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/revolut.json" /> | ||
| </a> | ||
| <a href="https://patreon.com/atanas" title="Become a Patron"> | ||
| <img src="https://img.shields.io/badge/Become_Patron-Support_me_on_Patreon-blue.svg?logo=patreon&color=e64413" /> | ||
| </a> | ||
| <a href="https://ko-fi.com/scriptex" title="Buy Me A Coffee"> | ||
| <img src="https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellow.svg?logo=ko-fi" /> | ||
| </a> | ||
| <a href="https://liberapay.com/scriptex/donate" title="Donate on Liberapay"> | ||
| <img src="https://img.shields.io/liberapay/receives/scriptex?label=Donate%20on%20Liberapay&logo=liberapay" /> | ||
| </a> | ||
|
|
||
| <a href="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/bitcoin.json" title="Donate Bitcoin"> | ||
| <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/bitcoin.json" /> | ||
| </a> | ||
| <a href="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/etherium.json" title="Donate Etherium"> | ||
| <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/etherium.json" /> | ||
| </a> | ||
| <a href="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/shiba-inu.json" title="Donate Shiba Inu"> | ||
| <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/scriptex/scriptex/master/badges/shiba-inu.json" /> | ||
| </a> | ||
| </div> |
Oops, something went wrong.