sessionm-resthome 0.8.1

data/spec/lib/resthome_spec.rb

@@ -0,0 +1,546 @@
+require 'helper'
+
+describe RESTHome do
+
+  before(:each) do
+    @service_class = Class.new RESTHome
+    FakeWeb.allow_net_connect = false
+  end
+
+  class DummyProduct
+    attr_accessor :data
+    def initialize(resource)
+      raise 'Missing id' unless resource['id']
+      @data = resource
+    end
+  end
+
+  def fakeweb_response(method, url, code, value)
+    FakeWeb.clean_registry
+    status = [code.to_s, 'Ok']
+    FakeWeb.register_uri(method, url, :status => status, :body => value.to_json, :content_type => 'application/jsonrequest')
+  end
+
+  it "should build the url and options" do
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+    @service.basic_auth = {:username => 'user', :password => 'x'}
+
+    @service.build_url('/items.json').should == 'http://test.dev/items.json'
+    options = {}
+    @service.build_options!(options)
+    options.should == {:basic_auth => {:username => 'user', :password => 'x'}}
+
+    options = {}
+    fakeweb_response(:get, 'http://user:x@test.dev/items.json', 200, {})
+    @service.request :get, '/items.json', options
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/items.json'
+    @service.request_options.should == {:basic_auth => {:username => 'user', :password => 'x'}}
+  end
+
+  it "should be able to create a route using GET" do
+    @service_class.route :products, '/products.json'
+    @service_class.method_defined?(:products).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    fakeweb_response(:get, 'http://test.dev/products.json', 200,
+                     [{'product' => {'id' => 1, 'name' => 'Item1'}}, {'product' => {'id' => 2, 'name' => 'Item2'}}])
+    @service.products
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products.json'
+    @service.request_options.should == {}    
+  end
+
+  it "should be able to create a route using POST" do
+    @service_class.route :create_product, '/products.json', :resource => 'product'
+    @service_class.route :add_products, '/products.json'
+    @service_class.method_defined?(:create_product).should be_true
+    @service_class.method_defined?(:add_products).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    # Create
+    fakeweb_response(:post, 'http://test.dev/products.json', 201, {'product' => {'id' => 1, 'name' => 'Item1'}})
+    @service.create_product :name => 'Item1'
+    @service.request_method.should == :post
+    @service.request_url.should == 'http://test.dev/products.json'
+    @service.request_options.should == {:body => {'product' => {:name => 'Item1'}}}
+
+    # Add
+    fakeweb_response(:post, 'http://test.dev/products.json', 201, {'product' => {'id' => 2, 'name' => 'Item2'}})
+    @service.add_products 'product' => {:name => 'Item2'}
+    @service.request_method.should == :post
+    @service.request_url.should == 'http://test.dev/products.json'
+    @service.request_options.should == {:body => {'product' => {:name => 'Item2'}}}
+  end
+
+  it "should be able to create a route using PUT" do
+    @service_class.route :edit_product, '/products/:product_id.json', :resource => 'product'
+    @service_class.route :update_products, '/products/:product_id.json'
+    @service_class.method_defined?(:edit_product).should be_true
+    @service_class.method_defined?(:update_products).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    # Edit
+    fakeweb_response(:put, 'http://test.dev/products/1.json', 200, {'product' => {'id' => 1, 'name' => 'Item1'}})
+    @service.edit_product 1, :name => 'Item1'
+    @service.request_method.should == :put
+    @service.request_url.should == 'http://test.dev/products/1.json'
+    @service.request_options.should == {:body => {'product' => {:name => 'Item1'}}}
+
+    # Update
+    fakeweb_response(:put, 'http://test.dev/products/2.json', 200, {'product' => {'id' => 2, 'name' => 'Item2'}})
+    @service.update_products 2, 'product' => {:name => 'Item2'}
+    @service.request_method.should == :put
+    @service.request_url.should == 'http://test.dev/products/2.json'
+    @service.request_options.should == {:body => {'product' => {:name => 'Item2'}}}
+  end
+
+  it "should be able to create a route using DELETE" do
+    @service_class.route :delete_product, '/products/:product_id.json'
+    @service_class.method_defined?(:delete_product).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    # Delete
+    fakeweb_response(:delete, 'http://test.dev/products/1.json', 200, {})
+    @service.delete_product 1
+    @service.request_method.should == :delete
+    @service.request_url.should == 'http://test.dev/products/1.json'
+    @service.request_options.should == {}
+  end
+
+  it "should be able to setup RESTful routes" do
+    @service_class.rest :product, :products, '/products.json'
+    @service_class.method_defined?(:products).should be_true
+    @service_class.method_defined?(:product).should be_true
+    @service_class.method_defined?(:create_product).should be_true
+    @service_class.method_defined?(:edit_product).should be_true
+    @service_class.method_defined?(:delete_product).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    # Get products
+    fakeweb_response(:get, 'http://test.dev/products.json', 200,
+                                [{'product' => {'id' => 1, 'name' => 'Item1'}},{'product' => {'id' => 2, 'name' => 'Item2'}}])
+    @service.products
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products.json'
+    @service.request_options.should == {}    
+
+    # Get a product
+    fakeweb_response(:get, 'http://test.dev/products/1.json', 200, {'product' => {'id' => 1, 'name' => 'Item1'}})
+    @service.product 1
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products/1.json'
+    @service.request_options.should == {}    
+
+    # Create
+    fakeweb_response(:post, 'http://test.dev/products.json', 201, {'product' => {'id' => 1, 'name' => 'Item1'}})
+    @service.create_product :name => 'Item1'
+    @service.request_method.should == :post
+    @service.request_url.should == 'http://test.dev/products.json'
+    @service.request_options.should == {:body => {'product' => {:name => 'Item1'}}}
+
+    # Edit
+    fakeweb_response(:put, 'http://test.dev/products/1.json', 200, {'product' => {'id' => 1, 'name' => 'Item1'}})
+    @service.edit_product 1, :name => 'Item1'
+    @service.request_method.should == :put
+    @service.request_url.should == 'http://test.dev/products/1.json'
+    @service.request_options.should == {:body => {'product' => {:name => 'Item1'}}}
+
+    # Delete
+    fakeweb_response(:delete, 'http://test.dev/products/1.json', 200, {})
+    @service.delete_product 1
+    @service.request_method.should == :delete
+    @service.request_url.should == 'http://test.dev/products/1.json'
+    @service.request_options.should == {}
+  end
+
+  it "should be able to save resources" do
+    @service_class.rest :product, :products, '/products.json'
+    @service_class.method_defined?(:create_product).should be_true
+    @service_class.method_defined?(:edit_product).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    # Create
+    fakeweb_response(:post, 'http://test.dev/products.json', 201, {'product' => {'id' => 1, 'name' => 'Item1'}})
+    @service.save :product, :name => 'Item1'
+    @service.request_method.should == :post
+    @service.request_url.should == 'http://test.dev/products.json'
+    @service.request_options.should == {:body => {'product' => {:name => 'Item1'}}}
+
+    # Edit
+    fakeweb_response(:put, 'http://test.dev/products/1.json', 200, {'product' => {'id' => 1, 'name' => 'Item1'}})
+    @service.save :product, :id => 1, :name => 'Item1'
+    @service.request_method.should == :put
+    @service.request_url.should == 'http://test.dev/products/1.json'
+    @service.request_options.should == {:body => {'product' => {:id => 1, :name => 'Item1'}}}
+  end
+
+  it "should be able to change the return value using a class" do
+    @service_class.rest :product, :products, '/products.json', :return => DummyProduct
+    @service_class.method_defined?(:products).should be_true
+    @service_class.method_defined?(:product).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    # Get products
+    fakeweb_response(:get, 'http://test.dev/products.json', 200,
+                                [{'product' => {'id' => 1, 'name' => 'Item1'}}, {'product' => {'id' => 2, 'name' => 'Item2'}}])
+    products = @service.products
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products.json'
+    @service.request_options.should == {}    
+    products.is_a?(Array).should be_true
+    products[1].data['id'].should == 2
+
+    # Get a product
+    fakeweb_response(:get, 'http://test.dev/products/1.json', 200, {'product' => {'id' => 1, 'name' => 'Item1'}})
+    product = @service.product 1
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products/1.json'
+    @service.request_options.should == {}    
+    product.is_a?(DummyProduct).should be_true
+    product.data['id'].should == 1
+  end
+
+  it "should be able to change the return value using a function" do
+    @service_class.send(:define_method, :handle_product) { |resource| resource['name'] }
+    @service_class.rest :product, :products, '/products.json', :return => :handle_product
+    @service_class.method_defined?(:products).should be_true
+    @service_class.method_defined?(:product).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    # Get products
+    fakeweb_response(:get, 'http://test.dev/products.json', 200, [{'product' => {'id' => 1, 'name' => 'Item1'}},
+                                   {'product' => {'id' => 2, 'name' => 'Item2'}}])
+    products = @service.products
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products.json'
+    @service.request_options.should == {}    
+    products.is_a?(Array).should be_true
+    products.should == ['Item1', 'Item2']
+
+    # Get a product
+    fakeweb_response(:get, 'http://test.dev/products/1.json', 200, {'product' => {'id' => 1, 'name' => 'Item1'}})
+    product = @service.product 1
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products/1.json'
+    @service.request_options.should == {}    
+    product.is_a?(String).should be_true
+    product.should == 'Item1'
+  end
+
+  it "should be able to use a find_<resource> method to adjust the query option" do
+    @service_class.route :find_product, '/products/lookup.json', :resource => 'product'
+    @service_class.route :find_component, '/products/:product_id/components/lookup.json', :resource => 'component'
+    @service_class.method_defined?(:find_product).should be_true
+    @service_class.method_defined?(:find_component).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    # Get a product
+    fakeweb_response(:get, 'http://test.dev/products/lookup.json?name=Item1', 200, {'product' => {'id' => 1, 'name' => 'Item1'}})
+    @service.find_product_by_name 'Item1'
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products/lookup.json'
+    @service.request_options.should == {:query => {'name' => 'Item1'}}
+
+    # Get a component
+    fakeweb_response(:get, 'http://test.dev/products/1/components/lookup.json?name=C2', 200, {'component' => {'id' => 100, 'name' => 'C2'}})
+    @service.find_component_by_name 1, 'C2'
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products/1/components/lookup.json'
+    @service.request_options.should == {:query => {'name' => 'C2'}}
+  end
+
+  it "should raise invalid response" do
+    @service_class.rest :product, :products, '/products.json'
+    @service_class.method_defined?(:product).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    # Get a product
+    fakeweb_response(:get, 'http://test.dev/products/1.json', 400, {})
+    lambda{ @service.product 1 }.should raise_error(RESTHome::InvalidResponse)
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products/1.json'
+    @service.request_options.should == {}
+  end
+
+  it "should raise error if find function is not found" do
+    @service_class.route :find_product, '/products/lookup.json', :resource => 'product'
+    @service_class.method_defined?(:find_product).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    lambda{ @service.find_component_by_name 'Item1' }.should raise_error(RESTHome::MethodMissing)
+    lambda{ @service.save :product, {:name => 'Item1'} }.should raise_error(RESTHome::MethodMissing)
+    lambda{ @service.save :product, {:id => 1, :name => 'Item1'} }.should raise_error(RESTHome::MethodMissing)
+  end
+
+  it "should be able to use blocks on the response" do
+    @service_class.route :products, '/products.json', :resource => 'product'
+    @service_class.method_defined?(:products).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    fakeweb_response(:get, 'http://test.dev/products.json', 200,
+                     [{'product' => {'id' => 1, 'name' => 'Item1'}}, {'product' => {'id' => 2, 'name' => 'Item2'}}])
+    @names = @service.products do |product|
+      product['name']
+    end
+
+    @names.should == ['Item1', 'Item2']
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products.json'
+    @service.request_options.should == {}    
+  end
+
+  it "should be able to use blocks on the response" do
+    @service_class.route :products, '/products.json', :resource => 'product', :return => Proc.new { |res| res['name'] }
+    @service_class.method_defined?(:products).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    fakeweb_response(:get, 'http://test.dev/products.json', 200,
+                     [{'product' => {'id' => 1, 'name' => 'Item1'}}, {'product' => {'id' => 2, 'name' => 'Item2'}}])
+    @names = @service.products
+
+    @names.should == ['Item1', 'Item2']
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products.json'
+    @service.request_options.should == {}    
+  end
+
+  it "should be able to use blocks on the response" do
+    @service_class.route :products, '/products.json', :resource => 'product', :return => lambda { |res| res['name'] }
+    @service_class.method_defined?(:products).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    fakeweb_response(:get, 'http://test.dev/products.json', 200,
+                     [{'product' => {'id' => 1, 'name' => 'Item1'}}, {'product' => {'id' => 2, 'name' => 'Item2'}}])
+    @names = @service.products
+
+    @names.should == ['Item1', 'Item2']
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products.json'
+    @service.request_options.should == {}    
+  end
+
+  it "should be able to use blocks on the response" do
+    @service_class.route :products, '/products.json', :resource => 'product' do |res|
+      res['name']
+    end
+    @service_class.method_defined?(:products).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    fakeweb_response(:get, 'http://test.dev/products.json', 200,
+                     [{'product' => {'id' => 1, 'name' => 'Item1'}}, {'product' => {'id' => 2, 'name' => 'Item2'}}])
+    @names = @service.products
+
+    @names.should == ['Item1', 'Item2']
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/products.json'
+    @service.request_options.should == {}    
+  end
+
+  it "should be able to parse cookies" do
+    @service = RESTHome.new
+    @service.save_cookies [nil, '', "test=1111; path=/; expires=Sat, 30-Nov-2002 00:00:00 GMT", "dev=1", "missing="]
+    @service.cookies['test'].should == '1111'
+    @service.cookies['dev'].should == '1'
+    @service.cookies['missing'].should be_nil
+  end
+
+  it "should be able to setup default query parameters" do
+    @service_class.route :find_songs, '/songs.json', :query => {'search' => 'all'}
+    @service_class.method_defined?(:find_songs).should be_true
+
+    @service = @service_class.new
+    @service.base_uri = 'http://test.dev'
+
+    fakeweb_response(:get, 'http://test.dev/songs.json?search=all', 200, [])
+    @names = @service.find_songs
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/songs.json'
+    @service.request_options.should == {:query => {'search' => 'all'}}
+
+    fakeweb_response(:get, 'http://test.dev/songs.json?search=test', 200, [])
+    @names = @service.find_songs_by_search 'test'
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/songs.json'
+    @service.request_options.should == {:query => {'search' => 'test'}}
+
+    fakeweb_response(:get, 'http://test.dev/songs.json?search=test2', 200, [])
+    @names = @service.find_songs :query => {'search' => 'test2'}
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/songs.json'
+    @service.request_options.should == {:query => {'search' => 'test2'}}
+  end
+
+  it "namespaces for convenience" do
+    @service_class.class_eval do
+      base_uri 'http://test.dev'
+
+      namespace '/users/1' do
+        route :find_songs,  '/songs.json'
+        route :find_albums, '/albums.json'
+        namespace '/videos' do
+          route :find_videos, '/search.json'
+        end
+        route :find_tracks, '/tracks.json'
+      end
+      route :tracks, '/tracks.json'
+    end
+
+    @service_class.method_defined?(:find_songs).should be_true
+    @service_class.method_defined?(:find_albums).should be_true
+    @service_class.method_defined?(:tracks).should be_true
+
+    @service = @service_class.new
+
+    fakeweb_response(:get, 'http://test.dev/users/1/songs.json', 200, [])
+    @service.find_songs
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/users/1/songs.json'
+
+    fakeweb_response(:get, 'http://test.dev/users/1/albums.json', 200, [])
+    @service.find_albums
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/users/1/albums.json'
+
+    fakeweb_response(:get, 'http://test.dev/users/1/tracks.json', 200, [])
+    @service.find_tracks
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/users/1/tracks.json'
+
+    fakeweb_response(:get, 'http://test.dev/users/1/videos/search.json', 200, [])
+    @service.find_videos
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/users/1/videos/search.json'
+
+    fakeweb_response(:get, 'http://test.dev/tracks.json', 200, [])
+    @service.tracks
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/tracks.json'
+  end
+
+  it "should support query arguments" do
+    @service_class.class_eval do
+      base_uri 'http://test.dev'
+      route :tracks, '/:version/', :query => {'method' => 'track.getinfo', 'artist' => :arg1, 'track' => :arg2}
+    end
+    @service = @service_class.new
+
+    fakeweb_response(:get, %r|http://test.dev/2.0/|, 200, [])
+    @service.tracks '2.0', 'cher', 'believe'
+
+    @service.request_method.should == :get
+    @service.request_url.should == 'http://test.dev/2.0/'
+    @service.request_options[:query]['method'].should == 'track.getinfo'
+    @service.request_options[:query]['artist'].should == 'cher'
+    @service.request_options[:query]['track'].should == 'believe'
+  end
+
+  it "should support body arguments" do
+    @service_class.class_eval do
+      base_uri 'http://test.dev'
+      route :tracks, '/:version/', :body => {'method' => 'track.getinfo', 'artist' => :arg1, 'track' => :arg2}, :method => :post, :no_body => true
+    end
+    @service = @service_class.new
+
+    fakeweb_response(:post, %r|http://test.dev/2.0/|, 200, [])
+    @service.tracks '2.0', 'cher', 'believe'
+
+    @service.request_method.should == :post
+    @service.request_url.should == 'http://test.dev/2.0/'
+    @service.request_options[:body]['method'].should == 'track.getinfo'
+    @service.request_options[:body]['artist'].should == 'cher'
+    @service.request_options[:body]['track'].should == 'believe'
+  end
+
+  it "should support body arguments" do
+    @service_class.class_eval do
+      base_uri 'http://test.dev'
+      route :tracks, '/:version/', :body => {'method' => 'track.getinfo', 'artist' => :arg1, 'track' => :arg2}, :method => :post
+    end
+    @service = @service_class.new
+
+    fakeweb_response(:post, %r|http://test.dev/2.0/|, 200, [])
+    @service.tracks '2.0', 'cher', 'believe', 'method' => 'track.getinfo2'
+
+    @service.request_method.should == :post
+    @service.request_url.should == 'http://test.dev/2.0/'
+    @service.request_options[:body]['method'].should == 'track.getinfo2'
+    @service.request_options[:body]['artist'].should == 'cher'
+    @service.request_options[:body]['track'].should == 'believe'
+  end
+
+  it "should support body and query arguments" do
+    @service_class.class_eval do
+      base_uri 'http://test.dev'
+      route :tracks, '/:version/', :body => {'method' => 'track.getinfo', 'artist' => :arg1, 'track' => :arg2}, :query => {'auth' => 'xx', 'Sign' => :arg1}, :method => :post
+    end
+    @service = @service_class.new
+
+    fakeweb_response(:post, 'http://test.dev/2.0/?auth=xx&Sign=secret', 200, [])
+    @service.tracks '2.0', 'cher', 'believe', 'secret', 'method' => 'track.getinfo2'
+
+    @service.request_method.should == :post
+    @service.request_url.should == 'http://test.dev/2.0/'
+    @service.request_options[:body]['method'].should == 'track.getinfo2'
+    @service.request_options[:body]['artist'].should == 'cher'
+    @service.request_options[:body]['track'].should == 'believe'
+  end
+
+  it "should set the expected status based on the method" do
+    @service_class.class_eval do
+      base_uri 'http://test.dev'
+      route :test, '/test', :method => :post, :no_body => true
+    end
+    @service = @service_class.new
+
+    fakeweb_response(:post, 'http://test.dev/test', 200, [])
+    @service.test
+
+    fakeweb_response(:post, 'http://test.dev/test', 201, [])
+    @service.test
+
+    fakeweb_response(:post, 'http://test.dev/test', 202, [])
+    expect {
+      @service.test
+    }.to raise_error { RESTHome::InvalidResponse }
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,9 @@
+begin
+  require 'spec/rake/spectask'
+  Spec::Rake::SpecTask.new(:spec) do |spec|
+    spec.libs << 'lib' << 'spec'
+    spec.spec_files = FileList['spec/**/*_spec.rb']
+  end
+rescue LoadError => e
+  puts "unable to run specs from rake. gem install rspec"
+end