reach-api 1.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+ - 1.8.7
+ - 1.9.2
+ - 1.9.3
+ - rbx

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Give guard growl notifications, if on OS X
+if RUBY_PLATFORM =~ /darwin/i
+  gem "rb-fsevent", :require => false
+  gem "ruby_gntp", :require => false
+end
+
+gemspec

data/Guardfile

@@ -0,0 +1,19 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -Ilib -rreach-api"
+end

data/lib/reach-api.rb

@@ -0,0 +1,25 @@
+module Reach
+  class << self
+
+    # Alias for Reach::API.new
+    #
+    # Returns a Reach::API object
+    def new(options)
+      Reach::API.new(options)
+    end
+
+    # Delegate to Reach::API
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+
+  autoload :API,     "reach/api"
+  autoload :Helper,  "reach/helper"
+  autoload :Version, "reach/version"
+end

data/lib/reach/api.rb

@@ -0,0 +1,32 @@
+require "httparty"
+require "json"
+
+module Reach
+  class API
+    include HTTParty
+
+    require "reach/api/game"
+    include Reach::API::Game
+
+    require "reach/api/player"
+    include Reach::API::Player
+
+    require "reach/api/file"
+    include Reach::API::File
+
+    # API endpoint
+    ENDPOINT = "http://www.bungie.net/api/reach/reachapijson.svc/"
+
+    # API key
+    attr_reader :key
+
+    # Public: Creates a new API object
+    #
+    # key - the API key used throughout the application
+    #
+    # Returns a new Reach::API object
+    def initialize(key)
+      @key = key
+    end
+  end
+end

data/lib/reach/api/file.rb

@@ -0,0 +1,100 @@
+module Reach
+  class API
+    module File
+
+      # Public: Fetches a listing of files in a player's
+      # file share
+      #
+      # gamertag - the player to get a file listing for
+      #
+      # Returns a hash
+      def get_player_file_share(gamertag)
+        gamertag = gamertag.gsub(' ', '%20')
+        uri = ENDPOINT + "file/share/#{key}/#{gamertag}"
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+
+      # Public: Fetches information on a specific file
+      #
+      # id - the ID of the file to get information on
+      #
+      # Returns a hash
+      def get_file_details(id)
+        uri = ENDPOINT + "file/details/#{key}/#{id}"
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+
+      # Public: Fetches a list of a player's recent screenshots
+      #
+      # gamertag - the specified player
+      #
+      # Returns a hash
+      def get_player_recent_screenshots(gamertag)
+        gamertag = gamertag.gsub(' ', '%20')
+        uri = ENDPOINT + "file/screenshots/#{key}/#{gamertag}"
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+
+      # Public: Fetches a list of file sets belonging
+      # to a player
+      #
+      # gamertag - the player to get a list of file sets for
+      #
+      # Returns a hash
+      def get_player_file_sets(gamertag)
+        gamertag = gamertag.gsub(' ', '%20')
+        uri = ENDPOINT + "file/sets/#{key}/#{gamertag}"
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+
+      # Public: Fetches a list of files in a player's
+      # file set
+      #
+      # gamertag - the specified player
+      # id       - the fileset ID
+      #
+      # Returns a hash
+      def get_player_file_set_files(gamertag, id)
+        gamertag = gamertag.gsub(' ', '%20')
+        uri = ENDPOINT + "file/sets/files/#{key}/#{gamertag}/#{id}"
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+
+      # Public: Fetches a list of rendered videos
+      # belonging to a player
+      #
+      # gamertag - the specified player
+      # page     - an optional page of results to fetch
+      #
+      # Returns a hash
+      def get_player_rendered_videos(gamertag, page = 0)
+        gamertag = gamertag.gsub(' ', '%20')
+        uri = ENDPOINT + "file/videos/#{key}/#{gamertag}/#{page}"
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+
+      # Public: Fetches a listing of files matching search criteria
+      #
+      # file_category - the type of file to search for
+      # map_filter    - an map to limit results
+      # engine_filter - an game engine type to limit results
+      # date_filter   - a required date filter
+      # sort_filter   - a required sort parameter
+      # tags          - a semicolon-delimited list of tags to search for
+      # page          - the page of results to fetch
+      #
+      # Returns a hash containing search results
+      def reach_file_search(file_category, map_filter, engine_filter, date_filter, sort_filter, tags = '', page = 0)
+        uri = ENDPOINT + "file/search/#{key}/#{file_category}/#{map_filter}/#{engine_filter}/#{date_filter}/#{sort_filter}/#{page}?tags=#{tags}"
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+    end
+  end
+end

data/lib/reach/api/game.rb

@@ -0,0 +1,43 @@
+module Reach
+  class API
+    module Game
+
+      # Public: Fetches metadata dictionaries
+      #
+      # Returns a hash
+      def get_game_metadata
+        uri = ENDPOINT + "game/metadata/#{key}"
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+
+      # Public: Fetches detailed game information
+      #
+      # id - the ID of the game to get details for
+      #
+      # Returns a hash
+      def get_game_details(id)
+        uri = ENDPOINT + "game/details/#{key}/#{id}"
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+
+      # Public: Fetches current challenges
+      #
+      # gamertag - optional gamertag to get
+      #            challenge progress for
+      #
+      # Returns a hash
+      def get_current_challenges(gamertag = nil)
+        if gamertag
+          gamertag = gamertag.gsub(' ', '%20')
+          uri = ENDPOINT + "game/metadata/#{key}/#{gamertag}"
+        else
+          uri = ENDPOINT + "game/metadata/#{key}"
+        end
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+    end
+  end
+end

