shopify_api 4.9.0 → 5.2.4

data/test/fixtures/payment.json

@@ -0,0 +1,7 @@
+{
+  "payment" : {
+    "amount": 10.00,
+    "session_id": "east-44a400ef20b36e38f10b882cb7260796",
+    "unique_token": "my-client-generated-idempotency-token"
+  }
+}

data/test/fixtures/payments.json

@@ -0,0 +1,9 @@
+{
+  "payments" : [
+    {
+      "amount": 10.00,
+      "session_id": "east-44a400ef20b36e38f10b882cb7260796",
+      "unique_token": "my-client-generated-idempotency-token"
+    }
+  ]
+}

data/test/fixtures/ping/conversation.json

@@ -0,0 +1 @@
+{"conversation":{"id":"d315d4f7-53bd-49ec-8808-23f6db3c641a","name":"my topic","participants":{"counts":{"total":1},"data":[{"id":"test","name":"foo","avatar":null,"group":"customer"}]},"shopify_account":{"domain":"backpackinghacks.myshopify.com"}}}

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/message.json

@@ -0,0 +1 @@
+{"message":{"id":"d0c7a2e6-8084-4e79-8483-e4a1352b81f7","sender_id":"test","sender":{"id":"test","name":"foo","avatar":null,"group":"customer"},"content":{"text":"Hello from shopify_api"},"sent_at":"2018-08-29T22:16:05.589479Z"}}

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/fixtures/product_publication.json

@@ -0,0 +1,11 @@
+{
+  "product_publication": {
+    "id": 647162527768,
+    "publication_id": 55650051,
+    "published_at": "2018-01-29T14:06:08-05:00",
+    "published": true,
+    "created_at": "2018-01-29T14:06:08-05:00",
+    "updated_at": "2018-09-26T15:39:05-04:00",
+    "product_id": 8267093571
+  }
+}

data/test/fixtures/product_publications.json

@@ -0,0 +1,13 @@
+{
+  "product_publications": [
+    {
+        "id": 647162527768,
+        "publication_id": 55650051,
+        "published_at": "2018-01-29T14:06:08-05:00",
+        "published": true,
+        "created_at": "2018-01-29T14:06:08-05:00",
+        "updated_at": "2018-09-26T15:39:05-04:00",
+        "product_id": 8267093571
+    }
+  ]
+}

data/test/fixtures/publications.json

@@ -0,0 +1,9 @@
+{
+  "publications": [
+    {
+      "id": 55650051,
+      "created_at": "2016-05-20T13:12:10-04:00",
+      "name": "Buy Button"
+    }
+  ]
+}

data/test/fixtures/shipping_rates.json

@@ -0,0 +1,12 @@
+[
+  {
+    "id": "canada_post-INT.TP.BOGUS-4.00",
+    "price": "4.00",
+    "title": "Small Packet International Air Bogus"
+  },
+  {
+    "id": "canada_post-INT.TP.BOGUS-8.00",
+    "price": "8.00",
+    "title": "Medium Packet International Air Bogus"
+  }
+]

data/test/fixtures/smart_collection_products.json

