play_asia 1.0.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 On the Game
+
+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,33 @@
+# PlayAsia
+
+A thin wrapper around the [Play Asia](http://www.play-asia.com) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'play_asia'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install play_asia
+
+## Usage
+
+    api = PlayAsia::Api.new
+      key: # your API key,
+      user: # your API user,
+      
+    api.listing mask: [:price, :name], type: [:game]
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end

data/lib/play_asia/api.rb

@@ -0,0 +1,35 @@
+require 'nokogiri'
+
+class PlayAsia::Api
+  attr_accessor :endpoint
+  attr_accessor :headers
+  attr_accessor :http_client
+
+  def initialize(opts = {})
+    @opts = opts
+    @endpoint = 'http://www.play-asia.com/__api__.php'
+    @http_client = PlayAsia::HttpClient.new
+  end
+
+  def query(opts = {})
+    opts = @opts.merge opts
+    url = build_url @endpoint, opts
+    headers = @headers || {}
+
+    PlayAsia::Response.new @http_client.request(url, headers).read
+  end
+  
+  private
+  def build_url(endpoint, opts)
+    ensure_required_parameters opts
+  
+    params = opts.map { |k,v| "#{k}=#{v}" }.join '&'
+    "#{endpoint}?#{params}"
+  end
+
+  def ensure_required_parameters opts
+    raise ArgumentError, 'Missing API key (expected :key)' unless opts[:key]
+    raise ArgumentError, 'Missing User ID (expected :user)' unless opts[:user]
+    raise ArgumentError, 'Missing Query type (expected :query)' unless opts[:query]
+  end
+end

data/lib/play_asia/api_listing.rb

@@ -0,0 +1,347 @@
+class PlayAsia::Api
+  def listing(opts = {})
+    opts = process_friendly_keys opts.merge({ query: :listing })
+    response = query opts
+    
+    raise "Query error: '#{response.error_message}'" if response.error?
+
+    response
+  end
+  
+  private
+  MASK = {
+    price: 'p',
+    barcodes: 'j',
+    manufacturer_codes: 'm',
+    sale_info: 's',
+    release_date: 'r',
+    name: 'n',
+    image: 'i',
+    url: 'l',
+    affiliate_url: 'a',
+    genre: 'g',
+    version: 'v',
+    encoding: 'e',
+    compatible: 'c'
+  }
+
+  TYPES = {
+    accessory: 2,
+    cd: 3,
+    groceries: 7,
+    apparel: 8,
+    electronics: 9,
+    movie: 4,
+    book: 6,
+    game: 1,
+    toy: 5
+  }
+
+  GENRES = {
+    strategy_video_game: 10,
+    racing_video_game: 11,
+    simulation_video_game: 12,
+    tv_series_dvd_vcd: 122,
+    enka_dvd_vcd: 123,
+    puzzle_video_game: 13,
+    music_video_game: 14,
+    language_learning_software_video_games: 147,
+    slg_video_game: 15,
+    documentary_dvd_vcd: 159,
+    classics_video_game: 16,
+    fantasy_mystery_dvd_vcd: 160,
+    musical_dvd_vcd: 161,
+    rock_pop_dvd_vcd: 162,
+    rap_hip_hop_dvd_vcd: 163,
+    western_dvd_vcd: 164,
+    oldies_dvd_vcd: 165,
+    soul_r_and_b_dvd_vcd: 166,
+    family_dvd_vcd: 167,
+    opera_dvd_vcd: 168,
+    concert_dvd_vcd: 169,
+    misc_video_game: 17,
+    heavy_metal_dvd_vcd: 170,
+    jazz_dvd_vcd: 171,
+    classical_dvd_vcd: 172,
+    folk_dvd_vcd: 173,
+    ballet_dvd_vcd: 178,
+    sports_video_dvd_vcd: 179,
+    action_video_game: 18,
+    gambling_dvd_vcd: 185,
+    adventure_video_game: 19,
+    augmented_reality_video_game: 192,
+    fighting_video_game: 2,
+    board_video_game: 20,
+    party_video_game: 21,
+    comedy_dvd_vcd: 22,
+    action_dvd_vcd: 23,
+    adult_dvd_vcd: 24,
+    crime_dvd_vcd: 25,
+    drama_dvd_vcd: 26,
+    romance_dvd_vcd: 27,
+    martial_arts_dvd_vcd: 28,
+    horror_dvd_vcd: 29,
+    beat_em_up_video_game: 3,
+    thriller_dvd_vcd: 30,
+    sci_fi_dvd_vcd: 31,
+    gambling_video_game: 32,
+    pinball_video_game: 33,
+    animation_dvd_vcd: 34,
+    ghost_dvd_vcd: 35,
+    soundtrack_music_cd: 36,
+    j_pop_music_cd: 37,
+    cantopop_music_cd: 38,
+    j_pop_dvd_vcd: 39,
+    shooting_video_game: 4,
+    video_game_soundtrack_music_cd: 40,
+    video_game_movie_dvd_vcd: 41,
+    japanese_movie_dvd_vcd: 42,
+    non_japanese_movie_dvd_vcd: 43,
+    education_dvd_vcd: 44,
+    misc_movie_dvd_vcd: 45,
+    karaoke_dvd_vcd: 46,
+    k_pop_music_cd: 47,
+    electronic_music_cd: 48,
+    dance_music_cd: 49,
+    gun_shooting_video_game: 5,
+    pop_music_cd: 50,
+    idol_movie_dvd_vcd: 54,
+    enka_music_cd: 55,
+    hentai_dvd_vcd: 57,
+    platform_video_game: 6,
+    rpg_video_game: 7,
+    action_adventure_video_game: 8,
+    sports_video_game: 9
+  }
+
+  COMPATIBILITIES = {
+    am3_advance_media_player: 23,
+    atari_jaguar: 20,
+    blackberry_bold_9900_9930: 201,
+    blackberry_torch_2_9810: 203,
+    blackberry_torch_9850_9860: 205,
+    dreamcast: 9,
+    dsi_ll_xl_japanese_only: 116,
+    famicom_disk_system: 87,
+    famicom_nes: 18,
+    gamecube: 2,
+    game_boy: 59,
+    game_boy_advance: 8,
+    game_boy_advance_sp: 39,
+    game_boy_color: 14,
+    game_boy_micro: 60,
+    game_boy_pocket: 84,
+    game_gear: 30,
+    gp2x: 61,
+    gp2x_caanoo: 112,
+    gp2x_f_200: 97,
+    gp2x_wiz: 99,
+    gp32: 10,
+    htchd7: 137,
+    htc_7_trophy: 139,
+    htc_cha_cha_a810e: 147,
+    htc_desire_hd_a9191: 120,
+    htc_evo4g: 157,
+    htc_evo_3d_x515m: 149,
+    htc_g2: 141,
+    htc_increadible_s_s710e: 143,
+    htc_one_s_z520e: 135,
+    htc_radar_c110e: 155,
+    htc_raider_4g_x710e: 151,
+    htc_rhyme_s510b: 153,
+    htc_sensation_xe_z715e: 133,
+    htc_sensation_z710e: 145,
+    ipad: 111,
+    ipad_2: 119,
+    ipad_3: 127,
+    iphone_3g: 98,
+    iphone_3gs: 114,
+    iphone_4: 115,
+    iphone_4s: 124,
+    iphone_5: 125,
+    ipod_4g_20gb: 67,
+    ipod_4g_40gb: 68,
+    ipod_5g_30gb: 63,
+    ipod_5g_60gb: 64,
+    ipod_classic_160gb: 95,
+    ipod_classic_80gb: 94,
+    ipod_mini_4gb_6gb: 66,
+    ipod_nano: 62,
+    ipod_nano_2nd_gen: 86,
+    ipod_nano_3rd_gen: 96,
+    ipod_nano_5th_gen: 109,
+    ipod_nano_6g: 131,
+    ipod_photo_30gb: 69,
+    ipod_photo_60gb: 70,
+    ipod_series: 92,
+    ipod_shuffle: 65,
+    ipod_touch: 123,
+    ipod_touch_4g: 129,
+    kindle_fire: 237,
+    kinect: 113,
+    laseractive: 103,
+    laseractive_ld_rom: 105,
+    laseractive_mega_ld: 104,
+    lcd_game: 72,
+    macbook_pro_15_inch_retina: 233,
+    macintosh: 21,
+    mark_iii: 58,
+    mega_cd: 25,
+    msx: 90,
+    neo_geo: 22,
+    neo_geo_cd: 29,
+    neo_geo_pocket: 82,
+    neo_geo_pocket_color: 16,
+    nintendo64: 4,
+    nintendo64_dd: 88,
+    nintendo_3ds: 110,
+    nintendo_3ds_ll_xl: 231,
+    nintendo_ds: 32,
+    nintendo_dsi: 102,
+    nintendo_dsi_ll_xl: 108,
+    nintendo_ds_lite: 71,
+    nintendo_mini_classics: 75,
+    nintendo_wii: 73,
+    nokia_603: 221,
+    nokia_c7: 211,
+    nokia_e6_00: 215,
+    nokia_e7_00: 213,
+    nokia_lumia_710: 207,
+    nokia_lumia_800: 209,
+    nokia_n9: 219,
+    nokia_x7_00: 217,
+    panasonic_q: 12,
+    pc_and_mac: 117,
+    pc_cd_rom: 74,
+    pc_engine_arcade_cd_rom: 79,
+    pc_engine_cd_rom: 78,
+    pc_engine_hucard: 76,
+    pc_engine_supergrafx: 83,
+    pc_engine_super_cd_rom: 77,
+    pc_engine_turbo_grafx_16: 19,
+    pc_fx: 34,
+    pico: 100,
+    pippin: 89,
+    playdia: 101,
+    playstation2: 1,
+    playstation3: 37,
+    playstation3_slim: 107,
+    playstation: 3,
+    playstation_vita: 121,
+    pocket_dream_console: 85,
+    pokemon_mini: 26,
+    samsung_galaxy_a_advance_i9070: 159,
+    samsung_galaxy_mini_2_gt_s6500: 229,
+    samsung_galaxy_note_gt_n7000: 179,
+    samsung_galaxy_r_gt_i9103: 171,
+    samsung_galaxy_sii_lte_sgh_i727: 173,
+    samsung_galaxy_sl_i9003: 167,
+    samsung_galaxy_s_captivate: 177,
+    samsung_galaxy_s_gt_i9000: 225,
+    samsung_galaxy_s_iii_gt_i9300: 227,
+    samsung_galaxy_s_ii_gt_i9100: 169,
+    samsung_galaxy_tab: 118,
+    samsung_galaxy_w_i8150: 175,
+    samsung_google_nexuss: 163,
+    samsung_gt_i9220: 181,
+    samsung_gt_i9228: 183,
+    samsung_sgh_i717: 185,
+    samsung_shv_e160k: 223,
+    samsung_shv_e160l: 191,
+    samsung_shv_e160s: 189,
+    samsung_shv_e169k: 187,
+    samsung_wave_iii_s8600: 161,
+    samsung_wave_ii_s8530: 165,
+    sega_mega_drive_sega_genesis: 24,
+    sega_saturn: 11,
+    sony_ericsson_xperia_arc: 197,
+    sony_ericsson_xperia_arc_s: 199,
+    sony_ericsson_xperia_neo: 193,
+    sony_ericsson_xperia_play: 195,
+    sony_psp: 33,
+    sony_psp_go: 106,
+    sony_psp_slim_and_lite: 93,
+    super_32x: 35,
+    super_famicom_snes: 7,
+    three_d_o: 36,
+    tomy_evio: 27,
+    virtual_boy: 31,
+    wii_u: 122,
+    windows_pc: 13,
+    wonderswan: 15,
+    wonderswan_color: 80,
+    wonderswan_crystal: 81,
+    x68000: 91,
+    xbox360: 38,
+    xbox: 6
+  }
+
+  ENCODINGS = {
+    aac: 31,
+    audio_cd: 14,
+    blu_ray_region_a: 27,
+    blu_ray_region_b: 28,
+    blu_ray_region_free: 29,
+    dvd_region_1: 6,
+    dvd_region_2: 7,
+    dvd_region_3: 8,
+    dvd_region_4: 9,
+    dvd_region_5: 10,
+    dvd_region_6: 11,
+    dvd_region_free: 5,
+    hd_dvd_region_2: 24,
+    hd_dvd_region_3: 25,
+    hd_dvd_region_free: 26,
+    no_region_protection: 13,
+    ntsc_j: 2,
+    ntsc_uc: 3,
+    pal: 4,
+    record: 30,
+    umd_music_region_2: 17,
+    umd_music_region_3: 23,
+    umd_music_region_free: 22,
+    umd_video_region_1: 20,
+    umd_video_region_2: 16,
+    umd_video_region_2_6: 21,
+    umd_video_region_3: 19,
+    umd_video_region_free: 18,
+    vcd_region_free: 12,
+    vhs_region_free: 15
+  }
+
+  VERSIONS = {
+    asia: 6,
+    european: 5,
+    hong_kong: 19,
+    japanese: 2,
+    korean: 3,
+    us: 4
+  }
+  
+  def process_friendly_keys opts
+    opts[:mask] = map_array_to_string opts[:mask], MASK if opts[:mask]
+    opts[:type] = map_array_to_string opts[:type], TYPES, ',' if opts[:type]
+    opts[:genre] = map_array_to_string opts[:genre], GENRES, ',' if opts[:genre]
+    opts[:compatible] = map_array_to_string opts[:compatible], COMPATIBILITIES, ',' if opts[:compatible]
+    opts[:encoding] = map_array_to_string opts[:encoding], ENCODINGS, ',' if opts[:encoding]
+    opts[:version] = map_array_to_string opts[:version], VERSIONS, ',' if opts[:version]
+
+    # map true/false literals to 1/0
+    opts.each do |key, value|
+      if value == true
+        opts[key] = '1'
+      elsif value == false
+        opts[key] = '0'
+      end
+    end
+
+    opts
+  end
+
+  def map_array_to_string(values, map, join_string = nil)
+    if values && values.is_a?(Array)
+      return values.flatten.map { |k| map[k] || k }.join join_string
+    end
+    values
+  end
+end

data/lib/play_asia/http_client.rb

@@ -0,0 +1,7 @@
+require 'open-uri'
+
+class PlayAsia::HttpClient
+  def request(url, options)
+    open url, *options
+  end
+end

data/lib/play_asia/response.rb

@@ -0,0 +1,70 @@
+class PlayAsia::ResponseError < RuntimeError
+end
+
+class PlayAsia::Response
+  attr_reader :raw_text, :status, :items, :content
+
+  def initialize(text)
+    @raw_text = text
+    @parsed = Nokogiri::XML.parse text
+  
+    parse_content
+  end
+
+  def error?
+    status[:error] != '0'
+  end
+
+  def error_message
+    status[:errorstring]
+  end
+
+  def start
+    status[:start] ? status[:start].to_i : 0
+  end
+
+  def total_items
+    status[:total_items] ? status[:total_items].to_i : nil
+  end
+
+  def items_count
+    status[:items] ? status[:items].to_i : nil
+  end
+
+  def has_more?
+    raise "Unknown total number of items" if total_items.nil?
+    start + items.size < total_items
+  end
+
+  def complete?
+    !has_more?
+  end
+
+  private
+  def parse_content
+    @status = parse_status
+    @content = @parsed.at 'content'
+    @items = parse_items
+
+    raise PlayAsia::ResponseError, "status/items not found.\n#{status}" unless items_count || error?
+    raise PlayAsia::ResponseError, "Unexpected number of items #{@items.size} instead of #{items_count}" if !error? && @items.size < items_count
+  end
+
+  def parse_status
+    dumb_xml_to_hash @parsed.at('status')
+  end
+
+  def parse_items
+    content.search('item').map do |xml|
+      dumb_xml_to_hash xml
+    end
+  end
+
+  def dumb_xml_to_hash(xml)
+    hash = {}
+    xml.search('*').each do |node|
+      hash[node.name.downcase.to_sym] = node.text
+    end
+    hash
+  end
+end

data/lib/play_asia/version.rb

@@ -0,0 +1,3 @@
+module PlayAsia
+  VERSION = '1.0.0'
+end

data/lib/play_asia.rb

@@ -0,0 +1,8 @@
+require "play_asia/version"
+require "play_asia/response"
+require "play_asia/http_client"
+require "play_asia/api"
+require "play_asia/api_listing"
+
+module PlayAsia
+end

data/play_asia.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/play_asia/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['James Gregory', 'On the Game']
+  gem.email         = ['james@onthegame.com.au']
+  gem.description   = 'A thin wrapper around the Play Asia API'
+  gem.summary       = 'Play Asia API'
+  gem.homepage      = 'http://www.onthegame.com.au/about/opensource'
+  
+  gem.add_runtime_dependency 'nokogiri'
+  gem.add_development_dependency 'minitest-reporters'
+
+  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.name          = 'play_asia'
+  gem.require_paths = ["lib"]
+  gem.version       = PlayAsia::VERSION
+end

data/test/stubs/stubbed_http_client.rb

@@ -0,0 +1,25 @@
+class StubbedHttpClient
+  attr_reader :last_url, :last_options
+
+  def initialize response
+    @response = response
+  end
+
+  def request url, options
+    @last_url = url
+    @last_options = options
+    
+    StubFileResponse.new @response
+  end
+
+  private
+  class StubFileResponse
+    def initialize content
+      @content = content
+    end
+
+    def read
+      @content
+    end
+  end
+end

data/test/test_api.rb

@@ -0,0 +1,63 @@
+require 'minitest/autorun'
+require 'play_asia'
+require_relative 'stubs/stubbed_http_client'
+
+class ApiTest < MiniTest::Unit::TestCase
+  STUBBED_RESPONSE = '<message><status><query>test</query><error>0</error><errorstring /><items>1</items></status><content><item>1</item></content></message>'
+
+  def setup
+    @api = PlayAsia::Api.new
+    @http_client = StubbedHttpClient.new STUBBED_RESPONSE
+    @api.http_client = @http_client
+  end
+
+  def test_query_defaults_to_using_play_asia_domain
+    @api.query key: 'api_key', user: 1, query: 'test'
+
+    assert @http_client.last_url.start_with? 'http://www.play-asia.com/__api__.php'
+  end
+
+  def test_query_uses_arguments_as_query_string
+    @api.query key: 'api_key', user: 1, query: 'test', a: 1, b: 2, c: 3
+    url = @http_client.last_url
+    query_string = parse_hash_from_query_string url.split('?').last
+
+    assert_equal query_string['key'], 'api_key'
+    assert_equal query_string['user'], '1'
+    assert_equal query_string['query'], 'test'
+    assert_equal query_string['a'], '1'
+    assert_equal query_string['b'], '2'
+    assert_equal query_string['c'], '3'
+  end
+
+  def test_query_raises_if_no_key_given
+    ex = assert_raises ArgumentError do
+      @api.query user: 1, query: 'test'
+    end
+    assert_equal ex.message, 'Missing API key (expected :key)'
+  end
+
+  def test_query_raises_if_no_user_given
+    ex = assert_raises ArgumentError do
+      @api.query key: 'api_key', query: 'test'
+    end
+    assert_equal ex.message, 'Missing User ID (expected :user)'
+  end
+
+  def test_query_raises_if_no_query_name_given
+    ex = assert_raises ArgumentError do
+      @api.query key: 'api_key', user: 1
+    end
+    assert_equal ex.message, 'Missing Query type (expected :query)'
+  end
+
+  private
+  def parse_hash_from_query_string query_string
+    hash = {}
+    query_string.split('&').each do |pair|
+      key,value = pair.split '='
+      hash[key] = value
+    end
+    hash
+  end
+end

data/test/test_api_listing.rb

@@ -0,0 +1,140 @@
+require 'minitest/autorun'
+require 'play_asia'
+require 'minitest/mock'
+require_relative 'stubs/stubbed_http_client'
+
+class ApiListingTest < MiniTest::Unit::TestCase
+  OK_RESPONSE = PlayAsia::Response.new '<message><status><query>test</query><error>0</error><errorstring /><items>1</items></status><content><item>1</item></content></message>'
+
+  def test_should_map_mask_array_to_string
+    api = api_with_stubbed_query
+    api.listing mask: [:price, :barcodes, :manufacturer_codes, :sale_info, :release_date, :name, :image,
+                       :url, :affiliate_url, :genre, :version, :encoding, :compatible]
+
+    assert_equal 'pjmsrnilagvec', api.queried_options[:mask]
+  end
+
+  def test_should_use_string_for_mask_if_given
+    api = api_with_stubbed_query
+    api.listing mask: 'string'
+
+    assert_equal 'string', api.queried_options[:mask]
+  end
+
+  def test_should_map_type_array_to_csv_of_integers
+    api = api_with_stubbed_query
+    api.listing type: [:accessory, :cd, :groceries, :apparel, :electronics, :movie, :book, :game, :toy]
+
+    assert_equal '2,3,7,8,9,4,6,1,5', api.queried_options[:type]
+  end
+
+  def test_should_use_string_for_type_if_given
+    api = api_with_stubbed_query
+    api.listing type: 'string'
+
+    assert_equal 'string', api.queried_options[:type]
+  end
+
+  def test_should_map_genre_array_to_csv_of_integers
+    api = api_with_stubbed_query
+    api.listing genre: [:strategy_video_game, :racing_video_game, :simulation_video_game, :tv_series_dvd_vcd]
+
+    assert_equal '10,11,12,122', api.queried_options[:genre]
+  end
+
+  def test_should_use_string_for_genre_if_given
+    api = api_with_stubbed_query
+    api.listing genre: 'string'
+
+    assert_equal 'string', api.queried_options[:genre]
+  end
+
+  def test_should_map_compatible_array_to_csv_of_integers
+    api = api_with_stubbed_query
+    api.listing compatible: [:dreamcast, :ipad]
+
+    assert_equal '9,111', api.queried_options[:compatible]
+  end
+
+  def test_should_use_string_for_compatible_if_given
+    api = api_with_stubbed_query
+    api.listing compatibility: 'string'
+
+    assert_equal 'string', api.queried_options[:compatibility]
+  end
+
+  def test_should_map_encoding_array_to_csv_of_integers
+    api = api_with_stubbed_query
+    api.listing encoding: [:pal, :aac]
+
+    assert_equal '4,31', api.queried_options[:encoding]
+  end
+
+  def test_should_use_string_for_encoding_if_given
+    api = api_with_stubbed_query
+    api.listing encoding: 'string'
+
+    assert_equal 'string', api.queried_options[:encoding]
+  end
+
+  def test_should_map_version_array_to_csv_of_integers
+    api = api_with_stubbed_query
+    api.listing version: [:asia, :hong_kong]
+
+    assert_equal '6,19', api.queried_options[:version]
+  end
+
+  def test_should_use_version_for_encoding_if_given
+    api = api_with_stubbed_query
+    api.listing version: 'string'
+
+    assert_equal 'string', api.queried_options[:version]
+  end
+
+  def test_should_map_skip_preowned_boolean_true_to_1
+    api = api_with_stubbed_query
+    api.listing skip_preowned: true
+
+    assert_equal '1', api.queried_options[:skip_preowned]
+  end
+
+  def test_should_map_skip_preowned_boolean_false_to_0
+    api = api_with_stubbed_query
+    api.listing skip_preowned: false
+
+    assert_equal '0', api.queried_options[:skip_preowned]
+  end
+
+  def test_should_allow_string_for_skip_preowned
+    api = api_with_stubbed_query
+    api.listing skip_preowned: 'yes'
+
+    assert_equal 'yes', api.queried_options[:skip_preowned]
+  end
+
+  def test_should_only_use_supplied_parameters_and_query
+    api = api_with_stubbed_query
+    api.listing type: [:game], mask: [:name]
+
+    refute_nil api.queried_options[:type]
+    refute_nil api.queried_options[:mask]
+    assert_equal [:type, :mask, :query], api.queried_options.keys
+  end
+
+  private
+  def api_with_stubbed_query
+    api = PlayAsia::Api.new
+
+    # overwrite the query method so we can grab the options passed to it
+    class << api
+      attr_reader :queried_options
+
+      def query(opts = {})
+        @queried_options = opts
+        OK_RESPONSE
+      end
+    end
+
+    api
+  end
+end

data/test/test_response.rb

@@ -0,0 +1,120 @@
+require 'minitest/autorun'
+require 'play_asia'
+
+class ResponseTest < MiniTest::Unit::TestCase
+  def test_should_have_error_when_error_in_status
+    assert error_response.error?
+  end
+
+  def test_should_have_error_message_when_errorstring_in_status
+    error_message = 'I am an error!'
+
+    assert_equal error_message, error_response_with_errorstring(error_message).error_message
+  end
+
+  def test_have_more_should_be_true_if_number_of_items_is_less_than_total_items
+    assert ok_response_with_paged_items.has_more?
+    refute ok_response_with_paged_items.complete?
+  end
+
+  def test_have_more_should_be_false_if_number_of_items_is_greater_or_equal_to_total_items
+    refute ok_response_with_all_items.has_more?
+    assert ok_response_with_all_items.complete?
+  end
+
+  def test_have_more_should_be_true_if_number_of_items_is_less_than_total_items_with_start_offset
+    assert ok_response_with_paged_items_page_two.has_more?
+    refute ok_response_with_paged_items_page_two.complete?
+  end
+
+  def test_have_more_should_be_false_if_number_of_items_is_greater_or_equal_to_total_items_with_start_offset
+    refute ok_response_with_paged_items_page_three.has_more?
+    assert ok_response_with_paged_items_page_three.complete?
+  end
+
+  private
+  def error_response
+    PlayAsia::Response.new '<message><status><error>1</error></status><content /></message>'
+  end
+
+  def error_response_with_errorstring(error_string)
+    PlayAsia::Response.new "<message><status><error>1</error><errorstring>#{error_string}</errorstring></status><content /></message>"
+  end
+
+  def ok_response_with_paged_items
+    PlayAsia::Response.new <<RESPONSE
+<message>
+  <status>
+    <error>0</error>
+    <errorstring />
+    <total_items>3</total_items>
+    <items>1</items>
+  </status>
+  <content>
+    <item>
+      <name>one</name>
+    </item>
+  </content>
+</message>
+RESPONSE
+  end
+
+  def ok_response_with_paged_items_page_two
+    PlayAsia::Response.new <<RESPONSE
+<message>
+  <status>
+    <error>0</error>
+    <errorstring />
+    <start>1</start>
+    <total_items>3</total_items>
+    <items>1</items>
+  </status>
+  <content>
+    <item>
+      <name>two</name>
+    </item>
+  </content>
+</message>
+RESPONSE
+  end
+
+  def ok_response_with_paged_items_page_three
+    PlayAsia::Response.new <<RESPONSE
+<message>
+  <status>
+    <error>0</error>
+    <errorstring />
+    <start>2</start>
+    <total_items>3</total_items>
+    <items>1</items>
+  </status>
+  <content>
+    <item>
+      <name>three</name>
+    </item>
+  </content>
+</message>
+RESPONSE
+  end
+
+  def ok_response_with_all_items
+    PlayAsia::Response.new <<RESPONSE
+<message>
+  <status>
+    <error>0</error>
+    <errorstring />
+    <total_items>2</total_items>
+    <items>2</items>
+  </status>
+  <content>
+    <item>
+      <name>one</name>
+    </item>
+    <item>
+      <name>two</name>
+    </item>
+  </content>
+</message>
+RESPONSE
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: play_asia
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- James Gregory
+- On the Game
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A thin wrapper around the Play Asia API
+email:
+- james@onthegame.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/play_asia.rb
+- lib/play_asia/api.rb
+- lib/play_asia/api_listing.rb
+- lib/play_asia/http_client.rb
+- lib/play_asia/response.rb
+- lib/play_asia/version.rb
+- play_asia.gemspec
+- test/stubs/stubbed_http_client.rb
+- test/test_api.rb
+- test/test_api_listing.rb
+- test/test_response.rb
+homepage: http://www.onthegame.com.au/about/opensource
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Play Asia API
+test_files:
+- test/stubs/stubbed_http_client.rb
+- test/test_api.rb
+- test/test_api_listing.rb
+- test/test_response.rb