https://github.com/hymkor/go-htnblog

はてなブログ-クライアント
https://github.com/hymkor/go-htnblog

go golang hatena hatena-blog

Last synced: 5 days ago
JSON representation

はてなブログ-クライアント

• Host: GitHub
• URL: https://github.com/hymkor/go-htnblog
• Owner: hymkor
• License: mit
• Created: 2023-10-15T06:17:00.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-01T00:09:03.000Z (9 months ago)
• Last Synced: 2024-10-31T00:08:14.250Z (about 2 months ago)
• Topics: go, golang, hatena, hatena-blog
• Language: Go
• Homepage:
• Size: 205 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
go-htnblog：はてなブログ-クライアント

====================================

[![GoDev](https://pkg.go.dev/badge/github.com/hymkor/go-htnblog)](https://pkg.go.dev/github.com/hymkor/go-htnblog)

本パッケージは

- コマンドラインクライアント(htnblog.exe, htnblog)  

    → シェル、コマンドプロンプトなどから利用。vim など任意のテキストエディターで記事を編集して、投稿

- クライアントライブラリ(github.com/hymkor/go-htnblog)  

    → Go言語で投稿機能を利用できるライブラリ

からなります。Windows, Linux (Ubuntu on WSL) で動作を確認しています

コマンドラインクライアント

--------------------------

### 手作業でインストール

[Releases](https://github.com/hymkor/go-htnblog/releases) よりダウンロードして、環境変数 PATH で指定されたディレクトリに実行ファイル htnblog.exe を展開してください

#### Go一式がある場合

```

go install github.com/hymkor/go-htnblog/cmd/htnblog@latest

```

#### scoop インストーラーがある場合

```

scoop install https://raw.githubusercontent.com/hymkor/go-htnblog/master/htnblog.json

```

もしくは

```

scoop bucket add hymkor https://github.com/hymkor/scoop-bucket

scoop install htnblog

```

### 設定

`htnblog init` を実行してください。

```

$ htnblog init

Hatena-id ? (← Hatena-IDを入力)

API-KEY ? (← APIキー入力)

End Point URL 1 ? (← 一つ目のブログのEndPointURL を入力)

End Point URL 2 ? (← 二つ目のブログのEndPointURL を入力:Enterのみで省略可)

End Point URL 3 ? (← 三つめのブログのEndPointURL を入力:Enterのみで省略可)

End Point URL (default) ? (← デフォルトのブログの EndPointURL: 既定値は1と同じ)

Text Editor Path ? (← テキストエディタのパス: 既定値は%EDITOR%)

Saved configuration to C:\Users\hymkor\.htnblog

```

設定は ~/.htnblog というファイルに次のように保存されます。

```

{

    "userid":"(YOUR_HATENA_ID)",

    "endpointurl":"(END_POINT_URL)",

    "apikey":"(YOUR API KEY)",

    "editor":"(YOUR EDITOR FULLPATH))"

    "endpointurl1":"(END_POINT_URL at option `-1`)",

    "endpointurl2":"(END_POINT_URL at option `-2`)",

    "endpointurl3":"(END_POINT_URL at option `-3`)",

}

```

- **endpointurl** は 「はてな」の「ダッシュボード」 → (ブログ名) → 「設定」 → 詳細設定 → 「AtomPub」セクションのルートネンドポイントの記載の URL になります。

- **apikey** は「アカウント設定」→「APIキー」に記載されています。

- **editor** は編集に使うテキストエディターのパスを記載してください。

- **endpointurl[123]** は **endpointurl** と同じですが、オプション -1,-2,-3 が指定された時にこちらが使われます。

### 使い方

[cmd/htnblog/main.go](cmd/htnblog/main.go)

- `htnblog` (オプションなし) … ヘルプ

- `htnblog init` … 設定の編集

- `htnblog list` … 直近10件の記事のリスト

- `htnblog new` … 新規記事のドラフトを作成

- `htnblog edit {URL|@0|@1|…}` … 既存記事の編集。記事を指定しない場合は @0 = 最も最近に編集したページを対象とする

- `htnblog publish {URL|@0|@1|…}` … 指定した記事を下書き状態から公開状態へ変更する

- `htnblog browse {URL|@0|@1|…}` … 指定した記事の編集ページをウェブブラウザで開く

```./htnblog |

htnblog v0.8.0-11-g70fa80c-windows-amd64 by go1.21.5

Usage: htnblog {options...} {init|list|new|type|edit}

  htnblog init                   ... edit configuration

  htnblog list                   ... show recent articles

  htnblog new                    ... create a new draft

  htnblog type    {URL|@0|@1|..} ... output the article to STDOUT

  htnblog edit    {URL|@0|@1|..} ... edit the article

  htnblog delete  {URL|@0|@1|..} ... output the article to STDOUT and delete it

  htnblog publish {URL|@0|@1|..} ... set false the draft flag of the article

  htnblog browse  {URL|@0|@1|..} ... open the edit page in a web browser

    The lines in the draft up to "---" are the header lines,

    and the rest is the article body.

  -1	Use the value of "endpointurl1" in the JSON setting

  -2	Use the value of "endpointurl2" in the JSON setting

  -3	Use the value of "endpointurl3" in the JSON setting

  -debug

    	Enable Debug Output

  -f	Delete without prompt

  -n int

    	fetch articles (default 10)

  -rc string

    	use the specified file instead of ~/.htnblog

```

Goライブラリ go-htnblog

------------------------

### 使用例: 一覧表示

[examples/list.go](examples/list.go)

設定は標準入力から読み込むようにしてます。ブログに投稿するためのアカウント情報を保持する htnblog.Blog型のインスタンスは `htnblog.NewFromJSON` 関数で JSON テキストから生成していますが、別に `&Blog{...}` でいきなり生成しても構いません。

```examples/list.go

package main

import (

    "fmt"

    "io"

    "os"

    "github.com/hymkor/go-htnblog"

)

func list() error {

    auth, err := io.ReadAll(os.Stdin)

    if err != nil {

        return err

    }

    blog, err := htnblog.NewFromJSON(auth)

    if err != nil {

        return err

    }

    entries, err := blog.List()

    if err != nil {

        return err

    }

    for _, entry1 := range entries {

        fmt.Println(entry1.Title)

        fmt.Println(entry1.EditUrl())

    }

    return nil

}

func main() {

    if err := list(); err != nil {

        fmt.Fprintln(os.Stderr, err.Error())

        os.Exit(1)

    }

}

```

### 使用例: 新規投稿

[examples/post.go](examples/post.go)

`(*Blog) Post` 関数は戻り値としてウェブアクセスの返信を `*http.Response` と `error` で返してきます。エラーでない場合は `*https.Response` の Body という io.Reader を全部読みとって、Close しなければいけないのですが、それらはエラーの判断も含めて `(*Blog).DropResponse` というメソッドに委ねています。同メソッドでは通常は読み取ったデータを io.Discard に捨てていますが、DebugPrint という io.Writer のフィールドが nil でない場合はそちらへコピーします

( つまり例では標準エラー出力にサーバーのレスポンスを表示させています )

`$ go run examples/post.go < ~/.htnblog`

```examples/post.go

package main

import (

    "fmt"

    "io"

    "os"

    "time"

    "github.com/hymkor/go-htnblog"

)

func post() error {

    auth, err := io.ReadAll(os.Stdin)

    if err != nil {

        return err

    }

    blog, err := htnblog.NewFromJSON(auth)

    if err != nil {

        return err

    }

    blog.DebugPrint = os.Stderr

    return blog.DropResponse(blog.Post(time.Now().Format("投稿 2006-01-02 15:04:05"), "本文を書く", "yes"))

}

func main() {

    if err := post(); err != nil {

        fmt.Fprintln(os.Stderr, err.Error())

        os.Exit(1)

    }

}

```

### 使用例: 最も新しい記事を編集

[examples/edit.go](examples/edit.go)

`$ go run examples/edit.go < ~/.htnblog`

```examples/edit.go

package main

import (

    "errors"

    "fmt"

    "io"

    "os"

    "time"

    "github.com/hymkor/go-htnblog"

)

func edit() error {

    auth, err := io.ReadAll(os.Stdin)

    if err != nil {

        return err

    }

    blog, err := htnblog.NewFromJSON(auth)

    if err != nil {

        return err

    }

    entries, err := blog.List()

    if err != nil {

        fmt.Fprintln(os.Stderr, err.Error())

        os.Exit(1)

    }

    if len(entries) <= 0 {

        return errors.New("no entries")

    }

    entries[0].Content.Body += time.Now().Format("\n編集 2006-01-02 15:04:05")

    blog.DebugPrint = os.Stderr

    return blog.DropResponse(blog.Update(entries[0]))

}

func main() {

    if err := edit(); err != nil {

        fmt.Fprintln(os.Stderr, err.Error())

        os.Exit(1)

    }

}

```

Refrences

---------

* [はてなブログAtomPub - はてなブログ ヘルプ](https://help.hatenablog.com/entry/atompub)

* [はてなブログAtomPub | Hatena Developer Center](https://developer.hatena.ne.jp/ja/documents/blog/apis/atom/)