RailsのAPIモードを試してみた話

RailsAPIモードを試してみた話

はじめに

これは香川大学工学部サークルSLPのアドベントカレンダー14日目の記事です。 前後、怖い人に挟まれていますが頑張ります(ガクブル)。 今回はRails5から実装されたAPIモードを使ってAPIサーバを構築し、様々な言語でHTTPリクエストを送ってみたいと思います。 かなり緩くやっていけたらなと思います。

APIモードとは

API作成に特化したモードのことで、Rails5で実装された機能らしいです。 簡単に今までのRailsとの違いを説明すると、MVCでいう、Viewの部分が存在しません。 変わりにそのURLにアクセスするとerbを返さず、jsonを返す仕様になっています。 また、標準で入っているGemもViewの分が必要なくなっているので、普通に立ち上げたRailsのプロジェクトよりも少なくなっています。 詳しくは各々で調べてみてください。

とりあえず使ってみた

さっそくですが、RailsAPIモードを使って、APIサーバを構築してみたいと思います。 今回は名前と学籍番号を管理するAPIを構築してみます。

今回使用した開発環境をざっくり紹介するとこんな感じです。
- Ubuntu16.04
- Ruby 2.4.1
- Rails 5.1.4

それではまず、プロジェクトを立ち上げます。

Rails new name_api --api

プロジェクト名の後に、 --apiをつけることでAPIモードでプロジェクトが立ち上がります。 --apiをつけなければ今まで通りのRailsのプロジェクトとして立ち上がります(当たり前)。 では、プロジェクトの中に入ってみましょう。

cd name_api

Railsらしく、様々なディレクトリとファイルが生成されていると思います。 今回は手早くRESTfulなAPIを作りたいのでscaffoldを使います。 基本的にはAPIモードでもRailsのコマンドは同じように使えるみたいです。 それでは、コマンドを入力していきます。

rails g scaffold User name:string number:string

ずらーっと色々と表示されたと思います。createとかinvokeとかrouteが出てきて、正常に終わっていればOKです。 私側の実行では、以下のように表示されました。

Running via Spring preloader in process 19815
      invoke  active_record
      create    db/migrate/20171205074009_create_users.rb
      create    app/models/user.rb
      invoke    test_unit
      create      test/models/user_test.rb
      create      test/fixtures/users.yml
      invoke  resource_route
       route    resources :users
      invoke  scaffold_controller
      create    app/controllers/users_controller.rb
      invoke    test_unit
      create      test/controllers/users_controller_test.rb

そしてmigrateします。

rails db:create && rails db:migrate

これでAPI側の実装はほとんど終わりです(すごく簡単!!)。 それではサーバを立ち上げてみましょう。

rails server -b=0.0.0.0

無事に起動したら、アクセスしてみます。

http://localhost:3000

アクセスできたら、いつものRailsのページが表示されると思います。

ルーティングを確認

以下のコマンドを入力して、ルーティングを確認します。

rails routes

以下のように表示されていると思います。

Prefix Verb   URI Pattern          Controller#Action
 users GET    /users(.:format)     users#index
       POST   /users(.:format)     users#create
  user GET    /users/:id(.:format) users#show
       PATCH  /users/:id(.:format) users#update
       PUT    /users/:id(.:format) users#update
       DELETE /users/:id(.:format) users#destroy

ためしに、users#indexにアクセスしてみます。

http://localhost:3000/users

通常、scaffoldを使うとあらかじめ完成されたページが表示されると思います。しかし、今回の場合だと、 [ ] だけが表示されたと思います。 なぜかというと、controllerを見ればわかりますが、APIモードでは、erbではなく、JSONを返してくれているからなのです。 [ ] なのは、まだ何もレコードされていないからですね。

様々な方法でPOSTしてみる

それでは、このAPIにPOSTリクエストを送ってみます。 基本的にはHTTPリクエストで、JSONをPOSTしてあげればOKです。 POSTするURLは先ほど確認したのでそれに従います。 今回の場合であれば以下のURLにPOSTしてあげればよさそうです。

http://localhost:3000/users

curlでPOST

curl -X POST -H "Content-Type: application/json" -d '{"name": "明示カール", "number": "17t200"}' http://localhost:3000/users

RubyでPOST

post.rb

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

url = "http://localhost:3000/hoges"
sample_data = {"name": "白沢ルビィ" : "number": "16t200"}

uri = URI.parse(url)

