The project is in a healthy, maintained state
This gems provides a client for the Spreadshop GraphQL API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies
 Project Readme

SpreadshopClient

Gem Version Build Status

SpreadshopClient is a Ruby gem that provides a convenient interface for interacting with the Spreadshop GraphQL API. It simplifies fetching shop data by encapsulating the necessary queries and handling the API communication, making it easy to integrate into your Ruby projects or Rails applications.

Installation

Add this line to your application's Gemfile:

gem 'spreadshop_client'

And then execute:

bundle install

Or install it yourself as:

gem install spreadshop_client

Usage

Here's an example of how to use the SpreadshopClient gem to fetch shop details:

require 'spreadshop_client'

name = "my-shop"       # Replace with the actual shop name
platform = "EU"           # Replace with the platform
locale = "de_DE"          # Replace with the locale

response = SpreadshopClient.get_shop(name: name, platform: platform, locale: locale)

if response.is_a?(SpreadshopClient::Shop)
  puts "Shop ID: #{response.id}"
  puts "Shop Name: #{response.name}"
elsif response.is_a?(Hash) && response[:error]
  puts "Error: #{response[:error]}"
else
  puts "Unexpected response: #{response.inspect}"
end

Development and Testing

Run Tests:

rake test

Check Code Style:

The project uses StandardRB to ensure consistent coding style. Run the linter with:

rake standard

Run StandardRB Auto-Fix:

rake standard:fix

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/paderich/spreadshop_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the SpreadshopClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.