gnip_api 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ace6a737270b54933d3a565107f177695ccc5fc
-  data.tar.gz: a5ff0135422ebbfb589e6caaa75fa78d394b5e61
+  metadata.gz: d0ae4c94718a2de90323b7511592b9d1320ef80e
+  data.tar.gz: f5b6ea9aee615af882e27555b4705774d7bbc206
 SHA512:
-  metadata.gz: 9d5b61329486ff45318975b4b6d2ee844b110a262fd1fa69b4c213bd4ac509cdb628f14815745cc1d9ce3eb1dcdf5c009fd2b4709f05721bbd5bee0ab591ecd6
-  data.tar.gz: 921dc1e0a35fbc0377a56fddbfe84e306a6508aef39462405296cc08ccd2d6a237f2f0bed95cdc0158477cca4125468dd930040123b8f92b9c7c4ea7f85c7cea
+  metadata.gz: 22b94334a96c94518ca52ae883ef98e04c98489ecbf5e6da4b70f6a70fb6017e982a97a395a32621e094f46dc3dfd017d5a00f8e4dc12bda3e8cc92ee3a814c1
+  data.tar.gz: 65205a747d6622d441960996fb597ebf79fb53adff213147ad4e225c1a948cd503d4cc865ccf1018d8cdcebf8f8c458a287beb602396ab376697a77646e7c967

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gnip_api (0.0.6)
+    gnip_api (0.0.7)
       activesupport
       addressable
       httparty

data/README.md

@@ -6,6 +6,7 @@ Connect with different Gnip APIs and get data from streams.
 
 ## Recent Changes
 
+- Timeout for requests added to fail if API is non responsive, time can be configured
 - Search API returns parsed data either for counts or activities, which also makes Search API usable to get activities now
 - Removed unused RateLimiter
 - Removed unused Mutex
@@ -49,6 +50,7 @@ GnipApi.configure |config|
   config.logger = Logger.new('myLog.log') # You can also provide a custom logger
   config.source = 'twitter' # General source, if none defined when quering, this will be used
   config.label = 'mystream' # General stream label, if none defined when quering, this will be used
+  config.request_timeout = 120 # Default time out on all requests, defaults to 60
 end
 ```
 
@@ -88,10 +90,10 @@ results = GnipApi::Apis::Search.new.counts :rule => rule, :from_date => DateTime
 For activities, there are a few extra considerations:
 
 - A param ```:max_results``` indicates how many activities to return on a response, valid values are from 10 to 500, default is 100, this param does not work on counts.
-- As you noticed, you pass a ```GnipApi::Apis::PowerTrack::Rule``` object to the search endpoint, and as you may also know, these objects have mostly 2 thigs: value (actual rule), and tag. When querying activities on the Search API, you can optionally use a tag that is returned on the activity, along with the rule. This tag is deduced from the rule object you pass, in other words, if you want a tag, add it on the ```GnipApi::Apis::PowerTrack::Rule``` object, it's not a valid param for the method.
+- As you noticed, you pass a ```GnipApi::Apis::PowerTrack::Rule``` object to the search endpoint, and as you may also know, these objects have mostly 2 things: value (actual rule), and tag. When querying activities on the Search API, you can optionally use a tag that is returned on the activity, along with the rule. This tag is deduced from the rule object you pass, in other words, if you want a tag, add it on the ```GnipApi::Apis::PowerTrack::Rule``` object, it's not a valid param for the method.
 - The ```:bucket``` option is only for counts.
 
-When you query for more than 30 days or more activities than ```:max_activities```, the results will include a ```:next``` token to iterate over the remaining pages. You can instantly feed this token to a following request with same parameters:
+When you query for more than 30 days or more activities than ```:max_results```, the results will include a ```:next``` token to iterate over the remaining pages. You can instantly feed this token to a following request with same parameters:
 
 ```ruby
 results = GnipApi::Apis::Search.new.counts :rule => rule, :from_date => DateTime.parse('2016-01-01 00:00'), :to_date => DateTime.parse('2016-05-01 22:00'), :bucket => 'day', :next_token => 'token_from_previous_request'

data/lib/gnip_api/adapters/base_adapter.rb

@@ -50,6 +50,10 @@ module GnipApi
       def password
         GnipApi.configuration.password
       end
+
+      def default_timeout
+        GnipApi.configuration.request_timeout
+      end
       
       def create_response request, status, body, headers
         GnipApi::Response.new request, status, body, headers

data/lib/gnip_api/adapters/httparty_adapter.rb

@@ -2,17 +2,17 @@ module GnipApi
   module Adapters
     class HTTPartyAdapter < GnipApi::Adapters::BaseAdapter
       def post request
-        data = HTTParty.post request.uri, :basic_auth => auth, :body => request.payload
+        data = HTTParty.post request.uri, :basic_auth => auth, :body => request.payload, :timeout => default_timeout
         return response(request, data)
       end
       
       def delete request
-        data = HTTParty.delete request.uri, :basic_auth => auth, :body => request.payload
+        data = HTTParty.delete request.uri, :basic_auth => auth, :body => request.payload, :timeout => default_timeout
         return response(request, data)
       end
       
       def get request
-        data = HTTParty.get request.uri, :basic_auth => auth
+        data = HTTParty.get request.uri, :basic_auth => auth, :timeout => default_timeout
         return response(request, data)
       end
 

data/lib/gnip_api/configuration.rb

@@ -1,10 +1,11 @@
 module GnipApi
   class Configuration
-    attr_accessor :user, :password, :adapter_class, :account, :logger, :source, :label
+    attr_accessor :user, :password, :adapter_class, :account, :logger, :source, :label, :request_timeout
 
     def initialize
       @adapter_class = GnipApi::Adapters::HTTPartyAdapter
       @logger = Logger.new('tmp/gnip_api.log')
+      @request_timeout = 60
     end
   end
 end

data/lib/gnip_api/version.rb

@@ -1,3 +1,3 @@
 module GnipApi
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnip_api
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Rayko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2016-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler