Upgrade from main source due to moving to new Shopify Inventory API

CHANGELOG

@@ -1,3 +1,36 @@
+== Version 4.11.0
+
+* Added `ShopifyAPI::InventoryItem`
+* Added `ShopifyAPI::InventoryLevel`
+* Added `#inventory_levels` method to `ShopifyAPI::Location`
+
+== Version 4.10.0
+
+* Added `ShopifyAPI::AccessScope`
+
+== Version 4.9.1
+
+* Fix a bug with custom properties for orders
+
+== Version 4.9.0
+
+* Added `ShopifyAPI::PriceRule`
+* Added `ShopifyAPI::DiscountCode`
+
+== Version 4.8.0
+
+* Added `add_engagements` to `ShopifyAPI::MarketingEvent`
+
+== Version 4.7.1
+
+* Added support for URL parameter (e.g. limit & page) to ShopifyAPI::Metafields
+* Added support for URL parameter (e.g. limit & page) to metafield operator in ShopifyAPI::Shop
+
+== Version 4.7.0
+
+* Removed the mandatory `application_id` parameter from `ShopifyAPI::ProductListing` and `ShopifyAPI::CollectionListing`
+* Fixed a bug related to the non-standard primary key for `ShopifyAPI::ProductListing` and `ShopifyAPI::CollectionListing`
+
 == Version 4.6.0
 
 * Added `ShopifyAPI::Report`

README.md

@@ -19,7 +19,7 @@ All API usage happens through Shopify applications, created by either shop owner
 * Shop owners can create applications for themselves through their own admin: https://docs.shopify.com/api/authentication/creating-a-private-app
 * Shopify Partners create applications through their admin: http://app.shopify.com/services/partners
 
-For more information and detailed documentation about the API visit http://api.shopify.com
+For more information and detailed documentation about the API visit https://developers.shopify.com/
 
 #### Ruby version
 
