bestbuy_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5f754a396c74d1b261ee6a128194d3ac2edc688621ba22b31963dd9611d7597
+  data.tar.gz: 962ade249e82c4cfa4592da1d928ead4c4a4b5efcd156f080b51078cc353a091
+SHA512:
+  metadata.gz: ab324760e5daefe668c269db7a3ca8f80e3c81bd4927832c3b0231f1230e94514ba955298237fe68d1f115474fae7a31a79cbf253ca3f87759fbed8dc8e40dcb
+  data.tar.gz: 7cdfb22fc14a3ec62788955b467a21cfeab9f983a35c93626b37e408f8bd0aa9e13bcfcb4184d943d76095bb47ef5464737786156c766d576d5ad5d68695fd77

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Metrics/LineLength:
+  Max: 120
+Metrics/BlockLength:
+  Max: 150

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bestbuy_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# Best Buy API
+
+A Ruby wrapper for the [Best Buy developer API](https://developer.bestbuy.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bestbuy_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bestbuy_api
+
+## Getting Started
+ Sign-up for a developer API Key at https://developer.bestbuy.com/
+
+## API Documentation
+
+Documentation for the Best Buy API is located at [bestbuyapis.github.io](https://bestbuyapis.github.io/api-documentation/).
+
+## Usage
+
+``` ruby
+require 'bestbuy_api'
+
+BestbuyApi.config.api_key = 'YourBestbuyApiKey'
+
+product = BestbuyApi::Product.select(:sku, :name, :sale_price, :url, :image)
+                             .where(keyword: 'iPhone')
+                             .limit(10).page(1)
+product.items.each do |item|
+  item['sku']
+end
+```
+
+## Find products
+
+``` ruby
+product = BestbuyApi::Product.select(:sku, :name, :sale_price, :url, :image)
+product.items
+```
+
+## Find categories
+
+``` ruby
+category = BestbuyApi::Category.select(:id, :name, :subcategory_id, :subcategory_name)
+category.items
+```
+
+## Find stores
+
+``` ruby
+store = BestbuyApi::Store.select(:id, :city, :state, :postal_code)
+store.items
+```
+
+## Selecting Specific Fields
+
+``` ruby
+BestbuyApi::Product.select(category_id: 'abcat500')
+```
+
+## Conditions
+
+``` ruby
+BestbuyApi::Product.where(category_id: 'abcat500')
+```
+
+## Limit and Offset
+
+``` ruby
+BestbuyApi::Product.limit(20).page(2)
+```
+
+## Pagination
+
+``` ruby
+product = BestbuyApi::Product.where(category_id: 'abcat500')
+product.pagination or product.url
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bestbuy_api.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bestbuy_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bestbuy_api"
+  spec.version       = BestbuyApi::VERSION
+  spec.authors       = ['Michael John Bayucot']
+  spec.email         = ['mbayucot@gmail.com']
+
+  spec.summary       = 'A Ruby wrapper for the Bestbuy API'
+  spec.homepage      = 'https://github.com/mbayucot/bestbuy-api'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'httparty', '~> 0.13'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+  spec.add_development_dependency 'vcr', '~> 4.0', '>= 4.0.0'
+  spec.add_development_dependency 'webmock', '~> 3.4', '>= 3.4.2'
+end

data/lib/bestbuy_api/category.rb

@@ -0,0 +1,16 @@
+require_relative 'model'
+
+module BestbuyApi
+  # Defines the attributes for the categories api. Documentation is
+  # located at https://bestbuyapis.github.io/api-documentation/#categories-api.
+  class Category < Model
+    PATH = 'categories'.freeze
+
+    ATTRIBUTES = {
+      id: { search: true },
+      name: { search: true },
+      subcategory_id: { kw: 'subCategories.id' },
+      subcategory_name: { kw: 'subCategories.name' }
+    }.freeze
+  end
+end

data/lib/bestbuy_api/criteria.rb

@@ -0,0 +1,58 @@
+require 'forwardable'
+
+module BestbuyApi
+  # Collect the parameters and validates the attributes
+  class Criteria
+    extend Forwardable
+    def_delegators :request, :items, :pagination, :url
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def criteria
+      @criteria ||= { attributes: [], conditions: {} }
+    end
+
+    def select(args)
+      # Check on attributes that are readable
+      attributes = @klass::ATTRIBUTES.select { |_k, v| v.key?(:read) ? v[:read] : true }
+      args.each { |k, _v| assert_keys(attributes.keys, k) }
+
+      criteria[:attributes] = args
+      self
+    end
+
+    def where(args)
+      # Check on attributes that are searchable
+      attributes = @klass::ATTRIBUTES.select { |_k, v| v.key?(:search) && v[:search] }
+      args.each { |k, _v| assert_keys(attributes.keys, k) }
+
+      criteria[:conditions].merge!(args)
+      self
+    end
+
+    def limit(limit)
+      criteria[:limit] = limit.to_i
+      self
+    end
+
+    def page(page)
+      criteria[:page] = page.to_i
+      self
+    end
+
+    private
+
+    def request
+      @request ||= BestbuyApi::Request.new(@klass::PATH, @klass::ATTRIBUTES, criteria)
+    end
+
+    def assert_keys(valid_keys, key)
+      return true if valid_keys.include?(key)
+
+      raise MissingAttributeError, "Unknown attribute: #{key.inspect}. Valid attributes are: " \
+                            "#{valid_keys.map(&:inspect).join(', ')}"
+    end
+  end
+end

data/lib/bestbuy_api/exceptions.rb

@@ -0,0 +1,5 @@
+module BestbuyApi
+  class MissingApiKeyError < ArgumentError; end
+  class MissingAttributeError < ArgumentError; end
+  class RequestError < StandardError; end
+end

data/lib/bestbuy_api/model.rb

@@ -0,0 +1,22 @@
+require_relative 'criteria'
+
+module BestbuyApi
+  # Chains method calls to build up queries
+  class Model
+    def self.select(*args)
+      Criteria.new(self).select(args.uniq)
+    end
+
+    def self.where(args)
+      Criteria.new(self).where(args)
+    end
+
+    def self.limit(args)
+      Criteria.new(self).limit(args)
+    end
+
+    def self.page(args)
+      Criteria.new(self).page(args)
+    end
+  end
+end

data/lib/bestbuy_api/product.rb

@@ -0,0 +1,26 @@
+require_relative 'model'
+
+module BestbuyApi
+  # Defines the attributes for the products api. Documentation is
+  # located at https://bestbuyapis.github.io/api-documentation/#products-api.
+  class Product < Model
+    PATH = 'products'.freeze
+
+    ATTRIBUTES = {
+      keyword: { kw: 'search', search: true, read: false },
+      sku: { search: true },
+      category_id: { kw: 'categoryPath.id', search: true },
+      category_name: { kw: 'categoryPath.name', search: true },
+      condition: { search: true },
+      customer_rating: { kw: 'customerReviewAverage', search: true },
+      manufacturer: { search: true },
+      regular_price: { kw: 'regularPrice' },
+      sale_price: { kw: 'salePrice' },
+      shipping_cost: { kw: 'shippingCost' },
+      reviews_count: { kw: 'customerReviewCount' },
+      discount: { kw: 'percentSavings' },
+      free_shipping: { kw: 'freeShipping' },
+      url: {}, name: {}, description: {}, image: {}
+    }.freeze
+  end
+end

data/lib/bestbuy_api/request.rb

@@ -0,0 +1,81 @@
+require 'httparty'
+
+module BestbuyApi
+  # Wrap HTTParty gem to query the api
+  class Request
+    include HTTParty
+    base_uri 'https://api.bestbuy.com/v1'
+    PAGE_VARS = %w[totalPages total currentPage].freeze
+
+    def initialize(path, attributes, criteria)
+      # Get your API Key at https://developer.bestbuy.com/.
+      api_key = BestbuyApi.config.api_key
+      raise MissingApiKeyError, 'API Key is not defined' if api_key.nil?
+
+      @path = path
+      @attributes = attributes
+      @criteria = criteria
+      @query = { apiKey: api_key, format: 'json' }
+    end
+
+    def items
+      response[@path] if response.key?(@path)
+    end
+
+    def pagination
+      response.select { |k| PAGE_VARS.include?(k) }
+    end
+
+    def url
+      response.request.last_uri.to_s
+    end
+
+    private
+
+    def response
+      @response ||= find
+    end
+
+    def find
+      response = self.class.get("/#{@path}#{slug}", query: params)
+      raise RequestError, "#{response.code} Request Error" if response.code != 200
+
+      response
+    end
+
+    # Collect attributes that are readable and substitute using kw or key
+    def slug
+      attributes = @attributes.select { |_k, v| v.key?(:search) && v[:search] }
+      opts = @criteria[:conditions].map do |k, v|
+        attributes[k].key?(:kw) ? { attributes[k][:kw] => v } : { k => v }
+      end
+      opts = opts.reduce({}, :merge)
+
+      encode_slug(opts)
+    end
+
+    # Collect attributes that are searchable and substitute using kw or key
+    def params
+      attributes = @attributes.select { |_k, v| v.key?(:read) ? v[:read] : true }
+      opts = Array[@criteria[:attributes].map do |k|
+        attributes[k].key?(:kw) ? attributes[k][:kw] : k
+      end].join(',')
+
+      join_fields(opts)
+    end
+
+    def encode_slug(opts)
+      search = opts.delete('search') if opts.key?('search')
+      slug = URI.encode_www_form(opts)
+      slug = format("(search=#{search})%<and>s", and: ("&#{slug}" unless slug.empty?)) if search
+      return "(#{slug})" unless slug.empty?
+    end
+
+    def join_fields(opts)
+      params = @criteria.slice(:limit, :page)
+      params[:show] = opts unless opts.empty?
+      @query.merge!(params) unless params.empty?
+      @query
+    end
+  end
+end

data/lib/bestbuy_api/store.rb

@@ -0,0 +1,20 @@
+require_relative 'model'
+require_relative 'request'
+
+module BestbuyApi
+  # Defines the attributes for the stores api. Documentation is
+  # located at https://bestbuyapis.github.io/api-documentation/#stores-api.
+  class Store < Model
+    PATH = 'stores'.freeze
+
+    ATTRIBUTES = {
+      id: { kw: 'storeId', search: true },
+      city: { search: true },
+      state: { kw: 'region', search: true },
+      postal_code: { kw: 'fullPostalCode', search: true },
+      store_type: { kw: 'storeType' },
+      name: {}, address: {}, address2: {}, country: {},
+      hours: {}, phone: {}
+    }.freeze
+  end
+end

data/lib/bestbuy_api/version.rb

@@ -0,0 +1,3 @@
+module BestbuyApi
+  VERSION = '0.1.0'.freeze
+end

data/lib/bestbuy_api.rb

@@ -0,0 +1,16 @@
+require 'bestbuy_api/exceptions'
+require 'bestbuy_api/product'
+require 'bestbuy_api/store'
+require 'bestbuy_api/category'
+
+# Handles BestBuy api queries. Documentation is located at
+# https://bestbuyapis.github.io/api-documentation.
+module BestbuyApi
+  class << self
+    attr_accessor :api_key
+
+    def config
+      self
+    end
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: bestbuy_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael John Bayucot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+description: 
+email:
+- mbayucot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bestbuy_api.gemspec
+- lib/bestbuy_api.rb
+- lib/bestbuy_api/category.rb
+- lib/bestbuy_api/criteria.rb
+- lib/bestbuy_api/exceptions.rb
+- lib/bestbuy_api/model.rb
+- lib/bestbuy_api/product.rb
+- lib/bestbuy_api/request.rb
+- lib/bestbuy_api/store.rb
+- lib/bestbuy_api/version.rb
+homepage: https://github.com/mbayucot/bestbuy-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Bestbuy API
+test_files: []