games_radar_api 1.0.0

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,4 @@
+source 'https://rubygems.org'
+
+# 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,46 @@
+# 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')
+
+Each request returns an array of Hashie objects which you can then manipulate in any way that you wish.
+
+For a full list of available request methods have a look through the lib/games_radar_api/client directory
+
+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          = "games_radar_api"
+  gem.version       = GamesRadarApi::VERSION
+  gem.authors       = ["Cube Websites"]
+  gem.email         = ["mail@cubewebsites.com"]
+  gem.description   = "Allows interaction with the Games Radar API"
+  gem.summary       = "This gem is created for developers to easily access all features of the Games Radar API"
+  gem.homepage      = "https://github.com/cubewebsites/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.rb

@@ -0,0 +1,26 @@
+Dir[File.dirname(__FILE__) + '/games_radar_api/*.rb'].each do |file|
+  require file
+end
+
+module GamesRadarApi
+     extend Configuration
+
+     # Alias for GamesRadarApi::Client.new
+     #
+     # @return [GamesRadarApi::Client]
+     def self.client(options={})
+       GamesRadarApi::Client.new(options)
+     end
+
+     # Delegate to GamesRadarApi::Client
+     def self.method_missing(method, *args, &block)
+       return super unless client.respond_to?(method)
+       client.send(method, *args, &block)
+     end
+
+     # Delegate to GamesRadarApi::Client
+     def self.respond_to?(method)
+       return client.respond_to?(method) || super
+     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.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/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,25 @@
+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
+         response.games.game
+      end
+
+      def game(id)
+        response = get("/game/#{id}")
+        self.total_rows = response.total_rows.to_i
+        return response.game unless 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,57 @@
+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 previews(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+        response = get('/previews',options)
+        self.total_rows = response.articles.total_rows.to_i
+        response.articles.article
+      end
+
+      def reviews(options={:region=>'us',:platform=>'all',:genre=>'all',:game_name=>'',:page_num=>1,:page_size=>10,:sort=>'newest'})
+        response = get('/reviews',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