best_buy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e295eefcc01f8b347c6db1f57c6fd6beecf3e148
+  data.tar.gz: 01e25099bb14c2c4a1061862f1d1fd201958ffd9
+SHA512:
+  metadata.gz: 3f0a5a82b5efa7f2f41b0c567508e05440153125d4c9ad34415704d1caf32212bec97d14242e71385d40ef551aa002b5eed3ec0d30f8d19fe7864e27c844ba45
+  data.tar.gz: e3b396e54d3b0582f80fd042e4c0a4a10b9b652c818f0256e200a22b353cc26ad49bfcfb99dafa9754352b91e5edabf27752b65e613617fae9ef675e44a706bc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bestbuy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 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,59 @@
+# BestBuy
+
+The BestBuy gem lets you request information from the BestBuy API in your Ruby applications. The API requires you to have an API key before you can make any requests, so make sure you obtain one [here](https://remix.mashery.com/member/register) first.
+
+**Disclaimer**: I am not affiliated with Best Buy in any way. I built this because it was useful to me and I'm releasing it in the hopes that it will be useful to others.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bestbuy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bestbuy
+
+## Usage
+
+First, require the BestBuy gem where you want to make requests to the API using:
+
+```
+require 'best_buy'
+```
+
+Next, you will need to instantiate a `BestBuy::Client` with your API key:
+
+```
+bby = BestBuy::Client(api_key: '1234567890')
+```
+
+Once you've created a client, you can access the various endpoints of the BestBuy API as methods off of the BestBuy client. Most options are passed as hash parameters to these methods.
+
+```
+bby.products(upc: '004815162342')
+
+#=> [#<BestBuy::Product:0xDEADBEEF>, ...]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/timraymond/bestbuy.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bestbuy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "best_buy"
+  spec.version       = BestBuy::VERSION
+  spec.authors       = ["Timothy Raymond"]
+  spec.email         = ["traymond@reviewed.com"]
+
+  spec.summary       = %q{A gem for requesting information from the BestBuy API }
+  spec.homepage      = "http://github.com/reviewed/bestbuy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'multi_json', "~> 1.11"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "yard", "~> 0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bestbuy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bestbuy.rb

@@ -0,0 +1,4 @@
+require "bestbuy/version"
+require "bestbuy/client"
+require "bestbuy/request"
+require "bestbuy/api_error"

data/lib/bestbuy/api_error.rb

@@ -0,0 +1,5 @@
+module BestBuy
+  # Represents errors incurred while interacting with the BestBuy API
+  class APIError < StandardError
+  end
+end

data/lib/bestbuy/client.rb

@@ -0,0 +1,23 @@
+module BestBuy
+  # A BestBuy::Client allows queries to be constructed to the BestBuy API
+  class Client
+    # @param api_key[String] The API Key for making requests to the BestBuy API. Get one at https://remix.mashery.com/member/register
+    def initialize(api_key: nil, affiliate_tracking_id: nil)
+      raise ArgumentError, "API Key not set" unless api_key
+      @api_key = api_key
+      @affiliate_tracking_id = affiliate_tracking_id
+    end
+
+    # Issues a request for products held in the BestBuy API
+    #
+    # @param params[Hash] Parameters passed to the products API call which filter the result set. Parameters are combined by logical OR
+    # @return Array<Hash> Products that were found in the BestBuy API
+    def products(**params)
+      filters = params.map {|key, value| "#{key}=#{value}"}
+      BestBuy::Request.new(api_key: @api_key,
+                           affiliate_tracking_id: @affiliate_tracking_id,
+                           endpoint: 'products',
+                           filters: filters)
+    end
+  end
+end

data/lib/bestbuy/request.rb

@@ -0,0 +1,100 @@
+require 'multi_json'
+require 'net/http'
+
+module BestBuy
+  # Represents an unfulfilled request to the BestBuy API. Fullfillment of the
+  # request can be triggered by invoking Request#call. Request also provides
+  # methods to inspect the request that will be made to the BestBuy API
+  class Request
+    # Endpoints that are supported by this API client
+    VALID_ENDPOINTS = [
+      'products',
+    ]
+    # @param api_key[String] The API key required by the BestBuy API
+    # @param endpoint[String] The endpoint of the API that this request will be made against. Must be one of VALID_ENDPOINTS
+    # @param filters[Array<String>] Filters that will be applied to the particular resource being requested.
+    def initialize(api_key:, endpoint:, affiliate_tracking_id: nil, filters: [])
+      unless VALID_ENDPOINTS.include? endpoint
+        fail APIError, "The endpoint \"#{endpoint}\" is currently unsupported. Supported endpoints are: #{VALID_ENDPOINTS.join(", ")}"
+      end
+      @endpoint = endpoint
+      @filters = filters
+      @affiliate_tracking_id = affiliate_tracking_id
+      @api_key = api_key
+      @show_params = []
+    end
+
+    # @returns [String] The URL that will be used for this Request
+    def to_s
+      "https://api.bestbuy.com/v1/#{@endpoint}(#{@filters.join('|')})?#{query_string}"
+    end
+
+    # Converts the request into a cURL request for debugging purposes
+    #
+    # @returns [String] An eval-able string that will make a request using cURL to the BestBuy API
+    def to_curl
+      "curl #{to_s}"
+    end
+
+    # Sets the request to only return the specified fields from the API
+    #
+    # @example Pluck attributes
+    #   bby = BestBuy::Client.new(api_key: '12345')
+    #   bby.products(upc: '004815162342').pluck(:name).call
+    #   #=> [{:name => "MegaProduct 5000"}]
+    # @param requested_fields [Array<Symbol>] The requested fields that should be included in product results
+    # @return BestBuy::Request The augmented request
+    def pluck(*requested_fields)
+      @show_params = requested_fields.map(&:to_s)
+      self
+    end
+
+    # Synchronously executes a request to the BestBuy API. This will block until results are ready and have been parsed
+    #
+    # @return Array<Hash> The results returned from the API.
+    def call
+      resp = ::Net::HTTP.get URI(to_s)
+      ::MultiJson.decode(resp)['products']
+    end
+
+    # Returns the query string that will be used for this request. Query string parameters are returned in alphabetical order.
+    #
+    # @return String The query string for this request
+    def query_string
+      [
+        api_key_param,
+        format_param,
+        show_param,
+        affiliate_param,
+      ].compact.sort.join("&")
+    end
+
+    private
+
+    # Inserts the query string parameter responsible for crediting affiliate links
+    def affiliate_param
+      if @affiliate_tracking_id
+        "LID=#{@affiliate_tracking_id}"
+      end
+    end
+
+    # Controls the apiKey query string parameter
+    def api_key_param
+      "apiKey=#{@api_key}"
+    end
+
+    # Changes the response format. The API accepts XML, but this gem requres JSON
+    def format_param
+      "format=json"
+    end
+
+    # Controls the fields returned for API response items. Corresponsds to the "show" query parameter
+    def show_param
+      if @show_params && @show_params.length > 0
+        "show=#{@show_params.join(",")}"
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/bestbuy/version.rb

@@ -0,0 +1,3 @@
+module BestBuy
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: best_buy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Timothy Raymond
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- traymond@reviewed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bestbuy.gemspec
+- bin/console
+- bin/setup
+- lib/bestbuy.rb
+- lib/bestbuy/api_error.rb
+- lib/bestbuy/client.rb
+- lib/bestbuy/request.rb
+- lib/bestbuy/version.rb
+homepage: http://github.com/reviewed/bestbuy
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A gem for requesting information from the BestBuy API
+test_files: []
+has_rdoc: