shopify_api 4.9.0 → 5.2.4

data/lib/shopify_api/resources/graphql.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'graphql/client'
+require 'graphql/client/http'
+
+module ShopifyAPI
+  # GraphQL API.
+  class GraphQL
+    def initialize
+      uri = Base.site.dup
+      uri.path = '/admin/api/graphql.json'
+      @http = ::GraphQL::Client::HTTP.new(uri.to_s) do
+        define_method(:headers) do |_context|
+          Base.headers
+        end
+      end
+      @schema = ::GraphQL::Client.load_schema(@http)
+      @client = ::GraphQL::Client.new(schema: @schema, execute: @http)
+    end
+
+    delegate :parse, :query, to: :@client
+  end
+end

data/lib/shopify_api/resources/image.rb

@@ -1,13 +1,13 @@
 module ShopifyAPI
   class Image < Base
     init_prefix :product
-    
+
     # generate a method for each possible image variant
     [:pico, :icon, :thumb, :small, :compact, :medium, :large, :grande, :original].each do |m|
       reg_exp_match = "/\\1_#{m}.\\2"
       define_method(m) { src.gsub(/\/(.*)\.(\w{2,4})/, reg_exp_match) }
     end
-    
+
     def attach_image(data, filename = nil)
       attributes['attachment'] = Base64.encode64(data)
       attributes['filename'] = filename unless filename.nil?

data/lib/shopify_api/resources/inventory_item.rb

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

data/lib/shopify_api/resources/inventory_level.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class InventoryLevel < Base
+
+    # The default path structure in ActiveResource for delete would result in:
+    # /admin/inventory_levels/#{ inventory_level.id }.json?#{ params }, but since
+    # InventroyLevels are a second class resource made up of a Where and a What
+    # (Location and InventoryItem), it does not have a resource ID. Here we
+    # redefine element_path to remove the id so HTTP DELETE requests go to
+    # /admin/inventory_levels.json?#{ params } instead.
+    #
+    def self.element_path(prefix_options = {}, query_options = nil)
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
+    end
+
+    def destroy
+      load_attributes_from_response(
+        self.class.delete('/', location_id: location_id, inventory_item_id: inventory_item_id)
+      )
+    end
+
+    def connect(relocate_if_necessary: nil)
+      body = { location_id: location_id, inventory_item_id: inventory_item_id }
+      body[:relocate_if_necessary] = relocate_if_necessary unless relocate_if_necessary.nil?
+      load_attributes_from_response(
+        self.class.post(:connect, {}, body.to_json)
+      )
+    end
+
+    def set(new_available, disconnect_if_necessary: nil)
+      body = {
+        location_id: location_id,
+        inventory_item_id: inventory_item_id,
+        available: new_available
+      }
+      body[:disconnect_if_necessary] = disconnect_if_necessary unless disconnect_if_necessary.nil?
+      load_attributes_from_response(
+        self.class.post(:set, {}, body.to_json)
+      )
+    end
+
+    def adjust(available_adjustment)
+      body = {
+        location_id: location_id,
+        inventory_item_id: inventory_item_id,
+        available_adjustment: available_adjustment
+      }
+      load_attributes_from_response(
+        self.class.post(:adjust, {}, body.to_json)
+      )
+    end
+  end
+end

data/lib/shopify_api/resources/line_item.rb

@@ -1,6 +1,14 @@
 module ShopifyAPI
-  class LineItem < Base 
+  class LineItem < Base
     class Property < Base
+      def initialize(*args)
+        attributes = args[0] || {}
+        persisted = args[1] || false
+        super
+      rescue NameError
+        attributes = attributes.to_hash
+        self
+      end
     end
   end
 end

data/lib/shopify_api/resources/location.rb

@@ -1,4 +1,8 @@
 module ShopifyAPI
   class Location < Base
+
+    def inventory_levels
+      ShopifyAPI::InventoryLevel.find(:all, from: "/admin/locations/#{id}/inventory_levels.json")
+    end
   end
 end

data/lib/shopify_api/resources/o_auth.rb

@@ -1,8 +1,16 @@
+# frozen_string_literal: true
+
+# This resource is deprecated and will be removed in a future version of this gem.
+# Use ShopifyAPI::ApiPermission.destroy instead
+
 module ShopifyAPI
   class OAuth < Base
     self.collection_name = 'oauth'
 
     def self.revoke
+      warn '[DEPRECATED] ShopifyAPI::OAuth#revoke is deprecated and will be removed in a future version. ' \
+        'Use ShopifyAPI::ApiPermission#destroy instead.'
+
       delete(:revoke)
     end
   end

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))
@@ -14,8 +19,15 @@ module ShopifyAPI
       Transaction.find(:all, :params => { :order_id => id })
     end
 
-    def capture(amount = "")
-      Transaction.create(:amount => amount, :kind => "capture", :order_id => id)
+    def capture(amount = "", currency: nil)
+      capture_transaction = {
+        amount: amount,
+        kind: "capture",
+        order_id: id,
+      }
+      capture_transaction[:currency] = currency if currency
+
+      Transaction.create(capture_transaction)
     end
 
     class ClientDetails < Base

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,42 @@
+# 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
+
+      def successful_delivery(message_id:, delivery_timestamp:)
+        delivery_details = ShopifyAPI::Ping::DeliveryConfirmationDetails.new(
+          delivery_attrs(message_id, delivery_timestamp).merge(delivered: true)
+        )
+        delivery_details.save
+        delivery_details
+      end
+
+      def failed_delivery(message_id:, delivery_timestamp:, details:)
+        delivery_details = ShopifyAPI::Ping::DeliveryConfirmationDetails.new(
+          delivery_attrs(message_id, delivery_timestamp).merge(delivered: false, details: details)
+        )
+        delivery_details.save
+        delivery_details
+      end
+
+      def delivery_attrs(message_id, delivery_timestamp)
+        {
+          conversation_id: id,
+          message_id: message_id,
+          confirmation_timestamp: delivery_timestamp,
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  module Ping
+    class DeliveryConfirmationDetails < Base
+      self.prefix = "/admin/api/ping-api/v1/conversations/:conversation_id/messages/:message_id/"
+      self.collection_name = "delivery_confirmation"
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+# 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/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/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/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/resources/tender_transaction.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class TenderTransaction < Base
+  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.2.4"
 end

data/service.yml

@@ -0,0 +1,8 @@
+audience: partner
+classification: library
+org_line: App & Partner Platform
+owners:
+  - Shopify/app-partner-dev-tools-education
+slack_channels:
+  - dev-tools-education
+  - api-patterns-team

data/shopify_api.gemspec

@@ -23,14 +23,17 @@ 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")
   s.add_development_dependency("minitest", ">= 4.0")
   s.add_development_dependency("rake")
   s.add_development_dependency("timecop")
+  s.add_development_dependency("pry")
+  s.add_development_dependency("pry-byebug")
 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