party_resource 0.0.1

data/spec/unit/request_spec.rb

@@ -0,0 +1,103 @@
+require File.expand_path(File.join(__FILE__, '..', '..', 'spec_helper'))
+
+describe PartyResource::Request do
+
+  subject { PartyResource::Request.new(verb, path, context, args, params) }
+  let_mock(:context, :parameter_values => {})
+  let_mock(:verb)
+  let_mock(:value)
+  let(:params) { {} }
+  let(:path) { '/path' }
+
+  context 'with static path' do
+    let(:path) { 'mypath/file.json' }
+    let(:args) { {} }
+
+    its(:verb) { should == verb }
+    its(:path) { should == path }
+    its(:data) { should == {} }
+
+    it "should merge http_data with passed options" do
+      subject.http_data(:foo => :bar).should == { :foo => :bar }
+    end
+  end
+
+  context 'with a parameter' do
+    let(:path) { 'mypath/file.json' }
+    let(:args) { {:param => value} }
+
+    its(:verb) { should == verb }
+    its(:path) { should == path }
+    its(:data) { should == args }
+  end
+
+  context 'with a parameter referenced in the path' do
+    let(:path) { 'mypath/:param.json' }
+    let(:args) { {:param => 'THE_VALUE', :second => value} }
+
+    its(:verb) { should == verb }
+    its(:path) { should == 'mypath/THE_VALUE.json' }
+    its(:data) { should == {:second => value } }
+  end
+
+  context 'with an object variable referenced in the path' do
+    let_mock(:context, :parameter_values => {:var => 'THE_VALUE'})
+    let(:path) { 'mypath/:param/:var.json' }
+    let(:args) { {:param => 'PARAM_VALUE', :second => value} }
+
+    its(:verb) { should == verb }
+    its(:path) { should == 'mypath/PARAM_VALUE/THE_VALUE.json' }
+    its(:data) { should == { :second => value } }
+    it 'asks the context object for required data values' do
+      context.should_receive(:parameter_values).with([:var])
+      subject.path
+    end
+  end
+
+  context 'with extra parameters' do
+    let(:path) { '/path/:id' }
+    let_mock(:p1)
+    let_mock(:p2)
+    let_mock(:a1)
+    let_mock(:a2)
+    let(:params) { {:id => mock(:id2), :param => p1, :param2 => p2} }
+    let(:args) { {:id => 'THE_ID', :param => a1, :arg2 => a2} }
+    it 'merges them into the request data' do
+      subject.path.should == '/path/THE_ID'
+      subject.data.should == {:param => a1, :param2 => p2, :arg2 => a2}
+    end
+  end
+
+  context 'for a GET request' do
+    let(:verb) { :get }
+    let_mock(:args)
+    its(:http_data) { { :query => args } }
+
+    context 'with no data' do
+      let(:args) { {} }
+      its(:http_data) { should == {} }
+    end
+  end
+
+  [:post, :put, :delete].each do |http_verb|
+    context "for a #{http_verb} request" do
+      let(:verb) { http_verb }
+      let(:args) { {:param => value} }
+      its(:http_data) { should == { :body => args } }
+    end
+
+    context 'with no data' do
+      let(:args) { {} }
+      its(:http_data) { should == {} }
+    end
+  end
+
+  context 'encoding the path' do
+    let(:args) { {} }
+    let(:path) { '/path needing encoding' }
+    it 'encodes the path' do
+      subject.path.should == '/path%20needing%20encoding'
+    end
+  end
+
+end

data/spec/unit/route_spec.rb

