ayadn 1.4.6 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d24e69e9bb60c49085dbb5a2301b2da8b9789f7
-  data.tar.gz: 39c9219947d43fdb3bf16bf4643fa8a8141a456c
+  metadata.gz: 6f4900ba881aee8b2b3ce277facfb6e86f7972b7
+  data.tar.gz: 4a52cad511fce5df653f55b54f4684d9e85071d8
 SHA512:
-  metadata.gz: bc082c53a74daff0a800cfb9fcd2f663730e9f35b7e96bd3fe80a35a4353914060cdcd1e3e7f965608942c9e0ba2f5eddbf9852295eeede5ff46bc9f4cbb9e37
-  data.tar.gz: 3a7fa5aa5494de09e95aa43b67c0fd9a5ee720285095fed3be53533111905bf195edf1ea0e9638c46951694a5125d941f37dc4c908c31ca54c7265ac5a993a8e
+  metadata.gz: 782007aa8e67ef39f173ac53ddd3d65c5ab2b3bca03b5b7dc9978da8a3ced9fa09f1865ae4bd20a15e0c553379a58c91cb3fc79dd1abb9bc24af4eb7bea3e795
+  data.tar.gz: 397da912926f39f5ebfeb238ee2e3b920eabf8706b0bb86353a88e3c3dd15e6173d073654a2943fd5ca63b3036111e7b42417cf4323dfa19be9e9b43e6554350

data/.gitignore

@@ -8,7 +8,6 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
 lib/bundler/man
 pkg
 rdoc

data/CHANGELOG.md

@@ -1,4 +1,17 @@
-# 1.4.6 - 'Filepaths'
+# 1.5.0 - 'Nozomi'
+
+- In 'convo', both the post id you've requested and the post it replies to are marked with arrows
+- Same feature in the view after a reply
+- Follow/unfollow/etc several users at a time
+- Much faster users lists generation (followers, muted, etc)
+- Users lists include number of posts/day
+- User info (-ui) includes number of posts/day
+- Added NowPlaying annotations
+- Documentation is included in the repo
+- Skipped objects are logged if debug is enabled
+- Force delete obsolete config keys / force create mandatory ones (less checks in the code, more stability)
+
+# 1.4.6 - 'Roman'
 
 - Temporary fix for filepaths instability when uploading pictures
 

data/README.md

