snafu 0.1.2 → 0.2.0

data/spec/snafu/models/glitch_image_spec.rb

@@ -2,32 +2,22 @@ require 'spec_helper'
 
 module Snafu
   module Models
-    describe Snafu::Models::GlitchImage do
-      before(:each) do
-        @valid_image = GlitchImage.new(
-          :url => "http://example.com",
-          :width => 100,
-          :height => 100
-        )
-      end
+    describe GlitchImage do
+      let(:valid_image) { GlitchImage.new(:url => "http://example.com", :width => 100, :height => 100) }
       context "initialize()" do
         it "should retain all parameters" do
-          @valid_image.url.should_not be_nil
-          @valid_image.height.should be > 0
-          @valid_image.width.should be > 0
+          valid_image.url.should_not be_nil
+          valid_image.height.should be > 0
+          valid_image.width.should be > 0
         end
 
         it "should convert a string width argument into an integer" do
-          glitch_image = GlitchImage.new(
-            :width => "100"
-          )
+          glitch_image = GlitchImage.new(:width => "100")
           glitch_image.width.should be_a Integer      
         end
 
         it "should convert a string height argument into an integer" do
-          glitch_image = GlitchImage.new(
-            :height => "100"
-          )
+          glitch_image = GlitchImage.new(:height => "100")
           glitch_image.height.should be_a Integer      
         end
       end