data/lib/reach/api/player.rb

@@ -0,0 +1,59 @@
+module Reach
+  class API
+    module Player
+
+      # Public: Fetches a player's list of games
+      # in reverse chronological order
+      #
+      # gamertag - player to fetch game history for
+      # variant - which game type to look for ("Unknown" returns all)
+      # page - which page of results to get (pages of 25)
+      #
+      # Returns a hash
+      def get_game_history(gamertag, variant = "Unknown", page = 0)
+        gamertag = gamertag.gsub(' ', '%20')
+        uri = ENDPOINT + "player/gamehistory/#{key}/#{gamertag}/#{variant}/#{page}"
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+
+      # Public: Fetches detailed player info, sorted
+      # by map
+      #
+      # gamertag - player to get information about
+      #
+      # Returns a hash
+      def get_player_details_with_stats_by_map(gamertag)
+        gamertag = gamertag.gsub(' ', '%20')
+        uri = ENDPOINT + "player/details/bymap/#{key}/#{gamertag}"
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+
+      # Public: Fetches detailed player info, sorted
+      # by playlist
+      #
+      # gamertag - player to get information about
+      #
+      # Returns a hash
+      def get_player_details_with_stats_by_playlist(gamertag)
+        gamertag = gamertag.gsub(' ', '%20')
+        uri = ENDPOINT + "player/details/byplaylist/#{key}/#{gamertag}"
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+
+      # Public: Fetches basic player information
+      #
+      # gamertag - player to get information about
+      #
+      # Returns a hash
+      def get_player_details_with_no_stats(gamertag)
+        gamertag = gamertag.gsub(' ', '%20')
+        uri = ENDPOINT + "player/details/nostats/#{key}/#{gamertag}"
+        data = JSON.parse(self.class.get(uri).body, :symbolize_names => true)
+        Reach::Helper::convert_keys(data)
+      end
+    end
+  end
+end

data/lib/reach/helper.rb

@@ -0,0 +1,64 @@
+module Reach
+  class Helper
+
+    # Public: Converts a string or key from CamelCase to snake_case
+    #
+    # value - the string or key to be converted
+    #
+    # Example:
+    #
+    #    Reach::Helper::to_snake_case("CamelCase")
+    #    #=> "camel_case"
+    #
+    #    Reach::Helper::to_snake_case(:CamelCase)
+    #    #=> :camel_case
+    #
+    # Returns the snake_cased string or key
+    def self.to_snake_case(value)
+      case value
+        when Symbol
+          lowercase(value.to_s).to_sym
+        when String
+          lowercase(value)
+        else
+          false
+      end
+    end
+
+    # Public: Converts a hash or array's keys from CamelCase to snake_case
+    #
+    # value - the hash or array to have it's keys converted
+    #
+    # Example:
+    #
+    #    Reach::Helper::to_snake_case({:hashKey => "hashValue"})
+    #    #=> {:hash_key => "hashValue"}
+    #
+    # Returns the hash/array with snake_case'd keys
+    def self.convert_keys(value)
+      case value
+        when Array
+          value.map(&method(:convert_keys))
+        when Hash
+          Hash[value.map { |k, v| [to_snake_case(k), convert_keys(v)] }]
+        else
+          value
+      end
+    end
+
+    private
+
+    # Private: Converts a string from CamelCase to snake_case
+    #
+    # string - the string to be converted
+    #
+    # Returns the snake_cased string
+    def self.lowercase(string)
+      string.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+  end
+end

data/lib/reach/version.rb

@@ -0,0 +1,39 @@
+module Reach
+  class Version
+
+    # The current major version number
+    #
+    # Returns an int
+    def self.major
+      1
+    end
+
+    # The current minor version number
+    #
+    # Returns an int
+    def self.minor
+      0
+    end
+
+    # The current patch version number
+    #
+    # Returns an int
+    def self.patch
+      0
+    end
+
+    # The current pre version number
+    #
+    # Returns an int
+    def self.pre
+      nil
+    end
+
+    # Bundles up the version number into a string
+    #
+    # Returns the current version number as a string
+    def self.to_s
+      [major, minor, patch, pre].compact.join('.')
+    end
+  end
+end

