snafu 0.1.2 → 0.2.0

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 pkg/*
 api_key.rb
+spec/fixtures/vcr_cassettes

data/CHANGELOG.textile

@@ -1,8 +1,19 @@
+h2. 0.2.0
+
+* Hub#streets now contains an array of Street objects
+* Support for in-game Date & Time
+* Support for the "achievements.listAll" method
+* Support for the "giants.list" method
+* Support for the "giants.getFavor" method
+
 h2. 0.1.2
-* Glitch Locations (Hubs, Streets, etc.) may have strings or integers for their IDs. Street#id,  and Hub#id now always return a String
+
+* Glitch Locations (Hubs, Streets, etc.) may have strings or integers for their IDs. Street#id,  and Hub#id now always returns a String
 
 h2. 0.1.1
+
 * Fixed an issue where Hub.new would not populate steet names when given the raw result from Glitch
 
 h2. 0.1.0
+
 * Initial release

data/README.textile

@@ -1,20 +1,65 @@
 h1. Snafu
 
-Snafu is a Ruby gem that provides an interface to the "Glitch API":http://api.glitch.com. "Glitch":http://glitch.com is an online multi-player game created by Tiny Speck and provides a decent API for interacting with its world.
+Snafu is a Ruby gem that provides an interface to the "API":http://api.glitch.com for "Glitch":http://glitch.com, a browser-based MMO created by "Tiny Speck":http://tinyspeck.com.
+
+h2. API Support
+
+h3. Currently Supported
+
+* In-Game Time & Date (See the GlitchTime class for more info)
+* Giants
+** giants.list (Snafu::Giants#get_giants)
+* Locations
+** locations.getHubs (Snafu::Locations#get_hubs)
+** locations.getStreets (Snafu::Locations#get_hub)
+** locations.streetInfo (Snafu::Locations#get_street)
+
+h3. Not Yet Supported
+
+* Achievements
+* Auctions
+* Avatar
+* Players
+* Skills
 
 h2. Usage
 
-To get started, instantiate a client by passing in an optional oauth token of an authenticated user. Be sure to pass in an OAuth token with the appropriate scope level for API method you wish to call.
+To get started, instantiate the client with either no options or with the OAuth token of an authenticated user if 'identity' scope or higher is required.
 
 <pre lang="ruby">
     snafu = Snafu.new(:oauth_token => "your-oauth-token")
 </pre>
 
-Snafu currently does not support Glitch's OAuth authentication. There are other gems that support authenticating with Glitch including the excellent "OmniAuth":https://github.com/intridea/omniauth.
+Snafu currently does not support Glitch's OAuth authentication. There are other gems that support authenticating with Glitch such as "OmniAuth":https://github.com/intridea/omniauth.
+
+h3. In-Game Time & Date
 
-h3. Supported Methods
+Note that the hour, minute, day of week, day of year, and day of month are all zero-based.
 
-Currently, only the locations.* methods are supported via helper methods. Each method returns a Ruby object representing the returned data.
+To get the current in-game date and time:
+
+<pre lang="ruby">
+    current_time = snafu.glitch_time
+    current_time.year
+    => 20
+    current_time.month
+    => "Spork"
+    current_time.day
+    => "Hairday"
+</pre>
+
+h3. Giants
+
+<pre lang="ruby">
+    # giants.list
+    giants = snafu.get_giants
+    giants.first.name
+    => "Alph"
+</pre>
+
+h3. Locations
+
+All locations.* methods are supported. Each method returns a Ruby object representing the returned data.
 
 <pre lang="ruby">
     # locations.*
@@ -23,9 +68,21 @@ Currently, only the locations.* methods are supported via helper methods. Each m
     street = snafu.get_street(street_tsid) # "locations.streetInfo"
 </pre>
 
-The rest of the API will be supported in due time.
+h3. Achievements
+
+<pre lang="ruby">
+    achievements = snafu.get_achievements # "achievements.listAll"
+    achievements.first.name
+    => "1-Star Cuisinartist"
+    achievements.first.desc
+    => "Whipped up 11 meals with an Awesome Pot"
+</pre>
+
+h3. Manual Method Calls
 
-You can also receive raw data from the Glitch API by passing in any method as a string and supplying required parameters via an options hash. This returns a Hash representation of the JSON returned by Glitch:
+You can also receive raw data from the Glitch API by passing any method name into #call and supplying any required parameters via an options hash. This returns a Hash representation of the JSON returned by Glitch.
+
+For example, to manually call the Glitch *calendar.getholidays* method:
 
 <pre lang="ruby">
     snafu.call("calendar.getHolidays")
@@ -63,3 +120,7 @@ You can also receive raw data from the Glitch API by passing in any method as a
     => }
 </pre>
 
+h2. Credits
+
+"Jeff Browning":http://github.com/jbrowning - Original author
+"Lee Jensen":https://github.com/outerim - Contributions to GlitchTime

data/lib/snafu.rb

@@ -1,6 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'httparty'
 
 require "snafu/version"
 require "snafu/locations"
-require "snafu/client"
-require "snafu/models"
+require "snafu/models"
+require "snafu/achievements"
+require "snafu/giants"
+require "snafu/util"
+
+# Must be required last
+require "snafu/client"

data/lib/snafu/achievements.rb

@@ -0,0 +1,17 @@
+module Snafu
+  module Achievements
+    def get_achievements
+      result = []
+      response = self.call("achievements.listAll", :per_page => self.achievement_count)
+      response["items"].each do |achievement|
+        result << Models::Achievement.new(achievement[1])
+      end
+      result
+    end
+
+    def achievement_count
+      response = self.call("achievements.listAll")
+      response["total"]
+    end
+  end
+end

data/lib/snafu/client.rb

@@ -9,12 +9,15 @@ module Snafu
     # it's p-p-p-party time
     include HTTParty
     
-    # include other classes & modules so they can be called on the returned client object
+    # include other classes & modules so they can be called on self
     include Snafu::Locations
-    
+    include Snafu::Achievements
+    include Snafu::Giants
+    include Snafu::Util
+
     base_uri API_URL
 
-    attr_accessor :oauth_token
+    attr_accessor :oauth_token, :last_request_result
 
     def initialize(options={})
       @oauth_token = options[:oauth_token]
@@ -30,39 +33,46 @@ module Snafu
     #   snafu = snafu.call("players.stats", :authenticate => true)
     #
     # Invalid method calls will raise a <tt>GlitchAPIError</tt>
-
     def call(method, query_parameters={})
-      if method.is_a? String
-        options = { :format => :json }
-        unless query_parameters.empty?
-          options[:query] = query_parameters
-          if options[:query].has_key?(:authenticate) && options[:query][:authenticate] == true
-            if self.oauth_token.nil?
-              raise GlitchAPIError.new("You cannot do an authenticated call without an oauth token")
-            end
+      unless method.is_a? String
+        raise ArgumentError.new("Method argument must be a string")
+      end
 
-            # Replace the authenticate
-            options[:query].delete(:authenticate)
-            options[:query].update(:oauth_token => GLITCH_OAUTH_TOKEN)
+      options = { :format => :json }
+      unless query_parameters.empty?
+        options[:query] = query_parameters
+        if options[:query].has_key?(:authenticate) && options[:query][:authenticate] == true
+          if self.oauth_token.nil?
+            raise GlitchAuthenticationError.new("You cannot perform an authenticated call without an oauth token")
           end
+
+          # Replace the authenticate key with the oauth token
+          options[:query].delete(:authenticate)
+          options[:query].update(:oauth_token => @oauth_token)
         end
-        request_uri = "/#{method}"
-        parse_response(self.class.get(request_uri, options))
-      else
-        raise ArgumentError.new("Method argument must be a string")
       end
+      request_uri = "/#{method}"
+      parse_response(self.class.get(request_uri, options))
     end
 
     def parse_response(response)
-      if response["ok"] == 0
-        raise GlitchAPIError.new(response["error"])
+      if response["error"] == "invalid_token"
+        raise GlitchAuthenticationError.new("Invalid Token")
+      elsif response["ok"] == 0
+        if response["error"] == "missing_scope"
+          raise GlitchAuthenticationError.new("The token supplied has insufficient scope for this API method")
+        elsif response["error"] == "not_authenticated"
+          raise GlitchAuthenticationError.new("This API method requires authentication and no OAuth token has been supplied")
+        else
+          raise GlitchAPIError.new(response["error"])
+        end
       else
+        @last_request_result = response
         response
       end
     end
   end
 
-
-
   class GlitchAPIError < StandardError;end
+  class GlitchAuthenticationError < StandardError;end
 end

data/lib/snafu/giants.rb

@@ -0,0 +1,35 @@
+module Snafu
+  module Giants
+
+    # Accesses the "giants.list" method from the Glitch API and returns an array of the
+    # Giant information
+    def get_giants
+      giants = []
+      response = self.call("giants.list")
+      response["giants"].each do |short_name, long_name|
+        giants << Models::Giant.new(:name => long_name)
+      end
+      giants
+    end
+
+    # Accesses the "giants.getFavor" method from the Glitch API and returns an array of
+    # giants with their respective favor for the authenticated users
+    #
+    # Requires an OAuth token with *read* scope
+    #
+    def get_giants_favor
+      giants = []
+      reponse = self.call("giants.getFavor", :authenticate => true)
+      reponse["giants"].each do |giant_short_name, giant_values|
+        giants << Models::Giant.new(
+          :name => giant_values["name"],
+          :cur_favor => giant_values["cur_favor"],
+          :max_favor => giant_values["max_favor"],
+          :cur_daily_favor => giant_values["cur_daily_favor"],
+          :max_daily_favor => giant_values["max_daily_favor"]
+          )
+      end
+      giants
+    end
+  end
+end

data/lib/snafu/models.rb

@@ -1,4 +1,7 @@
 require 'snafu/models/glitch_image'
 require 'snafu/models/location'
 require 'snafu/models/hub'
-require 'snafu/models/street'
+require 'snafu/models/street'
+require 'snafu/models/glitch_time'
+require 'snafu/models/achievement'
+require 'snafu/models/giant'

data/lib/snafu/models/achievement.rb

@@ -0,0 +1,24 @@
+module Snafu
+  module Models
+    class Achievement
+      attr_reader :name, :description, :url, :image_60, :image_180
+      alias_method :desc, :description
+      def initialize(options = {})
+        @name = options["name"]
+        @description = options["description"] || options["desc"]
+        @url = options["url"]
+        @image_60 = parse_image options["image_60"]
+        @image_180  = parse_image options["image_180"]
+      end
+
+      def parse_image(image)
+        if image.is_a? String
+          return GlitchImage.new(url: image)
+        elsif image.is_a? GlitchImage
+          return image
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/snafu/models/giant.rb

@@ -0,0 +1,21 @@
+module Snafu
+  module Models
+    # Defines a class for Glitch Giants
+    #
+    class Giant
+      attr_reader :name, :cur_favor, :max_favor, :cur_daily_favor, :max_daily_favor
+
+      alias_method :current_favor, :cur_favor
+      alias_method :current_daily_favor, :cur_daily_favor
+
+      def initialize(options={})
+        @name = options[:name] || options["name"]
+        @cur_favor = (options[:cur_favor] || options["cur_favor"] || 0).to_i
+        @max_favor = (options[:max_favor] || options["max_favor"] || 0).to_i
+        @cur_daily_favor = (options[:cur_daily_favor] || options["cur_daily_favor"] || 0).to_i
+        @max_daily_favor = (options[:max_daily_favor] || options["max_daily_favor"] || 0).to_i
+      end
+
+    end
+  end
+end

data/lib/snafu/models/glitch_time.rb

@@ -0,0 +1,116 @@
+module Snafu
+  module Models
+    # Class representing a Glitch date and time
+    # 
+    # there are 4435200 real seconds in a game year
+    # there are 115200 real seconds in a game week
+    # there are 14400 real seconds in a game day
+    # there are 600 real seconds in a game hour
+    # there are 10 real seconds in a game minute
+    #
+    class GlitchTime
+      class InvalidTimestampError < Exception; end
+
+      GLITCH_EPOCH = 1238562000
+      Y_SECS = 4435200
+      D_SECS = 14400
+      H_SECS = 600
+      M_SECS = 10
+      DAYS_IN_MONTH = [29, 3, 53, 17, 73, 19, 13, 37, 5, 47, 11, 1]
+      MONTH_NAMES = %w(Primuary Spork Bruise Candy Fever Junuary Septa Remember Doom Widdershins Eleventy Recurse)
+      DAY_NAMES = %w(Hairday Moonday Twoday Weddingday Theday Fryday Standday Fabday Recurse)
+      
+      attr_reader :timestamp, :seconds_since_epoch
+      
+      def initialize(new_timestamp = Time.now)
+        @timestamp = new_timestamp.to_i
+        raise InvalidTimestampError if @timestamp < GLITCH_EPOCH
+        @timestamp = timestamp
+        @seconds_since_epoch = @timestamp - GLITCH_EPOCH
+      end
+      
+      # Returns the number of years since the Glitch epoch
+      def year
+        (seconds_since_epoch / Y_SECS).to_i
+      end
+      
+      # Returns the 0-based day of the current Glitch year
+      def day_of_year
+        (seconds_since_start_of_year / D_SECS).to_i
+      end
+      
+      # Returns the 0-based month of the year
+      def month
+        running_days = -1
+        DAYS_IN_MONTH.each_with_index do |days, idx|
+          running_days += days
+          return idx if day_of_year <= running_days
+        end
+      end
+      
+      # Returns the name of the month
+      def name_of_month
+        MONTH_NAMES[self.month]
+      end
+      
+      # Returns the 0-based day of the month
+      def day_of_month
+        return self.day_of_year if self.month == 0
+        self.day_of_year - DAYS_IN_MONTH.slice(0, (month)).inject(:+)
+      end
+      
+      # Returns the 0-based day of the week
+      def day_of_week
+        return -1 if day_of_year == 307
+        days_since_epoch % 8
+      end
+      
+      # Returns the name of the day
+      def name_of_day
+        DAY_NAMES[day_of_week]
+      end
+
+      # Returns the number of game days since epoch
+      def days_since_epoch
+        self.day_of_year + (307 * year)
+      end
+
+      # Returns the hour of the day
+      def hour
+        # seconds_since_start_of_day / H_SECS
+        (seconds_since_start_of_day / H_SECS).to_i
+      end
+
+      # Returns the minute of the hour
+      #
+      # == Options
+      # 
+      # +:padded+ - If true, will return a zero-padded string if the minute value is less than 10
+      def minute(padded = false)
+        min = (seconds_since_start_of_hour / M_SECS).to_i
+        if padded && min < 10
+          min = "0#{min}"
+        end
+        min
+      end
+
+      def to_s
+        "#{self.hour}:#{self.minute(padded: true)}, #{self.name_of_day} #{self.day_of_month + 1} of #{self.name_of_month}, year #{self.year}"
+      end
+
+      private
+      def seconds_since_start_of_year
+        seconds_since_epoch - (Y_SECS * self.year)
+      end
+      
+      def seconds_since_start_of_day
+        seconds_since_start_of_year - (D_SECS * self.day_of_year)
+      end
+
+      def seconds_since_start_of_hour
+        seconds_since_start_of_day - (H_SECS * self.hour)
+      end
+
+    end
+  end
+end