snafu 0.1.2 → 0.2.0

data/lib/snafu/models/hub.rb

@@ -3,7 +3,7 @@ module Snafu
     # Defines a class for Glitch Hubs, which are the various regions in the game.
     # 
     class Hub < Location
-      attr_reader :streets
+      attr_reader :streets, :id
       
       # Accepts either the raw JSON-formatted response from the HTTParty get request or an options
       # hash.
@@ -15,7 +15,7 @@ module Snafu
           @name = options["name"]
           @streets = []
           options["streets"].each do |street_id, street|
-            @streets << {:id => street_id, :name => street["name"]}
+            @streets << Street.new(:id => street_id, :name => street["name"])
           end
         else
           @id = options[:id]
@@ -27,6 +27,9 @@ module Snafu
           end
         end
       end
+      def to_s
+        "Glitch Hub - ID: #{self.id} Name: #{self.name}"
+      end
     end
   end
 end

data/lib/snafu/models/location.rb

@@ -9,12 +9,12 @@ module Snafu
         @id = options[:id].to_s
         @name = options[:name]
       end
-      def to_s
-        "#{self.id} - #{self.name}"
-      end
       def id
         @id.to_s
       end
+      def to_s
+        "Glitch Generic Location: ID: #{self.id} - Name: #{self.name}"
+      end
     end
   end
 end

data/lib/snafu/models/street.rb

@@ -3,6 +3,7 @@ module Snafu
     class Street < Location
       attr_reader :hub, :connections, :mote, :features, :image, :active_project
       alias_method :active_project?, :active_project
+      alias_method :tsid, :id
       def initialize(options = {})
         if options.class == HTTParty::Response
           @id = options["tsid"]
@@ -19,11 +20,15 @@ module Snafu
             )
           end
           @mote = Hub.new(:id => options["mote"]["id"], :name => options["mote"]["name"])
-          @image = GlitchImage.new(
-            :url => options["image"]["url"],
-            :width => options["image"]["w"],
-            :height => options["image"]["h"]
-          )
+
+          unless options["image"].nil?
+            @image = GlitchImage.new(
+              :url => options["image"]["url"],
+              :width => options["image"]["w"],
+              :height => options["image"]["h"]
+            )
+          end
+
           @active_project = options["active_project"]
         else
           @id = options[:id]
@@ -36,6 +41,9 @@ module Snafu
           @active_project = options[:active_project] || false
         end
       end
+      def to_s
+        "Glitch Street: #{self.id} - #{self.name}"
+      end
     end
   end
 end

data/lib/snafu/util.rb

@@ -0,0 +1,12 @@
+module Snafu
+  # Contains convenience methods that don't seem to fit anywhere else
+  module Util
+    def glitch_time(timestamp = nil)
+      if timestamp
+        Snafu::Models::GlitchTime.new(timestamp)
+      else
+        Snafu::Models::GlitchTime.new
+      end
+    end
+  end
+end

data/lib/snafu/version.rb

@@ -1,3 +1,3 @@
 module Snafu
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/snafu.gemspec

@@ -10,8 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["jeff@jkbrowning.com"]
   s.homepage    = "https://github.com/jbrowning/snafu"
   s.summary     = %q{A library for the Glitch API}
-  s.description = %q{Snafu is an interface to API for Glitch, an online multi-player
-    game created by Tiny Speck.}
+  s.description = %q{Snafu is a Ruby gem that provides an interface to the API for Glitch, a browser-based MMO created by Tiny Speck.}
 
   s.required_ruby_version = '>= 1.9.2'
 
@@ -27,5 +26,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'fakeweb'
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'timecop'
   s.add_runtime_dependency 'httparty', '~> 0.8'
 end

