shopify_api 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 971668a584dc96aa673c1648c5c8da796e64adfd63a30515da9376b460efbd2a
-  data.tar.gz: d161f78b00baaf4def4c4effc51a802143b483af08281afc043b93e0e8eba940
+  metadata.gz: c6b6467bc9d4c7e3180f0385a0b7c6f75921b391659e7d0566796fb34f5fe63d
+  data.tar.gz: 6bcd7084be9a692d3e960c5659b4ed4e25abd629e6f91f58faa9934f55f720a1
 SHA512:
-  metadata.gz: ca615cd5b6ea53fccc3cd75a0ff4f994ceb6c086034232f36c64a1e2d11abe948faa12cf4b63603e2d9d98f2714038199950b2baa0561dde343b042f551b49e0
-  data.tar.gz: 9043ff8baf6e9f22f536c0ca68d85ba96d542648aea47da73a35909c86949036be7b310de82fa266a689786af7b9ca15c975677f048b70e64fb1399197161b80
+  metadata.gz: 4ab61dddb0c4fe44d89c9bced7e328c8e76932c9876803d2aeef6ea0a7c9eace8eaa728841f9445a2c59e53b555d8c16c40b4ed881b8630069f2e8343c2f3971
+  data.tar.gz: 5808669808de2b254c33d2a0d4f120f9b47a4868bb992575824f2a9348ecd74a1c54231b3ed821e694de1c2ed63ae6653c5138b6e86874d88c2a10fcee080965

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+== Version 8.1.0
+
+* Release 2020-01 REST ADMIN API VERSION [#656](https://github.com/Shopify/shopify_api/pull/656)
+* Release new Endpoint `collection.products` and `collection.find()` in 2020-01 REST API version [#657](https://github.com/Shopify/shopify_api/pull/657)
+* Enrich 4xx errors with error message from response body [#647](https://github.com/Shopify/shopify_api/pull/647)
+* Make relative cursor based pagination work across page loads [#625](https://github.com/Shopify/shopify_api/pull/625)
+* Small ruby compat fix [#623](https://github.com/Shopify/shopify_api/pull/623)
+* Small consistency change [#621](https://github.com/Shopify/shopify_api/pull/621)
+
 == Version 8.0.0
 
 * Api Version changes [#600](https://github.com/Shopify/shopify_api/pull/600)

data/lib/active_resource/detailed_log_subscriber.rb

@@ -27,9 +27,9 @@ module ActiveResource
       payload[:response].each do |header_name, header_value|
         case header_name.downcase
         when 'x-shopify-api-deprecated-reason'
-          warning_message = <<~MSG
-            [DEPRECATED] ShopifyAPI made a call to #{payload[:method].upcase} #{payload[:path]}, and this call made
-            use of a deprecated endpoint, behaviour, or parameter. See #{header_value} for more details.
+          warning_message = <<-MSG
+          [DEPRECATED] ShopifyAPI made a call to #{payload[:method].upcase} #{payload[:path]}, and this call made
+          use of a deprecated endpoint, behaviour, or parameter. See #{header_value} for more details.
           MSG
 
           warn warning_message

data/lib/shopify_api.rb

@@ -20,6 +20,7 @@ require 'shopify_api/metafields'
 require 'shopify_api/countable'
 require 'shopify_api/resources'
 require 'shopify_api/session'
+require 'shopify_api/message_enricher'
 require 'shopify_api/connection'
 require 'shopify_api/pagination_link_headers'
 

data/lib/shopify_api/connection.rb

@@ -4,7 +4,7 @@ module ShopifyAPI
 
     module ResponseCapture
       def handle_response(response)
-        @response = super
+        @response = super(ShopifyAPI::MessageEnricher.new(response))
       end
     end
 

data/lib/shopify_api/message_enricher.rb

@@ -0,0 +1,17 @@
+module ShopifyAPI
+  class MessageEnricher < SimpleDelegator
+    def message
+      return super unless (400...500).include?(code.to_i)
+
+      @_cached_message ||= begin
+        detailed_error = begin
+          JSON.parse(body)['error'].to_s
+        rescue JSON::ParserError
+          nil
+        end
+
+        detailed_error.present? ? "#{super} (#{detailed_error})" : super
+      end
+    end
+  end
+end

data/lib/shopify_api/paginated_collection.rb

@@ -27,6 +27,14 @@ module ShopifyAPI
         fetch_page(@previous_url)
       end
 
+      def next_page_info
+        extract_page_info(@next_url)
+      end
+
+      def previous_page_info
+        extract_page_info(@previous_url)
+      end
+
       private
 
       AVAILABLE_IN_VERSION = ShopifyAPI::ApiVersion.find_version('2019-10')
@@ -50,6 +58,10 @@ module ShopifyAPI
         return if ShopifyAPI::Base.api_version >= AVAILABLE_IN_VERSION_EARLY && resource_class.early_july_pagination?
         raise NotImplementedError
       end
+
+      def extract_page_info(url)
+        CGI.escape(Rack::Utils.parse_query(URI(url).query)['page_info']) if url.present?
+      end
     end
 
     include CollectionPagination

data/lib/shopify_api/resources/collection.rb

@@ -6,7 +6,7 @@ module ShopifyAPI
     include Metafields
 
     def products(options = {})
-      available_in_version = ShopifyAPI::ApiVersion.find_version(:unstable)
+      available_in_version = ShopifyAPI::ApiVersion.find_version('2020-01')
       raise NotImplementedError unless ShopifyAPI::Base.api_version >= available_in_version
       Product.find(:all, from: "#{self.class.prefix}collections/#{id}/products.json", params: options)
     end

data/lib/shopify_api/session.rb

@@ -104,7 +104,7 @@ module ShopifyAPI
         raise ShopifyAPI::ValidationException, "Invalid Signature: Possible malicious login"
       end
 
-      response = access_token_request(params['code'])
+      response = access_token_request(params[:code])
       if response.code == "200"
         self.extra = JSON.parse(response.body)
         self.token = extra.delete('access_token')

data/lib/shopify_api/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "8.0.0"
+  VERSION = "8.1.0"
 end

data/test/api_version_test.rb

@@ -22,15 +22,15 @@ class ApiVersionTest < Test::Unit::TestCase
   test "find_version removes unverified versions from version set if mode is set to :raise_on_unknown" do
     ShopifyAPI::ApiVersion.version_lookup_mode = :define_on_unknown
     assert ShopifyAPI::ApiVersion.versions.values.all?(&:verified?)
-    assert_equal 5, ShopifyAPI::ApiVersion.versions.size
+    assert_equal 6, ShopifyAPI::ApiVersion.versions.size
 
     ShopifyAPI::ApiVersion.find_version('2019-30')
     refute ShopifyAPI::ApiVersion.versions.values.all?(&:verified?)
-    assert_equal 6, ShopifyAPI::ApiVersion.versions.size
+    assert_equal 7, ShopifyAPI::ApiVersion.versions.size
     ShopifyAPI::ApiVersion.version_lookup_mode = :raise_on_unknown
 
     assert ShopifyAPI::ApiVersion.versions.values.all?(&:verified?)
-    assert_equal 5, ShopifyAPI::ApiVersion.versions.size
+    assert_equal 6, ShopifyAPI::ApiVersion.versions.size
   end
 
   test "find_version does not raise when coercing a string if no versions are defined when version_lookup_mode is :define_on_unknown" do
@@ -101,8 +101,9 @@ class ApiVersionTest < Test::Unit::TestCase
       {
         "2019-01" => ShopifyAPI::ApiVersion.new(handle: '2019-01', supported: true, latest_supported: false),
         "2019-04" => ShopifyAPI::ApiVersion.new(handle: '2019-04', supported: true, latest_supported: false),
-        "2019-07" => ShopifyAPI::ApiVersion.new(handle: '2019-07', supported: true, latest_supported: true),
+        "2019-07" => ShopifyAPI::ApiVersion.new(handle: '2019-07', supported: true, latest_supported: false),
         "2019-10" => ShopifyAPI::ApiVersion.new(handle: '2019-10', supported: false, latest_supported: false),
+        "2020-01" => ShopifyAPI::ApiVersion.new(handle: '2020-01', supported: false, latest_supported: true),
         "unstable" => ShopifyAPI::ApiVersion.new(handle: 'unstable', supported: false, latest_supported: false),
       }
     )
@@ -114,7 +115,7 @@ class ApiVersionTest < Test::Unit::TestCase
       )
 
       assert_equal(
-        ShopifyAPI::ApiVersion.new(handle: '2019-07'),
+        ShopifyAPI::ApiVersion.new(handle: '2020-01'),
         ShopifyAPI::ApiVersion.latest_stable_version
       )
     end

data/test/collection_test.rb

@@ -1,13 +1,13 @@
 require 'test_helper'
 
 class CollectionTest < Test::Unit::TestCase
-  test "Collection get products gets all products in a collection on unstable version" do
-    unstable_version = ShopifyAPI::Session.new(domain: 'shop2.myshopify.com', token: 'token2', api_version: :unstable)
-    ShopifyAPI::Base.activate_session(unstable_version)
+  test "Collection get products gets all products in a collection on 2020-01 version" do
+    available_version = ShopifyAPI::Session.new(domain: 'shop2.myshopify.com', token: 'token2', api_version: '2020-01')
+    ShopifyAPI::Base.activate_session(available_version)
 
     fake(
         'collections',
-        url: 'https://shop2.myshopify.com/admin/api/unstable/collections/1.json',
+        url: 'https://shop2.myshopify.com/admin/api/2020-01/collections/1.json',
         method: :get,
         status: 200,
         body: load_fixture('collection'),
@@ -18,7 +18,7 @@ class CollectionTest < Test::Unit::TestCase
 
     fake(
         'products',
-        url: 'https://shop2.myshopify.com/admin/api/unstable/collections/1/products.json',
+        url: 'https://shop2.myshopify.com/admin/api/2020-01/collections/1/products.json',
         method: :get,
         status: 200,
         body: load_fixture('collection_products'),
@@ -28,12 +28,12 @@ class CollectionTest < Test::Unit::TestCase
   end
 
   test "Collection get products fails on older api version" do
-    unstable_version = ShopifyAPI::Session.new(domain: 'shop2.myshopify.com', token: 'token2', api_version: '2019-07')
-    ShopifyAPI::Base.activate_session(unstable_version)
+    old_version = ShopifyAPI::Session.new(domain: 'shop2.myshopify.com', token: 'token2', api_version: '2019-10')
+    ShopifyAPI::Base.activate_session(old_version)
 
     fake(
         'collections',
-        url: 'https://shop2.myshopify.com/admin/api/2019-07/collections/1.json',
+        url: 'https://shop2.myshopify.com/admin/api/2019-10/collections/1.json',
         method: :get,
         status: 200,
         body: load_fixture('collection'),

data/test/fixtures/api_versions.json

@@ -7,26 +7,32 @@
   },
   {
     "handle": "2019-04",
+    "latest_supported": false,
     "display_name": "2019-04",
-    "supported": true,
-    "latest_supported": false
+    "supported": true
   },
   {
     "handle": "2019-07",
-    "display_name": "2019-07 (Latest)",
-    "supported": true,
-    "latest_supported": true
+    "latest_supported": false,
+    "display_name": "2019-07",
+    "supported": true
   },
   {
     "handle": "2019-10",
-    "display_name": "2019-10 (Release candidate)",
-    "supported": false,
-    "latest_supported": false
+    "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,
-    "latest_supported": false
+    "supported": false
   }
 ]

data/test/fixtures/apis.json

@@ -14,15 +14,21 @@
         },
         {
           "handle": "2019-07",
-          "latest_supported": true,
-          "display_name": "2019-07 (Latest)",
+          "latest_supported": false,
+          "display_name": "2019-07",
           "supported": true
         },
         {
           "handle": "2019-10",
           "latest_supported": false,
-          "display_name": "2019-10 (Release candidate)",
-          "supported": false
+          "display_name": "2019-10",
+          "supported": true
+        },
+        {
+          "handle": "2020-01",
+          "latest_supported": true,
+          "display_name": "2020-01 (Latest)",
+          "supported": true
         },
         {
           "handle": "unstable",

data/test/message_enricher_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+class MessageEnricherTest < Test::Unit::TestCase
+
+  def test_enriches_initial_message_when_body_is_passed
+    response = enriched_response(422, 'InitialMessage', { error: 'My Error' })
+
+    assert_equal 'InitialMessage (My Error)', 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

@@ -8,32 +8,38 @@ class ApiVersionTest < Test::Unit::TestCase
         "handle": "2019-01",
         "display_name": "2019-01",
         "supported": true,
-        "latest_supported": false,
+        "latest_supported": false
       },
       {
         "handle": "2019-04",
         "latest_supported": false,
         "display_name": "2019-04",
-        "supported": true,
+        "supported": true
       },
       {
         "handle": "2019-07",
-        "latest_supported": true,
-        "display_name": "2019-07 (Latest)",
-        "supported": true,
+        "latest_supported": false,
+        "display_name": "2019-07",
+        "supported": true
       },
       {
         "handle": "2019-10",
         "latest_supported": false,
-        "display_name": "2019-10 (Release candidate)",
-        "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,
-      },
+        "supported": false
+      }
     ].to_json
 
 

data/test/pagination_test.rb

@@ -97,6 +97,20 @@ class PaginationTest < Test::Unit::TestCase
     refute orders.next_page?
   end
 
+  test "#next_page_info returns next_page_info if next page is present" do
+    fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders'), :link => @next_link_header
+    orders = ShopifyAPI::Order.all
+
+    assert_equal @next_page_info, orders.next_page_info
+  end
+
+  test "#next_page_info returns nil if next page is not present" do
+    fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders'), :link => @previous_link_header
+    orders = ShopifyAPI::Order.all
+
+    assert_nil orders.next_page_info
+  end
+
   test "#previous_page? returns true if previous page is present" do
     fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders'), :link => @previous_link_header
     orders = ShopifyAPI::Order.all
@@ -111,6 +125,20 @@ class PaginationTest < Test::Unit::TestCase
     refute orders.previous_page?
   end
 
+  test "#previous_page_info returns previous_page_info if next page is present" do
+    fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders'), :link => @previous_link_header
+    orders = ShopifyAPI::Order.all
+
+    assert_equal @previous_page_info, orders.previous_page_info
+  end
+
+  test "#previous_page_info returns nil if next page is not present" do
+    fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders'), :link => @next_link_header
+    orders = ShopifyAPI::Order.all
+
+    assert_nil orders.previous_page_info
+  end
+
   test "pagination handles no link headers" do
     fake 'orders', :method => :get, :status => 200, api_version: @version, :body => load_fixture('orders')
     orders = ShopifyAPI::Order.all

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-05 00:00:00.000000000 Z
+date: 2019-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -213,6 +213,7 @@ files:
 - lib/shopify_api/disable_prefix_check.rb
 - lib/shopify_api/events.rb
 - lib/shopify_api/limits.rb
+- lib/shopify_api/message_enricher.rb
 - lib/shopify_api/meta.rb
 - lib/shopify_api/metafields.rb
 - lib/shopify_api/paginated_collection.rb
@@ -456,6 +457,7 @@ files:
 - test/limits_test.rb
 - test/location_test.rb
 - test/marketing_event_test.rb
+- test/message_enricher_test.rb
 - test/meta_test.rb
 - test/metafield_test.rb
 - test/order_risk_test.rb