ne_api 0.0.22 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16edd23e29a39103e8ec306e6b818b42a1688aad42e5d542e3d4db3b3b79c925
-  data.tar.gz: 3ed47af90711932cfd42ebd9a5253a0753f2d35a2d0badad04fad34fa7a4072d
+  metadata.gz: 6474b8bf6ff50eacf03ce97f30ee79275d2a239f21bcf7f0abce82b5c86d26e7
+  data.tar.gz: b81e71c968a5e36ecfffa2b45263ecc2def76c1250fc9136e7eb43c3456e0526
 SHA512:
-  metadata.gz: e5f8c4195d02c0c4b70ef4fd5751c51de67cde63867a130f168ff4ca98726f9f57d4fc2e2eb3bc647ab88f92fb7a55b4d193dfa905dae863195d096e4a8a1216
-  data.tar.gz: 3ae39d8ab93891d07a93f51b39bf8198ecafaaf3a723bc4aa880477f690f9982b7674a7343f4acc50a146c6db88b7330bc6237a4bd7bf0de2e9d6ca5085d343b
+  metadata.gz: e607e19e050b177d3263d7edd3fb7e3aacb145eb58ed761c54f5369074d9357b1fd9b9191dc20899adb797eb7d21c394cea1dd7c70032d0ca11f560f9dc6ce73
+  data.tar.gz: 133ec5ee2121bfd9d8791c5a3f463937739eb1f8fe42881aec2929216c86cc829bb20d7075a8e45193503db3b95daf55ea59653330324f3b5dd9a0d2d6dea465

data/BUNDLING_API.md

@@ -0,0 +1,54 @@
+# 同梱処理で使う NE API 一覧（ne_api gem）
+
+ne_bundling（同梱処理アプリ）が利用する NE API と、その gem 呼び出し名の一覧。
+v0.0.23 で「同梱系API」を追加した。呼び出しは `NeAPI::Master#<model>_<method>` 形式。
+
+## v0.0.23 で追加した同梱系API
+
+| gem 呼び出し | NE エンドポイント | 用途 | 主なパラメータ | 戻り値(get_key) |
+| --- | --- | --- | --- | --- |
+| `receiveorder_base_bundle` | `POST /api_v1_receiveorder_base/bundle` | 受注伝票の一括同梱（NE標準同梱処理を実行） | `params: { data: <JSON文字列>, receive_order_recalculate_flag: "1"/"0" }` | `results`（ジョブ毎の同梱結果配列） |
+| `receiveorder_base_bundle_candidate_groups` | `POST /api_v1_receiveorder_base/bundle_candidate_groups` | 同梱候補グループ取得（同梱可能な受注をグループ化） | `params: { target_receive_order_ids: "1,2,3" }`（省略時は全受注対象） | `groups`（受注番号配列の配列） |
+| `receiveorder_groupingtag_search` | `POST /api_v1_receiveorder_groupingtag/search` | 受注分類タグ検索 | `fields:`, `query:`（`grouping_tag_*`） | `data` |
+
+### `receiveorder_base_bundle` の `data` 構造
+
+```json
+[
+  {
+    "receive_order_id": "同梱先(親)の受注伝票番号",
+    "receive_order_last_modified_date": "YYYY-MM-DD HH:MM:SS",  // 楽観ロック用
+    "bundles": [
+      { "receive_order_id": "同梱元(子)の受注伝票番号",
+        "receive_order_last_modified_date": "YYYY-MM-DD HH:MM:SS" }
+    ]
+  }
+]
+```
+
+- `data` 配列は 1〜100 ジョブ。`receive_order_last_modified_date` が DB の最終更新日と不一致の伝票はスキップされる。
+- `results[].bundled_receive_order_ids` に成功した子注文、`skipped_receive_order_ids` / `skipped_receive_order_reasons` にスキップ分が返る。
+- 同梱元が全件スキップになるとエラー（コード `028013`）。固有エラーは `028001`〜`028021`。
+
+### `bundle_candidate_groups` のグループ判定条件
+
+同一グループは次を全て満たす受注: ①同じ店舗 ②有効な伝票（未キャンセル）③受注状態が起票済/納品書印刷待ち/納品書印刷済 ④送り先名一致 ⑤送り先住所一致 ⑥送り先電話番号一致 ⑦送り先未マスク。
+固有エラー: `029001`(1万件超) / `029002`(非数値) / `029003`。
+
+## 同梱フローで使う既存API（v0.0.22 時点で定義済み）
+
+| gem 呼び出し | NE エンドポイント | 用途 |
+| --- | --- | --- |
+| `receiveorder_row_search` / `_count` | `/api_v1_receiveorder_row/{search,count}` | 受注明細の検索・件数（同梱対象の絞り込み） |
+| `receiveorder_base_search` / `_count` | `/api_v1_receiveorder_base/{search,count}` | 受注伝票の検索・件数（配送先・状態の取得） |
+| `receiveorder_base_update` | `/api_v1_receiveorder_base/update` | 受注更新（商品追加・確認・タグ付与: XML） |
+| `receiveorder_base_bulkupdate` | `/api_v1_receiveorder_base/bulkupdate` | 子注文の一括更新（キャンセル等: XML） |
+| `master_goods_search` / `_count` | `/api_v1_master_goods/{search,count}` | 商品マスタ取得（商品名等の付与） |
+| `master_shop_search` | `/api_v1_master_shop/search` | 店舗一覧取得（shop_id 絞り込み用） |
+| `notice_execution_add` | `/api_v1_notice_execution/add` | 実行結果お知らせ登録 |
+| `login_company_info` / `login_user_info` | `/api_v1_login_{company,user}/info` | 認証・企業/ユーザー情報 |
+
+## 補足
+
+- 現行の同梱アプリ（`ne_bundling`）は `receiveorder_base_update` + `bulkupdate` を XML で組み立ててクライアント側で同梱を実装している。NE標準の `receiveorder_base_bundle` / `bundle_candidate_groups` を使うと、グループ判定〜同梱実行を NE 側に委譲でき、ロジックを大幅に簡素化できる（改修方針の選択肢）。
+- 全エンドポイントの詳細仕様は ne_bundling 側 `doc/ne_api_reference.txt`（出典 https://developer.next-engine.com/llms-full.txt ）を参照。