data/spec/snafu/achievements_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Snafu::Achievements do
+  before(:all) do
+    @snafu = Snafu.new
+  end
+
+  let(:all_achievements) { @snafu.get_achievements }
+
+  describe "#get_achievements_count" do
+    it "should return the count of all achievements in Glitch" do
+      VCR.use_cassette("achievements.listAll") do
+        achievement_count = @snafu.call("achievements.listAll").parsed_response["total"]
+        @snafu.achievement_count.should eql(achievement_count)
+      end
+    end
+  end
+
+  describe "#get_achievements" do
+    it "should return an array", :vcr do
+       all_achievements.should be_an(Array)
+    end
+
+    it "should return an array of the same size as the total number of achievements" do
+      VCR.use_cassette("achievements.listAll", :record => :new_episodes) do
+        all_achievements = @snafu.get_achievements
+        achievements_count = @snafu.last_request_result["total"]
+        all_achievements.count.should eql(achievements_count)
+      end
+    end
+
+    it "should return an array of Achievement objects", :vcr do
+      all_achievements.each do |achievement|
+        achievement.should be_a(Snafu::Models::Achievement)
+      end
+    end
+
+    it "should return an array of fully-populated achievements" do
+      VCR.use_cassette("achievements.listAll") do
+        all_achievements.each do |achievement|
+          achievement.name.should_not be_nil
+          achievement.desc.should_not be_nil
+          achievement.url.should_not be_nil
+          achievement.image_60.should_not be_nil
+          achievement.image_180.should_not be_nil
+        end
+      end
+    end
+  end
+
+end

data/spec/snafu/client_spec.rb

@@ -2,15 +2,13 @@ require 'spec_helper'
 
 describe Snafu::Client do
   before(:each) do
-    @snafu = Snafu.new(:api_key => GLITCH_API_KEY, :oauth_token => GLITCH_OAUTH_TOKEN)
+    @snafu = Snafu.new
   end
 
-  describe 'call()' do
+  describe '#call' do
     it 'should receive a successful response from the Glitch API if given an valid method', :vcr do
-      VCR.use_cassette "calendar.getHoldays/valid_calendar" do
-        result = @snafu.call("calendar.getHolidays")
-        result['ok'].should eql(1)
-      end
+      result = @snafu.call("calendar.getHolidays")
+      result['ok'].should eql(1)
     end
 
     it 'should raise a GlitchAPIError if receiving an unsucessful response from the Glitch API', :vcr do
@@ -24,18 +22,42 @@ describe Snafu::Client do
       result["name"].should eql(hub_name)
     end
     
-    it "should automatically pass in the oauth token if called with authenticate", :vcr do
-      expect { response = @snafu.call("players.stats", :authenticate => true) }.to_not raise_exception
+    if defined? GLITCH_OAUTH_READ_TOKEN
+      it "should automatically pass in the oauth token if called with authenticate", :vcr do
+        snafu = Snafu.new(:oauth_token => GLITCH_OAUTH_READ_TOKEN)
+        expect { response = snafu.call("players.stats", :authenticate => true) }.to_not raise_exception
+      end
     end
-  end
 
-  context "authentication" do
-    describe "call()" do
-      context "without oauth token"
-        it "should raise a GlitchAPIError if trying to do an authenticated call without an oauth token" do
-          snafu = Snafu.new()
-          expect { snafu.call("secureMethod", :authenticate => true) }.to raise_error(Snafu::GlitchAPIError, /oauth token/)
+    context "authentication" do
+      it "should raise a GlitchAuthenticationError if trying to perform an authenticated call without an oauth token", :vcr do
+        snafu = Snafu.new()
+        expect { snafu.call("secureMethod", :authenticate => true) }.to raise_error(Snafu::GlitchAuthenticationError, /oauth token/)
+      end
+
+      it "should raise a GlitchAuthenticationError if calling the API with an invalid OAuth token", :vcr, :record => :all do
+        snafu = Snafu.new(:oauth_token => "invalid token")
+        expect { snafu.call("giants.getFavor", :authenticate => true) }.to raise_error(Snafu::GlitchAuthenticationError, /invalid token/i)
+      end
+
+      it 'should raise a GlitchAuthenticationError if calling an authenticated API method without a token', :vcr do
+        expect { @snafu.call("giants.getFavor") }.to raise_error(Snafu::GlitchAuthenticationError)
+      end
+
+      if defined? GLITCH_OAUTH_READ_TOKEN
+        it "should raise a GlitchAuthenticationError if calling a method that requires a higher scope", :vcr do
+          snafu = Snafu.new(:oauth_token => GLITCH_OAUTH_IDENTITY_TOKEN)
+          expect { snafu.call("giants.getFavor", :authenticate => true) }.to raise_error(/insufficient scope/)
         end