@@ -39,15 +39,6 @@ Or install via [gem](http://rubygems.org/)
 gem install shopify_api
 ```
 
-#### Rails 5
-
-shopify_api is compatible with Rails 5 but since the latest ActiveResource release (4.1) is locked on Rails 4.x, you'll need to use the unreleased master version:
-
-```ruby
-gem 'shopify_api'
-gem 'activeresource', github: 'rails/activeresource'
-```
-
 ### Getting Started
 
 ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveResource has to be configured with a fully authorized URL of a particular store first. To obtain that URL you can follow these steps:
@@ -59,7 +50,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 +237,7 @@ rake install
 
 ## Additional Resources
 
-API Docs: http://docs.shopify.com/api
+API Reference: https://help.shopify.com/api/reference
 
 Ask questions on the forums: http://ecommerce.shopify.com/c/shopify-apis-and-technology
 

lib/active_resource/connection_ext.rb

@@ -6,5 +6,6 @@ class Connection
 
     prepend ShopifyAPI::Connection::ResponseCapture
     prepend ShopifyAPI::Connection::RequestNotification
+    prepend ShopifyAPI::Connection::RedoIfTemporaryError
   end
 end

lib/shopify_api.rb

@@ -21,6 +21,7 @@ module ShopifyAPI
 require 'shopify_api/countable'
 require 'shopify_api/resources'
 require 'shopify_api/session'
+require 'shopify_api/message_enricher'
 require 'shopify_api/connection'
 
 if ShopifyAPI::Base.respond_to?(:connection_class)

lib/shopify_api/connection.rb

@@ -4,7 +4,7 @@ class Connection < ActiveResource::Connection
 
     module ResponseCapture
       def handle_response(response)
-        @response = super
+        @response = super(ShopifyAPI::MessageEnricher.new(response))
       end
     end
 
@@ -29,5 +29,28 @@ def notify_about_request(response, arguments)
     end
 
     include RequestNotification
+
+    module RedoIfTemporaryError
+      def request(*args)
+        super
+      rescue ActiveResource::ClientError, ActiveResource::ServerError => e
+        if should_retry? && e.response.class.in?([Net::HTTPTooManyRequests, Net::HTTPInternalServerError])
+          wait
+          request *args
+        else
+          raise
+        end
+      end
+
+      def wait
+        sleep 0.5
+      end
+
+      def should_retry?
+        [true, nil].include? Thread.current[:retry_temporary_errors]
+      end
+    end
+
+    include RedoIfTemporaryError
   end
 end

lib/shopify_api/limits.rb

@@ -39,8 +39,7 @@ def credit_maxed?
       # @return {Integer}
       #
       def credit_limit(scope=:shop)
-        @api_credit_limit ||= {}
-        @api_credit_limit[scope] ||= api_credit_limit_param(scope).pop.to_i - 1
+        api_credit_limit_param(scope).pop.to_i - 1
       end
       alias_method :call_limit, :credit_limit
 

lib/shopify_api/message_enricher.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class ShopifyAPI::MessageEnricher < SimpleDelegator
+  def message
+    return super unless (400...500).include?(code.to_i)
+
+    @_cached_message ||= begin
+      detailed_error = begin
+        parsed_body = JSON.parse(body)
+
+        if parsed_body['error']
+          parsed_body['error'].to_s
+        elsif parsed_body['errors']
+          Array(parsed_body['errors']).join('; ')
+        end
+      rescue JSON::ParserError
+        nil
+      end
+
+      detailed_error.present? ? "#{super} (#{detailed_error})" : super
+    end
+  end
+end

lib/shopify_api/metafields.rb

@@ -1,7 +1,9 @@
 module ShopifyAPI
   module Metafields
-    def metafields
-      Metafield.find(:all, :params => {:resource => self.class.collection_name, :resource_id => id})
+    def metafields(**options)
+      options.merge! resource: self.class.collection_name, resource_id: id
+
+      Metafield.find :all, params: options
     end
 
     def add_metafield(metafield)

lib/shopify_api/resources/access_scope.rb

@@ -0,0 +1,5 @@
+module ShopifyAPI
+  class AccessScope < Base
+    self.prefix = '/admin/oauth/'
+  end
+end

lib/shopify_api/resources/asset.rb

@@ -42,7 +42,7 @@ def self.element_path(id, prefix_options = {}, query_options = nil) #:nodoc:
       prefix_options, query_options = split_options(prefix_options) if query_options.nil?
       "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
     end
-    
+
     # find an asset by key:
     #   ShopifyAPI::Asset.find('layout/theme.liquid', :params => {:theme_id => 99})
     def self.find(*args)
@@ -57,36 +57,36 @@ def self.find(*args)
         resource
       end
     end
-    
+
     # For text assets, Shopify returns the data in the 'value' attribute.
     # For binary assets, the data is base-64-encoded and returned in the
     # 'attachment' attribute. This accessor returns the data in both cases.
     def value
       attributes['value'] ||
       (attributes['attachment'] ? Base64.decode64(attributes['attachment']) : nil)
     end
-    
+
     def attach(data)
       self.attachment = Base64.encode64(data)
     end
-    
+
     def destroy
       connection.delete(element_path(prefix_options.merge(:asset => {:key => key})), self.class.headers)
     end
-    
+
     def new?
       false
     end
-    
+
     def method_missing(method_symbol, *arguments) #:nodoc:
       if %w{value= attachment= src= source_key=}.include?(method_symbol)
         wipe_value_attributes
       end
       super
     end
-    
+
     private
-    
+
     def wipe_value_attributes
       %w{value attachment src source_key}.each do |attr|
         attributes.delete(attr)

lib/shopify_api/resources/billing_address.rb

@@ -1,4 +1,4 @@
 module ShopifyAPI
   class BillingAddress < Base
-  end         
+  end
 end

lib/shopify_api/resources/collection_listing.rb

@@ -1,9 +1,9 @@
 module ShopifyAPI
   class CollectionListing < Base
-    init_prefix :application
+    self.primary_key = :collection_id
 
-    def product_ids(options = {})
-      get("#{collection_id}/product_ids", options[:params])
+    def product_ids
+      get(:product_ids)
     end
   end
 end

lib/shopify_api/resources/custom_collection.rb

@@ -6,14 +6,14 @@ class CustomCollection < Base
     def products
       Product.find(:all, :params => {:collection_id => self.id})
     end
-    
+
     def add_product(product)
       Collect.create(:collection_id => self.id, :product_id => product.id)
     end
-    
+
     def remove_product(product)
       collect = Collect.find(:first, :params => {:collection_id => self.id, :product_id => product.id})
       collect.destroy if collect
     end
-  end                                                                 
+  end
 end

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

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?

lib/shopify_api/resources/inventory_item.rb

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

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

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