data/spec/snafu/models/glitch_time_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+
+module Snafu
+  module Models
+    describe GlitchTime do
+      let(:glitch_epoch) { 1238562000 }
+      let(:secs_in_game_year) { 4435200 }
+      let(:secs_in_game_week) { 115200 }
+      let(:secs_in_game_day) { 14400 }
+      let(:secs_in_game_hour) { 600 }
+      let(:secs_in_game_minute) { 10 }
+      let(:days_in_month) { [29, 3, 53, 17, 73, 19, 13, 37, 5, 47, 11, 1] }
+      let(:names_of_months) { %w(Primuary Spork Bruise Candy Fever Junuary Septa Remember Doom Widdershins Eleventy Recurse) }
+      let(:names_of_days) { %w(Hairday Moonday Twoday Weddingday Theday Fryday Standday Fabday Recurse) }
+  
+      describe "#new" do
+        it "should retain the timestamp that is passed" do
+          time = GlitchTime.new(glitch_epoch)
+          time.timestamp.should eql(glitch_epoch)
+        end
+        
+        it "should raise an error when given a time before the glitch epoch" do
+          lambda { GlitchTime.new(glitch_epoch - 1) }.should raise_error(GlitchTime::InvalidTimestampError)
+        end
+        
+        it "should set the correct timestamp if given a valid Time object" do 
+          GlitchTime.new(Time.at(glitch_epoch)).timestamp.should eql(glitch_epoch)
+        end
+
+        it "should set the timestamp to the current time if no time is specified" do
+          Timecop.freeze(Time.now)
+          time = GlitchTime.new
+          time.timestamp.should eql(Time.now.to_i)
+        end
+      end
+      
+      describe "#seconds_since_epoch" do
+        it "should return the seconds since the glitch epoch" do
+          time = GlitchTime.new(glitch_epoch + 12345)
+          time.seconds_since_epoch.should eql(12345)
+        end
+      end
+      
+      describe "#year" do
+        it "should return 0 if timestamp is the Glitch epoch" do
+          time = GlitchTime.new(glitch_epoch)
+          time.year.should eql(0)
+        end
+        
+        it "should return 1 for a timestamp one game year from the Glitch epoch" do
+          time = GlitchTime.new(glitch_epoch + secs_in_game_year)
+          time.year.should eql(1)
+        end
+      end
+      
+      describe "#day_of_year" do
+        it "should return the day of the year" do
+          5.times { |day| GlitchTime.new(glitch_epoch + secs_in_game_day * day).day_of_year.should eql(day) }
+        end
+        
+        it "should roll back to 0 at the end of a game year" do
+          GlitchTime.new(glitch_epoch + secs_in_game_year).day_of_year.should eql(0)
+        end
+      end
+      
+      describe "#month" do
+        it "should return the month of the year" do          
+          12.times do |month|
+            time = GlitchTime.new(glitch_epoch + day_of_year_for_first_day_of_month(month) * secs_in_game_day)
+            time.month.should eql(month)
+          end
+        end
+      end
+      
+      describe "#day_of_month" do
+        it "should return the day of the month" do
+          12.times do |n|
+            time = GlitchTime.new(beginning_of_first_day_of_month(n))
+            time.day_of_month.should eql(0)
+          end
+        end
+      end
+      
+      describe "#name_of_month" do
+        it "should return the name of the month" do
+          12.times do |n|
+            GlitchTime.new(glitch_epoch + day_of_year_for_first_day_of_month(n) * secs_in_game_day).name_of_month.should eql(names_of_months[n])
+          end
+        end
+      end
+
+      describe "#day_of_week" do
+        it "should return the correct day of week" do
+          8.times { |day| GlitchTime.new(glitch_epoch + secs_in_game_day * (day + 1) - 1).day_of_week.should == day}
+        end
+
+        it "should return 3 for the day we wrote this code" do
+          time = GlitchTime.new(1327359466)
+          time.day_of_week.should == 2
+        end
+
+        it "should return Twoday for the day we wrote this code" do
+          time = GlitchTime.new(1327359466)
+          time.name_of_day.should eql("Twoday")
+        end
+        
+        it "should return -1 for the day if it is Recurse day" do
+          5.times { |year| GlitchTime.new(glitch_epoch + secs_in_game_year * (year + 1) - 1).day_of_week.should == -1 }
+        end
+      end
+
+      describe "#name_of_day" do
+        it "should return the name of the day" do
+          8.times { |day| GlitchTime.new(glitch_epoch + (secs_in_game_day * day)).name_of_day.should eql(names_of_days[day])}
+        end
+        it "should return 'Recurse' if it is Recurse day" do
+          5.times { |year| GlitchTime.new(glitch_epoch + secs_in_game_year * (year + 1) - 1).name_of_day.should eql("Recurse")}
+        end
+      end
+
+      describe "#hour" do
+        it "should return the hour of the day" do
+          24.times { |hour| GlitchTime.new(glitch_epoch + (hour * secs_in_game_hour)).hour.should == hour}
+          24.times { |hour| GlitchTime.new(glitch_epoch + secs_in_game_day + (hour * secs_in_game_hour)).hour.should == hour}
+        end
+      end
+
+      describe "#minute" do
+        it "should return the minute of the hour" do
+          60.times do |minute|
+            time = GlitchTime.new(glitch_epoch + secs_in_game_day + (minute * secs_in_game_minute))
+            time.minute.should == minute
+          end
+        end
+
+        it "should pad the minute if passed the :padded => true option" do
+          10.times do
+            time = random_time
+            while time.minute >= 10 do
+              time = random_time
+            end
+            time.minute(padded: true).to_s.should match(/\A0\d\z/)
+          end
+        end
+      end
+
+      describe "#to_s" do
+        it "should display the full time" do
+          time = GlitchTime.new
+          pattern_string = "#{time.hour}:#{time.minute(padded: true)}, #{time.name_of_day} #{time.day_of_month + 1} of #{time.name_of_month}, year #{time.year}"
+          time.to_s.should match(pattern_string)
+        end
+      end
+
+      def day_of_year_for_first_day_of_month(month_number)
+        result = 0
+        result = days_in_month[0..month_number-1].inject(:+) if month_number > 0
+        result
+      end
+
+      def beginning_of_first_day_of_month(month_number)
+        seconds_in_previous_days = 0
+        if month_number == 0
+          seconds_in_previous_days = 0
+        else
+          seconds_in_previous_days = (days_in_month[0..month_number-1].inject(:+)) * secs_in_game_day
+        end
+        glitch_epoch + seconds_in_previous_days
+      end
+
+      def random_time(seed = 1000)
+        GlitchTime.new(glitch_epoch + rand(1000))
+      end
+    end
+  end
+end

data/spec/snafu/models/hub_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module Snafu
   module Models
     describe Snafu::Models::Hub do
-      context "initialize()" do
+      describe "#initialize" do
         it "should populate values if given an options hash" do
           expected_id = "1"
           expected_name = "Some Hub"
