xbox-api 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8845d4286af9a4c771196a09fabc406897b4d191
-  data.tar.gz: 0693aaff2482d2cf3cd0da1884c7a2927bd72ee9
+  metadata.gz: cb88cd1c60d5504c351ebf64934cfb6f3bc7abc9
+  data.tar.gz: 1ad23dbdb85d7674f8c758e3ba5e48f9185c7a27
 SHA512:
-  metadata.gz: a0c866ce65d0bd5b8e7d2b1fa5d7637cf2ddb2f555ecf4444a49f15bedacb0d368307ab5d6df528977f742daa4003c4c6d9e29606d52b729a723dbdca8bc9f08
-  data.tar.gz: 8c3047482026b14999efc35ccff3b11946ac39db67afb2e21fdfd413df86e10c2d0d6a9527b3ea658e6240ce5af4b4e40d1c1af641470e6ef6f41cfb1c9b8fb6
+  metadata.gz: b2704631da62ce100b505aa327f96537b20cfcb49f6860685b03eaf665456cc59cd4a29013b13dee56d46da9a6bb3228e935c6016a9cb9d5c182a5b4979e84e9
+  data.tar.gz: 06acec1d0108bf79d7cb56c838cc7039bd7614ac7d7aa1b025b8dbfe4487888df0a675231868425e240b08c8b921af29913ce4b46bf94c50653d7a162da0ef08

data/README.md

@@ -13,6 +13,8 @@ This is a Ruby wrapper for the unofficial Xbox API located at http://xboxapi.com
 
 # Usage
 
+## Ruby Gem
+
 One must first create a client that is able to interface with the Xbox API.  
 The client takes one argument; your xbox API token.
 
@@ -51,6 +53,25 @@ client = XboxApi::Client.new(ENV[:XBOX_TOKEN])
 logan = XboxApi::Gamer.new("oh hai loganz", client, "189823798746")
 ```
 
+## Commad Line
+
+The `xbl` binary may be invoked from the command line.
+
+`xbl -s theschoolmaster` or `xbl --status theschoolmaster` may be used to retreive the status of a given player
+
+If you have not yet supplied your API token from XboxApi.com, you will be prompted when trying to use `xbl`
+
+Additionally, you may clear and set you token with `xbl token`
+
+```sh
+# clear your token
+xbl token --clear
+
+# set or view your token
+xbl token
+```
+
+
 # The API
 
 ### Currently Supported Endpoints

data/bin/xbl

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/xbox-api"
+require_relative "../lib/xbox-api/xboxlive"
+# $thor_runner = true
+XboxApi::XboxLive.start(ARGV)

data/lib/xbox-api.rb

@@ -1,5 +1,9 @@
 require "yajl"
 require "open-uri"
+require "thor"
+
 require "xbox-api/version"
 require "xbox-api/client"
 require "xbox-api/gamer"
+require_relative "./xbox-api/xboxlive"
+# require "xbox-api/xboxlive"

data/lib/xbox-api/version.rb

@@ -1,5 +1,5 @@
 module XboxApi
   module Wrapper
-    VERSION = "0.1.7"
+    VERSION = "0.2.0"
   end
 end

data/lib/xbox-api/xboxlive.rb

@@ -0,0 +1,90 @@
+require 'thor'
+require 'fileutils'
+
+module XboxApi
+
+  LIVE_DIR   = ".live"
+  TOKEN_FILE = "live-token"
+
+
+  class XboxLive < Thor
+    package_name "xbl"
+    map "-s" => :status
+
+    desc "status GAMERTAG","get the xbox live status of a user"
+    def status(gamertag)
+      token = TokenHelper.token_exists? ? \
+        TokenHelper.get_local_token : \
+        TokenHelper.first_run
+
+      client = Client.new(token)
+      puts client.gamer(gamertag).presence
+    end
+
+    desc "token","re/set your XboxApi token"
+    method_options :clear => :boolean
+    def token
+      if options.clear?
+
+        if TokenHelper.token_exists?
+          TokenHelper.clear!;
+          puts("Token deleted. Rerun `xbl token` to enter a new token")
+        else
+          puts("No token exists. Rerun `xbl token` to enter a new token")
+        end
+        
+      else
+        puts TokenHelper.token_exists? ? TokenHelper.get_local_token : TokenHelper.first_run
+      end
+    end
+
+  end
+
+  module TokenHelper
+    extend self
+
+    def first_run
+      write_local_token!(get_token)
+      puts "Token saved!"
+    end
+
+    def clear!
+      if token_exists?
+        FileUtils.rm token_file
+      end
+    end
+
+    def write_local_token!(token)
+      create_token_dir! unless Dir.exists? token_path
+      File.write(token_file, token)
+      token
+    end
+
+    def create_token_dir!
+      Dir.mkdir(token_path)
+    end
+
+    def token_exists?
+      File.exists?(token_file)
+    end
+
+    def get_local_token
+      raise "No Token Found at #{token_path}" unless token_exists?
+      File.read(token_file).chomp
+    end
+
+    def token_path
+      File.join(Dir.home, XboxApi::LIVE_DIR)
+    end
+
+    def token_file
+      File.join(token_path, XboxApi::TOKEN_FILE)
+    end
+
+    def get_token
+      print 'XboxAPI Token: '
+      username = $stdin.gets.chomp
+    end
+
+  end
+end

data/spec/xbox_api_spec.rb

@@ -145,4 +145,36 @@ let(:gamer)  { VCR.use_cassette("gamer") { client.gamer("audibleblink") } }
     end
   end
 
+  describe XboxApi::XboxLive do
+    context "#status" do
+      xit "displays an status for a valid user" do
+        VCR.use_cassette("thor-status-valid") do
+          expect{system("xbl -s theschoolmaster")}.to output("").to_stdout
+        end
+      end
+
+      xit "prompts for token when none is present" do
+          XboxApi::TokenHelper.clear!
+          expect{system("xbl -s theschoolmaster")}.to output("XboxAPI Token:").to_stdout
+      end
+    end
+
+    context "#token" do
+      let(:token){"123123"}
+
+      it "displays a token" do
+          XboxApi::TokenHelper.write_local_token!(token)
+          output = `xbl token`.chomp
+          expect(output).to eq token
+      end
+
+      it "clears a token" do
+          XboxApi::TokenHelper.write_local_token!(token)
+          warning = `xbl token --clear`.chomp
+          expect(warning).to eq("Token deleted. Rerun `xbl token` to enter a new token")
+      end
+    end
+
+  end
+
 end

data/xbox-api.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = XboxApi::Wrapper::VERSION
 
+  gem.add_runtime_dependency("thor")
   gem.add_runtime_dependency("yajl-ruby")
   gem.add_development_dependency("rspec")
   gem.add_development_dependency("vcr")

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: xbox-api
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Flores
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-21 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +112,8 @@ description: An Xbox API wrapper that allows one to fetch profiles, games, achie
   and friends data
 email:
 - xboxapin@alexflor.es
-executables: []
+executables:
+- xbl
 extensions: []
 extra_rdoc_files: []
 files:
@@ -108,10 +123,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/xbl
 - lib/xbox-api.rb
 - lib/xbox-api/client.rb
 - lib/xbox-api/gamer.rb
 - lib/xbox-api/version.rb
+- lib/xbox-api/xboxlive.rb
 - spec/spec_helper.rb
 - spec/support/console.rb
 - spec/vcr/activity.yml