32.2. カスタム手順による 3scale API Management アプリケーションの解析値の抽出

手順

1. 全アプリケーションのリストを取得する。この操作にはページネーションが必要です。

   def api_call_applications_list(domain, provider_key)
     done = false
     res = Array.new
     page = 1
   
         while !done
       url = "https://#{domain}/admin/api/applications.xml?provider_key=#{provider_key}&page=#{page}&per_page=100"
       page += 1
       response = RestClient.get url
       raise Exception.new("Wrong response code (#{response.code}) in request #{url}") if response.code!=200
       document = Nokogiri::XML(response.to_str)    done = document.xpath("applications/@current_page").text == document.xpath("applications/@total_pages").text
       document.xpath("//application").each do |item|
         app = Hash.new
         app["created_at"] = DateTime.parse(item.xpath("created_at").text)
         app["plan_name"] = item.xpath("plan/name").text
         app["service_id"] = item.xpath("plan/service_id").text
         app["account_id"] = item.xpath("user_account_id").text
         app["id"] = item.xpath("id").text
         res << app
       end
     end
     return res
   end

   Copy to Clipboard Toggle word wrap

2. 条件を満たしていないアプリケーションを除外する ("評価版" プランで、かつ 10 日前以降のものに絞り込む)。

   def filter_applications(domain, provider_key, plan_name, num_of_days)
     res = api_call_applications_list(domain, provider_key)
     res.each do |item|
       res.delete(item) if item["plan_name"] != plan_name
       res.delete(item) if item["created_at"] > (DateTime.now - num_of_days)
     end
     return res
   end

   Copy to Clipboard Toggle word wrap

3. 条件を満たすそれぞれのアプリケーションについて、その使用状況 (過去 10 日間のアプリケーションのヒットカウント) を取得する。

   def api_call_application_usage(domain, provider_key, application_id, metric, from, to, granularity)
     url = "https://#{domain}/stats/applications/#{application_id}/usage.xml?provider_key=#{provider_key}&metric_name=#{metric}&since=#{from}&until=#{to}&granularity=#{granularity}"
     response = RestClient.get url
     raise Exception.new("Wrong response code (#{response.code}) in request #{url}") if response.code!=200
     document = Nokogiri::XML(response.to_str)
     return document.xpath("//usage/data/values").text.split(",")
   end

   Copy to Clipboard Toggle word wrap

4. 開発者の情報はアカウントオブジェクトに保存されるため、アプリケーションをアカウントに紐付けする。

   def api_call_account_read(domain, provider_key, account_id)
     url = "https://#{domain}/admin/api/accounts/#{account_id}.xml?provider_key=#{provider_key}"
     response = RestClient.get url
     raise Exception.new("Wrong response code (#{response.code}) in request #{url}") if response.code!=200
     document = Nokogiri::XML(response.to_str)
     account = Hash.new
     account["email"] = document.xpath("//users/user/email").text
     account["name"] = document.xpath("//users/user/first_name").text + " " + document.xpath("//users/user/last_name").text
     return account
   end

   Copy to Clipboard Toggle word wrap
5. すべてを 1 つにまとめてスクリプトを完了する。このスクリプトで、3scale に組み込まれた解析機能ではまだ利用できなかった情報を取得することができます。完成したスクリプト を参照してください。