tweettop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb4b7a3dda0c1040734a25bf8f245e31d690ee56375a0f021ac8d27b881eb984
+  data.tar.gz: 5f14034ec6d23dbc61c3c5befbc08317a80fade31a714aaa85a1d19147f8fb77
+SHA512:
+  metadata.gz: 126cd00bf0ca6035852019607be931802ff536c4291f9ca68cfaf8865a111b3188521144f3c62e3d8b7cc31ff1be9a9ae77f15194fbcb73158f096d0e7792475
+  data.tar.gz: 0d8e8b6bf5c259bc49a0cc6d3254fb093188303088e5cc6a0661be4627235acb8cae3b20612ab8fb169e00805d9b53f564c52ab022537ac0f9909ee99b2201a2

data/lib/get_follow.rb

@@ -0,0 +1,70 @@
+require 'json'
+require 'typhoeus'
+
+module GetFollow
+    def get_followers(user_id, results: 100, info: "description,name,username,url", format: "json")
+        '''info parameter options (must be a string with the required options): created_at, description, entities,
+         id, location, name, pinned_tweet_id, profile_image_url, protected, public_metrics, url, username, verified, withheld
+        default info: description,name,username,url'''
+        url = "https://api.twitter.com/2/users/#{user_id}/followers"
+
+        info = info.gsub(" ", "")
+
+        params = {
+            "max_results" => results,
+            "user.fields" => info          
+        }
+
+        options = {
+            method: 'get',
+            headers: {
+                "Authorization": "Bearer #{@bearer_token}"
+            },
+            params: params
+        }
+
+        request = Typhoeus::Request.new(url, options)
+        response = request.run
+
+        if format == "ruby"
+            return JSON.parse(response.body.to_s)
+        elsif format == "code"
+            return response.code
+        else
+            return JSON.pretty_generate(JSON.parse(response.body))
+        end
+    end
+
+    def get_following(user_id, results: 100, info: "description,name,username,url", format: "json")
+        '''info parameter options (must be a string with the required options): created_at, description, entities,
+         id, location, name, pinned_tweet_id, profile_image_url, protected, public_metrics, url, username, verified, withheld
+        default info: description,name,username,url'''
+        url = "https://api.twitter.com/2/users/#{user_id}/following"
+
+        info = info.gsub(" ", "")
+
+        params = {
+            "max_results" => results,
+            "user.fields" => info          
+        }
+
+        options = {
+            method: 'get',
+            headers: {
+                "Authorization": "Bearer #{@bearer_token}"
+            },
+            params: params
+        }
+
+        request = Typhoeus::Request.new(url, options)
+        response = request.run
+
+        if format == "ruby"
+            return JSON.parse(response.body.to_s)
+        elsif format == "code"
+            return response.code    
+        else
+            return JSON.pretty_generate(JSON.parse(response.body))
+        end
+    end
+end

data/lib/get_tweets.rb

@@ -0,0 +1,59 @@
+require 'json'
+require 'typhoeus'
+
+module GetTweets
+    def get_tweets(tweet_ids, format: "json")#"tweet_ids" must be a string. If more than one ID's are given, they must be comma separated
+        url = "https://api.twitter.com/2/tweets"
+        tweet_ids = tweet_ids.gsub(" ", "")
+        params = {
+	        "ids" => tweet_ids,
+            "tweet.fields" => "conversation_id,created_at,public_metrics,id,referenced_tweets",
+            "media.fields" => "url",
+            "user.fields" => "description,username,url",
+            "expansions" => "author_id"            
+        }
+
+        options = {
+            method: 'get',
+            headers: {
+                "Authorization": "Bearer #{@bearer_token}"
+            },
+            params: params
+        }
+
+        request = Typhoeus::Request.new(url, options)
+        response = request.run
+
+        if format == "ruby"
+            return JSON.parse(response.body.to_s) 
+        elsif format == "code"
+            return response.code 
+        else
+            return JSON.pretty_generate(JSON.parse(response.body))
+        end
+    end
+
+    def get_conversation(tweet_id, format: "json")#tweet_id must be a single tweet ID
+        ids = "#{tweet_id}"
+        loop do
+            tweet = get_tweets(tweet_id, format: "ruby")
+            if is_a_reply(tweet)
+                tweet_id = tweet["data"][0]["referenced_tweets"][0]["id"]
+                ids += ",#{tweet["data"][0]["referenced_tweets"][0]["id"]}"
+            else
+                break
+            end
+        end
+        return get_tweets(ids, format: format)
+    end
+
+    private
+
+    def is_a_reply(tweet)
+        if tweet["data"][0]["referenced_tweets"].class == Array
+            return true
+        else
+            return false
+        end
+    end
+end