data/README.md

@@ -266,6 +266,9 @@ This allows easy injection of `FakeMaster` in tests.
 5. Create a new Pull Request
 
 ## Update
+### ver0.0.23
+  * 同梱系APIに対応（受注伝票一括同梱 `receiveorder_base_bundle` / 同梱候補グループ取得 `receiveorder_base_bundle_candidate_groups` / 受注分類タグ検索 `receiveorder_groupingtag_search`）。詳細は [`BUNDLING_API.md`](BUNDLING_API.md) 参照
+  * `method_missing` を複数語メソッド対応に改修（登録モデル名の最長前方一致で解決。単一語メソッドは従来通りで後方互換）
 ### ver0.0.22
   * bug fix
 ### ver0.0.21

data/config/api.yaml

@@ -218,6 +218,8 @@
   - divide
   - bulkupdate
   - bulkupdatereceipted
+  - bundle
+  - bundle_candidate_groups
   :prefix: receive_order
   :fields: shop_id,id,shop_cut_form_id,date,import_date,important_check_id,important_check_name,confirm_check_id,confirm_check_name,confirm_ids,mail_status,gruoping_tag,import_type_id,import_type_name,cancel_type_id,cancel_type_name,cancel_date,closed_after_edit_date,order_status_id,order_status_name,delivery_id,delivery_name,payment_method_id,payment_method_name,total_amount,tax_amount,charge_amount,delivery_fee_amount,other_amount,point_amount,goods_amount,deposit_amount,deposit_type_id,deposit_type_name,deposit_date,foreign_total_amount,foreign_tax_amount,foreign_charge_amount,foreign_delivery_fee_amount,foreign_other_amount,foreign_goods_amount,foreign_deposit_amount,note,include_possible_order_id,include_to_order_id,multi_delivery_parent_order_id,multi_delivery_parent_flag,statement_delivery_instruct_printing_date,statement_delivery_printing_date,statement_delivery_text,send_date,send_plan_date,send_sequence,worker_text,picking_instruct,picking_min_supplier_id,picking_min_goods_id,label_print_date,label_print_flag,hope_delivery_date,hope_delivery_time_slot_id,hope_delivery_time_slot_name,delivery_method_id,delivery_method_name,seal1_id,seal1_name,seal2_id,seal2_name,seal3_id,seal3_name,seal4_id,seal4_name,business_office_stop_id,business_office_stop_name,invoice_id,invoice_name,temperature_id,temperature_name,business_office_name,gift_flag,delivery_cut_form_id,delivery_cut_form_note,credit_type_id,credit_type_name,credit_approval_no,credit_approval_amount,credit_approval_type_id,credit_approval_type_name,credit_approval_date,credit_approval_rate,credit_number_payments,credit_authorization_center_id,credit_authorization_center_name,credit_approval_fax_printing_date,customer_type_id,customer_type_name,customer_id,purchaser_name,purchaser_kana,purchaser_zip_code,purchaser_address1,purchaser_address2,purchaser_tel,purchaser_fax,purchaser_mail_address,consignee_name,consignee_kana,consignee_zip_code,consignee_address1,consignee_address2,consignee_tel,consignee_fax,reminder_start_date,reminder_last_date,reminder_count,important_check_pic_id,important_check_pic_name,pic_id,pic_name,send_pic_id,send_pic_name,deleted_flag,creation_date,last_modified_date,last_modified_null_safe_date,creator_id,creator_name,last_modified_by_id,last_modified_by_null_safe_id,last_modified_by_name,last_modified_by_null_safe_name
 :receiveorder_option:
