gnip_api 0.0.1 → 0.0.2

data/lib/gnip_api/errors.rb

@@ -0,0 +1,39 @@
+module GnipApi
+  module Errors
+    module Adapter
+      class RequestError < StandardError
+        def initialize msg='Request failed'
+          @message = msg
+        end
+      end
+    end
+
+    module PowerTrack
+      class MissingRules < StandardError
+        def initialize
+          @message = 'No rules provided to operate'
+        end
+      end
+    end
+
+    class MissingCredentials < StandardError
+      def initialize
+        @message = 'No credentials provided'
+      end
+    end
+    
+    class MissingAdapter < StandardError
+      def initialize
+        @message = 'No adapter selected'
+      end
+    end
+  end
+end
+
+module Gnip
+  class UndefinedMessage < StandardError
+    def initialize 
+      @message = 'Could not recognize message received'
+    end
+  end
+end

data/lib/gnip_api/gnip/activity.rb

@@ -0,0 +1,72 @@
+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
+
+    def initialize params = {}
+      @id = params['id']
+      @object_type = params['objectType']
+      @actor = Gnip::Actor.new params['actor']
+      @verb = params['verb']
+      @posted_time = params['postedTime']
+      @generator = params['generator']
+      @provider = params['provider']
+      @link = params['link']
+      @body = params['body']
+      @object = retweet? ? Gnip::Activity.new(params['object']) : params['object']
+      @favorites_count = params['favoritesCount']
+      @twitter_entities = params['twitter_entities']
+      @twitter_filter_level = params['twitter_filter_level']
+      @twitter_lang = params['twitter_lang']
+      @retweet_count = params['retweetCount']
+      @gnip = Gnip::GnipData.new(params['gnip']) if params['gnip']
+    end
+
+    def original_attributes
+      {
+        :id => @id,
+        :objectType => @object_type,
+        :actor => @actor.original_attributes,
+        :verb => @verb,
+        :postedTime => @posted_time,
+        :generator => @generator,
+        :provider => @provider,
+        :link => @link,
+        :body => @body,
+        :object => @object.kind_of?(Gnip::Activity) ? @object.original_attributes : @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
+      }
+    end
+
+    def posted_time
+      DateTime.parse(@posted_time)
+    end
+
+    def link
+      URI(@link)
+    end
+
+    def tweet_id
+      @id.split(':').last
+    end
+
+    def to_json
+      generate_json(original_attributes)
+    end
+
+    def author
+      actor.display_name
+    end
+
+    def retweet? 
+      verb == 'share'
+    end
+  end
+end
+

data/lib/gnip_api/gnip/actor.rb

@@ -1,34 +1,65 @@
 module Gnip
-  class Actor
-    attr_accessor :id, :object_type, :link, :display_name, :image, :summary,
-    :location, :friends_count, :followers_count, :statuses_count
+  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
     
     def initialize params = {}
-      @id = params['id']
       @object_type = params['objectType']
+      @id = params['id']
       @link = params['link']
       @display_name = params['displayName']
+      @posted_time = params['postedTime']
       @image = params['image']
       @summary = params['summary']
-      @location = params['location']
+      @links = params['links']
       @friends_count = params['friendsCount']
       @followers_count = params['followersCount']
+      @listed_count = params['listedCount']
       @statuses_count = params['statusesCount']
+      @twitter_time_zone = params['twitterTimeZone']
+      @verified = params['verified']
+      @utc_offset = params['utcOffset']
+      @preferred_username = params['preferredUsername']
+      @languages = params['languages'].join(',')
+      @location = params['location']
+      @favorites_count = params['favoritesCount']
     end
 
-    def to_json
+    def original_attributes
       {
+        :objectType => @object_type,
         :id => @id,
-        :object_type => @object_type,
         :link => @link,
-        :display_name => @display_name,
+        :displayName => @display_name,
+        :postedTime => @posted_time,
         :image => @image,
         :summary => @summary,
+        :links => @links,
+        :friendsCount => @friends_count,
+        :followersCount => @followers_count,
+        :listedCount => @listed_count,
+        :statusesCount => @statuses_count,
+        :twitterTimeZone => @twitter_time_zone,
+        :verified => @verified,
+        :utcOffset => @utc_offset,
+        :preferredUsername => @preferred_username,
+        :languages => @languages.split(','),
         :location => @location,
-        :friends_count => @friends_count,
-        :followers_count =>  @followers_count,
-        :statuses_count => @statuses_count
+        :favoritesCount => @favorites_count
       }
     end
+
+    def user_id
+      @id.split(':').last
+    end
+
+    def image
+      URI(@image)
+    end
+
+    def to_json
+      generate_json(original_attributes)
+    end
   end
 end

data/lib/gnip_api/gnip/gnip_data.rb

