shopify_api 5.2.1 → 5.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9c77838f7f17c68d5a215c1f7be62d2cbd7d14307435694070f8252efe222af
-  data.tar.gz: 0dc09a8b02adb8471380384683150949fe081eb8304bb1e7a0fd82ee1af28e48
+  metadata.gz: b24e62339306bcf90e50246ef4e98f4ffa46c6a885d5859b14969f3aa1e62c9c
+  data.tar.gz: 7e57071a073cb0e5e2bda965a1ef4cef3cc42a968905b407df9184757a04ec3b
 SHA512:
-  metadata.gz: d75774779c87aec609443674312a27d4c9b8530745ff7127bcb149ba6a01b84ebdfe0a986a04b07b7aa5be4c6e9ba8e88cafdd3f4ec41c530c87c12cd6ffe940
-  data.tar.gz: c22a07f6fb4af17fa6c9d76fc8e6e806e339e948a6d64481c5d29525d109cb0cff44dadf2b0b99ee18a16c94bf45941c47aeb821ab71c1f99ea1c43a67fcb75e
+  metadata.gz: 5224d787f4cc65f3174fa894098af11b7342059510c916fc4359ab2285793053e97bfb8eee318e136410fe6fd67626f7146f7f7727f8dba4e5bcc1b32867d597
+  data.tar.gz: 54c9dfed163c44b51fd811ba38efcf4c157ffdcaad5b5cc7f064e035ad0c890d9580b20ed316b75f99cac6368eb19e17e19c1a2da1bb556eb49562dd3f947a72

data/CHANGELOG

@@ -1,3 +1,7 @@
+== Version 5.2.2
+
+* Add delivery confirmation endpoint to Ping resources.
+
 == Version 5.2.1
 
 * Log warning when Shopify indicates deprecated API call was performed

data/lib/shopify_api/resources/ping/conversation.rb

@@ -13,6 +13,33 @@ module ShopifyAPI
         message.save
         message
       end
+
+      def successful_delivery(message_id:, delivery_timestamp:)
+        delivery_details = ShopifyAPI::Ping::DeliveryConfirmation.new(
+          conversation_id: id,
+          message_id: message_id,
+          delivery_confirmation_details: {
+            delivered: true,
+            confirmation_timestamp: delivery_timestamp,
+          }
+        )
+        delivery_details.save
+        delivery_details
+      end
+
+      def failed_delivery(message_id:, delivery_timestamp:, details:)
+        delivery_details = ShopifyAPI::Ping::DeliveryConfirmation.new(
+          conversation_id: id,
+          message_id: message_id,
+          delivery_confirmation_details: {
+            delivered: false,
+            confirmation_timestamp: delivery_timestamp,
+            details: details,
+          }
+        )
+        delivery_details.save
+        delivery_details
+      end
     end
   end
 end

data/lib/shopify_api/resources/ping/delivery_confirmation.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  module Ping
+    class DeliveryConfirmation < Base
+      self.prefix = "/admin/api/ping-api/v1/conversations/:conversation_id/messages/:message_id/"
+      self.collection_name = "delivery_confirmation"
+    end
+  end
+end

data/lib/shopify_api/resources/ping/message.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-
 module ShopifyAPI
   module Ping
     class Message < Base

data/lib/shopify_api/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "5.2.1"
+  VERSION = "5.2.2"
 end

data/test/fixtures/ping/failed_delivery_confirmation.json

@@ -0,0 +1 @@
+{"delivery_confirmation_details":{"delivery_timestamp":"2018-08-29T22:16:05.589479Z","delivered":"false","details":"Integration failed to deliver message."}}

data/test/fixtures/ping/successful_delivery_confirmation.json

@@ -0,0 +1 @@
+{"delivery_confirmation_details":{"delivery_timestamp":"2018-08-29T22:16:05.589479Z","delivered":"true"}}

data/test/ping/conversation_test.rb

@@ -36,4 +36,36 @@ class PingConversationTest < Test::Unit::TestCase
 
     assert_equal "d0c7a2e6-8084-4e79-8483-e4a1352b81f7", message.id
   end
+
+  def test_successful_delivery
+    fake("api/ping-api/v1/conversations/123/messages/111/delivery_confirmation",
+      method: :post,
+      body: load_fixture('ping/successful_delivery_confirmation'))
+
+    conversation = ShopifyAPI::Ping::Conversation.new(id: '123')
+    delivery_confirmation = conversation.successful_delivery(
+      message_id: '111',
+      delivery_timestamp: "2018-08-29T22:16:05.589479Z"
+    )
+
+    assert_equal("true", delivery_confirmation.delivered)
+    assert_equal("2018-08-29T22:16:05.589479Z", delivery_confirmation.delivery_timestamp)
+  end
+
+  def test_failed_delivery
+    fake("api/ping-api/v1/conversations/123/messages/111/delivery_confirmation",
+      method: :post,
+      body: load_fixture('ping/failed_delivery_confirmation'))
+
+    conversation = ShopifyAPI::Ping::Conversation.new(id: '123')
+    delivery_confirmation = conversation.failed_delivery(
+      message_id: '111',
+      delivery_timestamp: Time.now.to_s,
+      details: "Integration failed to deliver message."
+    )
+
+    assert_equal("false", delivery_confirmation.delivered)
+    assert_equal("2018-08-29T22:16:05.589479Z", delivery_confirmation.delivery_timestamp)
+    assert_equal("Integration failed to deliver message.", delivery_confirmation.details)
+  end
 end

data/test/ping/message_test.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class PingMessageTest < Test::Unit::TestCase
+  def test_create_message
+    fake("api/ping-api/v1/conversations/123/messages",
+      method: :post,
+      body: load_fixture('ping/message'))
+
+    message = ShopifyAPI::Ping::Message.new(
+      dedupe_key: SecureRandom.uuid,
+      content: {
+        text: "Hello from shopify_api",
+      },
+      sender_id: 'test',
+      conversation_id: '123',
+    )
+
+    message.save
+    assert_equal("d0c7a2e6-8084-4e79-8483-e4a1352b81f7", message.id)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 5.2.1
+  version: 5.2.2
 platform: ruby
 authors:
 - Shopify
@@ -250,6 +250,7 @@ files:
 - lib/shopify_api/resources/payment_details.rb
 - lib/shopify_api/resources/ping.rb
 - lib/shopify_api/resources/ping/conversation.rb
+- lib/shopify_api/resources/ping/delivery_confirmation.rb
 - lib/shopify_api/resources/ping/message.rb
 - lib/shopify_api/resources/policy.rb
 - lib/shopify_api/resources/price_rule.rb
@@ -374,7 +375,9 @@ files:
 - test/fixtures/payment.json
 - test/fixtures/payments.json
 - test/fixtures/ping/conversation.json
+- test/fixtures/ping/failed_delivery_confirmation.json
 - test/fixtures/ping/message.json
+- test/fixtures/ping/successful_delivery_confirmation.json
 - test/fixtures/policies.json
 - test/fixtures/price_rule.json
 - test/fixtures/price_rules.json
@@ -429,6 +432,7 @@ files:
 - test/order_test.rb
 - test/payment_test.rb
 - test/ping/conversation_test.rb
+- test/ping/message_test.rb
 - test/policy_test.rb
 - test/price_rule_test.rb
 - test/product_listing_test.rb