shopify_api 4.9.0 → 9.4.1

data/test/graphql_test.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+require 'test_helper'
+require_relative 'fixtures/graphql/dummy_schema'
+
+class GraphQLTest < Test::Unit::TestCase
+  def setup
+    ShopifyAPI::ApiVersion.version_lookup_mode = :define_on_unknown
+    @fixture_location = Pathname('test/fixtures/graphql')
+    @site = 'https://this-is-my-test-shop.myshopify.com'
+    ShopifyAPI::Base.site = @site
+  end
+
+  def teardown
+    ShopifyAPI::GraphQL.clear_clients
+  end
+
+  test '#initialize_clients creates a GraphQL::Client from local schema file' do
+    version_fixtures('unstable') do |_dir|
+      ShopifyAPI::GraphQL.initialize_clients
+
+      assert(ShopifyAPI::GraphQL.client('unstable'))
+    end
+  end
+
+  test '#initialize_clients handles multiple schema files' do
+    version_fixtures('unstable', '2019-10') do |_dir|
+      ShopifyAPI::GraphQL.initialize_clients
+
+      assert(ShopifyAPI::GraphQL.client('unstable'))
+      assert(ShopifyAPI::GraphQL.client('2019-10'))
+    end
+  end
+
+  test '#initialize_clients ignores non JSON schema files' do
+    version_fixtures('unstable', '2019-10') do |_dir|
+      FileUtils.touch(ShopifyAPI::GraphQL.schema_location.join('nope.txt'))
+
+      ShopifyAPI::GraphQL.initialize_clients
+
+      assert(ShopifyAPI::GraphQL.client('unstable'))
+      assert(ShopifyAPI::GraphQL.client('2019-10'))
+    end
+  end
+
+  test '#initialize_clients raises if a JSON schema file is not named after a version' do
+    version_fixtures do |dir|
+      ShopifyAPI::GraphQL.schema_location = dir
+      FileUtils.touch(ShopifyAPI::GraphQL.schema_location.join('nope.json'))
+
+      assert_raises(ShopifyAPI::GraphQL::InvalidSchema) do
+        ShopifyAPI::GraphQL.initialize_clients
+      end
+    end
+  end
+
+  test '#initialize_clients does not raise if raise_on_invalid_schema is set to false' do
+    version_fixtures('unstable') do |dir|
+      ShopifyAPI::GraphQL.schema_location = dir
+      FileUtils.touch(ShopifyAPI::GraphQL.schema_location.join('nope.json'))
+
+      ShopifyAPI::GraphQL.initialize_clients(raise_on_invalid_schema: false)
+
+      assert(ShopifyAPI::GraphQL.client('unstable'))
+    end
+  end
+
+  test '#client returns default schema if only one exists' do
+    version_fixtures('unstable') do |_dir|
+      ShopifyAPI::Base.api_version = 'unstable'
+
+      ShopifyAPI::GraphQL.initialize_clients
+
+      assert_instance_of(::GraphQL::Client, ShopifyAPI::GraphQL.client)
+    end
+  end
+
+  test '#client accepts optional api_version parameter' do
+    version_fixtures('unstable') do |_dir|
+      ShopifyAPI::Base.api_version = 'unstable'
+
+      ShopifyAPI::GraphQL.initialize_clients
+
+      assert_instance_of(::GraphQL::Client, ShopifyAPI::GraphQL.client('unstable'))
+    end
+  end
+
+  test '#client executes queries on specified API version' do
+    version_fixtures('unstable', '2019-10') do |_dir|
+      ShopifyAPI::Base.api_version = 'unstable'
+
+      ShopifyAPI::GraphQL.initialize_clients
+      ShopifyAPI::Base.site = 'https://this-is-my-test-shop.myshopify.com'
+
+      client = ShopifyAPI::GraphQL.client('2019-10')
+
+      assert_instance_of(::GraphQL::Client, client)
+
+      query = client.parse(<<~GRAPHQL)
+        {
+          product {
+            name
+          }
+        }
+      GRAPHQL
+
+      path = ShopifyAPI::ApiVersion.new('2019-10').construct_graphql_path
+      stub_request(:post, "#{@site}#{path}").to_return(body: { product: { name: 'Shirt' } }.to_json)
+
+      client.query(query)
+    end
+  end
+
+  test '#client raises exception for version that does not exist' do
+    version_fixtures('unstable') do |_dir|
+      ShopifyAPI::Base.api_version = '2019-10'
+
+      ShopifyAPI::GraphQL.initialize_clients
+
+      assert_raises(ShopifyAPI::GraphQL::InvalidClient) do
+        ShopifyAPI::GraphQL.client('2019-10')
+      end
+    end
+  end
+
+  test '#client lazily initializes clients' do
+    version_fixtures('unstable') do |_dir|
+      ShopifyAPI::Base.api_version = 'unstable'
+
+      assert_raises(ShopifyAPI::GraphQL::InvalidClient) do
+        ShopifyAPI::GraphQL.client('2019-10')
+      end
+    end
+  end
+
+  test '#client caches lookups' do
+    version_fixtures('unstable') do |_dir|
+      ShopifyAPI::Base.api_version = 'unstable'
+
+      client1 = ShopifyAPI::GraphQL.client
+      client2 = ShopifyAPI::GraphQL.client('unstable')
+
+      assert_equal(client1, client2)
+    end
+  end
+
+  test '#client creates execution adapter based off configured class' do
+    class SuperDuperExecutionAdapter < ShopifyAPI::GraphQL::HTTPClient
+    end
+
+    ShopifyAPI::GraphQL.execution_adapter = SuperDuperExecutionAdapter
+    version_fixtures('unstable') do |_dir|
+      ShopifyAPI::Base.api_version = 'unstable'
+
+      ShopifyAPI::GraphQL.initialize_clients
+      assert_instance_of(SuperDuperExecutionAdapter, ShopifyAPI::GraphQL.client('unstable').execute)
+    end
+
+    ShopifyAPI::GraphQL.execution_adapter = nil
+  end
+
+  test '#client creates client based off configured class' do
+    class SuperDuperClient < ::GraphQL::Client
+    end
+
+    ShopifyAPI::GraphQL.graphql_client = SuperDuperClient
+    version_fixtures('unstable') do |_dir|
+      ShopifyAPI::Base.api_version = 'unstable'
+
+      ShopifyAPI::GraphQL.initialize_clients
+
+      assert_instance_of(SuperDuperClient, ShopifyAPI::GraphQL.client('unstable'))
+    end
+
+    ShopifyAPI::GraphQL.clear_clients
+    ShopifyAPI::GraphQL.graphql_client = nil
+  end
+
+  private
+
+  def version_fixtures(*versions)
+    Dir.mktmpdir do |dir|
+      versions.each do |version|
+        FileUtils.cp(@fixture_location.join("#{version}.json"), dir)
+      end
+
+      ShopifyAPI::GraphQL.schema_location = dir
+      yield(dir)
+    end
+  end
+end

