halo-reach-api 1.0.0 → 1.0.1

data/README.rdoc

@@ -44,8 +44,9 @@ Q: Dates are funky and not parsed as dates. For example:
      "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?!
+A: Yes they are funky. Yes. They. Are. You can now parse them out with the Halo::Reach::Util class.
+
+  >> parsed_time, parsed_timezone = Halo::Reach::Util::parse_timestamp(api_timestamp)
  
 == Contributing to halo-reach-api
  

data/Rakefile

@@ -13,7 +13,7 @@ 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.homepage = "http://github.com/agoragames/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}

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/halo-reach-api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{halo-reach-api}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   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.date = %q{2010-11-23}
   s.description = %q{Ruby gem for interacting with the Halo:Reach API}
   s.email = %q{dczarnecki@agoragames.com}
   s.extra_rdoc_files = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "halo-reach-api.gemspec",
     "lib/halo-reach-api.rb",
+    "lib/halo-reach-util.rb",
     "test/fakeweb/get_current_challenges.json",
     "test/fakeweb/get_file_details.json",
     "test/fakeweb/get_game_details.json",
@@ -42,16 +43,18 @@ Gem::Specification.new do |s|
     "test/fakeweb/get_player_rendered_videos.json",
     "test/fakeweb/reach_file_search.json",
     "test/helper.rb",
-    "test/test_halo-reach-api.rb"
+    "test/test_halo-reach-api.rb",
+    "test/test_halo-reach-util.rb"
   ]
-  s.homepage = %q{http://github.com/czarneckid/halo-reach-api}
+  s.homepage = %q{http://github.com/agoragames/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"
+    "test/test_halo-reach-api.rb",
+    "test/test_halo-reach-util.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/halo-reach-api.rb

@@ -7,7 +7,7 @@ module Halo
     class API
       include HTTParty
 
-      VERSION = '1.0.0'.freeze
+      VERSION = '1.0.1'.freeze
       API_URL = 'http://www.bungie.net/api/reach/reachapijson.svc/'
       
       DEFAULT_HEADERS = {

data/lib/halo-reach-util.rb

@@ -0,0 +1,19 @@
+module Halo
+  module Reach
+    class Util
+      def self.parse_timestamp(timestamp = nil)
+        # Expected format: '/Date(1284497520000-0700)/'
+        # The API returns the date as a UNIX timestamp in milliseconds
+        # The "0700" represents the timezone, in this example the U.S. Pacific (GMT-7) timezone
+        # (http://www.haloreachapi.net/wiki/Date_time_format)
+
+        if timestamp && (timestamp =~ /^\/Date\((\d+)-(\d+)\)\/$/)
+          return [Time.at($1.to_i / 1000).utc, $2]
+        else
+          raise ArgumentError.new('Invalid timestamp') 
+        end
+      end
+    end
+  end
+end
+

data/test/helper.rb

@@ -12,6 +12,7 @@ require 'test/unit'
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'halo-reach-api'
+require 'halo-reach-util'
 
 class Test::Unit::TestCase
 end

data/test/test_halo-reach-api.rb

@@ -12,7 +12,7 @@ class TestHaloReachApi < Test::Unit::TestCase
   end
   
   def test_api_version
-    assert_equal '1.0.0', Halo::Reach::API::VERSION
+    assert_equal '1.0.1', Halo::Reach::API::VERSION
   end
   
   def test_can_set_token

data/test/test_halo-reach-util.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+class TestHaloReachUtil < Test::Unit::TestCase
+
+  def test_can_parse_correctly_formatted_timestamp
+    utc_time = Time.now.utc
+    milliseconds_since_epoch = utc_time.to_i * 1000
+    timezone = '0500'
+    api_timestamp = build_timestamp(milliseconds_since_epoch, timezone)
+
+    parsed_time, parsed_timezone = Halo::Reach::Util::parse_timestamp(api_timestamp)
+    assert_equal utc_time.to_s, parsed_time.to_s
+    assert_equal timezone, parsed_timezone
+  end
+
+  def test_raise_invalid_timestamp_argument_error_on_malformed_timestamp
+    invalid_timestamps = [
+      nil, # nothing at all
+      '', # empty timestamp
+      '/Date(/', # generally malformed timestamp
+      '/Date()/', # malformed timestamp missing actual data
+      build_timestamp('',''), # missing both millisends and timezone
+      build_timestamp('','0700'), # missing millisends
+      build_timestamp(Time.now.utc.to_i * 1000, ''), # missing timezone
+      build_timestamp('abc1041', '04jhg'), # prepended/trailing garbage
+      build_timestamp('43gi', 'tb01'), # trailing/prepended garbage
+      build_timestamp('ed456mb', 'mvn029hgd'), # surrounded by garbage
+      build_timestamp('asd;kf', 'sdfoih') # omg pure garbage
+    ]
+
+    invalid_timestamps.each do |invalid_timestamp|
+      assert_raises(ArgumentError) do
+        Halo::Reach::Util::parse_timestamp(invalid_timestamp)
+      end
+    end
+  end
+
+  def build_timestamp(milliseconds_since_epoch, timezone)
+    "/Date(#{milliseconds_since_epoch.to_s}-#{timezone.to_s})/"
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: halo-reach-api
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - David Czarnecki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-22 00:00:00 -05:00
+date: 2010-11-23 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -112,6 +112,7 @@ files:
 - VERSION
 - halo-reach-api.gemspec
 - lib/halo-reach-api.rb
+- lib/halo-reach-util.rb
 - test/fakeweb/get_current_challenges.json
 - test/fakeweb/get_file_details.json
 - test/fakeweb/get_game_details.json
@@ -128,8 +129,9 @@ files:
 - test/fakeweb/reach_file_search.json
 - test/helper.rb
 - test/test_halo-reach-api.rb
+- test/test_halo-reach-util.rb
 has_rdoc: true
-homepage: http://github.com/czarneckid/halo-reach-api
+homepage: http://github.com/agoragames/halo-reach-api
 licenses: 
 - MIT
 post_install_message: 
@@ -165,3 +167,4 @@ summary: Ruby gem for interacting with the Halo:Reach API
 test_files: 
 - test/helper.rb
 - test/test_halo-reach-api.rb
+- test/test_halo-reach-util.rb