shopify_api 4.9.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fff80db1065be0d32a1762d81992769fc9cde8b6
-  data.tar.gz: 2a00b35496dcffdb72d0788c5b4bd18b90bee947
+  metadata.gz: ef057d0e70073f7c63a076b7f878c1c3afd062d0
+  data.tar.gz: 477cf304d0a68dc7e68cfac7e39c9af5617611c5
 SHA512:
-  metadata.gz: 4d53f0ae3e229f88800e277b83c4434228b1118f39627794b62868b37a4236deb626c295ee01557e10867b7070dd227a0fc1d1429201ecff203aabb2cb80ae24
-  data.tar.gz: 259547ebef03ae4f739ea2e7489ce0f01b8d03726037d8648c69321d8f640847872ee7b8ca27ed6c0c27ff7e4f529a04fdf35947a7b7a927a06aa05d9be5fa37
+  metadata.gz: c24fa3742f763e0f798a4e2d0eccd37ff2db06ba21e08e09d5853584550398db112354f39b9fd6edc55af2cc8e438f5d04b8e3ade7e704c81e2eda2a8236338f
+  data.tar.gz: 9886ecfff88b5b9e7dac1e1e1948fbe3ea3a0c69cbc9f13f601c413dead928bdfc68678f81d06ad74f277631f8048628252f390a37717bf17d9c1b6c4c3e016b

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from:
+  - https://shopify.github.io/ruby-style-guide/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+
+Rails:
+  Enabled: false

data/.travis.yml

@@ -2,7 +2,6 @@ language: ruby
 sudo: false
 
 rvm:
-  - '2.0'
   - 2.3.1
   - 2.4.0-preview1
 
@@ -15,9 +14,6 @@ gemfile:
   - Gemfile_ar_master
 
 matrix:
-  exclude:
-    - rvm: '2.0'
-      gemfile: Gemfile_ar_master
   fast_finish: true
   allow_failures:
     - rvm: 2.4.0-preview1

data/CHANGELOG

@@ -1,3 +1,21 @@
+== Version 4.12.0
+
+* Added support for the GraphQL API
+
+== 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`

data/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:
@@ -230,6 +221,30 @@ gem install shopify_cli
    shopify-cli help
    ```
 
+## GraphQL
+
+This library also supports Shopify's new [GraphQL API](https://help.shopify.com/api/graphql-admin-api)
+via a dependency on the [graphql-client](https://github.com/github/graphql-client) gem.
+The authentication process (steps 1-5 under [Getting Started](#getting-started))
+is identical. Once your session is activated, simply construct a new graphql
+client and use `parse` and `query` as defined by
+[graphql-client](https://github.com/github/graphql-client#defining-queries).
+
+```ruby
+client = ShopifyAPI::GraphQL.new
+
+SHOP_NAME_QUERY = client.parse <<-'GRAPHQL'
+  {
+    shop {
+      name
+    }
+  }
+GRAPHQL
+
+result = client.query(SHOP_NAME_QUERY)
+result.data.shop.name
+```
+
 ## Threadsafety
 
 ActiveResource is threadsafe as of version 4.1 (which works with Rails 4.x and above).
@@ -241,12 +256,13 @@ If you were previously using Shopify's [activeresource fork](https://github.com/
 Download the source code and run:
 
 ```bash
-rake install
+bundle install
+bundle exec rake test
 ```
 
 ## Additional Resources
 
-API Docs: https://help.shopify.com/api/reference
+API Reference: https://help.shopify.com/api/reference
 
 Ask questions on the forums: http://ecommerce.shopify.com/c/shopify-apis-and-technology
 

data/lib/shopify_api/limits.rb

@@ -39,8 +39,7 @@ module ShopifyAPI
       # @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
 

data/lib/shopify_api/resources/access_scope.rb

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

data/lib/shopify_api/resources/api_permission.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ShopifyAPI
+  class ApiPermission < Base
+    def self.destroy
+      delete(:current)
+    end
+  end
+end

data/lib/shopify_api/resources/asset.rb

@@ -42,7 +42,7 @@ module ShopifyAPI
       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,7 +57,7 @@ module ShopifyAPI
         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.
@@ -65,28 +65,28 @@ module ShopifyAPI
       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)

data/lib/shopify_api/resources/billing_address.rb

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

data/lib/shopify_api/resources/custom_collection.rb

@@ -6,14 +6,14 @@ module ShopifyAPI
     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

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))

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