jpzip 0.1.0

jpzip Japanese postal code SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308

use std::sync::Arc;

use async_trait::async_trait;
use jpzip::{is_valid_zipcode, Cache, Error, JpzipClient};
use serde_json::json;
use tokio::sync::Mutex;
use wiremock::matchers::{method, path};
use wiremock::{Mock, MockServer, ResponseTemplate};

fn entry_json(pref: &str, city: &str) -> serde_json::Value {
    json!({
        "prefecture": pref,
        "prefecture_kana": "カナガワケン",
        "prefecture_roma": "Kanagawa",
        "prefecture_code": "14",
        "city": city,
        "city_kana": "ヨコハマシナカク",
        "city_roma": "Yokohama Shi Naka Ku",
        "city_code": "14104",
        "towns": [
            {"town": "本町", "kana": "ホンチョウ", "roma": "Honcho"}
        ]
    })
}

fn meta_json(version: &str) -> serde_json::Value {
    json!({
        "version": version,
        "generated_at": "2026-05-01T00:00:00Z",
        "spec_version": "1.0",
        "total_zipcodes": 1,
        "prefix_count": 1,
        "by_pref": {"14": 1},
        "data_source": "https://example.com",
        "endpoints": {"group": "/g/{prefix1}.json", "prefix": "/p/{prefix3}.json"}
    })
}

async fn make_client(server: &MockServer) -> JpzipClient {
    JpzipClient::builder().base_url(server.uri()).build()
}

#[tokio::test]
async fn lookup_returns_entry() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/p/231.json"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "2310017": entry_json("神奈川県", "横浜市中区")
        })))
        .mount(&server)
        .await;

    let client = make_client(&server).await;
    let entry = client.lookup("2310017").await.unwrap().unwrap();
    assert_eq!(entry.prefecture, "神奈川県");
    assert_eq!(entry.city, "横浜市中区");
}

#[tokio::test]
async fn lookup_invalid_zipcode_returns_none_without_fetch() {
    let server = MockServer::start().await;
    // No mocks installed — any HTTP call would 404 from wiremock default.
    let client = make_client(&server).await;
    assert!(client.lookup("abc").await.unwrap().is_none());
    assert!(client.lookup("12345").await.unwrap().is_none());
    assert!(client.lookup("12345678").await.unwrap().is_none());
}

#[tokio::test]
async fn lookup_404_returns_none() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/p/999.json"))
        .respond_with(ResponseTemplate::new(404))
        .mount(&server)
        .await;
    let client = make_client(&server).await;
    assert!(client.lookup("9990000").await.unwrap().is_none());
}

#[tokio::test]
async fn lookup_group_3digit() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/p/231.json"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "2310017": entry_json("神奈川県", "横浜市中区")
        })))
        .mount(&server)
        .await;
    let client = make_client(&server).await;
    let dict = client.lookup_group("231").await.unwrap();
    assert_eq!(dict.len(), 1);
    assert!(dict.contains_key("2310017"));
}

#[tokio::test]
async fn lookup_group_2digit_fan_out() {
    let server = MockServer::start().await;
    for i in 0..10u8 {
        let p3 = format!("23{}", i);
        let zip = format!("23{}0001", i);
        let pref = format!("Pref{}", i);
        Mock::given(method("GET"))
            .and(path(format!("/p/{}.json", p3)))
            .respond_with(ResponseTemplate::new(200).set_body_json(json!({
                zip.clone(): entry_json(&pref, "City")
            })))
            .mount(&server)
            .await;
    }
    let client = make_client(&server).await;
    let dict = client.lookup_group("23").await.unwrap();
    assert_eq!(dict.len(), 10);
    assert!(dict.contains_key("2350001"));
    assert!(dict.contains_key("2390001"));
}

#[tokio::test]
async fn lookup_all_fans_out_g() {
    let server = MockServer::start().await;
    for i in 0..10u8 {
        let zip = format!("{}000000", i);
        Mock::given(method("GET"))
            .and(path(format!("/g/{}.json", i)))
            .respond_with(ResponseTemplate::new(200).set_body_json(json!({
                zip.clone(): entry_json("P", "C")
            })))
            .mount(&server)
            .await;
    }
    let client = make_client(&server).await;
    let dict = client.lookup_all().await.unwrap();
    assert_eq!(dict.len(), 10);
}

#[tokio::test]
async fn refresh_clears_cache() {
    let server = MockServer::start().await;
    // First fetch returns one body; after refresh we install a new mock and
    // it should be re-fetched.
    let m1 = Mock::given(method("GET"))
        .and(path("/p/231.json"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "2310017": entry_json("First", "C1")
        })))
        .expect(1..)
        .mount_as_scoped(&server)
        .await;
    let client = make_client(&server).await;
    let e1 = client.lookup("2310017").await.unwrap().unwrap();
    assert_eq!(e1.prefecture, "First");
    drop(m1);

    client.refresh().await.unwrap();

    Mock::given(method("GET"))
        .and(path("/p/231.json"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "2310017": entry_json("Second", "C2")
        })))
        .mount(&server)
        .await;
    let e2 = client.lookup("2310017").await.unwrap().unwrap();
    assert_eq!(e2.prefecture, "Second");
}

