gnip_api 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90f541c5fd7133a7416208c0cff50618e397f47c
-  data.tar.gz: 38b7f7a8a7259bd10f69682ad2fbf4d60d0f950a
+  metadata.gz: 0a575aa7bda2ab49439ff9cd2c46a2b2324fbc16
+  data.tar.gz: ad04004a6303514eff8aec1f7aed4c1496f7f376
 SHA512:
-  metadata.gz: 95049acfaabc043671d936642d5b0a8b97dae3fe6914ec3cbb599a4e94e12361d6b60642f7bb28f2832befe76216f58c0745c635997f075d7ceec2f21f39b0b6
-  data.tar.gz: fc49073866aa88340defea4aac2f4769dd2c6aae2c17ad1b510c35f774e4b572405dcd0d391b4e1f72bacbce6cd81ad7935cde0ab2a007487a0748af6bb8ee7f
+  metadata.gz: fca8be3517fb79eeacdc09944f468db1f5f9f9c593f1fb528d996c8be23574c655c646b7ace69bd881769df9daef30d3d3a40a27ab620fee3bcf7ae0fce201c2
+  data.tar.gz: da35c7a89f8c3e09cd0e1623e836acce8c092048d0749371658569236d91563900a22ad784317929b41ea1e530136cb151c8a3b88ef95723c0e95d47081ab013

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gnip_api (1.0.1)
+    gnip_api (1.0.2)
       addressable
       httparty
       yajl-ruby

data/README.md

@@ -6,16 +6,11 @@ Connect with different Gnip APIs and get data from streams.
 
 ## Recent Changes
 
+- Added a debug mode to output more information on logger from adapter
 - 2.0 APIs implemented partially, more will come soon
 - Fixed a memory issue with HTTParty
 - 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
-- Added source and label to config as default values
-- Added Search API
-- All APIs now default their parameters from config, you can still call an API with different label or source
-- More docs
 
 ## Notes
 
@@ -53,6 +48,8 @@ GnipApi.configure |config|
   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
