hypertext_client 0.0.1 → 0.0.2

data/CHANGELOG

@@ -1,3 +1,6 @@
+## 0.0.2 (September 24, 2010)
+
+Support belongs_to for parent/child relationships, client classes in module.
 
 ## 0.0.1 (September 23, 2010)
 

data/lib/hypertext_client/hypertext_client.rb

@@ -18,16 +18,20 @@
 
 # Hypertext provides an HTTP client based on HTTParty, with a few assumptions baked in.
 module HypertextClient
-	VERSION = '0.0.1'
+	VERSION = '0.0.2'
 
 	extend ActiveSupport::Concern
 	# Include HTTParty
 	@_dependencies = [HTTParty, ActiveModel::Conversion, ActiveModel::Validations]
 
 	class NotFoundException < HTTParty::ResponseError; end
+	class MissingArgumentError < ArgumentError; end
 
 	included do
 		extend ActiveModel::Naming
+		class_attribute :parents
+		class_attribute :base_endpoint
+		self.parents = []
 		raise 'HypertextClient depends on ObjectStruct. Inherit from ObjectStruct.' unless self.ancestors.include? ObjectStruct
 	end
 
@@ -68,7 +72,7 @@ module HypertextClient
 
 	# Get a related property.
 	def get_related(related)
-		klass = related.to_s.singularize.classify.constantize
+		klass = (self.class.name.split('::').first + '::' + related.to_s.singularize.classify).constantize
 		result = klass.get(send (related.to_s+'_url').to_sym)
 
 		(class << self; self; end).instance_eval do
@@ -86,7 +90,13 @@ module HypertextClient
 
 		# Specify a base url for the client.
 		def base_url(base)
-			base_uri base + '/' + self.to_s.parameterize.pluralize
+			self.base_endpoint = base
+			base_uri self.base_endpoint + '/' + self.name.split('::').last.parameterize.pluralize
+		end
+
+		def belongs_to(*classes)
+			self.parents += classes.select {|c| c.respond_to? :model_name}
+			base_url self.base_endpoint + '/' + self.parents.map {|parent| parent.model_name.split('::').last.parameterize}.map{|name| "#{name.pluralize}/|#{name.singularize}|"} * '/'
 		end
 
 		# Override HTTParty's methods to allow assumptions about a '/' path.
@@ -104,6 +114,16 @@ module HypertextClient
 					path = ''
 				end
 
+				if self.parents.count > 0
+					options = args.first
+					raise MissingArgumentError.new("Options hash required; must include parent ids") unless options.is_a? Hash
+					self.parents.each do |parent|
+						key = parent.model_name.split('::').last.parameterize.singularize.to_sym
+						raise MissingArgumentError.new("Missing required argument: #{key}") unless options.has_key? key
+						base_uri self.base_uri.gsub("|#{key}|", options[key])
+					end
+				end
+
 				response = super(path, *args)
 				case response.code
 				when (200..299)

data/lib/hypertext_client.rb

@@ -16,6 +16,7 @@
 #
 # ---------------------------------------------------------------------------
 
+require 'active_support/core_ext/class/attribute'
 require 'active_support/inflector'
 require 'active_support/concern'
 require 'active_model'

data/test/test_hypertext_client.rb

@@ -8,7 +8,7 @@ begin; require 'redgreen'; rescue LoadError; end
 
 require 'hypertext_client'
 
-FAKE_ENDPOINT = "http://api.widgetsinc.com"
+FAKE_ENDPOINT = "http://api.skynetinc.com"
 
 FakeWeb.allow_net_connect = false
 FakeWeb.register_uri(:get,
@@ -26,6 +26,11 @@ FakeWeb.register_uri(:get,
 										 :body => {:name => 'Frobby Widget', :knob_url => FAKE_ENDPOINT + '/knobs/excellent_knob'}.to_json,
 										 :content_type => 'application/json')
 
+FakeWeb.register_uri(:get,
+										 FAKE_ENDPOINT + '/widgets/frobby_widget/buttons/red_button',
+										 :body => {:description => 'Scary Red Button'}.to_json,
+										 :content_type => 'application/json')
+
 FakeWeb.register_uri(:get,
 										 FAKE_ENDPOINT + '/widgets/not_there',
 										 :status => ['404', 'Not Found'],
@@ -33,47 +38,69 @@ FakeWeb.register_uri(:get,
 										 :content_type => 'application/json')
 
 
-class Widget < ObjectStruct
-	include HypertextClient
-	base_url FAKE_ENDPOINT
-	headers 'Accept' => 'application/json'
+module SkynetClient
+	extend ActiveSupport::Concern
+	@_dependencies = [HypertextClient]
+	included do
+		base_url FAKE_ENDPOINT
+		headers 'Accept' => 'application/json'
+	end
 end
 
-class Knob < ObjectStruct
-	include HypertextClient
-	base_url FAKE_ENDPOINT
-	headers 'Accept' => 'application/json'
+class SkynetClient::Widget < ObjectStruct
+	include SkynetClient
 end
 
+class SkynetClient::Knob < ObjectStruct
+	include SkynetClient
+end
+
+class SkynetClient::Button < ObjectStruct
+	include SkynetClient
+	belongs_to Widget
+end
+
+
 class HypertextClientTest < MiniTest::Unit::TestCase
 	include ActiveModel::Lint::Tests
 
 	def setup
 		# For ActiveModel tests
-		@model = Widget.get('frobby_widget')
+		@model = SkynetClient::Widget.get('frobby_widget')
 	end
 
 	def test_get_basic_resource
-		assert_equal 'Frobby Widget', Widget.get('frobby_widget').name
+		assert_equal 'Frobby Widget', SkynetClient::Widget.get('frobby_widget').name
 	end
 
 	def test_should_raise_not_found
-		assert_raises HypertextClient::NotFoundException do Widget.get('not_there') end
+		assert_raises HypertextClient::NotFoundException do SkynetClient::Widget.get('not_there') end
 	end
 
 	def test_should_get_index_array
-		response = Widget.get
+		response = SkynetClient::Widget.get
 		assert_instance_of Array, response
-		assert response.all? {|e| e.instance_of? Widget}
+		assert response.all? {|e| e.instance_of? SkynetClient::Widget}
 	end
 
 	def test_traverse_related
-		knob = Widget.get('frobby_widget').knob
+		knob = SkynetClient::Widget.get('frobby_widget').knob
 		assert_equal 'Adjustormatic', knob.label
 	end
 
 	def test_has_related?
-		assert Widget.get('frobby_widget').has_knob?
-		refute Widget.get('frobby_widget').has_lever?
+		assert SkynetClient::Widget.get('frobby_widget').has_knob?
+		refute SkynetClient::Widget.get('frobby_widget').has_lever?
+	end
+
+	def test_request_child_resources
+		button =  SkynetClient::Button.get 'red_button', :widget => 'frobby_widget'
+		assert_equal "Scary Red Button", button.description
+	end
+
+	def test_complain_if_no_parent_id_specified
+		assert_raises HypertextClient::MissingArgumentError do
+			SkynetClient::Button.get 'red_button'
+		end
 	end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Quid, Inc.
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-23 00:00:00 -07:00
+date: 2010-09-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency