backlog-api - npm Package Compare versions

Comparing version 0.3.0 to 0.5.0

package.json

 {
   "name": "backlog-api",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Backlog API wrapper for Node.js",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -6,2 +6,14 @@ backlog-api
 
+    var backlogApi = require('backlog-api');
+    
+    var backlog = backlogApi('space', 'user', 'pass');
+    
+    backlog.findIssue({
+      projectId: 1,
+      statusId: [1, 2, 3],
+    }, function(err, issues) {
+      console.log(issues);
+    });
+
+
 Installation
@@ -12,18 +24,43 @@ ------------------------------------------------------------------------------
 
+
 Example
 ------------------------------------------------------------------------------
 
+    // show 'BAPI' project, 'bouzuya' user, 'imcomplete' issues.
     var backlogApi = require('backlog-api');
     
-    var backlog = backlogApi('space', 'user', 'pass');
+    // set env
+    // process.env.BACKLOG_SPACE_ID
+    // process.env.BACKLOG_USERNAME
+    // process.env.BACKLOG_PASSWORD
+    var backlog = backlogApi();
+    
+    // get project id 
     backlog.getProjects(function(err, projects) {
-      console.log(projects);
+      if (err) throw err;
+      var projectId = projects.filter(function(p) {
+        return p.key === 'BAPI';
+      })[0].id;
+      
+      // get user id
+      backlog.getUsers({
+        projectId: projectId
+      }, function(err, users) {
+        if (err) throw err;
+        var userId = users.filter(function(u) {
+          return u.name === 'bouzuya'
+        })[0].id;
+        
+        // get issues
+        backlog.findIssue({
+          projectId: projectId,
+          assignerId: userId,
+          statusId: [1, 2, 3]
+        }, function(err, issues) {
+          console.log(issues);
+        });
+      });
     });
-    backlog.findIssue({
-      projectId: 1,
-      statusId: [1, 2, 3],
-    }, function(err, issues) {
-      console.log(issues);
-    });
 
+
 Todo
@@ -45,5 +82,2 @@ ------------------------------------------------------------------------------
 - deleteComponent
-- getTimeline
-- getProjectSummaries
-- getUser
 - getUserIcon
@@ -50,0 +84,0 @@ - getActivityTypes

New alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

36159

27.32%

Number of package files

33

22.22%

Lines of code

1045

22.37%

Number of lines in readme file

103

49.28%

Number of medium supply chain risk alerts

0

-100%

No dependency changes