shopify_api 4.9.0 → 5.0.0

data/lib/shopify_api/resources/order.rb

@@ -3,8 +3,13 @@ module ShopifyAPI
     include Events
     include Metafields
 
-    def close;  load_attributes_from_response(post(:close, {}, only_id)); end
-    def open;   load_attributes_from_response(post(:open, {}, only_id)); end
+    def close
+      load_attributes_from_response(post(:close, {}, only_id))
+    end
+
+    def open
+      load_attributes_from_response(post(:open, {}, only_id))
+    end
 
     def cancel(options = {})
       load_attributes_from_response(post(:cancel, {}, options.to_json))

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir.glob("#{File.dirname(__FILE__)}/ping/*").each { |file| require file }

data/lib/shopify_api/resources/ping/conversation.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  module Ping
+    class Conversation < Base
+      self.prefix = "/admin/api/ping-api/v1/"
+
+      def send_message(message_attrs)
+        message = ShopifyAPI::Ping::Message.new(
+          message_attrs.merge(conversation_id: id)
+        )
+
+        message.save
+        message
+      end
+    end
+  end
+end

data/lib/shopify_api/resources/ping/message.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  module Ping
+    class Message < Base
+      self.prefix = "/admin/api/ping-api/v1/conversations/:conversation_id/"
+    end
+  end
+end

data/lib/shopify_api/resources/product.rb

@@ -13,19 +13,19 @@ module ShopifyAPI
         format % prices.min
       end
     end
-    
+
     def collections
       CustomCollection.find(:all, :params => {:product_id => self.id})
     end
-    
+
     def smart_collections
       SmartCollection.find(:all, :params => {:product_id => self.id})
     end
-    
+
     def add_to_collection(collection)
       collection.add_product(self)
     end
-    
+
     def remove_from_collection(collection)
       collection.remove_product(self)
     end

data/lib/shopify_api/resources/shipping_line.rb

@@ -1,4 +1,4 @@
 module ShopifyAPI
   class ShippingLine < Base
-  end  
+  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/resources/shop.rb

@@ -1,5 +1,5 @@
 module ShopifyAPI
-  # Shop object. Use Shop.current to receive 
+  # Shop object. Use Shop.current to receive
   # the shop.
   class Shop < Base
     def self.current(options={})
@@ -11,13 +11,13 @@ module ShopifyAPI
     end
 
     def add_metafield(metafield)
-      raise ArgumentError, "You can only add metafields to resource that has been saved" if new?      
+      raise ArgumentError, "You can only add metafields to resource that has been saved" if new?
       metafield.save
       metafield
     end
-    
+
     def events
       Event.find(:all)
     end
-  end               
+  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.9.0"
+  VERSION = "5.0.0"
 end

data/shopify_api.gemspec

@@ -23,10 +23,11 @@ Gem::Specification.new do |s|
   s.summary = %q{ShopifyAPI is a lightweight gem for accessing the Shopify admin REST web services}
   s.license = "MIT"
 
-  s.required_ruby_version = ">= 2.0"
+  s.required_ruby_version = ">= 2.1"
 
   s.add_runtime_dependency("activeresource", ">= 3.0.0")
   s.add_runtime_dependency("rack")
+  s.add_runtime_dependency("graphql-client")
 
   s.add_development_dependency("mocha", ">= 0.9.8")
   s.add_development_dependency("fakeweb")

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class ApiPermissionTest < Test::Unit::TestCase
+  test "revoke access token" do
+    fake "api_permissions/current", method: :delete, status: 200, body: "{}"
+    assert ShopifyAPI::ApiPermission.destroy
+  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
+      }
+    }
+  }
+}