halo-reach-api 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.8.7

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end
+
+gem 'httparty'
+gem 'json'
+
+group :test do
+	gem 'fakeweb'
+	gem 'mocha'
+end

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.6)
+    fakeweb (1.2.8)
+    git (1.2.5)
+    httparty (0.5.2)
+      crack (= 0.1.6)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    mocha (0.9.8)
+      rake
+    rake (0.8.7)
+    rcov (0.8.1.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  fakeweb
+  httparty
+  jeweler (~> 1.5.1)
+  json
+  mocha
+  rcov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 David Czarnecki
+
+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.rdoc

@@ -0,0 +1,63 @@
+= Halo::Reach::API
+
+Ruby gem for interacting with the Halo:Reach API
+
+* Official: http://www.bungie.net/fanclub/statsapi/Group/Resources/Article.aspx?cid=545064
+* Unofficial wiki: http://www.haloreachapi.net/wiki/Available_methods
+
+== Requirements
+
+* HTTParty
+* JSON
+* FakeWeb (testing)
+* Mocha (testing)
+
+== Install
+
+* sudo gem install halo-reach-api
+
+== Example
+
+  >> require 'halo-reach-api'
+  => true
+  >> halo_reach_api = Halo::Reach::API.new('xxx') # An API key will cost you 750 MS points/year for your application
+  => #<Halo::Reach::API:0x1015ec2c8 @token="xxx", @api_url="http://www.bungie.net/api/reach/reachapijson.svc/">
+
+Look at the unofficial wiki for complete descriptions of the API calls. 
+
+== FAQ
+
+Q: How do I get an API key?
+
+A: You must be a Bungie Pro subscriber. http://www.haloreachapi.net/wiki/API_key
+
+Q: Can I have your API key?
+
+A: No. You can subscribe to Bungie Pro and generate an API key for your application.
+
+Q: Dates are funky and not parsed as dates. For example:
+
+	>> { "Credits" : 1000,
+     "Description" : "Earn 20 assists today in multiplayer Matchmaking.",
+     "ExpirationDate" : "/Date(1290510000000-0800)/",
+     "IsWeeklyChallenge" : false,
+     "Name" : "Pass the Rock"
+     },
+  
+A: Yes they are funky. Yes. They. Are. I'm considering how I would actually parse that out. I may write a helper method on the API class to take a date like that 
+and parse it into something useable. Or you can submit a patch for that?!
+ 
+== Contributing to halo-reach-api
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 David Czarnecki. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "halo-reach-api"
+  gem.homepage = "http://github.com/czarneckid/halo-reach-api"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby gem for interacting with the Halo:Reach API}
+  gem.description = %Q{Ruby gem for interacting with the Halo:Reach API}
+  gem.email = "dczarnecki@agoragames.com"
+  gem.authors = ["David Czarnecki"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "halo-reach-api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/halo-reach-api.gemspec

@@ -0,0 +1,82 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{halo-reach-api}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Czarnecki"]
+  s.date = %q{2010-11-22}
+  s.description = %q{Ruby gem for interacting with the Halo:Reach API}
+  s.email = %q{dczarnecki@agoragames.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "halo-reach-api.gemspec",
+    "lib/halo-reach-api.rb",
+    "test/fakeweb/get_current_challenges.json",
+    "test/fakeweb/get_file_details.json",
+    "test/fakeweb/get_game_details.json",
+    "test/fakeweb/get_game_history.json",
+    "test/fakeweb/get_game_metadata.json",
+    "test/fakeweb/get_player_details_with_no_stats.json",
+    "test/fakeweb/get_player_details_with_stats_by_map.json",
+    "test/fakeweb/get_player_details_with_stats_by_playlist.json",
+    "test/fakeweb/get_player_file_set_files.json",
+    "test/fakeweb/get_player_file_sets.json",
+    "test/fakeweb/get_player_file_share.json",
+    "test/fakeweb/get_player_recent_screenshots.json",
+    "test/fakeweb/get_player_rendered_videos.json",
+    "test/fakeweb/reach_file_search.json",
+    "test/helper.rb",
+    "test/test_halo-reach-api.rb"
+  ]
+  s.homepage = %q{http://github.com/czarneckid/halo-reach-api}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby gem for interacting with the Halo:Reach API}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_halo-reach-api.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/halo-reach-api.rb

@@ -0,0 +1,113 @@
+require 'httparty'
+require 'json'
+require 'uri'
+
+module Halo
+  module Reach
+    class API
+      include HTTParty
+
+      VERSION = '1.0.0'.freeze
+      API_URL = 'http://www.bungie.net/api/reach/reachapijson.svc/'
+      
+      DEFAULT_HEADERS = {
+        'User-Agent' => "Halo:Reach API gem #{VERSION}"
+      }
+
+      headers(DEFAULT_HEADERS)
+
+      format(:json)
+
+      attr_accessor :api_url
+      attr_accessor :token
+      
+      def initialize(token, api_url = API_URL)
+        @token = token
+        @api_url = api_url
+      end
+      
+      def debug(location = $stderr)
+        self.class.debug_output(location)
+      end
+
+      def set_http_headers(http_headers = {})
+        http_headers.merge!(DEFAULT_HEADERS)
+        headers(http_headers)
+      end
+      
+      def get_game_metadata
+        game_metadata_uri = "game/metadata/#{@token}"        
+        self.class.get(@api_url + game_metadata_uri)        
+      end
+      
+      def get_current_challenges
+        current_challenges_uri = "game/challenges/#{@token}"
+        self.class.get(@api_url + current_challenges_uri)        
+      end
+      
+      def get_game_details(game_id)
+        get_game_details_uri = "game/details/#{@token}/#{game_id}"
+        self.class.get(@api_url + get_game_details_uri)        
+      end
+      
+      def get_game_history(gamertag, variant_class = 'Unknown', page = 0)
+        get_game_history_uri = "player/gamehistory/#{@token}/#{URI.escape(gamertag)}/#{variant_class}/#{page}"
+        self.class.get(@api_url + get_game_history_uri)        
+      end
+      
+      def get_player_details_with_stats_by_map(gamertag)
+        get_player_details_with_stats_by_map_uri = "player/details/bymap/#{@token}/#{URI.escape(gamertag)}"
+        self.class.get(@api_url + get_player_details_with_stats_by_map_uri)        
+      end
+
+      def get_player_details_with_stats_by_playlist(gamertag)
+        get_player_details_with_stats_by_playlist_uri = "player/details/byplaylist/#{@token}/#{URI.escape(gamertag)}"
+        self.class.get(@api_url + get_player_details_with_stats_by_playlist_uri)        
+      end
+      
+      def get_player_details_with_no_stats(gamertag)
+        get_player_details_with_no_stats_uri = "player/details/nostats/#{@token}/#{URI.escape(gamertag)}"
+        self.class.get(@api_url + get_player_details_with_no_stats_uri)        
+      end
+      
+      def get_player_file_share(gamertag)
+        get_player_file_share_uri = "file/share/#{@token}/#{URI.escape(gamertag)}"
+        self.class.get(@api_url + get_player_file_share_uri)        
+      end
+      
+      def get_file_details(file_id)
+        get_file_details_uri = "file/details/#{@token}/#{file_id}"
+        self.class.get(@api_url + get_file_details_uri)                
+      end
+      
+      def get_player_recent_screenshots(gamertag)
+        get_player_recent_screenshots_uri = "file/screenshots/#{@token}/#{URI.escape(gamertag)}"
+        self.class.get(@api_url + get_player_recent_screenshots_uri)        
+      end      
+
+      def get_player_file_sets(gamertag)
+        get_player_file_sets_uri = "file/sets/#{@token}/#{URI.escape(gamertag)}"
+        self.class.get(@api_url + get_player_file_sets_uri)        
+      end      
+
+      def get_player_file_set_files(gamertag, file_set_id)
+        get_player_file_set_files_uri = "file/sets/files/#{@token}/#{URI.escape(gamertag)}/#{file_set_id}"
+        self.class.get(@api_url + get_player_file_set_files_uri)        
+      end      
+
+      def get_player_rendered_videos(gamertag, page = 0)
+        get_player_rendered_videos_uri = "file/videos/#{@token}/#{URI.escape(gamertag)}/#{page}"
+        self.class.get(@api_url + get_player_rendered_videos_uri)        
+      end
+
+      def reach_file_search(file_category, map_filter, engine_filter, date_filter, sort_filter, tags, page = 0)
+        reach_file_search_uri = "file/search/#{@token}/#{file_category}/#{map_filter}/#{engine_filter}/#{date_filter}/#{sort_filter}/#{page}"
+        unless tags.nil?
+          reach_file_search_uri += "?tags=#{URI.escape(tags)}"
+        end
+        
+        self.class.get(@api_url + reach_file_search_uri)        
+      end
+    end
+  end
+end

data/test/fakeweb/get_current_challenges.json

@@ -0,0 +1,34 @@
+{ "Daily" : [ { "Credits" : 1000,
+        "Description" : "Kill 100 enemies in multiplayer Matchmaking.",
+        "ExpirationDate" : "/Date(1290510000000-0800)/",
+        "IsWeeklyChallenge" : false,
+        "Name" : "Gunslinger"
+      },
+      { "Credits" : 1000,
+        "Description" : "Earn 20 assists today in multiplayer Matchmaking.",
+        "ExpirationDate" : "/Date(1290510000000-0800)/",
+        "IsWeeklyChallenge" : false,
+        "Name" : "Pass the Rock"
+      },
+      { "Credits" : 1400,
+        "Description" : "Complete a Campaign mission on Heroic with Cloud and Famine on.",
+        "ExpirationDate" : "/Date(1290510000000-0800)/",
+        "IsWeeklyChallenge" : false,
+        "Name" : "Foggy Notion"
+      },
+      { "Credits" : 1800,
+        "Description" : "Kill 250 Grunts in Firefight Matchmaking.",
+        "ExpirationDate" : "/Date(1290510000000-0800)/",
+        "IsWeeklyChallenge" : false,
+        "Name" : "A Satisfied Thirst"
+      }
+    ],
+  "Weekly" : [ { "Credits" : 16000,
+        "Description" : "Complete 16 Daily Challenges this week.",
+        "ExpirationDate" : "/Date(1291028400000-0800)/",
+        "IsWeeklyChallenge" : true,
+        "Name" : "Dedication/Time"
+      } ],
+  "reason" : "Okay",
+  "status" : 0
+}

data/test/fakeweb/get_file_details.json

@@ -0,0 +1 @@
+{"Files":[{"ScreenshotMediumUrl":"/Stats/Reach/Screenshot.ashx?fid=546727&size=medium", "FileDetailsUrl":"/stats/reach/filedetails.aspx?fid=546727", "CreateDate":"/Date(1284664679000-0700)/", "ScreenshotThumbnailUrl":"/Stats/Reach/Screenshot.ashx?fid=546727", "RenderedWMVPathHD":nil, "RenderedWMVPath":nil, "RenderJobStatus":nil, "MapId":5070, "FileId":546727, "Title":"Seen The Light?", "Author":"Gamertag", "ScreenshotFullSizeUrl":"/Stats/Reach/Screenshot.ashx?fid=85D1D1186B5621EAD709D287EA30EDA1&size=full", "ModifiedDate":"/Date(1284664679000-0700)/", "FileCategory":"Image", "OriginalAuthor":"Gamertag", "LikesCount":0, "Description":"The Pillar of Autumn on Normal, Thursday September 16, 2010 20:17:17", "DownloadCount":3, "RenderJobResolution":nil}], "FileSets":nil, "reason":"Okay", "status":0}