+      end
     end
   end
+
+  describe "#last_request_result" do
+    it "should return the raw contents of the last request result", :vcr do 
+      result = @snafu.call("calendar.getHolidays")
+      @snafu.last_request_result.should eql(result)
+    end
+  end
+
 end

data/spec/snafu/giants_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Snafu::Giants do
+  before(:each) do
+    @snafu = Snafu.new()
+  end
+
+  describe "#get_giants" do
+    let(:giants) { @snafu.get_giants }
+
+    it "should return a non-empty array", :vcr do
+      giants.should be_an Array
+      giants.should_not be_empty
+    end
+    
+    it "should return an array of Giant objects", :vcr do
+      giants.each do |element|
+        element.should be_a Snafu::Models::Giant
+      end
+    end
+
+    it "should have populate the returned Giant objects with a name", :vcr do
+      giants.each do |giant|
+        giant.name.should_not be_empty
+      end
+    end
+  end
+
+  describe "#get_giants_favor", :if => defined?(GLITCH_OAUTH_READ_TOKEN) do
+
+    before(:each) do
+      @snafu = Snafu.new(:oauth_token => GLITCH_OAUTH_READ_TOKEN)
+    end
+
+    it "should raise an error if there is no OAuth token set" do
+      snafu = Snafu.new
+      expect { snafu.get_giants_favor }.to raise_error(Snafu::GlitchAuthenticationError)
+    end
+    
+    it "should return a non-empty Array", :vcr do
+      giants_favor = @snafu.get_giants_favor
+      giants_favor.should be_an Array
+      giants_favor.should_not be_empty
+    end
+
+
+    it "should return an Array of fully-populated Giant objects", :vcr do
+      giants_favor = @snafu.get_giants_favor
+      giants_favor.each do |giant| 
+        giant.should be_a(Snafu::Models::Giant)
+        giant.name.should_not be_empty
+        giant.cur_favor.should_not be_nil
+        giant.max_favor.should_not be_nil
+        giant.cur_daily_favor.should_not be_nil
+        giant.max_daily_favor.should_not be_nil
+      end
+    end
+  end
+
+end

data/spec/snafu/locations_spec.rb

@@ -2,60 +2,61 @@ require 'spec_helper'
 
 describe Snafu::Locations do
   before(:each) do
-    @snafu = Snafu.new(:api_key => GLITCH_API_KEY, :oauth_token => GLITCH_OAUTH_TOKEN)
-    @test_hub_id = 27
-    @test_hub_name = "Ix"
-    @test_street_id = "LM416LNIKVLM1"
-    @test_street_name = "Baby Steppes"
+    @snafu = Snafu.new
   end
 
-  context "get_hubs()" do
-    before(:each) do
-      @hubs = @snafu.get_hubs
-    end
+  let(:test_hub) { Snafu::Models::Hub.new(:id => 27, :name => "Ix") }
+  let(:test_street_id) { "LM416LNIKVLM1" }
+  let(:test_street_name) { "Baby Steppes" }
+  let(:test_hub_id) { "27" }
+
+  context "#get_hubs" do
 
+    let(:hubs) { @snafu.get_hubs }
+      
     it "should return an array of all hubs", :vcr do
-      @hubs.should_not be_empty
+      hubs.should_not be_empty
     end
 
     it "should return an array of Hub objects", :vcr do
-      @hubs.first.should be_a Snafu::Models::Hub
+      hubs.first.should be_a Snafu::Models::Hub
     end
 
-    it "should populated the returned Hub objects with an id and name", :vcr do
-      first_hub = @hubs.first
+    it "should populate the returned Hub objects with an id and name", :vcr do
+      first_hub = hubs.first
       first_hub.id.should_not be_nil
       first_hub.name.should_not be_nil
     end
   end
 
-  context "get_hub" do
+  context "#get_hub" do
     it "should return a valid hub if given a valid Hub ID", :vcr do
