rr_games_radar 1.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ash
+
+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,104 @@
+# GamesRadarApi
+
+This gem is a fully featured API wrapper for the Games Radar API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'games_radar_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install games_radar_api
+
+## Configuration
+
+You can use a block configuration to specify the API key. e.g.
+
+    GamesRadarApi.configure do |config|
+      config.api_key = "YOUR_CLIENT_ID"
+    end
+
+
+## Usage
+
+To start using the GamesRadarAPI just initialize the client and start requesting. e.g.
+
+    require 'games_radar_api'
+
+    client =   GamesRadarApi.client(:api_key=>'<YOUR_API_KEY>')
+    # search for games called Darksiders on the XBOX 360
+    response = client.game_search('Darksiders','xbox360')
+
+The following methods are available to you:
+
+    games(options={:platform=>'all',:genre=>'all',:page_num=>1,:page_size=>10,:sort=>'newest'})
+
+    game(id)
+
+    game_search(query,platform,options={:region=>'us'})
+
+    game_cheats(id,options={:region=>'us',:page_num=>1,:page_size=>10,:content=>'all_cheat'})
+
+    game_guides(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+
+    game_news(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+
+    game_features(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+
+    game_previews(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+
+    game_reviews(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+
+    game_screenshots(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+
+    game_videos(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+
+    cheats(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+
+    developers()
+
+    franchises()
+
+    genres()
+
+    guides(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+
+    news(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+
+    features(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+
+    previews(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+
+    reviews(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+
+    platforms()
+
+    publishers()
+
+    screenshots(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:unique_game=>false,:page_num=>1,:page_size=>10,:sort=>'newest'})
+
+    videos(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+
+Each request returns an array of Hashie Mash objects which you can then manipulate in any way that you wish.
+
+### NOTE
+
+Please note that during testing I found that elements of the Games Radar API don't work as expected.  Here's a few of the issues that I found:
+
+1. news - this method returns total_rows but the not the articles themselves
+1. game_features, game_previews, game_reviews and game_news - returns total_rows but not the articles
+1. game - this method fetches information about the game, but I'm yet to find a game with a thumbnail image, and the empty_logo image they send returns a 404
+1. videos and game_videos - whilst the API call works, visiting the video URL in the URL attribute always goes to a 404 page
+1. screenshots and game_screenshots - no data is returned
+
+It's also recommended that you look through the Games Radar API Documentation for a clearer idea of the parameters values which each method accepts http://dl.gamesradar.com/api/GamesRadar_Developer_API_Documentation.pdf
+
+## Credits
+
+This gem is created by Cube Websites

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.test_files = FileList['spec/lib/games_radar_api/*_spec.rb','spec/lib/games_radar_api/client/*_spec.rb']
+  test.verbose = true
+end
+
+task :default => :test

data/games_radar_api.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'games_radar_api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rr_games_radar"
+  gem.version       = GamesRadarApi::VERSION
+  gem.authors       = ["Rodrigo Martins"]
+  gem.email         = ["rodrigo@rrmartins.com"]
+  gem.description   = "Gem for interaction with the API of GamesRadar."
+  gem.summary       = "This gem is for interaction with the API of GamesRadar."
+  gem.homepage      = "https://github.com/rrmartins/games_radar_api"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency('faraday_middleware', '~> 0.8')
+  gem.add_runtime_dependency('faraday', ['>= 0.7', '< 0.9'])
+  gem.add_runtime_dependency('multi_xml', '>= 0.5.1')
+  gem.add_runtime_dependency('hashie',  '>= 0.4.0')
+
+  gem.add_development_dependency('turn', '~> 0.9.6')
+  gem.add_development_dependency('rake', '~> 0.9.2.2')
+
+end

data/lib/faraday/raise_http_exception.rb

@@ -0,0 +1,51 @@
+require 'faraday'
+
+# @private
+module FaradayMiddleware
+  # @private
+  class RaiseHttpException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response[:status].to_i
+          when 400
+            raise GamesRadarApi::BadRequest, error_message_400(response)
+          when 404
+            raise GamesRadarApi::NotFound, error_message_400(response)
+          when 500
+            raise GamesRadarApi::InternalServerError, error_message_500(response, "Something is technically wrong.")
+          when 503
+        end
+      end
+    end
+
+
+    def initialize(app)
+      super app
+      @parser = nil
+    end
+
+    private
+
+    def error_message_400(response)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{error_body(response[:body])}"
+    end
+
+    def error_body(body)
+      # body gets passed as a string, not sure if it is passed as something else from other spots?
+      if not body.nil? and not body.empty? and body.kind_of?(String)
+        # removed multi_json thanks to wesnolte's commit
+        body = MultiXml.parse(body)
+      end
+
+      if body.nil?
+        nil
+      elsif body['error'] and body['error']['messages'] and body['error']['messages']['message'] and not body['error']['messages']['message'].empty?
+        ": #{body['error']['messages']['message']}"
+      end
+    end
+
+    def error_message_500(response, body=nil)
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{[response[:status].to_s + ':', body].compact.join(' ')}"
+    end
+  end
+end

data/lib/games_radar_api/api.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../connection', __FILE__)
+require File.expand_path('../request', __FILE__)
+require File.expand_path('../configuration', __FILE__)
+
+module GamesRadarApi
+  # @private
+  class API
+    # @private
+    attr_accessor *Configuration::VALID_CONFIG_KEYS + [:total_rows]
+
+    # Creates a new API
+    def initialize(options={})
+      options = GamesRadarApi.options.merge(options)
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Connection
+    include Request
+  end
+end

data/lib/games_radar_api/client/cheats.rb

@@ -0,0 +1,18 @@
+module GamesRadarApi
+  class Client
+    module Cheats
+      def cheats(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+         response = get('/cheats',options)
+         self.total_rows = response.cheats.total_rows.to_i
+         response.cheats.cheat
+      end
+
+      def game_cheats(id,options={:region=>'us',:page_num=>1,:page_size=>10,:content=>'all_cheat'})
+        response = get("/game/cheats/#{id}",options)
+        self.total_rows = response.cheats.total_rows.to_i
+        response.cheats.cheat
+      end
+
+    end
+  end
+end

data/lib/games_radar_api/client/developers.rb

@@ -0,0 +1,9 @@
+module GamesRadarApi
+  class Client
+    module Developers
+      def developers
+        get('/developers').developers.company
+      end
+    end
+  end
+end

data/lib/games_radar_api/client/franchises.rb

@@ -0,0 +1,9 @@
+module GamesRadarApi
+  class Client
+    module Franchises
+      def franchises
+        get('/franchises').franchises.franchise
+      end
+    end
+  end
+end

data/lib/games_radar_api/client/games.rb

@@ -0,0 +1,61 @@
+module GamesRadarApi
+  class Client
+    module Games
+      def games(options={:platform=>'all',:genre=>'all',:page_num=>1,:page_size=>10,:sort=>'newest'})
+        response = get('/games',options)
+        self.total_rows = response.games.total_rows.to_i
+        unless response.game.nil? or response.game.id.nil?
+          if response.game.name.include?("us")
+            response.game.name = response.game.name.us
+          end
+        end
+        response.games.game
+      end
+
+      def game(id)
+        response = get("/game/#{id}")
+        self.total_rows = response.total_rows.to_i
+        unless response.game.nil? or response.game.id.nil?
+          if response.game.name.nil?
+            response.game.name = nil
+          elsif response.game.name.include?("us")
+            response.game.name = response.game.name.us
+          end
+
+          if response.game.release_date.nil?
+            response.game[:release_date] = nil
+          end
+
+          if response.game.platform.nil?
+            response.game[:platform] = nil
+          elsif response.game.platform.include?("name")
+            response.game[:platform] = response.game.platform.name
+          end
+
+          if response.game.genre.nil?
+            response.game[:genre] = nil
+          elsif response.game.genre.include?("name")
+            response.game[:genre] = response.game.genre.name
+          end
+
+          if response.game.publishers.nil?
+            response.game[:publishers] = nil
+          elsif response.game.publishers.include?("us")
+            response.game[:publishers] = response.game.publishers.us
+          end
+
+        end
+
+        return response.game unless response.game.nil? or response.game.id.nil?
+        return nil
+      end
+
+      def game_search(query,platform,options={:region=>'us'})
+        response = get("/search/gameName/#{platform}/#{query}",options)
+        self.total_rows = response.games.total_rows.to_i
+        response.games.game
+      end
+
+    end
+  end
+end

data/lib/games_radar_api/client/genres.rb

@@ -0,0 +1,9 @@
+module GamesRadarApi
+  class Client
+    module Genres
+      def genres
+        get('/genres').genres.genre
+      end
+    end
+  end
+end

data/lib/games_radar_api/client/guides.rb

@@ -0,0 +1,18 @@
+module GamesRadarApi
+  class Client
+    module Guides
+      def guides(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+         response = get('/guidesandfaqs',options)
+         self.total_rows = response.cheats.total_rows.to_i
+         response.cheats.cheat
+      end
+
+      def game_guides(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+        response = get("/game/guidesandfaqs/#{id}",options)
+        self.total_rows = response.cheats.total_rows.to_i
+        response.cheats.cheat
+      end
+
+    end
+  end
+end

data/lib/games_radar_api/client/news.rb

@@ -0,0 +1,44 @@
+module GamesRadarApi
+  class Client
+    module News
+      puts "NOTE: Tested the News API on 26 September 2012 and it wasn't returning any articles, just a number of rows"
+      puts "This module will therefore appear in this gem, but please don't be suprised if it doesn't work"
+      def news(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+         response = get('/news',options)
+         self.total_rows = response.articles.total_rows.to_i
+         response.articles.article
+      end
+
+      def features(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+        response = get('/features',options)
+        self.total_rows = response.articles.total_rows.to_i
+        response.articles.article
+      end
+
+      def game_news(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+        response = get("/game/news/#{id}",options)
+        self.total_rows = response.articles.total_rows.to_i
+        response.articles.article
+      end
+
+      def game_features(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+        response = get("/game/features/#{id}",options)
+        self.total_rows = response.articles.total_rows.to_i
+        response.articles.article
+      end
+
+      def game_previews(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+        response = get("/game/previews/#{id}",options)
+        self.total_rows = response.articles.total_rows.to_i
+        response.articles.article
+      end
+
+      def game_reviews(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+        response = get("/game/reviews/#{id}",options)
+        self.total_rows = response.articles.total_rows.to_i
+        response.articles.article
+      end
+
+    end
+  end
+end

data/lib/games_radar_api/client/platforms.rb

@@ -0,0 +1,9 @@
+module GamesRadarApi
+  class Client
+    module Platforms
+      def platforms
+        get('/platforms').platforms.platform
+      end
+    end
+  end
+end

data/lib/games_radar_api/client/publishers.rb

@@ -0,0 +1,9 @@
+module GamesRadarApi
+  class Client
+    module Publishers
+      def publishers
+        get('/publishers').publishers.company
+      end
+    end
+  end
+end

data/lib/games_radar_api/client/screenshots.rb

@@ -0,0 +1,20 @@
+module GamesRadarApi
+  class Client
+    module Screenshots
+      def screenshots(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:unique_game=>false,:page_num=>1,:page_size=>10,:sort=>'newest'})
+        puts "NOTE: Tested the Screenshot API on 26 September 2012 and it wasn't returning any rows"
+        puts "This module will therefore appear in this gem, but please don't be suprised if it doesn't work"
+         response = get('/screenshots',options)
+         self.total_rows = response.screenshots.total_rows.to_i
+         response.screenshots.screenshot
+      end
+
+      def game_screenshots(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+        response = get("/game/screenshots/#{id}",options)
+        self.total_rows = response.screenshots.total_rows.to_i
+        response.screenshots.screenshot
+      end
+
+    end
+  end
+end

data/lib/games_radar_api/client/videos.rb

@@ -0,0 +1,18 @@
+module GamesRadarApi
+  class Client
+    module Videos
+      def videos(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+         response = get('/videos',options)
+         self.total_rows = response.videos.total_rows.to_i
+         response.videos.video
+      end
+
+      def game_videos(id,options={:region=>'us',:page_num=>1,:page_size=>10})
+        response = get("/game/videos/#{id}",options)
+        self.total_rows = response.videos.total_rows.to_i
+        response.videos.video
+      end
+
+    end
+  end
+end

data/lib/games_radar_api/client.rb

@@ -0,0 +1,18 @@
+module GamesRadarApi
+  class Client < API
+    Dir[File.expand_path('../client/*.rb',__FILE__)].each{ |f| require f }
+
+    include GamesRadarApi::Client::Cheats
+    include GamesRadarApi::Client::Developers
+    include GamesRadarApi::Client::Franchises
+    include GamesRadarApi::Client::Games
+    include GamesRadarApi::Client::Genres
+    include GamesRadarApi::Client::Guides
+    include GamesRadarApi::Client::News
+    include GamesRadarApi::Client::Platforms
+    include GamesRadarApi::Client::Publishers
+    include GamesRadarApi::Client::Screenshots
+    include GamesRadarApi::Client::Videos
+
+  end # Client
+end

data/lib/games_radar_api/configuration.rb

@@ -0,0 +1,51 @@
+require 'faraday'
+require File.expand_path('../version', __FILE__)
+
+module GamesRadarApi
+  module Configuration
+    VALID_CONNECTION_KEYS   = [:adapter,:endpoint,:user_agent,:method,:proxy].freeze
+    VALID_OPTIONS_KEYS      = [:api_key,:format].freeze
+    VALID_CONFIG_KEYS       = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+
+    DEFAULT_ADAPTER         = Faraday.default_adapter.freeze
+    DEFAULT_ENDPOINT        = 'http://api.gamesradar.com'.freeze
+    DEFAULT_METHOD          = 'get'.freeze
+    DEFAULT_USER_AGENT      = "Games Radar API Gem #{GamesRadarApi::VERSION}".freeze
+
+    DEFAULT_API_KEY         = nil
+    DEFAULT_FORMAT          = :xml
+    DEFAULT_PROXY           = nil
+
+    # Build accessor methods for every config options so we can do this, for example:
+    # GamesRadarApi.format = :xml
+    attr_accessor *VALID_CONFIG_KEYS
+
+    # Make sure we have the default values set when we get 'extended'
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in  a block
+    def configure
+      yield self
+    end
+
+    # Create a has of options and their values
+    def options
+      Hash[* VALID_CONFIG_KEYS.map { |key| [key,send(key)] }.flatten ]
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter    = DEFAULT_ADAPTER
+      self.endpoint   = DEFAULT_ENDPOINT
+      self.method     = DEFAULT_METHOD
+      self.user_agent = DEFAULT_USER_AGENT
+
+      self.api_key    = DEFAULT_API_KEY
+      self.format     = DEFAULT_FORMAT
+      self.proxy      = DEFAULT_PROXY
+    end
+
+  end
+end

data/lib/games_radar_api/connection.rb

@@ -0,0 +1,32 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module GamesRadarApi
+  # @private
+  module Connection
+    private
+
+    def connection(raw=false)
+      options = {
+          :headers => {'Accept' => "application/#{format}; charset=utf-8", 'User-Agent' => user_agent},
+          :proxy => proxy,
+          :ssl => {:verify => false},
+          :url => endpoint,
+      }
+
+      Faraday::Connection.new(options) do |connection|
+        #connection.use FaradayMiddleware::OAuth2, client_id, access_token
+        connection.use Faraday::Request::UrlEncoded
+        connection.use FaradayMiddleware::Mashify unless raw
+        unless raw
+          case format.to_s.downcase
+            when 'json' then connection.use Faraday::Response::ParseJson
+            when 'xml' then connection.use Faraday::Response::ParseXml
+          end
+        end
+        connection.use FaradayMiddleware::RaiseHttpException
+        connection.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/games_radar_api/error.rb

@@ -0,0 +1,19 @@
+module GamesRadarApi
+  # Custom error class for rescuing from all Instagram errors
+  class Error < StandardError; end
+
+  # Raised when Instagram returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Instagram returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Instagram returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Instagram returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+
+  # Raised when a subscription payload hash is invalid
+  class InvalidSignature < Error; end
+end

data/lib/games_radar_api/request.rb

@@ -0,0 +1,42 @@
+module GamesRadarApi
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={}, raw=false, unformatted=false)
+      request(:get, path, options, raw, unformatted)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={}, raw=false, unformatted=false)
+      request(:post, path, options, raw, unformatted)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={}, raw=false, unformatted=false)
+      request(:put, path, options, raw, unformatted)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={}, raw=false, unformatted=false)
+      request(:delete, path, options, raw, unformatted)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options, raw=false, unformatted=false)
+      options = options.merge(:api_key=>api_key)
+      options.delete_if { |k, v| v.nil? or v.eql?'' }
+      response = connection(raw).send(method) do |request|
+        case method
+          when :get, :delete
+            request.url(path, options)
+          when :post, :put
+            request.path = path
+            request.body = options unless options.empty?
+        end
+      end
+      raw ? response : response.body
+    end
+  end
+end