Add methods for collections, topics and users (#174)

Co-authored-by: Thomas Turrell-Croft <[email protected]>

.github/workflows/node.js.yml

@@ -28,4 +28,9 @@ jobs:
       - run: npm ci
       - run: npx ng build
       # TODO add linting
-      - run: npx ng test --no-watch --no-progress --browsers=ChromeHeadless
+      - run: npx ng test --no-watch --no-progress --code-coverage --browsers=ChromeHeadless
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

README.md

@@ -106,7 +106,7 @@ function unsplashConfigFactory(userService: UserService) {
 export class AppModule {}
 ```
 
-### List
+### List Photos
 
 Inject the UnsplashService into the constructor of a component.
 
@@ -124,15 +124,15 @@ export class ListComponent {
 
   constructor(private unsplash: UnsplashService) {}
 
-  list() {
-    this.unsplash.list({ perPage: 40 }).subscribe((response) => {
+  photos() {
+    this.unsplash.photos({ perPage: 40 }).subscribe((response) => {
       this.photos = response;
     });
   }
 }
 ```
 
-### Get
+### Get a Photo
 
 Inject the UnsplashService into the constructor of a component.
 
@@ -144,8 +144,8 @@ export class GetComponent {
 
   constructor(private unsplash: UnsplashService) {}
 
-  get(id: string) {
-    this.unsplash.get(id).subscribe((response) => {
+  photo(id: string) {
+    this.unsplash.photo(id).subscribe((response) => {
       this.photo = response;
     });
   }
@@ -174,8 +174,8 @@ export class RandomComponent {
 
   constructor(private unsplash: UnsplashService) {}
 
-  random() {
-    this.unsplash.random({ count: 10 }).subscribe((response) => {
+  randomPhoto() {
+    this.unsplash.randomPhoto({ count: 10 }).subscribe((response) => {
       this.photos = response;
     });
   }
@@ -204,8 +204,8 @@ export class SearchComponent {
 
   constructor(private unsplash: UnsplashService) {}
 
-  search(query: string) {
-    this.unsplash.search(query, { perPage: 10 }).subscribe((response) => {
+  searchPhotos(query: string) {
+    this.unsplash.searchPhotos(query, { perPage: 10 }).subscribe((response) => {
       this.photos = response.results;
     });
   }
@@ -214,14 +214,16 @@ export class SearchComponent {
 
 ### Triggering a download
 
+Inject the UnsplashService into the constructor of a component.
+
 Example:
 
 ```TypeScript
 export class DownloadComponent {
 
 constructor(private unsplash: UnsplashService) {}
 
-  download(photo: Photo) {
+  downloadPhoto(photo: Photo) {
     this.unsplash.download(photo).subscribe();
   }
 }

angular.json

@@ -31,7 +31,8 @@
             "polyfills": [
               "zone.js",
               "zone.js/testing"
-            ]
+            ],
+            "karmaConfig": "projects/ngx-unsplash/karma.conf.js"
           }
         }
       }