@@ -245,6 +247,11 @@
   - update
   :prefix: confirm
   :fields: id,name,display_order,html,value,valid_flag
+:receiveorder_groupingtag:
+  :method:
+  - search
+  :prefix: grouping_tag
+  :fields: id,name,color,str_color,memo,creation_date,last_modified_date,last_modified_null_safe_date,creator_id,creator_name,last_modified_by_id,last_modified_by_null_safe_id,last_modified_by_name,last_modified_by_null_safe_name
 :receiveorder_paymentdeliveryconvert:
   :method:
   - count

data/lib/ne_api/version.rb

@@ -1,3 +1,3 @@
 module NeApi
-  VERSION = "0.0.22"
+  VERSION = "0.0.23"
 end

data/lib/ne_api.rb

@@ -93,13 +93,25 @@ module NeAPI
     end
     def method_missing(path, args={})
       super if @@params.nil? || path.nil?
-      unless models = /^(.*)_.*$/.match(path.to_s)
-        super
+
+      # path を「モデル名_メソッド名」に分解する。
+      # 旧実装は最後の "_" で分割していたが、bundle_candidate_groups のような
+      # 複数語メソッドに対応できなかった。登録済みモデル名との前方一致(最長一致優先)で
+      # 解決することで、単語数によらず正しい model / method を取り出す。
+      # 単一語メソッドでは旧実装と同じ結果になるため後方互換。
+      model = nil
+      method = nil
+      @@params.keys.sort_by { |key| -key.to_s.length }.each do |key|
+        prefix = "#{key}_"
+        next unless path.to_s.start_with?(prefix)
+        candidate = path.to_s[prefix.length..-1]
+        next unless @@params[key][:method].include?(candidate)
+        model = key
+        method = candidate
+        break
       end
-      model = models.captures.first.to_sym
-      method = path.to_s.split("_").last
 
-      if @@params.key?(model) && @@params[model][:method].include?(method)
+      if model
         get_key = nil
         query = (args[:query].present? ? args[:query] : nil)
         fields = (args[:fields].present? ? args[:fields] : nil)
@@ -119,6 +131,12 @@ module NeAPI
           get_key = "result"
         when "divide"
           get_key = "receive_order_id"
+        when "bundle"
+          # 受注伝票一括同梱: ジョブ毎の結果配列(results)を返す
+          get_key = "results"
+        when "bundle_candidate_groups"
+          # 同梱候補グループ取得: 同梱可能な受注番号配列の配列(groups)を返す
+          get_key = "groups"
         when "checkconnect"
           fields = nil
           get_key = nil

data/spec/bundling_dispatch_spec.rb

