botinsta 0.1.1

data/lib/botinsta/data/media_data.rb

@@ -0,0 +1,42 @@
+# Class handling media data.
+# Takes a data object extended Hashie::Extensions::DeepFind
+class MediaData
+
+  attr_reader :id, :owner, :text, :shortcode, :tags
+
+  def initialize(data)
+
+    @id                 = data.deep_find('id')
+    @owner              = data.deep_find('owner')['id']
+    @is_video           = data.deep_find('is_video')
+    @comments_disabled  = data.deep_find('comments_disabled')
+    @text               = data.deep_find('text')
+    @tags               = @text.scan(/#[a-zA-Z0-9]+/)
+    @shortcode          = data.deep_find('shortcode')
+
+  end
+
+  def comments_disabled?
+    @comments_disabled
+  end
+
+  def blacklisted_tag?(tag_blacklist)
+    !(@tags & tag_blacklist).empty?
+  end
+
+  def video?
+    @is_video
+  end
+
+  def insert_into_db(table)
+    table.insert(media_id: @id, user_id: @owner, shortcode: @shortcode, like_time: Time.now)
+  end
+
+  def delete_from_db(table)
+    table.where(media_id: @id).delete
+  end
+
+  def exists_in_db?(table)
+    !table.where(media_id: @id).empty?
+  end
+end

data/lib/botinsta/data/page_data.rb

@@ -0,0 +1,36 @@
+# Class handling media data.
+# Takes a data object extended Hashie::Extensions::DeepFind
+class PageData
+
+  attr_reader :hashtag_id, :hashtag_name, :end_cursor,
+              :medias, :media_count, :top_medias, :top_media_count,
+              :all_media, :all_media_count
+
+  def initialize(data)
+
+    @hashtag_id       = data.deep_find('hashtag')['id']
+    @hashtag_name     = data.deep_find('hashtag')['name']
+    @has_next_page    = data.deep_find('page_info')['has_next_page']
+    @end_cursor       = data.deep_find('end_cursor')
+    @top_medias       = data['data']['hashtag']['edge_hashtag_to_top_posts']['edges']
+    @top_media_count  = @top_medias.count
+    @medias           = data['data']['hashtag']['edge_hashtag_to_media']['edges']
+    @media_count      = @medias.count + @top_media_count
+    @all_media        = @top_medias + @medias
+    @all_media_count  = @all_media.count
+
+  end
+
+  def next_page?
+    @has_next_page
+  end
+
+  def end_cursor_nil?
+    @end_cursor.nil?
+  end
+
+  def medias_empty?
+    @medias.empty?
+  end
+
+end

data/lib/botinsta/data/user_data.rb

@@ -0,0 +1,31 @@
+# Class handling user data.
+# Takes a data object extended Hashie::Extensions::DeepFind
+class UserData
+
+  attr_reader :id, :username, :full_name, :follower_count, :following_count
+
+  def initialize(data)
+    @id              = data.deep_find('pk')
+    @username        = data.deep_find('username')
+    @full_name       = data.deep_find('full_name')
+    @following_count = data.deep_find('following_count')
+    @follower_count  = data.deep_find('follower_count')
+    @is_private      = data.deep_find('is_private')
+  end
+
+  def private?
+    @is_private
+  end
+
+  def insert_into_db(table)
+    table.insert(user_id: @id, username: @username, follow_time: Time.now)
+  end
+
+  def delete_from_db(table)
+    table.where(user_id: @id).delete
+  end
+
+  def exists_in_db?(table)
+    !table.where(user_id: @id).empty?
+  end
+end

data/lib/botinsta/helpers.rb

@@ -0,0 +1,156 @@
+# Some helper methods
+# to use in main methods for the bot.
+module Helpers
+
+  # Prints out the current time
+  # @example
+  #   print_time_stamp # => "2018-09-19 12:14:43"
+  def print_time_stamp
+    print "#{Time.now.strftime('%Y-%m-%d %H:%M:%S')}\t"
+  end
+
+  # Prints success message for a specified action.
+  #
+  # @option params [Symbol] :action The action performed.
+  # @option params [String] :data The id that the action is performed on.
+  # @option params [Integer] :number The number of times that the action has been performed.
+  def print_success_message(**params)
+    action = case params[:action]
+             when :like     then 'liked media'
+             when :unlike   then 'unliked media'
+             when :follow   then 'followed user'
+             when :unfollow then 'unfollowed user'
+             when :comment  then 'commented on media'
+             end
+    success_string = "Successfully #{action} ##{params[:number]} ".colorize(:green) + params[:data].to_s
+    print_time_stamp
+    puts success_string
+  end
+
+  # Prints error message for a specified action.
+  #
+  # @option params [Symbol] :action The action performed.
+  # @option params [String] :data The id that the action is performed on.
+  def print_error_message(**params)
+    action = case params[:action]
+             when :like     then 'like media'
+             when :unlike   then 'unlike media'
+             when :follow   then 'follow user'
+             when :unfollow then 'unfollow user'
+             when :comment  then 'comment on media'
+             end
+    error_string = "There was an error trying to #{action} ".colorize(:red) + params[:data].to_s
+    print_time_stamp
+    puts error_string
+
+  end
+
+  # Prints login status message for the account
+  #
+  # @option params [Symbol] :result Login status
+  # @option params [String] :username
+  def print_login_message(**params)
+    result = case params[:result]
+             when :success  then 'Successfully logged in as '
+             when :error    then 'There was an error trying to login as '
+             end
+    print_time_stamp
+    puts result.colorize(:red) + params[:username]
+  end
+
+  # Prints messages when trying to take some action.
+  #
+  # @option params [Symbol] :action The action that the bot is trying to take.
+  # @option params [String, Integer] :data The data which will be
+  #   affected by the specified action.
+  def print_try_message(**params)
+    action = case params[:action]
+             when :login    then 'Trying to login ...'
+             when :logout   then 'Trying to logout ...'
+             when :like     then 'Trying to like media '
+             when :unlike   then 'Trying to unlike media '
+             when :follow   then 'Trying to follow user '
+             when :unfollow then 'trying to unfollow user '
+             end
+    print_time_stamp
+    puts action.colorize(:light_red) + "#{params[:data].to_s unless params[:data].nil?}"
+    sleep(1)
+  end
+
+  # Prints action sum. Used before logging out.
+  #
+  # @example
+  #   bot.print_action_sum # => 2018-09-19 17:41:11	Liked: 0 Followed: 0 Unfollowed: 0
+  def print_action_sum
+    string =  'Liked: ' + @total_likes.to_s.colorize(:red) +
+              ' Followed: ' + @total_follows.to_s.colorize(:red) +
+              ' Unfollowed: ' + @total_unfollows.to_s.colorize(:red)
+    print_time_stamp
+    puts string
+  end
+
+  # Prints out when the current is set to some specified tag.
+  #
+  # @param tag [String] current tag.
+  def print_tag_message(tag)
+    print_time_stamp
+    puts 'Current tag is set to '.colorize(:blue) + '#' + tag
+  end
+
+  def sleep_rand(min, max)
+    sleep_time = rand(min..max)
+    sleep(1)
+    print_time_stamp
+    puts "Sleeping for #{sleep_time - 1} seconds ...".colorize(:red)
+    sleep(sleep_time - 1)
+  end
+
+  # Handles the creation and connection of a database and its tables.
+  # Sets @table_follows and @table_likes to the related tables for further use.
+  def handle_database_creation
+    database = Sequel.sqlite('./actions_db.db') # memory database, requires sqlite3
+    database.create_table? :"#{@username}_follows" do
+      primary_key :id
+      String  :user_id
+      String  :username
+      Time    :follow_time
+    end
+    database.create_table? :"#{@username}_likes" do
+      primary_key :id
+      String :media_id
+      String :user_id
+      String :shortcode
+      Time   :like_time
+    end
+    @table_follows  = database[:"#{@username}_follows"]
+    @table_likes    = database[:"#{@username}_likes"]
+  end
+
+  # Reassigns the database related variables to the first entry
+  # in the database.
+  # Used after a deletion from the database.
+  def refresh_db_related
+    return if @table_follows.empty?
+
+    @first_db_entry = @table_follows.first
+    @last_follow_time = @first_db_entry[:follow_time]
+  end
+
+  # The method that is used to delete a user from the database
+  # after unfollowing the user.
+  #
+  # @todo This method needs to be replaced with a better and DRY one.
+  # @param user_id [String, Integer] id of the user to be unfollowed.
+  def delete_from_db(user_id)
+    @table_follows.where(user_id: user_id).delete
+  end
+
+  # Calculates if a day is past since the first follow entry in the database.
+  #
+  # @param last_time [Time] a Time instance, used with @last_follow_time.
+  # @return [Boolean] true if a day is past since
+  #   the first follow entry in the database, false otherwise.
+  def one_day_past?(last_time)
+    ((Time.now - last_time) / 86_400) >= 1
+  end
+end

data/lib/botinsta/login.rb

@@ -0,0 +1,48 @@
+# Contains login and logout methods for the bot.
+module Login
+
+  # Login method to log the user in.
+  # Prints success message on successful login,
+  #   error message otherwise.
+  # @example Login example
+  #   bot.login # => 2018-09-19 17:39:45	Trying to login ...
+  #             # => 2018-09-19 17:39:47	Successfully logged in as andreyuhai
+  def login
+    @agent = Mechanize.new
+
+    # Navigate to classic login page
+    login_page = @agent.get 'https://www.instagram.com/accounts/login/?force_classic_login'
+
+    # Get the login form
+    login_form = login_page.forms.first
+
+    # Fill in the login form
+    login_form['username'] = @username
+    login_form['password'] = @password
+
+    # Submit the form and if couldn't login raise an exception.
+    print_try_message(action: :login)
+    response = login_form.submit
+    if response.code != 200 && response.body.include?('not-logged-in')
+      login_status = false
+    else
+      print_login_message(result: :success, username: @username)
+      login_status = true
+    end
+    raise StandardError unless login_status
+  rescue StandardError
+    print_login_message(result: :error, username: @username)
+    # TODO: logger to log these kind of stuff
+    exit
+  end
+
+  # Prints action sum and then logs the user out.
+  # @example Logout example
+  #   bot.logout # => 2018-09-19 17:41:11	Liked: 0 Followed: 0 Unfollowed: 0
+  #              # => 2018-09-19 17:41:11	Trying to logout ...
+  def logout
+    print_action_sum
+    print_try_message(action: :logout)
+    @agent.get 'https://instagram.com/accounts/logout/'
+  end
+end

data/lib/botinsta/modes.rb

@@ -0,0 +1,66 @@
+# Contains bot modes.
+# The bot has only one mode for now, which is tag based mode.
+# In this mode bot works on a tag basis. Gets medias from specified tags,
+#   likes them and follows the owner of the media until it fulfills
+#   its like and follow limits for the day.
+module Modes
+
+  def tag_based_mode
+    @tags.each do |tag|
+      like_count = 0; follow_count = 0
+      is_first_page = true
+      print_tag_message tag
+      until like_count == @likes_per_tag && follow_count == @follows_per_tag
+
+        if is_first_page
+          set_query_id(tag)
+          get_first_page_data(tag)
+          is_first_page = false
+          break if @page.medias_empty?
+        elsif like_count == @page.media_count && @page.has_next_page?
+          get_next_page_data(tag)
+        end
+        @page.medias.each do |media|
+          media.extend Hashie::Extensions::DeepFind
+          @media = MediaData.new(media)
+          next if @media.blacklisted_tag?(@tag_blacklist)
+
+          # Here is the code for liking stuff.
+          if like_count != @likes_per_tag
+            if like_if_not_in_db(@media)
+              like_count += 1
+            else
+              print_error_message(action: :like, data: @media.id)
+            end
+          end
+
+          # Here is the code for following users.
+          if follow_count != @follows_per_tag
+            if get_user_page_data(@media.owner) && follow_if_not_in_db(@user)
+              follow_count += 1
+            else
+              print_error_message(action: :follow, data: @user.username)
+            end
+          end
+
+          # Here is the code for unfollowing users
+          if !@table_follows.empty? && one_day_past?(@last_follow_time) && @total_unfollows != @unfollows_per_run
+            if unfollow_user(@first_db_entry[:user_id])
+              @total_unfollows += 1
+              print_success_message(action: :unfollow, number: @total_unfollows,
+                                    data: @first_db_entry[:username])
+              delete_from_db(@first_db_entry[:user_id])
+              refresh_db_related
+            else
+              false
+            end
+          end
+          break if like_count == @likes_per_tag && follow_count == @follows_per_tag
+        end
+      end
+    end
+  rescue Interrupt
+    logout
+    exit
+  end
+end

data/lib/botinsta/pages.rb

@@ -0,0 +1,79 @@
+# Contains methods for getting pages, query_id and JS link.
+# To like a media from every tag we first need its query_id (a.k.a) query_hash
+#
+module Pages
+  # Sets the query id for the current tag.
+  #
+  # @param tag [String] Current tag.
+  # @return @query_id [String] Returns the instance variable @query_id
+  def set_query_id(tag)
+    response = @agent.get get_js_link tag
+    # RegExp for getting the right query id. Because there are a few of them.
+    match_data = /byTagName\.get\(t\)\.pagination},queryId:"(?<queryId>[0-9a-z]+)/.match(response.body)
+    @query_id = match_data[:queryId]
+  end
+
+  # Returns the .js link of the TagPageContainer
+  # from which we will extract the query_id.
+  #
+  # @param (see #set_query_id)
+  # @return [String] Full link of the TagPageContainer.js
+  def get_js_link(tag)
+    response = @agent.get "https://instagram.com/explore/tags/#{tag}"
+    # Parsing the returned page to select the script which has 'TagPageContainer.js' in its src
+    parsed_page = Nokogiri::HTML(response.body)
+    script_array = parsed_page.css('script').select {|script| script.to_s.include?('TagPageContainer.js')}
+    script = script_array.first
+
+    'https://instagram.com' + script['src']
+  end
+
+  # Gets first page JSON string for the tag to extract data
+  # (i.e. media IDs and owner IDs) and creates a PageData
+  # instance.
+  #
+  # @param (see #set_query_id)
+  def get_first_page_data(tag)
+    print_time_stamp
+    puts 'Getting the first page for the tag '.colorize(:blue) + "##{tag}"
+    response = @agent.get "https://www.instagram.com/explore/tags/#{tag}/?__a=1"
+    data = JSON.parse(response.body.sub(/graphql/, 'data'))
+    data.extend Hashie::Extensions::DeepFind
+    @page = PageData.new(data)
+  end
+
+  # Gets next page JSON string for when we liked all the media
+  # on the first page and creates a PageData instance.
+  # This is where we need query_id and
+  # end_cursor string of the current page.
+  #
+  # @param (see #set_query_id)
+  def get_next_page_data(tag)
+    print_time_stamp
+    puts 'Getting the next page for the tag '.colorize(:red) + "#{tag}"
+    next_page_link =  "https://www.instagram.com/graphql/query/?query_hash=#{@query_id}&"\
+                      "variables={\"tag_name\":\"#{tag}\"," \
+                      "\"first\":10,\"after\":\"#{@page.end_cursor}\"}"
+    response = @agent.get next_page_link
+    data = JSON.parse(response.body)
+    data.extend Hashie::Extensions::DeepFind
+    @page = PageData.new(data)
+  end
+
+  # Gets user page JSON string and parses it
+  # to create a UserData instance.
+  #
+  # @param user_id [String] User id of the media owner.
+  def get_user_page_data(user_id)
+    url_user_detail = "https://i.instagram.com/api/v1/users/#{user_id}/info/"
+    begin
+    response = @agent.get url_user_detail
+    rescue Mechanize::ResponseCodeError
+      return false
+    end
+    data = JSON.parse(response.body)
+    data.extend Hashie::Extensions::DeepFind
+    @user = UserData.new(data)
+    true
+  end
+end