@@ -0,0 +1,23 @@
+module Gnip
+  class GnipData < Gnip::Message
+    attr_reader :matching_rules, :urls, :language
+
+    def initialize params={}
+      @matching_rules = params['matching_rules'].map{|r| GnipApi::Apis::PowerTrack::Rule.new(r)} if params['matching_rules']
+      @urls = (params['urls'] ? params['urls'].map{|u| Gnip::Url.new(u)} : [])
+      @language = params['language']
+    end
+
+    def original_attributes
+      {
+        :matching_rules => @matching_rules.map(&:attributes),
+        :urls => @urls.map(&:original_attributes),
+        :language => @language
+      }.delete_if{|k,v| v.nil?}
+    end
+
+    def to_json
+      generate_json(original_attributes)
+    end
+  end
+end

data/lib/gnip_api/gnip/message.rb

@@ -1,71 +1,44 @@
 module Gnip
   class Message
+    SYSTEM_MESSAGE_TYPES = ['error', 'warn', 'info']
+
     def self.build params
-      if params['error'] || params['warn'] || params['info']
-        SystemMessage.new params
-      elsif params['id']
-        Activity.new params
-      end
+      return build_system_message(params) if (SYSTEM_MESSAGE_TYPES & params.keys).any?
+      return build_activity(params) if params['objectType'] && params['objectType'] == 'activity'
+      raise Gnip::UndefinedMessage
     end
 
     def system_message?
-      false
+      @message_type ? true : false
     end
 
-    def activity?
-      false
+    def error?
+      @message_type == 'error'
     end
-  end
-
-  class SystemMessage < Message
-    attr_accessor :message, :sent
-
-    def initialize params
-      @message = params['message']
-      @sent = params['sent']
+    
+    def warn?
+      @message_type == 'warn'
     end
-
-    def system_message?
-      true
-    end
-  end
-
-  class Activity < Message
-    attr_accessor :id, :actor, :object_type, :verb, :posted_time, :provider, :link, :body
-    def initialize params = {}
-      @id = params['id']
-      @object_type = params['objectType']
-      @verb = params['verb']
-      @posted_time = params['postedTime']
-      @provider = params['provider']
-      @link = params['link']
-      @body = retweet? ? params['object']['body'] : params['body']
-      @actor = Actor.new params['actor']
+    
+    def info?
+      @message_type == 'info'
     end
 
-    def to_json
-      {
-        :id => @id,
-        :actor => @actor.to_json,
-        :object_type => @object_type,
-        :verb => @verb,
-        :posted_time => @posted_time,
-        :provider => @provider,
-        :link => @link,
-        :body => @body
-      }.to_json
+    def activity?
+      @object_type == 'activity'
     end
-
-    def author
-      actor.display_name
+    
+    def generate_json data
+      JSON.generate(data)
     end
 
-    def activity?
-      true
+    private
+    def self.build_system_message params
+      Gnip::SystemMessage.new params
     end
 
-    def retweet? 
-      verb == 'share'
+    def self.build_activity params
+      Gnip::Activity.new params
     end
   end
 end

data/lib/gnip_api/gnip/system_message.rb

@@ -0,0 +1,30 @@
+module Gnip
+  class SystemMessage < Gnip::Message
+    attr_reader :message, :sent, :message_type
+
+    def initialize params
+      @message_type = params.keys.first
+      @message = params['message']
+      @sent = params['sent']
+    end
+
+    def original_attributes
+      {
+        @message_type => @message,
+        :sent => @sent
+      }
+    end
+
+    def log_method
+      @message_type.to_sym
+    end
+
+    def message
+      @message.strip
+    end
+    
+    def to_json
+      parse_json(original_attributes)
+    end
+  end
+end

data/lib/gnip_api/gnip/url.rb

@@ -0,0 +1,35 @@
+module Gnip
+  class Url < Gnip::Message
+    attr_reader :url, :expanded_url, :expanded_status, :display_url, :indices
+
+    def initialize params={}
+      @url = params['url']
+      @expanded_url = params['expanded_url']
+      @display_url = params['display_url']
+      @expanded_status = params['expanded_status']
+      @indices = params['indices']
+    end
+
+    def url
+      URI(@url) unless @url.nil?
+    end
+    
+    def expanded_url
+      URI(@expanded_url) unless @url.nil?
+    end
+
+    def original_attributes
+      {
+        :url => @url,
+        :display_url => @display_url,
+        :expanded_url => @expanded_url,
+        :expanded_status => @expanded_status,
+        :indices => @indices
+      }.delete_if{|k,v| v.nil?}
+    end
+
+    def to_json
+      generate_json(original_attributes)
+    end
+  end
+end

data/lib/gnip_api/limiters/rules.rb

