ruby_shopify_api 1.0.0

data/test/lib/webmock_extensions/last_request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module LastRequest
+  def last_request
+    @last_request
+  end
+
+  def last_request=(request_signature)
+    @last_request = request_signature
+  end
+end
+
+WebMock.extend(LastRequest)
+WebMock.after_request do |request_signature, _response|
+  WebMock.last_request = request_signature
+end

data/test/limits_test.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class LimitsTest < Test::Unit::TestCase
+  def setup
+    super
+    @header_hash = { 'X-Shopify-Shop-Api-Call-Limit' => '100/300' }
+    ShopifyAPI::Base.connection.expects(:response).at_least(0).returns(@header_hash)
+  end
+
+  context "Limits" do
+    should "fetch limit total" do
+      assert_equal(299, ShopifyAPI.credit_limit(:shop))
+    end
+
+    should "fetch used calls" do
+      assert_equal(100, ShopifyAPI.credit_used(:shop))
+    end
+
+    should "calculate remaining calls" do
+      assert_equal(199, ShopifyAPI.credit_left)
+    end
+
+    should "flag maxed out credits" do
+      assert !ShopifyAPI.maxed?
+      @header_hash = { 'X-Shopify-Shop-Api-Call-Limit' => '299/300' }
+      ShopifyAPI::Base.connection.expects(:response).at_least(1).returns(@header_hash)
+      assert ShopifyAPI.maxed?
+    end
+
+    should "raise error when header doesn't exist" do
+      @header_hash = {}
+      ShopifyAPI::Base.connection.expects(:response).at_least(1).returns(@header_hash)
+      assert_raises(ShopifyAPI::Limits::LimitUnavailable) do
+        ShopifyAPI.credit_left
+      end
+    end
+  end
+end

data/test/location_test.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+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/marketing_event_test.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class MarketingEventTest < Test::Unit::TestCase
+  def test_get_marketing_events
+    fake("marketing_events", method: :get, body: load_fixture('marketing_events'))
+    marketing_events = ShopifyAPI::MarketingEvent.all
+    assert_equal(2, marketing_events.size)
+  end
+
+  def test_get_marketing_event
+    fake("marketing_events/1", method: :get, body: load_fixture('marketing_event'))
+    marketing_event = ShopifyAPI::MarketingEvent.find(1)
+    assert_equal(1, marketing_event.id)
+  end
+
+  def test_create_marketing_event
+    fake("marketing_events", method: :post, body: load_fixture('marketing_event'))
+    marketing_event = ShopifyAPI::MarketingEvent.new
+    marketing_event.currency_code = 'GBP'
+    marketing_event.event_target = 'facebook'
+    marketing_event.event_type = 'post'
+    marketing_event.save
+
+    assert_equal('facebook', marketing_event.event_target)
+    assert_equal(1, marketing_event.id)
+  end
+
+  def test_delete_marketing_event
+    fake("marketing_events/1", method: :get, body: load_fixture('marketing_event'))
+    fake("marketing_events/1", method: :delete, body: "destroyed")
+    marketing_event = ShopifyAPI::MarketingEvent.find(1)
+    assert(marketing_event.destroy)
+  end
+
+  def test_update_marketing_event
+    fake('marketing_events/1', method: :get, status: 200, body: load_fixture('marketing_event'))
+    marketing_event = ShopifyAPI::MarketingEvent.find(1)
+    marketing_event.currency = 'USD'
+    fake('marketing_events/1', method: :put, status: 200, body: load_fixture('marketing_event'))
+    assert(marketing_event.save)
+  end
+
+  def test_count_marketing_events
+    fake("marketing_events/count", method: :get, body: '{"count": 2}')
+    marketing_events_count = ShopifyAPI::MarketingEvent.count
+    assert_equal(2, marketing_events_count)
+  end
+
+  def test_add_engagements
+    fake("marketing_events/1", method: :get, body: load_fixture('marketing_event'))
+    marketing_event = ShopifyAPI::MarketingEvent.find(1)
+    fake("marketing_events/1/engagements", method: :post, status: 201, body: load_fixture('engagement'))
+    engagement = {
+      occurred_on: "2017-04-20",
+      impressions_count: nil,
+      views_count: nil,
+      clicks_count: 10,
+      shares_count: nil,
+      favorites_count: nil,
+      comments_count: nil,
+      ad_spend: nil,
+      is_cumulative: true,
+    }
+    marketing_event.add_engagements(engagement)
+    assert("2017-04-20", engagement[:occurred_on])
+  end
+end