data/test/image_test.rb

@@ -1,39 +1,41 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class ImageTest < Test::Unit::TestCase
   def test_create_image
-    fake "products/632910392/images", :method => :post, :body => load_fixture('image')
-    image = ShopifyAPI::Image.new(:product_id => 632910392)
+    fake("products/632910392/images", method: :post, body: load_fixture('image'))
+    image = ShopifyAPI::Image.new(product_id: 632910392)
     image.position = 1
-    image.attachment = "R0lGODlhbgCMAPf/APbr48VySrxTO7IgKt2qmKQdJeK8lsFjROG5p/nz7Zg3MNmnd7Q1MLNVS9GId71hSJMZIuzTu4UtKbeEeakhKMl8U8WYjfr18YQaIbAf=="
+    image.attachment = "R0lGODlhbgCMAPf/APbr48VySrxTO7IgKt2qmKQdJeK8lsFjROG5p/nz7Zg3MN" \
+      "mnd7Q1MLNVS9GId71hSJMZIuzTu4UtKbeEeakhKMl8U8WYjfr18YQaIbAf=="
     image.save
 
-    assert_equal 'http://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1389388540', image.src
-    assert_equal 850703190, image.id
+    assert_equal('http://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1389388540', image.src)
+    assert_equal(850703190, image.id)
   end
 
   def test_get_images
