ne_api 0.0.23 → 0.0.24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +20 -0
- data/lib/ne_api/testing/fake_master.rb +2 -2
- data/lib/ne_api/version.rb +1 -1
- data/lib/ne_api.rb +47 -14
- data/spec/token_refresh_spec.rb +105 -0
- metadata +8 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: cafa6c991b17f90ff2dee98f2434a77dc217772e7f4b042c52029a991aeaed14
|
|
4
|
+
data.tar.gz: a910e846c1c0151e4b18ee9530e27a39b60130a79aeacc397f70fe377016db40
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c24b58eae6fd8cfa38890c46cf8ee86f6e31b281bc83d74c60de2ac83b0efde524870e69f7f66699e93cf34e5c60b4e0cf04b981ae20078b58590f33a28b5e9f
|
|
7
|
+
data.tar.gz: 0ddd2d0c9cbf1e7ac7d6e0d1937bad95cb6b5979318aec8715774719e185bb97bd090aba90b3267e258fd321bde5bd45647ec035dc457c8bd39a4148fa2f9de7
|
data/README.md
CHANGED
|
@@ -300,3 +300,23 @@ This allows easy injection of `FakeMaster` in tests.
|
|
|
300
300
|
### ver0.0.6
|
|
301
301
|
* Ruby2.2対応
|
|
302
302
|
* リトライ回数のデフォルト値変更
|
|
303
|
+
|
|
304
|
+
## トークンの永続化 (0.0.24〜)
|
|
305
|
+
|
|
306
|
+
レスポンスにトークンが含まれていたとき(エラー応答・混雑時の再試行の途中を含む)に呼ばれるフックを設定できます。
|
|
307
|
+
次の呼び出しの前にトークンを保存しておくことで、古いトークンによる `002002` を防げます。
|
|
308
|
+
|
|
309
|
+
```ruby
|
|
310
|
+
master = NeAPI::Master.new(access_token: user.access_token, refresh_token: user.refresh_token)
|
|
311
|
+
master.on_token_refresh = ->(m, _body) { user.update!(access_token: m.access_token, refresh_token: m.refresh_token) }
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
`NeAPIException` からはエラーコードとエラー応答を取得できます(メッセージは従来どおり `"コード:メッセージ"`)。
|
|
315
|
+
|
|
316
|
+
```ruby
|
|
317
|
+
rescue NeAPIException => e
|
|
318
|
+
e.code #=> "020006"
|
|
319
|
+
e.response #=> { "result" => "error", "code" => "020006", "message" => "..." }
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
テストなどで HTTP 接続を差し替えるには `NeAPI.connection = Faraday.new { ... }` を設定します(`nil` で元に戻ります)。
|
|
@@ -13,7 +13,7 @@ module NeAPI
|
|
|
13
13
|
#
|
|
14
14
|
class FakeMaster
|
|
15
15
|
attr_accessor :access_token, :refresh_token, :wait_flag, :retry_num, :wait_interval
|
|
16
|
-
attr_accessor :access_token_end_date, :refresh_token_end_date
|
|
16
|
+
attr_accessor :access_token_end_date, :refresh_token_end_date, :on_token_refresh
|
|
17
17
|
attr_reader :call_history
|
|
18
18
|
|
|
19
19
|
def initialize(access_token: "test_access_token", refresh_token: "test_refresh_token")
|
|
@@ -106,7 +106,7 @@ module NeAPI
|
|
|
106
106
|
@call_history << { method: method_name.to_sym, args: args, time: Time.now }
|
|
107
107
|
|
|
108
108
|
if @error_mode
|
|
109
|
-
raise NeAPIException
|
|
109
|
+
raise NeAPIException.new("#{@error_code}:#{@error_message}", code: @error_code)
|
|
110
110
|
end
|
|
111
111
|
|
|
112
112
|
if @stubbed_responses.key?(method_name.to_sym)
|
data/lib/ne_api/version.rb
CHANGED
data/lib/ne_api.rb
CHANGED
|
@@ -9,12 +9,19 @@ require 'dotenv'
|
|
|
9
9
|
module NeAPI
|
|
10
10
|
API_SERVER_HOST = "https://api.next-engine.org"
|
|
11
11
|
NE_SERVER_HOST = "https://base.next-engine.org"
|
|
12
|
+
# メイン機能が混み合っているときのエラーコード。間隔を空けて再試行する
|
|
13
|
+
RETRYABLE_CODES = ["003001","003002","008003","009005","011007"].freeze
|
|
14
|
+
|
|
15
|
+
class << self
|
|
16
|
+
# Faraday のコネクションを差し替える(テストやスタブ用)。nil のときは API_SERVER_HOST へ接続する
|
|
17
|
+
attr_accessor :connection
|
|
18
|
+
end
|
|
12
19
|
|
|
13
20
|
private
|
|
14
21
|
|
|
15
22
|
|
|
16
23
|
def conn
|
|
17
|
-
@conn ||=
|
|
24
|
+
@conn ||= NeAPI.connection || Faraday.new(:url => API_SERVER_HOST) do |faraday|
|
|
18
25
|
faraday.request :url_encoded # form-encode POST params
|
|
19
26
|
faraday.response :logger # log requests to STDOUT
|
|
20
27
|
faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
|
|
@@ -25,10 +32,10 @@ module NeAPI
|
|
|
25
32
|
def response response
|
|
26
33
|
body = JSON.parse response.body
|
|
27
34
|
if body["result"] != "success"
|
|
28
|
-
if
|
|
35
|
+
if RETRYABLE_CODES.include?(body["code"])
|
|
29
36
|
return false
|
|
30
37
|
else
|
|
31
|
-
raise NeAPIException
|
|
38
|
+
raise NeAPIException.new(sprintf("%s:%s", body["code"], body["message"]), code: body["code"], response: body)
|
|
32
39
|
end
|
|
33
40
|
return false
|
|
34
41
|
end
|
|
@@ -38,6 +45,9 @@ module NeAPI
|
|
|
38
45
|
class Master
|
|
39
46
|
include NeAPI
|
|
40
47
|
attr_accessor :access_token, :refresh_token, :wait_flag, :retry_num, :wait_interval, :access_token_end_date, :refresh_token_end_date
|
|
48
|
+
# レスポンスにトークンが含まれていたとき(エラー応答を含む)に呼ばれるフック。
|
|
49
|
+
# ->(master, response_body) { ... } を設定すると、次の呼び出しの前にトークンを永続化できる
|
|
50
|
+
attr_accessor :on_token_refresh
|
|
41
51
|
PATH_PREFIX="/api_v1_"
|
|
42
52
|
|
|
43
53
|
def initialize access_token: "", refresh_token: ""
|
|
@@ -73,24 +83,40 @@ module NeAPI
|
|
|
73
83
|
post_args = {access_token: @access_token, refresh_token: @refresh_token}.merge(params)
|
|
74
84
|
end
|
|
75
85
|
res = false
|
|
76
|
-
|
|
86
|
+
|
|
77
87
|
self.retry_num.times do
|
|
78
|
-
|
|
79
|
-
|
|
88
|
+
body = JSON.parse((conn.post PATH_PREFIX+model.to_s+ "/" + method, post_args).body)
|
|
89
|
+
# エラー応答でもトークンが更新されることがある。取りこぼすと次の呼び出しが 002002 になるので必ず取り込む
|
|
90
|
+
store_tokens(body)
|
|
91
|
+
if body["result"] == "success"
|
|
92
|
+
res = body
|
|
93
|
+
break
|
|
94
|
+
end
|
|
95
|
+
unless RETRYABLE_CODES.include?(body["code"])
|
|
96
|
+
raise NeAPIException.new(sprintf("%s:%s", body["code"], body["message"]), code: body["code"], response: body)
|
|
97
|
+
end
|
|
98
|
+
# 再試行は更新後のトークンで行う
|
|
99
|
+
post_args[:access_token] = @access_token
|
|
100
|
+
post_args[:refresh_token] = @refresh_token
|
|
80
101
|
sleep(self.wait_interval)
|
|
81
102
|
end
|
|
82
103
|
if res == false
|
|
83
|
-
raise NeAPIException
|
|
84
|
-
return false
|
|
104
|
+
raise NeAPIException.new("003001:Next Engineが大変混み合っています。APIの接続を#{self.retry_num}回、#{self.wait_interval}秒間隔でアクセスを試みましたが、失敗をしました", code: "003001")
|
|
85
105
|
end
|
|
86
|
-
|
|
87
|
-
@access_token = res["access_token"] if res["access_token"].present?
|
|
88
|
-
@refresh_token = res["refresh_token"] if res["refresh_token"].present?
|
|
89
|
-
@access_token_end_date = res["access_token_end_date"] if res["access_token_end_date"].present?
|
|
90
|
-
@refresh_token_end_date = res["refresh_token_end_date"] if res["refresh_token_end_date"].present?
|
|
91
106
|
|
|
92
107
|
get_key.present? ? res[get_key] : res
|
|
93
108
|
end
|
|
109
|
+
# レスポンスに含まれるトークンと有効期限を取り込み、on_token_refresh フックを呼ぶ
|
|
110
|
+
def store_tokens(body)
|
|
111
|
+
return unless body.is_a?(Hash) && body["access_token"].present?
|
|
112
|
+
|
|
113
|
+
@access_token = body["access_token"]
|
|
114
|
+
@refresh_token = body["refresh_token"] if body["refresh_token"].present?
|
|
115
|
+
@access_token_end_date = body["access_token_end_date"] if body["access_token_end_date"].present?
|
|
116
|
+
@refresh_token_end_date = body["refresh_token_end_date"] if body["refresh_token_end_date"].present?
|
|
117
|
+
on_token_refresh.call(self, body) if on_token_refresh
|
|
118
|
+
end
|
|
119
|
+
|
|
94
120
|
def method_missing(path, args={})
|
|
95
121
|
super if @@params.nil? || path.nil?
|
|
96
122
|
|
|
@@ -179,5 +205,12 @@ module NeAPI
|
|
|
179
205
|
end
|
|
180
206
|
end
|
|
181
207
|
class NeAPIException < StandardError
|
|
182
|
-
|
|
208
|
+
# code: NEのエラーコード(例 "002004")、response: エラー応答のボディ(Hash)。メッセージは従来どおり "コード:メッセージ"
|
|
209
|
+
attr_reader :code, :response
|
|
183
210
|
|
|
211
|
+
def initialize(message = nil, code: nil, response: nil)
|
|
212
|
+
@code = code || message.to_s[/\A(\d{6}):/, 1]
|
|
213
|
+
@response = response
|
|
214
|
+
super(message)
|
|
215
|
+
end
|
|
216
|
+
end
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
require 'ne_api'
|
|
2
|
+
|
|
3
|
+
# 実APIには接続せず、Faraday のテストアダプタで応答を差し替える
|
|
4
|
+
describe 'トークンの取り込みとエラー' do
|
|
5
|
+
def connection(responses, requests = [])
|
|
6
|
+
stubs = Faraday::Adapter::Test::Stubs.new do |stub|
|
|
7
|
+
stub.post(%r{\A/api_v1_}) do |env|
|
|
8
|
+
requests << Faraday::Utils.parse_query(env.body)
|
|
9
|
+
[200, {}, JSON.generate(responses.shift)]
|
|
10
|
+
end
|
|
11
|
+
end
|
|
12
|
+
Faraday.new { |f| f.request :url_encoded; f.adapter :test, stubs }
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
let(:master) do
|
|
16
|
+
NeAPI::Master.new(access_token: "a0", refresh_token: "r0").tap { |m| m.wait_interval = 0; m.retry_num = 3 }
|
|
17
|
+
end
|
|
18
|
+
let(:tokens) { { "access_token" => "a1", "refresh_token" => "r1", "access_token_end_date" => "2026-11-20 00:00:00", "refresh_token_end_date" => "2026-11-22 00:00:00" } }
|
|
19
|
+
|
|
20
|
+
after { NeAPI.connection = nil }
|
|
21
|
+
|
|
22
|
+
it '成功応答のトークンを取り込み、on_token_refresh を呼ぶ' do
|
|
23
|
+
NeAPI.connection = connection([{ "result" => "success", "data" => [] }.merge(tokens)])
|
|
24
|
+
seen = []
|
|
25
|
+
master.on_token_refresh = ->(m, body) { seen << [m.access_token, body["result"]] }
|
|
26
|
+
expect(master.master_shop_search(fields: "shop_id")).to eq([])
|
|
27
|
+
expect([master.access_token, master.refresh_token, master.refresh_token_end_date]).to eq(["a1", "r1", "2026-11-22 00:00:00"])
|
|
28
|
+
expect(seen).to eq([["a1", "success"]])
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
it 'エラー応答でもトークンを取り込んでから例外を上げる' do
|
|
32
|
+
NeAPI.connection = connection([{ "result" => "error", "code" => "020006", "message" => "更新されています" }.merge(tokens)])
|
|
33
|
+
seen = []
|
|
34
|
+
master.on_token_refresh = ->(m, _body) { seen << m.access_token }
|
|
35
|
+
expect { master.receiveorder_base_update(params: { receive_order_id: 1 }) }.to raise_error(NeAPIException) { |e|
|
|
36
|
+
expect(e.code).to eq("020006")
|
|
37
|
+
expect(e.message).to eq("020006:更新されています")
|
|
38
|
+
expect(e.response["message"]).to eq("更新されています")
|
|
39
|
+
}
|
|
40
|
+
expect(master.access_token).to eq("a1")
|
|
41
|
+
expect(seen).to eq(["a1"])
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
it '混雑エラーは再試行し、再試行には更新後のトークンを使う' do
|
|
45
|
+
requests = []
|
|
46
|
+
NeAPI.connection = connection([{ "result" => "error", "code" => "003002", "message" => "busy" }.merge(tokens),
|
|
47
|
+
{ "result" => "success", "count" => "5" }], requests)
|
|
48
|
+
expect(master.master_shop_count).to eq("5")
|
|
49
|
+
expect(requests.map { |r| r["access_token"] }).to eq(["a0", "a1"])
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
it '混雑が続いたら 003001 の例外' do
|
|
53
|
+
NeAPI.connection = connection(Array.new(3) { { "result" => "error", "code" => "003002", "message" => "busy" } })
|
|
54
|
+
expect { master.master_shop_count }.to raise_error(NeAPIException) { |e| expect(e.code).to eq("003001") }
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
describe '後方互換(既存アプリの呼び出し方)' do
|
|
58
|
+
it 'search は data、count は count、update は result、info はボディ全体を返す' do
|
|
59
|
+
NeAPI.connection = connection([
|
|
60
|
+
{ "result" => "success", "data" => [{ "shop_id" => "1" }] },
|
|
61
|
+
{ "result" => "success", "count" => "3" },
|
|
62
|
+
{ "result" => "success" },
|
|
63
|
+
{ "result" => "success", "data" => [{ "company_id" => "c" }] }
|
|
64
|
+
])
|
|
65
|
+
expect(master.master_shop_search(fields: "shop_id", query: { "shop_deleted_flag-eq" => 0 })).to eq([{ "shop_id" => "1" }])
|
|
66
|
+
expect(master.receiveorder_base_count(query: { "receive_order_id-eq" => 1 })).to eq("3")
|
|
67
|
+
expect(master.receiveorder_base_update(params: { receive_order_id: 1, data: "<root/>" })).to eq("success")
|
|
68
|
+
expect(master.login_company_info["data"].first["company_id"]).to eq("c")
|
|
69
|
+
expect(master.access_token).to eq("a0") # 応答にトークンが無ければ変わらない
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
it 'query・fields・params・wait_flag の送り方は変わらない' do
|
|
73
|
+
requests = []
|
|
74
|
+
NeAPI.connection = connection([{ "result" => "success", "data" => [] }], requests)
|
|
75
|
+
master.force_import
|
|
76
|
+
master.receiveorder_base_search(fields: "receive_order_id", query: { "receive_order_id-in" => "1,2" }, params: { offset: 10 })
|
|
77
|
+
expect(requests.first).to eq("access_token" => "a0", "refresh_token" => "r0", "fields" => "receive_order_id",
|
|
78
|
+
"receive_order_id-in" => "1,2", "offset" => "10", "wait_flag" => "1")
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
it 'フックを設定しなくても動き、例外は従来どおり NeAPIException でメッセージは "コード:メッセージ"' do
|
|
82
|
+
NeAPI.connection = connection([{ "result" => "error", "code" => "004002", "message" => "fieldsが不正です" }])
|
|
83
|
+
expect { master.master_shop_search(fields: "x") }.to raise_error(NeAPIException, "004002:fieldsが不正です")
|
|
84
|
+
expect { raise NeAPIException, "plain" }.to raise_error(NeAPIException, "plain")
|
|
85
|
+
expect { raise NeAPIException }.to raise_error(NeAPIException)
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
it 'トークンが無ければ従来どおり no token!' do
|
|
89
|
+
expect { NeAPI::Master.new(access_token: nil, refresh_token: nil).master_shop_count }.to raise_error(NeAPIException, "no token!")
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
it 'テスト用スタブ FakeMaster の使い方も変わらない' do
|
|
93
|
+
require 'ne_api/testing'
|
|
94
|
+
fake = NeAPI::Testing::FakeMaster.new.stub(:master_shop_search, [{ "shop_id" => "1" }])
|
|
95
|
+
expect(fake.master_shop_search).to eq([{ "shop_id" => "1" }])
|
|
96
|
+
fake.simulate_error(code: "001001", message: "認証エラー")
|
|
97
|
+
expect { fake.master_shop_search }.to raise_error(NeAPIException, "001001:認証エラー")
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
it '従来どおりメッセージだけで生成した例外からもコードを引ける' do
|
|
102
|
+
expect(NeAPIException.new("002004:expired").code).to eq("002004")
|
|
103
|
+
expect(NeAPIException.new("no token!").code).to be_nil
|
|
104
|
+
end
|
|
105
|
+
end
|
metadata
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ne_api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.24
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Yuuna Kurita
|
|
8
8
|
- Mika Koizumi
|
|
9
|
+
autorequire:
|
|
9
10
|
bindir: bin
|
|
10
11
|
cert_chain: []
|
|
11
|
-
date:
|
|
12
|
+
date: 2026-11-18 00:00:00.000000000 Z
|
|
12
13
|
dependencies:
|
|
13
14
|
- !ruby/object:Gem::Dependency
|
|
14
15
|
name: bundler
|
|
@@ -161,10 +162,12 @@ files:
|
|
|
161
162
|
- ne_api.gemspec
|
|
162
163
|
- spec/bundling_dispatch_spec.rb
|
|
163
164
|
- spec/ne_api_spec.rb
|
|
165
|
+
- spec/token_refresh_spec.rb
|
|
164
166
|
homepage: http://github.com/infinity-octaver/ne_api/
|
|
165
167
|
licenses:
|
|
166
168
|
- MIT
|
|
167
169
|
metadata: {}
|
|
170
|
+
post_install_message:
|
|
168
171
|
rdoc_options: []
|
|
169
172
|
require_paths:
|
|
170
173
|
- lib
|
|
@@ -179,9 +182,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
179
182
|
- !ruby/object:Gem::Version
|
|
180
183
|
version: '0'
|
|
181
184
|
requirements: []
|
|
182
|
-
rubygems_version: 4.
|
|
185
|
+
rubygems_version: 3.4.19
|
|
186
|
+
signing_key:
|
|
183
187
|
specification_version: 4
|
|
184
188
|
summary: Next Engine API for ruby
|
|
185
189
|
test_files:
|
|
186
190
|
- spec/bundling_dispatch_spec.rb
|
|
187
191
|
- spec/ne_api_spec.rb
|
|
192
|
+
- spec/token_refresh_spec.rb
|