API on 高木のブログ

Ruby で ChatGPT API を触る（Stream 編）

Tue, 25 Apr 2023 00:00:00 +0000

前回、Ruby で ruby-openai gem を使って、ChatGPT API を触ってみた

今回は ChatGPT の Web 版のように返答を少しずつ表示するやつをやってみる

ruby-openai はまだ Stream には対応していないので、Faraday を使って実装した

完成物 🔗

コード 🔗

require 'bundler/inline'

gemfile do
  source 'https://rubygems.org'
  gem 'faraday'
end

url = 'https://api.openai.com'
openai_api_key = 'APIキー'
headers = { Authorization: "Bearer #{openai_api_key}" }

faraday = Faraday.new(url: url, headers: headers) do |conn|
  conn.request :json
end

params = {
  model: 'gpt-3.5-turbo',
  messages: [
    { role: 'user', content: 'こんにちは！' }
  ],
  stream: true
}

faraday.post('/v1/chat/completions') do |req|
  req.body = params.to_json

  req.options.on_data = Proc.new do |chunk|
    chunk.split('data: ')[1..].each do |data|
      text = JSON.parse(data)
      choice = text['choices'][0]

      return if choice['finish_reason'] == 'stop'

      print choice['delta']['content']
    end
  end
end

実行結果 🔗

補足 🔗

chunk の中身 🔗

req.options.on_data = Proc.new do |chunk|
  p chunk
end

data: JSONの形で返ってくる

