README.md

Best Buy Ruby

This is a Ruby gem for accessing all the different Best Buy APIs.

Installation

Add this line to your application's Gemfile:

gem 'best_buy_ruby'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install best_buy_ruby

On a Ruby on Rails project, you can also use a generator to create the gem's initializer:

$ rails generate best_buy:config

This will create this file: config/initializers/best_buy.rb

Usage

The gem can be used to access Best Buy APIs:

• Products
• Stores
• Categories

Example:

products_api = BestBuy::Products.new(your_api_key)

products_api.get_by(min_price: 6.5, max_price: 11, item_condition: "New")

Future Features

• Commerce API

• Buying Options API

• Recommendations API

• Sorting options

• Facets

• Stores API

  • Area function

(A detailed backlog can be found in our Github Projects board)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/rootstrap/best_buy_ruby. 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 Best Buy Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Credits

Rails Api Base is maintained by Rootstrap with the help of our contributors.