gnip_api 1.1.3 → 1.2.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnip_api
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Rayko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-14 00:00:00.000000000 Z
+date: 2017-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -169,14 +169,6 @@ files:
 - gnip_api.gemspec
 - lib/gnip_api.rb
 - lib/gnip_api/adapter.rb
-- lib/gnip_api/adapters/base_adapter.rb
-- lib/gnip_api/adapters/httparty_adapter.rb
-- lib/gnip_api/apis/power_track/buffer.rb
-- lib/gnip_api/apis/power_track/rule.rb
-- lib/gnip_api/apis/power_track/rule_validator.rb
-- lib/gnip_api/apis/power_track/rules.rb
-- lib/gnip_api/apis/power_track/stream.rb
-- lib/gnip_api/apis/search.rb
 - lib/gnip_api/configuration.rb
 - lib/gnip_api/endpoints.rb
 - lib/gnip_api/errors.rb
@@ -188,8 +180,14 @@ files:
 - lib/gnip_api/gnip/twitter_compliance_message.rb
 - lib/gnip_api/gnip/url.rb
 - lib/gnip_api/json_parser.rb
+- lib/gnip_api/power_track/buffer.rb
+- lib/gnip_api/power_track/rule.rb
+- lib/gnip_api/power_track/rule_validator.rb
+- lib/gnip_api/power_track/rules.rb
+- lib/gnip_api/power_track/stream.rb
 - lib/gnip_api/request.rb
 - lib/gnip_api/response.rb
+- lib/gnip_api/search.rb
 - lib/gnip_api/version.rb
 - spec/fixtures/activities/full_activity.json
 - spec/fixtures/activities/nil_urls.json
@@ -197,6 +195,7 @@ files:
 - spec/fixtures/activities/real_activity.json
 - spec/fixtures/activities/real_activity_long_object.json
 - spec/fixtures/activities/real_activity_long_rules.json
+- spec/fixtures/rule_value_examples.json
 - spec/fixtures/search_api/search_activities_response.json
 - spec/fixtures/search_api/search_counts_response.json
 - spec/fixtures/system_messages/error.json
@@ -218,13 +217,6 @@ files:
 - spec/fixtures/twitter_messages/user_unsuspend.json
 - spec/fixtures/twitter_messages/user_withheld.json
 - spec/gnip_api/adapter_spec.rb
-- spec/gnip_api/adapters/base_adapter_spec.rb
-- spec/gnip_api/adapters/httparty_adapter_spec.rb
-- spec/gnip_api/apis/power_track/buffer_spec.rb
-- spec/gnip_api/apis/power_track/rule_spec.rb
-- spec/gnip_api/apis/power_track/rules_spec.rb
-- spec/gnip_api/apis/power_track/stream_spec.rb
-- spec/gnip_api/apis/search_spec.rb
 - spec/gnip_api/configuration_spec.rb
 - spec/gnip_api/endpoints_spec.rb
 - spec/gnip_api/gnip/activity_spec.rb
@@ -233,9 +225,13 @@ files:
 - spec/gnip_api/gnip/twitter_compliance_message_spec.rb
 - spec/gnip_api/gnip/url_spec.rb
 - spec/gnip_api/json_parser_spec.rb
+- spec/gnip_api/power_track/buffer_spec.rb
+- spec/gnip_api/power_track/rule_spec.rb
+- spec/gnip_api/power_track/rules_spec.rb
+- spec/gnip_api/power_track/stream_spec.rb
 - spec/gnip_api/request_spec.rb
 - spec/gnip_api/response_spec.rb
-- spec/lib/test_adapter.rb
+- spec/gnip_api/search_spec.rb
 - spec/spec_helper.rb
 - spec/test_spec.rb
 homepage: ''
@@ -269,6 +265,7 @@ test_files:
 - spec/fixtures/activities/real_activity.json
 - spec/fixtures/activities/real_activity_long_object.json
 - spec/fixtures/activities/real_activity_long_rules.json
+- spec/fixtures/rule_value_examples.json
 - spec/fixtures/search_api/search_activities_response.json
 - spec/fixtures/search_api/search_counts_response.json
 - spec/fixtures/system_messages/error.json
@@ -290,13 +287,6 @@ test_files:
 - spec/fixtures/twitter_messages/user_unsuspend.json
 - spec/fixtures/twitter_messages/user_withheld.json
 - spec/gnip_api/adapter_spec.rb