data/lib/get_user.rb

@@ -0,0 +1,96 @@
+require 'oauth'
+require 'json'
+require 'typhoeus'
+require 'oauth/request_proxy/typhoeus_request'
+
+module GetUser
+    def get_user(usernames, format: "json")
+
+        url = "https://api.twitter.com/2/users/by"
+
+        query_params = {
+	        "usernames": usernames,
+            "user.fields": "name,description,created_at"
+        }
+
+        options = {
+	        :method => :get,
+	        params: query_params
+	    }
+	    
+        access_token = @credentials
+
+        oauth_params = {:consumer => @client, :token => access_token}
+        
+        request = Typhoeus::Request.new(url, options)
+	    oauth_helper = OAuth::Client::Helper.new(request, oauth_params.merge(:request_uri => url))
+	    request.options[:headers].merge!({"Authorization" => oauth_helper.header})
+	    response = request.run
+
+	    if format == "ruby"
+            return JSON.parse(response.body.to_s) 
+        elsif format == "code"
+            return response.code 
+        else
+            return JSON.pretty_generate(JSON.parse(response.body))
+        end
+    end
+
+    def get_user!(usernames, format: "json")
+        
+        url = "https://api.twitter.com/2/users/by"
+        
+        query_params = {
+	        "usernames": usernames,
+            "user.fields": "name,description,created_at"
+        }
+        
+        options = {
+            method: 'get',
+            headers: {
+              "Authorization" => "Bearer #{@bearer_token}"
+              },
+            params: query_params
+        }
+        
+        request = Typhoeus::Request.new(url, options)
+        response = request.run
+        
+        if format == "ruby"
+            return JSON.parse(response.body.to_s) 
+        elsif format == "code"
+            return response.code 
+        else
+            return JSON.pretty_generate(JSON.parse(response.body))
+        end
+    end
+
+    def get_user_by_id(user_ids, format: "json")#"user_ids" must be a string. If more than one ID's are given, they must be comma separated
+        
+        url = "https://api.twitter.com/2/users"
+        
+        query_params = {
+	        "ids": user_ids,
+            "user.fields": "name,description,created_at"
+        }
+        
+        options = {
+            method: 'get',
+            headers: {
+              "Authorization" => "Bearer #{@bearer_token}"
+              },
+            params: query_params
+        }
+        
+        request = Typhoeus::Request.new(url, options)
+        response = request.run
+        
+        if format == "ruby"
+            return JSON.parse(response.body.to_s) 
+        elsif format == "code"
+            return response.code 
+        else
+            return JSON.pretty_generate(JSON.parse(response.body))
+        end
+    end
+end

data/lib/get_user_timeline.rb

@@ -0,0 +1,35 @@
+require 'json'
+require 'typhoeus'
+
+module GetUserTimeline
+    def get_user_timeline(user_id, results = 5, format: "json") #results: minimum 5, maximum 200
+        
+        url = "https://api.twitter.com/2/users/#{user_id}/tweets"
+        
+        query_params = {
+            "max_results" => results,
+            "tweet.fields" => "conversation_id,created_at,public_metrics,id,referenced_tweets",
+            "user.fields" => "description,username,url",
+            "media.fields" => "url" 
+        }
+
+        options = {
+            method: 'get',
+            headers: {
+              "Authorization" => "Bearer #{@bearer_token}"
+              },
+            params: query_params
+        }
+
+        request = Typhoeus::Request.new(url, options)
+        response = request.run
+
+        if format == "ruby"
+            return JSON.parse(response.body.to_s) 
+        elsif format == "code"
+            return response.code 
+        else
+            return JSON.pretty_generate(JSON.parse(response.body))
+        end
+    end
+end