@@ -7,19 +7,40 @@ AYADN
 
 [App.net](http://app.net) command-line client.
 
-The purpose of Ayadn is to give you access to all the features of App.net from the console.
-
-View or scroll all streams in your Terminal, view or scroll conversations and posts from specific users or mentioning a user, follow/unfollow users, star/unstar/repost/etc, get information about users and their followers/followings, search for words or hashtags, list and download your files, view all your channels including Broadcasts and Patter rooms, write single-line or multi-line posts, send private messages, view geolocation data, etc.
-
-This CLI has more than 50 features awaiting for your Geekiness to command them.
-
-Ayadn is configurable: colors, timelines, durations, aliases, etc. 
-
-You can also specify many options, like show the raw JSON instead of the formatted response, show only a number of most recents posts, show only new posts, etc.
-
-There's also two exclusive antispam and filtering features: a blacklist, and Jason Irwin's NiceRank.
-
-Last but not least: Ayadn supports multiple ADN accounts! Authorize as many accounts as you wish and simply switch between them with a keystroke.  
+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!
+
+- view/scroll all streams 
+- view/scroll conversations
+- reply to users
+- write fast single-line or complex multi-line posts
+- embed pictures 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
+- 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
+- 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
+- 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
+- (see the docs for all the features)
+
+
+Ayadn is configurable: colors, stream content, durations, aliases, etc. 
+
+There's also two exclusive antispam and filtering features: a blacklist of users/mentions/hashtags, and Jason Irwin's NiceRank to kick out spammers and bots from Global, with a customisable threshold.
+
+Last but not least: Ayadn supports multiple ADN accounts! 
+
+Authorize as many accounts as you wish, and simply switch between them in a second. 
 
 
 ## INSTALL
@@ -49,3 +70,7 @@ App account: [@ayadn](http://app.net/ayadn)
 Website: [ayadn-app.net](http://ayadn-app.net)
 
 ADN Directory: [Ayadn](https://directory.app.net/app/345/ayadn/)
+
+# FEEDBACK
+
+Feedback and/or contributions are very welcomed!

data/ayadn.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Ayadn::VERSION
   spec.author        = "Eric Dejonckheere"
   spec.email         = "eric@aya.io"
-  spec.summary       = %q{App.net command-line client. See http://ayadn-app.net/doc/}
-  spec.description   = %q{App.net command-line client: toolbox to access and manage your ADN data, show your streams, post, manage conversations, star/follow/repost... and many, many more. http://ayadn-app.net/doc/}
+  spec.summary       = %q{App.net command-line client.}
+  spec.description   = %q{App.net command-line client: toolbox to access and manage your ADN data, show your streams, post, manage conversations, star/follow/repost... and many, many more.}
   spec.homepage      = "http://ayadn-app.net"
   spec.license       = "MIT"
   spec.metadata      = { "documentation" => "http://ayadn-app.net/doc/" }

data/doc/01-index.md

@@ -0,0 +1,38 @@
+# AYADN
+
+[Ayadn](https://github.com/ericdke/na) is an [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!
+
+- view/scroll all streams 
+- view/scroll conversations
+- reply to users
+- write fast single-line or complex multi-line posts
+- embed pictures 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
+- 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
+- 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
+- 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
+- (see the docs for all the features)
+
+
+Ayadn is configurable: colors, stream content, durations, aliases, etc. 
+
+There's also two exclusive antispam and filtering features: a blacklist of users/mentions/hashtags, and Jason Irwin's NiceRank to kick out spammers and bots from Global, with a customisable threshold.
+
+Last but not least: Ayadn supports multiple ADN accounts! 
+
+Authorize as many accounts as you wish, and simply switch between them in a second. 

data/doc/02-install.md

@@ -0,0 +1,24 @@
+# INSTALL
+
+Install:
+
+`gem install ayadn`  
+
+Update:
+
+`gem update ayadn`  
+
+Uninstall:
+
+`gem uninstall ayadn`  
+
+## OS X, LINUX, BSD
+
+Please use something like RVM or RBENV to install Ruby if necessary.
+
+You can also use the Ruby shipped with your system but it will require root privileges.
+
+## WINDOWS
+
+Ayadn 1.0.x isn't compatible with Windows: there's too many issues due to external Gems and POSIX-dependant tools.  
+

data/doc/03-first-steps.md

@@ -0,0 +1,161 @@
+# FIRST STEPS
+
+## AUTHORIZE
+
+You have to give Ayadn the authorization to use your App.net account. 
+
+Just run 
+
+`ayadn authorize` 
+
+or 
+
+`ayadn -auth` 
+
+to register a new user.  
+
+## ACCOUNTS
+
+Ayadn supports multiple accounts.
+
+Register a new user with 
+
+`ayadn -auth` 
+
+at any moment.
+
+You can then switch between accounts:
+
+`ayadn switch @ericd` 
+
+or 
+
+`ayadn -@ ericd`  
+
+## DATA
+
+All Ayadn files and folders are created in your 'home' folder. 
+
+On Mac OS X, it looks like this:
+
+```
+  /Users/ericdke/ayadn/
+  ├── accounts.db
+  /Users/ericdke/ayadn/ericd
+  ├── auth
+  │   └── token
+  ├── backup
+  ├── config
+  │   ├── api.json
+  │   ├── config.yml
+  │   └── version.yml
+  ├── db
+  │   ├── aliases.db
+  │   ├── blacklist.db
+  │   └── users.db
+  ├── downloads
+  ├── lists
+  ├── log
+  │   └── ayadn.log
+  ├── messages
+  ├── pagination
+  │   ├── index.db
+  │   └── pagination.db
+  └── posts
+```
+
+Each authorized account has its set of folders and databases.
+
+This is also the repository of the configuration file: 
+
+`config.yml`
+
+Although there's the `set` command in Ayadn to configure most parameters, you can of course edit the file manually.
+
+If you're not sure if your config file is up to date or properly filled and you want to benefit from the new options in Ayadn, run 
+
+`ayadn set defaults` 
+
+and it will create a brand new file with optimal values.  
+
+## HELP
+
+`ayadn` 
+
+shows a list of available commands.  
+
+`ayadn help COMMAND` 
+
+shows the instructions and available options for a specific command. 
+
+Examples:  
+
+`ayadn help post`  
+
+`ayadn help timeline`  
+
+`ayadn help blacklist`  
+
+And for the subcommands:
+
+`ayadn blacklist help import`
+
+`ayadn alias help create`  
+
+
+## SHORTCUTS
+
+Most examples will include the 'complete' command followed by the 'shortcut' command. 
+
+Of course, using Ayadn is much faster with the shortcut commands.
+
+If you're like me, you'll even want to create aliases in bash/zsh or TextExpander snippets for the combinations of Ayadn commands and options you use the most...  
+
+
+## EXAMPLES
+
+Just a few examples to give you a hint at the flexible syntax.
+
+Complete:    
+
+`ayadn timeline`
+
+`ayadn checkins --count=10 --index`
+
+`ayadn global --scroll`
+
+`ayadn userposts @ericd`
+
+`ayadn post 'Hello guys!'`
+
+`ayadn write`
+
+`ayadn reply 23362460`
+
+`ayadn convo 23362788`
+
+`ayadn search movies hollywood`
+
+`ayadn follow @ericd`  
+
+Shortcuts:  
+
+`ayadn -tl`
+
+`ayadn -ck -c10 -i`
+
+`ayadn -gl -s`
+
+`ayadn -up @ericd`
+
+`ayadn -P 'Hello guys!'`
+
+`ayadn -W`
+
+`ayadn -R 23362460`
+
+`ayadn -co 23362788`
+
+`ayadn -se movies hollywood`
+
+`ayadn -FO @ericd` 

data/doc/04-options.md

@@ -0,0 +1,13 @@
+# OPTIONS
+
+Note: options are only described once in this manual (in the first example for 'Streams', 'Timeline'). 
+
+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 
+
+`ayadn help COMMAND`  
+
+

data/doc/05-streams.md

@@ -0,0 +1,288 @@
+# TIMELINE
+
+Display your main timeline.
+
+This is also called the 'Unified stream': it regroups the posts of people you follow and the posts mentioning you.
+
+`ayadn timeline`
+
+`ayadn -tl`
+
+
+## AVAILABLE OPTIONS
+
+### SCROLL
+
+Scroll your timeline with:
+
+`ayadn timeline --scroll`
+
+`ayadn -tl -s`
+
+Note: Ayadn pulls the stream every 3 seconds by default. 
+
+It means you can launch up to 3 scroll streams at a time _per account_. 
+
+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.
+
+If Ayadn ends up making too many requests to ADN, it will display an alert message with instructions then stop running.
+
+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).
+
+Note: you can show an animated spinner while waiting for new posts, see the "SET" chapter.  
+
+### COUNT
+
+Ayadn displays a certain number of posts by default when you request a stream.
+
+With the *count* option, you can set a specific value for each request:
+
+`ayadn timeline --count=10`
+
+`ayadn -tl -c10`
+
+The maximum value is 200 for any stream.
+
+### INDEX
+
+Shows an index instead of the posts ids.
+
+`ayadn timeline --index`
+
+`ayadn -tl -i`  
+
+This is particularly useful if you're using Ayadn to *reply* to conversations.
+
+Copy/pasting the post id can be tedious at times, and anyway it's faster to glance at a short number and use it immediately.
+
+Example:
+
+`ayadn -tl -i`
+
+`ayadn -R 33`
+
+if 33 is the number of the indexed post you want to reply to.  
+
+### NEW
+
+Displays only the new posts in the stream since your last visit.
+
+`ayadn timeline --new`
+
+`ayadn -tl -n`
+
+### RAW
+
+Displays the raw response from the App.net API instead of the formatted Ayadn output. For debugging and learning purposes.  
+
+`ayadn timeline --raw`
+
+`ayadn -tl -x`
+
+### EXTRACT
+
+Extracts all links from posts.
+
+`ayadn hashtag --extract instagram`
+
+`ayadn -t -e instagram`
+
+`ayadn search --extract ruby gem`  
+
+`ayadn -s -e ruby gem`  
+
+`ayadn whatstarred @ericd -e`
+
+`ayadn -was -e ericd`
+
+# GLOBAL
+
+Display the 'Global stream'.
+
+`ayadn global`
+
+`ayadn -gl`
+
+Although the 'Global stream' is nowadays infested with spammers, it remains a fantastic source to find new people to interact with.
+
+Ayadn helps you in that task with two tools:
+
+- the *blacklist* command, which allows you to mute posters per client name, hashtag or mention, obliterating the unwanted posts
+
+- the *NiceRank* filter, which allows you to filter spammers out
+
+
+# CHECKINS
+
+Display the 'Checkins stream'.
+
+Ayadn will show any available geolocation data for these posts.
+
+`ayadn checkins`
+
+`ayadn -ck`
+
+# CONVERSATIONS
+
+Display the 'Conversations stream'.
+
+This is a stream of posts that lead to *conversations* with real people.
+
+`ayadn conversations`
+
+`ayadn -cq`
+
+# TRENDING
+
+Display the 'Trending stream'.
+
+This is a stream of trending posts.
+
+`ayadn trending`
+
+`ayadn -tr`
+
+# PHOTOS
+
+Display the 'Photos stream'.
+
+This is a stream of posts including a picture.
+
+`ayadn photos`
+
+`ayadn -ph`  
+
+# MENTIONS
+
+Display posts containing a mention of @username.
+
+`ayadn mentions @ericd`
+
+`ayadn -m @ericd`  
+
+You can get your own mentions stream by using *me* instead of *@username*:
+
+`ayadn -m me`
+
+Don't forget that like most streams, Mentions is *scrollable*: very convenient to know at a glance if we got something new from our friends!
+
+# POSTS
+
+Show the posts of a specific user.
+
+`ayadn userposts @ericd`
+
+`ayadn -up @ericd`
+
+You can get your own posts by using *me* instead of *@username*:
+
+`ayadn -up me`
+
+# MESSAGES
+
+Show messages in a *channel*.
+
+`ayadn messages 46217`
+
+`ayadn -ms 46217`
+
+You can replace the channel id with its alias if you previously defined one:
+
+`ayadn -ms mychannelalias`  
+
+# WHATSTARRED
+
+Show posts starred by a specific user.
+
+`ayadn whatstarred @ericd`
+
+`ayadn -was @ericd`
+
+You can get your own stars by using *me* instead of *@username*:
+
+`ayadn -was me`
+
+# CONVO
+
+Show the conversation thread around a specific post.
+
+`ayadn convo 23362788`
+
+`ayadn -co 23362788`
+
+# HASHTAG
+
+Show recent posts containing #HASHTAG(s).
+
+`ayadn hashtag nowplaying`
+
+`ayadn -t nowplaying`
+
+`ayadn -t nowplaying rock`
+
+# SEARCH
+
+Show recents posts containing WORD(s).
+
+`ayadn search ruby`
+
+`ayadn search ruby json api`
+
+## Search in messages, including PMs
+
+You can now search for WORD(S) in the messages of a channel, for example all PMs between you and @username.
+
+You have to specify a channel id (or an alias).
+
+```
+ayadn search --messages 24573 'meet me at'
+ayadn search --messages my_alias 'meet me at'
+```
+
+If you don't know what are your subscribed channels ids, discover them with `ayadn -ch`, then you can also set aliases with `ayadn -A create 24573 my_alias` to remember the names easily.
+
+## Look for users
+
+Look for App.net users by searching WORD(S) in their bio/description.
+
+`ayadn search --users coffee food`
+
+Returns a detailed view of each user's profile and informations.
+
+## Discover channels
+
+Search for App.net channels by searching WORD(S) in their description.
+
+`ayadn search --channels podcast ios`
+
+(This one operation may *sometimes* be long to execute if there's a lot of results.)
+
+If the channel (let's say 24573) is public, you can read its messages with `ayadn -ms 24573` or `ayadn -ms my_alias`.
+
+# RANDOM
+
+Show series of random posts from App.net. Just for fun :)
+
+`ayadn random`
+
+`ayadn -rnd`  
+
+# USER INFO
+
+Show informations about a user.
+
+`ayadn userinfo @ericd`
+
+`ayadn -ui @ericd`
+
+You can see your own info by using *me* instead of *@username*:
+
+`ayadn -ui me`
+
+# POST INFO
+
+Show informations about a post.
+
+`ayadn postinfo 23362788`
+
+`ayadn -pi 23362788`