ruby_shopify_api 1.0.0

data/test/discount_code_test.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class DiscountCodeTest < Test::Unit::TestCase
+  def setup
+    super
+    fake('price_rules/102586120/discount_codes/1002091923', body: load_fixture('discount_code'))
+
+    @discount_code = ShopifyAPI::DiscountCode.find(1002091923, params: { price_rule_id: 102586120 })
+  end
+
+  def test_get_discount_code
+    fake('price_rules/102586120/discount_codes', method: :get, status: 200, body: load_fixture('discount_code'))
+    discount_code = ShopifyAPI::DiscountCode.find(1002091923, params: { price_rule_id: 102586120 })
+
+    assert_equal(1002091923, discount_code.id)
+  end
+
+  def test_get_all_discount_codes
+    fake('price_rules/102586120/discount_codes', method: :get, status: 200, body: load_fixture('discount_codes'))
+    discount_codes = ShopifyAPI::DiscountCode.all(params: { price_rule_id: 102586120 })
+
+    assert_equal(1, discount_codes.length)
+    assert_equal(1002091923, discount_codes.first.id)
+  end
+
+  def test_create_discount_code
+    fake('price_rules/102586120/discount_codes', method: :post, status: 201, body: load_fixture('discount_code'))
+    discount_code = ShopifyAPI::DiscountCode.new
+    discount_code.prefix_options[:price_rule_id] = 102586120
+    discount_code.code = "SUMMERSALE10"
+    discount_code.save
+
+    assert_equal('{"discount_code":{"code":"SUMMERSALE10"}}', WebMock.last_request.body)
+  end
+
+  def test_update_discount_code
+    discount_code_response = ActiveSupport::JSON.decode(load_fixture('discount_code'))
+    discount_code_response['discount_code']['code'] = "WINTERSALE50"
+    @discount_code.code = "WINTERSALE50"
+
+    fake(
+      'price_rules/102586120/discount_codes/1002091923',
+      method: :put,
+      status: 200,
+      body: ActiveSupport::JSON.encode(discount_code_response)
+    )
+
+    @discount_code.save
+
+    assert_equal(discount_code_response['discount_code']['code'], @discount_code.code)
+  end
+
+  def test_delete_discount_code
+    fake('price_rules/102586120/discount_codes/1002091923', method: :delete, body: 'destroyed')
+
+    assert(@discount_code.destroy)
+  end
+end