@@ -19,7 +19,7 @@ module Snafu
         end
 
         it "should populate values if given the raw JSON response from HTTParty", :vcr do
-          glitch_client = Snafu.new(:api_key => GLITCH_API_KEY, :oauth_token => GLITCH_OAUTH_TOKEN)
+          glitch_client = Snafu.new
           glitch_response = glitch_client.call("locations.getStreets", :hub_id => 27)
           new_hub = Hub.new(glitch_response)
           new_hub.streets.should_not be_nil

data/spec/snafu/models/street_spec.rb

@@ -4,7 +4,7 @@ module Snafu
   module Models
     describe Snafu::Models::Street do
       before(:each) do
-        @snafu = Snafu.new(:api_key => GLITCH_API_KEY, :oauth_token => GLITCH_OAUTH_TOKEN)
+        @snafu = Snafu.new
         @test_hub_id = "27"
         @test_hub_name = "Ix"
         @test_street_id = "LM416LNIKVLM1"

data/spec/snafu/models/util_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Snafu::Util do
+  let(:glitch_epoch) { 1238562000 }
+  let(:snafu) { Snafu.new }
+
+  describe "#glitch_time" do
+    it "should return the current GlitchTime if given no arguments" do
+      Timecop.freeze(Time.now)
+      glitch_time = snafu.glitch_time
+      direct_time = Snafu::Models::GlitchTime.new
+      glitch_time.timestamp.should eql(direct_time.timestamp)
+    end
+
+    it "should return the same GlitchTime if given a Glitch timestamp" do
+      timestamp = glitch_epoch + rand(1000)
+      glitch_time = snafu.glitch_time(timestamp)
+      direct_time = Snafu::Models::GlitchTime.new(timestamp)
+      glitch_time.timestamp.should eql(direct_time.timestamp)
+    end
+  end
+end

data/spec/snafu_spec.rb

@@ -3,12 +3,13 @@ require 'spec_helper'
 describe Snafu do
   
   it "should return a Snafu::Client object if supplied with valid parameters" do
-    glitch_client = Snafu.new({:oauth_token => GLITCH_OAUTH_TOKEN})
+    glitch_client = Snafu.new()
   end
 
   it "should retain the Oauth Token" do
-    test_oauth_token = GLITCH_OAUTH_TOKEN
-    glitch_client = Snafu.new(:api_key => GLITCH_API_KEY, :oauth_token => GLITCH_OAUTH_TOKEN)
+    test_oauth_token = rand(100000).to_s
+    glitch_client = Snafu.new(:api_key => GLITCH_API_KEY, :oauth_token => test_oauth_token)
     glitch_client.oauth_token.should eql(test_oauth_token)
   end
+
 end

data/spec/spec_helper.rb

@@ -1,28 +1,29 @@
 require 'snafu'
 require 'vcr'
+require 'timecop'
 require 'api_key' if File.exists?(File.dirname(__FILE__) + "/api_key.rb")
 
-VCR.config do |config|
-  TWO_WEEKS = 14 * 24 * 60 * 60 # or use 7.days if you're using ActiveSupport
-  config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
-  config.stub_with :fakeweb
-  config.default_cassette_options = { :re_record_interval => TWO_WEEKS }
-  #config.allow_http_connections_when_no_cassette = true
+VCR.configure do |c|
+  c.allow_http_connections_when_no_cassette = false
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :fakeweb
+  c.configure_rspec_metadata!
+  #TWO_WEEKS = 14 * 24 * 60 * 60
+  #c.default_cassette_options = { :re_record_interval => TWO_WEEKS }
 end
 
 RSpec.configure do |config|
   config.filter_run_excluding :broken => true
   config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.around(:each, :vcr) do |example|
-    name = example.metadata[:full_description].split(/\s+/, 2).join("/").gsub(/[^\w\/]+/, "_")
-    VCR.use_cassette(name) { example.call }
-  end
+  config.extend VCR::RSpec::Macros
 end
 
