you_got_listed 0.5.0 → 0.5.1

data/README.rdoc

@@ -15,7 +15,7 @@ YouGotListings API documentation can be found here: http://www.yougotlistings.co
 
 In a rails 3 app
 
-  gem 'you_got_listed', '~> 0.4.0'
+  gem 'you_got_listed', '~> 0.5.1'
 
 In a rails 2.3.x app  (0.2.x only)
 
@@ -43,6 +43,11 @@ A client object is necessary for each request type.  The client is the base clas
 
 ** For all operations the "key" required parameter is automatically passed so you never need to worry about this parameter as the client class includes it by default.
 
+There is also an optional parameter to set the timeout in seconds, passing this will raise a Timeout::Error after that number of seconds
+
+  @ygl = YouGotListed::Client.new('you_api_key', 5)  # raises a Timeout::Error after 5 seconds with no response
+
+
 === Searching Accounts
 
 To find all of the accounts that your API key can access call #search off the Accounts class:

data/lib/you_got_listed/client.rb

@@ -5,15 +5,23 @@ module YouGotListed
     format :xml
     base_uri "https://www.yougotlistings.com/api"
 
-    attr_accessor :api_key
+    attr_accessor :api_key, :http_timeout
 
-    def initialize(api_key)
+    def initialize(api_key, http_timeout = nil)
+      self.http_timeout = http_timeout
       self.class.default_params :key => api_key
     end
 
     def perform_request(http_method, path, params = {})
       begin
-        self.class.send(http_method, path, :query => params)
+        http_params = {}
+        unless params.blank?
+          http_params[:query] = params
+        end
+        unless self.http_timeout.nil?
+          http_params[:timeout] = self.http_timeout
+        end
+        self.class.send(http_method, path, http_params)
       rescue Timeout::Error
         {"YGLResponse" => {"responseCode" => "996", "Error" => "Timeout"}}
       rescue Exception

data/lib/you_got_listed/version.rb

@@ -1,3 +1,3 @@
 module YouGotListed
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/spec/support/webmock_helper.rb

@@ -4,6 +4,10 @@ def new_ygl
   YouGotListed::Client.new(YGL_API_KEY)
 end
 
+def new_ygl_timeout_5
+  YouGotListed::Client.new(YGL_API_KEY, 5)
+end
+
 def mock_get(base_uri, method, response_fixture, params = {})
   url = base_uri + method
   unless params.blank?

data/spec/you_got_listed/client_spec.rb

@@ -2,16 +2,40 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe YouGotListed::Client do
 
-  before do
-    @ygl = new_ygl
-  end
+  context "standard" do
+    before do
+      @ygl = new_ygl
+    end
+
+    it "should set the api_key" do
+      @ygl.class.default_params.should == {:key => YGL_API_KEY}
+    end
+
+    it "should not set the timeout" do
+      @ygl.http_timeout.should == nil
+    end
 
-  it "should set the api_key" do
-    @ygl.class.default_params.should == {:key => YGL_API_KEY}
+    it "should set the base uri" do
+      @ygl.class.base_uri.should == "https://www.yougotlistings.com/api"
+    end
   end
 
-  it "should set the base uri" do
-    @ygl.class.base_uri.should == "https://www.yougotlistings.com/api"
+  context "timeout" do
+    before do
+      @ygl = new_ygl_timeout_5
+    end
+
+    it "should set the api_key" do
+      @ygl.class.default_params.should == {:key => YGL_API_KEY}
+    end
+
+    it "should set the timeout" do
+      @ygl.http_timeout.should == 5
+    end
+
+    it "should set the base uri" do
+      @ygl.class.base_uri.should == "https://www.yougotlistings.com/api"
+    end
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: you_got_listed
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 0
   - 5
-  - 0
-  version: 0.5.0
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Tom Cocca
@@ -19,7 +19,7 @@ date: 2011-04-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -28,12 +28,12 @@ dependencies:
         segments: 
         - 3
         version: "3"
-  version_requirements: *id001
-  name: activesupport
+  requirement: *id001
   type: :runtime
+  name: activesupport
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -44,12 +44,12 @@ dependencies:
         - 8
         - 3
         version: 0.8.3
-  version_requirements: *id002
-  name: httparty
+  requirement: *id002
   type: :runtime
+  name: httparty
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -60,12 +60,12 @@ dependencies:
         - 3
         - 2
         version: 0.3.2
-  version_requirements: *id003
-  name: rash
+  requirement: *id003
   type: :runtime
+  name: rash
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -74,12 +74,12 @@ dependencies:
         segments: 
         - 3
         version: "3"
-  version_requirements: *id004
-  name: will_paginate
+  requirement: *id004
   type: :runtime
+  name: will_paginate
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -90,12 +90,12 @@ dependencies:
         - 9
         - 2
         version: 0.9.2
-  version_requirements: *id005
-  name: rake
+  requirement: *id005
   type: :development
+  name: rake
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -106,12 +106,12 @@ dependencies:
         - 5
         - 0
         version: 2.5.0
-  version_requirements: *id006
-  name: rspec
+  requirement: *id006
   type: :development
+  name: rspec
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -122,12 +122,12 @@ dependencies:
         - 6
         - 2
         version: 1.6.2
-  version_requirements: *id007
-  name: webmock
+  requirement: *id007
   type: :development
+  name: webmock
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -138,9 +138,9 @@ dependencies:
         - 8
         - 0
         version: 1.8.0
-  version_requirements: *id008
-  name: vcr
+  requirement: *id008
   type: :development
+  name: vcr
   prerelease: false
 description: Ruby API wrapper for yougotlistings.com built with httparty
 email: tom.cocca@gmail.com