snafu 0.1.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in snafu.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+# 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(%r{^lib/snafu/(.+)\.rb$})     { |m| "spec/snafu/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2011 Jeff Browning
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +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.
+
+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.
+
+<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.
+
+h3. Supported Methods
+
+Currently, only the locations.* methods are supported via helper methods. Each method returns a Ruby object representing the returned data.
+
+<pre lang="ruby">
+    # locations.*
+    hubs = snafu.get_hubs # "locations.getHubs"
+    hub = snafu.get_hub(hub_id) # "locations.getStreets"
+    street = snafu.get_street(street_tsid) # "locations.streetInfo"
+</pre>
+
+The rest of the API will be supported in due time.
+
+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:
+
+<pre lang="ruby">
+    snafu.call("calendar.getHolidays")
+    => {
+    =>   "ok"=>1,
+    =>   "days"=>
+    =>   [{"month"=>1, "day"=>5, "name"=>"AlphCon"},
+    =>    {"month"=>2, "day"=>2, "name"=>"Lemadan"},
+    =>    {"month"=>3, "day"=>3, "name"=>"Pot Twoday"},
+    =>    {"month"=>4, "day"=>2, "name"=>"Root"},
+    =>    {"month"=>4, "day"=>3, "name"=>"Root"},
+    =>    {"month"=>4, "day"=>4, "name"=>"Root"},
+    =>    {"month"=>4, "day"=>11, "name"=>"Sprinkling"},
+    =>    {"month"=>6, "day"=>17, "name"=>"Croppaday"},
+    =>    {"month"=>7, "day"=>1, "name"=>"Belabor Day"},
+    =>    {"month"=>8, "day"=>37, "name"=>"Zilloween"},
+    =>    {"month"=>11, "day"=>11, "name"=>"Recurse Eve"}]
+    => }
+
+    snafu.call("locations.getStreets", :hub_id => 27)
+    => {
+    =>   "ok"=>1,
+    =>   "hub_id"=>"27",
+    =>   "name"=>"Ix",
+    =>   "streets"=>
+    =>   {
+    =>     "LM416LNIKVLM1"=>{"name"=>"Baby Steppes"},
+    =>     "LM413SQ6LRN58"=>{"name"=>"East Spice"},
+    =>     "LM410QQ0CHARO"=>{"name"=>"Flipside"},
+    =>     "LM4115NJ46G8M"=>{"name"=>"Groddle Ladder"},
+    =>     "LM4109NI2R640"=>{"name"=>"Guillermo Gamera Way"},
+    =>     "LM410TMR0S2S1"=>{"name"=>"Ruta Asuncion"},
+    =>     "LM413RQ6LRG9N"=>{"name"=>"West Spice"}
+    =>   }
+    => }
+</pre>
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/snafu.rb

@@ -0,0 +1,6 @@
+require 'httparty'
+
+require "snafu/version"
+require "snafu/locations"
+require "snafu/client"
+require "snafu/models"

data/lib/snafu/client.rb

@@ -0,0 +1,68 @@
+module Snafu
+  API_URL = 'http://api.glitch.com/simple'
+
+  def self.new(options={})
+    Snafu::Client.new(options)
+  end
+
+  class Client
+    # it's p-p-p-party time
+    include HTTParty
+    
+    # include other classes & modules so they can be called on the returned client object
+    include Snafu::Locations
+    
+    base_uri API_URL
+
+    attr_accessor :oauth_token
+
+    def initialize(options={})
+      @oauth_token = options[:oauth_token]
+    end
+
+    # Make a raw call to the Glitch API.
+    #
+    #   snafu = Snafu.new(:oauth_token => "some-token")
+    #   snafu.call("calendar.getHolidays")
+    #
+    # For Glitch methods which require authentication, set <tt>:authentication => true</tt>
+    #
+    #   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
+
+            # Replace the authenticate
+            options[:query].delete(:authenticate)
+            options[:query].update(:oauth_token => GLITCH_OAUTH_TOKEN)
+          end
+        end
+        request_uri = "/#{method}"
+        parse_response(self.class.get(request_uri, options))
+      else
+        raise ArgumentError.new("Method argument must be a string")
+      end
+    end
+
+    def parse_response(response)
+      if response["ok"] == 0
+        raise GlitchAPIError.new(response["error"])
+      else
+        response
+      end
+    end
+  end
+
+
+
+  class GlitchAPIError < StandardError;end
+end