data/lib/post_delete_tweets.rb

@@ -0,0 +1,55 @@
+require 'oauth'
+require 'json'
+require 'typhoeus'
+require 'oauth/request_proxy/typhoeus_request'
+
+module PostDeleteTweets
+    def post_tweet(text)
+
+        url = "https://api.twitter.com/2/tweets"
+
+        @json_payload = {"text": text}
+
+        options = {
+	        :method => :post,
+	        headers: {
+                "content-type": "application/json"
+	        },
+	        body: JSON.dump(@json_payload)
+        }
+	    
+        access_token = @credentials
+
+        oauth_params = {:consumer => @client, :token => access_token}
+        
+        request = Typhoeus::Request.new(url, options)
+	    oauth_helper = OAuth::Client::Helper.new(request, oauth_params.merge(:request_uri => url))
+	    request.options[:headers].merge!({"Authorization" => oauth_helper.header})
+	    response = request.run
+
+	    return response.code, JSON.pretty_generate(JSON.parse(response.body))
+    end
+
+    def delete_tweet(tweet_id)
+
+        url = "https://api.twitter.com/2/tweets/#{tweet_id}"
+
+        options = {
+	        :method => :delete,
+	        headers: {
+                "content-type": "application/json"
+	        }
+	    }
+	    
+        access_token = @credentials
+
+        oauth_params = {:consumer => @client, :token => access_token}
+        
+        request = Typhoeus::Request.new(url, options)
+	    oauth_helper = OAuth::Client::Helper.new(request, oauth_params.merge(:request_uri => url))
+	    request.options[:headers].merge!({"Authorization" => oauth_helper.header})
+	    response = request.run
+
+        return response.code
+    end
+end

data/lib/tweettop/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Tweettop
+  VERSION = "0.1.0"
+end

data/lib/tweettop.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require_relative "tweettop/version"
+require_relative "user.rb"

data/lib/user.rb

@@ -0,0 +1,30 @@
+require "typhoeus"
+require "json"
+require "oauth"
+require_relative "get_user_timeline.rb"
+require_relative "get_tweets.rb"
+require_relative "get_user.rb"
+require_relative "get_follow.rb"
+require_relative "post_delete_tweets.rb"
+
+module TweetTop
+    class User
+        include GetUserTimeline
+        include GetTweets
+        include GetUser
+        include GetFollow
+        include PostDeleteTweets
+    
+        def initialize(api_key, api_key_secret, access_token, access_token_secret, bearer_token)
+            @api_key = api_key
+            @api_key_secret = api_key_secret
+            @access_token = access_token
+            @access_token_secret = access_token_secret
+            @bearer_token = bearer_token
+            @client = OAuth::Consumer.new(@api_key, @api_key_secret, :site => 'https://api.twitter.com',
+                                                                     :authorize_path => '/oauth/authenticate',
+                                                                     :debug_output => false)
+            @credentials = OAuth::AccessToken.new(@client, @access_token, @access_token_secret)
+        end
+    end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: tweettop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolás Cané
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.10
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+description: 
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/get_follow.rb
+- lib/get_tweets.rb
+- lib/get_user.rb
+- lib/get_user_timeline.rb
+- lib/post_delete_tweets.rb
+- lib/tweettop.rb
+- lib/tweettop/version.rb
+- lib/user.rb
+homepage: https://github.com/CaneNicolas/tweettop
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/CaneNicolas/tweettop
+  source_code_uri: https://github.com/CaneNicolas/tweettop
+  changelog_uri: https://github.com/CaneNicolas/tweettop
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: A simple API wrapper for Twitter API requests.
+test_files: []