Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/screenstaring/shopify-default_variant
Determine if the given Shopify product only has a default variant, or if the given variant is the default variant.
https://github.com/screenstaring/shopify-default_variant
default-variant shopify shopify-api shopify-default-variant shopify-graphql-api shopify-products
Last synced: about 2 months ago
JSON representation
Determine if the given Shopify product only has a default variant, or if the given variant is the default variant.
- Host: GitHub
- URL: https://github.com/screenstaring/shopify-default_variant
- Owner: ScreenStaring
- License: mit
- Created: 2024-02-03T21:08:10.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2024-02-03T21:49:07.000Z (12 months ago)
- Last Synced: 2024-08-09T05:52:32.487Z (5 months ago)
- Topics: default-variant, shopify, shopify-api, shopify-default-variant, shopify-graphql-api, shopify-products
- Language: Ruby
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Shopify::DefaultVariant
[](https://github.com/ScreenStaring/shopify-default_variant/actions/workflows/ci.yml)
Determine if the given Shopify product only has a default variant, or if the given variant is the default variant.
Works with a variety of objects:
- ShopifyAPI gem response objects
- GraphQL response `Hash` with `String` or `Symbol` keys
- Plain Ol' Ruby Object (PORO)
- Plain `Hash` with `String` or `Symbol` keys
## Installation
Add this line to your application's `Gemfile`:
```ruby
gem "shopify-default_variant"
```
And then execute:
```sh
bundle
```
Or install it yourself as:
```sh
gem install shopify-default_variant
```
## Usage
```rb
Shopify::DefaultVariant.match?(object)
```
Where `object` can be a product or a variant in any of the aforementioned forms.
More examples:
```rb
require "shopify-default_variant"
require "shopify_api" # Just an example, *not* a recommendation 😉
product = ShopifyAPI::Product.find(id: id)
Shopify::DefaultVariant.match?(product)
Shopify::DefaultVariant.match?(product.variants)
Shopify::DefaultVariant.match?(product.variants.sample)
require "shopify_api-graphql-tiny"
gql = ShopifyAPI::GraphQL::Tiny.new("shop", "token")
data = gql.execute(YOUR_QUERY)
# Be sure to remove the data key and query's name key (whatever it may be) from the response hash
Shopify::DefaultVariant.match?(data.dig("data", "queryName"))
# Or use a Object or Hash that resembles one of the well-known forms
Shopify::DefaultVariant.match?(my_custom_object)
```
## Testing
The GraphQL tests require a Shopify store and access token. You can set this by
copying `.env.template` to `.env.test` and adding the appropriate values.
VCR is used to record these requests.
---
Made by [ScreenStaring](http://screenstaring.com)