data/lib/snafu/locations.rb

@@ -0,0 +1,32 @@
+module Snafu
+  module Locations
+    
+    # Accesses the "locations.getHubs" method from the Glitch API 
+    # and returns an Array of the returned Hub information.
+    # 
+    def get_hubs
+      hubs = []
+      response = self.call("locations.getHubs")
+      response["hubs"].each do |key,value|
+        hubs << Models::Hub.new(:id => key, :name => value["name"])
+      end
+      hubs
+    end
+
+    # Accesses the "locations.getStreets" method from the Glitch API passing in
+    # the supplied Hub ID.
+    # 
+    def get_hub(hub_id)
+      response = self.call("locations.getStreets", :hub_id => hub_id)
+      Models::Hub.new(response)
+    end
+
+    # Accesses the "locations.streetInfo" method from the Glitch API padding in
+    # the supplied street ID
+    # 
+    def get_street(street_id)
+      response = self.call("locations.streetInfo", :street_tsid => street_id)
+      Models::Street.new(response)
+    end
+  end
+end

data/lib/snafu/models.rb

@@ -0,0 +1,4 @@
+require 'snafu/models/glitch_image'
+require 'snafu/models/location'
+require 'snafu/models/hub'
+require 'snafu/models/street'

data/lib/snafu/models/glitch_image.rb

@@ -0,0 +1,17 @@
+module Snafu
+  module Models
+    # Provides a simple class to represent image information returned by the
+    # Glitch API.
+    # 
+    class GlitchImage
+      attr_reader :url, :width, :height
+      # Accepts an options hash with <tt>:url</tt>, <tt>:width</tt>, and
+      # <tt>:height</tt> properties
+      def initialize(options={})
+        @url = options[:url]
+        @width = options[:width].to_i || 0
+        @height = options[:height].to_i || 0
+      end
+    end
+  end
+end

data/lib/snafu/models/hub.rb

@@ -0,0 +1,32 @@
+module Snafu
+  module Models
+    # Defines a class for Glitch Hubs, which are the various regions in the game.
+    # 
+    class Hub < Location
+      attr_reader :streets
+      
+      # Accepts either the raw JSON-formatted response from the HTTParty get request or an options
+      # hash.
+      # 
+      def initialize(options = {})
+        if options.class == HTTParty::Response
+          # construct the street information
+          @id = options["hub_id"]
+          @name = options["name"]
+          @streets = []
+          options["streets"].each do |street_id, street|
+            @streets << {:id => street_id, :name => street[:name]}
+          end
+        else
+          @id = options[:id]
+          @name = options[:name]
+          if options[:streets].is_a? Array
+            @streets = options[:streets]
+          else
+            @streets = [options[:streets]]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/snafu/models/location.rb

@@ -0,0 +1,17 @@
+module Snafu
+  module Models
+    # Defines a generic location class with <tt>id</tt> and <tt>name</tt> 
+    # properties.
+    class Location
+      attr_reader :id, :name
+      # Accepts an options hash with <tt>:id</tt> or <tt>:name</tt>
+      def initializer(options={})
+        @id = options[:id]
+        @name = options[:name]
+      end
+      def to_s
+        "#{self.id} - #{self.name}"
+      end
+    end
+  end
+end

data/lib/snafu/models/street.rb

@@ -0,0 +1,41 @@
+module Snafu
+  module Models
+    class Street < Location
+      attr_reader :hub, :connections, :mote, :features, :image, :active_project
+      alias_method :active_project?, :active_project
+      def initialize(options = {})
+        if options.class == HTTParty::Response
+          @id = options["tsid"]
+          @name = options["name"]
+          @hub = Hub.new(:id => options["hub"]["id"], :name => options["hub"]["name"])
+          @features = options["features"]
+          @connections = []
+          options["connections"].each do |street_id, street|
+            @connections << Street.new(
+              :id => street_id,
+              :name => street["name"],
+              :hub => Hub.new(:id => options["hub"]["id"], :name => options["hub"]["name"]),
+              :mote => Hub.new(:id => options["mote"]["id"], :name => options["mote"]["name"]),
+            )
+          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"]
+          )
+          @active_project = options["active_project"]
+        else
+          @id = options[:id]
+          @name = options[:name]
+          @hub = options[:hub]
+          @features = options[:features]
+          @connections = options[:connections] || []
+          @mote = options[:mote]
+          @image = options[:image]
+          @active_project = options[:active_project] || false
+        end
+      end
+    end
+  end
+end