@@ -0,0 +1,56 @@
+module GnipApi
+  module Limiters
+    module Rules
+
+      def rules_init
+        @rules_last_reset = Time.now
+        @rules_requests = 0
+      end
+      
+      def rules_request_allowed?
+        mutex.synchronize do
+          reset_rules_if_expired!
+          add_rules_request!
+          return true if @rules_requests <= rules_max_requests
+          return false
+        end
+      end
+      
+      def reset_rules_if_expired!
+        if seconds_since_last_rules_request >= rules_expire
+          reset_rules!
+        end
+      end
+      
+      def seconds_since_last_rules_request
+        Time.now.to_i - @rules_last_reset.to_i
+      end
+      
+      def add_rules_request!
+        @rules_requests += 1
+      end
+      
+      def reset_rules!
+        @rules_last_reset = Time.now
+        @rules_requests = 0
+      end
+      
+      def rules_last_reset
+        @rules_last_reset
+      end
+      
+      def rules_requests
+        @rules_requests
+      end
+      
+      def rules_max_requests
+        5
+      end
+      
+      def rules_expire
+        1
+      end
+
+    end
+  end
+end

data/lib/gnip_api/rate_limiter.rb

@@ -0,0 +1,14 @@
+module GnipApi
+  class RateLimiter
+    include GnipApi::Limiters::Rules
+    
+    def initialize
+      self.rules_init
+    end
+
+    private
+    def mutex
+      GnipApi.config.mutex
+    end
+  end
+end

data/lib/gnip_api/request.rb

@@ -0,0 +1,26 @@
+module GnipApi
+  class Request
+    attr_reader :uri, :payload, :headers, :request_method
+
+    class << self
+      def new_get uri, headers=nil
+        new(:uri => uri, :headers => headers, :request_method => GnipApi::Adapter::GET, )
+      end
+      
+      def new_post uri, payload, headers=nil
+        new(:uri => uri, :headers => headers, :payload => payload, :request_method => GnipApi::Adapter::POST)
+      end
+      
+      def new_delete uri, payload, headers=nil
+        new(:uri => uri, :headers => headers, :payload => payload, :request_method => GnipApi::Adapter::DELETE)
+      end
+    end
+
+    def initialize params={}
+      @uri = params[:uri]
+      @payload = params[:payload]
+      @headers = params[:headers]
+      @request_method = params[:request_method]
+    end
+  end
+end

data/lib/gnip_api/response.rb

@@ -0,0 +1,35 @@
+module GnipApi
+  class Response
+    # List of codes that are considered OK
+    OK_STATUSES = [200, 201, 202, 203, 204, 205, 206, 207, 208, 226]
+
+    attr_reader :body, :headers, :status, :request
+    
+    def initialize request, status, body, headers
+      @status = status
+      @body = body
+      @headers = headers
+      @request = request
+    end
+
+    def request_method
+      @request.request_method
+    end
+
+    def request_uri
+      @request.uri
+    end
+
+    def ok?
+      OK_STATUSES.include? @status
+    end
+
+    def error_message
+      if @body && !@body.empty?
+        parsed = JSON.parse(@body)
+        return parsed['error']['message'] if parsed['error']
+      end
+      return nil
+    end
+  end
+end

data/lib/gnip_api/version.rb

@@ -1,3 +1,3 @@
 module GnipApi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/gnip_api.rb

@@ -1,13 +1,28 @@
 require "gnip_api/version"
+require "gnip_api/errors"
 require "gnip_api/configuration"
 require "gnip_api/endpoints"
+require "gnip_api/limiters/rules"
+require "gnip_api/rate_limiter"
 require "gnip_api/apis/power_track/stream"
 require "gnip_api/apis/power_track/rules"
 require "gnip_api/apis/power_track/buffer"
+require "gnip_api/apis/power_track/rule"
+require "gnip_api/apis/search/stream"
+require "gnip_api/apis/search/count"
+require "gnip_api/apis/search/query"
+require "gnip_api/apis/search/result"
 require "gnip_api/gnip/message"
+require "gnip_api/gnip/system_message"
 require "gnip_api/gnip/actor"
+require "gnip_api/gnip/activity"
+require "gnip_api/gnip/gnip_data"
+require "gnip_api/gnip/url"
 require "gnip_api/adapter"
+require "gnip_api/adapters/base_adapter"
 require "gnip_api/adapters/httparty_adapter"
+require "gnip_api/response"
+require "gnip_api/request"
 
 # External
 require 'httparty'
@@ -32,5 +47,21 @@ module GnipApi
     def logger
       self.configuration.logger
     end
+
+    def rate_limiter
+      self.configuration.rate_limiter
+    end
+    
+    def config
+      self.configuration
+    end
+
+    def credentials?
+      @configuration.user && @configuration.password && @configuration.account
+    end
+
+    def adapter_class?
+      @configuration.adapter_class ? true : false
+    end
   end
 end