ayadn 3.0 → 4.0

data/lib/ayadn/alias.rb

@@ -53,7 +53,7 @@ module Ayadn
     def list
       begin
         init
-        Settings.options[:timeline][:compact] = true if options[:compact] == true
+        Settings.options.timeline.compact = true if options[:compact]
         list = Databases.all_aliases
         unless list.empty? || list.nil?
           if options[:raw]

data/lib/ayadn/annotations.rb

@@ -4,8 +4,12 @@ module Ayadn
 
   class Annotations
 
+    ###
+    # This class contains the "annotations" (metadata) templates for posting to ADN
+
     attr_accessor :content
 
+    # Creates basic annotations and optionally adds necessary ones
     def initialize(dic)
       dic[:options] = {} if dic[:options].nil?
       @content = base()
@@ -13,23 +17,23 @@ module Ayadn
       @content += youtube(dic) if dic[:options][:youtube]
       @content += vimeo(dic) if dic[:options][:vimeo]
       @content += nowplaying(dic) if dic[:options][:nowplaying]
-      @content += movie(dic) if dic[:options][:movie]
-      @content += tvshow(dic) if dic[:options][:tvshow]
     end
 
     def base
+      # Creates basic post metadata
+      # Both types are custom types for Ayadn (all types beginning with "com.ayadn" are custom types)
       [
         {
         "type" => "com.ayadn.user",
         "value" => {
           "+net.app.core.user" => {
-              "user_id" => Settings.config[:identity][:handle],
+              "user_id" => Settings.config.identity.handle,
               "format" => "basic"
             },
             "env" => {
-              "platform" => Settings.config[:platform],
-              "ruby" => Settings.config[:ruby],
-              "locale" => Settings.config[:locale]
+              "platform" => Settings.config.platform,
+              "ruby" => Settings.config.ruby,
+              "locale" => Settings.config.locale
             }
           }
         },
@@ -43,13 +47,14 @@ module Ayadn
               "id" => "69904",
               "email" => "eric@aya.io"
             },
-          "version" => Settings.config[:version]
+          "version" => Settings.config.version
           }
         }
       ]
     end
 
     def files(dic)
+      # Creates "oembed" metadata for uploaded files
       files = FileOps.make_paths(dic[:options][:embed])
       data = FileOps.upload_files(files)
       data.map do |obj|
@@ -67,6 +72,7 @@ module Ayadn
     end
 
     def youtube(dic)
+      # Fetch Youtube metadata for a video
       dic['link'] = dic[:options][:youtube][0]
       req_url = "http://www.youtube.com/oembed?url=#{dic['link']}&format=json"
       resp = CNX.download(req_url)
@@ -84,6 +90,8 @@ module Ayadn
         Errors.global_error({error: e, caller: caller, data: [resp, dic]})
       end
       
+      # Adds Youtube oembed metadata to the existing metadata
+      # Also adds a custom type for Ayadn
       dic.merge!(decoded)
       [{
         "type" => "net.app.core.oembed",
@@ -152,26 +160,6 @@ module Ayadn
       }]
     end
 
-    def movie(dic)
-      [{
-        "type" => "com.ayadn.movie",
-          "value" => {
-            "title" => dic[:title],
-            "source" => dic[:source]
-          }
-      }]
-    end
-
-    def tvshow(dic)
-      [{
-        "type" => "com.ayadn.tvshow",
-          "value" => {
-            "title" => dic[:title],
-            "source" => dic[:source]
-          }
-      }]
-    end
-
     def nowplaying_silent(dic)
       [{
         "type" => "com.ayadn.nowplaying",

data/lib/ayadn/api.rb

@@ -2,14 +2,13 @@
 module Ayadn
   class API
 
-    def initialize
-      @workers = Workers.new
-      @status = Status.new
-    end
-
     def get_unified(options)
+      # "paginate" fetches last post ID we've seen if the user asks for scrolling or asks to see new posts only
       options = paginate options, 'unified'
-      get_parsed_response(Endpoints.new.unified(options))
+      # Create the API endpoint URL
+      endpoint = Endpoints.new.unified(options)
+      # Fetch the response from the ADN servers
+      get_parsed_response(endpoint)
     end
 
     def get_checkins(options)
@@ -111,6 +110,7 @@ module Ayadn
       build_list(username, :followers)
     end
 
+    # "nil" as a first argument? the other method should be refactored
     def get_muted
       build_list(nil, :muted)
     end
@@ -121,14 +121,16 @@ module Ayadn
 
     def get_raw_list(username, target)
       options = {:count => 200, :before_id => nil}
-      big = []
+      bucket = []
+      # Fetch new items until the API says no more
+      # This is chronologically reversed: start with current id, get 200 posts, get the post id we're at, then 200 again, etc
       loop do
         resp = get_parsed_response(get_list_url(username, target, options))
-        big << resp
+        bucket << resp
         break if resp['meta']['min_id'] == nil || resp['meta']['more'] == false
         options = {:count => 200, :before_id => resp['meta']['min_id']}
       end
-      big
+      bucket
     end
 
     def get_user(username)
@@ -150,8 +152,9 @@ module Ayadn
         resp['data'].each { |p| array_of_hashes << p }
       else
         options = {:count => 200, :before_id => nil}
+        endpoints = Endpoints.new
         loop do
-          resp = get_parsed_response(Endpoints.new.files_list(options))
+          resp = get_parsed_response(endpoints.files_list(options))
           resp['data'].each { |p| array_of_hashes << p }
           break unless resp['meta']['more']
           options = {:count => 200, :before_id => resp['meta']['min_id']}
@@ -220,15 +223,6 @@ module Ayadn
     def get_channels
       options = {:count => 200, :recent_message => 1, :annotations => 1, :before_id => nil}
       get_parsed_response(Endpoints.new.channels(options))
-      # big = []
-      # loop do
-      #   resp = get_parsed_response(Endpoints.new.channels(options))
-      #   #check_response_meta_code(resp)
-      #   big << resp
-      #   break if resp['meta']['more'] == false
-      #   options = {:count => 200, :before_id => resp['meta']['min_id']}
-      # end
-      # big
     end
 
     def get_channel channel_id, options = {}
@@ -263,22 +257,33 @@ module Ayadn
     end
 
     def self.build_query(arg)
+      # Number of posts/messages to fetch.
+      # Either from CLI and integer
+      # or from the settings
       if arg[:count].to_s.is_integer?
         count = arg[:count]
       else
-        count = Settings.options[:counts][:default]
+        count = Settings.options.counts.default
       end
-      directed = arg[:directed] || Settings.options[:timeline][:directed]
+      # Do we want the "directed posts"?
+      # Either from CLI (optional)
+      # or from the settings
+      directed = arg[:directed] || Settings.options.timeline.directed
+      # because I was not always consistent in the legacy code base, let's be cautious
       if directed == true || directed == 1
         directed = 1
       else
         directed = 0
       end
+      # We *never* want the HTML in the response, we are a CLI client
       html = 0
+      # If the user asks to see posts starting with a specific post ID
       if arg[:since_id]
         "&count=#{count}&include_html=#{html}&include_directed_posts=#{directed}&include_deleted=0&include_annotations=1&since_id=#{arg[:since_id]}"
+      # Or asks to see their recent messages
       elsif arg[:recent_message]
         "&count=#{count}&include_html=#{html}&include_directed_posts=#{directed}&include_deleted=0&include_annotations=1&include_recent_message=#{arg[:recent_message]}"
+      # Else we create a normal request URL
       else
         "&count=#{count}&include_html=#{html}&include_directed_posts=#{directed}&include_deleted=0&include_annotations=1"
       end
@@ -294,24 +299,28 @@ module Ayadn
     end
 
     def get_parsed_response(url)
+      # Bool for retry if failure
       working = true
       begin
+        # Get the response from the API and decode the JSON
         resp = JSON.parse(CNX.get_response_from(url))
         return resp
       rescue JSON::ParserError => e
-        if working == true
+        # Retry once after 10 seconds if the response wasn't valid
+        status = Status.new
+        if working
           working = false
-          @status.server_error(true)
+          status.server_error(true)
           begin
             sleep 10
           rescue Interrupt
-            @status.canceled
+            status.canceled
             exit
           end
-          puts "\e[H\e[2J"
+          View.new.clear_screen
           retry
         else
-          @status.server_error(false)
+          status.server_error(false)
           Errors.global_error({error: e, caller: caller, data: [resp]})
         end
       end
@@ -326,15 +335,17 @@ module Ayadn
     end
 
     def build_list(username, target)
+      # Fetch data for each user (and verify the user isn't deleted)
       options = {:count => 200, :before_id => nil}
       big_hash = {}
+      workers= Workers.new
       loop do
         resp = get_parsed_response(get_list_url(username, target, options))
         if resp['meta']['code'] == 404
-          @status.user_404(username)
+          Status.new.user_404(username)
           exit
         end
-        users = @workers.extract_users(resp)
+        users = workers.extract_users(resp)
         big_hash.merge!(users)
         break if resp['meta']['min_id'] == nil
         options = {:count => 200, :before_id => resp['meta']['min_id']}

data/lib/ayadn/app.rb

@@ -4,19 +4,32 @@ module Ayadn
     package_name "Ayadn"
 
     begin
-      %w{action api descriptions endpoints cnx view workers settings post status extend databases fileops logs set alias errors blacklist mark nicerank debug check diagnostics}.each { |r| require_relative "#{r}" }
+      %w{action api descriptions endpoints cnx view workers settings post status extend databases fileops logs set alias errors blacklist mark nicerank debug check diagnostics stream_object post_object user_object channel_object preferences_object filtered_post_object}.each { |r| require_relative "#{r}" }
     rescue Interrupt
       puts "\nExit: stopped by user while launching\n\n"
       exit
     end
 
+
     ##
     # These methods are intended to be called from the CLI.
+    # This is managed by the Thor gem.
+    # 
+
 
+    # "desc" (from Thor) describes what the following method does
     desc "timeline", "Show your App.net timeline, aka the Unified Stream (-tl)"
+    # "map" (from Thor) creates an alias for the command
+    # This one is officially "timeline" but also accepts "unified"
     map "unified" => :timeline
+    # "map" (from Thor) is also used to create the command shortcut(s)
     map "-tl" => :timeline
+    # "long_desc" (from Thor) is an optional long description for the method (is displayed in the Help)
     long_desc Descriptions.unified
+    # "option" (from Thor) creates an available option for the command
+    # The option name, a symbol, is automatically stringified by Thor
+    # - "aliases" optionally creates the option shortcut
+    # - "type" is the type of argument the user can pass to the option: a bool, an array, a number, etc (string by default)
     option :scroll, aliases: "-s", type: :boolean, desc: "Scroll the stream"
     option :new, aliases: "-n", type: :boolean, desc: Descriptions.options_new
     option :count, aliases: "-c", type: :numeric, desc: Descriptions.options_count
@@ -25,6 +38,7 @@ module Ayadn
     option :force, aliases: "-f", type: :boolean, desc: Descriptions.options_force
     option :compact, aliases: "-k", type: :boolean, desc: "Force the view to be compact if not already"
     def timeline
+      # "options" (the CLI arguments) is a hash automatically generated by Thor
       Action.new.unified(options)
     end
 
@@ -107,6 +121,8 @@ module Ayadn
     option :raw, aliases: "-x", type: :boolean, desc: Descriptions.options_raw
     option :force, aliases: "-f", type: :boolean, desc: Descriptions.options_force
     option :compact, aliases: "-k", type: :boolean, desc: "Force the view to be compact if not already"
+    # The method parameter is the CLI argument
+    # Here it has a star meaning it will always be an array
     def mentions(*username)
       Action.new.mentions(username, options)
     end
@@ -155,6 +171,7 @@ module Ayadn
     option :compact, aliases: "-k", type: :boolean, desc: "Force the view to be compact if not already"
     option :cache, type: :boolean, desc: "Cache the results"
     option :again, type: :boolean, desc: "Run the last request from cache"
+    # The argument has no star, it will be a string (by default)
     def whoreposted(post_id)
       Action.new.whoreposted(post_id, options)
     end
@@ -468,7 +485,6 @@ module Ayadn
     option :embed, aliases: "-E", type: :array, desc: "Embed one or several pictures in the new post"
     option :youtube, aliases: "-Y", type: :array, desc: "Embed a Youtube video in the new post"
     option :vimeo, aliases: "-V", type: :array, desc: "Embed a Vimeo video in the new post"
-    option :poster, aliases: "-M", type: :array, desc: "Embed a movie poster, from title, in the new post"
     option :compact, aliases: "-k", type: :boolean, desc: "Force the view to be compact if not already (after posting)"
     def post(*args)
       Action.new.post(args, options)
@@ -481,7 +497,6 @@ module Ayadn
     option :embed, aliases: "-E", type: :array, desc: "Embed one or several pictures in the new post"
     option :youtube, aliases: "-Y", type: :array, desc: "Embed a Youtube video in the new post"
     option :vimeo, aliases: "-V", type: :array, desc: "Embed a Vimeo video in the new post"
-    option :poster, aliases: "-M", type: :array, desc: "Embed a movie poster, from title, in the new post"
     option :compact, aliases: "-k", type: :boolean, desc: "Force the view to be compact if not already (after posting)"
     def write
       Action.new.write(options)
@@ -492,7 +507,6 @@ module Ayadn
     option :embed, aliases: "-E", type: :array, desc: "Embed one or several pictures in the new message"
     option :youtube, aliases: "-Y", type: :array, desc: "Embed a Youtube video in the new message"
     option :vimeo, aliases: "-V", type: :array, desc: "Embed a Vimeo video in the new message"
-    option :poster, aliases: "-M", type: :array, desc: "Embed a movie poster, from title, in the new message"
     option :silent, aliases: "-z", type: :boolean, desc: "Do not mark the channel as read"
     option :compact, aliases: "-k", type: :boolean, desc: "Force the view to be compact if not already (after posting)"
     def pm(*username)
@@ -505,7 +519,6 @@ module Ayadn
     option :embed, aliases: "-E", type: :array, desc: "Embed one or several pictures in the new message"
     option :youtube, aliases: "-Y", type: :array, desc: "Embed a Youtube video in the new message"
     option :vimeo, aliases: "-V", type: :array, desc: "Embed a Vimeo video in the new message"
-    option :poster, aliases: "-M", type: :array, desc: "Embed a movie poster, from title, in the new message"
     option :silent, aliases: "-z", type: :boolean, desc: "Do not mark the channel as read"
     option :compact, aliases: "-k", type: :boolean, desc: "Force the view to be compact if not already (after posting)"
     def send_to_channel(channel_id)
@@ -518,7 +531,6 @@ module Ayadn
     option :embed, aliases: "-E", type: :array, desc: "Embed one or several pictures in the new post"
     option :youtube, aliases: "-Y", type: :array, desc: "Embed a Youtube video in the new post"
     option :vimeo, aliases: "-V", type: :array, desc: "Embed a Vimeo video in the new post"
-    option :poster, aliases: "-M", type: :array, desc: "Embed a movie poster, from title, in the new post"
     option :noredirect, aliases: "-n", type: :boolean, desc: "Do not respond to the original post but to the reposted one if possible"
     option :force, aliases: "-f", type: :boolean, desc: Descriptions.options_force
     option :compact, aliases: "-k", type: :boolean, desc: "Force the view to be compact if not already (after posting)"
@@ -535,6 +547,7 @@ module Ayadn
 
     desc "set TYPE PARAM VALUE", "Set/configure a parameter and save it"
     long_desc Descriptions.set
+    # "subcommand" (from Thor) aliases the command to another command in the defined Thor class (here the CLI command "set" is aliased to the "set" command in the "Set" Thor class)
     subcommand "set", Set
 
     desc "alias COMMAND (PARAM)", "Create/delete/list aliases for channels (-A)"
@@ -574,29 +587,6 @@ module Ayadn
       Action.new.nowplaying(options)
     end
 
-    desc "movie TITLE", "Create a post from a movie title (-NW)"
-    map "nowwatching" => :movie
-    map "imdb" => :movie
-    map "-NW" => :movie
-    long_desc Descriptions.nowwatching
-    option :alt, aliases: "-a", type: :boolean, desc: "Select an alternative response if the first didn't match"
-    option :compact, aliases: "-k", type: :boolean, desc: "Force the view to be compact if not already (after posting)"
-    def movie(*title)
-      require_relative("nowwatching")
-      Action.new.nowwatching(title, options)
-    end
-
-    desc "tvshow TITLE", "Create a post from a TV show title (-TV)"
-    map "-TV" => :tvshow
-    long_desc Descriptions.tvshow
-    option :alt, aliases: "-a", type: :boolean, desc: "Select an alternative response if the first didn't match"
-    option :banner, aliases: "-b", type: :boolean, desc: "Inserts the show banner instead of the show poster"
-    option :compact, aliases: "-k", type: :boolean, desc: "Force the view to be compact if not already (after posting)"
-    def tvshow(*title)
-      require_relative("tvshow")
-      Action.new.tvshow(title, options)
-    end
-
     desc "random", "Show random posts from App.net (-rnd)"
     map "-rnd" => :random
     option :wait, aliases: "-w", type: :numeric, desc: "In seconds, time to wait before next page"

data/lib/ayadn/authorize.rb

@@ -3,17 +3,18 @@ module Ayadn
   class Authorize
 
     def initialize
-      @thor = Thor::Shell::Color.new # local statuses
       @status = Status.new # global statuses + utils
       @baseURL = "https://api.app.net" # may be overriden
     end
 
     def authorize(options)
       puts "\n"
+      # /ayadn/accounts.db is the Ayadn 1.x deprecated database
       if File.exist?(Dir.home + "/ayadn/accounts.db")
         @status.deprecated_ayadn
         exit
       end
+      # default config for ADN API
       api_file = Dir.home + "/ayadn/.api.yml"
       # overrides the default value
       if File.exist?(api_file)
@@ -25,12 +26,12 @@ module Ayadn
       end
       puts "\e[H\e[2J"
       show_link
+      # get the auth token from CLI or ask user
       token = if options["token"]
         options["token"][0]
       else
         get_token
       end
-      # token = get_token
       check_token(token)
       puts "\e[H\e[2J"
       @status.say_yellow :connexion, "downloading user info"
@@ -43,32 +44,34 @@ module Ayadn
       @status.say_green :done, "user #{user.handle} is authorized"
       Errors.info "#{user.handle} authorized."
       @status.say { @status.say_green :end, "Thank you for using Ayadn. Enjoy!" }
-      Switch.new.list
+      Switch.new(@status).list
     end
 
     def unauthorize(user, options)
       begin
-        @workers = Workers.new
         if user.size != 1
           @status.one_username
           exit
         end
-        user = @workers.remove_arobase_if_present(user)[0]
+        user = Workers.new.remove_arobase_if_present(user)[0]
         puts "\e[H\e[2J"
+        thor = Thor::Shell::Color.new
         if options[:delete]
-          sure = @thor.yes?("Are you sure you want to unauthorize user @#{user} and delete its folders? [y/N]\n\n> ", :red)
+          sure = thor.yes?("Are you sure you want to unauthorize user @#{user} and delete its folders? [y/N]\n\n> ", :red)
         else
-          sure = @thor.yes?("Are you sure you want to unauthorize user @#{user} ? [y/N]\n\n> ", :red)
+          sure = thor.yes?("Are you sure you want to unauthorize user @#{user} ? [y/N]\n\n> ", :red)
         end
-        unless sure == true
-          Status.new.canceled
+        unless sure
+          @status.canceled
           exit
         end
         puts "\e[H\e[2J"
         @status.say_yellow :delete, "database entry for @#{user}"
-
+        # load the current accounts DB
         db = Amalgalite::Database.new(Dir.home + "/ayadn/accounts.sqlite")
-
+        # remember who we are
+        active_user = Databases.all_accounts(db).select { |acc| acc[4] == 1 }[0][0]
+        # remove this user from DB
         Databases.remove_from_accounts(db, user)
         if options[:delete]
           @status.say_yellow :delete, "@#{user} user folders"
@@ -79,7 +82,13 @@ module Ayadn
         if remaining.flatten.empty?
           @status.say_info "accounts database is now empty"
         else
-          username = remaining[0][0]
+          # are we still here?
+          if !remaining.select { |arr| arr[0] == active_user }.empty?
+            username = active_user
+          else
+            # just to avoid having Ayadn without any user logged in
+            username = remaining[0][0]
+          end
           Databases.set_active_account(db, username)
           @status.say_info "user @#{username} is now the active user"
         end
@@ -88,7 +97,7 @@ module Ayadn
           @status.not_authorized
           exit
       rescue Interrupt
-        Status.new.canceled
+        @status.canceled
         exit
       end
     end