ruby-satisfaction 0.4.0 → 0.6.1

data/CONTRIBUTORS.txt

@@ -1,7 +1,6 @@
 John Duff
-Pius Uzamere
 
 Awards
 ======
 
-John Duff gets the "Getting the ball rolling" achievement award for being the first contributor besides myself.
+John Duff gets the "Getting the ball rolling" achievement award for being the first contributor outside of Get Satisfaction.

data/Gemfile

@@ -0,0 +1,5 @@
+source :gemcutter
+
+# Specify your gem's dependencies in ruby-satisfaction.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    ruby-satisfaction (0.6.0)
+      activesupport (~> 2.3)
+      json (>= 1.4.6)
+      memcache-client (>= 1.5.0)
+      nokogiri (>= 1.4.2)
+      oauth (>= 0.3.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (2.3.10)
+    columnize (0.3.2)
+    configuration (1.2.0)
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    json (1.4.6)
+    launchy (0.3.7)
+      configuration (>= 0.0.5)
+      rake (>= 0.8.1)
+    linecache (0.43)
+    memcache-client (1.8.5)
+    nokogiri (1.4.4)
+    oauth (0.4.4)
+    open_gem (1.4.2)
+      launchy (~> 0.3.5)
+    rake (0.8.7)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 2.3)
+  bundler (>= 1.0.0)
+  fakeweb (~> 1.3)
+  json (>= 1.4.6)
+  memcache-client (>= 1.5.0)
+  nokogiri (>= 1.4.2)
+  oauth (>= 0.3.5)
+  open_gem (>= 1.4)
+  rspec (~> 2.2)
+  ruby-debug (>= 0.10.4)
+  ruby-satisfaction!

data/License.txt

@@ -1,20 +1,22 @@
-Copyright (c) 2008 Scott Fleckenstein
+The MIT License
 
-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:
+Copyright (c) 2008-2010 Get Satisfaction, Inc.
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+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.
 
-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.markdown

@@ -0,0 +1,45 @@
+Get Satisfaction Ruby library
+=============================
+
+Please check our Web site for the latest documentation:
+
+[Web API documentation][1]
+
+[Ruby library documentation][2]
+
+For questions, please visit the [Get Satisfaction API community][3]
+
+Known Issues
+============
+
+If you use your Satisfaction object to get a person, then that object is scoped to that person.
+
+For example:
+
+  sfn = Satisfaction.new
+  person = sfn.peson.get('jargon')
+  topics = sfn.topics.page(3, :order => 'recently_created') # Jargon's topics
+
+In the above case, topics will be scoped to topics created by Jargon instead of scoped to the
+top level. A simple workaround for now is to create a new Satisfaction object like so:
+
+  sfn = Satisfaction.new
+  person = sfn.peson.get('jargon')
+
+  sfn = Satisfaction.new
+  topics = sfn.topics.page(3, :order => 'recently_created') # Everyone's topics
+
+Changelog
+=========
+
+0.6.0
+
+* The biggest change is that we're using exceptions to indicate error conditions. This will make it easier to detect errors, especially when chaining methods. We've also made it easier to tell when the site is in maintenance mode.
+* Moved repository to https://github.com/satisfaction/ruby-satisfaction
+* Updated gemspec to include all dependencies.
+* Using Nokogiri instead of Hpricot
+* Improved testing. Original tests ran against production. Our specs now use Fakeweb instead of trying to connect to a server. There still aren't very many specs, but changes in this release have coverage. 
+
+[1]: http://getsatisfaction.com/developers/
+[2]: http://getsatisfaction.com/developers/api-libraries
+[3]: http://getsatisfaction.com/getsatisfaction/products/satisfaction_satisfaction_api

data/Rakefile

@@ -1,19 +1,3 @@
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "ruby-satisfaction"
-    gemspec.summary = "Ruby interface to Get Satisfaction"
-    gemspec.description = "Ruby interface to Get Satisfaction"
-    gemspec.email = "scott@getsatisfaction.com"
-    gemspec.homepage = "http://github.com/nullstyle/ruby-satisfaction"
-    gemspec.authors = ["Scott Fleckenstein", "Josh Nichols", "Pius Uzamere"]
-    gemspec.rubyforge_project = "satisfaction"
-    gemspec.add_dependency('memcache-client', '>= 1.5.0')
-    gemspec.add_dependency('oauth', '>= 0.3.5')
-    gemspec.add_dependency('activesupport', '>= 2.3.2')
-  end
-  
-  Jeweler::RubyforgeTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks
+

data/lib/satisfaction.rb

@@ -2,6 +2,11 @@ require 'satisfaction/external_dependencies'
 module Sfn
 end
 class Satisfaction
+  # ==============
+  # = Exceptions =
+  # ==============
+  require 'satisfaction/exceptions'
+
   # ==================
   # = Core Utilities =
   # ==================
@@ -12,7 +17,6 @@ class Satisfaction
   require 'satisfaction/loader'
   require 'satisfaction/identity_map'
   
-  
   # =============
   # = Resources =
   # =============

data/lib/satisfaction/exceptions.rb

@@ -0,0 +1,10 @@
+
+module Sfn
+  class Error < StandardError; end
+  class TooManyRedirects < Sfn::Error; end
+  class BadRequest < Sfn::Error; end
+  class AuthorizationError < Sfn::Error; end
+  class NotFound < Sfn::Error; end
+  class SiteMaintenance < Sfn::Error; end
+  class MethodNotAllowed < Sfn::Error; end
+end

data/lib/satisfaction/external_dependencies.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require 'active_support'
-require 'hpricot'
+require 'nokogiri'
 require 'json'
 require 'json/add/rails'  #make json play nice with the json rails outputs
 gem('memcache-client')

data/lib/satisfaction/loader.rb

@@ -38,26 +38,26 @@ class Sfn::Loader
     response = execute(http, request)
     
     case response
-    when Net::HTTPNotModified
-      return [:ok, cache_record.body]
     when Net::HTTPSuccess
       cache.put(uri, response)
       [:ok, response.body]
-    when Net::HTTPMovedPermanently
+    when Net::HTTPMovedPermanently, Net::HTTPMovedTemporarily
       limit = options[:redirect_limit] || 3
-      raise ArgumentError, "Too many redirects" unless limit > 0 #TODO: what is a better error here?
+      raise Sfn::TooManyRedirects, "Too many redirects" unless limit > 0
       get(response['location'], options.merge(:redirect_limit => limit - 1))
     when Net::HTTPBadRequest
-      [:bad_request, response.body]
-    when Net::HTTPForbidden
-      [:forbidden, response.body]
-    when Net::HTTPUnauthorized
-      [:unauthorized, response.body]
+      raise Sfn::BadRequest, "Bad request. Response body:\n" + response.body
+    when Net::HTTPForbidden, Net::HTTPUnauthorized
+      raise Sfn::AuthorizationError, "Not authorized"
+    when Net::HTTPNotFound
+      raise Sfn::NotFound, "Not found"
+    when Net::HTTPServiceUnavailable
+      raise Sfn::SiteMaintenance, maintenance_message(response.body)
     else
-      raise "Explode: #{response.to_yaml}"
+      raise Sfn::Error, "Encountered error. Body of response:\n" + response.body
     end
   end
-  
+
   def post(url, options)
     uri = get_uri(url)
     form = options[:form] || {}
@@ -77,16 +77,24 @@ class Sfn::Loader
     response = execute(http, request)
     
     case response
-    when Net::HTTPUnauthorized
-      [:unauthorized, response.body]
+    when Net::HTTPForbidden, Net::HTTPUnauthorized
+      raise Sfn::AuthorizationError, "Not authorized"
+    when Net::HTTPNotFound
+      raise Sfn::NotFound, "Not found"
     when Net::HTTPBadRequest
-      [:bad_request, response.body]
-    when Net::HTTPForbidden
-      [:forbidden, response.body]
+      raise Sfn::BadRequest, "Bad request. Response body:\n" + response.body
     when Net::HTTPSuccess
       [:ok, response.body]
+    when Net::HTTPMethodNotAllowed
+      #Post responds differently when the site is down for maintenance.
+      #This will raise an error if site is down otherwise we will return method_not_allowed.
+      get(url)
+
+      raise Sfn::MethodNotAllowed, "Method not allowed"
+    when Net::HTTPServiceUnavailable
+      raise Sfn::SiteMaintenance, maintenance_message(response.body)
     else
-      raise "Explode: #{response.to_yaml}"
+      raise Sfn::Error, "Encountered error. Body of response:\n" + response.body
     end
   end
   
@@ -111,5 +119,11 @@ class Sfn::Loader
       request.oauth!(http, options[:consumer], options[:token])
     end
   end
-end
 
+  def maintenance_message(html = '')
+    Nokogiri::HTML(html).at('.error_message_summary').text
+  rescue
+    "The site is down for maintenance. Please try again later."
+  end
+  
+end

data/lib/satisfaction/version.rb

@@ -0,0 +1,10 @@
+module Satisfaction
+  module VERSION
+    MAJOR = 0
+    MINOR = 6
+    PATCH  = 1
+    PRE   = ""
+
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+  end
+end

data/ruby-satisfaction.gemspec

@@ -1,75 +1,34 @@
 # -*- encoding: utf-8 -*-
+require File.expand_path("../lib/satisfaction/version", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = %q{ruby-satisfaction}
-  s.version = "0.4.0"
+  s.name        = "ruby-satisfaction"
+  s.version     = '0.6.1'
+  s.platform    = Gem::Platform::RUBY
+  s.author     = 'Get Satisfaction'
+  s.email       = ["nerds+rubygems@getsatisfaction.com"]
+  s.homepage    = "https://github.com/satisfaction/ruby-satisfaction"
+  s.summary     = "Get Satisfaction ruby client"
+  s.description = "Get Satisfaction is a simple way to build online communities that enable productive conversations between companies and their customers. More than 46,000 companies use Get Satisfaction to provide a more social support experience, build better products, increase SEO and improve customer loyalty. Get Satisfaction communities are available at http://getsatisfaction.com."
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Scott Fleckenstein", "Josh Nichols", "Pius Uzamere"]
-  s.date = %q{2009-07-10}
-  s.description = %q{Ruby interface to Get Satisfaction}
-  s.email = %q{scott@getsatisfaction.com}
-  s.extra_rdoc_files = [
-    "README.txt"
-  ]
-  s.files = [
-    ".gitignore",
-     "CONTRIBUTORS.txt",
-     "License.txt",
-     "README.txt",
-     "Rakefile",
-     "VERSION.yml",
-     "init.rb",
-     "lib/satisfaction.rb",
-     "lib/satisfaction/associations.rb",
-     "lib/satisfaction/cache/hash.rb",
-     "lib/satisfaction/cache/memcache.rb",
-     "lib/satisfaction/company.rb",
-     "lib/satisfaction/external_dependencies.rb",
-     "lib/satisfaction/has_satisfaction.rb",
-     "lib/satisfaction/identity_map.rb",
-     "lib/satisfaction/loader.rb",
-     "lib/satisfaction/person.rb",
-     "lib/satisfaction/product.rb",
-     "lib/satisfaction/reply.rb",
-     "lib/satisfaction/resource.rb",
-     "lib/satisfaction/resource/attributes.rb",
-     "lib/satisfaction/tag.rb",
-     "lib/satisfaction/topic.rb",
-     "lib/satisfaction/util.rb",
-     "ruby-satisfaction.gemspec",
-     "spec/company_spec.rb",
-     "spec/identity_map_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/nullstyle/ruby-satisfaction}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{satisfaction}
-  s.rubygems_version = %q{1.3.4}
-  s.summary = %q{Ruby interface to Get Satisfaction}
-  s.test_files = [
-    "spec/company_spec.rb",
-     "spec/identity_map_spec.rb",
-     "spec/spec_helper.rb"
-  ]
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "ruby-satisfaction"
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_dependency 'nokogiri', '>= 1.4.2'
+  s.add_dependency 'json', '>= 1.4.6'
+  s.add_dependency 'activesupport', '~> 2.3'
+  s.add_dependency 'memcache-client', '>= 1.5.0'
+  s.add_dependency 'oauth', '>= 0.3.5'
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<memcache-client>, [">= 1.5.0"])
-      s.add_runtime_dependency(%q<oauth>, [">= 0.3.5"])
-      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.2"])
-    else
-      s.add_dependency(%q<memcache-client>, [">= 1.5.0"])
-      s.add_dependency(%q<oauth>, [">= 0.3.5"])
-      s.add_dependency(%q<activesupport>, [">= 2.3.2"])
-    end
-  else
-    s.add_dependency(%q<memcache-client>, [">= 1.5.0"])
-    s.add_dependency(%q<oauth>, [">= 0.3.5"])
-    s.add_dependency(%q<activesupport>, [">= 2.3.2"])
-  end
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", "~> 2.2"
+  s.add_development_dependency "fakeweb", "~> 1.3"
+  s.add_development_dependency "open_gem", ">= 1.4"
+  s.add_development_dependency "ruby-debug", ">= 0.10.4"
+
+  s.extra_rdoc_files = [ "README.markdown" ]
+  s.files        = `git ls-files`.split("\n") - ['.rvmrc', '.gitignore']
+  s.test_files = `git ls-files`.split("\n").grep(/^spec/)
+  s.require_path = 'lib'
 end
+

data/spec/satisfaction/identity_map_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Identity Map" do
+  before(:each) do
+    gsfn = {:id => 4, :domain => 'getsatisfaction'}
+
+    # Single record response w/ gsfn
+    FakeWeb.register_uri(
+      :get,
+      "http://#{@api_host}/companies/4.json",
+      :body => gsfn.to_json
+    )
+
+    # Collection response that includes gsfn
+    FakeWeb.register_uri(
+      :get,
+      "http://#{@api_host}/companies.json?q=satisfaction&page=1&limit=10",
+      :body => {"total" => 1, "data" => [gsfn]}.to_json
+    )
+  end
+
+  it "should work single instances" do
+    c1 = @sfn.companies.get(4)
+    c2 = @sfn.companies.get(4)
+    
+    c1.object_id.should == c2.object_id
+  end
+  
+  it "should load one if the other gets loaded" do
+    c1 = @sfn.companies.get(4)
+    c2 = @sfn.companies.get(4)
+    c2.should_not be_loaded
+    
+    c1.load
+  
+    c2.should be_loaded
+    c2.domain.should == 'getsatisfaction'
+  end
+  
+  it "should work with pages too" do
+    c1 = @sfn.companies.get(4)
+    c2 = @sfn.companies.page(1, :q => 'satisfaction').first
+    
+    c1.object_id.should == c2.object_id
+  end
+end

data/spec/satisfaction/loader_spec.rb

@@ -0,0 +1,307 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Sfn::Loader do
+
+  # ==== GET ==========================================================================================================
+
+  describe "#get" do
+    before(:each) do
+      @response = nil
+      @status_code = '200'
+      @get = lambda do
+        FakeWeb.register_uri(
+          :get,
+          'http://test',
+          :body => @response_body,
+          :status => [@status_code]
+        )
+        loader = Sfn::Loader.new
+        stub(loader).add_authentication {}
+        @response = loader.get('http://test')
+      end
+    end
+
+    describe "when the status is successful (2xx)" do
+      before(:each) do
+        @status_code.should == '200'
+        @response_body = {:id => "123", :domain => "foo.bar"}.to_json
+        @get.call
+      end
+
+      it "should return a status of :ok and the response body" do
+        @response.should == [:ok, @response_body]
+      end
+    end
+
+    describe "when we are in a redirect loop" do
+      attr_reader :loader
+
+      before(:each) do
+        @url = 'http://loop/'
+        @loader = Sfn::Loader.new
+        stub(loader).add_authentication {}
+      end
+
+      describe "and the status is 301" do
+        before(:each) do
+          @get = lambda { 
+            FakeWeb.register_uri(:get, @url, :status => 301, :location => @url)
+            @response = loader.get(@url)
+          }
+        end
+
+        it "should raise a TooManyRedirects exception with an appropriate message" do
+          @get.should raise_error(Sfn::TooManyRedirects, "Too many redirects")
+        end
+      end
+
+      describe "and the status is 302" do
+        before(:each) do
+          @get = lambda { 
+            FakeWeb.register_uri(:get, @url, :status => 302, :location => @url)
+            @response = loader.get(@url)
+          }
+        end
+
+        it "should raise a TooManyRedirects exception with an appropriate message" do
+          @get.should raise_error(Sfn::TooManyRedirects, "Too many redirects")
+        end
+      end
+
+
+    end
+
+    describe "when the status is 400 (Bad Request)" do
+      before(:each) do
+        @status_code = '400'
+        @response_body = {:message => "You've already me-too'd this topic."}.to_json
+      end
+
+      it "should return a status of :bad_request and the response body" do
+        @get.should raise_error(Sfn::BadRequest, "Bad request. Response body:\n" + @response_body)
+      end
+    end
+
+    describe "when there is an authentication error" do
+      describe "when the status is 401 (Unauthorized)" do
+        before(:each) do
+          @status_code = '401'
+        end
+
+        it "should raise an Sfn::AuthorizationError" do
+          @get.should raise_error(Sfn::AuthorizationError, "Not authorized")
+        end
+      end
+
+      describe "when the status is 403 (Forbidden)" do
+        before(:each) do
+          @status_code = '403'
+        end
+        
+        it "should raise an Sfn::AuthorizationError" do
+          @get.should raise_error(Sfn::AuthorizationError, "Not authorized")
+        end
+      end
+    end
+
+  # ---- MAINTENANCE --------------------------------------------------------------------------------------------------
+    describe "when the status is 404 (Not Found)" do
+      before(:each) do
+        @status_code = '404'
+      end
+
+      it "should raise an Sfn::NotFound error" do
+        @get.should raise_error(Sfn::NotFound, "Not found")
+      end
+    end
+
+    describe "when the site is in maintenance mode (503)" do
+      before(:each) do
+        @status_code = '503'
+        @response_body = "blah blah maintenance blah"
+      end
+
+      describe "and there is not an element with a class of error_message_summary in the HTML" do
+        it "should raise an error and include the default maintenance message" do
+          @get.should raise_error(Sfn::SiteMaintenance, "The site is down for maintenance. Please try again later.")
+        end
+      end
+
+      describe "and there is an element with a class of error_message_summary in the HTML" do
+        before(:each) do
+          @custom_error = "Something crazy is going down!"
+          @response_body = "<html><head></head><body><h2 class='error_message_summary'>#{@custom_error}</h2></body>"
+        end
+
+        it "should raise an error and include the contents of the element" do
+          @get.should raise_error(Sfn::SiteMaintenance, @custom_error)
+        end
+      end
+    end
+
+    describe "when the error is not one we explicitly check for" do
+      before(:each) do
+        @status_code = '505' # HTTP Version Not Supported
+        @response_body = "it'd be a little weird if our app responded with this error"
+      end
+
+      it "should raise an Sfn::Error and include the response body" do
+        begin
+          @get.call
+        rescue Sfn::Error => e
+          e.class.should == Sfn::Error
+          e.message.should == "Encountered error. Body of response:\n" + @response_body
+        end
+      end
+    end
+  end
+
+  # ==== POST ==================================================================================================
+  describe "#post" do
+    before(:each) do
+      @response = nil
+      @status_code = '200'
+      @post = lambda do
+        FakeWeb.register_uri(
+          :post,
+          'http://test',
+          :body => @response_body,
+          :status => [@status_code]
+        )
+        loader = Sfn::Loader.new
+        stub(loader).add_authentication {}
+        @response = loader.post('http://test', "a=b")
+      end
+    end
+
+    describe "when the status is successful (2xx)" do
+      before(:each) do
+        @status_code.should == '200'
+        @response_body = {:id => "123", :domain => "foo.bar"}.to_json
+        @post.call
+      end
+
+      it "should return a status of :ok and the response body" do
+        @response.should == [:ok, @response_body]
+      end
+    end
+
+    describe "when the status is 400 (bad request)" do
+      before(:each) do
+        @status_code = '400'
+        @response_body = 'some error message'.to_json
+      end
+
+      it "should return raise an Sfn::BadRequest error and the response body" do
+        @post.should raise_error(Sfn::BadRequest, "Bad request. Response body:\n" + @response_body)
+      end
+    end
+
+    describe "when there is an authentication error" do
+      describe "when the status is 401 (Unauthorized)" do
+        before(:each) do
+          @status_code = '401'
+        end
+
+        it "should raise an Sfn::AuthorizationError" do
+          @post.should raise_error(Sfn::AuthorizationError, "Not authorized")
+        end
+      end
+
+      describe "when the status is 403 (Forbidden)" do
+        before(:each) do
+          @status_code = '403'
+        end
+        
+        it "should raise an Sfn::AuthorizationError" do
+          @post.should raise_error(Sfn::AuthorizationError, "Not authorized")
+        end
+      end
+    end
+
+    describe "when the status is 404 (Not Found)" do
+      before(:each) do
+        @status_code = '404'
+      end
+
+      it "should raise an Sfn::NotFound error" do
+        @post.should raise_error(Sfn::NotFound, "Not found")
+      end
+    end
+
+  # ---- MAINTENANCE --------------------------------------------------------------------------------------------------
+
+    shared_examples_for "the site is in maintenance mode" do
+
+      describe "and there is not an element with a class of error_message_summary in the HTML" do
+        before(:each) do
+          FakeWeb.register_uri(:get, 'http://test', :body => "blah", :status => "503")
+        end
+
+        it "should raise an error and include the default maintenance message" do
+          @post.should raise_error(Sfn::SiteMaintenance, "The site is down for maintenance. Please try again later.")
+        end
+      end
+
+      describe "and there is an element with a class of error_message_summary in the HTML" do
+        before(:each) do
+          @custom_error = "Something crazy is going down!"
+          @response_body = "<html><head></head><body><h2 class='error_message_summary'>#{@custom_error}</h2></body>"
+          FakeWeb.register_uri(:get, 'http://test', :body => @response_body, :status => "503")
+        end
+
+        it "should raise an error and include the contents of the element" do
+          @post.should raise_error(Sfn::SiteMaintenance, @custom_error)
+        end
+      end
+
+    end
+
+    describe "when the status is 405 (Method Not Allowed)" do
+      before(:each) do
+        @status_code = '405'
+        @response_body = "blah blah maintenance blah"
+      end
+
+      it_should_behave_like "the site is in maintenance mode"
+
+      describe "when the site is not in maintenance mode" do
+        before(:each) do
+          FakeWeb.register_uri(:get, 'http://test', :body => "blah", :status => "200")
+        end
+
+        it "should raise an error and include the reponse body" do
+          @post.should raise_error(Sfn::MethodNotAllowed, "Method not allowed")
+        end
+      end
+    end
+
+    describe "when the status is 503 (Service Unavailable)" do
+      before :each do
+        @status_code = '503'
+        @response_body = "blah blah maintenance mode"
+      end
+
+      it_should_behave_like "the site is in maintenance mode"
+    end
+
+
+    describe "when the error is not one we explicitly check for" do
+      before(:each) do
+        @status_code = '505' # HTTP Version Not Supported
+        @response_body = "it'd be a little weird if our app responded with this error"
+      end
+
+      it "should raise an Sfn::Error and include the response body" do
+        begin
+          @post.call
+        rescue Sfn::Error => e
+          e.class.should == Sfn::Error
+          e.message.should == "Encountered error. Body of response:\n" + @response_body
+        end
+      end
+    end
+
+  end
+
+end

data/spec/satisfaction_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Satisfaction do
+
+  describe "#request_token" do
+
+    describe "when the http response is 200 OK" do
+      before :each do
+        @sfn.set_consumer('key', 'secret')
+
+        FakeWeb.register_uri(
+          :get,
+          "http://#{@app_host}/api/request_token",
+          :body => "oauth_token=foo&oauth_token_secret=bar",
+          :status => ['200']
+        )
+      end
+
+      it "should be successful" do
+        oauth = @sfn.request_token
+        oauth.token.first.should == "foo"
+        oauth.secret.first.should == "bar"
+      end
+    end
+
+    describe "when the http response is 503 Service Temporarily Unavailable" do
+      before(:each) do
+        FakeWeb.register_uri(
+          :get, 
+          "http://#{@app_host}/api/request_token",
+          :body => "<html><head><title>maintenance</title><head><body>maintenance</body></html>",
+          :status => ['503']
+        )
+      end
+
+      it "should raise an exception" do
+        lambda {@sfn.request_token}.should raise_exception(Sfn::Error)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,9 +1,37 @@
 require 'rubygems'
-require 'spec'
+require 'rspec'
+require 'fakeweb'
+require 'ruby-debug'
+require 'rr'
+
+Debugger.settings[:autolist] = 1
+Debugger.settings[:autoeval] = true
+Debugger.start
+
 $:.unshift "#{File.dirname(__FILE__)}/../lib"
 
 require 'satisfaction'
 
-Spec::Runner.configure do |config|
-  config.prepend_before(:each){ @satisfaction = Satisfaction.new(:root => 'http://api.getsatisfaction.com') }
-end
+RSpec.configure do |config|
+
+  config.mock_with(:rr)
+
+  config.before(:each) do
+    @app_host = 'app.gsfn:3000'
+    @api_host = 'api.gsfn:3001'
+    @sfn = Satisfaction.new(
+      :root => "http://#{@api_host}",
+      :autoload => false,
+      :request_token_url => "http://#{@app_host}/api/request_token",
+      :access_token_url => "http://#{@app_host}/api/access_token",
+      :authorize_url => "http://#{@app_host}/api/authorize"
+    )
+    FakeWeb.allow_net_connect = false
+  end
+
+  config.after(:each) do
+    FakeWeb.clean_registry
+    FakeWeb.allow_net_connect = true
+  end
+
+end

metadata

@@ -1,70 +1,202 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-satisfaction
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  hash: 5
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
-- Scott Fleckenstein
-- Josh Nichols
-- Pius Uzamere
+- Get Satisfaction
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-07-10 00:00:00 -07:00
+date: 2010-12-10 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: memcache-client
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 4
+        - 2
+        version: 1.4.2
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: memcache-client
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 5
+        - 0
         version: 1.5.0
-    version: 
+  type: :runtime
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: oauth
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 3
+        - 5
         version: 0.3.5
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        version: "2.2"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: open_gem
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.2
-    version: 
-description: Ruby interface to Get Satisfaction
-email: scott@getsatisfaction.com
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 10
+        - 4
+        version: 0.10.4
+  type: :development
+  version_requirements: *id010
+description: Get Satisfaction is a simple way to build online communities that enable productive conversations between companies and their customers. More than 46,000 companies use Get Satisfaction to provide a more social support experience, build better products, increase SEO and improve customer loyalty. Get Satisfaction communities are available at http://getsatisfaction.com.
+email: 
+- nerds+rubygems@getsatisfaction.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.txt
+- README.markdown
 files: 
-- .gitignore
 - CONTRIBUTORS.txt
+- Gemfile
+- Gemfile.lock
 - License.txt
-- README.txt
+- README.markdown
 - Rakefile
-- VERSION.yml
 - init.rb
 - lib/satisfaction.rb
 - lib/satisfaction/associations.rb
 - lib/satisfaction/cache/hash.rb
 - lib/satisfaction/cache/memcache.rb
 - lib/satisfaction/company.rb
+- lib/satisfaction/exceptions.rb
 - lib/satisfaction/external_dependencies.rb
 - lib/satisfaction/has_satisfaction.rb
 - lib/satisfaction/identity_map.rb
@@ -77,39 +209,50 @@ files:
 - lib/satisfaction/tag.rb
 - lib/satisfaction/topic.rb
 - lib/satisfaction/util.rb
+- lib/satisfaction/version.rb
 - ruby-satisfaction.gemspec
-- spec/company_spec.rb
-- spec/identity_map_spec.rb
+- spec/satisfaction/identity_map_spec.rb
+- spec/satisfaction/loader_spec.rb
+- spec/satisfaction_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/nullstyle/ruby-satisfaction
+homepage: https://github.com/satisfaction/ruby-satisfaction
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
-rubyforge_project: satisfaction
-rubygems_version: 1.3.4
+rubyforge_project: ruby-satisfaction
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Ruby interface to Get Satisfaction
+summary: Get Satisfaction ruby client
 test_files: 
-- spec/company_spec.rb
-- spec/identity_map_spec.rb
+- spec/satisfaction/identity_map_spec.rb
+- spec/satisfaction/loader_spec.rb
+- spec/satisfaction_spec.rb
 - spec/spec_helper.rb

data/.gitignore

@@ -1,3 +0,0 @@
-tmp/*
-log/*
-pkg

data/README.txt

@@ -1 +0,0 @@
-README

data/VERSION.yml

@@ -1,4 +0,0 @@
---- 
-:minor: 4
-:patch: 0
-:major: 0

data/spec/company_spec.rb

@@ -1,8 +0,0 @@
-require 'spec_helper'
-
-describe "Company loader" do
-  it "should work" do
-    @satisfaction.set_consumer('lmwjv4kzwi27', 'fiei6iv61jnoukaq1aylwd8vcmnkafrs')
-    p @satisfaction.request_token
-  end
-end

data/spec/identity_map_spec.rb

@@ -1,28 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe "Identity Map" do
-  it "should work single instances" do
-    c1 = @satisfaction.companies.get(4)
-    c2 = @satisfaction.companies.get(4)
-    
-    c1.object_id.should == c2.object_id
-  end
-  
-  it "should load one if the other gets loaded" do
-    c1 = @satisfaction.companies.get(4)
-    c2 = @satisfaction.companies.get(4)
-    c2.should_not be_loaded
-    
-    c1.load
-  
-    c2.should be_loaded
-    c2.domain.should == 'satisfaction'
-  end
-  
-  it "should work with pages too" do
-    c1 = @satisfaction.companies.get(4)
-    c2 = @satisfaction.companies.page(1, :q => 'satisfaction').first
-    
-    c1.object_id.should == c2.object_id
-  end
-end