ruby-satisfaction 0.6.7 → 0.7.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-satisfaction (0.6.5)
+    ruby-satisfaction (0.7.0)
       activesupport (~> 2.3)
       json (>= 1.4.6)
       memcache-client (>= 1.5.0)

data/README.markdown

@@ -11,6 +11,28 @@ For questions, please visit the [Get Satisfaction API community][3]
 
 Changelog
 =========
+0.7.0
+
+* Revised Sfn::Resource so that it supports calls to API endpoints for nested resources
+  (e.g. /companies/cid/products/pid/topics).
+
+IMPORTANT NOTE: This version changes the gem behavior in a way that may introduce backwards incompatibility. In
+particular, with prior versions, the following code:
+
+      Satisfaction.new.companies['company_domain'].products['p_slug'].topics['t_slug'].tags
+
+ignores the chained context of the final method call and simply sends a GET request to the following API endpoint:
+
+      /topics/t_slug/tags
+
+With this version, however, the gem will make API calls for nested resources in the API that correspond to the chained
+method calls. In particular, the above code will instead attempt to send a GET request to the following endpoint:
+
+      /companies/company_domain/products/p_slug/topics/t_slug/tags
+
+In this particular case, the endpoint does not exist in the Get Satisfaction REST API, so API calls made to it will
+yield a 404 Not Found response error.
+
 0.6.7
 
 * Fixed Sfn::Loader#get so it uses cached content when a 304 Not Modified is received.

data/lib/satisfaction.rb

@@ -102,7 +102,13 @@ class Satisfaction
   end
   
   def authorize_url(token)
-    "#{options[:authorize_url]}?oauth_token=#{token.token}"
+    uri = URI.parse(options[:authorize_url])
+    if uri.query.present?
+      uri.query += "&oauth_token=#{token.token}"
+    else
+      uri.query = "oauth_token=#{token.token}"
+    end
+    uri.to_s
   end
   
   def access_token(token)

data/lib/satisfaction/company.rb

@@ -2,10 +2,6 @@ class Sfn::Company < Sfn::Resource
   
   attributes :domain, :name, :logo, :description
   
-  def path
-    "/companies/#{@id}"
-  end
-  
   def setup_associations
     has_many :people, :url => "#{path}/people"
     has_many :topics, :url => "#{path}/topics"
@@ -15,4 +11,4 @@ class Sfn::Company < Sfn::Resource
     
   end
   
-end
+end

data/lib/satisfaction/identity_map.rb

@@ -6,16 +6,16 @@ class Sfn::IdentityMap
     @pages = {}
   end
   
-  def get_record(klass, id, &block)
-    result = @records[[klass, id]]
+  def get_record(klass, id, path='', &block)
+    result = @records[[klass, id, path]]
     result ||= begin
-      obj = yield(klass, id)
-      @records[[klass, id]] = obj
+      obj = yield(klass, id, path)
+      @records[[klass, id, path]] = obj
     end
     result
   end
   
-  def expire_record(klass, id)
-    @records[[klass, id]] = nil
+  def expire_record(klass, id, path='')
+    @records[[klass, id, path]] = nil
   end
-end
+end

data/lib/satisfaction/person.rb

@@ -1,10 +1,6 @@
 class Sfn::Person < Sfn::Resource
   attributes :name, :id, :photo, :tagline
   
-  def path
-    "/people/#{@id}"
-  end
-  
   def setup_associations
     has_many :replies, :url => "#{path}/replies"
     has_many :topics, :url => "#{path}/topics"
@@ -21,4 +17,4 @@ class Me < Sfn::Person
     @id = self.attributes["id"]
     setup_associations
   end
-end
+end

data/lib/satisfaction/product.rb

@@ -3,10 +3,6 @@ class Sfn::Product < Sfn::Resource
   attribute :last_active_at, :type => Time
   attribute :created_at, :type => Time
   
