xbox-api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a9799eca21451dc50be15e540c1e2af8f27c638
+  data.tar.gz: 7547068dd904d54af98f4573c3415d22f1f35434
+SHA512:
+  metadata.gz: 418a667bbafffff28a9cc230f644e87c7f28b0a14aa9fc5ecfdf0985cc2b9b82bbf33a0f4fe117cad3329fd11fa80aa5e1f7c5e07dd2991a745c396d8cd2ded7
+  data.tar.gz: bbc4add68e63d9c4507c9630f65879bd526b902530a464fad22467243a1460802878003e77f85604925d75aae6ff437a33ddb5dceab94b411d3c0d9e7484f7d8

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.1.2
+
+env:
+  - DISPLAY=:99.0
+
+# uncomment this line if your project needs to run something other than `rake`:
+script: "bundle exec rspec spec"
+
+branches:
+  only:
+    - master

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+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,51 @@
+# Desciption
+
+This is a Ruby wrapper for the unofficial Xbox API located at http://xboxapi.com
+
+# Usage
+
+One must first create a client that is able to interface with the Xbox API.  
+The client takes one argument; your xbox API token.
+
+```ruby
+require "xbox-api"
+client = XboxApi::Client.new("424242424242424242424242")
+#=> <XboxApi::Client:0x007fcc9215c8e8>
+
+```
+
+Using that client, one can then return a Gamer object
+
+```ruby
+logan = client.gamer("oh hai loganz")
+```
+
+The XboxApi::Gamer instance responds to methods that correspond to API endpoints
+
+```ruby
+logan.presence
+logan.gamercard
+```
+
+The client also respond to `#calls_emaining`
+
+```ruby
+live.calls_remaining
+#=> {:limit=>"120", :remaining=>"112", :resets_in=>"452"}
+```
+
+# The API
+
+### Currently Supported Endpoints
+
+| Endpoint | Name |  Short Description |
+|---       |---   |---                 |
+| /v2/{xuid}/profile | Profile | This is the Profile for a specified XUID|
+| /v2/{xuid}/gamercard | Gamercard | This is the Gamercard information for a specified XUID|
+| /v2/{xuid}/presence | Presence | This is the current presence information for a specified XUID|
+| /v2/{xuid}/activity | Activity | This is the current activity information for a specified XUID|
+| /v2/{xuid}/activity/recent | Recent Activity | This is the recent activity information for a specified XUID|
+| /v2/{xuid}/friends | Friends | This is the friends information for a specified XUID|
+| /v2/{xuid}/followers | Followers | This is the followers information for a specified XUID|
+| /v2/{xuid}/xbox360games | Xbox 360 Games | This is the Xbox 360 Games List for a specified XUID|
+| /v2/{xuid}/xboxonegames | Xbox ONE Games | This is the Xbox One Games List for a specified XUID|

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/xbox-api.rb

@@ -0,0 +1,5 @@
+require "multi_json"
+require "open-uri"
+require "xbox-api/version"
+require "xbox-api/client"
+require "xbox-api/gamer"

data/lib/xbox-api/client.rb

@@ -0,0 +1,50 @@
+module XboxApi
+
+  class Client
+
+    attr_reader :api_key, :base_url
+
+    def initialize(api_key)
+      @api_key = api_key
+      @base_url = "https://xboxapi.com/v2"
+    end
+
+    def gamer(tag)
+      XboxApi::Gamer.new(tag, self)
+    end
+
+    def credentials
+      {token: api_key}
+    end
+
+    def fetch_body_and_parse(endpoint)
+      parse(get_with_token(endpoint).read)
+    end
+
+    def calls_remaining
+      headers = fetch_headers
+      {
+        limit: headers["x-ratelimit-limit"],
+        remaining: headers["x-ratelimit-remaining"],
+        resets_in: headers["x-ratelimit-reset"]
+      }
+    end
+
+    private 
+
+    def parse(json)
+      MultiJson.load(json, symbolize_keys: true)
+    end
+
+    def get_with_token(endpoint)
+      request = URI.parse("#{base_url}/#{endpoint}")
+      open(request, "X-AUTH" => api_key)
+    end
+
+    def fetch_headers
+      get_with_token("accountXuid").meta
+    end
+
+  end
+
+end

data/lib/xbox-api/gamer.rb

@@ -0,0 +1,45 @@
+module XboxApi
+  class Gamer
+
+    attr_reader :gamertag, :xuid
+
+    ENDPOINTS = [
+      :presence,
+      :profile,
+      :gamercard,
+      :activity,
+      :friends,
+      :followers,
+      :xbox360games,
+      :xboxonegames
+    ]
+
+    def initialize(gamertag, client)
+      @gamertag = gamertag
+      @client   = client
+      @xuid     = fetch_xuid
+    end
+
+    ENDPOINTS.each do |action|
+      define_method( action ) do
+        endpoint = "#{xuid}/#{__method__}"
+        client.fetch_body_and_parse( endpoint )
+      end
+    end
+
+    def recent_activity
+      endpoint = "#{xuid}/activity/recent"
+      client.fetch_body_and_parse( endpoint )
+    end
+
+    private
+
+      attr_reader :client
+
+      def fetch_xuid
+        endpoint = "xuid/#{URI.encode(gamertag)}"
+        client.fetch_body_and_parse(endpoint)
+      end
+  end
+
+end

data/lib/xbox-api/version.rb

@@ -0,0 +1,5 @@
+module XboxApi
+  module Wrapper
+    VERSION = "0.1.1"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'xbox-api'
+require 'vcr'
+require 'fakeweb'
+
+RSpec.configure do |config|
+  # config.run_all_when_everything_filtered = true
+  # config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = 'random'
+end
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/vcr"
+  config.hook_into :fakeweb
+end

data/spec/vcr/calls_remaining.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://xboxapi.com/v2/accountXuid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      x-auth:
+      - e0662396178e32b0ea6c1f36c842a2b96b3bfb3d
+      accept-encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      accept:
+      - "*/*"
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/1.6.2
+      content-type:
+      - application/json
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      x-powered-by:
+      - PHP/5.5.20-1+deb.sury.org~trusty+1
+      cache-control:
+      - no-cache
+      date:
+      - Tue, 20 Jan 2015 20:58:47 GMT
+      access-control-allow-origin:
+      - "*"
+      x-ratelimit-limit:
+      - '120'
+      x-ratelimit-remaining:
+      - '87'
+      x-ratelimit-reset:
+      - '74'
+      access-control-allow-headers:
+      - content-type, content-length, x-auth, accept-encoding, accept, user-agent,
+        host, Origin, Access-Control-Allow-Origin, Access-Control-Request-Method,
+        Access-Control-Request-Headers, X-Auth
+    body:
+      encoding: UTF-8
+      string: '{"xuid":2533274810770211,"gamerTag":"audibleBLiNK","gamertag":"audibleBLiNK"}'
+    http_version: '1.1'
+  recorded_at: Tue, 20 Jan 2015 20:58:46 GMT
+recorded_with: VCR 2.9.3

data/spec/vcr/gamer.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://xboxapi.com/v2/xuid/audibleblink
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      x-auth:
+      - e0662396178e32b0ea6c1f36c842a2b96b3bfb3d
+      accept-encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      accept:
+      - "*/*"
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/1.6.2
+      content-type:
+      - text/plain; charset=UTF-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      vary:
+      - Accept-Encoding
+      x-powered-by:
+      - PHP/5.5.20-1+deb.sury.org~trusty+1
+      cache-control:
+      - no-cache
+      date:
+      - Tue, 20 Jan 2015 21:08:55 GMT
+      access-control-allow-origin:
+      - "*"
+      x-ratelimit-limit:
+      - '120'
+      x-ratelimit-remaining:
+      - '120'
+      x-ratelimit-reset:
+      - '3065'
+      access-control-allow-headers:
+      - content-type, content-length, x-auth, accept-encoding, accept, user-agent,
+        host, Origin, Access-Control-Allow-Origin, Access-Control-Request-Method,
+        Access-Control-Request-Headers, X-Auth
+      content-encoding:
+      - gzip
+    body:
+      encoding: UTF-8
+      string: '2533274810770211'
+    http_version: '1.1'
+  recorded_at: Tue, 20 Jan 2015 21:08:54 GMT
+recorded_with: VCR 2.9.3

data/spec/vcr/presence.yml

@@ -0,0 +1,109 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://xboxapi.com/v2/xuid/audibleblink
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      x-auth:
+      - e0662396178e32b0ea6c1f36c842a2b96b3bfb3d
+      accept-encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      accept:
+      - "*/*"
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/1.6.2
+      content-type:
+      - text/plain; charset=UTF-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      vary:
+      - Accept-Encoding
+      x-powered-by:
+      - PHP/5.5.20-1+deb.sury.org~trusty+1
+      cache-control:
+      - no-cache
+      date:
+      - Tue, 20 Jan 2015 20:58:48 GMT
+      access-control-allow-origin:
+      - "*"
+      x-ratelimit-limit:
+      - '120'
+      x-ratelimit-remaining:
+      - '86'
+      x-ratelimit-reset:
+      - '72'
+      access-control-allow-headers:
+      - content-type, content-length, x-auth, accept-encoding, accept, user-agent,
+        host, Origin, Access-Control-Allow-Origin, Access-Control-Request-Method,
+        Access-Control-Request-Headers, X-Auth
+      content-encoding:
+      - gzip
+    body:
+      encoding: UTF-8
+      string: '2533274810770211'
+    http_version: '1.1'
+  recorded_at: Tue, 20 Jan 2015 20:58:47 GMT
+- request:
+    method: get
+    uri: https://xboxapi.com/v2/2533274810770211/presence
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      x-auth:
+      - e0662396178e32b0ea6c1f36c842a2b96b3bfb3d
+      accept-encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      accept:
+      - "*/*"
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/1.6.2
+      content-type:
+      - application/json
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      x-powered-by:
+      - PHP/5.5.20-1+deb.sury.org~trusty+1
+      cache-control:
+      - no-cache
+      date:
+      - Tue, 20 Jan 2015 20:58:49 GMT
+      access-control-allow-origin:
+      - "*"
+      x-ratelimit-limit:
+      - '120'
+      x-ratelimit-remaining:
+      - '85'
+      x-ratelimit-reset:
+      - '71'
+      access-control-allow-headers:
+      - content-type, content-length, x-auth, accept-encoding, accept, user-agent,
+        host, Origin, Access-Control-Allow-Origin, Access-Control-Request-Method,
+        Access-Control-Request-Headers, X-Auth
+    body:
+      encoding: UTF-8
+      string: '{"xuid":2533274810770211,"state":"Offline"}'
+    http_version: '1.1'
+  recorded_at: Tue, 20 Jan 2015 20:58:48 GMT
+recorded_with: VCR 2.9.3

data/spec/vcr/presence_offline.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://xboxapi.com/v2/2533274810770211/presence
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      x-auth:
+      - e0662396178e32b0ea6c1f36c842a2b96b3bfb3d
+      accept-encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      accept:
+      - "*/*"
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/1.6.2
+      content-type:
+      - application/json
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      x-powered-by:
+      - PHP/5.5.20-1+deb.sury.org~trusty+1
+      cache-control:
+      - no-cache
+      date:
+      - Tue, 20 Jan 2015 21:20:09 GMT
+      access-control-allow-origin:
+      - "*"
+      x-ratelimit-limit:
+      - '120'
+      x-ratelimit-remaining:
+      - '117'
+      x-ratelimit-reset:
+      - '2391'
+      access-control-allow-headers:
+      - content-type, content-length, x-auth, accept-encoding, accept, user-agent,
+        host, Origin, Access-Control-Allow-Origin, Access-Control-Request-Method,
+        Access-Control-Request-Headers, X-Auth
+    body:
+      encoding: UTF-8
+      string: '{"xuid":2533274810770211,"state":"Offline"}'
+    http_version: '1.1'
+  recorded_at: Tue, 20 Jan 2015 21:20:09 GMT
+recorded_with: VCR 2.9.3

data/spec/xbox_api_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'vcr'
+
+describe XboxApi do
+
+let(:token)  {File.read('./.env').chomp.split(" ")[1]}
+let(:client) {XboxApi::Client.new(token)}
+let(:gamer)  {  VCR.use_cassette("gamer") { client.gamer("audibleblink") }  }
+
+  describe XboxApi::Client do
+
+    context "#gamer" do 
+
+      it "returns a Gamer object" do
+        expect( gamer ).to be_a_kind_of XboxApi::Gamer
+      end
+
+    end
+
+    context "#calls_remaining" do 
+      it "returns a hash with the correct info" do
+        VCR.use_cassette("calls_remaining") do
+          response = client.calls_remaining
+          expect(response).to be_a_kind_of Hash
+          expect(response.keys.length).to eq 3
+        end
+      end
+    end
+  end
+
+  describe XboxApi::Gamer do
+
+    context "#presence" do 
+      
+      it "returns 'Offline' for an offline player" do
+        VCR.use_cassette("presence_offline") do
+          response = gamer.presence
+          expect(response[:state]).to eq "Offline"
+        end
+      end
+
+      xit "returns 'Online' for an online player" do
+        VCR.use_cassette("presence_online") do
+          response = gamer.presence
+          expect(response[:state]).to eq "Online"
+        end
+      end
+
+      xit "returns 'Away' for an away player" do
+        VCR.use_cassette("presence_away") do
+          response = gamer.presence
+          expect(response[:state]).to eq "Away"
+        end
+      end
+    end
+
+    context "#xuid" do  
+      it "has an xuid" do
+        expect(gamer.xuid).to_not be nil
+      end
+    end
+  end
+
+end

data/xbox-api.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/xbox-api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alex Flores"]
+  gem.email         = ["xboxapin@alexflor.es"]
+  gem.description   = %q{An Xbox API wrapper that allows one to fetch profiles, games, achievements and friends data}
+  gem.summary       = %q{A Ruby wrapper for the xboxapi.com API}
+  gem.homepage      = "https://github.com/audibleblink/xbox-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.name          = "xbox-api"
+  gem.require_paths = ["lib"]
+  gem.version       = XboxApi::Wrapper::VERSION
+
+  gem.add_runtime_dependency("multi_json")
+  gem.add_development_dependency("rspec")
+  gem.add_development_dependency("vcr")
+  gem.add_development_dependency("fakeweb")
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: xbox-api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alex Flores
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An Xbox API wrapper that allows one to fetch profiles, games, achievements
+  and friends data
+email:
+- xboxapin@alexflor.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/xbox-api.rb
+- lib/xbox-api/client.rb
+- lib/xbox-api/gamer.rb
+- lib/xbox-api/version.rb
+- spec/spec_helper.rb
+- spec/vcr/calls_remaining.yml
+- spec/vcr/gamer.yml
+- spec/vcr/presence.yml
+- spec/vcr/presence_offline.yml
+- spec/xbox_api_spec.rb
+- xbox-api.gemspec
+homepage: https://github.com/audibleblink/xbox-api
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the xboxapi.com API
+test_files:
+- spec/spec_helper.rb
+- spec/vcr/calls_remaining.yml
+- spec/vcr/gamer.yml
+- spec/vcr/presence.yml
+- spec/vcr/presence_offline.yml
+- spec/xbox_api_spec.rb