@@ -0,0 +1,155 @@
+{
+  "products": [
+    {
+      "product_type": "Cult Products",
+      "handle": "ipod-nano",
+      "created_at": "2011-10-20T14:05:13-04:00",
+      "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>",
+      "title": "IPod Nano - 8GB",
+      "template_suffix": null,
+      "updated_at": "2011-10-20T14:05:13-04:00",
+      "id": 632910392,
+      "tags": "Emotive, Flash Memory, MP3, Music",
+      "images": [
+        {
+          "position": 1,
+          "created_at": "2011-10-20T14:05:13-04:00",
+          "product_id": 632910392,
+          "updated_at": "2011-10-20T14:05:13-04:00",
+          "src": "http://static.shopify.com/s/files/1/6909/3384/products/ipod-nano.png?0",
+          "id": 850703190
+        }
+      ],
+      "variants": [
+        {
+          "position": 1,
+          "price": "199.00",
+          "product_id": 632910392,
+          "created_at": "2011-10-20T14:05:13-04:00",
+          "requires_shipping": true,
+          "title": "Pink",
+          "inventory_quantity": 10,
+          "compare_at_price": null,
+          "inventory_policy": "continue",
+          "updated_at": "2011-10-20T14:05:13-04:00",
+          "inventory_management": "shopify",
+          "id": 808950810,
+          "taxable": true,
+          "grams": 200,
+          "sku": "IPOD2008PINK",
+          "option1": "Pink",
+          "fulfillment_service": "manual",
+          "option2": null,
+          "option3": null
+        },
+        {
+          "position": 2,
+          "price": "199.00",
+          "product_id": 632910392,
+          "created_at": "2011-10-20T14:05:13-04:00",
+          "requires_shipping": true,
+          "title": "Red",
+          "inventory_quantity": 20,
+          "compare_at_price": null,
+          "inventory_policy": "continue",
+          "updated_at": "2011-10-20T14:05:13-04:00",
+          "inventory_management": "shopify",
+          "id": 49148385,
+          "taxable": true,
+          "grams": 200,
+          "sku": "IPOD2008RED",
+          "option1": "Red",
+          "fulfillment_service": "manual",
+          "option2": null,
+          "option3": null
+        },
+        {
+          "position": 3,
+          "price": "199.00",
+          "product_id": 632910392,
+          "created_at": "2011-10-20T14:05:13-04:00",
+          "requires_shipping": true,
+          "title": "Green",
+          "inventory_quantity": 30,
+          "compare_at_price": null,
+          "inventory_policy": "continue",
+          "updated_at": "2011-10-20T14:05:13-04:00",
+          "inventory_management": "shopify",
+          "id": 39072856,
+          "taxable": true,
+          "grams": 200,
+          "sku": "IPOD2008GREEN",
+          "option1": "Green",
+          "fulfillment_service": "manual",
+          "option2": null,
+          "option3": null
+        },
+        {
+          "position": 4,
+          "price": "199.00",
+          "product_id": 632910392,
+          "created_at": "2011-10-20T14:05:13-04:00",
+          "requires_shipping": true,
+          "title": "Black",
+          "inventory_quantity": 40,
+          "compare_at_price": null,
+          "inventory_policy": "continue",
+          "updated_at": "2011-10-20T14:05:13-04:00",
+          "inventory_management": "shopify",
+          "id": 457924702,
+          "taxable": true,
+          "grams": 200,
+          "sku": "IPOD2008BLACK",
+          "option1": "Black",
+          "fulfillment_service": "manual",
+          "option2": null,
+          "option3": null
+        }
+      ],
+      "vendor": "Apple",
+      "published_at": "2007-12-31T19:00:00-05:00",
+      "manually_sorted": true,
+      "options": [
+        {
+          "name": "Title"
+        }
+      ]
+    },
+    {
+      "product_type": "Cult Products",
+      "handle": "ipod-touch",
+      "created_at": "2018-09-26T14:05:13-04:00",
+      "body_html": "<p>The iPod Touch has the iPhone's multi-touch interface, with a physical home button off the touch screen. The home screen has a list of buttons for the available applications.</p>",
+      "title": "IPod Touch 8GB",
+      "template_suffix": null,
+      "updated_at": "2018-09-26T14:05:13-04:00",
+      "id": 921728736,
+      "tags": null,
+      "variants": [
+        {
+          "id": 447654529,
+          "title": "Black",
+          "price": "199.00",
+          "sku": "IPOD2009BLACK",
+          "position": 1,
+          "inventory_policy": "continue",
+          "compare_at_price": null,
+          "fulfillment_service": "manual",
+          "inventory_management": "shopify",
+          "option1": "Black",
+          "option2": null,
+          "option3": null,
+          "created_at": "2018-09-26T14:05:13-04:00",
+          "updated_at": "2018-09-26T14:05:13-04:00",
+          "taxable": true,
+          "grams": 567,
+          "inventory_quantity": 13,
+          "requires_shipping": true
+        }
+      ],
+      "vendor": "Apple",
+      "published_at": "2018-09-26T14:05:13-04:00",
+      "manually_sorted": true
+    }
+  ]
+}

data/test/fixtures/tender_transactions.json