-- spec/gnip_api/adapters/base_adapter_spec.rb
-- spec/gnip_api/adapters/httparty_adapter_spec.rb
-- spec/gnip_api/apis/power_track/buffer_spec.rb
-- spec/gnip_api/apis/power_track/rule_spec.rb
-- spec/gnip_api/apis/power_track/rules_spec.rb
-- spec/gnip_api/apis/power_track/stream_spec.rb
-- spec/gnip_api/apis/search_spec.rb
 - spec/gnip_api/configuration_spec.rb
 - spec/gnip_api/endpoints_spec.rb
 - spec/gnip_api/gnip/activity_spec.rb
@@ -305,8 +295,12 @@ test_files:
 - spec/gnip_api/gnip/twitter_compliance_message_spec.rb
 - spec/gnip_api/gnip/url_spec.rb
 - spec/gnip_api/json_parser_spec.rb
+- spec/gnip_api/power_track/buffer_spec.rb
+- spec/gnip_api/power_track/rule_spec.rb
+- spec/gnip_api/power_track/rules_spec.rb
+- spec/gnip_api/power_track/stream_spec.rb
 - spec/gnip_api/request_spec.rb
 - spec/gnip_api/response_spec.rb
-- spec/lib/test_adapter.rb
+- spec/gnip_api/search_spec.rb
 - spec/spec_helper.rb
 - spec/test_spec.rb

data/lib/gnip_api/adapters/base_adapter.rb

@@ -1,94 +0,0 @@
-# BaseAdapter should be used on any adapter for this gem. In order
-# to create your own adapter you must inherit this class to 
-# let your adapter use the provided functionality of the gem. In 
-# other words, this just defines basic methods to provide the 
-# custom adapter with basic data.
-#
-# A few requirements to avoid issues for the adapter you want to use:
-# - Should support chunked read of stream
-# - Should handle compression (Excon seems to let user handle it)
-# - Shouldn't store chunked data (memory leak)
-# - Should allow custom headers
-# - Should allow block response
-#
-# To create a custom adapter, create your class, and implement the
-# following methods that GnipApi::Adapter will need.
-#
-# - #get
-# - #post
-# - #delete
-# - #stream_get
-#
-# All single-request methods (stream_get not included), should
-# return a GnipApi::Response object with:
-#
-# - status: integer value for status code (200, 403, etc)
-# - body: raw body, no matter if it's json or xml, the implementation of the api will know this
-# - headers: a hash with the response headers
-#
-# The response object is an effort to standarize the data and let Gnip::Adapter 
-# operate without the concern of the data format. The helper method to create
-# this response is available in this class, and will be available to your class
-# when you write your adapter.
-#
-# The process of parsing the headers to a hash, setting authorization headers or
-# parsing response data to break it down to status, body and headers are responsabilities
-# of your custom adapter class.
-#
-# Gnip::Adapter will pass your adapter a Gnip::Request object that contains:
-#
-# - uri: URI object with url, schema, etc
-# - payload: a parsed text to send in the request's body
-# - headers: a hash that may contain additional headers
-#
-# Your adapter should process this object and translate it into a relevant request for
-# your desired connector. Note that payload and headers may be nil if not needed.
-#
-# Last thing to denote, GnipApi::Adapter will expect an instance of your adapter to use.
-# What you do inside your adapter or how you implement a specific adapter is up to you.
-
-module GnipApi
-  module Adapters
-    class BaseAdapter
-      def username
-        GnipApi.configuration.user
-      end
-      
-      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
-      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

@@ -1,65 +0,0 @@
-module GnipApi
-  module Adapters
-    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
-
-      def stream_get request
-        begin
-          HTTParty.get request.uri, :headers => request.headers, :stream_body => true, :basic_auth => auth do |data|
-            yield(data)
-          end
-        rescue Zlib::BufError => error
-          GnipApi.config.logger.error "STREAM ERROR -> #{error.class} -- #{error.message}\n" + error.backtrace.join("\n")
-          raise error
-        end
-      end
-
-      def auth
-        {
-          :username => username,
-          :password => password
-        }
-      end
-      
-      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
-end

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

