bestbuy_api 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5f754a396c74d1b261ee6a128194d3ac2edc688621ba22b31963dd9611d7597
-  data.tar.gz: 962ade249e82c4cfa4592da1d928ead4c4a4b5efcd156f080b51078cc353a091
+  metadata.gz: 30fe2e8e4bea5f47e2b7914ab5503254caad2b44196d2f78a1ce80a141cadbaa
+  data.tar.gz: 1748654ec2820ffec00ad63ecb5a9e4c4cfbd4831d0c662b61a1b526e8e288cb
 SHA512:
-  metadata.gz: ab324760e5daefe668c269db7a3ca8f80e3c81bd4927832c3b0231f1230e94514ba955298237fe68d1f115474fae7a31a79cbf253ca3f87759fbed8dc8e40dcb
-  data.tar.gz: 7cdfb22fc14a3ec62788955b467a21cfeab9f983a35c93626b37e408f8bd0aa9e13bcfcb4184d943d76095bb47ef5464737786156c766d576d5ad5d68695fd77
+  metadata.gz: a03f206f578e31ebf60120de11a6753aafdc78f884dd0f17dca2caaa11857ed3a125f6e68e2d098bbaf49f1a085cb8f470b3ab547c91be08f0344866b12d9c35
+  data.tar.gz: cb3fd58846fb529926735e7259808b12e6305f0a1f5127bbef81d91deda0fa312b1e581322b89999d82a6de674d6b43b5e913227f2256a702ef80359d21a8778

data/.reek.yml

@@ -0,0 +1,3 @@
+detectors:
+  UtilityFunction:
+    public_methods_only: true

data/.rubocop.yml

@@ -1,4 +1,6 @@
 Metrics/LineLength:
   Max: 120
 Metrics/BlockLength:
-  Max: 150
+  Max: 150
+Style/Documentation:
+  Enabled: false

data/README.md

@@ -1,5 +1,7 @@
 # Best Buy API
 
+[![Build Status](https://travis-ci.org/mbayucot/bestbuy_api.svg?branch=master)](https://travis-ci.org/mbayucot/bestbuy_api)
+
 A Ruby wrapper for the [Best Buy developer API](https://developer.bestbuy.com/).
 
 ## Installation

data/lib/bestbuy_api.rb

@@ -3,8 +3,6 @@ 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

data/lib/bestbuy_api/category.rb

@@ -4,13 +4,11 @@ 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
+    path 'categories'
 
-    ATTRIBUTES = {
-      id: { search: true },
-      name: { search: true },
-      subcategory_id: { kw: 'subCategories.id' },
-      subcategory_name: { kw: 'subCategories.name' }
-    }.freeze
+    attribute :id, search: true
+    attribute :name, search: true
+    attribute :subcategory_id, field: 'subCategories.id'
+    attribute :subcategory_name, field: 'subCategories.name'
   end
 end

data/lib/bestbuy_api/criteria.rb

@@ -1,10 +1,11 @@
+require_relative 'params'
+require_relative 'request'
 require 'forwardable'
 
 module BestbuyApi
-  # Collect the parameters and validates the attributes
   class Criteria
     extend Forwardable
-    def_delegators :request, :items, :pagination, :url
+    def_delegators :response, :items, :pagination, :url
 
     def initialize(klass)
       @klass = klass
@@ -15,18 +16,14 @@ module BestbuyApi
     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) }
+      assert_keys(args, @klass.attributes[:read])
 
       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) }
+      assert_keys(args, @klass.attributes[:search])
 
       criteria[:conditions].merge!(args)
       self
@@ -42,17 +39,26 @@ module BestbuyApi
       self
     end
 
-    private
-
-    def request
-      @request ||= BestbuyApi::Request.new(@klass::PATH, @klass::ATTRIBUTES, criteria)
+    def response
+      params = Params.new(criteria, @klass.attributes)
+      request.find(params.structure)
     end
 
-    def assert_keys(valid_keys, key)
-      return true if valid_keys.include?(key)
+    private
 
-      raise MissingAttributeError, "Unknown attribute: #{key.inspect}. Valid attributes are: " \
+    def assert_keys(args, attributes)
+      valid_keys = attributes.keys
+      args.each do |key, _v|
+        unless valid_keys.include?(key)
+          raise MissingAttributeError, "Unknown attribute: #{key.inspect}. Valid attributes are: " \
                             "#{valid_keys.map(&:inspect).join(', ')}"
+        end
+      end
+    end
+
+    def request
+      api_key = BestbuyApi.config.api_key
+      @request ||= Request.new(api_key, @klass.attributes[:path])
     end
   end
 end

data/lib/bestbuy_api/model.rb

@@ -1,8 +1,21 @@
 require_relative 'criteria'
 
 module BestbuyApi
-  # Chains method calls to build up queries
   class Model
+    def self.attributes
+      @attributes ||= { path: nil, read: {}, search: {} }
+    end
+
+    def self.path(path = nil)
+      attributes[:path] = path
+    end
+
+    def self.attribute(id, columns = { search: false, read: true })
+      row = { id => columns }
+      attributes[:read].merge!(row) unless columns[:read] == false
+      attributes[:search].merge!(row) unless columns[:search] == false
+    end
+
     def self.select(*args)
       Criteria.new(self).select(args.uniq)
     end