http = Net::HTTP.new(uri.host, uri.port)
req = Net::HTTP::Post.new(uri.request_uri)
req["Content-Type"] = "application/json"
req.body = sample_data.to_json
res = http.request(req)

Python3でPOST

post.py

import requests
import json

url = 'http://localhost:3000/hoges'
method = "POST"
obj = {"name" : "本田パイソン", "number": "15t200"}
json_data = json.dumps(obj).encode("utf-8")

response = requests.post(url, json.dumps(obj), headers = {'Content-Type' : 'application/json'})
print(response.text)

JavaScriptでPOST

JavaScriptでPOSTする場合API側の設定を少し変更してあげなければなりません。 変更点は以下の記事を参考にしてみてください。 https://qiita.com/kaorumori/items/0a53c248343892c8f35c

index.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <title>JavaScriptからPOSTでJSONデータを送信する</title>
    <script src="jquery.js"></script>
    <script src="post.js"></script>
  </head>
  <body>
    <p>
      URL: <input type="text" id="url_post" name="url" size="100" value="http://localhost:3000/users">
    </p>
    <p>
      name:<input type="text" id="name" size="30" value="じゃばすく太郎">
    </p>
    <p>
      number:<input type="text" id="number" size="30" value="13T200">
    </p>
    <p>
      <button id="button" type="button">Submit</button></p>
    </p>
  </body>
</html>

post.js

$(function(){
  $("#response").html("Response Value");

  $("#button").click( function(){
    const url = $("#url_post").val();

    const JSONdata = {
      name: $("#name").val(),
      number: $("#name").val()
    };

    alert(JSON.stringify(JSONdata));

    $.ajax({
      type : 'post',
      url : url,
      data : JSON.stringify(JSONdata),
      contentType : 'application/JSON',
      dataType : 'JSON',
      scritCharset : 'utf-8',
      succes : function(data) {
        alert("success");
        alert(JSON.stringify(data));
        $("#response").html(JSON.stringify(data));
      },
      error : function(data) {
        alert("error");
        alert(JSON.stringify(data));
        $("#response").html(JSON.stringify(data));
      }
    });
  });
});

今回のサンプルコードでは、jqueryを使用しました。 今回の場合ですと、jqeuryをjquery.jsとして同じ階層のディレクトリに置いておいてあげて解決しています。

POSTしたデータを確認してみる

それでは先ほど、POSTしたデータを確認してみましょう。 まずはすべてのPOSTしたすべてのデータを確認してみます。

http://localhost:3000/users

上記のURLにアクセスすると、先ほどと違いPOSTした内容がレコードされていると思います。 せっかくなのでGETリクエストを送ってデータを取得してみます。 今回は、手っ取り早くcurlを使います。

curl http://localhost:3000/users

取得したのがこちら。

[{"id":1,"name":"明示カール","number":"17t200","created_at":"2017-12-05T08:15:37.735Z","updated_at":"2017-12-05T08:15:37.735Z"},{"id":2,"name":"白沢ルビィ","number":"16t200","created_at":"2017-12-05T14:51:40.472Z","updated_at":"2017-12-05T14:51:40.472Z"},{"id":3,"name":"本田パイソン","number":"15t200","created_at":"2017-12-05T14:52:46.918Z","updated_at":"2017-12-05T14:52:46.918Z"},{"id":4,"name":null,"number":"じゃばすく太郎","created_at":"2017-12-05T15:00:04.685Z","updated_at":"2017-12-05T15:00:04.685Z"}]

created_atやupdated_atは違う値を保持しているはずですが、似たようなデータを取得できたと思います。 次にレコードしたデータを一つずつ取得してみます。 試しに1番目と2番目のデータを取得してみます。 1番目

curl http://localhost:3000:users/1
{"id":1,"name":"明示カール","number":"17t200","created_at":"2017-12-05T08:15:37.735Z","updated_at":"2017-12-05T08:15:37.735Z"}%

2番目

curl http://localhost:3000:users/2
{"id":2,"name":"白沢ルビィ","number":"16t200","created_at":"2017-12-05T14:51:40.472Z","updated_at":"2017-12-05T14:51:40.472Z"}%

いい感じに取得できました。

まとめ

雑な説明になってしまいましたがいかかだったでしょうか。 いろいろな部分の説明を省いているので、詳しく知りたい方はこの記事ををきっかけにAPIモードについて調べてもらえたらなと思います。 私自身は、今後このモードを使って、様々なAPIを作ってみて、それに対応したネイティブアプリやスマホアプリを作ってみたいです。

最後に・・・