data/test/message_enricher_test.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class MessageEnricherTest < Test::Unit::TestCase
+  def test_enriches_initial_message_when_body_contains_error
+    response = enriched_response(422, 'InitialMessage', { error: 'My Error' })
+
+    assert_equal('InitialMessage (My Error)', response.message)
+  end
+
+  def test_enriches_initial_message_when_body_contains_errors_array
+    response = enriched_response(422, 'InitialMessage', { errors: ['My Error1', 'My Error2'] })
+
+    assert_equal('InitialMessage (My Error1; My Error2)', response.message)
+  end
+
+  def test_enriches_initial_message_when_body_contains_errors_single_value
+    response = enriched_response(422, 'InitialMessage', { errors: 'My Error1' })
+
+    assert_equal('InitialMessage (My Error1)', response.message)
+  end
+
+  def test_returns_initial_message_when_code_is_200
+    response = enriched_response(200, 'InitialMessage', { result: 'Success' })
+
+    assert_equal('InitialMessage', response.message)
+  end
+
+  def test_returns_initial_message_when_body_cant_be_parsed
+    response = enriched_response(422, 'InitialMessage', 'not a json')
+
+    assert_equal('InitialMessage', response.message)
+  end
+
+  private
+
+  def enriched_response(code, message, body)
+    mock_response =
+      Struct
+        .new(:code, :message, :body)
+        .new(code.to_s, message.to_s, body.to_json)
+
+    ShopifyAPI::MessageEnricher.new(mock_response)
+  end
+end

data/test/meta_test.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class ApiVersionTest < Test::Unit::TestCase
+  test ".admin_versions returns array of api versions for admin" do
+    versions = [
+      {
+        "handle": "2019-01",
+        "display_name": "2019-01",
+        "supported": true,
+        "latest_supported": false,
+      },
+      {
+        "handle": "2019-04",
+        "latest_supported": false,
+        "display_name": "2019-04",
+        "supported": true,
+      },
+      {
+        "handle": "2019-07",
+        "latest_supported": false,
+        "display_name": "2019-07",
+        "supported": true,
+      },
+      {
+        "handle": "2019-10",
+        "latest_supported": false,
+        "display_name": "2019-10",
+        "supported": true,
+      },
+      {
+        "handle": "2020-01",
+        "latest_supported": true,
+        "display_name": "2020-01 (Latest)",
+        "supported": true,
+      },
+      {
+        "handle": "unstable",
+        "latest_supported": false,
+        "display_name": "unstable",
+        "supported": false,
+      },
+    ].as_json
+
+    assert_equal versions, ShopifyAPI::Meta.admin_versions.as_json
+  end
+end

data/test/metafield_test.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class MetafieldTest < Test::Unit::TestCase
+  def test_get_metafields
+    fake("metafields", method: :get, body: load_fixture('metafields'))
+    ShopifyAPI::Metafield.find(:all)
+  end
+
+  def test_get_metafield
+    fake("metafields/721389482", method: :get, body: load_fixture('metafield'))
+    assert(ShopifyAPI::Metafield.find(721389482))
+  end
+
+  def test_get_metafield_of_a_blog
+    fake("blogs/1008414260/metafields/721389482", method: :get, body: load_fixture('metafield'))
+    metafield = ShopifyAPI::Metafield.find(721389482, params: { resource: "blogs", resource_id: 1008414260 })
+    assert_equal(1008414260, metafield.prefix_options[:resource_id])
+  end
+
+  def test_create_metafield_for_a_blog
+    fake("blogs/1008414260", method: :get, body: load_fixture('blog'))
+    fake("blogs/1008414260/metafields", method: :post, status: 201, body: load_fixture('metafield'))
+
+    blog = ShopifyAPI::Blog.find(1008414260)
+    metafield = blog.add_metafield(
+      ShopifyAPI::Metafield.new(
+        namespace: "summaries", key: "First Summary", value: "Make commerce better", value_type: "string"
+      )
+    )
+
+    assert_equal(
+      ActiveSupport::JSON.decode(
+        '{"metafield":{"namespace":"summaries","key":"First Summary",' \
+          '"value":"Make commerce better","value_type":"string"}}'
+      ),
+      ActiveSupport::JSON.decode(WebMock.last_request.body)
+    )
+    assert(!metafield.new_record?)
+  end
+
+  def test_update_metafield
+    fake("metafields/721389482", method: :get, body: load_fixture('metafield'))
+    fake("metafields/721389482", method: :put, status: 200, body: load_fixture('metafield'))
+    metafield = ShopifyAPI::Metafield.find(721389482)
+    metafield.namespace = "teaser"
+    assert(metafield.save)
+  end
+
+  def test_delete_metafield
+    fake("metafields/721389482", method: :get, body: load_fixture('metafield'))
+    fake("metafields/721389482", method: :delete, body: 'destroyed')
+    metafield = ShopifyAPI::Metafield.find(721389482)
+    assert(metafield.destroy)
+  end
+end