@@ -1,38 +0,0 @@
-module GnipApi
-  module Apis
-    module PowerTrack
-      class Buffer
-        attr_reader :terminator, :data
-
-        def initialize options={}
-          @terminator = options.delete(:terminator) || "\r\n"
-          @data = ""
-        end
-        
-        def size
-          @data.size
-        end
-        
-        def insert! chunk
-          @data << chunk
-        end
-
-        def read!
-          objects = @data.split(terminator)[0..-2]
-          unless objects.empty?
-            # Get the number of chars to read from buffer, counting
-            # the size of each splited chunk plus the number of chunks by
-            # terminator size, since it's still present in the buffer
-            size = objects.map(&:size).reduce(:+) + objects.size * terminator.size
-            consume!(size)
-          end
-          return objects
-        end
-
-        def consume! chars
-          @data[0..chars-1] = ''
-        end
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-module GnipApi
-  module Apis
-    module PowerTrack
-      class Rule
-        attr_accessor :value, :tag, :id
-
-        def initialize params={}
-          @value = params[:value] || params['value']
-          @tag = params[:tag] || params['tag']
-          @id = params[:id] || params['id']
-        end
-
-        def to_json
-          attributes.to_json
-        end
-
-        def attributes
-          attrs = {}
-          attrs[:value] = @value if @value
-          attrs[:tag] = @tag if @tag
-          attrs[:id] = @id if @id
-          attrs
-        end
-
-        def uid
-          rule = @value
-          rule += "tag:#{@tag}" if @tag
-          Digest::SHA2.hexdigest(rule)
-        end
-      end
-    end
-  end
-end

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

@@ -1,8 +0,0 @@
-module GnipApi
-  module Apis
-    module PowerTrack
-      class RuleValidator
-      end
-    end
-  end
-end

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

@@ -1,83 +0,0 @@
-# Gnip PowerTrack Rules API
-#
-# Create, delete and list rules of a powetrack stream.
-
-module GnipApi
-  module Apis
-    module PowerTrack
-      class Rules
-        attr_reader :adapter
-
-        # In order to do any operation, you need to specify:
-        # - label: the label of your stream
-        # - source: which data source to use (I think only twitter is available)
-        def initialize params={}
-          @adapter = GnipApi::Adapter.new
-          @label = params[:label] || GnipApi.config.label
-        end
-
-        # Returns an array of defined rules
-        def list
-          request = create_get_request
-          rules = adapter.get(request)
-          parse_rules(rules)
-        end
-
-        # Creates the specified rule. Parameters:
-        # - rules: GnipApi::Apis::PowerTrack::Rule object
-        def create rules
-          raise GnipApi::Errors::PowerTrack::MissingRules.new if rules.nil? || rules.empty?
-          request = create_post_request(construct_rules(rules))
-          response = adapter.post(request)
-          return true if response.nil?
-          return GnipApi::JsonParser.new.parse(response)
-        end
-
-        # Deletes the specified rule. Parameters:
-        # - rules: GnipApi::Apis::PowerTrack::Rule object
-        def delete rules
-          raise GnipApi::Errors::PowerTrack::MissingRules.new if rules.nil? || rules.empty?
-          request = create_delete_request(construct_rules(rules))
-          response = adapter.delete(request)
-          return true if response.nil?
-          return GnipApi::JsonParser.new.parse(response)
-        end
-
-        # Parses an array of GnipApi::Apis::PowerTrack::Rule objects
-        # to the necesary JSON format for the endpoint
-        def construct_rules rules
-          parsed_rules = {:rules => []}
-          rules.each do |rule|
-            parsed_rules[:rules] << rule.attributes
-          end
-          parsed_rules.to_json
-        end
-
-        def parse_rules data
-          parsed_data = GnipApi::JsonParser.new.parse(data)
-          parsed_data['rules'].map{|rule| GnipApi::Apis::PowerTrack::Rule.new(:value => rule['value'], :tag => rule['tag'], :id => rule['id'])}
-        end
-
-        private
-        def endpoint
-          GnipApi::Endpoints.powertrack_rules(@label)
-        end
-
-        def create_get_request
-          GnipApi::Request.new_get(endpoint)
-        end
-
-        def create_post_request payload
-          GnipApi::Request.new_post(endpoint, payload)
-        end
-        
-        def create_delete_request payload
-          delete_url = endpoint
-          delete_url.query = '_method=delete'
-          GnipApi::Request.new_delete(delete_url, payload)
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,84 +0,0 @@
-module GnipApi
-  module Apis
-    module PowerTrack
-      class Stream
-        attr_reader :adapter
-        
-        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
-        
-        def logger
-          GnipApi.logger
-        end
-
-        def consume
-          request = create_request
-          adapter.stream_get request do |chunk|
-            @buffer.insert! chunk
-            begin
-              yield process_entries(@buffer.read!)
-            rescue Exception => e
-              puts e.class
-              puts e.message
-              puts e.backtrace[0..10].join("\n")
-              raise e
-            end
-          end
-        end 
-
-        def process_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
-          entries.select{|message| message.system_message? }.each do |system_message|
-            GnipApi.logger.send(system_message.log_method, system_message.message)
-          end
-        end
-
-        def build_message params
-          Gnip::Message.build(params)
-        end
-
-        def parse_json json
-          begin 
-            GnipApi::JsonParser.new.parse json
-          rescue GnipApi::Errors::JsonParser::ParseError
-            nil
-          end
-        end
-
-        private
-        def create_request 
-          headers = {}
-          headers['Accept-Encoding'] = 'gzip' if GnipApi.config.enable_gzip
-          headers['Accept-Encoding'] ||= 'json'
-          GnipApi::Request.new_get(endpoint, headers)
-        end
-
-        def set_config
-          raise 'MissingStream' if @stream.nil?
-          @user = GnipApi.configuration.user
-          @password = GnipApi.configuration.password
-          @account = GnipApi.configuration.account
-          @adapter = GnipApi::Adapter.new
-          @buffer = GnipApi::Apis::PowerTrack::Buffer.new
-        end
-
-        def endpoint
-          GnipApi::Endpoints.powertrack_stream(@stream)
-        end
-
-      end
-    end
-  end
-end