-  def path
-    "/products/#{@id}"
-  end
-  
   def setup_associations
     has_many :topics, :url => "#{path}/topics"
     has_many :people, :url => "#{path}/people"
@@ -14,4 +10,4 @@ class Sfn::Product < Sfn::Resource
     has_many :tags, :url => "#{path}/tags"
   end
 
-end
+end

data/lib/satisfaction/reply.rb

@@ -3,11 +3,7 @@ class Sfn::Reply < Sfn::Resource
   attribute :created_at, :type => Time
   attribute :author, :type => Sfn::Person
   
-  def path
-    "/replies/#{id}"
-  end
-  
   def setup_associations
     belongs_to :topic
   end
-end
+end

data/lib/satisfaction/resource.rb

@@ -4,18 +4,19 @@ class Sfn::Resource < Sfn::HasSatisfaction
   require 'satisfaction/resource/attributes'
   include ::Associations
   include Attributes
-  attr_reader :id
+  attr_reader :id, :prefix
   include Sfn::Util
   
   
-  def initialize(id, satisfaction)
+  def initialize(id, satisfaction, prefix='')
     super satisfaction
     @id = id
+    @prefix = prefix
     setup_associations if respond_to?(:setup_associations)
   end
   
   def path
-    raise "path not implemented in Resource base class"
+    "#{prefix}/#{@id}"
   end
   
   def load
@@ -82,8 +83,8 @@ class Sfn::ResourceCollection < Sfn::HasSatisfaction
   
   def get(id, options={})
     #options currently ignored
-    satisfaction.identity_map.get_record(klass, id) do
-      klass.new(id, satisfaction)
+    satisfaction.identity_map.get_record(klass, id, path) do
+      klass.new(id, satisfaction, path)
     end
   end
   
@@ -206,4 +207,4 @@ class Sfn::Page < Sfn::HasSatisfaction
       result
     end
   end
-end
+end

data/lib/satisfaction/resource/attributes.rb

@@ -61,7 +61,7 @@ class Sfn::Resource
     case value
     when Hash
       id = value['id']
-      returning(new(id, satisfaction)){|r| r.attributes = value}
+      new(id, satisfaction).tap {|r| r.attributes = value}
     else
       new(value, satisfaction)
     end

data/lib/satisfaction/tag.rb

@@ -1,14 +1,10 @@
 class Sfn::Tag < Sfn::Resource
   attributes :name
 
-  def path
-    "/tags/#{@id}"
-  end
-  
   def setup_associations
     has_many :topics, :url => "#{path}/topics"
     has_many :companies, :url => "#{path}/companies"
     has_many :products, :url => "#{path}/products"
   end
 
-end
+end

data/lib/satisfaction/topic.rb

@@ -4,10 +4,6 @@ class Sfn::Topic < Sfn::Resource
   attribute :created_at, :type => Time
   attribute :author, :type => Sfn::Person
   
-  def path
-    "/topics/#{@id}"
-  end
-  
   def setup_associations
     has_many :replies, :url => "#{path}/replies"
     has_many :people, :url => "#{path}/people"
@@ -17,4 +13,4 @@ class Sfn::Topic < Sfn::Resource
     belongs_to :company
   end
 
-end
+end

data/lib/satisfaction/version.rb

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

data/spec/satisfaction/identity_map_spec.rb

@@ -38,7 +38,7 @@ describe "Identity Map" do
   end
   
   it "should work with pages too" do
-    c1 = @sfn.companies.get(4)
+    c1 = @sfn.companies.page(1, :q => 'satisfaction').first
     c2 = @sfn.companies.page(1, :q => 'satisfaction').first
     
     c1.object_id.should == c2.object_id

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-satisfaction
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: 
+  hash: 3
+  prerelease: false
   segments: 
   - 0
-  - 6
   - 7
-  version: 0.6.7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Get Satisfaction
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-08 00:00:00 -07:00
+date: 2011-09-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -280,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ruby-satisfaction
-rubygems_version: 1.4.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Get Satisfaction ruby client