この記事で作ったサンプルコードの出来が悪くても、多めにみてやってください...。

Raspberry Pi を使ってサーバを構築しよう

はじめに

最近大学の授業やその他の行事やバイトやらで、プログラミングを教える機会がかなり増えてきました。僕自身こういったプログラミングを教えれる立場になることは、大学に入学する前にやれたらいいなと思っていたことなので、いい傾向にあります。そこで今回はそれに少しだけちなんで、あると凄く便利なサーバの構築を、サーバってなんぞやとかサーバ構築してみたいけどお金かかりそうだし敷居高そうっていう人に向けて、記事を書いて行きたいと思います。なので今回は、サーバ構築の経験がある人や高度な技術を持っている人は優しい目でみてくださると幸いです。また、今回はRaspberry Piを使ってサーバを構築していきます。理由は記事内でも書いてますが手軽に使えて手頃な価格で入手できるからと言った理由から使います。あとなんか面白そうじゃないですか。

サーバとは

まずそもそもサーバとはなんぞやっていう人もいると思います。サーバとは簡単に言うといろいろなサービスを提供するシステムです。
例としてはファイルサーバやSSHサーバやDNSサーバなど色々なものがあります。有名なものとしてはマインクラフトのゲームサーバもサーバの一種ですね。今回の記事ではSSHサーバについて取り扱っていきます。
長々と説明するより実際に作ってみたほうが理解しやすいと思うので早速サーバを構築していきましょう。

環境構築

まずはRaspberry Piをサーバとして使えるように環境を整えていきましょう。
今回紹介する例は僕の動作環境なのであくまで参考程度に環境を構築してみてください。

Raspberry Piでサーバを構築する際の大きな利点は以下の通りのことがあるかと。

  • Raspberry PiがPCに比べて安い
  • USBメモリを使うので簡単に組み立てられる
  • バイルバッテリーを使うことにより非常時の電源にもできる
  • とても小さいので場所に困らない

まあようするに手軽に使えるし必要な物も安く集められるのです。

それでは実際にOSをインストールしてSSHで接続するところまでやっていきましょう。


OSのインストールしよう

今回使用するOSはRaspbianというものです。Raspberry Piで使えるメジャーなOSだと思います。  他にもArch Linuxやwindows10Iotなどもありますがそれはお好みで使ってみてください(僕は使ったことがありません...)。 OSのインストール自体はRaspbianのサイトから入手してSDカードに書き込むだけです。

インストールの手順は以下の通りにすればできると思います。

  1. サイトからNOOBSのzipを入手 https://www.raspberrypi.org/downloads/noobs/
  2. 入手したzipフォルダを解凍しSDカードにコピーする
  3. Raspberry piにSDカードを差し込み起動する
  4. インストールするものを選択する画面になると思いますのでRaspbianを選択(この時画面下にある言語選択で自分の使いたい言語を選ぶと良い)
  5. Installを選択
  6. 本当に書き込んでいいですかと言ったことを聞かれるのではい(Yes)を選択する

これでインストールの作業は終わりです。

すごく簡単にできましたね。

それでは次にSSHを使えるように設定していきます。


SSHを有効化しよう

Raspberry PiSSH接続するにはSSHを有効化する必要があります。Ctrl+Alt+Tでターミナルを起動して以下のコマンドを入力しましょう。

$sudo raspi-config

すると設定画面のようなものが出てくると思います。
この中からAdvanced Optionsを選択してください。
次にA4のSSHを選択してください。
次の画面ではYesを選択してください。
これでRaspberry piSSHが有効になりました。

ここまできたらSSHで接続してみましょう。

実際にSSHで接続してみよう

ここまで色々環境構築をしてきましたがこれで一旦環境構築はおしまいです。ではSSHRaspberry Piサーバに接続してみましょう。SSHを使うにはMacLinuxを使っている人はTerminalで、Windowsを使っている人はTeraTermCygwinなどを使って接続します。今回はTerminal(Cygwin)を使っていきます。

OSX,Linux,Windows(Cygwin)の場合

$SSH pi@Raspberry PiのIPアドレス

とTerminalに打ち込みます。
すると英語で色々文がでてきてyesかnoで聞かれる状態になると思うのでyesを選択してください。その後パスワードを聞かれるのでraspberryと入力しましょう。
すると

pi@raspberry:~$

とでてきます。

ここでwarningが出た場合は

ssh-keygen -R Raspberry PiのIPアドレス

を打ち込んでからssh接続してみてください

これでSSHサーバの完成です。

