shopify_api 4.8.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcb1fe2d6a1c1b42c80381495c978e6b2fb0e911
-  data.tar.gz: 5c9f07855c85365f9784c06a53f11e0c6b706805
+  metadata.gz: fff80db1065be0d32a1762d81992769fc9cde8b6
+  data.tar.gz: 2a00b35496dcffdb72d0788c5b4bd18b90bee947
 SHA512:
-  metadata.gz: 7526001ec0f3edea9b9d43f7ec213e066d9c8fe305d0dceae1dec74122fee38f32cc3faf3a3f70f2a486d8983c2381e4a7df0e805e86832e3228092933e0e06a
-  data.tar.gz: 2ac04850be172a6a06ef670a16720324c2e8d572cfc9d4d140f9b0372c0a2509c6794a55fe68d6ebc36fda463d9d026def2f188384eb9f01d2b0ef8ee305142c
+  metadata.gz: 4d53f0ae3e229f88800e277b83c4434228b1118f39627794b62868b37a4236deb626c295ee01557e10867b7070dd227a0fc1d1429201ecff203aabb2cb80ae24
+  data.tar.gz: 259547ebef03ae4f739ea2e7489ce0f01b8d03726037d8648c69321d8f640847872ee7b8ca27ed6c0c27ff7e4f529a04fdf35947a7b7a927a06aa05d9be5fa37

data/CHANGELOG

@@ -1,3 +1,8 @@
+== Version 4.9.0
+
+* Added `ShopifyAPI::PriceRule`
+* Added `ShopifyAPI::DiscountCode`
+
 == Version 4.8.0
 
 * Added `add_engagements` to `ShopifyAPI::MarketingEvent`

data/README.md

@@ -59,7 +59,7 @@ ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveR
 2. For a private App you just need to set the base site url as follows:
 
    ```ruby
-   shop_url = "https://#{API_KEY}:#{PASSWORD}@SHOP_NAME.myshopify.com/admin"
+   shop_url = "https://#{API_KEY}:#{PASSWORD}@#{SHOP_NAME}.myshopify.com/admin"
    ShopifyAPI::Base.site = shop_url
    ```
 
@@ -246,7 +246,7 @@ rake install
 
 ## Additional Resources
 
-API Docs: http://docs.shopify.com/api
+API Docs: https://help.shopify.com/api/reference
 
 Ask questions on the forums: http://ecommerce.shopify.com/c/shopify-apis-and-technology
 

data/lib/shopify_api/resources/discount_code.rb

@@ -0,0 +1,9 @@
+module ShopifyAPI
+  class DiscountCode < Base
+    init_prefix :price_rule
+
+    def price_rule_id
+      @prefix_options[:price_rule_id]
+    end
+  end
+end

data/lib/shopify_api/resources/price_rule.rb

@@ -0,0 +1,8 @@
+module ShopifyAPI
+  class PriceRule < Base
+
+    def discount_codes
+      DiscountCode.find(:all, params: { price_rule_id: id })
+    end
+  end
+end

data/lib/shopify_api/version.rb

@@ -1,3 +1,3 @@
 module ShopifyAPI
-  VERSION = "4.8.0"
+  VERSION = "4.9.0"
 end

data/test/discount_code_test.rb

@@ -0,0 +1,53 @@
+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"}}', FakeWeb.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/fixtures/discount_code.json

@@ -0,0 +1,10 @@
+{
+  "discount_code": {
+    "id": 1002091923,
+    "price_rule_id": 102586120,
+    "code": "SUMMERSALE10",
+    "usage_count": 5,
+    "created_at": "2017-03-09T19:22:49Z",
+    "updated_at": "2017-03-09T19:22:49Z"
+  }
+}

data/test/fixtures/discount_codes.json

@@ -0,0 +1,12 @@
+{
+  "discount_codes": [
+    {
+      "id": 1002091923,
+      "price_rule_id": 102586120,
+      "code": "SUMMERSALE10",
+      "usage_count": 5,
+      "created_at": "2017-03-09T19:22:49Z",
+      "updated_at": "2017-03-09T19:22:49Z"
+    }
+  ]
+}

data/test/fixtures/price_rule.json

@@ -0,0 +1,27 @@
+{
+  "price_rule": {
+    "id": 102586120,
+    "target_type": "line_item",
+    "target_selection": "entitled",
+    "allocation_method": "across",
+    "value_type": "fixed_amount",
+    "value": -10.0,
+    "customer_selection": "all",
+    "once_per_customer": false,
+    "usage_limit": 10,
+    "created_at": "2016-09-11T09:00:00-04:00",
+    "updated_at": "2016-09-11T09:30:00-04:00",
+    "starts_at": "2016-09-12T0:00:00-04:00",
+    "ends_at": "2016-09-12T00:00:00-04:00",
+    "entitled_product_ids": [22,278,293],
+    "entitled_variant_ids": [],
+    "entitled_collection_ids": [],
+    "entitled_country_ids": [],
+    "prerequisite_subtotal_range": {
+      "greater_than_or_equal_to": 10
+    },
+    "prerequisite_shipping_price_range": {},
+    "prerequisite_saved_search_ids": [34,88],
+    "title": "Summer Sale Event 2017"
+  }
+}

data/test/fixtures/price_rules.json

