choiceqr 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07dec0ce2e854c10973278cf04728e882f6402babed554baed28ad04760b267e
-  data.tar.gz: 138b5ff77c3bfe9b9113fddd791bc32fbee5d59abe4a3a949c3037e72f7ee410
+  metadata.gz: c1977ab8cbeaec88217f43e89bdc837caccb65f844e1a8dfb0916395e8d25d23
+  data.tar.gz: 670d2b1b9edbe47c72ef1e2f0f86822deba3f7df451431bad0313ad5ffe2d863
 SHA512:
-  metadata.gz: 5214c6437aab17feab020cdd34046e8001406667efc3936f5d1469903a13da27723e11ed008778807a886768566d2de1ec1354b24f99759c470ef0eed38148e9
-  data.tar.gz: 33437df630e03f6718fd77d41df0e6fd5a195f81f4046fee2f18d9ea8f2f687bdc9b07590b8cc21e9709bb05efe083bcd744778e2e70e30993bcb46b227bac3a
+  metadata.gz: 157e389e0d57323bff53ea4f82ebc81c8c8eebc2f6df3d3f7072a073699b77a97be15334a744a0614d4305f305fcb7909d12d72a8ae430d7648709a1c490f6c7
+  data.tar.gz: 8fc87c2cdb3958d62122a9e2c50ea8d06b04dfb648b5526c69bed1f4195463935dbeaf5bac5f2f5a219ceebba7a5f87de96c00b47d879e15012a6637559b3436

data/README.md