セキュリティ問題を解決しよう

さてSSHRaspberry Piに接続できましたね。しかしこのまま使っているとユーザー名やパスワードがバレているということもありすごく危険な状態です。なので必要最低限の対策としてアカウントを新しく作りパスワードを設定してあげます。今回はローカル内で使用することを前提としているのでポートに関する設定はしません。

最初にrootユーザにパスワードを変えましょう。(rootの説明は省きます) Raspberry PiのTerminalに

$sudo passwd root

と打ち込みます。するとパスワードを聞かれますので自分が設定したいパスワードを入力しましょう。 次に新しいユーザを作っていきます。

$sudo adduser 新規ユーザー名

とTerminalに打ち込みます。何か色々聞かれる思いますので自分で確認しながら設定していってください。 これで新しいアカウントができました。

そして新規ユーザでsudoコマンドを使えるようにします。

sudo gpasswd -a 新規ユーザ名 sudo

これで新しいアカウントでsudoが使えるようになりました。

次に先ほど作った新規ユーザをpiユーザと同じグループに設定してあげます。

$groups pi

とTerminalに入力するとズラーッと色々出てくると思います。
pi: pi adm dialout ...みたいな感じに。

これがpiユーザの入っているグループです。

そして上記の:より右側にあるものをコピーしてあげます。

これを新規ユーザに追加してあげます。

コピーした文字列の区切りはスペースになってると思いますが,で区切るようにしてください。

例:pi,adm.dialout ...

$sudo usermod -G コピーした文字列 新規ユーザ名

とTerminalに入力することでグループに追加できました。

一応確認のために以下のコマンドをTerminalに入力して確認しておきます。

groups 新規ユーザ名

これでpiユーザと同じように表示されればOKです。

これで新しいアカウントでsudoが使えるようになりました。

ここで一旦rootユーザになっておきましょう。

$su

パスワードを聞かれたら先ほど決めたrootユーザのパスワードを入力しましょう。

そして最後にpiユーザを削除しておきます。

#userdel -rf pi

で削除してあげましょう

これで新しいアカウントのみがユーザとして使えるようになりました。

再起動後Raspberry Pi側で新規ユーザでログインした後に別のPCで新しいユーザにSSH接続してみます。

$ssh 新しいユーザ名@Raspberry PiのIPアドレス

接続でき、lsと打ち込んで色々フォルダがでてこればOKです。

まとめ

今回はRaspberry Piを使ってSSHサーバを構築してきました。結構簡単じゃない?ちょっと設定書くだけでサーバができるんだって思った人もいるかもしれません。ちょっとした機能のサーバは構築が簡単です。かなり内容的には薄っぺらいものになってしまいましたが少しでも誰かの役にたてばいいなと思います。これ以外にもsambaを使ったファイルサーバの構築などを行ってみるとサーバの構築がより楽しくなると思います。あとRaspbianはバージョンによって結構仕様が異なるみたい...? ぜひみなさんもサーバを構築してみましょう!

Pythonで音楽プレイヤーを作ってみた話

はじめに

この記事はAdventCalender2016その2、11日目の記事になります。 今回はPythonを使ったTerminal上で動く音楽プレイヤーを作ってみたので、それについて話していきます。 超初心者が作ったので色々至らぬところがあると思いますが温かい目で見てくださると幸いです。

作ったきっかけ

僕が普段使っているノートPCはPanasonic製のLet's note CF-N8というものです。
このPCのCPUはcore2duoのメモリがDRR2の4GB(初期では2GB)という今となってはスペックが低いPCです…。
このPCで作業していて音楽が聞きたい時に音楽プレイヤーを開くとすごく重くなる…。 そこで自分で軽い音楽プレイヤーを作ってみようということで作ってみました。

実装したかった機能

この音楽プレイヤーを作るにあたって実装したかった機能は以下の点です。

  • Terminal上で動く
  • mp3が再生できる
  • 曲を選んで流す

まずはこの3つの機能だけを実装するように作りました。
なので連続再生とかループさせるなどといった機能は作ってないです。(まずは曲を再生したかったので)

ライブラリやモジュールの機能の確認

まず上記の機能を作るには

  • 音楽ファイルの読み込み
  • 音楽の再生

この2つの機能を実装しなければなりません。
この機能を実装するにはライブラリとかモジュールが必要ということが判明(そりゃそうだ)。 そこでgoogle大先生で検索してみると、pygameを使えば良いということが判明。
ほかにも色々でてきたのですが、とりあえず僕が調べてみた感じ一番情報量が多かったpygameを使うことに。

