play_asia 1.0.0 → 2.0.0

data/.gitignore

@@ -1,3 +1,4 @@
+bin/
 *.sublime-*
 .idea
 *.gem

data/README.md

@@ -20,9 +20,13 @@ Or install it yourself as:
 
     api = PlayAsia::Api.new
       key: # your API key,
-      user: # your API user,
+      user: # your API user
       
-    api.listing mask: [:price, :name], type: [:game]
+    api.listing(mask: [:price, :name], type: [:game]).exec
+    # => PlayAsia::Response
+
+    api.listing(mask: [:price, :name], type: [:game]).url
+    # => http://www.play-asia.com/__api__.php?...
 
 ## Contributing
 

data/Rakefile

@@ -1,4 +1,3 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"
 require 'rake/testtask'
 

data/lib/play_asia.rb

@@ -2,7 +2,8 @@ require "play_asia/version"
 require "play_asia/response"
 require "play_asia/http_client"
 require "play_asia/api"
-require "play_asia/api_listing"
+require "play_asia/query"
+require "play_asia/listing_query"
 
 module PlayAsia
 end

data/lib/play_asia/api.rb

@@ -1,35 +1,25 @@
-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
+    query = PlayAsia::Query.new http_client
+    query.build(@headers || {}, @opts.merge(opts))
+    query
   end
-  
-  private
-  def build_url(endpoint, opts)
-    ensure_required_parameters opts
-  
-    params = opts.map { |k,v| "#{k}=#{v}" }.join '&'
-    "#{endpoint}?#{params}"
+
+  def listing(opts = {})
+    query = PlayAsia::ListingQuery.new http_client
+    query.build(@headers || {}, @opts.merge(opts))
+    query
   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]
+  private
+  def http_client
+    @http_client
   end
 end

data/lib/play_asia/{api_listing.rb → listing_query.rb}

@@ -1,13 +1,4 @@
-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
-  
+class PlayAsia::ListingQuery < PlayAsia::Query
   private
   MASK = {
     price: 'p',
@@ -318,7 +309,8 @@ class PlayAsia::Api
     us: 4
   }
   
-  def process_friendly_keys opts
+  def prepare_opts(opts)
+    opts[:query] = :listing
     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]

data/lib/play_asia/query.rb

@@ -0,0 +1,34 @@
+class PlayAsia::Query
+  attr_reader :url
+
+  def initialize(http_client)
+    @endpoint = 'http://www.play-asia.com/__api__.php'
+    @http_client = http_client
+  end
+
+  def build(headers, opts)
+    @url = build_url(@endpoint, opts)
+  end
+
+  def exec
+    PlayAsia::Response.new @http_client.request(@url, headers).read
+  end
+
+  private
+  def build_url(endpoint, opts)
+    opts = prepare_opts opts
+    ensure_required_parameters opts
+    params = opts.map { |k,v| "#{k}=#{v}" }.join '&'
+    "#{endpoint}?#{params}"
+  end
+
+  def prepare_opts(opts)
+    opts
+  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/response.rb

@@ -1,3 +1,5 @@
+require 'nokogiri'
+
 class PlayAsia::ResponseError < RuntimeError
 end
 

data/lib/play_asia/version.rb

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

data/play_asia.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = 'http://www.onthegame.com.au/about/opensource'
   
   gem.add_runtime_dependency 'nokogiri'
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'minitest-reporters'
 
   gem.files         = `git ls-files`.split($\)

data/test/test_api.rb

@@ -8,19 +8,20 @@ class ApiTest < MiniTest::Unit::TestCase
   def setup
     @api = PlayAsia::Api.new
     @http_client = StubbedHttpClient.new STUBBED_RESPONSE
-    @api.http_client = @http_client
+    def @api.http_client
+      @http_client
+    end
   end
 
   def test_query_defaults_to_using_play_asia_domain
-    @api.query key: 'api_key', user: 1, query: 'test'
+    query = @api.query(key: 'api_key', user: 1, query: 'test')
 
-    assert @http_client.last_url.start_with? 'http://www.play-asia.com/__api__.php'
+    assert query.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
+    query = @api.query(key: 'api_key', user: 1, query: 'test', a: 1, b: 2, c: 3)
+    query_string = parse_hash_from_query_string query.url.split('?').last
 
     assert_equal query_string['key'], 'api_key'
     assert_equal query_string['user'], '1'

data/test/test_api_listing.rb

@@ -4,137 +4,106 @@ require 'minitest/mock'
 require_relative 'stubs/stubbed_http_client'
 
 class ApiListingTest < MiniTest::Unit::TestCase
+  KEY = 'abc'
+  USER = 1
   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 setup
+    @api = PlayAsia::Api.new
+    @http_client = StubbedHttpClient.new OK_RESPONSE
+    def @api.http_client
+      @http_client
+    end
+  end
+
   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]
+    query = @api.listing(key: KEY, user: USER, 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]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&mask=pjmsrnilagvec&query=listing', query.url
   end
 
   def test_should_use_string_for_mask_if_given
-    api = api_with_stubbed_query
-    api.listing mask: 'string'
+    query = @api.listing key: KEY, user: USER, mask: 'string'
 
-    assert_equal 'string', api.queried_options[:mask]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&mask=string&query=listing', query.url
   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]
+    query = @api.listing key: KEY, user: USER, 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]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&type=2,3,7,8,9,4,6,1,5&query=listing', query.url
   end
 
   def test_should_use_string_for_type_if_given
-    api = api_with_stubbed_query
-    api.listing type: 'string'
+    query = @api.listing key: KEY, user: USER, type: 'string'
 
-    assert_equal 'string', api.queried_options[:type]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&type=string&query=listing', query.url
   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]
+    query = @api.listing key: KEY, user: USER, genre: [:strategy_video_game, :racing_video_game, :simulation_video_game, :tv_series_dvd_vcd]
 
-    assert_equal '10,11,12,122', api.queried_options[:genre]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&genre=10,11,12,122&query=listing', query.url
   end
 
   def test_should_use_string_for_genre_if_given
-    api = api_with_stubbed_query
-    api.listing genre: 'string'
+    query = @api.listing key: KEY, user: USER, genre: 'string'
 
-    assert_equal 'string', api.queried_options[:genre]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&genre=string&query=listing', query.url
   end
 
   def test_should_map_compatible_array_to_csv_of_integers
-    api = api_with_stubbed_query
-    api.listing compatible: [:dreamcast, :ipad]
+    query = @api.listing key: KEY, user: USER, compatible: [:dreamcast, :ipad]
 
-    assert_equal '9,111', api.queried_options[:compatible]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&compatible=9,111&query=listing', query.url
   end
 
   def test_should_use_string_for_compatible_if_given
-    api = api_with_stubbed_query
-    api.listing compatibility: 'string'
+    query = @api.listing key: KEY, user: USER, compatibility: 'string'
 
-    assert_equal 'string', api.queried_options[:compatibility]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&compatibility=string&query=listing', query.url
   end
 
   def test_should_map_encoding_array_to_csv_of_integers
-    api = api_with_stubbed_query
-    api.listing encoding: [:pal, :aac]
+    query = @api.listing key: KEY, user: USER, encoding: [:pal, :aac]
 
-    assert_equal '4,31', api.queried_options[:encoding]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&encoding=4,31&query=listing', query.url
   end
 
   def test_should_use_string_for_encoding_if_given
-    api = api_with_stubbed_query
-    api.listing encoding: 'string'
+    query = @api.listing key: KEY, user: USER, encoding: 'string'
 
-    assert_equal 'string', api.queried_options[:encoding]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&encoding=string&query=listing', query.url
   end
 
   def test_should_map_version_array_to_csv_of_integers
-    api = api_with_stubbed_query
-    api.listing version: [:asia, :hong_kong]
+    query = @api.listing key: KEY, user: USER, version: [:asia, :hong_kong]
 
-    assert_equal '6,19', api.queried_options[:version]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&version=6,19&query=listing', query.url
   end
 
   def test_should_use_version_for_encoding_if_given
-    api = api_with_stubbed_query
-    api.listing version: 'string'
+    query = @api.listing key: KEY, user: USER, version: 'string'
 
-    assert_equal 'string', api.queried_options[:version]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&version=string&query=listing', query.url
   end
 
   def test_should_map_skip_preowned_boolean_true_to_1
-    api = api_with_stubbed_query
-    api.listing skip_preowned: true
+    query = @api.listing key: KEY, user: USER, skip_preowned: true
 
-    assert_equal '1', api.queried_options[:skip_preowned]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&skip_preowned=1&query=listing', query.url
   end
 
   def test_should_map_skip_preowned_boolean_false_to_0
-    api = api_with_stubbed_query
-    api.listing skip_preowned: false
+    query = @api.listing key: KEY, user: USER, skip_preowned: false
 
-    assert_equal '0', api.queried_options[:skip_preowned]
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&skip_preowned=0&query=listing', query.url
   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
+    query = @api.listing key: KEY, user: USER, skip_preowned: 'yes'
 
-    api
+    assert_equal 'http://www.play-asia.com/__api__.php?key=abc&user=1&skip_preowned=yes&query=listing', query.url
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: play_asia
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-21 00:00:00.000000000 Z
+date: 2013-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -28,6 +28,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
@@ -58,8 +74,9 @@ files:
 - 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/listing_query.rb
+- lib/play_asia/query.rb
 - lib/play_asia/response.rb
 - lib/play_asia/version.rb
 - play_asia.gemspec
@@ -79,15 +96,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4515185138541930384
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4515185138541930384
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Play Asia API