data/lib/bestbuy_api/params.rb

@@ -0,0 +1,53 @@
+module BestbuyApi
+  class Params
+    def initialize(criteria, attributes)
+      @criteria = criteria
+      @attributes = attributes
+    end
+
+    def structure
+      { slug: build_filters, query: build_response_options }
+    end
+
+    private
+
+    def build_filters
+      collection = collect_search
+      collection.empty? ? '' : query_string(collection)
+    end
+
+    def build_response_options
+      query = @criteria.slice(:limit, :page)
+      query[:show] = collect_read
+      query
+    end
+
+    def collect_read
+      Array[@criteria[:attributes].map do |key|
+        elements = @attributes[:read]
+        if elements.key?(key)
+          attribute = elements[key]
+          attribute.key?(:field) ? attribute[:field] : key
+        end
+      end].join(',')
+    end
+
+    def collect_search
+      @criteria[:conditions].map do |key, value|
+        elements = @attributes[:search]
+        if elements.key?(key)
+          attribute = elements[key]
+          attribute.key?(:field) ? { attribute[:field] => value } : { key => value }
+        end
+      end.reduce({}, :merge)
+    end
+
+    def query_string(props)
+      search = props.delete('search')
+      uri = URI.encode_www_form(props)
+      search_query = "(search=#{search})" if search
+      uri = format("#{search_query}%<and>s", and: "&#{uri}") if search_query && uri
+      "(#{uri})"
+    end
+  end
+end

data/lib/bestbuy_api/product.rb

@@ -4,23 +4,24 @@ 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
+    path 'products'
 
-    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
+    attribute :keyword, field: 'search', search: true, read: false
+    attribute :sku, search: true
+    attribute :category_id, field: 'categoryPath.id', search: true
+    attribute :category_name, field: 'categoryPath.name', search: true
+    attribute :condition, search: true
+    attribute :customer_rating, field: 'customerReviewAverage', search: true
+    attribute :manufacturer, search: true
+    attribute :regular_price, field: 'regularPrice'
+    attribute :sale_price, field: 'salePrice'
+    attribute :shipping_cost, field: 'shippingCost'
+    attribute :reviews_count, field: 'customerReviewCount'
+    attribute :discount, field: 'percentSavings'
+    attribute :free_shipping, field: 'freeShipping'
+    attribute :url
+    attribute :name
+    attribute :description
+    attribute :image
   end
 end

data/lib/bestbuy_api/request.rb

@@ -1,81 +1,24 @@
 require 'httparty'
+require_relative 'response'
 
 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?
+    def initialize(api_key, path)
+      raise MissingApiKeyError, 'API Key is not defined' if api_key.empty?
 
       @path = path
-      @attributes = attributes
-      @criteria = criteria
-      @query = { apiKey: api_key, format: 'json' }
+      @options = { 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 find(params)
+      result = self.class.get("/#{@path}#{params[:slug]}", query: @options.merge(params[:query]))
+      code = result.code
+      raise RequestError, "#{code} Request Error: #{result.request.last_uri}" if code != 200
 
-    def join_fields(opts)
-      params = @criteria.slice(:limit, :page)
-      params[:show] = opts unless opts.empty?
-      @query.merge!(params) unless params.empty?
-      @query
+      Response.new(result, @path)
     end
   end
 end

data/lib/bestbuy_api/response.rb

@@ -0,0 +1,22 @@
+module BestbuyApi
+  class Response
+    PAGE_VARS = %w[totalPages total currentPage].freeze
+
+    def initialize(result, path)
+      @result = result
+      @path = path
+    end
+
+    def items
+      @result[@path] if @result.key?(@path)
+    end
+
+    def pagination
+      @result.select { |key| PAGE_VARS.include?(key) }
+    end
+
+    def url
+      @result.request.last_uri.to_s
+    end
+  end
+end

data/lib/bestbuy_api/store.rb

@@ -1,20 +1,21 @@
 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
+    path 'stores'
 
-    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
+    attribute :id, field: 'storeId', search: true
+    attribute :city, search: true
+    attribute :state, field: 'region', search: true
+    attribute :postal_code, field: 'fullPostalCode', search: true
+    attribute :store_type, field: 'storeType'
+    attribute :name
+    attribute :address
+    attribute :address2
+    attribute :country
+    attribute :hours
+    attribute :phone
   end
 end

data/lib/bestbuy_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bestbuy_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael John Bayucot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-01 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -128,6 +128,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -141,8 +142,10 @@ files:
 - lib/bestbuy_api/criteria.rb
 - lib/bestbuy_api/exceptions.rb
 - lib/bestbuy_api/model.rb
+- lib/bestbuy_api/params.rb
 - lib/bestbuy_api/product.rb
 - lib/bestbuy_api/request.rb
+- lib/bestbuy_api/response.rb
 - lib/bestbuy_api/store.rb
 - lib/bestbuy_api/version.rb
 homepage: https://github.com/mbayucot/bestbuy-api