-      hub = @snafu.get_hub(@test_hub_id)
-      hub.name.should eql(@test_hub_name)
+      hub = @snafu.get_hub(test_hub_id)
+      hub.should be_a Snafu::Models::Hub
+      hub.name.should eql(test_hub.name)
     end
 
     it "should return an array of valid street information if given a valid Hub ID", :vcr do
-      test_array = {:id => @test_street_id, :name => @test_street_name}
-      hub = @snafu.get_hub(@test_hub_id)
-      hub.streets.should include(test_array)
+      hub = @snafu.get_hub(test_hub_id)
+      hub.streets.each do |street|
+        street.should be_a Snafu::Models::Street
+        street.id.should_not be_nil
+        street.name.should_not be_nil
+      end
     end
   end
 
-  context "get_street" do
-    before(:each) do
-      @test_street = @snafu.get_street(@test_street_id)
-    end
-
+  context "#get_street" do
     it "should return a complete street if given a valid street ID", :vcr do
-      @test_street.id.should_not be_nil
-      @test_street.name.should_not be_nil
-      @test_street.mote.should_not be_nil
-      @test_street.active_project?.should_not be_nil
-      @test_street.connections.should_not be_empty
-      @test_street.image.url.should_not be_nil
-      @test_street.image.width.should_not be_nil
-      @test_street.image.height.should_not be_nil
+      test_street = @snafu.get_street(test_street_id)
+      test_street.id.should_not be_nil
+      test_street.name.should_not be_nil
+      test_street.mote.should_not be_nil
+      test_street.active_project?.should_not be_nil
+      test_street.connections.should_not be_empty
+      test_street.image.url.should_not be_nil
+      test_street.image.width.should_not be_nil
+      test_street.image.height.should_not be_nil
     end
   end
 end

data/spec/snafu/models/achievement_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+module Snafu
+  module Models
+    describe Snafu::Models::Achievement do
+      before(:each) do
+        @valid_options = {
+          "name" => "a name",
+          "desc" => "a description",
+          "url" => "http://example.com",
+          "image_60" => "http://example.com/60.png",
+          "image_180" => "http://example.com/180.png"
+        }
+        @achievement = Achievement.new @valid_options
+      end
+
+      it "should populate values if given an options hash" do
+        @achievement.name.should eql(@valid_options["name"])
+        @achievement.description.should eql(@valid_options["desc"])
+        @achievement.url.should eql(@valid_options["url"])
+        @achievement.image_60.url.should eql(@valid_options["image_60"])
+        @achievement.image_180.url.should eql(@valid_options["image_180"])
+      end
+
+      it "should alias #description as #desc" do
+        @achievement.desc.should eql(@achievement.description)
+      end
+
+    end
+  end
+end

data/spec/snafu/models/giant_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module Snafu
+  module Models
+    describe Snafu::Models::Giant do
+
+      GIANT_LIST = ["Alph", "Cosma", "Friendly", "Grendaline",
+                    "Humbaba", "Lem", "Mab", "Pot", "Spriggan",
+                    "Tii", "Zille" ]
+
+      describe "#initialize" do
+        let(:random_giant) { GIANT_LIST.sample }
+
+        it "should populate values if given an options hash" do
+          expected_name = random_giant
+          expected_cur_favor = rand(1000)
+          expected_max_favor = expected_cur_favor + 1
+          expected_cur_daily_favor = rand(1000)
+          expected_max_daily_favor = expected_cur_daily_favor + 1
+
+          giant = Giant.new(
+            :name => expected_name,
+            :cur_favor => expected_cur_favor.to_s,
+            :max_favor => expected_max_favor.to_s,
+            :cur_daily_favor => expected_cur_daily_favor.to_s,
+            :max_daily_favor => expected_max_daily_favor.to_s
+          )
+
+          giant.name.should eql(expected_name)
+          giant.cur_favor.should eql(expected_cur_favor)
+          giant.max_favor.should eql(expected_max_favor)
+          giant.cur_daily_favor.should eql(expected_cur_daily_favor)
+          giant.max_daily_favor.should eql(expected_max_daily_favor)
+        end
+      end
+    end
+  end
+end