xbox_video 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcb5e006a94f0dcd974ca35b3b07774bb3066fa5
+  data.tar.gz: dd42f839e8c36833733d8c148c67532e59ed7de3
+SHA512:
+  metadata.gz: 3f5985ab6c89c7666b07aa244c55628fa4995b9d1e795806588c6ba0c9307e8754d0d70780d46fe910b6fa9d43027a431acf523a30528c81701f35a4dcdbd5d0
+  data.tar.gz: 8dbb98012b04f7440aca7d990f1cb7546df37e75aba8390cbb2c87a7053390d32f309fd830fce486e8fb512e5b8b918ec8158c09ffba03909838cb3bbc781f6c

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 doomy
+
+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,100 @@
+# XboxVideo
+
+The `xbox_video` gem is an API interface for Xbox Live video recordings.  Basically, it'll find videos recently uploaded
+by users to Xbox live.  It's pretty entertaining.
+
+# Attribution
+
+This is possible because of [gabe_k](https://github.com/gabe-k) and his work on the original python script, [xbox_live_video_thing](https://github.com/gabe-k/xbox_live_video_thing/blob/master/xbox_api_client.py).
+This is simply a wrapper for his work.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xbox_video'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xbox_video
+
+## Usage
+
+To use, require the `xbox_video` gem.  You will need authorization before using the gem.  You can find this by signing
+into your [Xbox account](https://account.xbox.com).  After signing in, go to your profile page and open up developer tools.
+Find XHR requests, and look for an `Authorization` header.  It should look similar to this:
+
+```
+XBL3.0 x=3234823942052384923042398423;93482093482394...
+```
+
+The entire string is fairly long, so you may want to save it into a file, or as an environment variable.  Make sure to include
+everything, including the `XBL3.0 x=...`.
+
+Once you have your code, instantiate the XboxVideo client.  The following example assumes you have your authorization code
+exported to the `XBOX_KEY` environment variable.
+
+```ruby
+client = XboxVideo::Client.new(ENV['XBOX_KEY'])
+```
+
+Once your client is instantiated, you can start to find videos.  These videos are user generated, and new.  The following will
+return an array of `Video` objects from a random game.
+
+```ruby
+videos = client.get_videos
+```
+
+If you would like to search videos from a specific game, you can either specify the ID or game title.  You can browse
+all known games in the `lib/xbox_video/games.yml` file.  Only several are documented right now, so please feel free to add
+additional games.
+
+```ruby
+# both of these return results for forza motorsport 5
+videos = client.get_videos(game: 'forza motorsport 5')
+videos = client.get_videos(game_id: 2067126551)
+```
+
+Each `Video` object contains several attributes - most usefully, the `clips` attribute, which holds an array of `Clip` objects.
+Each `Clip` object (usually only one per video) contains a few attributes, most usefully the `uri`, that allows us to view and download the video.
+
+Instead of parsing everything out manually, we can simply download a video with our `Client` object.
+
+```ruby
+client.download(video: videos.first, path: '/path/to/my/desired/folder/')
+```
+
+If we wanted more, we could download an array of video objects.  Take note, this may take a long time.
+
+```ruby
+client.download_all(videos: videos, path: '/path/to/my/desired/folder/')
+```
+
+If we wanted to download a random video, we could do the following.  Take note that we don't have to search for a video first.
+We can call this immediately after instantiating our `Client` object.  All we need to specify is a path.
+
+```ruby
+client.download_random(path: '/path/to/my/desired/folder/')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/piedoom/xbox_video.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xbox_video"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xbox_video/client.rb

@@ -0,0 +1,69 @@
+require 'rest-client'
+require 'json'
+require 'yaml'
+require 'open-uri'
+
+require_relative 'video'
+
+BASE_URL = 'https://gameclipsmetadata.xboxlive.com'
+GAME_LIST = YAML.load_file(File.join(File.dirname(File.expand_path(__FILE__)), 'games.yml'))
+
+module XboxVideo
+  class Client
+    def initialize(key)
+      @key = key
+    end
+
+    # users can search by specifying the game title or game id
+    def get_videos(game: nil, game_id: nil)
+
+      # check if user specified a game_id
+      if game_id.nil?
+        # get random game if none listed
+        game.nil? ? game_id = GAME_LIST[GAME_LIST.keys.sample] : game_id = GAME_LIST[game.downcase.gsub(":",' ')]
+      end
+
+      uri = "#{BASE_URL}/public/titles/#{game_id}/clips?qualifier=created&type=userGenerated"
+      puts uri
+      response = RestClient.get(uri, :'Authorization' => @key, :'contract_version' => 2)
+      parsed = JSON.parse(response)
+      videos = create_videos(parsed)
+    end
+
+    # download a clip.  Pass in a video object and a pathname.
+    def download(video:,path:)
+      path = "#{video.game} #{video.title} #{video.clip_id}"
+      File.open("#{path}.mp4",'wb') do |save_file|
+        open(video.clips.first.uri, 'rb') do |read_file|
+          save_file.write(read_file.read)
+        end
+      end
+    end
+
+    def download_random(path: )
+      videos = get_videos
+      video = videos.sample
+      download(video: video, path: path)
+    end
+
+    # pass in an array of video objects to be downloaded
+    def download_all(videos:,path:)
+      videos.each do |video|
+        download(video: video, path: path)
+      end
+    end
+
+    private
+
+    def create_videos videos_hash
+      videos = []
+      videos_hash['gameClips'].each do |video|
+        videos.push(XboxVideo::Video.new(video))
+      end
+
+      videos
+
+    end
+
+  end
+end

data/lib/xbox_video/clip.rb

@@ -0,0 +1,12 @@
+module XboxVideo
+  class Clip
+    attr_accessor :uri, :file_size, :uri_type, :expiration
+
+    def initialize(block)
+      @uri = block['uri']
+      @file_size = block['fileSize']
+      @uri_type = block['uriType']
+      @expiration = block['expiration']
+    end
+  end
+end

data/lib/xbox_video/games.yml

@@ -0,0 +1,46 @@
+# titles for games must be added in alphabetical order
+# please only include alphanumerical characters, spaces, dashes, and underscores in the name
+# make all characters lowercase
+
+'assassins creed iv black flag':      556718860
+'call of duty ghosts':                572802557
+'child of light':                     1512517621
+'contrast':                           370169912
+'crimson dragon':                     461173340
+'dead rising 3':                      1923160643
+'ea sports ufc':                      548464799
+'fifa 14':                            1813362885
+'fighter within':                     1569388578
+'forza motorsport 5':                  2067126551
+'guacamelee super turbo championship edition': 1958071699
+'halo spartan assult':                682562723
+'just dance 2014':                    1006362568
+'killer instinct':                    58472989
+'kinect sports rivals':               1840996916
+'lego marvel super heroes':           470244957
+'lococycle':                          1721636964
+'madden nfl 25':                      142841733
+'max the curse of brotherhood':       1649675719
+'murdered soul suspect':              1839786246
+'nba 2k14':                           778400368
+'need for speed rivals':              956568979
+'outlast':                            196423588
+'peggle 2':                           848717329
+'plants vs zombies garden warfare':   860666361
+'powerstar golf':                     1302301894
+'rayman legends':                     666757656
+'ryse son of rome':                   1708767297
+'sniper elite 3':                     269700535
+'strider':                            2029929513
+'super time force':                   255219908
+'the amazing spider-man 2':           1999803984
+'the lego movie videogame':           1755825192
+'thief':                              1181281124
+'titanfall':                          1292135256
+'tomb raider definitive edition':     826545257
+'trials fusion':                      1265757851
+'valiant hearts the great war':       1211542442
+'watch_dogs':                         585771792
+'wolfenstein the new order':          1981403899
+'worms battlegrounds':                1307429766
+'zoo tycoon':                         711381438

data/lib/xbox_video/thumbnail.rb

@@ -0,0 +1,11 @@
+module XboxVideo
+  class Thumbnail
+    attr_accessor :uri, :file_size, :size
+
+    def initialize(block)
+      @uri = block['uri']
+      @file_size = block['fileSize']
+      @size = block['thumbnailType']
+    end
+  end
+end

data/lib/xbox_video/version.rb

@@ -0,0 +1,3 @@
+module XboxVideo
+  VERSION = "0.1.0"
+end

data/lib/xbox_video/video.rb

@@ -0,0 +1,55 @@
+require_relative 'thumbnail'
+require_relative 'clip'
+
+module XboxVideo
+  class Video
+    attr_accessor :clip_id, :published, :publish_date, :record_date, :modified_date, :caption, :type, :duration,
+                  :rating, :rating_count, :views, :title, :game, :device, :likes_count, :shares_count, :comments_count,
+                  :thumbnails, :clips
+
+    def initialize(options={})
+      @clip_id = options['gameClipId']
+      @published = (options['state'] == 'Published')
+      @publish_date = options['datePublished']
+      @record_date = options['dateRecorded']
+      @modified_date = options['lastModified']
+      @caption = options['userCaption']
+      @type = options['userCaption']
+      @duration = options['durationInSeconds']
+      @rating = options['rating']
+      @rating_count = options['ratingCount']
+      @views = options['views']
+      @title = options['clipName']
+      @game = options['titleName']
+      @device = options['deviceType']
+      @likes_count = options['likeCount']
+      @shares_count = options['shareCount']
+      @comments_count = options['commentCount']
+      @thumbnails = generate_thumbnails options['thumbnails']
+      @clips = generate_clips options['gameClipUris']
+    end
+
+    private
+
+    def generate_thumbnails thumbnails_hash
+      thumbnails = []
+      thumbnails_hash.each do |thumbnail|
+        thumbnails.push(Thumbnail.new(thumbnail))
+      end
+
+      thumbnails
+
+    end
+
+    def generate_clips clips_hash
+      clips = []
+      clips_hash.each do |clip|
+        clips.push(Clip.new(clip))
+      end
+
+      clips
+
+    end
+
+  end
+end

data/lib/xbox_video.rb

@@ -0,0 +1,6 @@
+require "xbox_video/version"
+require "xbox_video/client"
+
+module XboxVideo
+  # Your code goes here...
+end

data/xbox_video.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xbox_video/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xbox_video"
+  spec.version       = XboxVideo::VERSION
+  spec.authors       = ["doomy", "gabe_k"]
+  spec.email         = ["alexanderpaullozada@gmail.com"]
+
+  spec.summary       = "A way to get random new user-uploaded game videos from Xbox live."
+  spec.homepage      = "https://github.com/piedoom/xbox_video"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rest-client"
+  spec.add_development_dependency "json"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: xbox_video
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- doomy
+- gabe_k
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: json
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- alexanderpaullozada@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xbox_video.rb
+- lib/xbox_video/client.rb
+- lib/xbox_video/clip.rb
+- lib/xbox_video/games.yml
+- lib/xbox_video/thumbnail.rb
+- lib/xbox_video/version.rb
+- lib/xbox_video/video.rb
+- xbox_video.gemspec
+homepage: https://github.com/piedoom/xbox_video
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A way to get random new user-uploaded game videos from Xbox live.
+test_files: []