newegg-api 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a027adfba6fc335a04a7c9ddddb9319fae3ec1e
+  data.tar.gz: 9e2e4f48ff6025d23140c8b6cbfdeee783cd22be
+SHA512:
+  metadata.gz: 32c2e3aca2be907f1c3fb21b754d10fb940bb9eff0e1276879e52294d05183c61781d900bc777c0eb2e985c6e94981ca8c0ac324d5f400c7d2507a452c7e4a7d
+  data.tar.gz: b4fa8f313692e20cd929272912c650324b43c615f84db7b1d65d7d60d4e2f001fe6c2b58de987e38b15107754f58347060393022d3531f4219a1575a4ca2c66f

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    newegg-api (1.0.1)
+      faraday (~> 0.8)
+      json (~> 1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    json (1.8.0)
+    mime-types (1.23)
+    multi_json (1.4.0)
+    multipart-post (1.2.0)
+    rake (10.0.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+  x86-mingw32
+
+DEPENDENCIES
+  coveralls (~> 0.6)
+  fakeweb (~> 1.3)
+  newegg-api!
+  rake (~> 10.0.4)
+  rspec (~> 2.11)
+  simplecov

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chris Magnacca
+
+MIT License
+
+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,144 @@
+# Newegg Api Gem
+
+A Ruby Wrapper for the Newegg Mobile API
+
+[![Build Status](https://api.travis-ci.org/chrismagnacca/newegg-api.png)](https://api.travis-ci.org/chrismagnacca/newegg-api.png)
+
+[![Coverage Status](https://coveralls.io/repos/chrismagnacca/newegg-api/badge.png)](https://coveralls.io/r/chrismagnacca/newegg-api)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'newegg-api', :git => 'git://github.com/chrismagnacca/newegg-api.git'
+
+And then execute:
+
+    $ bundle install
+    
+Lastly, require the gem as such:
+```ruby
+require 'newegg'
+```
+## Usage
+
+
+#### Obtain Store Information
+```ruby
+Newegg.stores #=> Array<Newegg::Store>
+```
+
+```ruby
+Newegg::Store #=> Class Instance Variables
+title,				# store title
+store_department,	# store department name
+store_id,			# store id
+show_see_all_deals,	# boolean if store contains deals
+categories			# array of category ids
+```
+
+
+#### Obtain Categories for a Store
+```ruby
+Newegg.categories(store_id) #=> Array<Newegg::Category>
+```
+
+```ruby
+Newegg::Category #=> Class Instance Variables 
+description, 		# description of the returned Category 
+category_type,		# category type
+category_id,		# category id
+store_id,			# store id
+show_see_all_deals,	# boolean if category contains deals
+node_id				# node id
+```
+
+#### Navigate through Categories
+```ruby
+Newegg.navigate(store_id, category_id, node_id) #=> Array<Newegg::Category>
+```
+
+#### Search for Products (all arguments optional)
+```ruby
+Newegg.search(store_id: STORE_ID, category_id: CAT_ID, sub_category_id: SUB_CAT_ID, node_id: NODE_ID, page_number: 1, sort: "FEATURED", keywords: KEYWORDS) #=> json
+```
+```json
+{
+	"NavigationContentList" => [
+	{"TitleItem" => {"Description" => "Useful Links",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "Price",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "Manufacturer",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "Type",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "Color",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "Case Material",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "With Power Supply",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "Power Supply",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "With Side Panel Window",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "External 5.25\" Drive Bays",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "External 3.5\" Drive Bays",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "Power Supply Mounted",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "Internal 3.5\" Drive Bays",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "Front Ports",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "80mm Fans",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "120mm Fans",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "250mm Fans",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "Side Air duct",  "NavigationItemList" => [{...}]},
+	{"TitleItem" => {"Description" => "Expansion Slots", "NavigationItemList" => [{...}]}
+	],
+
+	"RelatedLinkList" => nil,
+
+	"CoremetricsInfo" => {"CategoryID" => "2010090007", ...}
+
+	"IsAllComboBundle" => false,
+	"CanBeCompare" => true,
+	"MasterComboStoreId" => 0,
+	"SubCategoryId" => 7,
+	"HasDeactivatedItems" => false,
+	"HasHasSimilarItems" => false,
+	"SearchProvider" => 0,
+	"SearchResultType" => 0,
+	"ProductListItems" => [
+	{"Title" => "Antec Three Hundred Illusion Black Steel ATX Mid Tower Computer Case", ...},
+	{"Title" => "COOLER MASTER HAF X RC-942-KKN1 Black Steel/ Plastic ATX Full Tower Computer Case", ...}
+	{"Title" => "Thermaltake VL84301W2Z V3 Black Edition with 430W  Power Supply ATX Mid Tower Computer Case", ...}
+	],
+	"PaginationInfo" => {"TotalCount" => 572,
+	"PageSize" => 20,
+	"PageNumber" => 1,
+	"PageCount" => 0}
+}
+```
+#### Retrieve Product Specifications
+```ruby
+Newegg.specifications(item_number) 
+```
+
+```json
+{
+	"NeweggItemNumber": "N82E16811147107",
+	"Title": "Rosewill BLACKHAWK Gaming ATX Mid Tower Computer Case, come with Five Fans, window side panel, top HDD dock ",
+	"SpecificationGroupList": [
+	{
+		"GroupName": "Model", "SpecificationPairList":
+		[{"Key": "Brand", "Value": "Rosewill"},
+		{"Key": "Model","Value": "BlackHawk"}]
+	}
+	{"GroupName": "Spec", "SpecificationPairList": [{..}]},
+	{"GroupName": "Expansion", "SpecificationPairList": [{..}]},
+	{"GroupName": "Front Ports", "SpecificationPairList": [{..}]},
+	{"GroupName": "Cooling System", "SpecificationPairList": [{..}]},
+	{"GroupName": "Physical Spec", "SpecificationPairList": [{..}]},
+	{"GroupName": "Features", "SpecificationPairList": [{..}]},
+	]
+}
+```
+####
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: [:spec]
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/newegg.rb

@@ -0,0 +1,13 @@
+module Newegg
+  require "json"
+  require "faraday"
+
+  require "newegg/api"
+  require "newegg/error"
+  require "newegg/store"
+  require "newegg/version"
+  require "newegg/category"
+  require "newegg/explorer"
+  
+  extend Explorer
+end

data/lib/newegg/api.rb

@@ -0,0 +1,430 @@
+module Newegg
+  class Api
+    UserAgents = {
+        iPhone: 'Newegg iPhone App / 4.3.1',
+        Android: 'Newegg Android App / 3.3.3'
+    }
+    DefaultUserAgent = :iPhone
+
+    attr_accessor :conn, :_stores, :_categories, :_id
+
+    def initialize
+      self._stores = []
+    end
+
+    #
+    # retrieve an active connection or establish a new connection
+    #
+    # @ returns [Faraday::Connection] conn to the web service
+    #
+    def connection
+      self.conn ||= Faraday.new(:url => 'http://www.ows.newegg.com') do |faraday|
+        faraday.request :url_encoded            # form-encode POST params
+        faraday.response :logger                # log requests to STDOUT
+
+        faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
+      end
+    end
+
+    #
+    # retrieve and populate a list of available stores
+    #
+    def stores
+      return self._stores if not self._stores.empty?
+      response = api_get("Stores.egg")
+      stores = JSON.parse(response.body)
+      stores.each do |store|
+        self._stores <<  Newegg::Store.new(store['Title'], store['StoreDepa'], store['StoreID'], store['ShowSeeAllDeals'])
+      end
+      self._stores
+    end
+
+    #
+    # retrieve and populate list of categories for a given store_id
+    #
+    # @param [Integer] store_id of the store
+    #
+    def categories(store_id)
+      return [] if store_id.nil?
+
+      response = api_get("Stores.egg", "Categories", store_id)
+      categories = JSON.parse(response.body)
+      categories = categories.collect do |category|
+        Newegg::Category.new(category['Description'], category['CategoryType'], category['CategoryID'],
+                             category['StoreID'], category['ShowSeeAllDeals'], category['NodeId'])
+      end
+
+      categories
+    end
+
+    #
+    # retrieves information necessary to search for products, given the store_id, category_id, node_id
+    #
+    # @param [Integer] store_id of the store
+    # @param [Integer] category_id of the store
+    # @param [Integer] node_id of the store
+    #
+    def navigate(store_id, category_id, node_id)
+      response = api_get("Stores.egg", "Navigation", "#{store_id}/#{category_id}/#{node_id}")
+      categories = JSON.parse(response.body)
+    end
+
+    #
+    # retrieves store content
+    #
+    def store_content(store_id, category_id = -1, node_id = -1, store_type = 4, page_number = 1)
+      params = {
+          'storeId'    => store_id,
+          'categoryId' => category_id,
+          'nodeId'     => node_id,
+          'storeType'  => store_type,
+          'pageNumber' => page_number
+      }
+      JSON.parse(api_get('Stores.egg', 'Content', nil, params).body)
+    end
+
+    #
+    # retrieves stores
+    #
+    def shop_all_navigation
+      JSON.parse(api_get('Store.egg', 'ShopAllNavigation').body)
+    end
+
+    def shop_more_navigation
+      JSON.parse(api_get('Store.egg', 'MoreNavigation').body)
+    end
+
+    #
+    # retrieves information necessary to search for products, given the store_id, category_id, node_id
+    #
+    # @param [Integer] store_id of the store
+    # @param [Integer] category_id of the store
+    # @param [Integer] node_id of the store
+    # @param [Integer] store_type of the store
+    #
+    def store_navigate(store_id, category_id = -1, node_id = -1, store_type = 4)
+      params = {
+          'storeId'    => store_id,
+          'categoryId' => category_id,
+          'nodeId'     => node_id,
+          'storeType'  => store_type
+      }
+      JSON.parse(api_get('Store.egg', 'storeNavigation', nil, params).body)
+    end
+
+    #
+    # retrieves a single page of products given a query specified by an options hash. See options below.
+    # node_id, page_number, and an optional sorting method
+    #
+    # @param [Integer] store_id, from @api.navigation, returned as StoreID
+    # @param [Integer] category_id from @api.navigation, returned as CategoryType
+    # @param [Integer] sub_category_id from @api.navigation, returned as CategoryID
+    # @param [Integer] node_id from @api.navigation, returned as NodeId
+    # @param [Integer] page_number of the paginated search results, returned as PaginationInfo from search
+    # @param [String] sort style of the returned search results, default is FEATURED (can also be RATING, PRICE, PRICED, REVIEWS)
+    # @param [String] keywords
+    #
+    def search(options={})
+      options = {store_id: -1, category_id: -1, sub_category_id: -1, node_id: -1, page_number: 1, sort: "FEATURED",
+                 keywords: ""}.merge(options)
+      request = {
+          'IsUPCCodeSearch'      => false,
+          'IsSubCategorySearch'  => options[:sub_category_id] > 0,
+          'isGuideAdvanceSearch' => false,
+          'StoreDepaId'          => options[:store_id],
+          'CategoryId'           => options[:category_id],
+          'SubCategoryId'        => options[:sub_category_id],
+          'NodeId'               => options[:node_id],
+          'BrandId'              => -1,
+          'NValue'               => "",
+          'Keyword'              => options[:keywords],
+          'Sort'                 => options[:sort],
+          'PageNumber'           => options[:page_number]
+      }
+
+      JSON.parse(api_post("Search.egg", "Advanced", request).body, {quirks_mode: true})
+    end
+
+    #
+    # retrieves a single page of products given a query specified by an options hash. See options below.
+    #
+    # @param [Array] brand_list
+    # @param [Array] search_properties
+    # @param [String] keyword
+    # @param [String] max_price
+    # @param [String] min_price
+    # @param [String] nvalue
+    # @param [Array] product_type
+    # @param [Integer] page_number
+    # @param [Integer] node_id
+    # @param [Integer] category_id
+    # @param [Integer] brand_id
+    # @param [Integer] store_id
+    # @param [Integer] store_type
+    # @param [Integer] sub_category_id
+    #
+    def query(options={})
+      options = {brand_list: [], search_properties: [], keyword: '', max_price:'', min_price: '', nvalue: '', product_type: [],
+                 page_number: 1, node_id: -1, category_id: -1, brand_id: -1, store_id: -1, store_type: -1, sub_category_id: -1}.merge(options)
+      request = {
+          'BrandList'        => options[:brand_list],
+          'SearchProperties' => options[:search_properties],
+          'Keyword'          => options[:keyword],
+          'MaxPrice'         => options[:max_price],
+          'MinPrice'         => options[:min_price],
+          'NValue'           => options[:nvalue],
+          'ProductType'      => options[:product_type],
+          'PageNumber'       => options[:page_number],
+          'NodeId'           => options[:node_id],
+          'CategoryId'       => options[:category_id],
+          'BrandId'          => options[:brand_id],
+          'StoreId'          => options[:store_id],
+          'StoreType'        => options[:store_type],
+          'SubCategoryId'    => options[:sub_category_id]
+      }
+
+      JSON.parse(api_post('Search.egg', 'Query', request).body, {quirks_mode: true})
+    end
+
+    #
+    # retrieve power search content given an category
+    #
+    # @param [Integer] category_id
+    #
+    def power_search_content(category_id)
+      JSON.parse(api_get('PowerSearchContent.egg', '0', "#{category_id}/-1").body)
+    end
+
+    #
+    # retrieves a single page of products given a query specified by an options hash. See options below.
+    #
+    # @param [Array] search_properties
+    # @param [Integer] page_number of the paginated power search results
+    # @param [Array] product_type
+    # @param [String] min_price
+    # @param [String] nvalues
+    # @param [String] srch_in_desc
+    # @param [Array] brand_list
+    # @param [String] max_price
+    #
+    def power_search(search_properties, options={})
+      options = {page_number: 1, product_type: [], min_price: '', nvalues: '', srch_in_desc: '',
+                 brand_list: [], max_price: ''}.merge(options)
+      request = {
+          'PageNumber'       => options[:page_number],
+          'ProductType'      => options[:product_type],
+          'SearchProperties' => search_properties,
+          'MinPrice'         => options[:min_price],
+          'NValues'          => options[:nvalues],
+          'SrchInDesc'       => options[:srch_in_desc],
+          'BrandList'        => options[:brand_list],
+          'MaxPrice'         => options[:max_price]
+      }
+
+      JSON.parse(api_post('PowerSearch.egg', nil, request).body, {quirks_mode: true})
+    end
+
+    #
+    # retrieve related keywords given an keyword
+    #
+    # @param [String] item_number of the product
+    #
+    def keywords(keyword)
+      JSON.parse(api_get('AutoKeywords.egg', nil, nil, keyword: keyword).body)
+    end
+
+    #
+    # retrieve product details given an item number
+    #
+    # @param [String] item_number of the product
+    #
+    def details(item_number)
+      JSON.parse(api_get('Products.egg', item_number, 'ProductDetails').body)
+    end
+
+    #
+    # retrieve product information given an item number
+    #
+    # @param [String] item_number of the product
+    #
+    def specifications(item_number)
+      JSON.parse(api_get("Products.egg", item_number, "Specification").body)
+    end
+
+    #
+    # retrieve product combo deals given an item number
+    #
+    # @param [String] item_number of the product
+    # @param [Integer] sub_category
+    # @param [Integer] sort_field
+    # @param [Integer] page_number
+    #
+    def combo_deals(item_number, options={})
+      options = {sub_category: -1, sort_field: 0, page_number: 1}.merge(options)
+      params = {
+          'SubCategory' => options[:sub_category],
+          'SortField'   => options[:sort_field],
+          'PageNumber'  => options[:page_number]
+      }
+      JSON.parse(api_get('Products.egg', item_number, 'ComboDeals', params).body)
+    end
+
+    #
+    # retrieve product reviews given an item number
+    #
+    # @param [String] item_number of the product
+    # @param [Integer] page_number
+    # @param [String] time
+    # @param [String] rating default All (can also be 5, 4, 3, 2, 1)
+    # @param [String] sort default 'date posted' (can also be 'most helpful', 'highest rated', 'lowest rated', 'ownership')
+    #
+    def reviews(item_number, page_number = 1, options={})
+      options = {time: 'all', rating: 'All', sort: 'date posted'}.merge(options)
+      params = {
+          'filter.time'   => options[:time],
+          'filter.rating' => options[:rating],
+          'sort'          => options[:sort]
+      }
+      JSON.parse(api_get('Products.egg', item_number, "Reviewsinfo/#{page_number}", params).body)
+    end
+
+    #
+    # retrieve tracking country
+    #
+    def country
+      JSON.parse(api_get('Tracking.egg', 'Country').body)
+    end
+
+    #
+    # retrieve shopping guide config
+    #
+    def shopping_guide
+      JSON.parse(api_get('Configurations.egg', 'ShoppingGuideConfig').body)
+    end
+
+    #
+    # retrieve iphone client config
+    #
+    def client_config
+      JSON.parse(api_get('Configurations.egg', 'IphoneClient').body)
+    end
+
+    #
+    # retrieve exclusive deal item
+    #
+    def exclusive_deals
+      JSON.parse(api_get('Promotions.egg', 'ExclusiveDeals').body)
+    end
+
+    #
+    # retrieve daily deal
+    #
+    def daily_deal
+      JSON.parse(api_get('Promotions.egg', 'DailyDeal').body)
+    end
+
+    #
+    # retrieve spotlight item
+    #
+    def spotlight
+      JSON.parse(api_get('Promotions.egg', 'Spotlight').body)
+    end
+
+    #
+    # retrieve spotlights
+    #
+    def spotlights
+      JSON.parse(api_get('Promotions.egg', 'Spotlights').body)
+    end
+
+    #
+    # retrieve shell shocker items
+    #
+    def shell_shockers
+      JSON.parse(api_get('Promotions.egg', 'ShellShockers').body)
+    end
+
+    #
+    # retrieve new shell shocker items
+    #
+    def shell_shockers_new
+      JSON.parse(api_get('Promotions.egg', 'NewShellShocker').body)
+    end
+
+    #
+    # retrieve banners
+    #
+    def banners
+      JSON.parse(api_get('Promotions.egg', 'Banners').body)
+    end
+
+    private
+
+    #
+    # GET: {controller}/{action}/{id}/
+    #
+    # @param [String] controller
+    # @param [optional, String] action
+    # @param [optional, String] id
+    #
+    def api_get(controller, action = nil, id = nil, params = {})
+      uri = String.new
+
+      if action && id
+        uri = "/#{controller}/#{action}/#{id}"
+      elsif action
+        uri = "/#{controller}/#{action}/"
+      else
+        uri = "/#{controller}/"
+      end
+
+      response = self.connection.get(uri, params) do |request|
+        request.headers['Content-Type'] = 'application/json'
+        request.headers['Accept']       = 'application/json'
+        request.headers['User-Agent']  = UserAgents[DefaultUserAgent]
+      end
+
+      case code = response.status.to_i
+      when 400..499
+        raise(Newegg::NeweggClientError, "error, #{code}: #{response.inspect}")
+      when 500..599
+        raise(Newegg::NeweggServerError, "error, #{code}: #{response.inspect}")
+      else
+        response
+      end
+    end
+
+    #
+    # POST: {controller}/{action}/
+    #
+    # @param [String] controller
+    # @param [String] action
+    # @param [Hash] opts
+    #
+    def api_post(controller, action = nil, opts={})
+      uri = String.new
+      if action
+        uri = "/#{controller}/#{action}/"
+      else
+        uri = "/#{controller}/"
+      end
+      response = self.connection.post do |request|
+        request.url uri
+        request.headers['Content-Type'] = 'application/json'
+        request.headers['Accept']       = 'application/json'
+        request.headers['User-Agent']  = UserAgents[DefaultUserAgent]
+        request.body = opts.to_json
+      end
+
+      case code = response.status.to_i
+      when 400..499
+        raise(Newegg::NeweggClientError, "error, #{code}: #{response.inspect}")
+      when 500..599
+        raise(Newegg::NeweggServerError, "error, #{code}: #{response.inspect}")
+      else
+        response
+      end
+    end
+
+  end
+end

data/lib/newegg/category.rb

@@ -0,0 +1,26 @@
+module Newegg
+  class Category < Api
+    attr_accessor :description, :category_type, :category_id, :store_id, :show_see_all_deals, :node_id
+    
+    def initialize(description, category_type, category_id, store_id, show_see_all_deals, node_id)
+      self.description = description
+      self.category_type = category_type
+      self.category_id = category_id
+      self.store_id = store_id
+      self.show_see_all_deals = show_see_all_deals
+      self.node_id = node_id
+    end
+
+    def to_h
+      @h ||= {
+          :description   => description,
+          :category_type => category_type,
+          :category_id   => category_id,
+          :store_id      => store_id,
+          :node_id       => node_id
+      }.freeze
+      @h
+    end
+
+  end
+end

data/lib/newegg/error.rb

@@ -0,0 +1,5 @@
+module Newegg
+  class NeweggServerError < StandardError; end
+  class NeweggClientError < StandardError; end
+  class ApiError < StandardError; end
+end

data/lib/newegg/explorer.rb

@@ -0,0 +1,20 @@
+module Newegg
+  module Explorer
+    require 'newegg/api'
+    
+    def api
+      @api ||= Api.new
+    end
+    
+    def method_missing(method, *args, &block)
+      return self.api.send(method) if args.empty?
+      self.api.send(method, *args)
+    end
+    
+    def respond_to?(method)
+      return true if (self.methods.include?(method) || self.instance_methods.include?(method))
+      false
+    end
+    
+  end
+end

data/lib/newegg/store.rb

@@ -0,0 +1,35 @@
+module Newegg
+  class Store < Api
+    attr_accessor :title, :store_department, :store_id, :show_see_all_deals, :categories
+
+    def initialize(title, store_department, store_id, show_see_all_deals)
+      self.title = title
+      self.store_department = store_department
+      self.store_id = store_id
+      self.show_see_all_deals = show_see_all_deals
+      self.categories = []
+    end
+
+    def get_categories(newegg = Newegg)
+      self.categories = newegg.categories(self.store_id).freeze if self.categories.empty?
+      self.categories
+    end
+
+    def to_h(newegg = Newegg)
+      @h ||= begin
+        categories_hash = []
+        get_categories(newegg).each do |c|
+          categories_hash << c.to_h
+        end
+        {
+          :title              => title,
+          :store_department   => store_department,
+          :store_id           => store_id,
+          :show_see_all_deals => show_see_all_deals,
+          :categories         => categories_hash
+        }.freeze
+      end
+    end
+
+  end
+end

data/lib/newegg/version.rb

@@ -0,0 +1,3 @@
+module Newegg
+  VERSION = '1.0.1'
+end

data/newegg-api.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/newegg/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = %q{newegg-api}
+  spec.version       = Newegg::VERSION
+
+  spec.authors       = ['Chris Magnacca']
+  spec.email         = %w{'chrismagnacca@gmail.com'}
+  spec.description   = %q{this gem allows the usage of the newegg.com api to ascertain product information.}
+  spec.summary       = %q{newegg's json api}
+  spec.homepage      = %q{http://github.com/chrismagnacca/newegg-api}
+
+  spec.files         = %w{
+                        Gemfile
+                        Gemfile.lock
+                        LICENSE
+                        README.md
+                        Rakefile
+                        lib/
+                        lib/newegg.rb
+                        lib/newegg/api.rb
+                        lib/newegg/category.rb
+                        lib/newegg/error.rb
+                        lib/newegg/store.rb
+                        lib/newegg/explorer.rb
+                        lib/newegg/version.rb
+                        spec/api_spec.rb
+                        spec/category_spec.rb
+                        spec/spec_helper.rb
+                        spec/newegg_spec.rb
+                        spec/store_spec.rb
+                        newegg-api.gemspec
+                        }
+
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.require_paths = ['lib']
+  spec.add_dependency(%q<json>,['~>1.7'])
+  spec.add_dependency(%q<faraday>,['~>0.8'])
+  spec.add_development_dependency(%q<simplecov>)
+  spec.add_development_dependency(%q<fakeweb>,['~>1.3'])
+  spec.add_development_dependency(%q<rspec>,['~>2.11'])
+  spec.add_development_dependency(%q<rake>, ['~>10.0.4'])
+  spec.add_development_dependency(%q<coveralls>, ['~>0.6'])
+end

data/spec/api_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+describe Newegg::Api do
+  before(:each) do
+    @api = Newegg::Api.new
+    FakeWeb.clean_registry
+  end
+
+  it %q{throws an error when response is 404} do
+    FakeWeb.register_uri(:get, "http://www.ows.newegg.com/Stores.egg/", :status => ["404", "Not Found"])
+    lambda {
+      @api.send(:api_get, "Stores.egg")
+    }.should raise_error Newegg::NeweggClientError
+  end
+
+  it %q{throws an error when response is 404} do
+    FakeWeb.register_uri(:get, %r{http://www.ows.newegg.com/Stores.egg/}, :status => ["500", "Server Error"])
+    lambda {
+      @api.send(:api_get, "Stores.egg")
+    }.should raise_error Newegg::NeweggServerError
+  end
+
+  it %q{should return an array of Newegg::Store for Newegg::Api.stores} do
+    @api.stores.each do |store|
+      store.class.should eq(Newegg::Store)
+    end
+  end
+
+  describe "categories()" do
+    subject { @api.categories(store_id) }
+    context "with a valid store_id" do
+      let(:store_id) { 1 }
+      it "should return the correct categories" do
+        categories = {
+          'Backup Devices & Media' => 2,
+          'Barebone / Mini Computers' => 3,
+          'CD / DVD / Blu-Ray Burners & Media' => 10,
+          'Computer Accessories' => 1,
+          'Computer Cases' => 9,
+          'CPUs / Processors' => 34,
+          'Fans & PC Cooling' => 11,
+          'Flash Memory & Readers' => 324,
+          'Hard Drives' => 15,
+          'Headsets, Speakers, & Soundcards' => 37,
+          'Input Devices' => 29,
+          'Keyboards & Mice' => 234,
+          'Memory' => 17,
+          'Monitors' => 19,
+          'Motherboards' => 20,
+          'Networking' => 281,
+          'Power Protection' => 314,
+          'Power Supplies' => 32,
+          'Printers / Scanners & Supplies' => 33,
+          'Projectors' => 343,
+          'Servers & Workstations' => 271,
+          'SSDs' => 119,
+          'Video Cards & Video Devices' => 38
+        }
+
+        expect(subject.length).to eq(categories.length)
+        expect(subject.collect{|c| c.description}).to match_array categories.keys
+        expect(subject.collect{|c| c.category_id}).to match_array categories.values
+      end
+
+      it "should return the same categories after multiple calls" do
+        orig_cats = subject.dup
+        @api.categories(@api.stores.last.store_id)
+        new_cats = @api.categories(store_id)
+        expect(orig_cats.collect{|c| c.description}).to match_array new_cats.collect{|c| c.description}
+        expect(orig_cats.collect{|c| c.category_id}).to match_array new_cats.collect{|c| c.category_id}
+      end
+    end
+
+    context "with an invalid store_id" do
+      let(:store_id) { 23123 }
+      it "should return an empty array" do
+        expect(subject).to be_empty
+      end
+    end
+
+    context "with a nil store_id" do
+      let(:store_id) { nil }
+      it "should return an empty array" do
+        expect(subject).to be_empty
+      end
+    end
+  end
+
+  it %q{should return an array of Newegg::Category for Newegg::Api.stores[index].categories} do
+    @api.stores.each do |store|
+      store.categories.each do |category|
+        category.class.should eq(Newegg::Category)
+      end
+    end
+  end
+
+  it %q{should return a stores categories for Newegg::Api.stores[index].categories} do
+    @api.stores.first.categories.should_not be_nil
+    @api.stores.last.categories.should_not be_nil
+  end
+
+  it %q{returns success for retrieve(store_id, category_id, node_id)} do
+    response = {"Description" => "Backup Devices & Media", "CategoryType" => 0, "CategoryID" => 2, "StoreID" => 1, "ShowSeeAllDeals" => true, "NodeId" => 6642}
+    @api.navigate(response["StoreID"], response["CategoryID"], response["NodeId"]).should_not be_nil
+  end
+
+  it %q{returns success for search(store_id, category_id, sub_category_id, node_id)} do
+    response ={"Description" => "Computer Cases", "CategoryType" => 1, "CategoryID" => 7, "StoreID" => 1, "ShowSeeAllDeals" => false, "NodeId" => 7583}
+    @api.search(store_id: response["StoreID"], category_id: response["CategoryType"], sub_category_id: response["CategoryID"], node_id: response["NodeId"], page_number: 1)['PaginationInfo']['TotalCount'].should be > 0
+  end
+
+  it %q{throws error for search(store_id, category_id, sub_category_id, node_id} do
+    FakeWeb.register_uri(:post, %r{http://www.ows.newegg.com/Search.egg/Advanced}, :status => ["404", "Not Found"])
+    response = {"Description" => "Computer Cases", "CategoryType" => 1, "CategoryID" => 7, "StoreID" => 1, "ShowSeeAllDeals" => false, "NodeId" => 7583}
+    lambda {
+      @api.search(store_id: response["StoreID"], category_id: response["CategoryType"], sub_category_id: response["CategoryID"], node_id: response["NodeId"], page_number: 1)
+    }.should raise_error Newegg::NeweggClientError
+  end
+
+  it %q{throws error for search(store_id, category_id, sub_category_id, node_id} do
+    FakeWeb.register_uri(:post, %r{http://www.ows.newegg.com/Search.egg/Advanced}, :status => ["500", "Server"])
+    response = {"Description" => "Computer Cases", "CategoryType" => 1, "CategoryID" => 7, "StoreID" => 1, "ShowSeeAllDeals" => false, "NodeId" => 7583}
+    lambda {
+      @api.search(store_id: response["StoreID"], category_id: response["CategoryType"], sub_category_id: response["CategoryID"], node_id: response["NodeId"], page_number: 1)
+    }.should raise_error Newegg::NeweggServerError
+  end
+
+  it %q{returns success for search(keywords)} do
+    expect(@api.search(keywords: "gtx 770")['PaginationInfo']['TotalCount']).to be > 0
+  end
+
+  it %q{returns nil for a NULL search result} do
+    expect(@api.search()).to be_nil
+  end
+
+  it %q{returns success for specifications} do
+    response = {"NeweggItemNumber"=>"N82E16823114051",
+                        "Title"=>"RAZER BlackWidow Chroma RZ03-01220200-R3U1 USB Wired Gaming RGB Mechanical Keyboard",
+                        "SpecificationGroupList"=> [{
+                          "GroupName"=>"Model", "SpecificationPairList"=>[{
+                            "Key"=>"Brand", "Value"=>"RAZER"}, {"Key"=>"Name", "Value"=>"BlackWidow Chroma"}, {"Key"=>"Model", "Value"=>"RZ03-01220200-R3U1"}]}, {"GroupName"=>"Spec", "SpecificationPairList"=>[{
+                              "Key"=>"Keyboard Interface", "Value"=>"USB"}, {"Key"=>"Design Style", "Value"=>"Gaming"}, {"Key"=>"Mechanical Keyboard", "Value"=>"Yes"}, {"Key"=>"Type", "Value"=>"Wired"}]
+                              }]}
+    specs = @api.specifications("N82E16823114051")
+    expect(specs['SpecificationGroupList'].length).to eq(response['SpecificationGroupList'].length)
+    res_group_names = response['SpecificationGroupList'].collect{|s| s['GroupName']}
+    specs['SpecificationGroupList'].each{|s| expect(res_group_names).to include s['GroupName']}
+  end
+
+end #end Newegg::Api

data/spec/category_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Newegg::Category do
+
+  it %q{should return a Newegg::Category for Newegg::Category.new(description, category_type, category_id, store_id, show_see_all_deals, node_id)} do
+    description = "Backup Devices & Media"
+    category_type = 0
+    category_id = 2
+    store_id = 1
+    show_see_all_deals = true
+    node_id = 6642
+
+    category = Newegg::Category.new(description, category_type, category_id, store_id, show_see_all_deals, node_id)
+
+    category.description.should eq("Backup Devices & Media")
+    category.category_type.should eq(0)
+    category.store_id.should eq(1)
+    category.show_see_all_deals.should eq(true)
+    category.node_id.should eq(6642)
+  end
+
+  it %q{should return category information when .to_h is called on a Newegg::Category} do
+    category = Newegg.categories(Newegg.stores.first.store_id)
+    response = {:title=>"Computer Hardware", :store_department=>"ComputerHardware", :store_id=>1, :show_see_all_deals=>true, :categories=>[{:description=>"Backup Devices & Media", :category_type=>0, :category_id=>2, :store_id=>1, :node_id=>6642}, {:description=>"Barebone / Mini Computers", :category_type=>0, :category_id=>3, :store_id=>1, :node_id=>6668}, {:description=>"CD / DVD / Blu-Ray Burners & Media", :category_type=>0, :category_id=>10, :store_id=>1, :node_id=>6646}, {:description=>"Computer Accessories", :category_type=>0, :category_id=>1, :store_id=>1, :node_id=>6640}, {:description=>"Computer Cases", :category_type=>0, :category_id=>9, :store_id=>1, :node_id=>6644}, {:description=>"CPUs / Processors", :category_type=>0, :category_id=>34, :store_id=>1, :node_id=>6676}, {:description=>"Fans & PC Cooling", :category_type=>0, :category_id=>11, :store_id=>1, :node_id=>6648}, {:description=>"Flash Memory & Readers", :category_type=>0, :category_id=>324, :store_id=>1, :node_id=>6682}, {:description=>"Hard Drives", :category_type=>0, :category_id=>15, :store_id=>1, :node_id=>6670}, {:description=>"Headsets, Speakers, & Soundcards", :category_type=>0, :category_id=>37, :store_id=>1, :node_id=>6660}, {:description=>"Input Devices", :category_type=>0, :category_id=>29, :store_id=>1, :node_id=>6666}, {:description=>"Keyboards & Mice", :category_type=>0, :category_id=>234, :store_id=>1, :node_id=>6690}, {:description=>"Memory", :category_type=>0, :category_id=>17, :store_id=>1, :node_id=>6650}, {:description=>"Monitors", :category_type=>0, :category_id=>19, :store_id=>1, :node_id=>6652}, {:description=>"Motherboards", :category_type=>0, :category_id=>20, :store_id=>1, :node_id=>6654}, {:description=>"Networking", :category_type=>0, :category_id=>281, :store_id=>1, :node_id=>6688}, {:description=>"Power Protection", :category_type=>0, :category_id=>314, :store_id=>1, :node_id=>6674}, {:description=>"Power Supplies", :category_type=>0, :category_id=>32, :store_id=>1, :node_id=>6656}, {:description=>"Printers / Scanners & Supplies", :category_type=>0, :category_id=>33, :store_id=>1, :node_id=>6664}, {:description=>"Projectors", :category_type=>0, :category_id=>343, :store_id=>1, :node_id=>6686}, {:description=>"Servers & Workstations", :category_type=>0, :category_id=>271, :store_id=>1, :node_id=>6684}, {:description=>"SSDs", :category_type=>0, :category_id=>119, :store_id=>1, :node_id=>11692}, {:description=>"Video Cards & Video Devices", :category_type=>0, :category_id=>38, :store_id=>1, :node_id=>6662}]}
+    Newegg.stores.first.to_h.should eq(response)
+  end
+
+end #end Newegg::Category

data/spec/newegg_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Newegg do
+
+  it %q{should return stores for Newegg.stores} do
+    Newegg.stores.should_not be_nil
+  end
+
+  it %q{should respond to methods properly} do
+    Newegg.respond_to?(:api).should be_true
+  end
+
+  it %q{should not respond to non-existent methods} do
+    Newegg.respond_to?(:wrong).should be_false
+  end
+
+  it %q{should pass arguments through method_missing correctly} do
+    Newegg.send(:categories, 1).should be_true
+  end
+end #end Newegg

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "rspec"
+require "fakeweb"
+require "net/http"
+require "simplecov"
+require "coveralls"
+
+# coveralls.io, code coverage, & statistics
+Coveralls.wear!
+SimpleCov.start
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/newegg")

data/spec/store_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Newegg::Store do
+
+  it %q{should return a Newegg::Category for Newegg::Store.new(title, store_department, store_id, show_see_all_deals)} do
+    title = "Computer Hardware"
+    store_department = "ComputerHardware"
+    store_id = 1
+    show_see_all_deals = true
+
+    store = Newegg::Store.new(title, store_department, store_id, show_see_all_deals)
+
+    store.title.should  eq("Computer Hardware")
+    store.store_department.should eq("ComputerHardware")
+    store.store_id.should eq(1)
+    store.show_see_all_deals.should eq(true)
+  end
+
+  it %q{should return store information when .to_h is called on a Newegg::Store} do
+    response = {:description=>"Backup Devices & Media", :category_type=>0, :category_id=>2, :store_id=>1, :node_id=>6642}
+    store = Newegg.stores.first
+    Newegg.categories(store.store_id).count.should eq(23)
+    Newegg.categories(store.store_id).first.to_h.should eq(response)
+  end
+
+  it %q{should return Newegg::Categories when .get_categories is called on a Newegg::Store} do
+    categories = Newegg.stores.first.get_categories
+    categories.should_not be_nil
+    categories.count.should eq(23)
+  end
+end #end Newegg::Store

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: newegg-api
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Chris Magnacca
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: this gem allows the usage of the newegg.com api to ascertain product
+  information.
+email:
+- '''chrismagnacca@gmail.com'''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/newegg.rb
+- lib/newegg/api.rb
+- lib/newegg/category.rb
+- lib/newegg/error.rb
+- lib/newegg/explorer.rb
+- lib/newegg/store.rb
+- lib/newegg/version.rb
+- newegg-api.gemspec
+- spec/api_spec.rb
+- spec/category_spec.rb
+- spec/newegg_spec.rb
+- spec/spec_helper.rb
+- spec/store_spec.rb
+homepage: http://github.com/chrismagnacca/newegg-api
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: newegg's json api
+test_files:
+- spec/api_spec.rb
+- spec/category_spec.rb
+- spec/newegg_spec.rb
+- spec/spec_helper.rb
+- spec/store_spec.rb