ayadn 1.7.2 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b3446f30e2035384926d37687d0063e8babc1f2
-  data.tar.gz: 3cc304f22b3d4e73b1d80a22ec079959b6032dab
+  metadata.gz: a3fa11aebafb50de81803f096315afad28f111c7
+  data.tar.gz: e5cdfc47373c3cbfb956701320f641d049f279af
 SHA512:
-  metadata.gz: b9cf55b0587c5399cfc8684f54bf7af4ea0e7d45b6a357774e837b4eb3d59834b1ddfb27c9ebc0cd74b74b1735402922879d18df72af97addb3ea5f778216714
-  data.tar.gz: 3c8dc7b8fe631221157c8d36994f205a3504cfc56b0977d7b336d446c72cf71e54b79da311550792a0a0985e7f1f3cab22215800b3b35b7548553dada1002e26
+  metadata.gz: f7e8d412005c5008c75ee4127c31f403bbcef9da09d5b0f51bf69329c5fde654f5e02ca662444b9759e77bddc9186f13222968241b92bbe44e4c2d60821f03a5
+  data.tar.gz: 402269792d12923b31a01f951f29f8fa91d2b94793e407fdbd36eb53dacc0bcaa99c35e9f6cbc23a356d6fad13dae0c6983a04783f9cd90f93d49d9180c79e32

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 1.7.3 (2014-09-08) - 'Scanners'
+
+- New: option to reply to a reposted post
+- New: you can change the users lists order with `set`
+- New: you can change the table width with `set`
+- Docs: the documentation has been fixed and updated
+
 # 1.7.2 (2014-09-04) - 'Fortress'
 
 - Fixed: option to retrieve only specified channels in Channels

data/doc/01-index.md

@@ -1,6 +1,6 @@
 # AYADN
 
-[Ayadn](https://github.com/ericdke/na) is an [App.net](http://app.net) command-line client.
+[App.net](http://app.net) command-line client.
 
 The purpose of Ayadn is to let you use all the features of App.net from the console without any headaches... and then more: power, freedom and fun!
 
@@ -9,20 +9,25 @@ The purpose of Ayadn is to let you use all the features of App.net from the cons
 - reply to users
 - write fast single-line or complex multi-line posts
 - embed pictures in posts
+- embed online video in posts
+- embed movie poster in posts
 - view/scroll the Global stream with spammers filtered out
 - view/scroll posts from specific users or posts mentioning a user
 - follow/unfollow users, star/repost/mute/block/unstar/etc 
-- create/manage silent bookmarks for conversations
+- create local bookmarks for conversations
 - get information about users and their followers/followings
 - search for words, hashtags, post annotations, channels, etc
 - extract links from conversations, streams, posts, etc
 - list and download your files
 - view (and write to) all your channels including Broadcasts, Patter, Ohai, etc
-- #nowplaying from iTunes or Last.fm, with album art and store link
+- 'nowplaying' from iTunes or Last.fm, with album art and store link
+- 'movie' creates a post from a movie title with poster, plot, and link
+- 'tvshow' creates a post from a TV show title with poster, plot, and link
 - view/send private messages
 - view geolocation data in streams
-- create/manage silent black lists of users, mentions or hashtags
-- create/manage aliases for easier use of channels ids
+- create silent black lists of users, mentions or hashtags
+- create aliases for easier use of channels ids
+- update your user profile
 - export links and text from a post to Pinboard
 - option to export almost any stream or object in JSON
 - options: set the number of posts by request, show only new posts, etc

data/doc/02-install.md

@@ -14,9 +14,9 @@ Uninstall:
 
 ## OS X, LINUX, BSD
 
-Please use something like RVM or RBENV to install Ruby if necessary.
+If you need to install Ruby it's better to use something like RVM or RBENV.
 
-You can also use the Ruby shipped with your system but it will require root privileges.
+You can of course use the Ruby shipped with your system but it will require root privileges and is not recommended.
 
 ## WINDOWS
 

data/doc/03-first-steps.md

@@ -105,7 +105,7 @@ And for the subcommands:
 
 ## SHORTCUTS
 
-Most examples will include the 'complete' command followed by the 'shortcut' command. 
+Most examples in the documentation include the 'complete' command followed by the 'shortcut' command. 
 
 Of course, using Ayadn is much faster with the shortcut commands.
 
@@ -156,6 +156,6 @@ Shortcuts:
 
 `ayadn -co 23362788`
 
-`ayadn -se movies hollywood`
+`ayadn -s movies hollywood`
 
 `ayadn -FO @ericd` 

data/doc/04-options.md

@@ -2,12 +2,14 @@
 
 Note: options are only described once in this manual (in the first example for 'Streams', 'Timeline'). 
 
-However, options are available for mosts of streams! 
+**However, options are available for mosts of streams!** 
 
 They're described only once *for readability purposes*.
 
-You can check if a command has specific options with 
+You can always check if a command has specific options with 
 
 `ayadn help COMMAND`  
 
+or, for subcommands:
 
+`ayadn COMMAND help SUBCOMMAND`

data/doc/05-streams.md

@@ -19,17 +19,21 @@ Scroll your timeline with:
 
 `ayadn -tl -s`
 
-Note: Ayadn pulls the stream every 3 seconds by default. 
+#### SCROLL
 
-It means you can launch up to 3 scroll streams at a time _per account_. 
+A note about `--scroll`. 
 
-You can bring that value down to 1 second if you're using only _one_ scroll stream per account at a time, 2 seconds if you're using _two_ scroll streams, and so on and so forth.
+**Ayadn pulls the stream every 3 seconds by default.**
 
-If Ayadn ends up making too many requests to ADN, it will display an alert message with instructions then stop running.
+It means you can launch up to 3 scroll streams at a time _per account_ if you want. 
 
-So if you plan on launching many Ayadn scrolling instances at once, you should *set* the timer parameter accordingly (App.net accepts 5000 requests per hour per account maximum).
+To launch even more streams at the same time, increment the timer by one second for each stream. 
 
-Note: you can show an animated spinner while waiting for new posts, see the "SET" chapter.  
+Example: to launch 10 streams, set the timer to 12 seconds *before launching the streams* with `ayadn set scroll timer 12`.
+
+On the contrary, you can bring that value down to 1 second if you're using only _one_ scroll stream per account at a time.
+
+App.net accepts 5000 requests per hour per account maximum. If Ayadn ends up making too many requests to ADN, it will display an alert message with instructions, then it will exit.
 
 ### COUNT
 
@@ -73,7 +77,7 @@ Displays only the new posts in the stream since your last visit.
 
 ### RAW
 
-Displays the raw response from the App.net API instead of the formatted Ayadn output. For debugging and learning purposes.  
+Displays the raw response from the App.net API instead of the formatted Ayadn output.  
 
 `ayadn timeline --raw`
 
@@ -276,13 +280,11 @@ Search for App.net channels by searching WORD(S) in their description.
 
 If the channel (let's say 24573) is public, you can read its messages with `ayadn -ms 24573` or `ayadn -ms my_alias`.
 
-# RANDOM
+## Search ADN annotations
 
-Show series of random posts from App.net. Just for fun :)
+For the developers -or the adventurous-, there's a command to search for annotations types.
 
-`ayadn random`
-
-`ayadn -rnd`  
+`ayadn search --annotations net.app.ohai.location`
 
 # USER INFO
 
@@ -303,3 +305,11 @@ Show informations about a post.
 `ayadn postinfo 23362788`
 
 `ayadn -pi 23362788` 
+
+# RANDOM
+
+Show series of random posts from ADN. Just for fun :)
+
+`ayadn random`
+
+`ayadn -rnd`  

data/doc/06-post.md

@@ -6,13 +6,13 @@ Simple and fast way to post a short sentence/word to App.net.
 
 `ayadn -P Hello from Ayadn`
 
-`ayadn -P @ericd hello Eric`
+`ayadn -P @ericd Hello Eric`
 
 You have to put your text between single quotes if you're using punctuation:
 
 `ayadn -P 'Hello from Ayadn, guys!'`
 
-But remember you can't then use any `'` character!
+*But remember you can't use any quote character inside the quotes...*
 
 **So you should rather use either the _write_ or the _auto_ method for posting.**
 
@@ -20,7 +20,7 @@ But remember you can't then use any `'` character!
 
 Multi-line post to App.net.
 
-This is the recommended way to post elaborate text to ADN:
+*This is the recommended way to post elaborate text to ADN:*
 
 `ayadn write`
 
@@ -28,7 +28,9 @@ This is the recommended way to post elaborate text to ADN:
 
 It will show you a prompt where you can type anything, including special characters and Markdown links.
 
-Hit ENTER to create line breaks and paragraphs.
+Hit ENTER to create line breaks. 
+
+Hit ENTER, SPACE, ENTER to create paragraphs compatible with all clients.
 
 Cancel your post with CTRC-C or send it with CTRL-D.
 
@@ -66,6 +68,15 @@ If you reply to a post containing multiple mentions, your text will be inserted
 
 `ayadn -R 3`  
 
+If you reply to a reposted post, Ayadn will reply to the original post, complying with the ADN guidelines.
+
+However, if needed, you can reply to the reposted post with the `--noredirect` option:
+
+`ayadn -R --noredirect 23344556`
+
+`ayadn -R -n 23344556`  
+
+
 # PM (PRIVATE MESSAGE)
 
 Send a private message to a specific user.
@@ -102,7 +113,7 @@ Examples:
 
 ```
 ayadn -P Meet my cat -E lolcat.jpg
-ayadn -P "@ericd Hey, meet my pets" -E ~/lolcat.jpg ./doge.jpeg
+ayadn -P "@ericd Hey, meet my pets" -E ~/lolcat.jpg ~/doge.jpeg
 ayadn -W -E ~/lolcat.png
 ayadn -R 23362460 -E "Desktop/dancing lolcat.gif"
 ayadn pm @ericd -E /users/dad/lol\'cat.JPG /users/mom/my\ doge.PNG
@@ -132,7 +143,7 @@ You can embed a movie poster in a normal post with option `-M`.
 
 This is compatible with other options, eg embedding other images.
 
-Warning: contrary to the `movie` command, this option doesn't check with the user if the movie is valid. The poster is retrieved from IMDb and is automatically embedded in the post.
+*Warning: contrary to the `movie` command, this option doesn't check with the user if the movie is valid. The poster is retrieved from IMDb and is automatically embedded in the post.*
 
 Examples:
 
@@ -141,4 +152,3 @@ ayadn -P "I'll be back" -M terminator
 ayadn -W -M truman show -E ~/Pics/my_face.jpg
 ayadn -R 23362460 -M the dark knight
 ```  
-

data/doc/07-actions.md

@@ -6,9 +6,9 @@ Delete a post.
 
 `ayadn -D 23365251`
 
-# DELETE MESSAGE
+# DELETE_M
 
-Delete a message. 
+Delete a private message. 
 
 You have to specify channel id (or alias) then message number.
 
@@ -108,44 +108,44 @@ Download a file from your App.net storage (any file posted with other ADN client
 
 # PIN
 
-Export a post's link and text, with tags, to your Pinboard account.
+Export a post's url, text and link(s) to your Pinboard account and add optional tags.
 
-`ayadn pin 22790201 Ayadn gem update`
+`ayadn pin 22790201 Ayadn Ruby dev`
 
-`ayadn pin 26874913 duel swords france`
+`ayadn pin 26874913 duel swords france history`
 
 # UPDATE
 
-Update your user profile.
-
-Use option `--delete` or `-D` to delete the field.
+- Update your user profile
 
 `ayadn --update --bio`
 
 `ayadn -U --bio`
 
-`ayadn --update --bio --delete`
-
-`ayadn -U --bio -D`
-
 `ayadn -U --name`
 
 `ayadn -U --twitter`
 
-`ayadn -U --twitter -D`
-
 `ayadn -U --blog`
 
-`ayadn -U --blog -D`
-
 `ayadn -U --web`
 
-`ayadn -U --web -D`
-
 `ayadn -U --avatar ~/Pics/myface.jpg`
 
-Avatar: the uploaded image will be cropped to square and must be smaller than 1 MB. The optimal size is 200×200 pixels.
+*Avatar: the uploaded image will be cropped to square and must be smaller than 1 MB. The optimal size is 200×200 pixels.*
 
 `ayadn -U --cover ~/Pics/mycats.jpg`
 
-Cover: the uploaded image must be at least 960 pixels wide and less than 4 MB in size.
+*Cover: the uploaded image must be at least 960 pixels wide and less than 4 MB in size.*
+
+- Use option `--delete` or `-D` to delete the field
+
+`ayadn --update --bio --delete`
+
+`ayadn -U --bio -D`
+
+`ayadn -U --twitter -D`
+
+`ayadn -U --blog -D`
+
+`ayadn -U --web -D`

data/doc/08-listings.md

@@ -24,13 +24,13 @@ You can see your own list by using *me* instead of *@username*:
 
 # CHANNELS
 
-List your active App.net channels.
+List all your active App.net channels.
 
 `ayadn channels`
 
 `ayadn -ch`
 
-Retrieve only specified channel(s) with option `--id`:
+Retrieve a unique channel, or specific channel(s), with option `--id`:
 
 `ayadn -ch --id 55123`
 
@@ -95,3 +95,21 @@ List them all:
 `ayadn files -a`
 
 `ayadn -fl -a`
+
+## OPTIONS
+
+### LIST
+
+You can reverse the default lists order with a `set` command:
+
+`ayadn set formats list reverse false`
+
+(defaults to true since Ayadn version 1.7.3)
+
+### TABLE
+
+You can change the width of the lists table if the default size doesn't fit well in your terminal:
+
+`ayadn set formats table width 80`
+
+(min: 60, max: 90, default: 75)

data/doc/09-accounts.md

@@ -18,13 +18,13 @@ Switch between your authorized accounts.
 
 `ayadn switch @ericd`
 
-`ayadn switch @otheraccount`
+`ayadn switch @mysecretaccount`
 
 Alternative syntax:
 
 `ayadn -@ ericd`
 
-`ayadn -@ otheraccount`
+`ayadn -@ mysecretaccount`
 
 List your authorized accounts:
 

data/doc/10-nicerank.md

@@ -22,7 +22,7 @@ An idea of the scale:
 
 - A user posting a lot of automated links without being active otherwise will be < 2
 
-- A new ADN user will typically start with 2
+- A new ADN user will typically start with 2.1
 
 - A regular user will always be > 2
 
@@ -32,27 +32,24 @@ An idea of the scale:
 
 *Again, this is not a popularity ratio: far from it. It only serves as a filter for bots and spam.*
 
+## Threshold
 
-## Activate NiceRank
-
-NiceRank is disabled by default.
-
-Enable it with:
+Set the NiceRank threshold.
 
-`ayadn set nicerank filter true`
+You can use an integer or a float (only one decimal).
 
-My advice is to also filter out the few users that NiceRank haven't analyzed yet, as most of them are bots:
+Any user with a NiceRank smaller than this value will be ignored.
 
-`ayadn set nicerank filter_unranked true`
+`ayadn set nicerank threshold 2.5`
 
-## Threshold
+`ayadn set nicerank threshold 3`
 
-Set the NiceRank threshold.
+(default: 2.1)
 
-Any user with a NiceRank smaller than this value will be ignored.
+## Desactivate NiceRank
 
-`ayadn set nicerank threshold 2`  
+NiceRank is enabled by default on new Ayadn installations, but can be disabled if needed:
 
-## Deactivate NiceRank
+`ayadn set nicerank filter false`
 
-It's the same as above, with *false* instead of *true*.  
+`ayadn set nicerank filter_unranked false`

data/doc/11-blacklist.md

@@ -20,11 +20,15 @@ Oh, and you can import blacklist databases from other accounts, too.
 
 Adds an item to your blacklist.
 
-Available items: client, hashtag, mention.
+Available items: client, hashtag, user, mention.
 
 `ayadn blacklist add mention @shmuck`
 
-Add a mention:
+Add a user:
+
+`ayadn -K add user @shmuck`
+
+Add a mention of a user:
 
 `ayadn -K add mention @shmuck`
 
@@ -40,10 +44,14 @@ Add a hashtag:
 
 Removes an item from your blacklist.
 
-Available items: client, hashtag, mention.
+Available items: client, hashtag, user, mention.
 
 `ayadn blacklist remove mention @shmuck`
 
+Remove a user:
+
+`ayadn -K remove user @shmuck`
+
 Remove a mention:
 
 `ayadn -K remove mention @shmuck`
@@ -78,6 +86,8 @@ You can add/remove several elements to/from the blacklist at once.
 
 (For usernames, '@' prefix will automatically be added if missing.)  
 
+`ayadn -K add user shmuck jerk mrspammer`
+
 `ayadn -K add mention shmuck jerk mrspammer`
 
 `ayadn -K add client ifttt pourover twitterfeed`

data/doc/13-bookmark.md

@@ -6,7 +6,7 @@ Usage:
 
 `ayadn mark add 30594331`
 
-`ayadn mark add 30594331 'convo title'`
+`ayadn mark add 30594331 convo title`
 
 `ayadn mark list`
 
@@ -22,7 +22,9 @@ Usage:
 
 `ayadn mark add 30594331`
 
-`ayadn mark add 30594331 'convo title'`
+`ayadn mark add 30594331 talking about stuff`
+
+`ayadn mark add 30594331 'This convo about x, y and z is cool!'`
 
 You don't have to specify the root post of the conversation, any post within the thread will work.
 

data/doc/14-set.md

@@ -10,6 +10,8 @@ You can get a list of configurable parameters with
 
 ## EXAMPLES
 
+These are just a few examples.  
+
 `ayadn set color username green`
 
 `ayadn set color mentions yellow`
@@ -28,9 +30,11 @@ You can get a list of configurable parameters with
 
 `ayadn set scroll timer 5`
 
-`ayadn set nicerank filter true`
+`ayadn set formats table width 80`
+
+`ayadn set formats list reverse false`
 
-`ayadn set timeline show_spinner true`
+## RESET
 
 To reset the configuration to default values:
 
@@ -38,7 +42,7 @@ To reset the configuration to default values:
 
 ## LIST
 
-Example list of configured items in Ayadn.
+*Example* list of configured items in Ayadn.
 
 `ayadn -sg` will show your own list.
 

data/doc/15-nowplaying.md

@@ -20,4 +20,6 @@ It will also grab a 30 seconds preview and the album art from the iTunes Store.
 
 `ayadn -np -l`
 
-Same behaviour and options as above.
+Ayadn will grab information from your Last.fm account, format it, insert the *#nowplaying* hashtag then ask for your confirmation before posting it.
+
+It will also grab a 30 seconds preview and the album art from the iTunes Store. You can prevent this behavior by adding the `--no-url` option (short: `-n`).

data/doc/16-movie.md

@@ -1,6 +1,8 @@
 # MOVIE (nowwatching)
 
-Create a post from (part of) a movie title. Includes movie poster, IMDb url and hashtag.
+Create a post from (part of) a movie title. 
+
+Includes movie poster, IMDb url and hashtag.
 
 Usage:
 
@@ -26,21 +28,12 @@ This is useful for remakes:
 
 (gives the 1972 version)
 
-## ALIASES
-
-`ayadn nowwatching godfather II`
-
-`ayadn imdb -a conan`
-
 ## HASHTAG
 
-You can modify the hashtag with 'set':
+You can modify the default hashtag with 'set':
 
 `ayadn set movie hashtag movietime`
 
 `ayadn set movie hashtag adnmovieclub`
 
 (default is 'nowwatching')
-
-
-

data/doc/17-tvshow.md

@@ -1,6 +1,8 @@
 # TVSHOW (nowwatching)
 
-Create a post from (part of) a TV show title. Includes show poster, IMDb url and hashtag.
+Create a post from (part of) a TV show title. 
+
+Includes show poster, IMDb url and hashtag.
 
 Usage:
 

data/doc/18-contact.md

@@ -10,6 +10,10 @@
 
 ## THANK YOU
 
+This is a list of the first people who helped me when I started developing Ayadn.
+
+I can't keep up and update the list, of course, there's too many of you awesome geeks. ;)
+
 [@matigo](http://app.net/matigo)
 [@ksniod](http://app.net/ksniod)
 [@donnywdavis](http://app.net/donnywdavis)
@@ -27,3 +31,5 @@
 [@jextxadore](http://app.net/jextxadore)
 [@jvimedia](http://app.net/jvimedia)
 [@fredvd](http://app.net/fredvd)
+
+See also the Ayadn CHANGELOG file...

data/doc/19-examples.md

@@ -38,6 +38,6 @@ Shortcuts:
 
 `ayadn -co 23362788`
 
-`ayadn -se movies hollywood`
+`ayadn -s movies hollywood`
 
 `ayadn -FO @ericd` 

data/lib/ayadn/action.rb

@@ -556,7 +556,9 @@ module Ayadn
       	puts Status.replying_to(post_id)
       	replied_to = @api.get_details(post_id)
         Check.no_post(replied_to, post_id)
-        post_id = @workers.get_original_id(post_id, replied_to)
+        unless options[:noredirect]
+          post_id = @workers.get_original_id(post_id, replied_to)
+        end
         if replied_to['data']['repost_of']
           if post_id == replied_to['data']['repost_of']['id']
             replied_to = @api.get_details(post_id)

data/lib/ayadn/app.rb

@@ -423,6 +423,7 @@ module Ayadn
     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"
     def reply(id)
       ayadn = Action.new
       ayadn.reply(id, options)

data/lib/ayadn/cnx.rb

@@ -66,6 +66,9 @@ module Ayadn
         end
         puts "\nConnection error.".color(:red)
         Errors.global_error({error: e, caller: caller, data: [url]})
+      rescue URI::InvalidURIError => e
+        puts "\nConnection or authorization error.".color(:red)
+        Errors.global_error({error: e, caller: caller, data: [url]})
       rescue => e
         Errors.global_error({error: e, caller: caller, data: [url]})
       end

data/lib/ayadn/errors.rb

@@ -3,6 +3,7 @@ module Ayadn
   class Errors
 
     def self.global_error(args)
+      abort(Status.wtf) if Logs.nil?
       Logs.rec.error "--BEGIN--"
       Logs.rec.error "CAUSE: #{args[:error]}"
       Logs.rec.debug "DATA: #{args[:data]}"