shopify_api 4.13.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef057d0e70073f7c63a076b7f878c1c3afd062d0
-  data.tar.gz: 477cf304d0a68dc7e68cfac7e39c9af5617611c5
+  metadata.gz: 55a5fb52fc6aa176717a301e7a52d015b54a7128
+  data.tar.gz: 7318df185fd7cfe2272a3b5078900beea9831eb4
 SHA512:
-  metadata.gz: c24fa3742f763e0f798a4e2d0eccd37ff2db06ba21e08e09d5853584550398db112354f39b9fd6edc55af2cc8e438f5d04b8e3ade7e704c81e2eda2a8236338f
-  data.tar.gz: 9886ecfff88b5b9e7dac1e1e1948fbe3ea3a0c69cbc9f13f601c413dead928bdfc68678f81d06ad74f277631f8048628252f390a37717bf17d9c1b6c4c3e016b
+  metadata.gz: 8b0eeef0481961159424da00239ac3f9bfbc4709ccc169f592bdd4a385c15ea27a1efe2cd083737c5a36a13d2be8a6687cd5b44b4ad0d69903a1cbcf34440414
+  data.tar.gz: 2b0c63f6db528a3c721c2ddf9e30ed5e79976e8570c0ec7a9f03bfde173c90230e5af3979b16f7a49a001ab9ce90ad4d68920d03e291487340215506c9d70653

data/CHANGELOG

@@ -1,3 +1,10 @@
+== Version 5.0.0
+
+* Added `ShopifyAPI::AbandonedCheckout`
+* Added support for X-Shopify-Checkout-Version header on `ShopifyAPI::Checkout`
+* Added `ShopifyAPI::ShippingRate`
+* Added support for Checkout::complete endpoint
+
 == Version 4.12.0
 
 * Added support for the GraphQL API

data/README.md

@@ -10,6 +10,13 @@ The Shopify API gem allows Ruby developers to programmatically access the admin
 
 The API is implemented as JSON over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation. In other words, we’ve tried to make the API follow the REST principles as much as possible.
 