data/reach-api.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path '../lib/reach/version', __FILE__
+
+Gem::Specification.new do |gem|
+  gem.name        = "reach-api"
+  gem.version     = Reach::Version.to_s
+  gem.authors     = ["Andrew Stewart"]
+  gem.email       = ["andrew@averagestudios.com"]
+  gem.homepage    = "https://github.com/stewart/reach-api"
+  gem.summary     = %q{A wrapper for the Halo Reach stats API}
+  gem.description = %q{A Ruby wrapper for Bungie's Halo Reach
+                       stats API. Returns all API responses as
+                       Ruby hashes.}
+
+  gem.rubyforge_project = "reach-api"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "httparty", "~> 0.8.1"
+  gem.add_dependency "json", "~> 1.6.5"
+
+  gem.add_development_dependency "guard-rspec", "~> 0.6.0"
+  gem.add_development_dependency "simplecov", "~> 0.5.4"
+  gem.add_development_dependency "rspec", "~> 2.8.0"
+  gem.add_development_dependency "guard", "~> 1.0.0"
+  gem.add_development_dependency "rake", "~> 0.9.2.2"
+end

data/readme.md

@@ -0,0 +1,31 @@
+# reach-api
+
+A Ruby wrapper for the Halo Reach stats API.
+
+## installation
+
+    [sudo] gem install reach-api
+
+## usage
+
+You'll need a Bungie-provided [API key][key]:
+
+    require "reach-api"
+    reach = Reach.new("your_key")
+
+For information on API methods, please refer to the [wiki][].
+
+## contributing
+
+1. Fork it
+2. Create a feature branch - `git checkout -b new_feature`
+3. Commit your changes - `git commit -m "Added new feature"`
+4. Push to GitHub - `git push origin new_feature`
+5. Create a new Pull Request
+
+## copyright
+
+Copyright (c) 2012 Andrew Stewart. See `LICENSE` for more details
+
+[key]: http://www.bungie.net/fanclub/statsapi/Group/GroupHome.aspx
+[wiki]: http://www.haloreachapi.net/wiki/Main_Page

data/spec/cases/api_spec.rb

@@ -0,0 +1,12 @@
+require "helper"
+
+describe Reach::API do
+  it "should store an API key on creation" do
+    reach = Reach.new("example_api_key")
+    reach.key.should == "example_api_key"
+  end
+
+  it "should contain an API endpoint" do
+    Reach::API::ENDPOINT.should == "http://www.bungie.net/api/reach/reachapijson.svc/"
+  end
+end

data/spec/cases/helper_spec.rb

@@ -0,0 +1,41 @@
+require "helper"
+
+describe Reach::Helper do
+  context "converting strings/symbols from CamelCase to snake_case" do
+    it "shouldn't modify a snake_cased string" do
+      Reach::Helper::to_snake_case("snake_case").should == "snake_case"
+    end
+
+    it "should convert a basic string" do
+      Reach::Helper::to_snake_case("CamelCase").should == "camel_case"
+    end
+
+    it "should convert a string containing '::'" do
+      Reach::Helper::to_snake_case("Module::Class").should == "module/class"
+    end
+
+    it "should convert a string containing a hypen '-'" do
+      Reach::Helper::to_snake_case("Here-Say").should == "here_say"
+    end
+
+    it "should convert a symbol" do
+      Reach::Helper::to_snake_case(:CamelCase).should == :camel_case
+    end
+
+    it "should return false on anything else" do
+      Reach::Helper::to_snake_case({:hashKey => "hashvalue"}).should == false
+    end
+  end
+
+  context "converting hash/array keys from CamelCase to snake_case" do
+    it "should convert hash keys" do
+      hash = {:hashKey => "hashValue"}
+      Reach::Helper::convert_keys(hash).should == {:hash_key => "hashValue"}
+    end
+
+    it "should convert hash keys inside arrays" do
+      array = [{:hashKey => "hashValue"}]
+      Reach::Helper::convert_keys(array).should == [{:hash_key => "hashValue"}]
+    end
+  end
+end

data/spec/cases/version_spec.rb

@@ -0,0 +1,8 @@
+require "helper"
+
+describe Reach::Version do
+  it "should return a string" do
+    string = Reach::Version.to_s
+    string.should == "0.0.1"
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,6 @@
+require "simplecov"
+SimpleCov.start
+
+require "reach-api"
+
+require "rspec"

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: reach-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Stewart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70145548992020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70145548992020
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70145548991220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70145548991220
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70145548990280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70145548990280
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70145548989140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :development
+  prerelease: false
+  version_requirements: *70145548989140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70145548988620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70145548988620
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70145548987980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70145548987980
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70145548987520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70145548987520
+description: ! "A Ruby wrapper for Bungie's Halo Reach\n                       stats
+  API. Returns all API responses as\n                       Ruby hashes."
+email:
+- andrew@averagestudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Guardfile
+- Rakefile
+- lib/reach-api.rb
+- lib/reach/api.rb
+- lib/reach/api/file.rb
+- lib/reach/api/game.rb
+- lib/reach/api/player.rb
+- lib/reach/helper.rb
+- lib/reach/version.rb
+- reach-api.gemspec
+- readme.md
+- spec/cases/api_spec.rb
+- spec/cases/helper_spec.rb
+- spec/cases/version_spec.rb
+- spec/helper.rb
+homepage: https://github.com/stewart/reach-api
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: reach-api
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A wrapper for the Halo Reach stats API
+test_files:
+- spec/cases/api_spec.rb
+- spec/cases/helper_spec.rb
+- spec/cases/version_spec.rb
+- spec/helper.rb