@@ -0,0 +1,118 @@
+require File.expand_path(File.join(__FILE__, '..', '..', 'spec_helper'))
+
+describe PartyResource::Route do
+
+  subject { PartyResource::Route.new options }
+
+  let_mock(:path)
+  let_mock(:object)
+  let_mock(:raw_result)
+  let(:connector) { mock(:connector, :fetch => raw_result) }
+  let(:klass) { Class.new {def initialize(data); end} }
+  let(:options) { { :get => path, :as => klass } }
+
+  before do
+    PartyResource.stub(:Connector => connector)
+  end
+
+  describe ".call" do
+
+    [:get, :put, :post, :delete].each do |verb|
+
+      context "for a #{verb} request" do
+        let(:options) { { verb => path, :as => klass } }
+
+        it "performs a #{verb} request to the path with the connector" do
+          request = mock(:request)
+          PartyResource::Request.should_receive(:new).with(verb, path, object, anything, anything).and_return(request)
+          connector.should_receive(:fetch).with(request)
+          subject.call(object)
+        end
+      end
+    end
+
+    context 'with more than one verb passed' do
+      let(:options) { { :post => path, :get => path } }
+
+      it "raises an argument error" do
+        lambda{ subject.call(object) }.should raise_error(ArgumentError)
+      end
+    end
+
+    context "with no variables" do
+      let(:options) { { :get => path, :as => klass } }
+
+      it "builds the request path" do
+        PartyResource::Request.should_receive(:new).with(:get, path, object, {}, anything)
+        subject.call(object)
+      end
+
+    end
+
+    context "with some variables" do
+      let(:options) { { :get => path, :with => [:a, :b, :c], :as => klass } }
+
+      it "builds the request path" do
+        PartyResource::Request.should_receive(:new).with(:get, path, object, {:a => 1, :b => 2, :c => 3}, anything)
+        subject.call(object, 1, 2, 3)
+      end
+
+      it "raises an ArgumentError for the wrong number of arguments" do
+        lambda { subject.call(object, 1, 2, 3, 4) }.should raise_error(ArgumentError)
+        lambda { subject.call(object) }.should raise_error(ArgumentError)
+      end
+    end
+
+    context 'when returning as class' do
+      let_mock(:result_object)
+
+      it 'builds an object from the data returned' do
+        klass.should_receive(:new).with(raw_result).and_return(result_object)
+        subject.call(object).should == result_object
+      end
+    end
+
+    context 'when returning as :raw' do
+      let(:options) { { :get => path, :as => :raw } }
+      it 'builds an object from the data returned' do
+        klass.should_not_receive(:new)
+        subject.call(object).should == raw_result
+      end
+    end
+
+    context 'when returning as class with builder method' do
+      let_mock(:result_object)
+      let(:options) { { :get => path, :as => [klass, :builder] } }
+
+      it 'builds an object from the data returned' do
+        klass.should_receive(:builder).with(raw_result).and_return(result_object)
+        subject.call(object).should == result_object
+      end
+    end
+
+    context 'when returning as proc' do
+      let_mock(:result_object)
+      let(:options) { { :get => path, :as => lambda {|data| data.morph } } }
+
+      it 'builds an object from the data returned' do
+        raw_result.should_receive(:morph).and_return(result_object)
+        subject.call(object).should == result_object
+      end
+    end
+
+    context 'when returning an array' do
+      let(:raw_result) { [1, 2] }
+      let(:options) { { :get => path, :as => lambda {|data| "X#{data}" } } }
+      it 'builds each value individually' do
+        subject.call(object).should == %w{ X1 X2 }
+      end
+    end
+
+    context 'with an extra params hash' do
+      it '' do
+        lambda { subject.call(object, {:params => :data}) }.should_not raise_error
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: party_resource
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tristan Harris
+- Steve Tooke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-26 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: party_resource is a framework for building ruby objects which interact with a REST api. Built on top of HTTParty.
+email: dev+party_resource@edendevelopment.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/party_resource.rb
+- lib/party_resource/buildable.rb
+- lib/party_resource/connector.rb
+- lib/party_resource/connector/base.rb
+- lib/party_resource/exceptions.rb
+- lib/party_resource/method_define.rb
+- lib/party_resource/party_resource.rb
+- lib/party_resource/property.rb
+- lib/party_resource/request.rb
+- lib/party_resource/route.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/edendevelopment/party_resource.git
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple REST interface for ruby objects.
+test_files: 
+- spec/fixtures/other_class.rb
+- spec/fixtures/test_base_class.rb
+- spec/fixtures/test_class.rb
+- spec/integration/integration_spec.rb
+- spec/spec_helper.rb
+- spec/unit/connector/base_spec.rb
+- spec/unit/connector_spec.rb
+- spec/unit/exceptions_spec.rb
+- spec/unit/party_resource_spec.rb
+- spec/unit/request_spec.rb
+- spec/unit/route_spec.rb