+## ⚠️ Breaking change notice for version 5.0.0 ⚠️
+The [Abandoned Checkout API](https://help.shopify.com/en/api/reference/orders/abandoned_checkouts) is now accessed through the `ShopifyAPI::AbandonedCheckout` resource. If you were previously accessing the Abandoned Checkout API through the `ShopifyAPI::Checkout` resource, you will need to update your code after upgrading from version 4.x.x or earlier.
+
+Going forward, the `ShopifyAPI::Checkout` resource is used to access the [Checkout API](https://help.shopify.com/en/api/reference/sales_channels/checkout), which can be used to create new checkouts.
+
+For more details, [please see this issue](https://github.com/Shopify/shopify_api/issues/471).
+
 ## Usage
 
 ### Requirements
@@ -262,9 +269,8 @@ bundle exec rake test
 
 ## Additional Resources
 
-API Reference: https://help.shopify.com/api/reference
-
-Ask questions on the forums: http://ecommerce.shopify.com/c/shopify-apis-and-technology
+* [API Reference](https://help.shopify.com/api/reference)
+* [Ask questions on the forums](http://ecommerce.shopify.com/c/shopify-apis-and-technology)
 
 ## Copyright
 

data/lib/shopify_api/resources/abandoned_checkout.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class AbandonedCheckout < Base
+    self.element_name = "checkout"
+  end
+end

data/lib/shopify_api/resources/checkout.rb

@@ -1,4 +1,27 @@
+# frozen_string_literal: true
+
 module ShopifyAPI
   class Checkout < Base
+    self.primary_key = :token
+    headers['X-Shopify-Checkout-Version'] = '2016-09-06'
+
+    def complete
+      post(:complete)
+    end
+
+    def ready?
+      return false unless persisted?
+
+      reload
+      [200, 201].include?(ShopifyAPI::Base.connection.response.code.to_i)
+    end
+
+    def payments
+      Payment.find(:all, params: { checkout_id: id })
+    end
+
+    def shipping_rates
+      ShippingRate.find(:all, params: { checkout_id: id })
+    end
   end
-end
+end

data/lib/shopify_api/resources/payment.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class Payment < Base
+    self.prefix = '/admin/checkouts/:checkout_id/'
+  end
+end

data/lib/shopify_api/resources/shipping_rate.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class ShippingRate < Base
+    self.prefix = '/admin/checkouts/:checkout_id/'
+  end
+end

data/lib/shopify_api/session.rb

@@ -51,7 +51,7 @@ module ShopifyAPI
       end
 
       def validate_signature(params)
-        params = params.with_indifferent_access
+        params = (params.respond_to?(:to_unsafe_hash) ? params.to_unsafe_hash : params).with_indifferent_access
         return false unless signature = params[:hmac]
 
         calculated_signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA256.new(), secret, encoded_params_for_signature(params))

data/lib/shopify_api/version.rb

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

data/test/abandoned_checkouts_test.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class AbandonedCheckoutsTest < Test::Unit::TestCase
+  def setup
+    super
+
+    @expected_checkouts = JSON.parse(load_fixture('abandoned_checkouts'))['checkouts']
+    @expected_checkout_id = JSON.parse(load_fixture('abandoned_checkout'))['checkout']['id']
+  end
+
+  test ":create creates a checkout" do
+    fake 'checkouts', method: :post, status: 201, body: load_fixture('abandoned_checkout')
+
+    checkout = ShopifyAPI::AbandonedCheckout.create
+
+    assert_equal @expected_checkout_id, checkout.id
+    assert_equal true, checkout.attributes.include?(:abandoned_checkout_url)
+  end
+
+  test "get all checkouts indexed by token" do
+    fake 'checkouts', method: :get, status: 200, body: load_fixture('abandoned_checkouts')
+
+    checkouts = ShopifyAPI::AbandonedCheckout.all
+
+    assert_equal @expected_checkout_id, checkouts.first.id
+    assert_equal @expected_checkouts.size, checkouts.size
+  end
+end

data/test/checkouts_test.rb

@@ -1,9 +1,72 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class CheckoutsTest < Test::Unit::TestCase
-  test "get all should get all orders" do
-    fake 'checkouts', :method => :get, :status => 200, :body => load_fixture('checkouts')
-    checkout = ShopifyAPI::Checkout.all
-    assert_equal 450789469, checkout.first.id
+  def setup
+    super
+
+    @expected_checkouts = JSON.parse(load_fixture('checkouts'))['checkouts']
+    @expected_checkout_id = JSON.parse(load_fixture('checkout'))['checkout']['token']
+  end
+
+  test ":create creates a checkout" do
+    fake 'checkouts', method: :post, status: 201, body: load_fixture('checkout')
+
+    checkout = ShopifyAPI::Checkout.create
+
+    assert_equal @expected_checkout_id, checkout.id
+  end
+
+  test "get all checkouts indexed by token" do
+    fake 'checkouts', method: :get, status: 200, body: load_fixture('checkouts')
+
+    checkouts = ShopifyAPI::Checkout.all
+
+    assert_equal @expected_checkout_id, checkouts.first.id
+    assert_equal @expected_checkouts.size, checkouts.size
+  end
+
+  test ":complete completes a checkout" do
+    fake "checkouts/#{@expected_checkout_id}", method: :get, status: 200, body: load_fixture('checkout')
+
+    checkout = ShopifyAPI::Checkout.find(@expected_checkout_id)
+
+    fake "checkouts/#{@expected_checkout_id}/complete", method: :post, status: 200, body: load_fixture('checkouts')
+
+    checkout.complete
+  end
+
+  test ":ready? returns true when status is 201" do
+    fake "checkouts/#{@expected_checkout_id}", method: :get, status: 201, body: load_fixture('checkout')
+    checkout = ShopifyAPI::Checkout.find(@expected_checkout_id)
+
+    assert_predicate checkout, :ready?
+  end
+
+  test ":ready? returns false when status is 202" do
+    fake "checkouts/#{@expected_checkout_id}", method: :get, status: 202, body: load_fixture('checkout')
+    checkout = ShopifyAPI::Checkout.find(@expected_checkout_id)
+
+    refute_predicate checkout, :ready?
+  end
+
+  test ":payments returns payments for a checkout" do
+    fake "checkouts/#{@expected_checkout_id}", method: :get, status: 200, body: load_fixture('checkout')
+    checkout = ShopifyAPI::Checkout.find(@expected_checkout_id)
+
+    fake "checkouts/#{@expected_checkout_id}/payments", method: :get, status: 202, body: load_fixture('payments')
+
+    assert_equal 10.00, checkout.payments.first.amount
+  end
+
+  test ":shipping_rates returns shipping rates for a checkout" do
+    fake "checkouts/#{@expected_checkout_id}", method: :get, status: 200, body: load_fixture('checkout')
+    checkout = ShopifyAPI::Checkout.find(@expected_checkout_id)
+
+    fake("checkouts/#{@expected_checkout_id}/shipping_rates",
+      method: :get,
+      status: 202,
+      body: load_fixture('shipping_rates'))
+    assert_equal "canada_post-INT.TP.BOGUS-4.00", checkout.shipping_rates.first.id
   end
 end

data/test/detailed_log_subscriber_test.rb

@@ -8,6 +8,7 @@ class LogSubscriberTest < Test::Unit::TestCase
     super
     @page = { :page => { :id => 1, :title => 'Shopify API' } }.to_json
     @ua_header = "\"User-Agent\"=>\"ShopifyAPI/#{ShopifyAPI::VERSION} ActiveResource/#{ActiveResource::VERSION::STRING} Ruby/#{RUBY_VERSION}\""
+    @ver_header = "\"X-Shopify-Checkout-Version\"=>\"2016-09-06\""
 
     ShopifyAPI::Base.clear_session
     ShopifyAPI::Base.site = "https://this-is-my-test-shop.myshopify.com/admin"
@@ -28,7 +29,7 @@ class LogSubscriberTest < Test::Unit::TestCase
     assert_equal 4, @logger.logged(:info).size
     assert_equal "GET https://this-is-my-test-shop.myshopify.com:443/admin/pages/1.json", @logger.logged(:info)[0]
     assert_match /\-\-\> 200/, @logger.logged(:info)[1]
-    assert_equal "Headers: {\"Accept\"=>\"application/json\", #{@ua_header}}", @logger.logged(:info)[2]
+    assert_equal "Headers: {\"Accept\"=>\"application/json\", #{@ua_header}, #{@ver_header}}", @logger.logged(:info)[2]
     assert_match /Response:\n\{\"page\"\:\{((\"id\"\:1)|(\"title\"\:\"Shopify API\")),((\"id\"\:1)|(\"title\"\:\"Shopify API\"))\}\}/,  @logger.logged(:info)[3]
 
   end
@@ -43,7 +44,7 @@ class LogSubscriberTest < Test::Unit::TestCase
     assert_equal 4, @logger.logged(:info).size
     assert_equal "GET https://this-is-my-test-shop.myshopify.com:443/admin/pages/2.json", @logger.logged(:info)[0]
     assert_match /\-\-\> 404/, @logger.logged(:info)[1]
-    assert_equal "Headers: {\"Accept\"=>\"application/json\", #{@ua_header}}", @logger.logged(:info)[2]
+    assert_equal "Headers: {\"Accept\"=>\"application/json\", #{@ua_header}, #{@ver_header}}", @logger.logged(:info)[2]
     assert_equal "Response:", @logger.logged(:info)[3]
   end
 end

data/test/fixtures/abandoned_checkout.json

@@ -0,0 +1,184 @@
+{
+  "checkout": {
+    "buyer_accepts_marketing": false,
+    "cart_token": "68778783ad298f1c80c3bafcddeea02f",
+    "closed_at": null,
+    "completed_at": null,
+    "created_at": "2012-10-12T07:05:27-04:00",
+    "currency": "USD",
+    "email": "bob.norman@hostmail.com",
+    "gateway": null,
+    "id": 450789469,
+    "landing_site": null,
+    "note": null,
+    "referring_site": null,
+    "shipping_lines": [
+      {
+        "title": "Free Shipping",
+        "price": "0.00",
+        "code": "Free Shipping",
+        "source": "shopify"
+      }
+    ],
+    "source": null,
+    "source_identifier": null,
+    "source_name": "web",
+    "source_url": null,
+    "subtotal_price": "398.00",
+    "taxes_included": false,
+    "token": "2a1ace52255252df566af0faaedfbfa7",
+    "total_discounts": "0.00",
+    "total_line_items_price": "398.00",
+    "total_price": "409.94",
+    "total_tax": "11.94",
+    "total_weight": 400,
+    "updated_at": "2012-10-12T07:05:27-04:00",
+    "line_items": [
+      {
+        "applied_discounts": [
+
+        ],
+        "compare_at_price": null,
+        "fulfillment_service": "manual",
+        "gift_card": false,
+        "grams": 200,
+        "id": 49148385,
+        "line_price": "199.00",
+        "price": "199.00",
+        "product_id": 632910392,
+        "properties": null,
+        "quantity": 1,
+        "requires_shipping": true,
+        "sku": "IPOD2008RED",
+        "tax_lines": [
+
+        ],
+        "taxable": true,
+        "title": "IPod Nano - 8GB",
+        "variant_id": 49148385,
+        "variant_title": "Red",
+        "vendor": "Apple"
+      },
+      {
+        "applied_discounts": [
+
+        ],
+        "compare_at_price": null,
+        "fulfillment_service": "manual",
+        "gift_card": false,
+        "grams": 200,
+        "id": 808950810,
+        "line_price": "199.00",
+        "price": "199.00",
+        "product_id": 632910392,
+        "properties": null,
+        "quantity": 1,
+        "requires_shipping": true,
+        "sku": "IPOD2008PINK",
+        "tax_lines": [
+
+        ],
+        "taxable": true,
+        "title": "IPod Nano - 8GB",
+        "variant_id": 808950810,
+        "variant_title": "Pink",
+        "vendor": "Apple"
+      }
+    ],
+    "name": "#450789469",
+    "note_attributes": [
+      {
+        "name": "custom engraving",
+        "value": "Happy Birthday"
+      },
+      {
+        "name": "colour",
+        "value": "green"
+      }
+    ],
+    "discount_codes": [
+      {
+        "code": "TENOFF",
+        "amount": "10.00"
+      }
+    ],
+    "abandoned_checkout_url": "https://checkout.local/orders/690933842/2a1ace52255252df566af0faaedfbfa7?recovered=1",
+    "tax_lines": [
+      {
+        "price": "11.94",
+        "rate": 0.06,
+        "title": "State Tax"
+      }
+    ],
+    "billing_address": {
+      "address1": "Chestnut Street 92",
+      "address2": "",
+      "city": "Louisville",
+      "company": null,
+      "country": "United States",
+      "first_name": "Bob",
+      "last_name": "Norman",
+      "latitude": "45.41634",
+      "longitude": "-75.6868",
+      "phone": "555-625-1199",
+      "province": "Kentucky",
+      "zip": "40202",
+      "name": "Bob Norman",
+      "country_code": "US",
+      "province_code": "KY"
+    },
+    "shipping_address": {
+      "address1": "Chestnut Street 92",
+      "address2": "",
+      "city": "Louisville",
+      "company": null,
+      "country": "United States",
+      "first_name": "Bob",
+      "last_name": "Norman",
+      "latitude": "45.41634",
+      "longitude": "-75.6868",
+      "phone": "555-625-1199",
+      "province": "Kentucky",
+      "zip": "40202",
+      "name": "Bob Norman",
+      "country_code": "US",
+      "province_code": "KY"
+    },
+    "customer": {
+      "accepts_marketing": false,
+      "created_at": "2014-03-07T16:12:37-05:00",
+      "email": "bob.norman@hostmail.com",
+      "first_name": "Bob",
+      "id": 207119551,
+      "last_name": "Norman",
+      "last_order_id": null,
+      "multipass_identifier": null,
+      "note": null,
+      "orders_count": 0,
+      "state": "disabled",
+      "total_spent": "0.00",
+      "updated_at": "2014-03-07T16:12:37-05:00",
+      "verified_email": true,
+      "tags": "",
+      "last_order_name": null,
+      "default_address": {
+        "address1": "Chestnut Street 92",
+        "address2": "",
+        "city": "Louisville",
+        "company": null,
+        "country": "United States",
+        "first_name": null,
+        "id": 207119551,
+        "last_name": null,
+        "phone": "555-625-1199",
+        "province": "Kentucky",
+        "zip": "40202",
+        "name": null,
+        "province_code": "KY",
+        "country_code": "US",
+        "country_name": "United States",
+        "default": true
+      }
+    }
+  }
+}

data/test/fixtures/abandoned_checkouts.json

@@ -0,0 +1,186 @@
+{
+  "checkouts": [
+    {
+      "buyer_accepts_marketing": false,
+      "cart_token": "68778783ad298f1c80c3bafcddeea02f",
+      "closed_at": null,
+      "completed_at": null,
+      "created_at": "2012-10-12T07:05:27-04:00",
+      "currency": "USD",
+      "email": "bob.norman@hostmail.com",
+      "gateway": null,
+      "id": 450789469,
+      "landing_site": null,
+      "note": null,
+      "referring_site": null,
+      "shipping_lines": [
+        {
+          "title": "Free Shipping",
+          "price": "0.00",
+          "code": "Free Shipping",
+          "source": "shopify"
+        }
+      ],
+      "source": null,
+      "source_identifier": null,
+      "source_name": "web",
+      "source_url": null,
+      "subtotal_price": "398.00",
+      "taxes_included": false,
+      "token": "2a1ace52255252df566af0faaedfbfa7",
+      "total_discounts": "0.00",
+      "total_line_items_price": "398.00",
+      "total_price": "409.94",
+      "total_tax": "11.94",
+      "total_weight": 400,
+      "updated_at": "2012-10-12T07:05:27-04:00",
+      "line_items": [
+        {
+          "applied_discounts": [
+
+          ],
+          "compare_at_price": null,
+          "fulfillment_service": "manual",
+          "gift_card": false,
+          "grams": 200,
+          "id": 49148385,
+          "line_price": "199.00",
+          "price": "199.00",
+          "product_id": 632910392,
+          "properties": null,
+          "quantity": 1,
+          "requires_shipping": true,
+          "sku": "IPOD2008RED",
+          "tax_lines": [
+
+          ],
+          "taxable": true,
+          "title": "IPod Nano - 8GB",
+          "variant_id": 49148385,
+          "variant_title": "Red",
+          "vendor": "Apple"
+        },
+        {
+          "applied_discounts": [
+
+          ],
+          "compare_at_price": null,
+          "fulfillment_service": "manual",
+          "gift_card": false,
+          "grams": 200,
+          "id": 808950810,
+          "line_price": "199.00",
+          "price": "199.00",
+          "product_id": 632910392,
+          "properties": null,
+          "quantity": 1,
+          "requires_shipping": true,
+          "sku": "IPOD2008PINK",
+          "tax_lines": [
+
+          ],
+          "taxable": true,
+          "title": "IPod Nano - 8GB",
+          "variant_id": 808950810,
+          "variant_title": "Pink",
+          "vendor": "Apple"
+        }
+      ],
+      "name": "#450789469",
+      "note_attributes": [
+        {
+          "name": "custom engraving",
+          "value": "Happy Birthday"
+        },
+        {
+          "name": "colour",
+          "value": "green"
+        }
+      ],
+      "discount_codes": [
+        {
+          "code": "TENOFF",
+          "amount": "10.00"
+        }
+      ],
+      "abandoned_checkout_url": "https://checkout.local/orders/690933842/2a1ace52255252df566af0faaedfbfa7?recovered=1",
+      "tax_lines": [
+        {
+          "price": "11.94",
+          "rate": 0.06,
+          "title": "State Tax"
+        }
+      ],
+      "billing_address": {
+        "address1": "Chestnut Street 92",
+        "address2": "",
+        "city": "Louisville",
+        "company": null,
+        "country": "United States",
+        "first_name": "Bob",
+        "last_name": "Norman",
+        "latitude": "45.41634",
+        "longitude": "-75.6868",
+        "phone": "555-625-1199",
+        "province": "Kentucky",
+        "zip": "40202",
+        "name": "Bob Norman",
+        "country_code": "US",
+        "province_code": "KY"
+      },
+      "shipping_address": {
+        "address1": "Chestnut Street 92",
+        "address2": "",
+        "city": "Louisville",
+        "company": null,
+        "country": "United States",
+        "first_name": "Bob",
+        "last_name": "Norman",
+        "latitude": "45.41634",
+        "longitude": "-75.6868",
+        "phone": "555-625-1199",
+        "province": "Kentucky",
+        "zip": "40202",
+        "name": "Bob Norman",
+        "country_code": "US",
+        "province_code": "KY"
+      },
+      "customer": {
+        "accepts_marketing": false,
+        "created_at": "2014-03-07T16:12:37-05:00",
+        "email": "bob.norman@hostmail.com",
+        "first_name": "Bob",
+        "id": 207119551,
+        "last_name": "Norman",
+        "last_order_id": null,
+        "multipass_identifier": null,
+        "note": null,
+        "orders_count": 0,
+        "state": "disabled",
+        "total_spent": "0.00",
+        "updated_at": "2014-03-07T16:12:37-05:00",
+        "verified_email": true,
+        "tags": "",
+        "last_order_name": null,
+        "default_address": {
+          "address1": "Chestnut Street 92",
+          "address2": "",
+          "city": "Louisville",
+          "company": null,
+          "country": "United States",
+          "first_name": null,
+          "id": 207119551,
+          "last_name": null,
+          "phone": "555-625-1199",
+          "province": "Kentucky",
+          "zip": "40202",
+          "name": null,
+          "province_code": "KY",
+          "country_code": "US",
+          "country_name": "United States",
+          "default": true
+        }
+      }
+    }
+  ]
+}

data/test/fixtures/checkout.json

@@ -0,0 +1,160 @@
+{
+  "checkout": {
+    "applied_discount": "0.00",
+    "clone_url": "",
+    "completed_at": null,
+    "created_at": "2012-10-12T07:05:27-04:00",
+    "credit_card": null,
+    "currency": "USD",
+    "presentment_currency": "USD",
+    "email": "bob.norman@hostmail.com",
+    "note": null,
+    "shipping_line": [
+      {
+        "title": "Free Shipping",
+        "price": "0.00",
+        "code": "Free Shipping",
+        "source": "shopify"
+      }
+    ],
+    "shipping_rates": [
+      {
+        "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"
+      }
+    ],
+    "source_identifier": null,
+    "source_name": "web",
+    "source_url": null,
+    "subtotal_price": "398.00",
+    "shipping_policy_url": null,
+    "taxes_included": false,
+    "token": "2a1ace52255252df566af0faaedfbfa7",
+    "total_line_items_price": "398.00",
+    "total_price": "409.94",
+    "total_tax": "11.94",
+    "updated_at": "2012-10-12T07:05:27-04:00",
+    "line_items": [
+      {
+        "applied_discounts": [
+
+        ],
+        "compare_at_price": null,
+        "fulfillment_service": "manual",
+        "gift_card": false,
+        "grams": 200,
+        "id": 49148385,
+        "line_price": "199.00",
+        "price": "199.00",
+        "product_id": 632910392,
+        "properties": null,
+        "quantity": 1,
+        "requires_shipping": true,
+        "sku": "IPOD2008RED",
+        "tax_lines": [
+
+        ],
+        "taxable": true,
+        "title": "IPod Nano - 8GB",
+        "variant_id": 49148385,
+        "variant_title": "Red",
+        "vendor": "Apple"
+      },
+      {
+        "applied_discounts": [
+
+        ],
+        "compare_at_price": null,
+        "fulfillment_service": "manual",
+        "gift_card": false,
+        "grams": 200,
+        "id": 808950810,
+        "line_price": "199.00",
+        "price": "199.00",
+        "product_id": 632910392,
+        "properties": null,
+        "quantity": 1,
+        "requires_shipping": true,
+        "sku": "IPOD2008PINK",
+        "tax_lines": [
+
+        ],
+        "taxable": true,
+        "title": "IPod Nano - 8GB",
+        "variant_id": 808950810,
+        "variant_title": "Pink",
+        "vendor": "Apple"
+      }
+    ],
+    "name": "#450789469",
+    "note_attributes": [
+      {
+        "name": "custom engraving",
+        "value": "Happy Birthday"
+      },
+      {
+        "name": "colour",
+        "value": "green"
+      }
+    ],
+    "discount_code": [
+      {
+        "code": "TENOFF",
+        "amount": "10.00"
+      }
+    ],
+    "tax_lines": [
+      {
+        "price": "11.94",
+        "rate": 0.06,
+        "title": "State Tax"
+      }
+    ],
+    "billing_address": {
+      "address1": "Chestnut Street 92",
+      "address2": "",
+      "city": "Louisville",
+      "company": null,
+      "country": "United States",
+      "first_name": "Bob",
+      "last_name": "Norman",
+      "latitude": "45.41634",
+      "longitude": "-75.6868",
+      "phone": "555-625-1199",
+      "province": "Kentucky",
+      "zip": "40202",
+      "name": "Bob Norman",
+      "country_code": "US",
+      "province_code": "KY"
+    },
+    "shipping_address": {
+      "address1": "Chestnut Street 92",
+      "address2": "",
+      "city": "Louisville",
+      "company": null,
+      "country": "United States",
+      "first_name": "Bob",
+      "last_name": "Norman",
+      "latitude": "45.41634",
+      "longitude": "-75.6868",
+      "phone": "555-625-1199",
+      "province": "Kentucky",
+      "zip": "40202",
+      "name": "Bob Norman",
+      "country_code": "US",
+      "province_code": "KY"
+    },
+    "customer_id": null,
+    "customer_locale": "en-CA",
+    "device_id": "12",
+    "order": null,
+    "order_id": null,
+    "order_status_url": ""
+  }
+}

data/test/fixtures/checkouts.json

@@ -1,19 +1,16 @@
 {
   "checkouts": [
     {
-      "buyer_accepts_marketing": false,
-      "cart_token": "68778783ad298f1c80c3bafcddeea02f",
-      "closed_at": null,
+      "applied_discount": "0.00",
+      "clone_url": "",
       "completed_at": null,
       "created_at": "2012-10-12T07:05:27-04:00",
+      "credit_card": null,
       "currency": "USD",
+      "presentment_currency": "USD",
       "email": "bob.norman@hostmail.com",
-      "gateway": null,
-      "id": 450789469,
-      "landing_site": null,
       "note": null,
-      "referring_site": null,
-      "shipping_lines": [
+      "shipping_line": [
         {
           "title": "Free Shipping",
           "price": "0.00",
@@ -21,18 +18,28 @@
           "source": "shopify"
         }
       ],
-      "source": null,
+      "shipping_rates": [
+        {
+          "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"
+        }
+      ],
       "source_identifier": null,
       "source_name": "web",
       "source_url": null,
       "subtotal_price": "398.00",
+      "shipping_policy_url": null,
       "taxes_included": false,
       "token": "2a1ace52255252df566af0faaedfbfa7",
-      "total_discounts": "0.00",
       "total_line_items_price": "398.00",
       "total_price": "409.94",
       "total_tax": "11.94",
-      "total_weight": 400,
       "updated_at": "2012-10-12T07:05:27-04:00",
       "line_items": [
         {
@@ -97,13 +104,12 @@
           "value": "green"
         }
       ],
-      "discount_codes": [
+      "discount_code": [
         {
           "code": "TENOFF",
           "amount": "10.00"
         }
       ],
-      "abandoned_checkout_url": "https://checkout.local/orders/690933842/2a1ace52255252df566af0faaedfbfa7?recovered=1",
       "tax_lines": [
         {
           "price": "11.94",
@@ -145,42 +151,12 @@
         "country_code": "US",
         "province_code": "KY"
       },
-      "customer": {
-        "accepts_marketing": false,
-        "created_at": "2014-03-07T16:12:37-05:00",
-        "email": "bob.norman@hostmail.com",
-        "first_name": "Bob",
-        "id": 207119551,
-        "last_name": "Norman",
-        "last_order_id": null,
-        "multipass_identifier": null,
-        "note": null,
-        "orders_count": 0,
-        "state": "disabled",
-        "total_spent": "0.00",
-        "updated_at": "2014-03-07T16:12:37-05:00",
-        "verified_email": true,
-        "tags": "",
-        "last_order_name": null,
-        "default_address": {
-          "address1": "Chestnut Street 92",
-          "address2": "",
-          "city": "Louisville",
-          "company": null,
-          "country": "United States",
-          "first_name": null,
-          "id": 207119551,
-          "last_name": null,
-          "phone": "555-625-1199",
-          "province": "Kentucky",
-          "zip": "40202",
-          "name": null,
-          "province_code": "KY",
-          "country_code": "US",
-          "country_name": "United States",
-          "default": true
-        }
-      }
+      "customer_id": null,
+      "customer_locale": "en-CA",
+      "device_id": "12",
+      "order": null,
+      "order_id": null,
+      "order_status_url": ""
     }
   ]
 }

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

@@ -214,33 +214,33 @@ class SessionTest < Test::Unit::TestCase
   end
 
   test "return true when the signature is valid and the keys of params are strings" do
-    params = {"code" => "any-code", "timestamp" => Time.now}
-    params["hmac"] = generate_signature(params)
+    params = { 'code' => 'any-code', 'timestamp' => Time.now }
+    params[:hmac] = generate_signature(params)
     assert_equal true, ShopifyAPI::Session.validate_signature(params)
   end
 
   test "return true when validating signature of params with ampersand and equal sign characters" do
     ShopifyAPI::Session.secret = 'secret'
-    params = {'a' => '1&b=2', 'c=3&d' => '4'}
-    to_sign = "a=1%26b=2&c%3D3%26d=4"
-    params['hmac'] = generate_signature(to_sign)
-
+    params = { 'a' => '1&b=2', 'c=3&d' => '4' }
+    to_sign = 'a=1%26b=2&c%3D3%26d=4'
+    params[:hmac] = generate_signature(to_sign)
     assert_equal true, ShopifyAPI::Session.validate_signature(params)
   end
 
   test "return true when validating signature of params with percent sign characters" do
     ShopifyAPI::Session.secret = 'secret'
-    params = {'a%3D1%26b' => '2%26c%3D3'}
-    to_sign = "a%253D1%2526b=2%2526c%253D3"
-    params['hmac'] = generate_signature(to_sign)
-
+    params = { 'a%3D1%26b' => '2%26c%3D3' }
+    to_sign = 'a%253D1%2526b=2%2526c%253D3'
+    params[:hmac] = generate_signature(to_sign)
     assert_equal true, ShopifyAPI::Session.validate_signature(params)
   end
 
   private
 
   def make_sorted_params(params)
-    sorted_params = params.with_indifferent_access.except(:signature, :hmac, :action, :controller).collect{|k,v|"#{k}=#{v}"}.sort.join('&')
+    params.with_indifferent_access.except(
+      :signature, :hmac, :action, :controller
+    ).collect { |k, v| "#{k}=#{v}" }.sort.join('&')
   end
 
   def generate_signature(params)

data/test/shipping_rate_test.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class ShippingRateTest < Test::Unit::TestCase
+  test ":get lists all shipping rates for a given checkout" do
+    fake 'checkouts', method: :get, status: 200, body: load_fixture('checkouts')
+    checkouts = ShopifyAPI::Checkout.all
+
+    fake "checkouts/#{checkouts.first.id}/shipping_rates",
+      method: :get, status: 200, body: load_fixture('checkouts')
+    shipping_rates = ShopifyAPI::ShippingRate.find(:all, params: { checkout_id: checkouts.first.id })
+
+    assert_equal 2, shipping_rates.first.shipping_rates.length
+    assert_equal 'canada_post-INT.TP.BOGUS-4.00', shipping_rates.first.shipping_rates.first.id
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 4.13.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -166,6 +166,7 @@ files:
 - lib/shopify_api/limits.rb
 - lib/shopify_api/metafields.rb
 - lib/shopify_api/resources.rb
+- lib/shopify_api/resources/abandoned_checkout.rb
 - lib/shopify_api/resources/access_scope.rb
 - lib/shopify_api/resources/access_token.rb
 - lib/shopify_api/resources/address.rb
@@ -213,6 +214,7 @@ files:
 - lib/shopify_api/resources/order.rb
 - lib/shopify_api/resources/order_risk.rb
 - lib/shopify_api/resources/page.rb
+- lib/shopify_api/resources/payment.rb
 - lib/shopify_api/resources/payment_details.rb
 - lib/shopify_api/resources/ping.rb
 - lib/shopify_api/resources/ping/conversation.rb
@@ -232,6 +234,7 @@ files:
 - lib/shopify_api/resources/script_tag.rb
 - lib/shopify_api/resources/shipping_address.rb
 - lib/shopify_api/resources/shipping_line.rb
+- lib/shopify_api/resources/shipping_rate.rb
 - lib/shopify_api/resources/shipping_zone.rb
 - lib/shopify_api/resources/shop.rb
 - lib/shopify_api/resources/smart_collection.rb
@@ -248,6 +251,7 @@ files:
 - lib/shopify_api/version.rb
 - shipit.rubygems.yml
 - shopify_api.gemspec
+- test/abandoned_checkouts_test.rb
 - test/access_token_test.rb
 - test/active_resource/json_errors_test.rb
 - test/api_permission_test.rb
@@ -269,6 +273,8 @@ files:
 - test/detailed_log_subscriber_test.rb
 - test/discount_code_test.rb
 - test/draft_order_test.rb
+- test/fixtures/abandoned_checkout.json
+- test/fixtures/abandoned_checkouts.json
 - test/fixtures/access_token_delegate.json
 - test/fixtures/application_charge.json
 - test/fixtures/application_charges.json
@@ -283,6 +289,7 @@ files:
 - test/fixtures/blogs.json
 - test/fixtures/carrier_service.json
 - test/fixtures/carts.json
+- test/fixtures/checkout.json
 - test/fixtures/checkouts.json
 - test/fixtures/collect.json
 - test/fixtures/collection_listing.json
@@ -323,6 +330,8 @@ files:
 - test/fixtures/order_risks.json
 - test/fixtures/order_with_properties.json
 - test/fixtures/orders.json
+- test/fixtures/payment.json
+- test/fixtures/payments.json
 - test/fixtures/ping/conversation.json
 - test/fixtures/ping/message.json
 - test/fixtures/policies.json
@@ -341,6 +350,7 @@ files:
 - test/fixtures/reports.json
 - test/fixtures/script_tag.json
 - test/fixtures/script_tags.json
+- test/fixtures/shipping_rates.json
 - test/fixtures/shipping_zones.json
 - test/fixtures/shop.json
 - test/fixtures/smart_collection.json
@@ -371,6 +381,7 @@ files:
 - test/o_auth_test.rb
 - test/order_risk_test.rb
 - test/order_test.rb
+- test/payment_test.rb
 - test/ping/conversation_test.rb
 - test/policy_test.rb
 - test/price_rule_test.rb
@@ -383,6 +394,7 @@ files:
 - test/resource_feedback_test.rb
 - test/script_tag_test.rb
 - test/session_test.rb
+- test/shipping_rate_test.rb
 - test/shipping_zone_test.rb
 - test/shop_test.rb
 - test/smart_collection_test.rb