data/lib/snafu/version.rb

@@ -0,0 +1,3 @@
+module Snafu
+  VERSION = "0.1.0"
+end

data/snafu.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "snafu/version"
+
+Gem::Specification.new do |s|
+  s.name        = "snafu"
+  s.version     = Snafu::VERSION
+  s.authors     = ["Jeff Browning"]
+  s.license     = 'MIT'
+  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 the Glitch API. Glitch is an online 
+  multi-player game created by Tiny Speck.}
+
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.rubyforge_project = "snafu"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'rake'
+  s.add_runtime_dependency 'httparty', '~> 0.8'
+end

data/spec/fixtures/vcr_cassettes/Snafu_Client/call_should_accept_a_hash_of_POST_arguments.yml

@@ -0,0 +1,39 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://api.glitch.com:80/simple/locations.getStreets?hub_id=27
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      access-control-allow-credentials:
+      - 'false'
+      access-control-allow-methods:
+      - POST, GET, OPTIONS
+      access-control-allow-origin:
+      - ! '*'
+      access-control-max-age:
+      - '1728000'
+      cache-control:
+      - no-cache="set-cookie"
+      content-type:
+      - text/plain; charset=utf-8
+      date:
+      - Thu, 01 Dec 2011 01:34:59 GMT
+      server:
+      - Apache/2.2.17
+      set-cookie:
+      - AWSELB=F7715B6B10BD5947A6E9DAE19D6F6DD7D91A271FB744B8EE156EEC745EF275A9089C697163F6DA6B492CB3CBE399C5977DF92D1F3093BD75659503606D3AB37D325E15FFCF;PATH=/;MAX-AGE=600
+      content-length:
+      - '329'
+      connection:
+      - Close
+    body: ! '{"ok":1,"hub_id":"27","name":"Ix","streets":{"LM416LNIKVLM1":{"name":"Baby
+      Steppes"},"LM413SQ6LRN58":{"name":"East Spice"},"LM410QQ0CHARO":{"name":"Flipside"},"LM4115NJ46G8M":{"name":"Groddle
+      Ladder"},"LM4109NI2R640":{"name":"Guillermo Gamera Way"},"LM410TMR0S2S1":{"name":"Ruta
+      Asuncion"},"LM413RQ6LRG9N":{"name":"West Spice"}}}'
+    http_version: '1.1'

data/spec/fixtures/vcr_cassettes/Snafu_Client/call_should_automatically_pass_in_the_oauth_token_if.yml

@@ -0,0 +1,36 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://api.glitch.com:80/simple/players.stats?oauth_token=dj0xJmk9Mjg3MzgmYz03NDZmMDYyM2M1ODQ4YmVjMGY2OWZhOTY1YWM0NTZhMw
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      access-control-allow-credentials:
+      - 'false'
+      access-control-allow-methods:
+      - POST, GET, OPTIONS
+      access-control-allow-origin:
+      - ! '*'
+      access-control-max-age:
+      - '1728000'
+      cache-control:
+      - no-cache="set-cookie"
+      content-type:
+      - text/plain; charset=utf-8
+      date:
+      - Fri, 02 Dec 2011 02:46:34 GMT
+      server:
+      - Apache/2.2.17
+      set-cookie:
+      - AWSELB=F7715B6B10BD5947A6E9DAE19D6F6DD7D91A271FB7C136A73584C8A9C7D99844891B9CE4098DC7B1C7896C3495C0321477EE3FFB6D062BCC604E27B432E4350AD26F2A097D;PATH=/;MAX-AGE=600
+      content-length:
+      - '113'
+      connection:
+      - Close
+    body: ! '{"ok":1,"level":13,"xp":60,"xp_max":7032,"currants":2541,"energy":298,"energy_max":300,"mood":295,"mood_max":300}'
+    http_version: '1.1'