"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"role\":\"assistant\"},\"index\":0,\"finish_reason\":null}]}\n\ndata: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\x93\xE3\x82\x93\xE3\x81\xAB\xE3\x81\xA1\xE3\x81\xAF\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xEF\xBC\x81\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE7\xA7\x81\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\xAF\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"AI\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\xAE\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x82\xA2\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x82\xB7\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x82\xB9\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x82\xBF\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x83\xB3\xE3\x83\x88\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\xA7\xE3\x81\x99\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x80\x82\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE4\xBD\x95\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\x8B\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\x8A\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE6\x89\x8B\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE4\xBC\x9D\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\x84\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\xA7\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\x8D\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x82\x8B\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\x93\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\xA8\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\x8C\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\x82\xE3\x82\x8A\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\xBE\xE3\x81\x99\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xE3\x81\x8B\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{\"content\":\"\xEF\xBC\x9F\"},\"index\":0,\"finish_reason\":null}]}\n\n"
"data: {\"id\":\"chatcmpl-78sf0vt4xuqm6MnLtqEBOA0WqeQ9I\",\"object\":\"chat.completion.chunk\",\"created\":1682351094,\"model\":\"gpt-3.5-turbo-0301\",\"choices\":[{\"delta\":{},\"index\":0,\"finish_reason\":\"stop\"}]}\n\ndata: [DONE]\n\n"

最後の chunk 🔗

最後の chunk には data: [DONE] が来るので JSON.parse すると当然コケる
そのため、finish_reason: 'stop' が含まれている1つ前の chunk で止めるようにしている

return if choice['finish_reason'] == 'stop'

参考 🔗

Ruby で ChatGPT API を触る

Sat, 08 Apr 2023 00:00:00 +0000

Ruby で ruby-openai gem を使って、ChatGPT API を触ってみた

Hello World! 的なやつ 🔗

「こんにちは」とメッセージを送って、そのレスポンスを表示する

require 'bundler/inline'

gemfile do
  source 'https://rubygems.org'
  gem 'ruby-openai'
end

client = OpenAI::Client.new(access_token: 'access_token')

response = client.chat(
  parameters: {
    model: 'gpt-3.5-turbo',
    messages: [{ role: 'user', content: 'こんにちは' }]
  }
)

puts response.dig('choices', 0, 'message', 'content')

$ ruby app.rb
こんにちは！私はAIアシスタントです。どのようなご要望がありますか？

しりとり 🔗

ループでしりとりをやってみた

loop do
  print 'User: '
  content = gets.chomp

  response = client.chat(
    parameters: {
      model: 'gpt-3.5-turbo',
      messages: [{ role: 'user', content: content }]
    }
  )

  puts "Assistant: #{response.dig('choices', 0, 'message', 'content')}"
end

$ ruby app.rb
User: しりとりをしよう
Assistant: りんご
User: ごりら
Assistant: ごりらとは、哺乳動物の一種で、日本語では「サイチョウザメ」「ラッコウオ」とも呼ばれます。体重は約2～3トンにもなり、大型哺乳動物の一つです。鼻先に角質の「つの」があり、強力な力で木を倒したり、車両をも動かすことができます。草食性で、主に木の葉などを食べす。また、ごりらは現在絶滅の危機に瀕しており、保護が必要な動物の一つです。
User:

失敗 🔗

「りんご」の次に「ごりら」と送ると、ゴリラの説明が返ってきた

原因 🔗

過去の会話履歴を保持していないからである
ChatGPT 的にはいきなり「ごりら」とだけ送られてきている

改修 🔗

過去の会話履歴を保持するようにする
messages に 過去の会話 + 新しいメッセージ を入れてあげれば良い

messages = []

loop do
  print 'User: '
  content = gets.chomp

  messages.push({ role: 'user', content: content })

  response = client.chat(
    parameters: {
      model: 'gpt-3.5-turbo',
      messages: messages
    }
  )

  message = response.dig('choices', 0, 'message')
  messages.push(message)

  puts "Assistant: #{message['content']}"
end

$ ruby app.rb
User: しりとりをしよう
Assistant: りんご
User: ごりら
Assistant: らっぱ
User: ぱんつ
Assistant: つりかべ
User:

無事、しりとりをすることができた

参考 🔗

ruby-openaiを使ってChatGPT APIを叩いてみよう - Qiita

switchbot gem v0.8.0 をリリースした

Thu, 30 Mar 2023 00:00:00 +0000

SwitchBot API 用の Gem、switchbot v0.8.0 をリリースした

https://rubygems.org/gems/switchbot

変更点 🔗

今回のアップデートは内部的なリファクタリングが中心で、機能としては Plug Mini に対応した

いつもと違うのは、Plug Mini の対応はプルリクエストで頂いた点
とてもありがたい！

Add Plug Mini by kataring · Pull Request #21 · ytkg/switchbot

使い方 🔗

require 'switchbot'

client = Switchbot::Client.new('YOUR_TOKEN', 'YOUR_SECRET')

plug_mini = client.plug_mini('C271111EC0AB')

# ステータスの確認
plug_mini.status

# スイッチON
plug_mini.on

# スイッチOFF
plug_mini.off

# スイッチONかどうか確認
plug_mini.on?

# スイッチOFFかどうか確認
plug_mini.off?

# スイッチON/OFFのトグル
plug_mini.toggle

【Spotify Web API】アーティスト名を日本語で取得する

Mon, 16 Jan 2023 00:00:00 +0000

問題 🔗

Spotify Web API で現在再生中の曲を取得できるエンドポイントを叩いた時、アーティスト名が英語というかローマ字で返ってくる

$ curl -s -X GET https://api.spotify.com/v1/me/player/currently-playing \
  -H 'Authorization: Bearer {アクセストークン}' | jq -r '.item.artists[].name'
Ken Hirai
Aimyon

解決方法 🔗

ヘッダーに「Accept-Language: ja」を追加してあげれば日本語で取得することができる

$ curl -s -X GET https://api.spotify.com/v1/me/player/currently-playing \
  -H 'Accept-Language: ja' \
  -H 'Authorization: Bearer {アクセストークン}' | jq -r '.item.artists[].name'
平井堅
あいみょん

参考 🔗

Spotifyの検索APIで日本語の結果が返されないときの対処法 - Qiita

【Spotify Web API】現在再生中の曲を取得する

Tue, 10 Jan 2023 00:00:00 +0000

Spotify で現在再生中の曲を取得したかった

Spotify は API を公開しているので、Spotify Web API で取得することができる

$ curl -s -X GET https://api.spotify.com/v1/me/player/currently-playing \
-H 'Authorization: Bearer {アクセストークン}' | jq -r .item.name
君はロックを聴かない

アクセストークンを取得する方法 🔗

【Spotify Web API】アクセストークンの取得と更新（リフレッシュ）に書いた

API のレスポンス 🔗

$ curl -X GET https://api.spotify.com/v1/me/player/currently-playing \
-H 'Authorization: Bearer {アクセストークン}'
{
  "timestamp" : 1673277556270,
  "context" : {
    "external_urls" : {
      "spotify" : "https://open.spotify.com/playlist/37i9dQZF1DWZ7hCgzgU48z"
    },
    "href" : "https://api.spotify.com/v1/playlists/37i9dQZF1DWZ7hCgzgU48z",
    "type" : "playlist",
    "uri" : "spotify:playlist:37i9dQZF1DWZ7hCgzgU48z"
  },
  "progress_ms" : 5344,
  "item" : {
    "album" : {
      "album_type" : "album",
      "artists" : [ {
        "external_urls" : {
          "spotify" : "https://open.spotify.com/artist/5kVZa4lFUmAQlBogl1fkd6"
        },
        "href" : "https://api.spotify.com/v1/artists/5kVZa4lFUmAQlBogl1fkd6",
        "id" : "5kVZa4lFUmAQlBogl1fkd6",
        "name" : "Aimyon",
        "type" : "artist",
        "uri" : "spotify:artist:5kVZa4lFUmAQlBogl1fkd6"
      } ],
      "available_markets" : [ "AD", "AE", "AG", "AL", "AM", "AO", "AR", "AT", "AU", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BN", "BO", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CD", "CG", "CH", "CI", "CL", "CM", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "ES", "FI", "FJ", "FM", "FR", "GA", "GB", "GD", "GE", "GH", "GM", "GN", "GQ", "GR", "GT", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IN", "IQ", "IS", "IT", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MN", "MO", "MR", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NZ", "OM", "PA", "PE", "PG", "PH", "PK", "PL", "PS", "PT", "PW", "PY", "QA", "RO", "RS", "RW", "SA", "SB", "SC", "SE", "SG", "SI", "SK", "SL", "SM", "SN", "SR", "ST", "SV", "SZ", "TD", "TG", "TH", "TJ", "TL", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VC", "VE", "VN", "VU", "WS", "XK", "ZA", "ZM", "ZW" ],
      "external_urls" : {
        "spotify" : "https://open.spotify.com/album/0ct8ESCAYEpDGYJOndCfft"
      },
      "href" : "https://api.spotify.com/v1/albums/0ct8ESCAYEpDGYJOndCfft",
      "id" : "0ct8ESCAYEpDGYJOndCfft",
      "images" : [ {
        "height" : 640,
        "url" : "https://i.scdn.co/image/ab67616d0000b27333c05e1d08fec494a30bd240",
        "width" : 640
      }, {
        "height" : 300,
        "url" : "https://i.scdn.co/image/ab67616d00001e0233c05e1d08fec494a30bd240",
        "width" : 300
      }, {
        "height" : 64,
        "url" : "https://i.scdn.co/image/ab67616d0000485133c05e1d08fec494a30bd240",
        "width" : 64
      } ],
      "name" : "青春のエキサイトメント",
      "release_date" : "2017-09-12",
      "release_date_precision" : "day",
      "total_tracks" : 11,
      "type" : "album",
      "uri" : "spotify:album:0ct8ESCAYEpDGYJOndCfft"
    },
    "artists" : [ {
      "external_urls" : {
        "spotify" : "https://open.spotify.com/artist/5kVZa4lFUmAQlBogl1fkd6"
      },
      "href" : "https://api.spotify.com/v1/artists/5kVZa4lFUmAQlBogl1fkd6",
      "id" : "5kVZa4lFUmAQlBogl1fkd6",
      "name" : "Aimyon",
      "type" : "artist",
      "uri" : "spotify:artist:5kVZa4lFUmAQlBogl1fkd6"
    } ],
    "available_markets" : [ "AD", "AE", "AG", "AL", "AM", "AO", "AR", "AT", "AU", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BN", "BO", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CD", "CG", "CH", "CI", "CL", "CM", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "ES", "FI", "FJ", "FM", "FR", "GA", "GB", "GD", "GE", "GH", "GM", "GN", "GQ", "GR", "GT", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IN", "IQ", "IS", "IT", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MN", "MO", "MR", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NZ", "OM", "PA", "PE", "PG", "PH", "PK", "PL", "PS", "PT", "PW", "PY", "QA", "RO", "RS", "RW", "SA", "SB", "SC", "SE", "SG", "SI", "SK", "SL", "SM", "SN", "SR", "ST", "SV", "SZ", "TD", "TG", "TH", "TJ", "TL", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VC", "VE", "VN", "VU", "WS", "XK", "ZA", "ZM", "ZW" ],
    "disc_number" : 1,
    "duration_ms" : 246306,
    "explicit" : false,
    "external_ids" : {
      "isrc" : "JPWP01771557"
    },
    "external_urls" : {
      "spotify" : "https://open.spotify.com/track/59eluCMn0XbOWqeWQ91FTM"
    },
    "href" : "https://api.spotify.com/v1/tracks/59eluCMn0XbOWqeWQ91FTM",
    "id" : "59eluCMn0XbOWqeWQ91FTM",
    "is_local" : false,
    "name" : "君はロックを聴かない",
    "popularity" : 68,
    "preview_url" : "https://p.scdn.co/mp3-preview/7e26c8a2bd4b3fa7207d78baf796dd28994a8547?cid=1f2f34c40ba8411bbe57cdc7bd3f3632",
    "track_number" : 3,
    "type" : "track",
    "uri" : "spotify:track:59eluCMn0XbOWqeWQ91FTM"
  },
  "currently_playing_type" : "track",
  "actions" : {
    "disallows" : {
      "resuming" : true
    }
  },
  "is_playing" : true
}

【Spotify Web API】アクセストークンの取得と更新（リフレッシュ）

Mon, 09 Jan 2023 00:00:00 +0000

Spotify Web API を使うために必要なアクセストークンの取得方法とその更新（リフレッシュ）方法

認証フローが3つあり、今回の記事は「Authorization Code Flow」のやり方

事前準備 🔗

アプリを作成する 🔗

https://developer.spotify.com/dashboard/applications でアプリを作成し、Client ID と Client Secret を取得する

Redirect URL を設定する 🔗

アプリ詳細画面の「EDIT SETTINGS」から Redirect URL を設定する
ローカルで使うだけなのでなんでも良い
今回は「 http://localhost:3000 」を設定した

アクセストークンの取得 🔗

認証コードの取得する 🔗

以下の URL にブラウザでアクセスする

https://accounts.spotify.com/authorize?client_id={Client ID}&response_type=code&redirect_uri=http://localhost:3000&scope=user-read-currently-playing

client_id に事前準備で取得した Client ID を指定する
scope には許可したいものを指定する（今回の例では user-read-currently-playing）

アプリの認証画面が表示されるので「同意する」をクリック

すると以下のような URL にリダイレクトされるので、code の値をメモしておく（存在しない URL なので、エラーが表示されているが問題なし）

http://localhost:3000/?code=HOGEHOGE_CODE

Client ID と Client Secret を Base64 でエンコードする 🔗

$ echo -n {Client ID}:{Client Secret} | base64
BASE64_ENCODE_VALUE=

アクセストークンをリクエストする 🔗

$ curl -X POST https://accounts.spotify.com/api/token \
-H "Authorization: Basic {Client ID と Client Secret を Base64 でエンコードした値}" \
-d grant_type=authorization_code \
-d code={先ほどメモした code の値} \
-d redirect_uri=http://localhost:3000
{
  "access_token": "HOGEHOGE_ACCESS_TOKEN",
  "token_type": "Bearer",
  "expires_in": 3600,
  "refresh_token": "HOGEHOGE_REFRESH_TOKEN",
  "scope": "user-read-currently-playing"
}

これでアクセストークンを取得することができた
リフレッシュトークンも必要な値なので、メモしておく

アクセストークンの更新（リフレッシュ） 🔗

アクセストークンには1時間の有効期限がある
有効期限が切れたらリフレッシュトークンを使って更新する必要がある

$ curl -X POST https://accounts.spotify.com/api/token \
-H "Authorization: Basic {Client ID と Client Secret を Base64 でエンコードした値}" \
-d grant_type=refresh_token \
-d refresh_token={リフレッシュトークン}
{
  "access_token": "HOGEHOGE_NEW_ACCESS_TOKEN",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "user-read-currently-playing"
}

switchbot gem v0.7.0 をリリースした

Fri, 28 Oct 2022 00:00:00 +0000

SwitchBot API 用の Gem、switchbot v0.7.0 をリリースした
このリリースで、SwitchBot API v1.1 を使うようになった

https://rubygems.org/gems/switchbot

変更点 🔗

認証方法の変更 🔗

SwitchBot API v1.1 では認証方法が変わり、トークンに加えてシークレットも必要になった
シークレットはトークンと同じく SwitchBot のアプリから取得できる

client = Switchbot::Client.new('YOUR_TOKEN', 'YOUR_SECRET')

SwitchBot ロックに対応 🔗

認証方式が変わってセキュリティが強化されたので、API 経由でロックの解錠・施錠ができるようになった

client = Switchbot::Client.new('YOUR_TOKEN', 'YOUR_SECRET')

client.lock('C271111EC0AB').unlock
#=>
#{:status_code=>100,
# :body=>
#  {:items=>
#    [{:device_id=>"C271111EC0AB",
#      :code=>100,
#      :status=>
#       {:door_state=>"closed",
#        :is_slave=>false,
#        :door_state_source=>"master",
#        :is_slave_online=>false,
#        :battery=>95,
#        :pause_auto_lock=>false,
#        :lock_state=>"unlocked",
#        :last_action_source=>"autoLock",
#        :is_calibrate=>true,
#        :power=>"on",
#        :is_group=>false,
#        :door_opened_overtime_warning=>false,
#        :unlocked_overtime_warning=>false},
#      :message=>"success!"}]},
# :message=>"success"}

client.lock('C271111EC0AB').lock
#=>
#{:status_code=>100,
# :body=>
#  {:items=>
#    [{:device_id=>"C271111EC0AB",
#      :code=>100,
#      :status=>
#       {:door_state=>"closed",
#        :is_slave=>false,
#        :door_state_source=>"master",
#        :is_slave_online=>false,
#        :battery=>95,
#        :pause_auto_lock=>false,
#        :lock_state=>"locked",
#        :last_action_source=>"command",
#        :is_calibrate=>true,
#        :power=>"on",
#        :is_group=>false,
#        :door_opened_overtime_warning=>false,
#        :unlocked_overtime_warning=>false},
#      :message=>"success!"}]},
# :message=>"success"}

SwitchBot API v1.1 の認証（Ruby バージョン）

Wed, 12 Oct 2022 00:00:00 +0000

先日、SwitchBot API の v1.1 が公開された
v1.1 では認証方法が変わっている
公式ドキュメントには Python と JavaScript での認証方法のサンプルコードが載っていたが、Ruby がなかったので書いてみた

コード 🔗

require 'securerandom'
require 'base64'
require 'openssl'

token = 'hoge-token'
secret = 'fuga-secret'
t = (Time.now.to_f * 1000).to_i
nonce = SecureRandom.alphanumeric

sign = Base64.strict_encode64(OpenSSL::HMAC.digest('sha256', secret, "#{token}#{t}#{nonce}"))

puts "Authorization: #{token}"
puts "t: #{t}"
puts "sign: #{sign}"
puts "nonce: #{nonce}"

token: アクセストークン
secret: アクセストークンシークレット（SwitchBot アプリ v6.14 以降で取得可能）
t: 13桁のタイムスタンプ
nonce: 利用するプログラムで生成した UUID キー
sign: 特定のアルゴリズムで生成した文字列

実行 🔗

実行すると必要な情報が出力される

$ ruby app.rb
Authorization: hoge-token
t: 1665582731060
sign: Lk4PPsJLZXAN6yhRTfhE5Vargx9N0iIBJRO+YeAkyJU=
nonce: flMkSCm3PkBgOukF

リクエストヘッダーに追加して curl などでリクエストしたらOK（例はデバイスを取得する）

$ curl -X GET 'https://api.switch-bot.com/v1.1/devices' \
--header 'Authorization: hoge-token' \
--header 't: 1665582731060' \
--header 'sign: Lk4PPsJLZXAN6yhRTfhE5Vargx9N0iIBJRO+YeAkyJU=' \
--header 'nonce: flMkSCm3PkBgOukF'

本当は Ruby で API を叩くところまでやりたかったけど、なぜかうまくいかなかったので調査中

参考 🔗

SwitchBot のスマートロックを API で操作する

Sun, 24 Jul 2022 00:00:00 +0000

SwitchBotのスマートロックを買ったので、APIから操作をサクッと試してみた記録

手順 🔗

ドキュメント: SwitchBotAPI/README.md at main · OpenWonderLabs/SwitchBotAPI

APIキーは公式アプリから取得できる。（「SwitchBotのスマート加湿器をAPIで操作する」に書いた）

デバイスを探す（スマートロックのdevice IDを取得） 🔗

$ curl -s -X GET -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices | jq '.body.deviceList[] | select(.deviceType == "Smart Lock")'
{
  "deviceId": "EX0DEVICE0ID",
  "deviceName": "ロック A8",
  "deviceType": "Smart Lock",
  "enableCloudService": true,
  "hubDeviceId": "EX0HUB0DEVICE"
}

たくさんデバイスが出てくるので、deviceTypeで絞り込みをする

enableCloudServiceがfalseになっている場合、アプリからクラウドサービスを有効にしておく

ステータスを確認する 🔗

$ curl -s -X GET -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices/EX0DEVICE0ID/status | jq
{
  "statusCode": 100,
  "body": {
    "deviceId": "EX0DEVICE0ID",
    "deviceType": "Smart Lock",
    "hubDeviceId": "EX0HUB0DEVICE",
    "lockState": "locked",
    "doorState": "closed",
    "calibrate": true
  },
  "message": "success"
}

解錠・施錠する 🔗

セキュリティの都合か何かでドキュメントに書いてなかったけど、それっぽいコマンドを叩いたらできた（やる時は自己責任で）

解錠 🔗

$ curl -s -X POST -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices/EX0DEVICE0ID/commands -H 'Content-Type: application/json' -d '{"command": "unlock","parameter": "default","commandType": "command"}' | jq
{
  "statusCode": 100,
  "body": {},
  "message": "success"
}

施錠 🔗

$ curl -s -X POST -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices/EX0DEVICE0ID/commands -H 'Content-Type: application/json' -d '{"command": "lock","parameter": "default","commandType": "command"}' | jq
{
  "statusCode": 100,
  "body": {},
  "message": "success"
}

Twitter APIのレートリミット情報を取得する（Rubyで）

Sun, 12 Sep 2021 00:00:00 +0000

Twitter APIを使った機能の開発をしている時、何度もAPIを叩くのであとどれくらい叩けるのか気になる
しかし、レートリミット情報を取得できるエンドポイントは用意されているが、使っているtwitter gem にはそのメソッドが用意されてないので自前で用意するしかない

Why was Twitter::API#rate_limit_status removed? · Issue #430 · sferik/twitter
ちゃんと経緯を全て読んだわけではないけど、「Twitter::Error:TooManyRequestsでrescueしてあげればよくない？」らしい
メソッドを用意しない理由にはなっていないような。。。

実装 🔗

任意のエンドポイントが叩けるTwitter::REST::Requestクラスが用意されているので実装は簡単
見やすいようにformatador gem を使ってテーブルフォーマットで出力する

require 'bundler/inline'

gemfile do
  source 'https://rubygems.org'
  gem 'twitter'
  gem 'formatador'
end

client = Twitter::REST::Client.new do |config|
  config.consumer_key        = "YOUR_CONSUMER_KEY"
  config.consumer_secret     = "YOUR_CONSUMER_SECRET"
  config.access_token        = "YOUR_ACCESS_TOKEN"
  config.access_token_secret = "YOUR_ACCESS_SECRET"
end

response =  Twitter::REST::Request.new(client, :get, '/1.1/application/rate_limit_status.json').perform
rate_limit_status = response[:resources].values.each_with_object([]) do |endpoints, array|
  endpoints.each do |endpoint, values|
    array.push(
      endpoint: endpoint,
      limit: values[:limit],
      remaining: values[:remaining],
      reset: Time.at(values[:reset])
    )
  end
end

Formatador.display_table(rate_limit_status)

$ ruby app.rb
  +-------------------------+--------+-----------+---------------------------+
  | endpoint                | limit  | remaining | reset                     |
  +-------------------------+--------+-----------+---------------------------+
  | /lists/list             | 15     | 15        | 2021-09-11 19:37:14 +0900 |
  +-------------------------+--------+-----------+---------------------------+
  | /lists/memberships      | 75     | 75        | 2021-09-11 19:37:14 +0900 |
  +-------------------------+--------+-----------+---------------------------+
  | /lists/subscribers/show | 15     | 15        | 2021-09-11 19:37:14 +0900 |
  +-------------------------+--------+-----------+---------------------------+
  ...
  +-------------------------+--------+-----------+---------------------------+
  | /trends/place           | 75     | 75        | 2021-09-11 19:37:14 +0900 |
  +-------------------------+--------+-----------+---------------------------+
  | /live_pipeline/events   | 180    | 180       | 2021-09-11 19:37:14 +0900 |
  +-------------------------+--------+-----------+---------------------------+
  | /graphql                | 15     | 15        | 2021-09-11 19:37:14 +0900 |
  +-------------------------+--------+-----------+---------------------------+

消費されているエンドポイントのみ表示 🔗

全エンドポイントが出力されても見づらいので、消費されているエンドポイントだけ出力させる

Formatador.display_table(rate_limit_status.select { |v| v[:limit] != v[:remaining] })

$ ruby app.rb
  +-----------------------------+-------+-----------+---------------------------+
  | endpoint                    | limit | remaining | reset                     |
  +-----------------------------+-------+-----------+---------------------------+
  | /users/:id                  | 900   | 887       | 2021-09-11 19:18:10 +0900 |
  +-----------------------------+-------+-----------+---------------------------+
  | /users/lookup               | 900   | 895       | 2021-09-11 19:30:28 +0900 |
  +-----------------------------+-------+-----------+---------------------------+
  | /followers/list             | 15    | 12        | 2021-09-11 19:30:50 +0900 |
  +-----------------------------+-------+-----------+---------------------------+
  | /account/verify_credentials | 75    | 72        | 2021-09-11 19:30:49 +0900 |
  +-----------------------------+-------+-----------+---------------------------+

定期実行 🔗

開発中はwatchコマンドで定期実行させておく
レートリミット情報の取得するエンドポイントは15分間に180回まで叩けるので、5秒間隔であれば問題なさそう

$ watch -n 5 ruby app.rb

参考 🔗

DeepStackのObject Detectionの結果を画像に矩形を描画して可視化する

Thu, 22 Jul 2021 00:00:00 +0000

DeepStackのObject Detectionを試すの続き

以下の画像をAPIに投げて物体検出することができた
結果のJSONに物体の座標も載っているので今回はそれ使って画像に矩形を描画する

この画像はPAKUTASO様からお借りした(https://www.pakutaso.com/20170609172post-12164.html )

{
  "success": true,
  "predictions": [
    {
      "confidence": 0.7281746,
      "label": "motorcycle",
      "y_min": 275,
      "x_min": 241,
      "y_max": 388,
      "x_max": 401
    },
    {
      "confidence": 0.856776,
      "label": "person",
      "y_min": 219,
      "x_min": 131,
      "y_max": 418,
      "x_max": 246
    },
    {
      "confidence": 0.86147404,
      "label": "bicycle",
      "y_min": 294,
      "x_min": 100,
      "y_max": 468,
      "x_max": 301
    },
    {
      "confidence": 0.9212758,
      "label": "cow",
      "y_min": 293,
      "x_min": 359,
      "y_max": 482,
      "x_max": 566
    }
  ],
  "duration": 0
}

画像に矩形を描画する 🔗

画像に描画するにはImageMagickを使う

矩形の描画するコマンド 🔗

以下のコマンドとオプションで矩形の描画ができる

$ convert 元の画像 -draw "rectangle X1の座標, Y1の座標, X2の座標, Y2の座標" 描画後の画像

牛の位置に矩形を描画してみる 🔗

$ convert original.jpg -draw "fill #ffffff fill-opacity 0.5 rectangle 359, 293, 566, 482" draw_rectanglejpg

そのままだと黒い矩形ができるので半透明の白を指定して実行した

これで正しい座標が返ってきていることが確認できた

複数矩形を描画する 🔗

複数物体検出されているので全て描画してみる

JSONの結果から描画に必要なオプションを出力するスクリプト 🔗

複数の座標を入力するのは手間なので必要なオプションを出力するスクリプトを書いた

#!/bin/bash

if [ -p /dev/stdin ]; then
  json=`cat -`
else
  json=`echo $@`
fi

echo `echo $json | \
      jq -r '.predictions[] | "-draw \"fill #ffffff fill-opacity 0.5 rectangle " + (.x_min|tostring) + ", " + (.y_min|tostring) + ", " + (.x_max|tostring) + ", " + (.y_max|tostring) + "\""' | \
      tr '\n' ' '`

実行権限を付与して実行

$ chmod +x ./parser.sh
$ ./parser.sh '{"success":true,"predictions":[{"confidence":0.7281746,"label":"motorcycle","y_min":275,"x_min":241,"y_max":388,"x_max":401},{"confidence":0.856776,"label":"person","y_min":219,"x_min":131,"y_max":418,"x_max":246},{"confidence":0.86147404,"label":"bicycle","y_min":294,"x_min":100,"y_max":468,"x_max":301},{"confidence":0.9212758,"label":"cow","y_min":293,"x_min":359,"y_max":482,"x_max":566}],"duration":0}'
-draw "fill #ffffff fill-opacity 0.5 rectangle 241, 275, 401, 388" -draw "fill #ffffff fill-opacity 0.5 rectangle 131, 219, 246, 418" -draw "fill #ffffff fill-opacity 0.5 rectangle 100, 294, 301, 468" -draw "fill #ffffff fill-opacity 0.5 rectangle 359, 293, 566, 482"

牛以外の物体の位置に矩形を描画してみる 🔗

$ convert original.jpg -draw "fill #ffffff fill-opacity 0.5 rectangle 241, 275, 401, 388" -draw "fill #ffffff fill-opacity 0.5 rectangle 131, 219, 246, 418" -draw "fill #ffffff fill-opacity 0.5 rectangle 100, 294, 301, 468" -draw "fill #ffffff fill-opacity 0.5 rectangle 359, 293, 566, 482" draw_rectanglejpg

全て正しい位置に検出できている、良きね

（補足）パイプで繋げることも可能 🔗

標準入力でも値を受け付けられるようにしてあるので、APIに投げるコマンドにパイプで繋げてあげたら結果をダイレクトで変換することも可能

$ curl -s -X POST -F image=sample.jpg http://localhost:80/v1/vision/detection | ./parser.sh
-draw "fill #ffffff fill-opacity 0.5 rectangle 241, 275, 401, 388" -draw "fill #ffffff fill-opacity 0.5 rectangle 131, 219, 246, 418" -draw "fill #ffffff fill-opacity 0.5 rectangle 100, 294, 301, 468" -draw "fill #ffffff fill-opacity 0.5 rectangle 359, 293, 566, 482"

DeepStackのObject Detectionを試す

Sat, 17 Jul 2021 00:00:00 +0000

DeepStack のObject Detection を試したメモ

画像内のオブジェクトを見つける物体検出API

現時点では80種類のオブジェクトが判断できるみたい

person, bicycle, car, motorcycle, airplane, bus, train, truck, boat, traffic light,
fire hydrant, stop_sign, parking meter, bench, bird, cat, dog, horse, sheep, cow,
elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee,
skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard,
surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana,
apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donot, cake, chair, couch,
potted plant, bed, dining table, toilet, tv, laptop, mouse, remote, keyboard,
cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase,
scissors, teddy bear, hair dryer, toothbrush

https://docs.deepstack.cc/object-detection/index.html#classes

手順 🔗

起動 🔗

Dockerイメージが用意されているので簡単に起動することができる

$ docker run -e VISION-DETECTION=True -v localstorage:/datastore -p 80:5000 deepquestai/deepstack

実行 🔗

Curlで画像ファイルをPOSTしたら結果が返ってくる

$ curl -X POST -F image=@{画像ファイル} http://localhost:80/v1/vision/detection

この画像はPAKUTASO様からお借りした(https://www.pakutaso.com/20170609172post-12164.html )

$ curl -s -X POST -F image=@sample.jpg http://localhost:80/v1/vision/detection |jq .
{
  "success": true,
  "predictions": [
    {
      "confidence": 0.7281746,
      "label": "motorcycle",
      "y_min": 275,
      "x_min": 241,
      "y_max": 388,
      "x_max": 401
    },
    {
      "confidence": 0.856776,
      "label": "person",
      "y_min": 219,
      "x_min": 131,
      "y_max": 418,
      "x_max": 246
    },
    {
      "confidence": 0.86147404,
      "label": "bicycle",
      "y_min": 294,
      "x_min": 100,
      "y_max": 468,
      "x_max": 301
    },
    {
      "confidence": 0.9212758,
      "label": "cow",
      "y_min": 293,
      "x_min": 359,
      "y_max": 482,
      "x_max": 566
    }
  ],
  "duration": 0
}

バイク、人、自転車、牛。ちゃんと認識されていて精度良さそう！
物体の位置も返ってくる

矩形を描画して可視化する 🔗

続きを書いた
DeepStackのObject Detectionの結果を画像に矩形を描画して可視化する

SwitchBot用のGem作った

Mon, 28 Jun 2021 00:00:00 +0000

スマートリモコンをNature Remo からSwitchBot に乗り換えてからいろいろなSwitchBotの製品を使うようになったので、Rubyで操作できるようにAPIクライアントのGemを作った

switchbotのネームスペースを使うのはかなり躊躇したが、ちゃんとメンテする覚悟ができたので使わせてもらった

https://rubygems.org/gems/switchbot

使い方 🔗

インストール 🔗

gem 'switchbot'

$ bundle install

もしくは

$ gem install switchbot

初期化 🔗

require 'switchbot'

client = Switchbot::Client.new('YOUR_TOKEN')

デバイス一覧を取得 🔗

client.devices
#=> {:status_code=>100,
#    :body=>
#     {:device_list=>
#       [{:device_id=>"500291B269BE",
#         :device_name=>"Living Room Humidifier",
#         :device_type=>"Humidifier",
#         :enable_cloud_service=>true,
#         :hub_device_id=>"000000000000"}],
#      :infrared_remote_list=>
#       [{:device_id=>"02-202008110034-13",
#         :device_name=>"Living Room TV",
#         :remote_type=>"TV",
#         :hub_device_id=>"FA7310762361"}]},
#    :message=>"success"}

デバイスのステータスを取得 🔗

client.status(device_id: 'C271111EC0AB')
# or
client.device('C271111EC0AB').status
#=> {:status_code=>100,
#    :body=>
#     {:device_id=>"C271111EC0AB",
#      :device_type=>"Meter",
#      :hub_device_id=>"FA7310762361",
#      :humidity=>52,
#      :temperature=>26.1},
#    :message=>"success"}

コマンドを実行 🔗

client.commands(device_id: 'C271111EC0AB', command: 'turnOn')
# or
client.device('C271111EC0AB').commands(command: 'turnOn')
# or
client.device('C271111EC0AB').on
#=> {:status_code=>100,
#    :body=>{},
#    :message=>"success"}

使用例 🔗

スマート加湿器 🔗

SwitchBotのスマート加湿器が止まっていたら起動させるスクリプトで書いたものをRubyで書き直す

require 'switchbot'

client = Switchbot::Client.new('YOUR_TOKEN')
humidifier = client.device('DEVICE_ID')

humidifier.on if humidifier.off?

onとoff?のメソッドしか使わなかったのでDeviceクラスを使ったが、一応Humidifierクラスもあってそれ使えばモードの切り替えも可能

humidifier = client.humidifier('DEVICE_ID')

humidifier.low
humidifier.medium
humidifier.high

ライト 🔗

これは製品ではなくて、SwitchBot Hubにリモコン登録したライトのこと

電源のオン・オフはもちろん、明るさの調整ができる

light = client.light('DEVICE_ID')

light.on
light.brightness_up
light.brightness_down
light.off

Issue、Pull Request大歓迎 🔗

一応最低限操作はできるけど、まだまだ未完成なので協力してくれる方募集中
いくつかのAPIクライアントGemの書き方を参考にして作ってみたがこれいいのか自信がない
こうした方がいいとかこの書き方はまずいとかあったら教えてくれたら嬉しい

SwitchBotのボットをAPIで操作する

Thu, 24 Jun 2021 00:00:00 +0000

SwitchBotのボットを買ったので、APIから操作をサクッと試してみた記録

手順 🔗

ドキュメント: SwitchBotAPI/README.md at main · OpenWonderLabs/SwitchBotAPI

APIキーは公式アプリから取得できる。（「SwitchBotのスマート加湿器をAPIで操作する」に書いた）

デバイスを探す（ボットのdevice IDを取得） 🔗

$ curl -s -X GET -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices | jq '.body.deviceList[] | select(.deviceType == "Bot")'
{
  "deviceId": "EX0DEVICE0ID",
  "deviceName": "ボット",
  "deviceType": "Bot",
  "enableCloudService": true,
  "hubDeviceId": "EX0HUB0DEVICE"
}

たくさんデバイスが出てくるので、deviceTypeで絞り込みをする

enableCloudServiceがfalseになっている場合、アプリからクラウドサービスを有効にしておく

ステータスを確認する 🔗

$ curl -s -X GET -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices/EX0DEVICE0ID/status | jq
{
  "statusCode": 100,
  "body": {
    "deviceId": "EX0DEVICE0ID",
    "deviceType": "Bot",
    "hubDeviceId": "EX0HUB0DEVICE",
    "power": "off"
  },
  "message": "success"
}

スイッチをオン、オフする 🔗

モードは「スイッチ」モードにしている（アプリから設定）

オン 🔗

$ curl -s -X POST -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices/EX0DEVICE0ID/commands -H 'Content-Type: application/json' -d '{"command": "turnOn","parameter": "default","commandType": "command"}' | jq
{
  "statusCode": 100,
  "body": {},
  "message": "success"
}

オフ 🔗

$ curl -s -X POST -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices/EX0DEVICE0ID/commands -H 'Content-Type: application/json' -d '{"command": "turnOff","parameter": "default","commandType": "command"}' | jq
{
  "statusCode": 100,
  "body": {},
  "message": "success"
}

SESAME 3の状態と履歴をWeb APIで取得する

Mon, 14 Jun 2021 00:00:00 +0000

SESAME 3 のAPIが公開されていたので触ってみた（まだ正式には発表されてはいないっぽいが）

https://doc.candyhouse.co/ja/SesameAPI

API KEYの取得 🔗

https://dash.candyhouse.co/ でログインしたら取得できる
最初「-」しか表示されていなかったけど待っていたら表示された

状態を取得 🔗

GET: "https://app.candyhouse.co/api/sesame2/{UUID}"

$ curl -s -H "x-api-key:{API KEY}" https://app.candyhouse.co/api/sesame2/{UUID} |jq
{
  "batteryPercentage": 100,
  "batteryVoltage": 6.116129032258065,
  "position": 1069,
  "CHSesame2Status": "locked",
  "timestamp": 1623646157
}

履歴を取得 🔗

GET: "https://app.candyhouse.co/api/sesame2/{UUID}/history?page=1&lg=3"

$ curl -s -H "x-api-key:{API KEY}" "https://app.candyhouse.co/api/sesame2/{UUID}/history?page=1&lg=3" |jq
[
  {
    "recordID": 83,
    "type": 2,
    "timeStamp": 1623646093156,
    "historyTag": "44KI44GX44GN"
  },
  {
    "recordID": 82,
    "type": 3,
    "timeStamp": 1623645290000,
    "parameter": "atzGYAEAAAA="
  },
  {
    "recordID": 85,
    "type": 10,
    "timeStamp": 1623606552160
  }
]

pageとlgは必須パラメータっぽい
pageは何ページ目を取得するか
lgは1ページに何件の履歴を取得するか

NEM(XEM)とSymbol(XYM)のウォレット残高をAPIを使って取得する方法

Mon, 31 May 2021 00:00:00 +0000

仮想通貨の総資産を出したいので調べた
取引所はコインチェックとバイナンスを使っているが、NEMとSymbolだけはオプトインの時に個別ウォレットに入れてそのままにしているため

手順 🔗

NEM(XEM) 🔗

$ curl http://133.167.127.119:7890/account/get?address={アドレス}

※ノードのアドレスは https://nemnodes.org/nodes/ から適当に選んだ

$ curl -s http://133.167.127.119:7890/account/get?address=ND4HES3F4GJZPN2TRV3WLXSEUONOIFG2UGZ3NDM4 |jq .
{
  "meta": {
    "cosignatories": [],
    "cosignatoryOf": [],
    "status": "LOCKED",
    "remoteStatus": "INACTIVE"
  },
  "account": {
    "address": "ND4HES3F4GJZPN2TRV3WLXSEUONOIFG2UGZ3NDM4",
    "harvestedBlocks": 0,
    "balance": 119950000,
    "importance": 0,
    "vestedBalance": 119926419,
    "publicKey": "da666110fa4e58b6e692ab5dca4238b2145c6d29eb76ac1f36189e2a3fe2085f",
    "label": null,
    "multisigInfo": {}
  }
}

$ curl -s http://133.167.127.119:7890/account/get?address=ND4HES3F4GJZPN2TRV3WLXSEUONOIFG2UGZ3NDM4 |jq .account.balance
119950000

※小数点の計算を避けるために100万倍されている。

Symbol(XYM) 🔗

$ curl 153.127.35.168:3000/accounts/{アドレス}

※ノードのアドレスは https://symbolnodes.org/nodes/ から適当に選んだ

$ curl -s 153.127.35.168:3000/accounts/NATIJRZR3WKPMDUWUNHC2M4PRWOA5WV47T6W3QA |jq .
{
  "account": {
    "version": 1,
    "address": "682684C731DD94F60E96A34E2D338F8D9C0EDABCFCFD6DC0",
    "addressHeight": "217397",
    "publicKey": "0000000000000000000000000000000000000000000000000000000000000000",
    "publicKeyHeight": "0",
    "accountType": 0,
    "supplementalPublicKeys": {},
    "activityBuckets": [],
    "mosaics": [
      {
        "id": "6BED913FA20223F8",
        "amount": "118732400"
      }
    ],
    "importance": "0",
    "importanceHeight": "0"
  },
  "id": "60B4D5E2EF53F56F638952CC"
}

$ curl -s 153.127.35.168:3000/accounts/NATIJRZR3WKPMDUWUNHC2M4PRWOA5WV47T6W3QA |jq -r .account.mosaics[].amount
118732400

※小数点の計算を避けるために100万倍されている。

乞食 🔗

僕のウォレットです。お小遣いください。

NEM(XEM): ND4HES-3F4GJZ-PN2TRV-3WLXSE-UONOIF-G2UGZ3-NDM4
Symbol(XYM): NATIJR-ZR3WKP-MDUWUN-HC2M4P-RWOA5W-V47T6W-3QA

参考 🔗

PixelaをActiveRecordのように使う試み

Mon, 05 Apr 2021 00:00:00 +0000

※下書きにずっと放置してあって、記事も実装も中途半端な状態だけど一旦公開しておく 🔗

Pixela の利用シーンの例として「“日"系列データベース」があったので、その使い方でやるとしたらどうやるか試してみた話。
ActiveRecordみたいに使えたらいいなと思ったのでサクッと作ってみた。

最初に言い訳として雑に作ってある。
とりあえず、findとwhereだけ実装した。
createは力尽きたので断念。

require 'pixela'

class PixelaRecord
  attr_accessor :date, :quantity

  def initialize(date:, quantity:)
    @date = date
    @quantity = quantity.to_i
  end

  class << self
    def find(date = Date.today)
      response = client.get_pixel(graph_id: graph_id, date: date)
      new(date: date, quantity: response.quantity)
    end

    def where(from: nil, to: nil)
      dates = client.get_pixel_dates(graph_id: graph_id, from: from, to: to)
      dates.map do |date|
        response = client.get_pixel(graph_id: graph_id, date: date)
        new(date: date, quantity: response.quantity)
      end
    end

    private

    def client
      @client = Pixela::Client.new(username: 'takagi', token: 'hogehoge')
    end

    def graph_id
      self.name.downcase
    end
  end
end

class Distance < PixelaRecord
end

distance = Distance.find(Date.today)
puts "#{distance.date}: #{distance.quantity}km"
#=> 2020-11-21: 1km

distances = Distance.where(from: Date.parse('2020-10-01'), to: Date.parse('2020-10-31'))
distances.each do |distance|
  puts "#{distance.date}: #{distance.quantity}km"
end
#=> 2020-10-01: 56km
#=> 2020-10-02: 67km
#=> 2020-10-03: 72km
#=> 2020-10-04: 40km
#=> 2020-10-05: 14km
#=> 2020-10-06: 37km
#=> 2020-10-07: 82km
#=> 2020-10-08: 100km
#=> 2020-10-09: 58km
#=> 2020-10-10: 71km
#=> 2020-10-11: 77km
#=> 2020-10-12: 3km
#=> 2020-10-13: 4km
#=> 2020-10-14: 44km
#=> 2020-10-15: 80km
#=> 2020-10-16: 2km
#=> 2020-10-17: 10km
#=> 2020-10-18: 64km
#=> 2020-10-19: 15km
#=> 2020-10-20: 10km
#=> 2020-10-21: 51km
#=> 2020-10-22: 74km
#=> 2020-10-23: 3km
#=> 2020-10-24: 67km
#=> 2020-10-25: 38km
#=> 2020-10-26: 41km
#=> 2020-10-27: 19km
#=> 2020-10-28: 65km
#=> 2020-10-29: 46km
#=> 2020-10-30: 74km
#=> 2020-10-31: 94km

感想 🔗

N+1問題が発生している
API制限があるのかわからないが、なかったとしてもあまりよろしくないと思う。

備考 🔗

先にグラフは作成しておく。

$ curl -X POST https://pixe.la/v1/users/takagi/graphs -H 'X-USER-TOKEN:xxxx' -d '{"id":"distance","name":" 走行距離","unit":"km","type":"float","color":"sora","timezone":"Asia/Tokyo"}'
{"message":"Success.","isSuccess":true}

GASでGoogle ToDoリストにデイリーミッションを追加する

Mon, 15 Mar 2021 00:00:00 +0000

タイトルがちょっと何言ってるかわからないかもしれない

毎日の自己研鑽タイムでやることが最近偏ってきてるなと思ったので、やることをランダムで決めてもらうことにした
そのプロトタイプ的なものをGASで作ってみた

仕様 🔗

毎日Tasks APIを使って4つ選んでToDoリストに追加する
前日分の消化していないミッションは最初に消す

コード 🔗

function myFunction() {
  const list_id = 'hogehoge';
  const missions = [
    '読書',
    'エンジニア学習',
    '英語学習',
    'ブログ活動',
    '筋トレ',
    'ウォーキング'
  ]

  const response = Tasks.Tasks.list(list_id)
  const tasks = response.items
  if(tasks) {
    tasks.forEach(function(task){
      Tasks.Tasks.remove(list_id, task.id)
    });
  }

  sample(missions, 4).forEach(function(mission){
    Tasks.Tasks.insert({ title: mission }, list_id)
  });
}

function shuffle([...array]) {
  for (let i = array.length - 1; i >= 0; i--) {
    const j = Math.floor(Math.random() * (i + 1));
    [array[i], array[j]] = [array[j], array[i]];
  }
  return array;
}

function sample(array, num) {
  return shuffle(array).slice(0, num);
}

結果 🔗

こんな感じに

補足 🔗

list_id（リストID）はTasks.Tasklists.list()で取得できる

Logger.log(Tasks.Tasklists.list());

参考 🔗

【Ruby/Rails】JSONのキーをキャメルケースからスネークケースに、文字列からシンボルに変換する

Wed, 03 Mar 2021 00:00:00 +0000

問題 🔗

APIを叩いて返ってきたレスポンスがJSON形式でキーがキャメルケースの文字列だった
普通にJSON.parseしても問題ないが、Rubyだったらできればスネークケースのシンボルで扱いたい

SwitchBotのAPIレスポンス 🔗

{
    "statusCode": 100,
    "body": {
        "deviceList": [
            {
                "deviceId": "500291B269BE",
                "deviceName": "Living Room Humidifier",
                "deviceType": "Humidifier",
                "enableCloudService": true,
                "hubDeviceId": "000000000000"
            }
        ],
        "infraredRemoteList": [
            {
                "deviceId": "02-202008110034-13",
                "deviceName": "Living Room TV",
                "remoteType": "TV",
                "hubDeviceId": "FA7310762361"
            }
        ]
    },
    "message": "success"
}

JSON.parseした結果 🔗

JSON.parse(File.open('devices.json').read)
#=> {"statusCode"=>100, "body"=>{"deviceList"=>[{"deviceId"=>"500291B269BE", "deviceName"=>"Living Room Humidifier", "deviceType"=>"Humidifier", "enableCloudService"=>true, "hubDeviceId"=>"000000000000"}], "infraredRemoteList"=>[{"deviceId"=>"02-202008110034-13", "deviceName"=>"Living Room TV", "remoteType"=>"TV", "hubDeviceId"=>"FA7310762361"}]}, "message"=>"success"}

解決方法 🔗

deep_transform_keys(&:underscore)でスネークケースにして、deep_symbolize_keysでシンボルにする

require 'json'
require 'active_support/all' # Rubyの場合

JSON.parse(File.open('devices.json').read).deep_transform_keys(&:underscore).deep_symbolize_keys
#=> {:status_code=>100, :body=>{:device_list=>[{:device_id=>"500291B269BE", :device_name=>"Living Room Humidifier", :device_type=>"Humidifier", :enable_cloud_service=>true, :hub_device_id=>"000000000000"}], :infrared_remote_list=>[{:device_id=>"02-202008110034-13", :device_name=>"Living Room TV", :remote_type=>"TV", :hub_device_id=>"FA7310762361"}]}, :message=>"success"}

解説的なもの 🔗

キーを文字列からシンボルにする方法 🔗

方法は2つある

JSON.parseのsymbolize_namesオプション 🔗

JSON.parse('{"name": "Takagi"}', symbolize_names: true)
#=> {:name=>"Takagi"}

symbolize_keysメソッド 🔗

JSON.parse('{"name": "Takagi"}').symbolize_keys
#=> {:name=>"Takagi"}

※多次元の場合はdeep_symbolize_keys

キーをキャメルケースからスネークケースにする方法 🔗

JSON.parse('{"lastName": "Takagi"}').transform_keys(&:underscore)
#=> {"last_name"=>"Takagi"}

※多次元の場合はdeep_transform_keys

symbolize_namesオプションを使わず、symbolize_keysメソッドを使った理由 🔗

Symbolクラスにunderscoreメソッドが存在しないため

JSON.parse(File.open('spec/support/fixtures/devices.json').read, symbolize_names: true).deep_transform_keys(&:underscore)
#=> NoMethodError (undefined method `underscore' for :statusCode:Symbol)

SwitchBotのスマート加湿器が止まっていたら起動させるスクリプト

Wed, 27 Jan 2021 00:00:00 +0000

SwitchBotのスマート加湿器が振動によって安全装置が作動したのか、一定時間連続起動していると止まるのかわからないが、気がついたら止まっていることがある。
ということで、止まっていたら起動させるシェルスクリプトを書いて、Raspberry Piで動かすことにした。

さっそく実際にAPIを使って操作する事例ができた。（SwitchBotのスマート加湿器をAPIで操作する）

完成物 🔗

リポジトリ 🔗

コード 🔗

シェルスクリプトはあまり書きなれていないからこれでいいのかわからん。

#!/bin/bash

set -eu

SCRIPT_DIR=$(cd $(dirname $0); pwd)

source "${SCRIPT_DIR}/.env"

power=$(
  curl -s https://api.switch-bot.com/v1.0/devices/${SWITCHBOT_DEVICE_ID}/status \
    -H "Authorization: ${SWITCHBOT_API_TOKEN}" \
    | jq .body.power -r
)

if [[ $power = off ]]; then
  curl -s -X POST https://api.switch-bot.com/v1.0/devices/${SWITCHBOT_DEVICE_ID}/commands \
    -H "Authorization: ${SWITCHBOT_API_TOKEN}" \
    -H 'Content-Type: application/json' \
    -d '{"command": "turnOn","parameter": "default","commandType": "command"}' \
    -o /dev/null
fi

使い方 🔗

リポジトリのREADMEを参照。

SwitchBotのスマート加湿器をAPIで操作する

Tue, 19 Jan 2021 00:00:00 +0000

SwitchBotのスマート加湿器を買ったので、ご多分に漏れずAPIで操作してみる。
ちなみに買ったメインの目的が加湿器をAPIを使って操作してみたいという理由だけだけど、加湿器の機能としても大変満足している。

手順 🔗

ドキュメント: SwitchBotAPI/README.md at main · OpenWonderLabs/SwitchBotAPI

APIトークンを取得する 🔗

公式アプリから取得できる。（iPhoneでしか確認していないが、Androidも変わらないはず）

「プロフィール」をタップ
「設定」をタップ
「アプリバージョン」を10回タップ（「開発者向けオプション」が表示される）
「開発者向けオプション」をタップ（トークンが生成される）

デバイスを取得する 🔗

リクエスト 🔗

curl -X GET -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices

レスポンス 🔗

{
  "statusCode": 100,
  "body": {
    "deviceList": [
      {
        "deviceId": "AC0123456789",
        "deviceName": "リビング加湿器",
        "deviceType": "Humidifier",
        "enableCloudService": true,
        "hubDeviceId": "000000000000"
      },
      {
        "deviceId": "XX0123456789",
        "deviceName": "リビング温湿度計",
        "deviceType": "Meter",
        "enableCloudService": false,
        "hubDeviceId": "000000000000"
      }
    ],
    "infraredRemoteList": []
  },
  "message": "success"
}

デバイスのステータスを取得する 🔗

リクエスト 🔗

$ curl -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices/AC0123456789/status

レスポンス 🔗

{
  "statusCode": 100,
  "body": {
    "deviceId": "AC0123456789",
    "deviceType": "Humidifier",
    "hubDeviceId": "000000000000",
    "nebulizationEfficiency": 1,
    "humidity": 43,
    "auto": true,
    "childLock": false,
    "sound": true,
    "power": "off",
    "temperature": "19.9"
  },
  "message": "success"
}

デバイスにコマンドを送信する 🔗

https://github.com/OpenWonderLabs/SwitchBotAPI/blob/main/README.md#command-set-for-physical-devices

電源をオン 🔗

リクエスト 🔗

curl -X POST -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices/AC0123456789/commands -H 'Content-Type: application/json' -d '{"command": "turnOn","parameter": "default","commandType": "command"}''

{
  "command": "turnOn",
  "parameter": "default",
  "commandType": "command"
}

レスポンス 🔗

{ "statusCode": 100, "body": {}, "message": "success" }

電源をオフ 🔗

リクエスト 🔗

curl -X POST -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices/AC0123456789/commands -H 'Content-Type: application/json' -d '{"command": "turnOff","parameter": "default","commandType": "command"}''

{
  "command": "turnOff",
  "parameter": "default",
  "commandType": "command"
}

レスポンス 🔗

同じなので省略

モードをオートに変更 🔗

リクエスト 🔗

curl -X POST -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices/AC0123456789/commands -H 'Content-Type: application/json' -d '{"command": "setMode","parameter": "auto","commandType": "command"}''

{
  "command": "setMode",
  "parameter": "auto",
  "commandType": "command"
}

レスポンス 🔗

同じなので省略

モードを中に変更 🔗

リクエスト 🔗

curl -X POST -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices/AC0123456789/commands -H 'Content-Type: application/json' -d '{"command": "setMode","parameter": "102","commandType": "command"}''

{
  "command": "setMode",
  "parameter": "102",
  "commandType": "command"
}

レスポンス 🔗

同じなので省略

モードを霧化効率80%に変更 🔗

リクエスト 🔗

curl -X POST -H 'Authorization: token' https://api.switch-bot.com/v1.0/devices/AC0123456789/commands -H 'Content-Type: application/json' -d '{"command": "setMode","parameter": "80","commandType": "command"}''

{
  "command": "setMode",
  "parameter": "80",
  "commandType": "command"
}

レスポンス 🔗

同じなので省略

Nature RemoのローカルAPIを叩いて家電を操作する

Fri, 15 Jan 2021 00:00:00 +0000

Nature Remoはアプリなどから操作した際、たとえ家に居たとしてもクラウドAPIを経由して実行される仕様になっている
この仕様のせいで、Nature Remoのクラウドで障害が起きたときに電気が消すことができなくて不便な思いをしたので、次に障害が起きても問題ないようにローカルAPI経由でも家電を操作できるようにしておく

手順 🔗

公式ドキュメント: https://local-swagger.nature.global/

Nature RemoのIPアドレスを確認 🔗

Instance Nameを特定する 🔗

$ dns-sd -B _remo._tcp
Browsing for _remo._tcp
DATE: ---Thu 14 Jan 2021---
21:00:16.807  ...STARTING...
Timestamp     A/R    Flags  if Domain               Service Type         Instance Name
21:00:21.766  Add        2   6 local.               _remo._tcp.          Remo-XXXXXX

IPアドレスを確認 🔗

Instance Nameに.localを追加

$ dns-sd -G v4 Remo-XXXXXX.local
DATE: ---Thu 14 Jan 2021---
21:00:47.557  ...STARTING...
Timestamp     A/R    Flags if Hostname                               Address                                      TTL
21:00:47.557  Add 40000002  6 Remo-XXXXXX.local.                     192.168.10.3                                 120

赤外線信号の受信 🔗

Nature Remo本体にリモコンで信号を送ったあとに以下を実行する

$ curl -X GET http://192.168.10.3/messages -H "X-Requested-With: curl" -H "Expect:"
{"format":"us","freq":36,"data":[3401,1821,353,516,358,1387,356,506,361,509,360,509,360,510,383,482,353,516,353,516,358,508,358,510,360,509,358,511,350,1391,358,513,363,517,347,524,359,515,358,516,358,516,357,517,361,511,354,519,361,1386,355,517,360,510,348,514,353,516,363,507,358,507,386,483,360,509,359,1384,352,516,380,1361,350,1391,360,1387,361,1384,448,419,358,510,357,1383,360,509,442,1302,394,1354,356,1380,354,1392,358,509,353,1390,392,65535,0,8885,3403,1821,360,506,354,1390,359,509,359,511,358,506,363,507,353,516,360,82,65535,427,356,508,361,510,357,511,454,410,365,504,363,1382,348,524,352,521,352,525,357,520,355,518,356,517,356,515,359,514,361,513,362,1385,351,518,359,512,349,514,360,510,359,510,357,511,454,414,360,507,358,1384,352,517,359,1379,361,1382,360,1387,361,1383,354,515,350,518,360,1383,351,513,353,1392,358,1386,361,1384,358,1385,356,510,382,1360,357,65535,0,8923,3403,1825,349,523,359,1391,356,506,361,511,413,456,358,509,357,510,359,508,352,517,358,507,351,518,360,510,383,486,357,1381,362,508,350,518,358,511,355,511,359,509,353,518,356,511,358,507,361,510,358,1384,359,510,357,509,358,87,65535,422,362,506,361,508,359,507,359,512,358,508,352,1393,356,515,405,1343,358,1385,358,1382,354,1388,360,515,358,516,359,1390,355,511,358,1384,351,1392,358,1385,350,1394,360,509,362,1380,351]}

赤外線信号の送信 🔗

受信時に受け取ったものをそのままPOSTで送ってあげればよい

$ curl -X POST http://192.168.10.3/messages -H "X-Requested-With: curl" -H "Expect:" -d '{"format":"us","freq":36,"data":[3401,1821,353,516,358,1387,356,506,361,509,360,509,360,510,383,482,353,516,353,516,358,508,358,510,360,509,358,511,350,1391,358,513,363,517,347,524,359,515,358,516,358,516,357,517,361,511,354,519,361,1386,355,517,360,510,348,514,353,516,363,507,358,507,386,483,360,509,359,1384,352,516,380,1361,350,1391,360,1387,361,1384,448,419,358,510,357,1383,360,509,442,1302,394,1354,356,1380,354,1392,358,509,353,1390,392,65535,0,8885,3403,1821,360,506,354,1390,359,509,359,511,358,506,363,507,353,516,360,82,65535,427,356,508,361,510,357,511,454,410,365,504,363,1382,348,524,352,521,352,525,357,520,355,518,356,517,356,515,359,514,361,513,362,1385,351,518,359,512,349,514,360,510,359,510,357,511,454,414,360,507,358,1384,352,517,359,1379,361,1382,360,1387,361,1383,354,515,350,518,360,1383,351,513,353,1392,358,1386,361,1384,358,1385,356,510,382,1360,357,65535,0,8923,3403,1825,349,523,359,1391,356,506,361,511,413,456,358,509,357,510,359,508,352,517,358,507,351,518,360,510,383,486,357,1381,362,508,350,518,358,511,355,511,359,509,353,518,356,511,358,507,361,510,358,1384,359,510,357,509,358,87,65535,422,362,506,361,508,359,507,359,512,358,508,352,1393,356,515,405,1343,358,1385,358,1382,354,1388,360,515,358,516,359,1390,355,511,358,1384,351,1392,358,1385,350,1394,360,509,362,1380,351]}'
{}

参考 🔗

Toggl APIで前日の総作業時間を取得する

Sat, 25 Jul 2020 00:00:00 +0000

APIで取得できる項目はいろいろあるけど、前日の作業時間だけ欲しかったのでそれだけ調べたメモ

手順 🔗

API Tokenの取得 🔗

プロフィールページの下の方に表示されている
https://toggl.com/app/profile

curlで叩く 🔗

api_tokenとworkspace_idはドキュメントに載ってたダミー

curl -u 1971800d4d82861d8f2c1651fea4d212:api_token -X GET "https://toggl.com/reports/api/v2/summary?user_agent=api_test&workspace_id=123&since=2020-07-24&until=2020-07-24"

user_agent: 必須。アプリケーション名かメールアドレス
workspace_id: 必須。ReportsページのURLに含まれている
since: 開始日（Defaults to today - 6 days.）
until: 終了日（Defaults to today, unless since is in future or more than year ago, in this case until is since + 6 days.）

結果 🔗

{
  "total_grand": 6188000,
  "total_billable": null,
  "total_currencies": [
    {
      "currency": null,
      "amount": null
    }
  ],
  "data": [
    {
      "id": 162312870,
      "title": {
        "project": "ブログ活動",
        "client": null,
        "color": "0",
        "hex_color": "#d92b2b"
      },
      "time": 3777000,
      "total_currencies": [
        {
          "currency": null,
          "amount": null
        }
      ],
      "items": [
        {
          "title": {
            "time_entry": ""
          },
          "time": 3777000,
          "cur": null,
          "sum": null,
          "rate": null
        }
      ]
    },
    {
      "id": 162307142,
      "title": {
        "project": "英語学習",
        "client": null,
        "color": "0",
        "hex_color": "#c9806b"
      },
      "time": 428000,
      "total_currencies": [
        {
          "currency": null,
          "amount": null
        }
      ],
      "items": [
        {
          "title": {
            "time_entry": ""
          },
          "time": 428000,
          "cur": null,
          "sum": null,
          "rate": null
        }
      ]
    },
    {
      "id": 162354173,
      "title": {
        "project": "読書",
        "client": null,
        "color": "0",
        "hex_color": "#0b83d9"
      },
      "time": 1983000,
      "total_currencies": [
        {
          "currency": null,
          "amount": null
        }
      ],
      "items": [
        {
          "title": {
            "time_entry": ""
          },
          "time": 1983000,
          "cur": null,
          "sum": null,
          "rate": null
        }
      ]
    }
  ]
}

jqで総作業時間を取得 🔗

total_grandが総作業時間（単位はms）

curl -u 1971800d4d82861d8f2c1651fea4d212:api_token -X GET "https://toggl.com/reports/api/v2/summary?user_agent=api_test&workspace_id=123&since=2020-07-24&until=2020-07-24" | jq .total_grand
6188000

参考 🔗

toggl_api_docs/reports.md at master · toggl/toggl_api_docs
toggl_api_docs/summary.md at master · toggl/toggl_api_docs

Pixelaを使ってみる

Thu, 23 Jul 2020 00:00:00 +0000

Pixela 🔗

あなたの頑張りや継続を記録し、育てたい。そのすべてを、APIで。 Pixela はAPIサービスです。このサービスを使えば、あなたの日々の様々な活動量を GitHub のような鮮やかなグラフで表現することができます。そのすべての操作を、APIで。もちろん、無料です。

Pixela | あなたの頑張りや継続を記録し、育てたい。そのすべてを、APIで。

使い方 🔗

たったの3ステップでできる

ユーザーの作成 🔗

$ curl -X POST https://pixe.la/v1/users -d '{"token":"password", "username":"takagi", "agreeTermsOfService":"yes", "notMinor":"yes"}'

token: パスワード
username: ユーザー名
agreeTermsOfService: サービスの利用規約に同意したか
notMinor: 未成年ではないか。未成年の場合、保護者の了承は得ているか

グラフの作成 🔗

$ curl -X POST https://pixe.la/v1/users/takagi/graphs -H 'X-USER-TOKEN:password' -d '{"id":"test-graph","name":"graph-name","unit":"commit","type":"int","color":"shibafu"}'

X-USER-TOKEN: パスワード
id: グラフのID
name: グラフの名前
unit: 記録する値の単位
type: 記録する値の型
- int
- float
color: グラフの色
- shibafu (緑)
- momiji (赤)
- sora (青)
- ichou (黄)
- ajisai (紫)
- kuro (黒)

作成したグラフ 🔗

値の登録 🔗

$ curl -X POST https://pixe.la/v1/users/takagi/graphs/test-graph -H 'X-USER-TOKEN:password' -d '{"date":"20200723","quantity":"5"}'

date: 日付
quantity: 値

値を登録したグラフ 🔗

その他の使い方 🔗

APIドキュメントに詳しく書いてある。 Pixela API Document - Pixela API Document

その中で実際に使ってみた使い方

パスワードの変更 🔗

$ curl -X PUT https://pixe.la/v1/users/takagi -H 'X-USER-TOKEN:password' -d '{"newToken":"new_password"}'

グラフの単位の変更 🔗

$ curl -X PUT https://pixe.la/v1/users/takagi/graphs/test-graph -H 'X-USER-TOKEN:password' -d '{"unit":"point"}'

値の変更 🔗

$ curl -X PUT https://pixe.la/v1/users/takagi/graphs/test-graph/20200723 -H 'X-USER-TOKEN:password' -d '{"quantity":"15"}'

値の削除 🔗

$ curl -X DELETE https://pixe.la/v1/users/takagi/graphs/test-graph/20200723 -H 'X-USER-TOKEN:password'

（小学生並みの）感想 🔗

APIがしっかり作り込まれててすごい

Nature Remo Cloud APIを使って家電を操作する時のメモ

Tue, 19 Nov 2019 00:00:00 +0000

ドキュメント 🔗

https://swagger.nature.global/

トークンの発行 🔗

https://home.nature.global/

手順 🔗

認証確認 🔗

$ curl -X GET "https://api.nature.global/1/users/me" -H "Authorization: Bearer Authorization: Bearer {取得したトークン}" | jq .
{
  "id": "{User ID}",
  "nickname": "ytkg"
}

電化製品一覧取得 🔗

$ curl -X GET "https://api.nature.global/1/appliances" -H "Authorization: Bearer {取得したトークン}" | jq .
[
  {
    "id": "{Appliance ID}",
    "device": {
      "name": "Remo",
      "id": "{Device ID}",
      "created_at": "2017-05-20T09:52:53Z",
      "updated_at": "2019-11-16T15:58:16Z",
      "mac_address": "{Mac Address}",
      "serial_number": "{Serial Number}",
      "firmware_version": "Remo/1.0.39-g41c1188",
      "temperature_offset": 0,
      "humidity_offset": 0
    },
    "model": null,
    "type": "IR",
    "nickname": "電気",
    "image": "ico_av",
    "settings": null,
    "aircon": null,
    "signals": [
      {
        "id": "{ONのSignal ID}",
        "name": "ON",
        "image": "ico_on"
      },
      {
        "id": "{OFFのSignal ID}",
        "name": "OFF",
        "image": "ico_off"
      }
    ]
  },
  {
    省略
  }
]

電化製品を操作する赤外線を送る 🔗

curl -X POST "https://api.nature.global/1/signals/{Signal ID}/send" -H "Authorization: Bearer {取得したトークン}"

Rubyで書くと 🔗

require 'faraday'

client = Faraday.new url: 'https://api.nature.global'
token = '{トークン}'
client.headers['Authorization'] = "Bearer #{token}"

response = client.get do |req|
  req.url '/1/appliances'
end

JSON.parse(response.body)

signal_id = 'Signal ID'
client.post do |req|
  req.url "/1/signals/#{signal_id}/send"
end

映画の公開日情報は映画.comがiCalフォーマットで公開してくれていた

Sun, 04 Aug 2019 00:00:00 +0000

映画の公開日を取得できるAPIってないのかなと探していたら、映画.com がAPIではないけれど、iCalフォーマットで公開してくれていたのでこれを使うことにする。

iCal公開予定スケジュール - 映画.com

$ curl -s https://eiga.com/movie/coming.ics |head -n 53
BEGIN:VCALENDAR
VERSION:2.0
PRODID:icalendar-ruby
CALSCALE:GREGORIAN
METHOD:PUBLISH
X-WR-CALNAME:公開スケジュール - 映画.com
X-WR-CALDESC:今週末以降、公開予定の映画作品・上映スケ
 ジュールのカレンダーです。
X-WR-TIMEZONE:Asia/Tokyo
X-WR-RELCALID:e34ddde7-3e5e-5a98-69ed-c61f22710c56
BEGIN:VEVENT
DTSTAMP:20190803T080034Z
UID:eiga.com_91480
DTSTART:20190727T000000
DTEND:20190728T000000
DESCRIPTION:受け口にコンプレックスを抱く少年を主人公に
 、いじめを受けている当事者への無理解や周囲との違
 いを理解することなどを描いた短編作品。カナザワ映
 画祭2017「期待の新人監督」特別賞、第18回TAMA NEW WAVEコ
 ンペティション特別賞など、国内のインディペンデン
 ト映画祭で数多く受賞を果たした。小学6年生の少年・
 光は受け口が悩みで、マスクをつけて学校へ行くよう
 になる。両親は矯正のため光を歯科に連れて行くが、
 顎の矯正には18歳頃になってから手術が必要と知らされ
 る。人との違いに悩みを、クラスになじめない光の日
 常は続くが……。\n作品紹介ページ：https://eiga.com/movie/9
 1480/
SUMMARY:アマノジャク・思春期
END:VEVENT
BEGIN:VEVENT
DTSTAMP:20190803T080034Z
UID:eiga.com_91179
DTSTART:20190727T000000
DTEND:20190728T000000
DESCRIPTION:激しい情念を宿した生き人形が引き起こす惨劇
 を描くフィリピン製ホラー。バス事故によって愛する
 娘を失ったフェイス、フリオ、ステラ。心理学者のマ
 ノロ博士は、3人の耐え難い悲しみを癒やすため、それ
 ぞれの娘の姿に似せた等身大の人形を置いていく。フ
 ェイスは亡き娘マリアにそっくりのリアルな人形に強
 い抵抗感を抱くが、次第に我が子同然の愛情を注ぐよ
 うになっていく。マノロ博士の実験は成功したかに見
 えたが、やがて3人の周囲で不可解な事件が起こり始め
 る。出演は「ダイ・ビューティフル」のイザ・カルザ
 ド、「ローサは密告された」のマリア・イサベル・ロ
 ペス。監督はフィリピンを代表するヒットメーカーで
 、16年に49歳の若さで急逝したウェン・V・デラマス。新
 宿シネマカリテの特集企画「カリコレ2019／カリテ・フ
 ァンタスティック！シネマコレクション2019」（19年7月1
 3日～8月9日）上映作品。\n作品紹介ページ：https://eiga.co
 m/movie/91179/
SUMMARY:生き人形マリア
END:VEVENT

BEGIN:VEVENTからEND:VEVENTまでが1つの映画の情報で、 DTSTARTが公開日、SUMMARYがタイトルになっている感じ。十分使えそうだ。

パーサーがないときついなと思ったらちゃんとgemもあった。よきよき。

https://github.com/icalendar/icalendar

require 'open-uri'
require 'icalendar'

event_file = open('https://eiga.com/movie/coming.ics').read

events = Icalendar::Event.parse(event_file)
events.each do |event|
  puts "公開日: #{event.dtstart.strftime('%Y年%m月%d日')}, タイトル: #{event.summary}"
end

公開日: 2019年07月27日, タイトル: アマノジャク・思春期
公開日: 2019年07月27日, タイトル: 生き人形マリア
公開日: 2019年07月27日, タイトル: キスは命がけ！
公開日: 2019年07月27日, タイトル: 北の果ての小さな村で
公開日: 2019年07月27日, タイトル: 教科書にないッ！5
公開日: 2019年07月27日, タイトル: 隣の影
公開日: 2019年07月27日, タイトル: 浜の記憶
公開日: 2019年07月27日, タイトル: パラダイス・ネクスト
公開日: 2019年07月27日, タイトル: ブレス　あの波の向こうへ
公開日: 2019年07月27日, タイトル: ホール・イン・ザ・グラウンド
公開日: 2019年07月27日, タイトル: 約束の時間
公開日: 2019年07月28日, タイトル: 教科書にないッ！6
公開日: 2019年07月31日, タイトル: チャーリー・セズ　マンソンの女たち
公開日: 2019年08月01日, タイトル: 4×4 殺人四駆
公開日: 2019年08月02日, タイトル: あなたの名前を呼べたなら
公開日: 2019年08月02日, タイトル: 風をつかまえた少年
公開日: 2019年08月02日, タイトル: 守護教師
公開日: 2019年08月02日, タイトル: 世界の涯ての鼓動
公開日: 2019年08月02日, タイトル: トム・オブ・フィンランド
公開日: 2019年08月02日, タイトル: ドラゴンクエスト　ユア・ストーリー
公開日: 2019年08月02日, タイトル: ワイルド・スピード　スーパーコンボ
公開日: 2019年08月03日, タイトル: 悪魔の舞を手に入れし者
公開日: 2019年08月03日, タイトル: エモーショナルレモン　旅立ちはいつもレモンの味がする、あなたはどんな味がする？
公開日: 2019年08月03日, タイトル: グッド・ヴァイブレーションズ
公開日: 2019年08月03日, タイトル: サマー・オブ・84
公開日: 2019年08月03日, タイトル: 太陽がほしい　劇場版
公開日: 2019年08月03日, タイトル: 東京裁判
公開日: 2019年08月03日, タイトル: 夏少女
公開日: 2019年08月03日, タイトル: 飄々　拝啓、大塚康生様
公開日: 2019年08月03日, タイトル: メランコリック
公開日: 2019年08月03日, タイトル: 優しいシャツ　カナタソウタロウの旅
公開日: 2019年08月03日, タイトル: 私たちは、
公開日: 2019年08月07日, タイトル: BRING THE SOUL: THE MOVIE
以下略

映画ってこんなに公開されてるんだな

codicのAPIをRubyで試してみる

Fri, 07 Jun 2019 00:00:00 +0000

前回の記事の続き的な。(codicのAPIを試してみる | 高木のブログ )
Rubyで書くとこんな感じになる。

require 'net/http'
require 'uri'
require 'json'

uri = URI.parse(URI.encode('https://api.codic.jp/v1/engine/translate.json?text=記事を書く&casing=lower+underscore'))
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer {ACCESS_TOKEN}'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

JSON.parse(response.body)
# => [
#        {
#            "successful": true,
#            "text": "記事を書く",
#            "translated_text": "write_article",
#            "words": [
#                {
#                    "successful": true,
#                    "text": "書く",
#                    "translated_text": "write",
#                    "candidates": [
#                        {
#                            "text": "write"
#                        },
#                        {
#                            "text": "writing"
#                        }
#                    ]
#                },
#                {
#                    "successful": true,
#                    "text": "を",
#                    "translated_text": null,
#                    "candidates": [
#                        {
#                            "text": null
#                        },
#                        {
#                            "text": "that"
#                        },
#                        {
#                            "text": "to"
#                        },
#                        {
#                            "text": "for"
#                        },
#                        {
#                            "text": "from"
#                        },
#                        {
#                            "text": "is"
#                        },
#                        {
#                            "text": "of"
#                        }
#                    ]
#                },
#                {
#                    "successful": true,
#                    "text": "記事",
#                    "translated_text": "article",
#                    "candidates": [
#                        {
#                            "text": "article"
#                        },
#                        {
#                            "text": "posts"
#                        },
#                        {
#                            "text": "post"
#                        },
#                        {
#                            "text": "news"
#                        }
#                    ]
#                }
#            ]
#        }
#    ]

codicのAPIを試してみる

Thu, 06 Jun 2019 00:00:00 +0000

いつもお世話になってるcodicにAPIがあったので試してみる。もちろん認証が必要。
トークンの取得とか使い方の説明は以下を参照
API | codic

手順 🔗

こんな感じでcurlを叩く。

$ curl -H "Authorization: Bearer {ACCESS_TOKEN}" "https://api.codic.jp/v1/engine/translate.json?text=記事を書く&casing=lower+underscore"

実際に叩いてみた結果。

$ curl -H "Authorization: Bearer {ACCESS_TOKEN}" "https://api.codic.jp/v1/engine/translate.json?text=記事を書く&casing=lower+underscore"
[{"successful":true,"text":"\u8a18\u4e8b\u3092\u66f8\u304f","translated_text":"write_article","words":[{"successful":true,"text":"\u66f8\u304f","translated_text":"write","candidates":[{"text":"write"},{"text":"writing"}]},{"successful":true,"text":"\u3092","translated_text":null,"candidates":[{"text":null},{"text":"that"},{"text":"to"},{"text":"for"},{"text":"from"},{"text":"is"},{"text":"of"}]},{"successful":true,"text":"\u8a18\u4e8b","translated_text":"article","candidates":[{"text":"article"},{"text":"posts"},{"text":"post"},{"text":"news"}]}]}]

見にくいし、文字があれなので、jq使う。

[Dev:~]$ curl -H "Authorization: Bearer {ACCESS_TOKEN}" "https://api.codic.jp/v1/engine/translate.json?text=記事を書く&casing=lower+underscore" | jq .
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   554  100   554    0     0   1355      0 --:--:-- --:--:-- --:--:--  1354
[
  {
    "successful": true,
    "text": "記事を書く",
    "translated_text": "write_article",
    "words": [
      {
        "successful": true,
        "text": "書く",
        "translated_text": "write",
        "candidates": [
          {
            "text": "write"
          },
          {
            "text": "writing"
          }
        ]
      },
      {
        "successful": true,
        "text": "を",
        "translated_text": null,
        "candidates": [
          {
            "text": null
          },
          {
            "text": "that"
          },
          {
            "text": "to"
          },
          {
            "text": "for"
          },
          {
            "text": "from"
          },
          {
            "text": "is"
          },
          {
            "text": "of"
          }
        ]
      },
      {
        "successful": true,
        "text": "記事",
        "translated_text": "article",
        "candidates": [
          {
            "text": "article"
          },
          {
            "text": "posts"
          },
          {
            "text": "post"
          },
          {
            "text": "news"
          }
        ]
      }
    ]
  }
]

変換されたものだけじゃなくて単語ごとの候補も出してくれるっぽい。
何かに使えたら使ってみよう。

Google Books APIsを使ってISBNから書籍情報を取得する

Thu, 07 Mar 2019 00:00:00 +0000

https://www.googleapis.com/books/v1/volumes?q=isbn:[書籍のISBN]

こんな感じになる

$ curl -s https://www.googleapis.com/books/v1/volumes?q=isbn:4582824773 | jq .
{
  "items": [
    {
      "searchInfo": {
        "textSnippet": "ひきこもりから瞬く間に「IT長者」へ―驚愕のロングセラー『こんな僕でも社長になれた』を凌ぐ、その後の転落・逃亡・孤立を巡るどん底物語と、都知事選の裏側、そして“い ..."
      },
      "accessInfo": {
        "quoteSharingAllowed": false,
        "accessViewStatus": "NONE",
        "country": "JP",
        "viewability": "NO_PAGES",
        "embeddable": false,
        "publicDomain": false,
        "textToSpeechPermission": "ALLOWED",
        "epub": {
          "isAvailable": false
        },
        "pdf": {
          "isAvailable": false
        },
        "webReaderLink": "http://play.google.com/books/reader?id=zV_SsgEACAAJ&hl=&printsec=frontcover&source=gbs_api"
      },
      "saleInfo": {
        "isEbook": false,
        "saleability": "NOT_FOR_SALE",
        "country": "JP"
      },
      "volumeInfo": {
        "canonicalVolumeLink": "https://books.google.com/books/about/%E6%88%91%E3%81%8C%E9%80%83%E8%B5%B0.html?hl=&id=zV_SsgEACAAJ",
        "infoLink": "http://books.google.co.jp/books?id=zV_SsgEACAAJ&dq=isbn:4582824773&hl=&source=gbs_api",
        "previewLink": "http://books.google.co.jp/books?id=zV_SsgEACAAJ&dq=isbn:4582824773&hl=&cd=1&source=gbs_api",
        "language": "ja",
        "imageLinks": {
          "thumbnail": "http://books.google.com/books/content?id=zV_SsgEACAAJ&printsec=frontcover&img=1&zoom=1&source=gbs_api",
          "smallThumbnail": "http://books.google.com/books/content?id=zV_SsgEACAAJ&printsec=frontcover&img=1&zoom=5&source=gbs_api"
        },
        "contentVersion": "preview-1.0.0",
        "allowAnonLogging": false,
        "maturityRating": "NOT_MATURE",
        "title": "我が逃走",
        "authors": [
          "家入一真"
        ],
        "publishedDate": "2015-05-25",
        "description": "ひきこもりから瞬く間に「IT長者」へ―驚愕のロングセラー『こんな僕でも社長になれた』を凌ぐ、その後の転落・逃亡・孤立を巡るどん底物語と、都知事選の裏側、そして“いま”を克明に描く衝撃作、満を持して刊行!!",
        "industryIdentifiers": [
          {
            "identifier": "4582824773",
            "type": "ISBN_10"
          },
          {
            "identifier": "9784582824773",
            "type": "ISBN_13"
          }
        ],
        "readingModes": {
          "image": false,
          "text": false
        },
        "pageCount": 335,
        "printType": "BOOK"
      },
      "selfLink": "https://www.googleapis.com/books/v1/volumes/zV_SsgEACAAJ",
      "etag": "W8tHI2/C/bo",
      "id": "zV_SsgEACAAJ",
      "kind": "books#volume"
    }
  ],
  "totalItems": 1,
  "kind": "books#volumes"
}

登録とかなしでここまでの情報が取れるのは便利
本の定価が取れたらよかったんだけどなあ