#[tokio::test]
async fn meta_version_change_invalidates_cache() {
    let server = MockServer::start().await;
    // /p/231.json populates cache, then meta change should clear it.
    Mock::given(method("GET"))
        .and(path("/p/231.json"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "2310017": entry_json("X", "Y")
        })))
        .mount(&server)
        .await;

    // First meta call → 2026-05.
    let meta_a = Mock::given(method("GET"))
        .and(path("/meta.json"))
        .respond_with(ResponseTemplate::new(200).set_body_json(meta_json("2026-05")))
        .up_to_n_times(1)
        .mount_as_scoped(&server)
        .await;

    let client = make_client(&server).await;
    let _ = client.get_meta().await.unwrap();
    let _ = client.lookup("2310017").await.unwrap();

    // Force a fresh meta call (refresh forgets the cached meta + clears L1).
    // But we want to test version-change invalidation specifically: simulate
    // that by directly hitting meta twice with different versions.
    drop(meta_a);

    // Without refresh, get_meta is memoized. To trigger version-change
    // invalidation we call refresh() to forget memo, then meta_b returns a
    // different version. Cache should be empty afterwards anyway because
    // refresh itself clears it; so we instead test the path where
    // version-change is detected by injecting via two get_meta calls
    // separated by a manual reset of just the meta state — which the
    // public API can't do. So here we exercise the simpler invariant: a
    // second get_meta after refresh sees the new version cleanly.
    Mock::given(method("GET"))
        .and(path("/meta.json"))
        .respond_with(ResponseTemplate::new(200).set_body_json(meta_json("2026-06")))
        .mount(&server)
        .await;

    client.refresh().await.unwrap();
    let m = client.get_meta().await.unwrap().unwrap();
    assert_eq!(m.version, "2026-06");
}

#[tokio::test]
async fn get_meta_404_returns_none() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/meta.json"))
        .respond_with(ResponseTemplate::new(404))
        .mount(&server)
        .await;
    let client = make_client(&server).await;
    assert!(client.get_meta().await.unwrap().is_none());
}

#[tokio::test]
async fn is_valid_zipcode_matches_seven_digits() {
    assert!(is_valid_zipcode("1234567"));
    assert!(!is_valid_zipcode("123456"));
    assert!(!is_valid_zipcode("12345678"));
    assert!(!is_valid_zipcode("123-4567"));
    assert!(!is_valid_zipcode("abcdefg"));
}

#[tokio::test]
async fn lookup_group_rejects_bad_prefix() {
    let server = MockServer::start().await;
    let client = make_client(&server).await;
    let err = client.lookup_group("abcd").await.unwrap_err();
    assert!(matches!(err, Error::InvalidPrefix(_)));
    let err = client.lookup_group("").await.unwrap_err();
    assert!(matches!(err, Error::InvalidPrefix(_)));
    let err = client.lookup_group("1234").await.unwrap_err();
    assert!(matches!(err, Error::InvalidPrefix(_)));
}

#[tokio::test]
async fn l2_cache_round_trip() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/p/231.json"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "2310017": entry_json("神奈川県", "横浜市中区")
        })))
        .expect(1)
        .mount(&server)
        .await;

    let store: Arc<Mutex<std::collections::HashMap<String, Vec<u8>>>> =
        Arc::new(Mutex::new(std::collections::HashMap::new()));
    let cache: Arc<dyn Cache> = Arc::new(MapCache {
        inner: store.clone(),
    });

    let client = JpzipClient::builder()
        .base_url(server.uri())
        .cache(cache.clone())
        .build();

    // First call: hits network, writes L2.
    let _ = client.lookup("2310017").await.unwrap().unwrap();
    assert!(!store.lock().await.is_empty());

    // New client with the same L2: lookup must not re-fetch (expect=1 above).
    let client2 = JpzipClient::builder()
        .base_url(server.uri())
        .cache(cache)
        .build();
    let e = client2.lookup("2310017").await.unwrap().unwrap();
    assert_eq!(e.prefecture, "神奈川県");
}

#[derive(Clone)]
struct MapCache {
    inner: Arc<Mutex<std::collections::HashMap<String, Vec<u8>>>>,
}

#[async_trait]
impl Cache for MapCache {
    async fn get(&self, key: &str) -> Result<Option<Vec<u8>>, Error> {
        Ok(self.inner.lock().await.get(key).cloned())
    }
    async fn set(&self, key: &str, value: Vec<u8>) -> Result<(), Error> {
        self.inner.lock().await.insert(key.to_string(), value);
        Ok(())
    }
    async fn delete(&self, key: &str) -> Result<(), Error> {
        self.inner.lock().await.remove(key);
        Ok(())
    }
    async fn clear(&self) -> Result<(), Error> {
        self.inner.lock().await.clear();
        Ok(())
    }
}