data/lib/gnip_api/apis/search.rb

@@ -1,109 +0,0 @@
-# Gnip Search Full Archive API
-#
-# Retrive counts with a provided rule
-
-module GnipApi
-  module Apis
-    class Search
-      attr_reader :adapter
-
-      def initialize params={}
-        @adapter = GnipApi::Adapter.new
-        @label = params[:label] || GnipApi.config.label
-      end
-
-      def activities options={}
-        required_options?(options)
-        payload = construct_activities_payload(options)
-        request = GnipApi::Request.new_post(activities_endpoint, payload)
-        data = adapter.post(request)
-        return parse_activities_response(data)
-      end
-
-      def counts options={}
-        required_options?(options)
-        payload = construct_counts_payload(options)
-        request = GnipApi::Request.new_post(count_endpoint, payload)
-        data = adapter.post(request)
-        return parse_counts_response(data)
-      end
-
-      private
-      def count_endpoint
-        GnipApi::Endpoints.search_counts(@label)
-      end
-
-      def activities_endpoint
-        GnipApi::Endpoints.search_activities(@label)
-      end
-
-      def required_options
-        [:rule]
-      end
-
-      def required_options? options
-        provided_options = required_options - options.keys
-        raise GnipApi::Errors::Search::MissingParameters.new(provided_options) if provided_options.any?
-      end
-
-      def parse_date date
-        return nil unless date
-        date.strftime('%Y%m%d%H%M')
-      end
-
-      def parse_counts_response data
-        parsed_data = GnipApi::JsonParser.new.parse(data)
-        result_set = parsed_data['results']
-        params = parsed_data['requestParameters']
-        result = {:results => [], :total_count => parsed_data['totalCount'], :next => parsed_data['next'], :request_parameters => {}}
-        result[:request_parameters][:bucket] = params['bucket'] if params['bucket']
-        result[:request_parameters][:from_date] = Time.parse("#{params['fromDate']}-0000") if params['fromDate']
-        result[:request_parameters][:to_date] = Time.parse("#{params['toDate']}-0000") if params['toDate']
-        result_set.each do |item|
-          result[:results] << {:time_period => Time.parse("#{item['timePeriod']}-0000"), :count => item['count']}
-        end
-        return result
-      end
-
-      def parse_activities_response data
-        parsed_data = GnipApi::JsonParser.new.parse(data)
-        result_set = parsed_data['results']
-        params = parsed_data['requestParameters']
-        result = {:results => [], :next => parsed_data['next'], :request_parameters => {}}
-        result[:request_parameters][:bucket] = params['bucket'] if params['bucket']
-        result[:request_parameters][:from_date] = Time.parse("#{params['fromDate']}-0000") if params['fromDate']
-        result[:request_parameters][:to_date] = Time.parse("#{params['toDate']}-0000") if params['toDate']
-        result[:request_parameters][:max_results] = params['maxResults'] if params['maxResult']
-        result_set.each do |item|
-          result[:results] << Gnip::Activity.new(item)
-        end
-        return result
-      end
-
-      def construct_counts_payload options
-        payload = {
-          :query => options[:rule].value,
-          :fromDate => parse_date(options[:from_date]),
-          :toDate => parse_date(options[:to_date]),
-          :bucket => options[:bucket],
-          :next => options[:next_token]
-        }
-        payload.delete_if{|k,v| v.nil?}
-        return payload.to_json
-      end
-
-      def construct_activities_payload options
-        payload = {
-          :query => options[:rule].value,
-          :fromDate => parse_date(options[:from_date]),
-          :toDate => parse_date(options[:to_date]),
-          :tag => options[:rule].tag,
-          :maxResults => options[:max_results],
-          :next => options[:next_token]
-        }
-        payload.delete_if{|k,v| v.nil?}
-        return payload.to_json
-      end
-    end
-  end
-end