@@ -228,7 +228,26 @@ client = ChoiceQR::Client.new(
 
 ## Webhooks
 
-ChoiceQR pushes events (menu changes, new orders, booking updates, …) to a Webhook URL you configure when creating your application — there is no API for managing webhook subscriptions, so this gem does not include a webhook client. See [Webhooks](https://open-api.choiceqr.com/docs/content/webhooks) for the event payload shape; the `data` field of each event matches the corresponding resource's response schema, so you can wrap it yourself with `ChoiceQR::Resource.new(event["data"])` if useful.
+ChoiceQR pushes events (menu changes, new orders, booking updates, …) to a Webhook URL you configure when creating your application — there is no API for managing webhook subscriptions, so there's no `client.webhooks`. `ChoiceQR::WebhookEvent` parses the payload your endpoint receives:
+
+```ruby
+post "/webhooks/choiceqr" do
+  event = ChoiceQR::WebhookEvent.parse(request.body.read)
+
+  case event.type
+  when "dish.created", "dish.changed"
+    Dish.upsert_from_choiceqr(event.data) # same shape as Dishes#get
+  when "order.created"
+    Order.create_from_choiceqr(event.data)
+  when "section.positionChanged"
+    Section.reorder(event.data.items) # array of section ids
+  end
+end
+```
+
+`event.data`'s shape depends on `event.type` — usually the same entity schema the matching resource method returns, but `*.positionChanged` events carry `{items: [...ids]}` and `*.removed` events carry just an id. `ChoiceQR::WebhookEvent::TYPES` lists every documented event type (not enforced — an unrecognized `type` still parses fine). See [Webhooks](https://open-api.choiceqr.com/docs/content/webhooks) for the full type → shape mapping.
+
+**ChoiceQR does not document a signature or secret for verifying a webhook's authenticity.** `WebhookEvent` parses the payload; it does not, and cannot, confirm the request actually came from ChoiceQR.
 
 ## Development
 

data/lib/choiceqr/version.rb

@@ -1,3 +1,3 @@
 module ChoiceQR
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/choiceqr/webhook_event.rb

@@ -0,0 +1,122 @@
+require "json"
+
+module ChoiceQR
+  # Wraps an incoming webhook event payload — the thing your own server
+  # receives at the Webhook URL configured for your application (see
+  # https://open-api.choiceqr.com/docs/content/application), not something
+  # this gem calls the API for. ChoiceQR has no API for managing webhook
+  # subscriptions (the URL is set once in the app dashboard), so there is no
+  # corresponding client.webhooks resource — this class only parses the
+  # payload shape.
+  #
+  # IMPORTANT: ChoiceQR does not document a signature or secret for
+  # verifying that a webhook request genuinely came from ChoiceQR. This
+  # class parses the payload; it does not, and cannot, authenticate it.
+  #
+  # Usage (e.g. inside a Rack/Sinatra/Rails webhook endpoint):
+  #
+  #   event = ChoiceQR::WebhookEvent.parse(request.body.read)
+  #   event.id          # => "unique_id"
+  #   event.type        # => "dish.created"
+  #   event.lang_code   # => "en"
+  #   event.var_symbol  # => company id
+  #
+  #   case event.type
+  #   when "dish.created", "dish.changed"
+  #     event.data.name   # data is the same Dish shape #dishes.get returns
+  #   when "section.positionChanged"
+  #     event.data.items  # => array of section ids
+  #   when /\.removed\z/
+  #     event.data.id     # => {_id: "..."} → :id
+  #   end
+  #
+  # See https://open-api.choiceqr.com/docs/content/webhooks for the full
+  # event type → data shape mapping.
+  class WebhookEvent
+    # Every event type ChoiceQR documents, for reference — not enforced:
+    # #type is whatever string the payload contains, so an event type added
+    # to the API later still parses fine here.
+    TYPES = %w[
+      place.changed
+      sectionInfo.changed
+      section.created section.changed section.positionChanged section.removed
+      category.created category.changed category.positionChanged category.removed
+      dish.created dish.changed dish.positionChanged dish.removed
+      dishOption.changed
+      menuLabel.created menuLabel.changed menuLabel.removed
+      option.created option.changed option.positionChanged option.removed
+      import.full.done
+      marketplace.acceptance.enabled marketplace.acceptance.disabled
+      order.created order.accepted order.cancelled order.closed order.delivery.update
+      order.qrPayment.completed order.qrPayment.error
+    ].freeze
+
+    # +payload+ is a JSON String (e.g. a raw request body) or an
+    # already-parsed Hash.
+    def self.parse(payload)
+      new(payload.is_a?(String) ? JSON.parse(payload) : payload)
+    end
+
+    def initialize(attributes)
+      @resource = Resource.new(attributes)
+    end
+
+    def id
+      @resource.id
+    end
+
+    # The event type, e.g. "dish.created", "order.qrPayment.completed" — see
+    # TYPES.
+    def type
+      @resource.type
+    end
+
+    def lang_code
+      @resource.lang_code
+    end
+
+    # Uniq identifier of the company the event belongs to.
+    def var_symbol
+      @resource.var_symbol
+    end
+
+    # The event-specific payload. Its shape depends on #type — see the class
+    # docs above and https://open-api.choiceqr.com/docs/content/webhooks.
+    def data
+      @resource.data
+    end
+
+    # Hash-style access, for any envelope field not covered by a named
+    # reader above.
+    def [](key)
+      @resource[key]
+    end
+
+    def to_h
+      @resource.to_h
+    end
+
+    def inspect
+      "#<#{self.class.name} type=#{type.inspect} id=#{id.inspect}>"
+    end
+
+    def to_s
+      inspect
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @resource.respond_to?(name, include_private) || super
+    end
+
+    # Delegates to the underlying Resource, so any envelope field not given
+    # a named reader above (or a documented-but-misspelled one) is still
+    # reachable by dot access.
+    def method_missing(name, *, &)
+      if @resource.respond_to?(name)
+        @resource.public_send(name, *, &)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/choiceqr.rb

@@ -3,6 +3,7 @@ require_relative "choiceqr/errors"
 require_relative "choiceqr/configuration"
 require_relative "choiceqr/key_transformer"
 require_relative "choiceqr/resource"
+require_relative "choiceqr/webhook_event"
 require_relative "choiceqr/resources/base"
 require_relative "choiceqr/resources/place"
 require_relative "choiceqr/resources/section_info"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: choiceqr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Stockbird Team
@@ -142,6 +142,7 @@ files:
 - lib/choiceqr/resources/section_info.rb
 - lib/choiceqr/resources/sections.rb
 - lib/choiceqr/version.rb
+- lib/choiceqr/webhook_event.rb
 homepage: https://github.com/stockbird-app/choiceqr
 licenses:
 - MIT