@@ -0,0 +1,52 @@
+{
+  "tender_transactions": [
+    {
+      "id": 1,
+      "order_id": 450789469,
+      "amount": "138.46",
+      "currency": "CAD",
+      "user_id": null,
+      "test": true,
+      "processed_at": "2018-08-09T15:43:39-04:00",
+      "updated_at": "2018-08-09T15:43:41-04:00",
+      "remote_reference": "1118366",
+      "payment_method": "credit_card",
+      "payment_details": {
+        "credit_card_number": "•••• •••• •••• 1",
+        "credit_card_company": "Bogus"
+      }
+    },
+    {
+      "id": 2,
+      "order_id": 450789469,
+      "amount": "128.16",
+      "currency": "CAD",
+      "user_id": null,
+      "test": true,
+      "processed_at": "2018-08-11T15:43:39-04:00",
+      "updated_at": "2018-08-09T15:43:41-04:00",
+      "remote_reference": "1118367",
+      "payment_method": "credit_card",
+      "payment_details": {
+        "credit_card_number": "•••• •••• •••• 2",
+        "credit_card_company": "Bogus"
+      }
+    },
+    {
+      "id": 3,
+      "order_id": 450789469,
+      "amount": "28.16",
+      "currency": "CAD",
+      "user_id": null,
+      "test": true,
+      "processed_at": "2018-08-12T15:43:39-04:00",
+      "updated_at": "2018-08-09T15:43:41-04:00",
+      "remote_reference": "1118368",
+      "payment_method": "credit_card",
+      "payment_details": {
+        "credit_card_number": "•••• •••• •••• 3",
+        "credit_card_company": "Bogus"
+      }
+    }
+  ]
+}

data/test/inventory_level_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+class InventoryLevelTest < Test::Unit::TestCase
+  def setup
+    super
+    @inventory_level_response = ActiveSupport::JSON.decode load_fixture('inventory_level')
+    @inventory_level = ShopifyAPI::InventoryLevel.new(@inventory_level_response['inventory_level'])
+  end
+
+  test ".find with inventory_item_ids and location_ids returns expected inventory levels" do
+    params = { inventory_item_ids: [808950810, 39072856], location_ids: [905684977, 487838322] }
+    fake "inventory_levels.json?#{params.to_param}", extension: false, method: :get,
+          status: 200, body: load_fixture('inventory_levels')
+    inventory_levels = ShopifyAPI::InventoryLevel.find(:all, params: params)
+
+    assert inventory_levels.all? { |item|
+      params[:location_ids].include?(item.location_id) &&
+      params[:inventory_item_ids].include?(item.inventory_item_id)
+    }, message: 'Response contained inventory_items or locations not requested.'
+  end
+
+  test '#adjust with adjustment value returns inventory_level with available increased by adjustment value' do
+    adjustment = 5
+    updated_available = @inventory_level.available + adjustment
+    @inventory_level_response[:available] = updated_available
+
+    fake 'inventory_levels/adjust', method: :post, body: ActiveSupport::JSON.encode(@inventory_level_response)
+    @inventory_level.adjust(adjustment)
+    assert_equal updated_available, @inventory_level.available
+  end
+
+  test '#connect saves an inventory_level associated with inventory_item and location_id' do
+    params = { inventory_item_id: 808950810, location_id: 99999999 }
+    response = params.clone
+    response[:available] = 0
+
+    fake 'inventory_levels/connect', method: :post, body: ActiveSupport::JSON.encode(response)
+    inventory_level = ShopifyAPI::InventoryLevel.new(params)
+    inventory_level.connect
+    assert_equal 0, inventory_level.available, message: 'expected newly connected location to have 0 inventory'
+  end
+
+  test '#destroy removes inventory_level and returns nil' do
+    params = { inventory_item_id: @inventory_level.inventory_item_id, location_id: @inventory_level.location_id }
+    fake "inventory_levels.json?#{params.to_param}", extension: false, method: :delete, status: 204, body: nil
+    assert_nil @inventory_level.destroy
+  end
+
+  test '#set with available value returns inventory_level with available as the available value' do
+    available = 13
+    response = @inventory_level_response.clone
+    response['inventory_level']['available'] = available
+
+    fake 'inventory_levels/set', method: :post, body: ActiveSupport::JSON.encode(response)
+    @inventory_level.set(available)
+
+    assert_equal available, @inventory_level.available
+  end
+end