+  config.debug = false # Defaults to false, enables/disables debug output on log
+  config.stream_output_format = :activity # What stream should return: :json, :parsed_json or :activity?, default if :activity
 end
 ```
 
@@ -155,6 +152,19 @@ There are a few considerations to make when doing this:
 GnipApi is not dependent of a single adapter (there's a dependency with HTTParty, but shhh... it won't last too long). You can use one of the provided adapters, or you can make your own, using the BaseAdapter class. You only need to implement the desired connector POST, GET and DELETE methods. There's an extra stream_get method, but it's just a variant of GET. Keep in mind that Gnip uses compression, I found out that Excon doesn't decompress responses by default, just to name an example.
 The custom adapter does not require to live within the gem files, as long as GnipApi has access to your class, just put it in the config and you're ready to go. See the current adapters for reference.
 
+## Debug mode
+
+At any time you can enable/disable the debug mode like this:
+
+```ruby
+GnipApi.configuration.debug = true
+```
+
+This will output information about the request/response. Response body is not returned to avoid excessive logging.
+
+Note that debug data is dependent on what adapter you are using. You should be able to dump the necesary information from
+your adapter and call the internal debugger to log the information.
+
 ## WIP State
 
 GnipApi is a WIP. Call it a beta, alpha, gem that has part of the features, whatever. It is currently usable and it's being used by... well.. me. The custom adapter feature is there, and some of the APIs of Gnip were implemented. I'll be coding more things into this, such as other APIs, request retries, error handling, different adapters for known connectors like RestClient or HTTP/net, etc.

data/lib/gnip_api/adapter.rb

@@ -11,6 +11,7 @@ module GnipApi
       raise GnipApi::Errors::MissingAdapter unless GnipApi.adapter_class?
       @adapter = GnipApi.config.adapter_class.new
       @logger = GnipApi.config.logger
+      @debug = GnipApi.config.debug
     end
 
     def get request

data/lib/gnip_api/adapters/base_adapter.rb

@@ -65,6 +65,30 @@ module GnipApi
       def create_response request, status, body, headers
         GnipApi::Response.new request, status, body, headers
       end
+      
+      private
+      def debug_request options={}
+        return nil unless GnipApi.config.debug
+        request_headers = options[:request_headers]
+        request_body = options[:request_body]
+        request_method = options[:request_method]
+        request_url = options[:request_url]
+        response_headers = options[:response_headers]
+        response_status = options[:response_status]
+        response_body = options[:response_body]
+        debug_message = "REQUEST/RESPONSE DEBUG\n"
+        debug_message += "#{request_method} -- #{request_url}\n"
+        debug_message += "Request Headers:\n"
+        debug_message += request_headers.map{|k,v| "#{k} -> #{v.join(', ')}"}.join("\n")
+        debug_message += "\n\nRequest Body:\n"
+        debug_message += request_body
+        debug_message += "\n\nResponse Headers:\n"
+        debug_message += response_headers.map{|k,v| "#{k} -> #{v.join(', ')}"}.join("\n")
+        debug_message += "\n\nResponse Status: #{response_status}"
+        # debug_message += "\n\nResponse Body: #{response_body}\n\n"
+        GnipApi.logger.debug debug_message
+        return nil
+      end
     end
   end
 end

data/lib/gnip_api/adapters/httparty_adapter.rb

@@ -3,16 +3,19 @@ module GnipApi
     class HTTPartyAdapter < GnipApi::Adapters::BaseAdapter
       def post request
         data = HTTParty.post request.uri, :basic_auth => auth, :body => request.payload, :timeout => default_timeout
+        httparty_debugger(data)
         return response(request, data)
       end
       
       def delete request
         data = HTTParty.post request.uri, :basic_auth => auth, :body => request.payload, :timeout => default_timeout
+        httparty_debugger(data)
         return response(request, data)
       end
       
       def get request
         data = HTTParty.get request.uri, :basic_auth => auth, :timeout => default_timeout
+        httparty_debugger(data)
         return response(request, data)
       end
 
@@ -32,6 +35,25 @@ module GnipApi
       def response request, data
         create_response request, data.code, data.body, data.headers
       end
+
+      private
+      def debug_data data
+        {
+          :request_headers => data.request.instance_variable_get(:@raw_request).to_hash,
+          :request_body => data.request.instance_variable_get(:@raw_request).body,
+          :request_method => data.request.http_method.to_s,
+          :request_url => data.request.path.to_s,
+          :response_headers => data.headers,
+          :response_status => data.code,
+          :response_body => data.body
+        }
+      end
+
+      def httparty_debugger data
+        return nil unless GnipApi.config.debug
+        debug_request(debug_data(data))
+        return nil
+      end
       
     end
   end

data/lib/gnip_api/apis/power_track/stream.rb

@@ -6,6 +6,8 @@ module GnipApi
         
         def initialize params = {}
           @stream = params[:stream] || GnipApi.config.label
+          @output_format = GnipApi.config.stream_output_format
+          raise GnipApi::Errors::Configuration::InvalidOutputFormat unless GnipApi::Configuration::OUTPUT_FORMATS.include?(@output_format)
           set_config
         end
         
@@ -29,10 +31,12 @@ module GnipApi
         end 
 
         def process_entries entries
-          entries.map!{|e| parse_json(e)}.compact!
-          entries.map!{|e| build_message(e)}
-          log_system_messages(entries)
-          entries
+          return entries if @output_format == :json
+          return entries.map{|e| parse_json(e)}.compact if @output_format == :parsed_json
+          data = entries.map{|e| parse_json(e)}.compact
+          data.map!{|e| build_message(e)} 
+          log_system_messages(data)
+          return data
         end
 
         def log_system_messages entries

data/lib/gnip_api/configuration.rb

@@ -1,11 +1,16 @@
 module GnipApi
   class Configuration
-    attr_accessor :user, :password, :adapter_class, :account, :logger, :source, :label, :request_timeout
+    OUTPUT_FORMATS = [:activity, :json, :parsed_json]
+
+    attr_accessor :user, :password, :adapter_class, :account, :logger, :source, :label, :request_timeout, :debug, 
+                  :stream_output_format
 
     def initialize
       @adapter_class = GnipApi::Adapters::HTTPartyAdapter
       @logger = Logger.new('tmp/gnip_api.log')
       @request_timeout = 60
+      @debug = false
+      @stream_output_format = :activity
     end
   end
 end

data/lib/gnip_api/errors.rb

@@ -1,5 +1,13 @@
 module GnipApi
   module Errors
+    module Configuration
+      class InvalidOutputFormat < StandardError
+        def initialize msg="Invalid output format. Available formats: #{GnipApi::Configuration::OUTPUT_FORMATS}"
+          @message = msg
+        end
+      end
+    end
+
     module JsonParser
       class ParseError < StandardError
       end

data/lib/gnip_api/gnip/activity.rb

@@ -2,9 +2,10 @@ module Gnip
   class Activity < Gnip::Message
     attr_reader :id, :object_type, :actor, :verb, :posted_time, :generator, :provider, :link,
     :body, :object, :favorites_count, :twitter_entities, :twitter_filter_level, :twitter_lang,
-    :retweet_count, :gnip
+    :retweet_count, :gnip, :raw
 
     def initialize params = {}
+      @raw = params
       @id = params['id']
       @object_type = params['objectType']
       @actor = Gnip::Actor.new params['actor']
@@ -23,24 +24,24 @@ module Gnip
       @gnip = Gnip::GnipData.new(params['gnip']) if params['gnip']
     end
 
-    def original_attributes
+    def to_h
       {
         :id => @id,
         :objectType => @object_type,
-        :actor => @actor.original_attributes,
+        :actor => @actor.to_h,
         :verb => @verb,
         :postedTime => @posted_time,
         :generator => @generator,
         :provider => @provider,
         :link => @link,
         :body => @body,
-        :object => @object.kind_of?(Gnip::Activity) ? @object.original_attributes : @object,
+        :object => @object.kind_of?(Gnip::Activity) ? @object.to_h : @object,
         :favoritesCount => @favorites_count,
         :twitter_entities => @twitter_entities,
         :twitter_filter_level => @twitter_filter_level,
         :twitter_lang => @twitter_lang,
         :retweetCount => @retweet_count,
-        :gnip => @gnip ? @gnip.original_attributes : nil
+        :gnip => @gnip ? @gnip.to_h : nil
       }
     end
 
@@ -57,7 +58,7 @@ module Gnip
     end
 
     def to_json
-      generate_json(original_attributes)
+      @raw.to_json
     end
 
     def author

data/lib/gnip_api/gnip/actor.rb

@@ -2,9 +2,10 @@ module Gnip
   class Actor < Gnip::Message
     attr_reader :object_type, :id, :link, :display_name, :posted_time, :image, :summary,
     :links, :friends_count, :followers_count, :statuses_count, :twitter_time_zone, :verified,
-    :utc_offset, :preferred_username, :languages, :location, :favorites_count
+    :utc_offset, :preferred_username, :languages, :location, :favorites_count, :raw
     
     def initialize params = {}
+      @raw = params
       @object_type = params['objectType']
       @id = params['id']
       @link = params['link']
@@ -59,7 +60,7 @@ module Gnip
     end
 
     def to_json
-      generate_json(original_attributes)
+      @raw.to_json
     end
   end
 end

data/lib/gnip_api/gnip/system_message.rb

@@ -3,6 +3,7 @@ module Gnip
     attr_reader :message, :sent, :message_type
 
     def initialize params
+      @raw = params
       @message_type = params.keys.first
       @message = params['message']
       @sent = params['sent']
@@ -24,7 +25,7 @@ module Gnip
     end
     
     def to_json
-      generate_json(original_attributes)
+      @raw.to_json
     end
   end
 end

data/lib/gnip_api/gnip/url.rb

@@ -1,38 +1,32 @@
 module Gnip
   class Url < Gnip::Message
-    attr_reader :url, :expanded_url, :expanded_status, :display_url, :indices, :expanded_url_title, :expanded_url_description
+    attr_reader :url, :expanded_url, :expanded_status, :display_url, :indices, :expanded_url_title, :expanded_url_description, :raw
 
     def initialize params={}
+      @raw = params
       @url = params['url']
-      @expanded_url = params['expanded_url']
       @display_url = params['display_url']
+      @expanded_url = params['expanded_url']
       @expanded_status = params['expanded_status']
-      @indices = params['indices']
       @expanded_url_title = params['expanded_url_title']
       @expanded_url_description = params['expanded_url_description']
+      @indices = params['indices']
     end
 
-    def url
-      Addressable::URI.parse(@url) unless @url.nil?
-    end
-    
-    def expanded_url
-      Addressable::URI.parse(@expanded_url) unless @expanded_url.nil?
-    end
-
-    def original_attributes
+    def to_h
       {
         :url => @url,
-        :title => @title,
         :display_url => @display_url,
         :expanded_url => @expanded_url,
         :expanded_status => @expanded_status,
+        :expanded_url_title => @expanded_url_title,
+        :expanded_url_description => @expanded_url_description,
         :indices => @indices
       }.delete_if{|k,v| v.nil?}
     end
 
     def to_json
-      generate_json(original_attributes)
+      @raw.to_json
     end
   end
 end

data/lib/gnip_api/version.rb

@@ -1,3 +1,3 @@
 module GnipApi
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/lib/gnip_api.rb

@@ -27,7 +27,6 @@ require "gnip_api/response"
 require "gnip_api/request"
 require "gnip_api/json_parser"
 
-
 module GnipApi
   class << self
     attr_reader :configuration

data/spec/gnip_api/apis/power_track/stream_spec.rb

@@ -6,19 +6,62 @@ describe GnipApi::Apis::PowerTrack::Stream do
     @stream = GnipApi::Apis::PowerTrack::Stream.new
   end
 
+  describe '#initialize' do
+    it 'throws GnipApi::Errors::Configuration::InvalidOutputFormat when not included' do
+      GnipApi.configuration.stream_output_format = :invalid
+      expect(Proc.new{GnipApi::Apis::PowerTrack::Stream.new}).to raise_error(GnipApi::Errors::Configuration::InvalidOutputFormat)
+    end
+  end
+
   describe '#process_entries' do
     before do
       @json = File.read('spec/fixtures/activities/real_activity.json')
     end
     
-    it 'bulds a Message object from the json' do
-      message = @stream.process_entries([@json])
-      expect(message.first.class).to eq(Gnip::Activity)
+    context 'when output format is :activity' do
+      it 'bulds a Message object from the json' do
+        message = @stream.process_entries([@json])
+        expect(message.first.class).to eq(Gnip::Activity)
+      end
+
+      it 'returns empty array if could not parse json' do
+        message = @stream.process_entries(['lol'])
+        expect(message).to eq([])
+      end
+    end
+
+    context 'when output format is :parsed_json' do
+      before do
+        GnipApi.configuration.stream_output_format = :parsed_json
+        @stream = GnipApi::Apis::PowerTrack::Stream.new
+      end
+
+      it 'parses json' do
+        message = @stream.process_entries([@json])
+        expect(message.first.class).to eq(Hash)
+      end
+
+      it 'returns empty array if could not parse json' do
+        message = @stream.process_entries(['lol'])
+        expect(message).to eq([])
+      end
     end
 
-    it 'returns empty array if could not parse json' do
-      message = @stream.process_entries(['lol'])
-      expect(message).to eq([])
+    context 'when output format is :json' do
+      before do 
+        GnipApi.configuration.stream_output_format = :json
+        @stream = GnipApi::Apis::PowerTrack::Stream.new
+      end
+
+      it 'returns raw json' do
+        message = @stream.process_entries([@json])
+        expect(message.first.class).to eq(String)
+      end
+
+      it 'returns whatever stream returns' do
+        message = @stream.process_entries(['lol'])
+        expect(message).to eq(['lol'])
+      end
     end
   end
 

data/spec/gnip_api/configuration_spec.rb

@@ -1,6 +1,20 @@
 require 'spec_helper'
 
 describe GnipApi::Configuration do
+  describe 'OUTPUT_FORMATS' do
+    it 'includes :json' do
+      expect(GnipApi::Configuration::OUTPUT_FORMATS.include?(:json)).to eq(true)
+    end
+
+    it 'includes :activity' do
+      expect(GnipApi::Configuration::OUTPUT_FORMATS.include?(:activity)).to eq(true)
+    end
+
+    it 'includes :parsed_json' do
+      expect(GnipApi::Configuration::OUTPUT_FORMATS.include?(:parsed_json)).to eq(true)
+    end
+  end
+
   describe '#new' do
     it 'has the default values' do
       config = GnipApi::Configuration.new
@@ -12,6 +26,7 @@ describe GnipApi::Configuration do
       expect(config.logger).not_to eq(nil)
       expect(config.source).to eq(nil)
       expect(config.label).to eq(nil)
+      expect(config.debug).to eq(false)
     end
   end
 

data/spec/gnip_api/gnip/url_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Gnip::Url do
+  before do
+    # Taken from http://support.gnip.com/enrichments/expanded_urls.html
+    @raw_data = '{"url": "https://t.co/b9ZdzRxzFK","expanded_url": "http://www.today.com/parents/joke-s-you-kid-11-family-friendly-april-fools-pranks-t83276","expanded_status": 200,"expanded_url_title": "The joke\'s on you, kid: 11 family-friendly April Fools pranks","expanded_url_description": "If your kids are practical jokers, turn this April Fools\' Day into a family affair."}'
+    @data = JSON.parse(@raw_data)
+  end
+
+  describe '#initialize' do
+    it 'receives raw data' do
+      expect(Proc.new{Gnip::Url.new(@data)}).not_to raise_error
+    end
+
+    describe 'attributes' do
+      before{@url = Gnip::Url.new(@raw_data)}
+
+      it 'has url' do
+        expect(@url.url).not_to eq(nil)
+      end
+
+      it 'has expanded_url' do
+        expect(@url.expanded_url).not_to eq(nil)
+      end
+
+      it 'has expanded_url_status' do
+        expect(@url.expanded_status).not_to eq(nil)
+      end
+
+      it 'has expanded_url_title' do
+        expect(@url.expanded_url_title).not_to eq(nil)
+      end
+      
+      it 'has expanded_url_description' do
+        expect(@url.expanded_url_description).not_to eq(nil)
+      end
+    end
+  end
+
+  describe '#to_h' do
+    before{@url = Gnip::Url.new(@data)}
+
+    it 'includes url' do
+      expect(@url.to_h[:url]).to eq(@url.url)
+    end
+
+    it 'includes expanded_url' do
+      expect(@url.to_h[:expanded_url]).to eq(@url.expanded_url)
+    end
+
+    it 'includes expanded_url_status' do
+      expect(@url.to_h[:expanded_status]).to eq(@url.expanded_status)
+    end
+
+    it 'includes expanded_url_title' do
+      expect(@url.to_h[:expanded_url_title]).to eq(@url.expanded_url_title)
+    end
+
+    it 'includes expanded_url_description' do
+      expect(@url.to_h[:expanded_url_description]).to eq(@url.expanded_url_description)
+    end
+  end
+
+  describe '#to_json' do
+    before{@url = Gnip::Url.new(@data)}
+
+    it 'converts to original json' do
+      expect(JSON.parse(@url.to_json)).to eq(@data)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -11,6 +11,8 @@ def configure_gem
     config.adapter_class = TestAdapter
     config.source = 'twitter'
     config.label = 'prod'
+    config.debug = false
+    config.stream_output_format = :activity
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnip_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Rayko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-05 00:00:00.000000000 Z
+date: 2016-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -228,6 +228,7 @@ files:
 - spec/gnip_api/gnip/activity_spec.rb
 - spec/gnip_api/gnip/gnip_data_spec.rb
 - spec/gnip_api/gnip/message_spec.rb
+- spec/gnip_api/gnip/url_spec.rb
 - spec/gnip_api/json_parser_spec.rb
 - spec/gnip_api/request_spec.rb
 - spec/gnip_api/response_spec.rb
@@ -297,6 +298,7 @@ test_files:
 - spec/gnip_api/gnip/activity_spec.rb
 - spec/gnip_api/gnip/gnip_data_spec.rb
 - spec/gnip_api/gnip/message_spec.rb
+- spec/gnip_api/gnip/url_spec.rb
 - spec/gnip_api/json_parser_spec.rb
 - spec/gnip_api/request_spec.rb
 - spec/gnip_api/response_spec.rb