shopify_api 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55a5fb52fc6aa176717a301e7a52d015b54a7128
-  data.tar.gz: 7318df185fd7cfe2272a3b5078900beea9831eb4
+  metadata.gz: 613f6d8028571843ca524cae058a468ec0e496b6
+  data.tar.gz: b410fefaab43e2afe984aa7b50c019e15dea4a64
 SHA512:
-  metadata.gz: 8b0eeef0481961159424da00239ac3f9bfbc4709ccc169f592bdd4a385c15ea27a1efe2cd083737c5a36a13d2be8a6687cd5b44b4ad0d69903a1cbcf34440414
-  data.tar.gz: 2b0c63f6db528a3c721c2ddf9e30ed5e79976e8570c0ec7a9f03bfde173c90230e5af3979b16f7a49a001ab9ce90ad4d68920d03e291487340215506c9d70653
+  metadata.gz: 38de7545efafa728e251353506d6078a263af09a4b72504356394d5e35dcc08532ee5662c8edf132a2eacfe0d2c2ea213e9d4a97bbedf298d58d463cce1dbbee
+  data.tar.gz: 0c1e77dafdb01ec104f9345fab05be9c6c47e80357879f12709946fcb5d2872a9ae47109d3ac3daa48a8e80b9cace6f94f97f9a72e58af127aabded28dc2a2f1

data/.gitignore

@@ -6,5 +6,6 @@ doc
 pkg
 .ruby-version
 *.lock
+*.gem
 .idea
 .dev/

data/CHANGELOG

@@ -1,9 +1,24 @@
+== Version 5.1.0
+
+* Added `ShopifyAPI::Publications`
+* Added `ShopifyAPI::ProductPublications`
+* Added `ShopifyAPI::CollectionPublications`
+* Added support for new collection products endpoint from `ShopifyAPI::Collection#products`
+
 == Version 5.0.0
 
+* Breaking change: `ShopifyAPI::Checkout` now maps to the Checkout API, rather than the Abandoned Checkouts API
+  * See the README for more details
 * Added `ShopifyAPI::AbandonedCheckout`
 * Added support for X-Shopify-Checkout-Version header on `ShopifyAPI::Checkout`
 * Added `ShopifyAPI::ShippingRate`
-* Added support for Checkout::complete endpoint
+* Added `ShopifyAPI::Payment`
+* Added support for `Checkout::complete` endpoint
+* Fixed session handling support for Rails 5.2.1
+
+== Version 4.13.0
+* Added `ShopifyAPI::ApiPermission` resource for uninstalling an application
+* Added a deprecation warning to `ShopifyAPI::OAuth`
 
 == Version 4.12.0
 

data/lib/shopify_api/resources/collection_publication.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module ShopifyAPI
+  class CollectionPublication < Base
+    init_prefix :publication
+
+    def publication_id
+      @prefix_options[:publication_id]
+    end
+  end
+end

data/lib/shopify_api/resources/product_publication.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module ShopifyAPI
+  class ProductPublication < Base
+    init_prefix :publication
+
+    def publication_id
+      @prefix_options[:publication_id]
+    end
+  end
+end

data/lib/shopify_api/resources/publication.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module ShopifyAPI
+  class Publication < Base
+  end
+end

data/lib/shopify_api/resources/smart_collection.rb

@@ -3,8 +3,12 @@ module ShopifyAPI
     include Events
     include Metafields
 
-    def products
-      Product.find(:all, :params => {:collection_id => self.id})
+    def products(options = {})
+      if options.present?
+        Product.find(:all, from: "/admin/smart_collections/#{id}/products.json", params: options)
+      else
+        Product.find(:all, params: { collection_id: id })
+      end
     end
 
     def order(options={})

data/lib/shopify_api/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "5.0.0"
+  VERSION = "5.1.0"
 end

data/test/collection_publication_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class CollectionPublicationTest < Test::Unit::TestCase
+  def test_get_all_collection_publications
+    fake 'publications/55650051/collection_publications', body: load_fixture('collection_publications')
+    collection_publications = ShopifyAPI::CollectionPublication.find(:all, params: { publication_id: 55650051 })
+
+    assert_equal 96062799894, collection_publications.first.id
+    assert_equal 55650051, collection_publications.first.publication_id
+  end
+
+  def test_get_collection_publication
+    fake 'publications/55650051/collection_publications/647162527768', body: load_fixture('collection_publication')
+    collection_publication = ShopifyAPI::CollectionPublication.find(647162527768, params: { publication_id: 55650051 })
+
+    assert_equal 96062799894, collection_publication.id
+    assert_equal 55650051, collection_publication.publication_id
+  end
+
+  def test_create_collection_publication
+    fake 'publications/55650051/collection_publications', method: :post, body: load_fixture('collection_publication')
+    ShopifyAPI::CollectionPublication.create(
+      publication_id: 55650051,
+      published_at: "2018-01-29T14:06:08-05:00",
+      published: true,
+      collection_id: 8267093571
+    )
+
+    expected_body = {
+      collection_publication: {
+        published_at: "2018-01-29T14:06:08-05:00",
+        published: true,
+        collection_id: 8267093571,
+      },
+    }.to_json
+
+    assert_equal expected_body, FakeWeb.last_request.body
+  end
+end

data/test/fixtures/collection_publication.json

@@ -0,0 +1,11 @@
+{
+  "collection_publication": {
+    "id": 96062799894,
+    "publication_id": 55650051,
+    "published_at": "2018-09-05T17:22:31-04:00",
+    "published": true,
+    "created_at": "2018-09-05T17:22:31-04:00",
+    "updated_at": "2018-09-14T14:31:19-04:00",
+    "collection_id": 60941828118
+  }
+}

data/test/fixtures/collection_publications.json

@@ -0,0 +1,13 @@
+{
+  "collection_publications": [
+    {
+        "id": 96062799894,
+        "publication_id": 55650051,
+        "published_at": "2018-09-05T17:22:31-04:00",
+        "published": true,
+        "created_at": "2018-09-05T17:22:31-04:00",
+        "updated_at": "2018-09-14T14:31:19-04:00",
+        "collection_id": 60941828118
+    }
+  ]
+}

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/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/product_publication_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class ProductPublicationTest < Test::Unit::TestCase
+  def test_get_all_product_publications
+    fake 'publications/55650051/product_publications', body: load_fixture('product_publications')
+    product_publications = ShopifyAPI::ProductPublication.find(:all, params: { publication_id: 55650051 })
+
+    assert_equal 647162527768, product_publications.first.id
+    assert_equal 55650051, product_publications.first.publication_id
+  end
+
+  def test_get_product_publication
+    fake 'publications/55650051/product_publications/647162527768', body: load_fixture('product_publication')
+    product_publication = ShopifyAPI::ProductPublication.find(647162527768, params: { publication_id: 55650051 })
+
+    assert_equal 647162527768, product_publication.id
+    assert_equal 55650051, product_publication.publication_id
+  end
+
+  def test_create_product_publication
+    fake 'publications/55650051/product_publications', method: :post, body: load_fixture('product_publication')
+    ShopifyAPI::ProductPublication.create(
+      publication_id: 55650051,
+      published_at: "2018-01-29T14:06:08-05:00",
+      published: true,
+      product_id: 8267093571
+    )
+
+    expected_body = {
+      product_publication: {
+        published_at: "2018-01-29T14:06:08-05:00",
+        published: true,
+        product_id: 8267093571,
+      },
+    }.to_json
+
+    assert_equal expected_body, FakeWeb.last_request.body
+  end
+end

data/test/publication_test.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class PublicationTest < Test::Unit::TestCase
+  def test_find_all_publications
+    fake 'publications'
+    publications = ShopifyAPI::Publication.find(:all)
+
+    assert_equal 55650051, publications.first.id
+    assert_equal "Buy Button", publications.first.name
+  end
+end

data/test/smart_collection_test.rb

@@ -7,4 +7,29 @@ class SmartCollectionTest < Test::Unit::TestCase
     smart_collection = ShopifyAPI::SmartCollection.create(:title => "Macbooks", :rules => rules)
     assert_equal 1063001432, smart_collection.id
   end
+
+  test "Smart Collection get products gets all products in a smart collection" do
+    fake "smart_collections/1063001432", method: :get, status: 200, body: load_fixture('smart_collection')
+    smart_collection = ShopifyAPI::SmartCollection.find(1063001432)
+
+    fake "products.json?collection_id=1063001432",
+      method: :get,
+      status: 200,
+      body:
+      load_fixture('smart_collection_products'),
+      extension: false
+    assert_equal [632910392, 921728736], smart_collection.products.map(&:id)
+  end
+
+  test "Smart Collection get products with only_sorted=only_manual gets only manually sorted products" do
+    fake "smart_collections/1063001432", method: :get, status: 200, body: load_fixture('smart_collection')
+    smart_collection = ShopifyAPI::SmartCollection.find(1063001432)
+
+    fake "smart_collections/1063001432/products.json?only_sorted=only_manual",
+      method: :get,
+      status: 200,
+      body: load_fixture('smart_collection_products'),
+      extension: false
+    assert_equal [632910392, 921728736], smart_collection.products(only_sorted: "only_manual").map(&:id)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-01 00:00:00.000000000 Z
+date: 2018-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -184,6 +184,7 @@ files:
 - lib/shopify_api/resources/checkout.rb
 - lib/shopify_api/resources/collect.rb
 - lib/shopify_api/resources/collection_listing.rb
+- lib/shopify_api/resources/collection_publication.rb
 - lib/shopify_api/resources/comment.rb
 - lib/shopify_api/resources/country.rb
 - lib/shopify_api/resources/custom_collection.rb
@@ -223,7 +224,9 @@ files:
 - lib/shopify_api/resources/price_rule.rb
 - lib/shopify_api/resources/product.rb
 - lib/shopify_api/resources/product_listing.rb
+- lib/shopify_api/resources/product_publication.rb
 - lib/shopify_api/resources/province.rb
+- lib/shopify_api/resources/publication.rb
 - lib/shopify_api/resources/receipt.rb
 - lib/shopify_api/resources/recurring_application_charge.rb
 - lib/shopify_api/resources/redirect.rb
@@ -266,6 +269,7 @@ files:
 - test/checkouts_test.rb
 - test/collect_test.rb
 - test/collection_listing_test.rb
+- test/collection_publication_test.rb
 - test/countable_test.rb
 - test/custom_collection_test.rb
 - test/customer_saved_search_test.rb
@@ -295,6 +299,8 @@ files:
 - test/fixtures/collection_listing.json
 - test/fixtures/collection_listing_product_ids.json
 - test/fixtures/collection_listings.json
+- test/fixtures/collection_publication.json
+- test/fixtures/collection_publications.json
 - test/fixtures/custom_collection.json
 - test/fixtures/customer_invite.json
 - test/fixtures/customer_saved_search.json
@@ -341,6 +347,9 @@ files:
 - test/fixtures/product_listing.json
 - test/fixtures/product_listing_product_ids.json
 - test/fixtures/product_listings.json
+- test/fixtures/product_publication.json
+- test/fixtures/product_publications.json
+- test/fixtures/publications.json
 - test/fixtures/recurring_application_charge.json
 - test/fixtures/recurring_application_charge_adjustment.json
 - test/fixtures/recurring_application_charges.json
@@ -354,6 +363,7 @@ files:
 - test/fixtures/shipping_zones.json
 - test/fixtures/shop.json
 - test/fixtures/smart_collection.json
+- test/fixtures/smart_collection_products.json
 - test/fixtures/storefront_access_token.json
 - test/fixtures/storefront_access_tokens.json
 - test/fixtures/tags.json
@@ -386,7 +396,9 @@ files:
 - test/policy_test.rb
 - test/price_rule_test.rb
 - test/product_listing_test.rb
+- test/product_publication_test.rb
 - test/product_test.rb
+- test/publication_test.rb
 - test/recurring_application_charge_test.rb
 - test/redirect_test.rb
 - test/refund_test.rb