-    fake "products/632910392/images", :method => :get, :body => load_fixture('images')
-    image = ShopifyAPI::Image.find(:all, :params => {:product_id => 632910392})
-    assert_equal 2, image.size
+    fake("products/632910392/images", method: :get, body: load_fixture('images'))
+    image = ShopifyAPI::Image.find(:all, params: { product_id: 632910392 })
+    assert_equal(2, image.size)
   end
 
   def test_get_image
-    fake "products/632910392/images/850703190", :method => :get, :body => load_fixture('image')
-    image = ShopifyAPI::Image.find(850703190, :params => {:product_id => 632910392})
-    assert_equal 850703190, image.id
+    fake("products/632910392/images/850703190", method: :get, body: load_fixture('image'))
+    image = ShopifyAPI::Image.find(850703190, params: { product_id: 632910392 })
+    assert_equal(850703190, image.id)
   end
 
   def test_delete_image
-    fake "products/632910392/images/850703190", :method => :get, :body => load_fixture('image')
-    fake "products/632910392/images/850703190", :method => :delete, :body => "destroyed"
-    image = ShopifyAPI::Image.find(850703190, :params => {:product_id => 632910392})
-    assert image.destroy
+    fake("products/632910392/images/850703190", method: :get, body: load_fixture('image'))
+    fake("products/632910392/images/850703190", method: :delete, body: "destroyed")
+    image = ShopifyAPI::Image.find(850703190, params: { product_id: 632910392 })
+    assert(image.destroy)
   end
 
   def test_delete_image_without_fetching
-    fake "products/632910392/images/850703190", :method => :delete, :body => "destroyed"
+    fake("products/632910392/images/850703190", method: :delete, body: "destroyed")
     image = ShopifyAPI::Image.new(product_id: 632910392, id: 850703190)
-    assert image.destroy
+    assert(image.destroy)
   end
 end

data/test/inventory_level_test.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+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? do |item|
+        params[:location_ids].include?(item.location_id) &&
+        params[:inventory_item_ids].include?(item.inventory_item_id)
+      end,
+      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/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

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class LimitsTest < Test::Unit::TestCase
   def setup
     super
-    @header_hash = {'http_x_shopify_shop_api_call_limit' => '100/300'}
+    @header_hash = { 'X-Shopify-Shop-Api-Call-Limit' => '100/300' }
     ShopifyAPI::Base.connection.expects(:response).at_least(0).returns(@header_hash)
   end
 
@@ -22,7 +23,7 @@ class LimitsTest < Test::Unit::TestCase
 
     should "flag maxed out credits" do
       assert !ShopifyAPI.maxed?
-      @header_hash = {'http_x_shopify_shop_api_call_limit' => '299/300'}
+      @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
@@ -30,7 +31,7 @@ class LimitsTest < Test::Unit::TestCase
     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
+      assert_raises(ShopifyAPI::Limits::LimitUnavailable) do
         ShopifyAPI.credit_left
       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

@@ -1,56 +1,56 @@
+# 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')
+    fake("marketing_events", method: :get, body: load_fixture('marketing_events'))
     marketing_events = ShopifyAPI::MarketingEvent.all
-    assert_equal 2, marketing_events.size
+    assert_equal(2, marketing_events.size)
   end
 
   def test_get_marketing_event
-    fake "marketing_events/1", :method => :get, :body => load_fixture('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
+    assert_equal(1, marketing_event.id)
   end
 
   def test_create_marketing_event
-    fake "marketing_events", :method => :post, :body => load_fixture('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
+    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"
+    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
+    assert(marketing_event.destroy)
   end
 
   def test_update_marketing_event
-    fake 'marketing_events/1', :method => :get, :status => 200, :body => load_fixture('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
+    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.get(:count)
-    assert_equal 2, marketing_events_count
+    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')
+    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')
+    fake("marketing_events/1/engagements", method: :post, status: 201, body: load_fixture('engagement'))
     engagement = {
       occurred_on: "2017-04-20",
       impressions_count: nil,
@@ -60,9 +60,9 @@ class MarketingEventTest < Test::Unit::TestCase
       favorites_count: nil,
       comments_count: nil,
       ad_spend: nil,
-      is_cumulative: true
+      is_cumulative: true,
     }
     marketing_event.add_engagements(engagement)
-    assert "2017-04-20", engagement[:occurred_on]
+    assert("2017-04-20", engagement[:occurred_on])
   end
 end