-if !defined? GLITCH_API_KEY
-  GLITCH_API_KEY = "testing-key"
-end
-
-if !defined? GLITCH_OAUTH_TOKEN
-  GLITCH_OAUTH_TOKEN = "testing-token"
+# Handy time and date calculations
+class Numeric
+  def milliseconds; self/1000.0; end
+  def seconds; self; end
+  def minutes; self*60; end
+  def hours; self*60*60; end
+  def days; self*60*60*24; end
+  def weeks; self*60*60*24*7; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snafu
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-12 00:00:00.000000000Z
+date: 2012-06-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70277761501020 !ruby/object:Gem::Requirement
+  requirement: &70111835294180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277761501020
+  version_requirements: *70111835294180
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70277761496860 !ruby/object:Gem::Requirement
+  requirement: &70111835293720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277761496860
+  version_requirements: *70111835293720
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70277761493740 !ruby/object:Gem::Requirement
+  requirement: &70111835293260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277761493740
+  version_requirements: *70111835293260
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70277761480920 !ruby/object:Gem::Requirement
+  requirement: &70111835292820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277761480920
+  version_requirements: *70111835292820
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70277761479300 !ruby/object:Gem::Requirement
+  requirement: &70111835292320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70277761479300
+  version_requirements: *70111835292320
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &70111835291660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70111835291660
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70277761478120 !ruby/object:Gem::Requirement
+  requirement: &70111835290820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,9 +87,9 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70277761478120
-description: ! "Snafu is an interface to API for Glitch, an online multi-player\n
-  \   game created by Tiny Speck."
+  version_requirements: *70111835290820
+description: Snafu is a Ruby gem that provides an interface to the API for Glitch,
+  a browser-based MMO created by Tiny Speck.
 email:
 - jeff@jkbrowning.com
 executables: []
@@ -93,39 +104,32 @@ files:
 - README.textile
 - Rakefile
 - lib/snafu.rb
+- lib/snafu/achievements.rb
 - lib/snafu/client.rb
+- lib/snafu/giants.rb
 - lib/snafu/locations.rb
 - lib/snafu/models.rb
+- lib/snafu/models/achievement.rb
+- lib/snafu/models/giant.rb
 - lib/snafu/models/glitch_image.rb
+- lib/snafu/models/glitch_time.rb
 - lib/snafu/models/hub.rb
 - lib/snafu/models/location.rb
 - lib/snafu/models/street.rb
+- lib/snafu/util.rb
 - lib/snafu/version.rb
 - snafu.gemspec
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_accept_a_hash_of_POST_arguments.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_automatically_pass_in_the_oauth_token_if.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_automatically_pass_in_the_oauth_token_if_authenticate.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_automatically_pass_in_the_oauth_token_if_authenticate_called_with_true.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_automatically_pass_in_the_oauth_token_if_called_with_authenticate.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_automatically_pass_in_the_oauth_token_if_called_with_authenticate_true.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_automatically_pass_in_the_oauth_token_if_called_with_true.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_raise_a_GlitchAPIError_if_receiving_an_unsucessful_response_from_the_Glitch_API.yml
-- spec/fixtures/vcr_cassettes/Snafu_Locations/get_hub_should_return_a_valid_hub_if_given_a_valid_Hub_ID.yml
-- spec/fixtures/vcr_cassettes/Snafu_Locations/get_hub_should_return_an_array_of_valid_street_information_if_given_a_valid_Hub_ID.yml
-- spec/fixtures/vcr_cassettes/Snafu_Locations/get_hubs_should_populated_the_returned_Hub_objects_with_an_id_and_name.yml
-- spec/fixtures/vcr_cassettes/Snafu_Locations/get_hubs_should_return_an_array_of_Hub_objects.yml
-- spec/fixtures/vcr_cassettes/Snafu_Locations/get_hubs_should_return_an_array_of_all_hubs.yml
-- spec/fixtures/vcr_cassettes/Snafu_Locations/get_street_should_return_a_complete_street_if_given_a_valid_street_ID.yml
-- spec/fixtures/vcr_cassettes/Snafu_Models_Hub/initialize_should_populate_values_if_given_the_raw_JSON_response_from_HTTParty.yml
-- spec/fixtures/vcr_cassettes/Snafu_Models_Hub/initialize_should_populate_values_if_given_the_raw_response_from_Glitch.yml
-- spec/fixtures/vcr_cassettes/Snafu_Models_Street/initialize_should_populate_values_if_given_the_raw_JSON_response_from_HTTParty.yml
-- spec/fixtures/vcr_cassettes/Snafu_Models_Street_new/should_populate_values_if_given_the_raw_JSON_response_from_HTTParty.yml
-- spec/fixtures/vcr_cassettes/calendar_getHoldays/valid_calendar.yml
+- spec/snafu/achievements_spec.rb
 - spec/snafu/client_spec.rb