@@ -0,0 +1,90 @@
+# 同梱系API追加(v0.0.23)に伴う method_missing ディスパッチの検証。
+# 実APIには接続せず、post を差し替えて model / method / get_key の解決のみを検証する。
+#
+# 実行: rspec spec/bundling_dispatch_spec.rb  (bundle exec 不要 / グローバルgem使用)
+
+require_relative "../lib/ne_api"
+
+RSpec.describe NeAPI::Master do
+  subject(:master) { described_class.new(access_token: "a", refresh_token: "r") }
+
+  # post を差し替え、method_missing が組み立てた引数をそのまま返させる
+  before do
+    allow(master).to receive(:post) { |**kwargs| kwargs }
+  end
+
+  describe "既存メソッドのディスパッチ(後方互換)" do
+    it "receiveorder_base_search は search に解決される" do
+      result = master.receiveorder_base_search
+      expect(result).to include(model: :receiveorder_base, method: "search", get_key: "data")
+    end
+
+    it "件数取得は count / get_key=count に解決される" do
+      expect(master.receiveorder_base_count).to include(method: "count", get_key: "count")
+    end
+
+    it "info系は info / get_key=nil に解決される" do
+      expect(master.login_company_info).to include(model: :login_company, method: "info", get_key: nil)
+    end
+
+    it "一括更新は bulkupdate / get_key=result に解決される" do
+      expect(master.receiveorder_base_bulkupdate).to include(method: "bulkupdate", get_key: "result")
+    end
+  end
+
+  describe "モデル名の前方一致が曖昧なケースの解決" do
+    it "master_goods_search は master_goods に解決される" do
+      expect(master.master_goods_search).to include(model: :master_goods, method: "search")
+    end
+
+    it "master_goods_page_search はより長い master_goods_page に解決される" do
+      expect(master.master_goods_page_search).to include(model: :master_goods_page, method: "search")
+    end
+
+    it "master_goods_page_variation_search は最長一致の master_goods_page_variation に解決される" do
+      expect(master.master_goods_page_variation_search)
+        .to include(model: :master_goods_page_variation, method: "search")
+    end
+  end
+
+  describe "同梱系API(v0.0.23 で追加)" do
+    it "receiveorder_base_bundle は bundle / get_key=results に解決される" do
+      result = master.receiveorder_base_bundle(params: { data: "[]", receive_order_recalculate_flag: 1 })
+      expect(result).to include(model: :receiveorder_base, method: "bundle", get_key: "results")
+    end
+
+    it "bundle は params をそのまま post へ渡す" do
+      params = { data: "[{\"receive_order_id\":\"1\"}]", receive_order_recalculate_flag: 1 }
+      expect(master.receiveorder_base_bundle(params: params)).to include(params: params)
+    end
+
+    it "複数語メソッド bundle_candidate_groups が groups に解決される" do
+      result = master.receiveorder_base_bundle_candidate_groups(params: { target_receive_order_ids: "1,2,3" })
+      expect(result).to include(
+        model: :receiveorder_base,
+        method: "bundle_candidate_groups",
+        get_key: "groups"
+      )
+    end
+
+    it "receiveorder_groupingtag_search は新規モデルとして search に解決される" do
+      result = master.receiveorder_groupingtag_search
+      expect(result).to include(model: :receiveorder_groupingtag, method: "search", get_key: "data")
+    end
+
+    it "groupingtag_search はデフォルトfieldsに grouping_tag_ プレフィックスを付与する" do
+      expect(master.receiveorder_groupingtag_search[:fields]).to start_with("grouping_tag_id,")
+    end
+  end
+
+  describe "未定義メソッド" do
+    it "存在しないAPIは NoMethodError を送出する" do
+      expect { master.nonexistent_foo }.to raise_error(NoMethodError)
+    end
+
+    it "存在するモデルでも未定義のメソッドは NoMethodError を送出する" do
+      # receiveorder_groupingtag は search のみ。update は未定義。
+      expect { master.receiveorder_groupingtag_update }.to raise_error(NoMethodError)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ne_api
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.23
 platform: ruby
 authors:
 - Yuuna Kurita
@@ -145,6 +145,7 @@ extra_rdoc_files: []
 files:
 - ".env"
 - ".gitignore"
+- BUNDLING_API.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -158,6 +159,7 @@ files:
 - lib/ne_api/testing/rspec_helpers.rb
 - lib/ne_api/version.rb
 - ne_api.gemspec
+- spec/bundling_dispatch_spec.rb
 - spec/ne_api_spec.rb
 homepage: http://github.com/infinity-octaver/ne_api/
 licenses:
@@ -181,4 +183,5 @@ rubygems_version: 4.0.1
 specification_version: 4
 summary: Next Engine API for ruby
 test_files:
+- spec/bundling_dispatch_spec.rb
 - spec/ne_api_spec.rb