data/test/location_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class LocationTest < Test::Unit::TestCase
+  test '#inventory_levels returns all inventory_levels associated with this location' do
+    location = ShopifyAPI::Location.new(id: 487838322)
+    expected_body = JSON.parse(load_fixture('inventory_levels'))
+    expected_body['inventory_levels'].delete_if {|level| level['location_id'] != location.id }
+    fake "locations/#{location.id}/inventory_levels", method: :get, status: 200, body: JSON(expected_body).to_s
+    inventory_levels = location.inventory_levels
+
+    assert inventory_levels.all? { |item| item.location_id == location.id },
+           message: 'Response contained locations other than the current location.'
+  end
+end

data/test/order_test.rb

@@ -8,12 +8,25 @@ class OrderTest < Test::Unit::TestCase
     assert_equal 39072856, order.line_items.first.variant_id
   end
 
+  test "create should create an order with custom properties" do
+    props = [{ :"By default may label with \"Roasted for " => { :"Your First Name" => { :"\". If you want something specific on the label, enter it here:" => "" }}}]
+    fake 'orders', :method => :post, :status => 201, :body => load_fixture('order_with_properties')
+    order = ShopifyAPI::Order.create(line_items: [{quantity:1, variant_id:39072856, properties:props}], financial_status:"authorized")
+    assert_equal 39072856, order.line_items.first.variant_id
+  end
+
   test "get should get an order" do
     fake 'orders/450789469', :method => :get, :status => 200, :body => load_fixture('order')
     order = ShopifyAPI::Order.find(450789469)
     assert_equal 450789469, order.id
   end
 
+  test "get should get an order with custom properties" do
+    fake 'orders/450789469', :method => :get, :status => 200, :body => load_fixture('order_with_properties')
+    order = ShopifyAPI::Order.find(450789469)
+    assert_equal 450789469, order.id
+  end
+
   test "get all should get all orders" do
     fake 'orders', :method => :get, :status => 200, :body => load_fixture('orders')
     order = ShopifyAPI::Order.all
@@ -43,5 +56,20 @@ class OrderTest < Test::Unit::TestCase
     order.cancel(email: false, restock: true)
     assert_request_body({'email' => false, 'restock' => true}.to_json)
   end
-end
 
+  test "capture an order with currency param" do
+    fake 'orders/450789469', body: load_fixture('order')
+    order = ShopifyAPI::Order.find(450789469)
+
+    fake 'orders/450789469/transactions', method: :post, status: 201, body: load_fixture('transaction')
+    order.capture(100.00, currency: 'CAD')
+
+    assert_request_body({
+      transaction: {
+        amount: 100.00,
+        kind: 'capture',
+        currency: 'CAD',
+      },
+    }.to_json)
+  end
+end

data/test/payment_test.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class PaymentTest < Test::Unit::TestCase
+  def setup
+    super
+
+    @checkout_id = JSON.parse(load_fixture('checkout'))['checkout']['token']
+    @expected_payment = JSON.parse(load_fixture('payment'))['payment']
+  end
+
+  test ":create creates a new payment" do
+    fake "checkouts/#{@checkout_id}/payments", method: :post, status: 201, body: load_fixture('payment')
+
+    new_payment = ShopifyAPI::Payment.create(checkout_id: @checkout_id)
+
+    assert_equal @expected_payment['unique_token'], new_payment.attributes['unique_token']
+  end
+end

data/test/ping/conversation_test.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class PingConversationTest < Test::Unit::TestCase
+  def test_create_conversation
+    fake "api/ping-api/v1/conversations", method: :post, body: load_fixture('ping/conversation')
+
+    conversation = ShopifyAPI::Ping::Conversation.new(
+      topic: 'my topic',
+      participants: [
+        {
+          name: 'foo',
+          id: 'test',
+          group: 'customer',
+        },
+      ]
+    )
+
+    conversation.save
+
+    assert_equal "d315d4f7-53bd-49ec-8808-23f6db3c641a", conversation.id
+  end
+
+  def test_send_message
+    fake "api/ping-api/v1/conversations/123/messages", method: :post, body: load_fixture('ping/message')
+
+    conversation = ShopifyAPI::Ping::Conversation.new(id: '123')
+    message = conversation.send_message(
+      dedupe_key: SecureRandom.uuid,
+      content: {
+        text: "Hello from shopify_api",
+      },
+      sender_id: 'test',
+    )
+
+    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