data/test/draft_order_test.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class DraftOrderTest < Test::Unit::TestCase
+  def setup
+    super
+
+    fake('draft_orders/517119332', body: load_fixture('draft_order'))
+
+    @draft_order = ShopifyAPI::DraftOrder.find(517119332)
+  end
+
+  def test_get_draft_order
+    fake('draft_orders/517119332', method: :get, status: 200, body: load_fixture('draft_order'))
+
+    draft_order = ShopifyAPI::DraftOrder.find(517119332)
+
+    assert_equal(517119332, draft_order.id)
+  end
+
+  def test_get_all_draft_orders
+    fake('draft_orders', method: :get, status: 200, body: load_fixture('draft_orders'))
+
+    draft_orders = ShopifyAPI::DraftOrder.all
+
+    assert_equal(1, draft_orders.length)
+    assert_equal(517119332, draft_orders.first.id)
+  end
+
+  def test_get_count_draft_orders
+    fake('draft_orders/count', method: :get, status: 200, body: '{"count": 16}')
+
+    draft_orders_count = ShopifyAPI::DraftOrder.count
+
+    assert_equal(16, draft_orders_count)
+  end
+
+  def test_create_draft_order
+    fake('draft_orders', method: :post, status: 201, body: load_fixture('draft_order'))
+
+    draft_order = ShopifyAPI::DraftOrder.create(line_items: [{ quantity: 1, variant_id: 39072856 }])
+
+    assert_equal('{"draft_order":{"line_items":[{"quantity":1,"variant_id":39072856}]}}', WebMock.last_request.body)
+    assert_equal(39072856, draft_order.line_items.first.variant_id)
+  end
+
+  def test_create_draft_order_202
+    fake('draft_orders', method: :post, status: 202, body: load_fixture('draft_order'))
+
+    draft_order = ShopifyAPI::DraftOrder.create(line_items: [{ quantity: 1, variant_id: 39072856 }])
+
+    assert_equal(39072856, draft_order.line_items.first.variant_id)
+  end
+
+  def test_update_draft_order
+    draft_order_response = ActiveSupport::JSON.decode(load_fixture('draft_order'))
+    draft_order_response['draft_order']['note'] = 'Test new note'
+    @draft_order.note = 'Test new note'
+    fake('draft_orders/517119332', method: :put, status: 200, body: ActiveSupport::JSON.encode(draft_order_response))
+
+    @draft_order.save
+
+    assert_equal(draft_order_response['draft_order']['note'], @draft_order.note)
+  end
+
+  def test_send_invoice_with_no_params
+    draft_order_invoice_fixture = load_fixture('draft_order_invoice')
+    draft_order_invoice = ActiveSupport::JSON.decode(draft_order_invoice_fixture)
+    fake('draft_orders/517119332/send_invoice', method: :post, body: draft_order_invoice_fixture)
+
+    draft_order_invoice_response = @draft_order.send_invoice
+
+    assert_equal('{"draft_order_invoice":{}}', WebMock.last_request.body)
+    assert_kind_of(ShopifyAPI::DraftOrderInvoice, draft_order_invoice_response)
+    assert_equal(draft_order_invoice['draft_order_invoice']['to'], draft_order_invoice_response.to)
+  end
+
+  def test_send_invoice_with_params
+    draft_order_invoice_fixture = load_fixture('draft_order_invoice')
+    draft_order_invoice = ActiveSupport::JSON.decode(draft_order_invoice_fixture)
+    fake('draft_orders/517119332/send_invoice', method: :post, body: draft_order_invoice_fixture)
+
+    draft_order_invoice_response = @draft_order.send_invoice(
+      ShopifyAPI::DraftOrderInvoice.new(draft_order_invoice['draft_order_invoice'])
+    )
+
+    assert_equal(draft_order_invoice, ActiveSupport::JSON.decode(WebMock.last_request.body))
+    assert_kind_of(ShopifyAPI::DraftOrderInvoice, draft_order_invoice_response)
+    assert_equal(draft_order_invoice['draft_order_invoice']['to'], draft_order_invoice_response.to)
+  end
+
+  def test_delete_draft_order
+    fake('draft_orders/517119332', method: :delete, body: 'destroyed')
+    assert(@draft_order.destroy)
+  end
+
+  def test_add_metafields_to_draft_order
+    fake('draft_orders/517119332/metafields', method: :post, status: 201, body: load_fixture('metafield'))
+
+    field = @draft_order.add_metafield(
+      ShopifyAPI::Metafield.new(namespace: 'contact', key: 'email', value: '123@example.com', value_type: 'string')
+    )
+
+    assert_equal(
+      ActiveSupport::JSON.decode(
+        '{"metafield":{"namespace":"contact","key":"email","value":"123@example.com","value_type":"string"}}'
+      ),
+      ActiveSupport::JSON.decode(WebMock.last_request.body)
+    )
+    assert(!field.new_record?)
+    assert_equal('contact', field.namespace)
+    assert_equal('email', field.key)
+    assert_equal('123@example.com', field.value)
+  end
+
+  def test_get_all_metafields_for_draft_order
+    fake('draft_orders/517119332/metafields', body: load_fixture('metafields'))
+
+    metafields = @draft_order.metafields
+
+    assert_equal(3, metafields.length)
+    assert(metafields.all? { |m| m.is_a?(ShopifyAPI::Metafield) })
+  end
+
+  def test_get_2_metafields_for_draft_order
+    body = ActiveSupport::JSON.decode(load_fixture('metafields'))
+    body['metafields'].slice!(2, 1)
+
+    fake('draft_orders/517119332/metafields.json?limit=2', body: body.to_json, extension: false)
+
+    metafields = @draft_order.metafields(limit: 2)
+
+    assert_equal(2, metafields.length)
+    assert(metafields.all? { |m| m.is_a?(ShopifyAPI::Metafield) })
+  end
+
+  def test_complete_draft_order_with_no_params
+    completed_fixture = load_fixture('draft_order_completed')
+    completed_draft = ActiveSupport::JSON.decode(completed_fixture)['draft_order']
+    fake('draft_orders/517119332/complete', method: :put, status: 200, body: completed_fixture)
+
+    @draft_order.complete
+
+    assert_equal(completed_draft['status'], @draft_order.status)
+    assert_equal(completed_draft['order_id'], @draft_order.order_id)
+    refute_nil(@draft_order.completed_at)
+  end
+
+  def test_complete_draft_order_with_params
+    completed_fixture = load_fixture('draft_order_completed')
+    completed_draft = ActiveSupport::JSON.decode(completed_fixture)['draft_order']
+    complete_params = { payment_pending: true }
+    fake(
+      'draft_orders/517119332/complete.json?payment_pending=true',
+      extension: false,
+      method: :put,
+      status: 200,
+      body: completed_fixture
+    )
+
+    @draft_order.complete(complete_params)
+
+    assert_equal(completed_draft['status'], @draft_order.status)
+    assert_equal(completed_draft['order_id'], @draft_order.order_id)
+    refute_nil(@draft_order.completed_at)
+  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/access_scopes.json

@@ -0,0 +1,10 @@
+{
+  "access_scopes": [
+    {
+      "handle": "write_product_listings"
+    },
+    {
+      "handle": "read_shipping"
+    }
+  ]
+}

data/test/fixtures/access_token_delegate.json

@@ -0,0 +1,4 @@
+{
+  "access_token": "abracadabra",
+  "scope": "write_orders,read_products"
+}

data/test/fixtures/api_versions.json

@@ -0,0 +1,38 @@
+[
+  {
+    "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
+  }
+]

data/test/fixtures/apis.json

@@ -0,0 +1,42 @@
+{
+  "apis": [{
+      "handle": "admin",
+      "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
+        }
+      ]
+    }
+  ]
+}