@@ -0,0 +1,28 @@
+{
+  "price_rules": [
+    {
+      "id": 102586120,
+      "target_type": "line_items",
+      "target_selection": "entitled",
+      "allocation_method": "each",
+      "value_type": "fixed_amount",
+      "value": -10,
+      "once_per_customer": false,
+      "usage_limit": 10,
+      "created_at": "2016-09-11T09:00:00-04:00",
+      "updated_at": "2016-09-11T09:30:00-04:00",
+      "starts_at": "2016-09-12T0:00:00-04:00",
+      "ends_at": "2016-09-12T00:00:00-04:00",
+      "entitled_product_ids": [22,278,293],
+      "entitled_variant_ids": [],
+      "entitled_collection_ids": [],
+      "entitled_country_ids": [],
+      "prerequisite_subtotal_range": {
+        "greater_than_or_equal_to": 10
+      },
+      "prerequisite_shipping_price_range": {},
+      "prerequisite_saved_search_ids": [34,88],
+      "title": "Summer Sale Event 2017"
+    }
+  ]
+}

data/test/price_rule_test.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+class PriceRuleTest < Test::Unit::TestCase
+  def setup
+    super
+    fake 'price_rules/102586120', body: load_fixture('price_rule')
+
+    @price_rule = ShopifyAPI::PriceRule.find(102586120)
+  end
+
+  def test_get_price_rule
+    fake 'price_rules/102586120', method: :get, status: 200, body: load_fixture('price_rule')
+    price_rule = ShopifyAPI::PriceRule.find(102586120)
+
+    assert_equal 102586120, price_rule.id
+  end
+
+  def test_get_all_price_rules
+    fake 'price_rules', method: :get, status: 200, body: load_fixture('price_rules')
+    price_rules = ShopifyAPI::PriceRule.all
+
+    assert_equal 1, price_rules.length
+    assert_equal 102586120, price_rules.first.id
+  end
+
+  def test_get_all_discount_codes_for_a_price_rule
+    fake 'price_rules/102586120/discount_codes', method: :get, status: 200, body: load_fixture('discount_codes')
+    price_rule = ShopifyAPI::PriceRule.find(102586120)
+
+    assert_equal "SUMMERSALE10", price_rule.discount_codes.first.code
+  end
+
+  def test_create_price_rule
+    fake 'price_rules', method: :post, status: 201, body: load_fixture('price_rule')
+
+    price_rule = ShopifyAPI::PriceRule.create(
+      target_type: "line_item",
+      allocation_method: "across",
+      value_type: "fixed_amount",
+      value: -10.0,
+      customer_selection: "all",
+      starts_at: "2017-01-19T00:00:00Z"
+    )
+
+    assert_equal '{"price_rule":{"target_type":"line_item","allocation_method":"across","value_type":"fixed_amount","value":-10.0,"customer_selection":"all","starts_at":"2017-01-19T00:00:00Z"}}', FakeWeb.last_request.body
+    assert_equal -10, price_rule.value
+  end
+
+  def test_update_price_rule
+    price_rule_response = ActiveSupport::JSON.decode(load_fixture('price_rule'))
+    price_rule_response['price_rule']['value'] = -50.0
+    @price_rule.value = -50.0
+    fake 'price_rules/102586120', method: :put, status: 200, body: ActiveSupport::JSON.encode(price_rule_response)
+
+    @price_rule.save
+
+    assert_equal price_rule_response['price_rule']['value'], @price_rule.value
+  end
+
+  def test_delete_price_rule
+    fake 'price_rules/102586120', method: :delete, body: 'destroyed'
+
+    assert @price_rule.destroy
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_api
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2017-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -174,6 +174,7 @@ files:
 - lib/shopify_api/resources/customer_invite_message.rb
 - lib/shopify_api/resources/customer_saved_search.rb
 - lib/shopify_api/resources/discount.rb
+- lib/shopify_api/resources/discount_code.rb
 - lib/shopify_api/resources/draft_order.rb
 - lib/shopify_api/resources/draft_order_invoice.rb
 - lib/shopify_api/resources/event.rb
@@ -195,6 +196,7 @@ files:
 - lib/shopify_api/resources/page.rb
 - lib/shopify_api/resources/payment_details.rb
 - lib/shopify_api/resources/policy.rb
+- lib/shopify_api/resources/price_rule.rb
 - lib/shopify_api/resources/product.rb
 - lib/shopify_api/resources/product_listing.rb
 - lib/shopify_api/resources/province.rb
@@ -242,6 +244,7 @@ files:
 - test/customer_saved_search_test.rb
 - test/customer_test.rb
 - test/detailed_log_subscriber_test.rb
+- test/discount_code_test.rb
 - test/discount_test.rb
 - test/draft_order_test.rb
 - test/fixtures/access_token_delegate.json
@@ -271,6 +274,8 @@ files:
 - test/fixtures/customers_account_activation_url.json
 - test/fixtures/customers_search.json
 - test/fixtures/discount.json
+- test/fixtures/discount_code.json
+- test/fixtures/discount_codes.json
 - test/fixtures/discount_disabled.json
 - test/fixtures/discounts.json
 - test/fixtures/draft_order.json
@@ -297,6 +302,8 @@ files:
 - test/fixtures/order_risks.json
 - test/fixtures/orders.json
 - test/fixtures/policies.json
+- test/fixtures/price_rule.json
+- test/fixtures/price_rules.json
 - test/fixtures/product.json
 - test/fixtures/product_listing.json
 - test/fixtures/product_listing_product_ids.json
@@ -339,6 +346,7 @@ files:
 - test/order_risk_test.rb
 - test/order_test.rb
 - test/policy_test.rb
+- test/price_rule_test.rb
 - test/product_listing_test.rb
 - test/product_test.rb
 - test/recurring_application_charge_test.rb