階層JSONの子オブジェクトの特定データを取得する(Node.js) - designetwork

function redmineGet(ticketLimit){
  var ticketJson, ticketOffset=0;
  var ticketUrl="<Redmine URL>", ticketKey="<API Access Key>";
  var response = request(
    'GET',
    'http://'+ticketUrl+'/issues.json?status_id=*&limit='+ticketLimit+'&offset='+ticketOffset+'&key='+ticketKey
    );
    if (response.statusCode == 200) {
      //console.log("Redmine : "+response.body);
      ticketJson = JSON.parse(response.body);
      return ticketJson;
    }
}

JSONをparse(解析)するとこのような構造になっている。[Object]になっている部分は記載の通りObjectで、階層が深く、もう一段dumpする必要がある。(ここでは割愛)

また、本方式だとチケットを降順で取得する。

{ issues: 
   [ { id: 101,
       project: [Object],
       tracker: [Object],
       status: [Object],
       priority: [Object],
       author: [Object],
       assigned_to: [Object],
       category: [Object],
       subject: 'Node.jsの記事を投稿する',
       description: '',
       start_date: '2016-11-18',
       done_ratio: 0,
       custom_fields: [Object],
       created_on: '2016-11-18T01:15:59Z',
       updated_on: '2016-11-18T08:56:39Z' },
     { id: 100,
       project: [Object],
       <snip>
       created_on: '2016-11-18T01:10:02Z',
       updated_on: '2016-11-18T06:36:54Z' } ],
  total_count: 101,
  offset: 0,
  limit: 4 }

階層JSONのオブジェクトを取得する

取得した各オブジェクト(=チケット)の情報を取得する。今回対象とするのは、Redmineのカスタムフィールド。

カスタムフィールドはユーザ任意で作れるもので、用途に応じて追加することができる。今回、試験用に「不具合番号」、「要求元」、「システム」という項目を作っている。 JSONの階層構造では以下のようになっている。

{ issues: 
   [ { id: 99,
       subject: 'Node.jsが起動しない',
       <snip>
       custom_fields: { id: 1, name: '不具合番号', value: '634' },
                      { id: 3, name: '要求元', value: '営業' },
                      { id: 4, name: 'システム', value: 'GitHub' },

今回はチケットのうち、「システム」が「HatenaBlog」のものを抽出する。

各項目はカスタムフィールド内のidで管理されている。一般的な使い方として、これらはトラッカーによって表示/非表示を切り替えている。そのため、チケットによって以下の通り項目数(インデックス番号)が変わることになる。

その中で抽出対象に"HatenaBlog ticket!!"を付けている。(ソースコードは後述)

101
'Node.jsの記事を投稿する'

 customFields : 
  index: 0 | id: 4  name: システム  value: HatenaBlog
  HatenaBlog ticket!!

100
'Node.jsでJSONをGETできない'

 customFields : 
  index: 0 | id: 1  name: 不具合番号  value: 635
  index: 1 | id: 3  name: 要求元  value: 保守
  index: 2 | id: 4  name: システム  value: HatenaBlog
  HatenaBlog ticket!!

99
'Node.jsが起動しない'

 customFields : 
  index: 0 | id: 1  name: 不具合番号  value: 634
  index: 1 | id: 3  name: 要求元  value: 営業
  index: 2 | id: 4  name: システム  value: GitHub

98
'Node.jsで階層JSONから特定オブジェクトを取り出す'

 customFields : 
  index: 0 | id: 3  name: 要求元  value: 営業
  index: 1 | id: 4  name: システム  value: Redmine

ネストされたJSONの中で、変動するインデックス番号を追従するために考慮が必要になる。

今回は、シンプルで愚直な考え方だが、オブジェクトの要素数を取得し、要素数分だけforでループする。各indexでif判定することにより、対象を抽出する。

var customFieldsLength, cf=["id", "name", "value"]; //cf:Custom Fields
for(var i=0; i<ticketCount; i++){
  console.log("\n");dump(returnJson["issues"][i]["id"]);dump(returnJson["issues"][i]["subject"]);

  customFieldsLength = returnJson["issues"][i]["custom_fields"].length;
  console.log("\n customFields : ");
  for(var j=0; j<customFieldsLength; j++){
    cf = returnJson["issues"][i]["custom_fields"][j];
    console.log("  index: "+j+" | id: "+cf.id+"  name: "+cf.name+"  value: "+cf.value);
    if((cf.id==4) && (cf.value == "HatenaBlog")){console.log("  HatenaBlog ticket!!");}
  }
}