まず、使うためにはインストールしないといけません。僕は普段Xubuntu16.04LTSを使っているのでTerminal上からpygameをインストールします。
sudo apt-get install python-pygame
これでインストールができます(めっちゃ楽!)。

それでは実際にコードを書いていきましょう!...と言いたいところなんですが使い方がわからない...。
そこで以下のサイトを参考にまずは音楽を再生してみました。

nwpct1.hatenablog.com

なるほど。わからん。

とにかくmusic.loadのところでmp3の音楽ファイルを読み込んでmusic.playで再生してるのかなってことはわかりました。
じゃあこれを応用すれば使えそうなのでそれでいくことに。

しかし、ここでこのソースを見てとあることに気づいてしまいました。

「あれ?これってソースファイルと音楽ファイル同じ所に置かないと使えないんじゃね??」 「あと音楽ファイルってそれぞれ再生時間が違うんじゃない?」

そうなのです。これだと同じフォルダに音楽ファイルがいっぱいあるとか、途中までしか音楽が流れないとかいったことが起こりますね。
これは何か美しくない…。

では1つ目の問題から解決しようと思いました。
この問題はソースファイルのあるフォルダの中に、新しくMusic用のフォルダを作ってそのパスを通してあげれば解決できると判明。

というわけでフォルダを作ってそのフォルダのパスを通してあげることに。

パスをソースに直接書くのはまずいと思ったので別のファイルを作ってあげてそれをファイル読み込みで読み込ませることにしました。

次に2つ目の再生時間が違う問題はmutagenというモジュールを使えばmp3の再生時間を取得できるみたいです。 ではこれもちょちょいとインストールしてあげます。
pip install mutagen
これでインストールできます(これも簡単!)。

pipが入ってない場合は先にインストールしておく必要性がありますが僕の場合はすでにインストールしていたので問題なかったです。

これで上記の2つ問題を解決できました。
あとはこれらを元に実装するだけです。

実装

とりあえず完成させたソースファイルがこちらです。

#!/usr/bin/python
#!/coding:utf-8

# import
import os
import pygame
import time
import sys
from mutagen.mp3 import MP3

filepath = 'path.txt'
musicdir = 'Music'

# path
if os.path.exists(filepath):
    print "Path file [OK]"
else :
    print "Path file [NO]"
    print "Please make a path.txt file"
    print "Please write absolute path to music in the path.txt"
    exit()

if os.path.exists(filepath):
    print "Music directory [OK]"
else :
    print "Music directory [NO]"
    print "Please make a `Music` directory"
    exit()

path = open('path.txt', 'r')

for musicpath in path:
    print "Music file path =",
    print musicpath

path.close()

musicpath = musicpath.rstrip("\n")

# start
print "-- pyMusic-CUI --"
print "*** MUSIC LIST***"
print ""

# file list
files = os.listdir(musicpath)

for file in files:
    print file

print ""
print "music select"
print "=>",

## select music
select = raw_input()
selectmusic = musicpath + select

audio = MP3(selectmusic)

pygame.mixer.init()
pygame.mixer.music.load(selectmusic)
pygame.mixer.music.play(1)

print "---"+select+"---"
print ""
print "音量:%s" %pygame.mixer.music.get_volume()

time.sleep(audio.info.length)
pygame.mixer.music.stop()
print "終了"

クラスわけや関数などを使っていないのですごく長く見難いソースファイルになってしまいましたが、とりあえず実装はできました。 最初にファイルやフォルダがあるかを確認し、path.txtからパスの情報を読み取りMusicフォルダから音楽ファイルをリストとして表示する。 そして音楽ファイルを選択してそのファイルを再生する。といった流れのプログラムになりました。
あと英語が全くできないので文法がおかしいとかはスルーしておいてください(笑)。

これから行っていきたいこと

  • クラス分け、関数の利用
  • 音楽ファイルの選択を番号で指定できるようにする
  • ループ再生やランダム再生の機能も実装する

今回はとりあえず実装を目標にやってきたので省いてきた以上のことをまず次の目標にしていきたいと思ってます。

まとめ

とりあえずこれで作業中でも音楽が聞けるので作業が捗るはずです(そこ!音楽プレイヤーを使えとか言うな!!)。
今回の開発でPythonのいい勉強にもなったので自分のこれからのアプリ開発のモチベーションにしていきたいと思います。 またこれからもPythonを使ったアプリケーションを作ってみたいです。