spark_api 1.3.9 → 1.3.10

data/VERSION

@@ -1 +1 @@
-1.3.9
+1.3.10

data/lib/spark_api/configuration.rb

@@ -11,7 +11,7 @@ module SparkApi
     # valid configuration options
     VALID_OPTION_KEYS = [:api_key, :api_secret, :api_user, :endpoint, 
       :user_agent, :version, :ssl, :ssl_verify, :oauth2_provider, :authentication_mode, 
-      :auth_endpoint, :callback, :compress].freeze
+      :auth_endpoint, :callback, :compress, :timeout].freeze
     OAUTH2_KEYS = [:authorization_uri, :access_uri, :client_id, :client_secret,
       # Requirements for authorization_code grant type
       :redirect_uri,  
@@ -41,6 +41,7 @@ module SparkApi
     DEFAULT_SSL_VERIFY = true
     DEFAULT_OAUTH2 = nil
     DEFAULT_COMPRESS = false
+    DEFAULT_TIMEOUT = 5 # seconds
     
     X_SPARK_API_USER_AGENT = "X-SparkApi-User-Agent"
 
@@ -73,6 +74,7 @@ module SparkApi
       self.ssl_verify  = DEFAULT_SSL_VERIFY
       self.version     = DEFAULT_VERSION
       self.compress    = DEFAULT_COMPRESS
+      self.timeout     = DEFAULT_TIMEOUT
       self
     end
   end

data/lib/spark_api/connection.rb

@@ -24,6 +24,7 @@ module SparkApi
 
       conn = Faraday.new(opts) do |conn|
         conn.response :spark_api
+        conn.options[:timeout] = self.timeout
         conn.adapter Faraday.default_adapter
       end
       SparkApi.logger.debug("Connection: #{conn.inspect}")

data/spec/unit/spark_api/configuration_spec.rb

@@ -12,6 +12,7 @@ describe SparkApi::Client, "Client config"  do
       SparkApi.user_agent.should match(/Spark API Ruby Gem .*/)
       SparkApi.api_key = "my_api_key"
       SparkApi.api_key.should match("my_api_key")
+      SparkApi.timeout.should eq(5)
     end
   end
 
@@ -21,7 +22,8 @@ describe SparkApi::Client, "Client config"  do
                                     :api_secret => "TopSecret", 
                                     :api_user => "1234",
                                     :auth_endpoint => "https://login.wade.dev.fbsdata.com",
-                                    :endpoint => "http://api.wade.dev.fbsdata.com")
+                                    :endpoint => "http://api.wade.dev.fbsdata.com",
+                                    :timeout => 15)
  
       client.api_key.should match("key_of_wade")
       client.api_secret.should match("TopSecret")
@@ -29,6 +31,7 @@ describe SparkApi::Client, "Client config"  do
       client.auth_endpoint.should match("https://login.wade.dev.fbsdata.com")
       client.endpoint.should match("http://api.wade.dev.fbsdata.com")
       client.version.should match("v1")
+      client.timeout.should eq(15)
     end
     
     it "should allow unverified ssl certificates when verification is off" do
@@ -90,6 +93,7 @@ describe SparkApi::Client, "Client config"  do
         config.version = "veleventy"
         config.endpoint = "test.api.sparkapi.com"
         config.user_agent = "my useragent"
+        config.timeout = 15
       end
 
       SparkApi.api_key.should match("my_key")
@@ -99,6 +103,7 @@ describe SparkApi::Client, "Client config"  do
       SparkApi.endpoint.should match("test.api.sparkapi.com")
       SparkApi.user_agent.should match("my useragent")
       SparkApi.oauth2_enabled?().should be_false
+      SparkApi.timeout.should eq(15)
     end
 
     it "should correctly set up the client for oauth2" do
@@ -180,16 +185,26 @@ describe SparkApi::Client, "Client config"  do
     end
 
     it "should not set gzip header by default" do
-      c = SparkApi::Client.new(:endpoint => "https://sparkapi.com") 
+      c = SparkApi::Client.new(:endpoint => "https://sparkapi.com")
       c.connection.headers["Accept-Encoding"].should be_nil
     end
 
     it "should set gzip header if compress option is set" do
-      c = SparkApi::Client.new(:endpoint => "https://api.sparkapi.com", 
+      c = SparkApi::Client.new(:endpoint => "https://api.sparkapi.com",
         :compress => true) 
       c.connection.headers["Accept-Encoding"].should eq("gzip, deflate")
     end
-    
+
+    it "should set default timeout of 5 seconds" do
+      c = SparkApi::Client.new(:endpoint => "https://sparkapi.com")
+      c.connection.options[:timeout].should eq(5)
+    end
+
+    it "should set alternate timeout if specified" do
+      c = SparkApi::Client.new(:endpoint => "https://sparkapi.com",
+        :timeout => 15)
+      c.connection.options[:timeout].should eq(15)
+    end
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: spark_api
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: 
   segments: 
   - 1
   - 3
-  - 9
-  version: 1.3.9
+  - 10
+  version: 1.3.10
 platform: ruby
 authors: 
 - Brandon Hornseth
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-07-22 00:00:00 Z
+date: 2013-07-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -528,8 +528,8 @@ files:
 - spec/unit/spark_api/multi_client_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/sparkapi/spark_api
-licenses: []
-
+licenses: 
+- Apache 2.0
 post_install_message: 
 rdoc_options: []