data/test/order_risk_test.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class OrderRiskTest < Test::Unit::TestCase
+  def test_create_order_risk
+    fake("orders/450789469/risks", method: :post, body: load_fixture('order_risk'))
+    v = ShopifyAPI::OrderRisk.new(order_id: 450789469)
+    v.message = "This order was placed from a proxy IP"
+    v.recommendation = "cancel"
+    v.score = "1.0"
+    v.source = "External"
+    v.merchant_message = "This order was placed from a proxy IP"
+    v.display = true
+    v.cause_cancel = true
+    v.save
+
+    assert_equal(284138680, v.id)
+  end
+
+  def test_get_order_risks
+    fake("orders/450789469/risks", method: :get, body: load_fixture('order_risks'))
+    v = ShopifyAPI::OrderRisk.find(:all, params: { order_id: 450789469 })
+    assert_equal(2, v.size)
+  end
+
+  def test_get_order_risk
+    fake("orders/450789469/risks/284138680", method: :get, body: load_fixture('order_risk'))
+    v = ShopifyAPI::OrderRisk.find(284138680, params: { order_id: 450789469 })
+    assert_equal(284138680, v.id)
+  end
+
+  def test_delete_order_risk
+    fake("orders/450789469/risks/284138680", method: :get, body: load_fixture('order_risk'))
+    fake("orders/450789469/risks/284138680", method: :delete, body: "destroyed")
+    v = ShopifyAPI::OrderRisk.find(284138680, params: { order_id: 450789469 })
+    assert(v.destroy)
+  end
+
+  def test_update_order_risk
+    fake("orders/450789469/risks/284138680", method: :get, body: load_fixture('order_risk'))
+    fake("orders/450789469/risks/284138680", method: :put, body: load_fixture('order_risk'))
+
+    v = ShopifyAPI::OrderRisk.find(284138680, params: { order_id: 450789469 })
+    v.position = 3
+    v.save
+  end
+end

data/test/order_test.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+require 'test_helper'
+require 'fulfillment_order_test_helper'
+
+class OrderTest < Test::Unit::TestCase
+  include FulfillmentOrderTestHelper
+
+  test "create should create order" do
+    fake('orders', method: :post, status: 201, body: load_fixture('order'))
+    order = ShopifyAPI::Order.create(
+      line_items: [{ quantity: 1, variant_id: 39072856 }],
+      financial_status: "authorized"
+    )
+    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
+    assert_equal(450789469, order.first.id)
+  end
+
+  test "add note should add a note to order" do
+    fake('orders/450789469', method: :get, status: 200, body: load_fixture('order'))
+    order = ShopifyAPI::Order.find(450789469)
+    order.note = "Test note"
+    fake('orders/450789469', method: :put, status: 200, body: load_fixture('order'))
+    order.save
+    assert_equal("Test note", order.note)
+  end
+
+  test "delete should delete an order" do
+    fake('orders/450789469', method: :get, status: 200, body: load_fixture('order'))
+    fake('orders/450789469', method: :delete, body: 'destroyed')
+    order = ShopifyAPI::Order.find(450789469)
+    assert(order.destroy)
+  end
+
+  test "cancel an order with params" do
+    fake('orders/450789469', method: :get, status: 200, body: load_fixture('order'))
+    fake('orders/450789469/cancel', method: :post, body: load_fixture('order'))
+    order = ShopifyAPI::Order.find(450789469)
+    order.cancel(email: false, restock: true)
+    assert_request_body({ 'email' => false, 'restock' => true }.to_json)
+  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
+
+  test "fulfillment_orders should get fulfillment orders for an order with 2020-01 version" do
+    url_prefix = url_prefix_for_activated_session_for('2020-01')
+
+    fake(
+      'orders',
+      url: "#{url_prefix}/orders/450789469.json",
+      method: :get,
+      status: 200,
+      body: load_fixture('order'),
+      extension: false
+    )
+    order = ShopifyAPI::Order.find(450789469)
+
+    fake(
+      'orders',
+      url: "#{url_prefix}/orders/450789469/fulfillment_orders.json",
+      method: :get,
+      status: 200,
+      body: load_fixture('fulfillment_orders'),
+      extension: false
+    )
+    fulfillment_orders = order.fulfillment_orders
+
+    assert_equal([519788021, 519788022], fulfillment_orders.map(&:id).sort)
+    fulfillment_orders.each do |fulfillment_order|
+      assert(fulfillment_order.is_a?(ShopifyAPI::FulfillmentOrder))
+      assert_equal(450789469, fulfillment_order.order_id)
+    end
+  end
+
+  test "fulfillment_orders raises NotImplementedError when api_version is older than 2020-01" do
+    url_prefix = url_prefix_for_activated_session_for('2019-10')
+
+    fake(
+      'orders',
+      url: "#{url_prefix}/orders/450789469.json",
+      method: :get,
+      status: 200,
+      body: load_fixture('order'),
+      extension: false
+    )
+    order = ShopifyAPI::Order.find(450789469)
+
+    assert_raises(NotImplementedError) do
+      order.fulfillment_orders
+    end
+  end
+end