+- spec/snafu/giants_spec.rb
 - spec/snafu/locations_spec.rb
+- spec/snafu/models/achievement_spec.rb
+- spec/snafu/models/giant_spec.rb
 - spec/snafu/models/glitch_image_spec.rb
+- spec/snafu/models/glitch_time_spec.rb
 - spec/snafu/models/hub_spec.rb
 - spec/snafu/models/street_spec.rb
+- spec/snafu/models/util_spec.rb
 - spec/snafu/models_spec.rb
 - spec/snafu_spec.rb
 - spec/spec_helper.rb
@@ -155,30 +159,18 @@ signing_key:
 specification_version: 3
 summary: A library for the Glitch API
 test_files:
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_accept_a_hash_of_POST_arguments.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_automatically_pass_in_the_oauth_token_if.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_automatically_pass_in_the_oauth_token_if_authenticate.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_automatically_pass_in_the_oauth_token_if_authenticate_called_with_true.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_automatically_pass_in_the_oauth_token_if_called_with_authenticate.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_automatically_pass_in_the_oauth_token_if_called_with_authenticate_true.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_automatically_pass_in_the_oauth_token_if_called_with_true.yml
-- spec/fixtures/vcr_cassettes/Snafu_Client/call_should_raise_a_GlitchAPIError_if_receiving_an_unsucessful_response_from_the_Glitch_API.yml
-- spec/fixtures/vcr_cassettes/Snafu_Locations/get_hub_should_return_a_valid_hub_if_given_a_valid_Hub_ID.yml
-- spec/fixtures/vcr_cassettes/Snafu_Locations/get_hub_should_return_an_array_of_valid_street_information_if_given_a_valid_Hub_ID.yml
-- spec/fixtures/vcr_cassettes/Snafu_Locations/get_hubs_should_populated_the_returned_Hub_objects_with_an_id_and_name.yml
-- spec/fixtures/vcr_cassettes/Snafu_Locations/get_hubs_should_return_an_array_of_Hub_objects.yml
-- spec/fixtures/vcr_cassettes/Snafu_Locations/get_hubs_should_return_an_array_of_all_hubs.yml
-- spec/fixtures/vcr_cassettes/Snafu_Locations/get_street_should_return_a_complete_street_if_given_a_valid_street_ID.yml
-- spec/fixtures/vcr_cassettes/Snafu_Models_Hub/initialize_should_populate_values_if_given_the_raw_JSON_response_from_HTTParty.yml
-- spec/fixtures/vcr_cassettes/Snafu_Models_Hub/initialize_should_populate_values_if_given_the_raw_response_from_Glitch.yml
-- spec/fixtures/vcr_cassettes/Snafu_Models_Street/initialize_should_populate_values_if_given_the_raw_JSON_response_from_HTTParty.yml
-- spec/fixtures/vcr_cassettes/Snafu_Models_Street_new/should_populate_values_if_given_the_raw_JSON_response_from_HTTParty.yml
-- spec/fixtures/vcr_cassettes/calendar_getHoldays/valid_calendar.yml
+- spec/snafu/achievements_spec.rb
 - spec/snafu/client_spec.rb
+- spec/snafu/giants_spec.rb
 - spec/snafu/locations_spec.rb
+- spec/snafu/models/achievement_spec.rb
+- spec/snafu/models/giant_spec.rb
 - spec/snafu/models/glitch_image_spec.rb
+- spec/snafu/models/glitch_time_spec.rb
 - spec/snafu/models/hub_spec.rb
 - spec/snafu/models/street_spec.rb
+- spec/snafu/models/util_spec.rb
 - spec/snafu/models_spec.rb
 - spec/snafu_spec.rb
 - spec/spec_helper.rb
+has_rdoc: