cheapshark 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 845f882f1c716ed0233f3a66ffd8708001ad78ac
+  data.tar.gz: 8b552c4e4d38e11874ca63d3e9fa2fa70475fb21
+SHA512:
+  metadata.gz: 8e24deb0199312b8cb60ff9809ec8248b3c852358c8a06177805b7c96d014e5eacb98731f359b267b0204412be856dd6bbe375e7110c1779e08fee97c69fef6d
+  data.tar.gz: e71f073b26d5964fdcf7c17479a68014ae86a8d67140c654ee166b55427fbb62f73a935646db3a6bc232f59c6b34791a3c59d8da1d18539132f4bfc11b0bc279

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/support/cassettes/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+coverage

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2.2
+script:
+  - bundle exec rspec

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,6 @@
+require 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Antonio Gurgel
+
+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,52 @@
+# CheapShark
+
+[![Dependency Status](https://gemnasium.com/GA114/cheapshark.svg)](https://gemnasium.com/GA114/cheapshark) [![Code Climate](https://codeclimate.com/github/GA114/cheapshark/badges/gpa.svg)](https://codeclimate.com/github/GA114/cheapshark) [![Build Status](https://travis-ci.org/GA114/cheapshark.svg)](https://travis-ci.org/GA114/cheapshark)
+
+Ruby wrapper for [CheapShark's API](http://www.cheapshark.com/api/).
+
+## Installation
+
+Add this to your `Gemfile` and do a `bundle install`.
+
+```ruby
+gem 'cheapshark'
+```
+
+Or install it yourself:
+
+    $ gem install cheapshark
+
+## Usage
+
+``` ruby
+require 'cheapshark'
+CheapShark.games(title: 'Borderlands 2')    # Returns an array of Game objects
+CheapShark.games(title: 'Borderlands 2')[0] # Returns the likely most-relevant result
+CheapShark.stores                           # Returns stores and their IDs
+CheapShark.deals(storeID: 1, pageSize: 5)   # Returns five best deals on Steam (CS sorts by deal rating by default)
+CheapShark.deal(id: 'DCqsq6Hnmtzu2UVkBpD133kL1pG93Ovz4%2BEjTuJAx9c%3D') # Returns a specific deal.
+```
+
+Keep in mind that option names **must be properly capitalized**. The API will respond to `storeID` but ignore `storeid`.
+
+``` ruby
+CheapShark.deals(storeID: 1, pageSize: 5) # Right
+CheapShark.deals(storeid: 1, pageSize: 5) # Wrong, will return five best deals from any store
+CheapShark.deals(storeID: 1, pagesize: 5) # Wrong, will return the API default of sixty deals
+CheapShark.deals(storeid: 1, pagesize: 5) # Very wrong, will return all deals
+
+```
+
+## To-dos
+
+- Decide on garbage-input scenarios to handle (things like calling `CheapShark.games()` without params)
+- Alert feature
+- Complete [expectations.md](https://github.com/GA114/cheapshark/blob/master/expectations.md)
+
+## Contributing
+
+1. Fork it ( https://github.com/GA114/cheapshark/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/cheapshark.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cheapshark/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cheapshark"
+  spec.version       = CheapShark::VERSION
+  spec.author        = "Antonio Gurgel"
+  spec.email         = "ag@antoniogurgel.com"
+  spec.summary       = %q{Ruby wrapper gem for CheapShark's API.}
+  spec.description   = %q{CheapShark aggregates sales from PC game stores.}
+  spec.homepage      = "http://github.com/GA114/cheapshark"
+  spec.license       = "MIT"
+  spec.platform      = Gem::Platform::RUBY
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "webmock", "~> 1.20.4"
+  spec.add_development_dependency "sinatra", "~> 1.4.5"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard", "~> 2.12.4"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "guard-rspec", "~> 4.5.0"
+  spec.add_development_dependency "io-console", "~> 0.4.3"
+  spec.add_development_dependency "vcr", "~> 2.9.3"
+  spec.add_development_dependency "simplecov", "~> 0.10.0"
+  spec.add_development_dependency "yard", "~> 0.8.7.6"
+  spec.add_runtime_dependency "httparty", "~> 0.13"
+  spec.add_runtime_dependency "json"
+end

data/expectations.md

@@ -0,0 +1,49 @@
+# Questions
+
+[x] Where can I find $GAME for the cheapest price?
+[x] What sales does $STORE have at the moment?
+[ ] Which store has the best overall deals right now?
+[ ] Which store has the most unique deals?
+
+# Answers
+
+## Find $GAME at lowest price
+
+Search for games with single form input, which is just the name of the game.
+Return a list of games, prices, and store link.
+
+``` ruby
+CheapShark.games(title: 'Borderlands 2')    # returns an array of Game objects
+```
+
+Extra features (possibilities):
+Search as you type (with Rails!)
+
+## List $STORE's sales
+
+Have user select a store from a list populated with API's store fetcher.
+Return top $LIMIT or 10 deals of that store.
+
+```ruby
+CheapShark.deals(storeID: 1, pageSize: 5) # returns five best deals on Steam (CS sorts by deal rating by default)
+```
+
+Extra features (possibilities):
+
+## Find store with best deals
+
+Search all deals.
+Return top $LIMIT or 10 deals.
+
+```ruby
+CheapShark.deals(limit: 10)
+```
+
+Extra features (possibilities):
+
+## Find best unique deals
+
+(Meaning, no other store has $GAME on sale?)
+??
+
+Extra features (possibilities):

data/lib/cheapshark.rb

@@ -0,0 +1,95 @@
+require 'uri'
+require_relative 'cheapshark/version'
+require_relative 'cheapshark/fetchers/games_fetcher.rb'
+require_relative 'cheapshark/fetchers/game_fetcher.rb'
+require_relative 'cheapshark/fetchers/deal_fetcher.rb'
+require_relative 'cheapshark/fetchers/deals_fetcher.rb'
+require_relative 'cheapshark/fetchers/stores_fetcher.rb'
+
+# Base object to handle interaction with API.
+#
+module CheapShark
+  extend self
+
+  # Gets info about a specific deal, by ID.
+  #
+  # @param options [{Symbol => String}] 
+  # @option options [String] :id the ID of the deal
+  # @example Returns "Borderlands 2" on the Humble Store.
+  #   CheapShark.deal(id: 'DCqsq6Hnmtzu2UVkBpD133kL1pG93Ovz4%2BEjTuJAx9c%3D')
+  # @return [CheapShark::Deal]
+  def deal(options={})
+    options[:id] = URI.unescape(options[:id])
+    CheapShark::DealFetcher.new(options).results
+  end
+
+  # Searches for deals matching each criterion supplied, and returns them in a paginated list.
+  #
+  # @param options [{Symbol => String}] 
+  # @option options [String] :storeID Comma-separated list of stores; omit for any store.
+  # @option options [Integer] :pageSize (60) Number of deals to return
+  # @option options [Integer] :pageNumber (0) Page to start on
+  # @option options [String] :sortBy ("Deal Rating") Can be "Deal Rating", "Title", "Savings", "Price", "Metacritic", "Release", or "Store".
+  # @option options [Integer] :desc (0) Sort descending?
+  # @option options [Integer] :lowerPrice (0) Minimum deal price.
+  # @option options [Integer] :upperPrice Maximum deal price. 50 is the same as no limit.
+  # @option options [Integer] :metacritic (0) Minimum Metacritic score.
+  # @option options [String] :title Match the supplied string anywhere in the game's title.
+  # @option options [Integer] :exact (0) Match exact title string.
+  # @option options [Integer] :AAA (0) Finds games with RETAIL PRICE >$29
+  # @option options [Integer] :steamworks (0) Find games that redeem on Steam (API has best-guess policy).
+  # @option options [Integer] :onSale (0) Find games currently on sale.
+  #
+  # @example Returns five best deals on Steam (API sorts by deal rating by default)
+  #   CheapShark.deals(storeID: 1, pageSize: 5)
+  # @example Returns all deals with titles containing the word "civilization"
+  #   CheapShark.deals(title: 'civilization')
+  # @example Returns all deals for "Grand Theft Auto V"
+  #   CheapShark.deals(title: 'Grand Theft Auto V', exact: 1)
+  # @return [Array<CheapShark::Deal>]
+  def deals(options={})
+    CheapShark::DealsFetcher.new(options).results
+  end
+
+  # Searches for games matching either the title or Steam ID supplied.
+  #
+  # @param options [{Symbol => String}] 
+  # @option options [String] :title Title of the game.
+  # @option options [Integer] :steamAppID Steam ID of the game.
+  # @option options [Integer] :limit Limit the amount of games to return.
+  # @example Search for the "Max Payne" series.
+  #   CheapShark.games(title: 'Max Payne')
+  # @example Returns "Portal 2" (and use it as a Game object rather than an Array).
+  #   CheapShark.games(steamAppID: 620)[0]
+  # @return [Array<CheapShark::Game>]
+  def games(options={})
+    CheapShark::GamesFetcher.new(options).results
+  end
+
+
+  # Returns a game identified by CheapShark ID and all current deals associated with it.
+  # @note Game IDs are different from deal IDs; the game IDs take on the form of an integer, whereas deal IDs are encoded strings.
+  #
+  # @param options [{Symbol => String}] 
+  # @option options [String] :id ID of the game.
+  # @example Returns "Batman: Arkham City" and all deals it's in.
+  #   CheapShark.game(id: 14)
+  # @returns [CheapShark::Game]
+  def game(options={})
+    CheapShark::GameFetcher.new(options).results
+  end
+
+  # Returns all stores tracked by CheapShark, as well as their IDs.
+  #
+  # @example 
+  #   CheapShark.stores()
+  # @returns [Array<CheapShark::Store>]
+  def stores(options={})
+    CheapShark::StoresFetcher.new(options).results
+  end
+
+  # TODO
+  # def alerts(options={})
+  # end
+
+end

data/lib/cheapshark/config.rb

@@ -0,0 +1,4 @@
+module CheapShark
+  API_VERSION = '1.0'
+  BASE_URI = "http://www.cheapshark.com/api/#{API_VERSION}"
+end

data/lib/cheapshark/fetchers/deal_fetcher.rb

@@ -0,0 +1,14 @@
+require_relative 'fetcher.rb'
+require_relative '../models/deal.rb'
+
+module CheapShark
+  class DealFetcher < CheapShark::Fetcher
+
+    FETCHER_ENDPOINT = '/deals'
+
+    def results
+      CheapShark::Deal.new :by_id, @results
+    end
+
+  end
+end

data/lib/cheapshark/fetchers/deals_fetcher.rb

@@ -0,0 +1,14 @@
+require_relative 'fetcher.rb'
+require_relative '../models/deal.rb'
+
+module CheapShark
+  class DealsFetcher < CheapShark::Fetcher
+
+    FETCHER_ENDPOINT = '/deals'
+
+    def results
+      @results.map { |result| CheapShark::Deal.new :search, result }
+    end
+
+  end
+end

data/lib/cheapshark/fetchers/fetcher.rb

@@ -0,0 +1,25 @@
+require 'json'
+require 'uri'
+require 'httparty'
+
+require_relative '../config'
+
+module CheapShark
+
+  # Base fetcher class.
+  class Fetcher
+
+    include HTTParty
+
+    base_uri CheapShark::BASE_URI
+
+    def initialize(options)
+      @results = JSON.parse self.class.get( self.class::FETCHER_ENDPOINT, query: options ).body
+    end
+
+    def results
+      @results
+    end
+
+  end
+end

data/lib/cheapshark/fetchers/game_fetcher.rb

@@ -0,0 +1,14 @@
+require_relative 'fetcher.rb'
+require_relative '../models/game.rb'
+
+module CheapShark
+  class GameFetcher < CheapShark::Fetcher
+
+    FETCHER_ENDPOINT = '/games'
+
+    def results
+      CheapShark::Game.new :by_id, @results
+    end
+
+  end
+end

data/lib/cheapshark/fetchers/games_fetcher.rb

@@ -0,0 +1,14 @@
+require_relative 'fetcher.rb'
+require_relative '../models/game.rb'
+
+module CheapShark
+  class GamesFetcher < CheapShark::Fetcher
+
+    FETCHER_ENDPOINT = '/games'
+
+    def results
+      @results.map { |result| CheapShark::Game.new :search, result }
+    end
+
+  end
+end

data/lib/cheapshark/fetchers/stores_fetcher.rb

@@ -0,0 +1,14 @@
+require_relative 'fetcher.rb'
+require_relative '../models/store.rb'
+
+module CheapShark
+  class StoresFetcher < CheapShark::Fetcher
+
+    FETCHER_ENDPOINT = '/stores'
+
+    def results
+      @results.map { |result| CheapShark::Store.new result }
+    end
+
+  end
+end

data/lib/cheapshark/models/deal.rb

@@ -0,0 +1,48 @@
+require 'uri'
+
+module CheapShark
+  class Deal
+    attr_reader :store_id, :game_id, :name, :steam_app_id, :sale_price, :retail_price, :metacritic_score, :metacritic_link, :release_date, :publisher, :thumb, :cheaper_stores, :cheapest_price, :cheapest_date, :price, :internal_name, :deal_rating
+
+    # TODO: DRY up this abomination
+    def initialize(query_type, results)
+      case query_type
+      when :search
+        @internal_name    = results['internalName']
+        @name             = results['title']
+        @deal_id          = results['dealID'].to_i
+        @store_id         = results['storeID'].to_i
+        @game_id          = results['gameID'].to_i
+        @sale_price       = results['salePrice'].to_f
+        @retail_price     = results['normalPrice'].to_f
+        @savings          = results['savings'].to_f
+        @metacritic_score = results['metacriticScore'].to_i
+        @metacritic_link  = results['metacriticLink']
+        @release_date     = Time.at(results['releaseDate'].to_i)
+        @last_change      = Time.at(results['lastChange'].to_i)
+        @deal_rating      = results['dealRating'].to_f
+        @thumb            = results['thumb']
+      when :by_id
+        @store_id         = results['gameInfo']['storeID'].to_i
+        @game_id          = results['gameInfo']['gameID'].to_i
+        @name             = results['gameInfo']['name']
+        @steam_app_id     = results['gameInfo']['steamAppID'].to_i
+        @sale_price       = results['gameInfo']['salePrice'].to_f
+        @retail_price     = results['gameInfo']['retailPrice'].to_f
+        @metacritic_score = results['gameInfo']['metacriticScore'].to_i
+        @metacritic_link  = results['gameInfo']['metacriticLink']
+        @release_date     = Time.at(results['gameInfo']['releaseDate'].to_i)
+        @publisher        = results['gameInfo']['publisher']
+        @thumb            = results['gameInfo']['thumb']
+        @cheaper_stores   = results['cheaperStores'].map { |deal| Deal.new :game, deal }
+        @cheapest_price   = results['cheapestPrice']['price'].to_f
+        @cheapest_date    = Time.at(results['cheapestPrice']['date'].to_i)
+      when :game # derived from game object
+        @store_id     = results['storeID']
+        @deal_id      = results['dealID']
+        @price        = results['price']
+        @retail_price = results['retailPrice']
+      end
+    end
+  end
+end