gamertag 1.1.0 → 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d867e724bcb5d37345fd299a61c6b29f5147f32b
+  data.tar.gz: 661506f822872344343fec30c6dc5d93da682861
+SHA512:
+  metadata.gz: 677d6061086874b060f7617dd170faf42768892d7f65e9bf642ca9394dd453674773895668ebc90dad66cc86d8b8a25f18dedf42b826bfe306f5b8db48f85dd9
+  data.tar.gz: 02016cec46d80a5609260ddd49e1db239a2b511b784bad299e5fb82c0e378826dcbe51d5a344021a3cfb8b1bd79ec361542527ddfb22a1bd29ae57bc86fdb690

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 2.0.1 
+
+* Forgot to enable the passing of options to the client, currently only the version/adapter really, but possibly others in future.
+
+
+## 2.0.0
+
+* Completely re-written (inspired by [Octokit.rb](https://github.com/octokit/octokit.rb)), replacing a lot of old crappy code, updating to the Xbox Leaders 2.0 API throughout, dropping the XboxGamertag API and finally employing Faraday so the adapter can be configured/swapped out as the user sees fit.
+* New licence.
+
 ## 1.1.0
 
 * Added support for a gamertag's friends via `Gamertag::Friends`. 2 methods on this class, `friends` and
@@ -20,4 +30,4 @@
 
 ## 1.0.0
 
-* Initial release
+* Initial release

data/LICENSE.md

@@ -0,0 +1,11 @@
+*DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE*
+*Version 2, December 2004*
+
+Copyright (C) 2013 Baris Balic <leafybasil@gmail.com> 
+
+Everyone is permitted to copy and distribute verbatim or modified copies of this license document, and changing it is allowed as long as the name is changed.
+
+*DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE 
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION*
+
+0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,84 @@
+# Gamertag Raq [![Build Status](https://travis-ci.org/barisbalic/gamertag.png?branch=master)](https://travis-ci.org/barisbalic/gamertag) [![Dependency Status]
+
+A simple wrapper for the [Xbox Leaders](https://www.xboxleaders.com/) 2.0 API, which allows you to pull back public information about an Xbox Live user with just their Gamertag.  This includes their profile, friends, games played and achievements.
+
+## Divergence from API
+
+The Xbox Leaders API has evolved recently and will probably continue to do so now that it has more focus from it's developer.  As a result I've made some choices that may not marry up completely with the API documentation, however I feel they are sensible/idiomatic, and where reasonable I've suggested to the Xbox Leaders team that they could make changes directly to the API.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gamertag'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gamertag
+
+
+## Documentation
+
+LINK TO RDOC
+
+### Examples
+
+#### Override the adapter
+
+```ruby
+client = Gamertag::Client.new(:adapter => :em_http)
+client.profile('Major Nelson')
+```
+
+#### Retrieve a user
+
+```ruby
+Gamertag.profile('Major Nelson')
+=> #<Hashie::Mash avatar=#<Hashie::Mash full="http://avatar.xboxlive.com/avatar/Major Nelson/avatar-body.png" large="http://avatar.xboxlive.com/avatar/Major Nelson/avatarpic-l.png" small="http://avatar.xboxlive.com/avatar/Major Nelson/avatarpic-s.png"> badges=#<Hashie::Mash kinect_launch_team=true nxe_launch_team=true xbox_launch_team=true> biography="" freshness="new" gamerscore=63937 gamertag="Major Nelson" location="" motto="" name="" online=false presence="Last seen 1 minute ago playing Xbox.com" recent_activity=[#<Hashie::Mash achievements=#<Hashie::Mash current=36 total=69> artwork=#<Hashie::Mash large="http://download.xbox.com/content/images/66acd000-77fe-1000-9115-d8025454087c/1033/boxartlg.jpg" small="http://download.xbox.com/content/images/66acd000-77fe-1000-9115-d8025454087c/1033/boxartsm.jpg"> gamerscore=#<Hashie::Mash current=770 total=1625> id=1414793340 is_app=false last_played="1372305965" progress=52.2 title="Borderlands 2">, #<Hashie::Mash achievements=#<Hashie::Mash current=43 total=76> artwork=#<Hashie::Mash large="http://download.xbox.com/content/images/66acd000-77fe-1000-9115-d8024d530919/1033/boxartlg.jpg" small="http://download.xbox.com/content/images/66acd000-77fe-1000-9115-d8024d530919/1033/boxartsm.jpg"> gamerscore=#<Hashie::Mash current=825 total=1750> id=1297287449 is_app=false last_played="1372216446" progress=56.6 title="Halo 4">, #<Hashie::Mash achievements=#<Hashie::Mash current=28 total=63> artwork=#<Hashie::Mash large="http://download.xbox.com/content/images/66acd000-77fe-1000-9115-d80245410950/1033/boxartlg.jpg" small="http://download.xbox.com/content/images/66acd000-77fe-1000-9115-d80245410950/1033/boxartsm.jpg"> gamerscore=#<Hashie::Mash current=680 total=1600> id=1161890128 is_app=false last_played="1372131482" progress=44.4 title="Battlefield 3">, #<Hashie::Mash achievements=#<Hashie::Mash current=0 total=0> artwork=#<Hashie::Mash large="http://download.xbox.com/content/images/66acd000-77fe-1000-9115-d8025848085b/1033/boxartlg.jpg" small="http://download.xbox.com/content/images/66acd000-77fe-1000-9115-d8025848085b/1033/boxartsm.jpg"> gamerscore=#<Hashie::Mash current=0 total=0> id=1481115739 is_app=true last_played="1371965964" progress=0 title="Xbox Music and Video">, #<Hashie::Mash achievements=#<Hashie::Mash current=0 total=0> artwork=#<Hashie::Mash large="http://download.xbox.com/content/images/66acd000-77fe-1000-9115-d8024d530a1b/1033/boxartlg.jpg" small="http://download.xbox.com/content/images/66acd000-77fe-1000-9115-d8024d530a1b/1033/boxartsm.jpg"> gamerscore=#<Hashie::Mash current=0 total=0> id=1297287707 is_app=true last_played="1371335033" progress=0 title="Live Event Player">] reputation=20 tier="gold">
+```
+
+#### Retrieve games played by a user
+
+```ruby
+Gamertag.games('Major Nelson')
+=> [#<Hashie::Mash achievements=#<Hashie::Mash current=1 total=31> artwork=#<Hashie::Mash large="http://download.xbox.com/content/images/66acd000-77fe-1000-9115-d802415607d3/1033/boxartlg.jpg" small="http://download.xbox.com/content/images/66acd000-77fe-1000-9115-d802415607d3/1033/boxartsm.jpg"> gamerscore=#<Hashie::Mash current=5 total=1000> id=1096157139 is_app=false last_played="1132028299" progress=3.2 title="Gun">, …]
+```
+
+#### Retrieve friends of a user
+
+```ruby
+Gamertag.friends('Major Nelson')
+=> [#<Hashie::Mash gamerpic=#<Hashie::Mash large="https://avatar-ssl.xboxlive.com/avatar/allad1nsane/avatarpic-s.png" small="https://avatar-ssl.xboxlive.com/avatar/allad1nsane/avatarpic-l.png"> gamerscore=21080 gamertag="allad1nsane" last_seen="1371973384" online=false status="Last seen 6/23/2013 playing Max Payne 3">, …]
+```
+
+#### Retrieve user's achievements
+
+```ruby
+Gamertag.achievements('Major Nelson', 1414793309)
+=> [#<Hashie::Mash artwork=#<Hashie::Mash locked="https://live.xbox.com/tiles/4g/ym/0zc8P2NhbC9GWxoEGlxTWTVkL2FjaC8wL2EyAAAAAVBQUPyJDP4=.jpg" unlocked=""> description="Kill 20 enemies by knocking them off Columbia." gamerscore=25 id=36 secret=false title="Bon Voyage" unlock_date="1368255380" unlocked=true>, …]
+```
+
+
+## Contributors
+
+As of 2.0, the codebase is completely re-written, however I'd like to thank [David Czarnecki](https://github.com/czarneckid) for his contributions, especially for putting up with the original crappy code.
+
+## 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
+
+## Copyright
+
+Copyright (c) 2011-2013 Baris Balic, David Czarnecki.
+See [LICENSE][] for details.
+
+[license]: LICENSE.md

data/gamertag.gemspec

@@ -1,30 +1,30 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("lib", __FILE__)
-require "./lib/gamertag/version"
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gamertag/version'
 
-Gem::Specification.new do |s|
-  s.name        = "gamertag"
-  s.version     = Gamertag::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Baris Balic", "David Czarnecki"]
-  s.email       = ["baris@webloch.co.uk", "dczarnecki@agoragames.com"]
-  s.homepage    = "https://github.com/barisbalic/gamertag"
-  s.summary     = %q{A gem for retrieving your XBOX Live gamertag information}
-  s.description = %q{A gem for retrieving your XBOX Live gamertag information}
+Gem::Specification.new do |spec|
+  spec.name          = 'gamertag'
+  spec.version       = Gamertag::VERSION
+  spec.authors       = ['Baris Balic']
+  spec.email         = ['leafybasil@gmail.com']
+  spec.description   = %q{A wrapper for the XboxLeaders API}
+  spec.summary       = %q{A wrapper for the XboxLeaders API}
+  spec.homepage      = 'https://github.com/barisbalic/gamertag'
+  spec.licenses      = ['DWHTFYWTPL']
 
-  s.rubyforge_project = "gamertag"
+  spec.files         = %w(CHANGELOG.md LICENSE.md README.md gamertag.gemspec)
+  spec.files         += Dir.glob("lib/**/*.rb")
+  spec.files         += Dir.glob("spec/**/*")
+  spec.test_files    = Dir.glob("spec/**/*")
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-  
-  s.add_dependency('json')
-  s.add_dependency('hashie')
-  s.add_dependency('nokogiri')
+  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"]
 
-  s.add_development_dependency('rake')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('vcr')
-  s.add_development_dependency('fakeweb')
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_dependency 'faraday', '~> 0.8'
+  spec.add_dependency 'faraday_middleware', '~> 0.9'
+  spec.add_dependency 'hashie', '~> 2.0'
+  spec.add_dependency 'multi_json', '~> 1.3'
 end

data/lib/faraday/response/cleanup_xbox_leaders_naming.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'multi_json'
+
+# @api private
+module Faraday
+  class Response::CleanupXboxLeadersNaming < Response::Middleware
+    MAPPINGS = {
+      'xboxlaunchteam' => 'xbox_launch_team',
+      'kinectlaunchteam' => 'kinect_launch_team',
+      'nxelaunchteam' => 'nxe_launch_team',
+      'recentactivity' => 'recent_activity',
+      'isapp' => 'is_app',
+      'lastplayed' => 'last_played',
+      '"friend":' => '"gamertag":',
+      'lastseen' => 'last_seen',
+      'unlockdate' => 'unlock_date'
+    }
+    
+    def initialize(app = nil, options = {})
+      super(app)
+    end
+    
+    def parse(body)
+      MAPPINGS.each do |k,v|
+        body.gsub!(k, v)
+      end
+      body
+    end
+  end
+end

data/lib/faraday/response/raise_xbox_leaders_error.rb

@@ -0,0 +1,22 @@
+require 'faraday'
+require 'multi_json'
+
+# @api private
+module Faraday
+  class Response::RaiseXboxLeadersError < Response::Middleware
+    # Bit crappy but at the moment there's little to be done about it, I have
+    # suggested to vendor that the API use HTTP response codes
+    ERROR_MAP = {
+      'The gameid supplied was not valid.' => Gamertag::InvalidGameId,
+      'The gamertag supplied was not valid.' => Gamertag::InvalidGamertag,
+      'The gamertag supplied does not exist on Xbox Live.' => Gamertag::GamertagNotFound,
+      'The gamertag supplied has never played this game or does not exist on Xbox Live.' => Gamertag::AchievementNotFound,
+      "No friends found, or friend's list is set to private." => Gamertag::FriendsNotFound
+    }
+
+    def on_complete(response)
+      key = response[:body]['data']['message']
+      raise ERROR_MAP[key].new(response) if ERROR_MAP.has_key? key
+    end
+  end
+end

data/lib/gamertag.rb

@@ -1,11 +1,22 @@
-require 'net/http'
-require 'date'
-require 'json'
-require 'hashie'
-require 'nokogiri'
+require 'gamertag/configuration'
+require 'gamertag/error'
+require 'gamertag/client'
 
-require 'gamertag/simple_profile'
-require 'gamertag/friends'
-require 'gamertag/played_games'
-require 'gamertag/profile'
-require 'gamertag/version'
+module Gamertag
+  extend Configuration
+
+  class << self
+    # Alias for Gamertag::Client.new
+    #
+    # @return [Gamertag::Client]
+    def new(opts={})
+      Gamertag::Client.new(opts)
+    end
+
+    # Delegate calls to Gamertag::Client instance
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+  end
+end

data/lib/gamertag/client.rb

@@ -0,0 +1,25 @@
+require 'gamertag/connection'
+
+require 'gamertag/client/profile'
+require 'gamertag/client/games'
+require 'gamertag/client/friends'
+require 'gamertag/client/achievements'
+
+module Gamertag
+  class Client
+    attr_accessor(*Configuration::OPTION_KEYS)
+
+    def initialize(opts={})
+      options = Gamertag.options.merge(opts)
+      Configuration::OPTION_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Gamertag::Connection
+    include Gamertag::Client::Profile
+    include Gamertag::Client::Friends
+    include Gamertag::Client::Games
+    include Gamertag::Client::Achievements
+  end
+end

data/lib/gamertag/client/achievements.rb

@@ -0,0 +1,15 @@
+module Gamertag
+  class Client
+    module Achievements
+      # Retrieve the achievements for the user
+      #
+      # @see https://www.xboxleaders.com/examples/#achievements
+      # @param gamertag [string] User's gamertag
+      # @param game_id [Fixnum] The Game ID
+      # @return [Array<Hashie::Mash>] A list of achievements for the specified game
+      def achievements(gamertag, game_id)
+        get('/achievements.json', :gamertag => gamertag, :gameid => game_id).data.achievements
+      end
+    end
+  end
+end

data/lib/gamertag/client/friends.rb

@@ -0,0 +1,14 @@
+module Gamertag
+  class Client
+    module Friends
+      # Retrieve the friends of the user
+      #
+      # @see https://www.xboxleaders.com/examples/#friends
+      # @param gamertag [String] User's gamertag
+      # @return [Array<Hashie::Mash>] A list of friends
+      def friends(gamertag)
+        get('/friends.json', :gamertag => gamertag).data.friends
+      end
+    end
+  end
+end

data/lib/gamertag/client/games.rb

@@ -0,0 +1,41 @@
+module Gamertag
+  class Client
+    module Games
+      # Retrieve the games played by the user
+      #
+      # @see https://www.xboxleaders.com/examples/#games
+      # @param gamertag [String] User's gamertag
+      # @return [Array<Hashie::Mash>] List of the games played
+      def games(gamertag)
+        get('/games.json', :gamertag => gamertag).data.games
+      end
+
+      # Retrieve the potential gamerscore for the user
+      #
+      # @see https://www.xboxleaders.com/examples/#games
+      # @param gamertag [String] User's gamertag
+      # @return [Fixnum] The score the user has achieved
+      def potential_gamerscore(gamertag)
+        get('/games.json', :gamertag => gamertag).data.gamerscore.total
+      end
+
+      # Retrieve the number of achievements the user could achieve from the collection of games that they have played at some point 
+      #
+      # @see https://www.xboxleaders.com/examples/#games
+      # @param gamertag [String] User's gamertag
+      # @return [Fixnum] The potential achievement count for the user 
+      def potential_achievement_count(gamertag)
+        get('/games.json', :gamertag => gamertag).data.achievements.total
+      end
+
+      # Retrieve the number of achievements the user has actually achieved from the collection of games that they have played
+      #
+      # @see https://www.xboxleaders.com/examples/#games
+      # @param gamertag [String] User's gamertag
+      # @return [Fixnum] The actual achievement count for the user
+      def achievement_count(gamertag)
+        get('/games.json', :gamertag => gamertag).data.achievements.current
+      end
+    end
+  end
+end

data/lib/gamertag/client/profile.rb

@@ -0,0 +1,14 @@
+module Gamertag
+  class Client
+    module Profile
+      # Retrieve the profile for the user
+      #
+      # @see https://www.xboxleaders.com/examples/#profile
+      # @param gamertag [string] User's gamertag
+      # @return <Hashie::Mash> The user's profile
+      def profile(gamertag)
+        get('/profile.json', :gamertag => gamertag).data
+      end
+    end
+  end
+end

data/lib/gamertag/configuration.rb

@@ -0,0 +1,48 @@
+require 'faraday'
+require 'gamertag/version'
+
+module Gamertag
+  module Configuration
+    OPTION_KEYS = [
+        :endpoint_url,
+        :api_version,
+        :adapter
+      ]
+
+    DEFAULT_ENDPOINT_URL = 'https://www.xboxleaders.com'
+    DEFAULT_API_VERSION = '2.0'
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    attr_accessor(*OPTION_KEYS)
+
+    def self.extended(base)
+      base.defaults
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      OPTION_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def defaults
+      self.endpoint_url = DEFAULT_ENDPOINT_URL
+      self.api_version = DEFAULT_API_VERSION
+      self.adapter = DEFAULT_ADAPTER
+    end
+
+    def adapter=(adapter)
+      @adapter = adapter
+    end
+
+    def endpoint_url=(endpoint_url)
+      @endpoint_url = endpoint_url
+    end
+
+    def api_version=(api_version)
+      @api_version = api_version
+    end
+  end
+end

data/lib/gamertag/connection.rb

@@ -0,0 +1,22 @@
+require 'faraday_middleware'
+require 'faraday/response/raise_xbox_leaders_error'
+require 'faraday/response/cleanup_xbox_leaders_naming'
+
+module Gamertag
+  # @private
+  module Connection
+    def get(path, params={})
+      conn = Faraday.new(:url => endpoint_url) do |faraday|
+        faraday.use Faraday::Response::RaiseXboxLeadersError
+        faraday.use Faraday::Response::Mashify
+        faraday.use Faraday::Response::ParseJson
+        faraday.use Faraday::Response::CleanupXboxLeadersNaming
+
+        faraday.adapter adapter
+      end
+      
+      response = conn.get "/api/#{api_version}#{path}", params
+      response.body
+    end
+  end
+end