pry-send_tweet.rb 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae88328b20378917474eec4a9b41346938f04b0a4ebcb3708bf9d937ea1c5691
-  data.tar.gz: 5223319e205eef81dfad63169be032aac646c9eafd8efca518ebe38f58929c51
+  metadata.gz: 8feaa382edf88c8b48066b7cbfc2c2d08b0fcb34a3d6f976e639041af51d4820
+  data.tar.gz: ac72cdd37aee73e2aeefc7dea74b596ba62e40c23238734be1fad90f06a1d063
 SHA512:
-  metadata.gz: 45fdfbbf1334c97f04e554226ecb8263a65e62f9521efe89cd77a440096db235f0ee4e3327e68583077f74534df874d9f4124e58b5b9dabf71f44311b8e39e0f
-  data.tar.gz: 983ff67471fe84c19dd5d88ed378628bcd3f30c4b0279098ff7f2490db5f09cdec72c8128cb8c37e1df93786f1609f2fbe48c490099cde60b964d97ff4402fa5
+  metadata.gz: 9e6ab0d98689c9e3f101f1e9f5afa0389afdaaf5041ec3eacc939452bd058ed7834d7c4b60ed1887a0eb7c54bbeb1cad7337393946b27abc92e938889841306e
+  data.tar.gz: 5f019e2cdbf53d8598c09abebaf0f930075f3f9f8df0b5e38b9834901f313caae0a88969f958cea077c80eebccba193020a3b3e53c21992f78eb74982baa453d

data/CHANGELOG.md

@@ -1,5 +1,48 @@
 # CHANGELOG
 
+## master
+
+* Add `send-tweet -n`, `send-tweet --no-newline`, for removing newlines from a   
+  tweet before sending it.
+
+* Add `twitter-action --mute-user=`
+
+* Add `twitter-action --suggested-users=`, `twitter-action --suggested-topics`  
+  and `twitter-action --suggested-lang`.
+
+* Add configuration option, `Pry.config.twitter.line_width`, for choosing the  
+  a lines width before word wrapping occurs. Default line width is 200.
+
+* Add pre-post tweet validation that catches empty tweets, and tweets who use  
+  too many characters.
+
+* Add `send-tweet --delay=xx` for delaying the creation of a tweet by a number  
+  of seconds.
+
+* Add `send-tweet --self-destruct=xx` for automatically deleting a tweet after  
+  a number of seconds.
+
+* Add `twitter-search`.
+
+* Add `read-tweets --tweeter=`, a longer version of `read-tweets -t`.  
+
+* Add `read-tweets --replies <user>`.
+
+* Add short hand variants for all `read-tweets` options.
+
+* Combine the `read-tweets` options `--my-likes` and `--liked-by` into  
+  one option, `--likes`.
+
+* Rename `read-tweets --that-mention-me` to `read-tweets --mentions`.
+
+* Don't hit the Twitter API if a composed tweet is entirely whitespace.
+
+* `send-tweet --file` accepts a comma separated list for attaching multiple  
+   images to a tweet.
+
+* Like, unlike, and delete actions accept a comma separated list for performing  
+  an action on multiple tweets.
+
 ## v0.6.0
 
 * Fix a bug where the auto refresh feature could not be disabled.   

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.5.3-stretch
+FROM ruby:2.6.0-stretch
 
 # Create working directory
 RUN mkdir -p /app/
@@ -7,13 +7,15 @@ WORKDIR /app/
 # Bundler
 ADD Gemfile pry-send_tweet.gemspec /app/
 ADD lib /app/lib
-RUN gem install bundler --no-rdoc --no-ri
+RUN gem install bundler
+# FIXME: During 'bundle install', i got: Could not find gem 'buftok (~> 0.2.0)'
+# Installing twitter as a gem first fixes that.
+RUN gem install twitter
 RUN bundle install
 
 # Install packages
 RUN apt-get update
-RUN apt-get install -y --no-install-recommends cowsay locales emacs24-nox less
-RUN ln -s /usr/games/cowsay /usr/bin/cowsay
+RUN apt-get install -y --no-install-recommends locales emacs24-nox less
 
 # Configure locale
 RUN sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen

data/Gemfile

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 gemspec
+gem 'pry-auto_benching.rb'
+gem 'pry-doc'
 group :test do
   gem 'rspec'
-end
+end

data/README.md

@@ -1,16 +1,34 @@
 # pry-send_tweet.rb
 
-## Introduction
-
-Extends the Pry REPL with the capabilities of a Twitter client.
-
-## API Access
+* [Introduction](#introduction)
+* [API Access](#api-access)
+* [Configuration - required](#configuration)
+* [Usage](#usage)
+  * [Sending Tweets](#sending-tweets)
+  * [Reading Tweets](#reading-tweets)
+  * [Deleting Tweets](#deleting-tweets)
+  * [Liking Tweets](#liking-tweets)
+  * [Searching Twitter](#searching-twitter)
+  * [Retweets](#retweets)
+  * [Profile Actions](#profile-actions)
+  * [Twitter Suggestions](#twitter-suggestions)
+  * [Muting other users](#muting-other-users)
+  * [Tip: Command Aliases](#tip)
+* [Multi-tasking: tmux / screen](#multi-tasking)
+* [Install](#install)
+* [License](#license)
+
+## <a id='Introduction'>Introduction</a>
+
+A Twitter client for the Pry REPL.
+
+## <a id='api-access'>API Access</a>
 
 Using the Twitter API requires a developer account.
 Follow the instructions at [https://developer.twitter.com](https://developer.twitter.com)  
 if you haven't already setup access to the Twitter API.
 
-## Configuration (required)
+## <a id='configuration'>Configuration (required)</a>
 
 The placeholder keys and tokens in the below example can be replaced
 by those from your developer account.
@@ -27,14 +45,16 @@ Pry.configure do |config|
     # Optional configuration
     # The User-Agent to use when making requests to the Twitter API.
     # Default is: 'pry-send_tweet.rb vX.Y.Z'
-    user_agent: 'Custom User-Agent'
+    user_agent: 'Custom User-Agent',
+    # The width of a line before word wrapping occurs, the default is 100.
+    line_width: 120
   })
 end
 ```
 
-## Usage
+## <a id='usage'>Usage</a>
 
-There are three commands added to Pry by this plugin, those commands are:
+There are four commands added to Pry by this plugin, those commands are:
 
   * `send-tweet`  
     For sending tweets.
@@ -45,7 +65,10 @@ There are three commands added to Pry by this plugin, those commands are:
   * `twitter-action` (aliased as: `on-twitter`)  
     For performing misc actions on Twitter, such as following, unfollowing, etc.
 
-### Sending tweets
+  * `twitter-search`  
+    For searching Twitter.  
+
+### <a id='sending-tweets'>Sending tweets</a>
 
 
 * Send a tweet:
@@ -60,29 +83,34 @@ There are three commands added to Pry by this plugin, those commands are:
 
       [1] pry(main)> send-tweet --file #{File.join ENV['HOME'], 'photos', 'image.jpg'}
 
+
 * Reply to a tweet:
 
       [1] pry(main)> send-tweet --reply-to https://twitter.com/username/status/1
 
-* There is built-in support for the `cowsay` program, which is a program that  
-  draws humorous ascii art. The following example will send a tweet using the  
-  Linux 'tux' mascot.  
-  <br>
-  **Tip:** `--cowsay-char` is optional and can be left blank. A cow will be used  
-  as the default. For a full list of available `cowsay` characters that can be  
-  used with the `--cowsay-char` option, run `cowsay -l` from a shell.   
+* Send a tweet that will self-destruct after 70 seconds.  
+It's worth adding that if the Pry process exits this operation will be cancelled:
+
+      [1] pry(main)> send-tweet --self-destruct=70
 
-  **Extra Tip:** The `Dockerfile` in this repository installs `cowsay`.
+* Send a tweet that will be published 70 seconds in the future.  
+It's worth adding that if the Pry process exits, this operation will be cancelled:  
 
-      [1] pry(main)> send-tweet --cowsay-text 'Hello, world' --cowsay-char tux
+      [1] pry(main)> send-tweet --delay=70
 
-### Reading tweets
+* Delay sending a tweet until 12AM, today. `--self-destruct` also supports this  
+  syntax:
+
+      [1] pry(main)> send-tweet --delay=00:00
+
+### <a id='reading-tweets'>Reading tweets</a>
 
 By default the tweets displayed by the `read-tweets` command  are automatically  
-refreshed every 4 minutes.
+refreshed every 5 minutes.
 
 That can be changed to a custom interval by setting `Pry.config.twitter.refresh_interval`  
-to a number of seconds, or to `false` if you want to disable this feature.  
+to a number of seconds, or to `false` if you want to disable this
+feature.
 
 * Read recent tweets from your timeline:
 
@@ -94,84 +122,143 @@ to a number of seconds, or to `false` if you want to disable this feature.
 
 * Read recent tweets that `@mention` you:
 
-      [1] pry(main)> read-tweets --that-mention-me
+      [1] pry(main)> read-tweets --mentions
 
 * Read recent tweets that you've liked:
 
-      [1] pry(main) read-tweets --my-likes
+      [1] pry(main) read-tweets --likes
 
 * Read recent tweets liked by another user:
 
-      [1] pry(main)> read-tweets --liked-by ladygaga
+      [1] pry(main)> read-tweets --likes ladygaga
+
+* Read recent tweets sent as replies by a given user, the example uses `@github`:
+
+      [1] pry(main)> read-tweets --replies github
+
+* Read 100 recent tweets instead of the default 200 recent tweets.    
+  **Tip:** `--count` can be combined with all of the options described above.
+
+      [1] pry(main)> read-tweets --count 100
 
 * By default retweets are not displayed.  
   To display retweets, pass the `--with-retweets` option.  
 
       [1] pry(main)> read-tweets --with-retweets
 
-* Read 100 recent tweets instead of the default 35 recent tweets.    
-  **Tip:** `--count` can be combined with all of the options described above.
+### <a id='deleting-tweets'>Deleting tweets</a>
 
-      [1] pry(main)> read-tweets --count 100
+* Delete one or more tweets with a comma separated list:
 
-### Deleting tweets
+      [1] pry(main)> on-twitter --delete-tweet https://twitter.com/username/status/1
 
-* Delete a tweet:
+* Delete one or more retweets with a comma separated list:
 
-      [1] pry(main)> twitter-action --delete-tweet https://twitter.com/username/status/1
+      [1] pry(main)> on-twitter --delete-retweet https://twitter.com/username/status/1
 
-* Delete a retweet:
+### <a id='liking-tweets'>Liking tweets</a>
 
-      [1] pry(main)> twitter-action --delete-retweet https://twitter.com/username/status/1
+* Like one or more tweets with a comma separated list:
 
-### Liking tweets
+      [1] pry(main)> on-twitter --like https://twitter.com/user/status/1
 
-* Like a tweet:
+* Unlike one or more tweets with a comma separated list:
 
-      [1] pry(main)> twitter-action --like https://twitter.com/user/status/1
+      [1] pry(main)> on-twitter --unlike https://twitter.com/user/status/1
 
-* Unlike a tweet:
+### <a id='searching-twitter'>Searching Twitter</a>
 
-      [1] pry(main)> twitter-action --unlike https://twitter.com/user/status/1
+The `twitter-search` command can be used to search Twitter.
 
-### Retweets
+* Search Twitter using a given hashtag:
 
-* Retweet a tweet:
+      [1] pry(main)> twitter-search #ruby
 
-      [1] pry(main)> twitter-action --retweet https://twitter.com/user/status/1
+### <a id='retweets'>Retweets</a>
 
-### Update your Twitter profile
+* Retweet one or more tweets with a comma separated list:
+
+      [1] pry(main)> on-twitter --retweet https://twitter.com/user/status/1
+
+### <a id='profile-actions'>Profile actions</a>
 
 * Update your profiles image:
 
-      [1] pry(main)> twitter-action --set-profile-image /path/to/image.jpg
+      [1] pry(main)> on-twitter --set-profile-image /path/to/image.jpg
 
 * Update your profiles banner image:
 
-      [1] pry(main)> twitter-action --set-profile-banner-image /path/to/image.jpg
+      [1] pry(main)> on-twitter --set-profile-banner-image /path/to/image.jpg
 
 * Update your profiles bio:
 
       # Your editor opens (`_pry_.editor`), write your bio then hit save & close.
       # Your bio will be updated after closing your editor.
-      [1] pry(main)> twitter-action --set-profile-bio
+      [1] pry(main)> on-twitter --set-profile-bio
+
+### <a id='twitter-suggestions'>Twitter Suggestions</a>
+
+* View a list of suggested topics, optionally restricted to Spanish:
 
-## Install
+      [1] pry(main)> on-twitter --suggested-lang=es --suggested-topics
+
+* View a list of suggested users from a given topic, optionally restricted to  
+  Spanish:
+
+      [1] pry(main)> on-twitter --suggested-lang=es --suggested-users=<topic>
+
+
+### <a id='muting-other-users'>Muting other users</a>
+
+* Mute one or more users with a comma separated list:
+
+      [1] pry(main)> on-twitter --mute-user=user1,user2,user3
+
+* Unmute one or more users with a comma separated list:
+
+      [1] pry(main)> on-twitter --unmute-user=user1,user2,user3
+
+### <a id='tip'>Tip: Command Aliases</a>
+
+When there are Twitter accounts you read often, it can turn out to be faster   
+to create command aliases for reading those accounts. An example follows, a   
+hyphen is included in the aliased commands to avoid collisions with Ruby code.
+
+```ruby
+# .pryrc
+Pry.commands.alias_command "prez-trump", "read-tweets -t realdonaldtrump"
+Pry.commands.alias_command "prez-obama", "read-tweets -t barackobama"
+```
+
+## <a id='multi-tasking'>Multi-tasking: tmux / screen</a>
+
+To get the most out of `pry-send_tweet.rb` I use tmux to manage a pane for reading  
+tweets and another for writing tweets. I've found this to be the best way since  
+a single shell does not allow for multi tasking but tmux and screen do.
+
+I use
+[tmuxinator](https://github.com/tmuxinator/tmuxinator)
+to manage my tmux sessions.  
+The tmuxinator configuration I use is available as a
+[sample](./samples/tmuxinator.yml)
+to use yourself or to act   
+as inspiration for your own configuration.
+
+## <a id='install'>Install</a>
 
 Install the gem:
 
     $ gem install pry-send_tweet.rb
 
-There's also the option to clone this repository and then use the provided
-`Dockerfile` to run pry-send_tweet.rb inside a Docker container.
-The container is configured to use `emacs` when sending tweets and when using
-other commands that open an editor.
+There's also the option to clone this repository and then use the provided  
+`Dockerfile` to run pry-send_tweet.rb inside a Docker container.  
+The container is configured to use `emacs` when sending tweets and when using  
+other commands that open an editor.  
 
     $ git clone https://github.com/r-obert/pry-send_tweet.rb
     $ cd pry-send_tweet.rb
     $ ./dockerize.sh
 
-
-## License
+## <a id='license'>License</a>
 
 This project uses the MIT license, see [LICENSE.txt](./LICENSE.txt) for details.

data/lib/pry-send_tweet.rb

@@ -1,12 +1,32 @@
-require 'pry' if not defined?(Pry::ClassCommand)
-require 'twitter'
-require 'cgi'
-require 'shellwords'
-require 'timeout'
-module Pry::SendTweet
-  require_relative 'pry/send_tweet/mixins/tweet_renderer'
-  require_relative 'pry/send_tweet/base_command'
-  require_relative 'pry/send_tweet/send_tweet_command'
-  require_relative 'pry/send_tweet/read_tweets_command'
-  require_relative 'pry/send_tweet/twitter_action_command'
+class Pry
+  module SendTweet
+    #
+    # @return [Integer]
+    #   The size of a line before word wrapping occurs.
+    #
+    # @api private
+    #
+    DEFAULT_LINE_WIDTH = 100
+
+    #
+    # @return [Integer]
+    #   The number of tweets to request when reading tweets from Twitters API.
+    #
+    # @api private
+    #
+    DEFAULT_READ_SIZE = 200
+
+    require 'pry' if not defined?(Pry::ClassCommand)
+    require 'twitter'
+    require 'cgi'
+    require 'shellwords'
+    require 'timeout'
+    require 'time-lord'
+    require_relative 'pry/send_tweet/renderers/tweet_renderer'
+    require_relative 'pry/send_tweet/commands/base_command'
+    require_relative 'pry/send_tweet/commands/send_tweet'
+    require_relative 'pry/send_tweet/commands/read_tweets'
+    require_relative 'pry/send_tweet/commands/twitter_search'
+    require_relative 'pry/send_tweet/commands/twitter_action'
+  end
 end

data/lib/pry/send_tweet/{base_command.rb → commands/base_command.rb}

@@ -17,7 +17,7 @@ class Pry::SendTweet::BaseCommand < Pry::ClassCommand
   private
 
   def page(txt)
-    _pry_.pager.page txt
+    _pry_.pager.page txt.to_s
   end
 
   def find_usernames_in(*ary)
@@ -34,7 +34,7 @@ class Pry::SendTweet::BaseCommand < Pry::ClassCommand
 
   # With thanks to ActionView for this method
   def word_wrap(text, options = {})
-   line_width = options.fetch(:line_width, 80)
+   line_width = _pry_.config.twitter.line_width || Pry::SendTweet::DEFAULT_LINE_WIDTH
    text.split("\n").collect! do |line|
      line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
    end * "\n"
@@ -46,14 +46,23 @@ class Pry::SendTweet::BaseCommand < Pry::ClassCommand
     title + ary.map.with_index { |item, index| yield(item, index+1) }.join("\n")
   end
 
-  def client
-    @client ||= Twitter::REST::Client.new { |config|
+  def twitter_error(e)
+    msg = Exception === e ? e.message : e
+    "#{bold(bright_red('Twitter Error:'))} #{msg}"
+  end
+
+  def time_format
+    "%-d %b %Y, %-I:%M:%S %p"
+  end
+
+  def twitter
+    @twitter ||= Twitter::REST::Client.new { |config|
       config.consumer_key = _pry_.config.twitter.consumer_key
       config.consumer_secret = _pry_.config.twitter.consumer_secret
       config.access_token = _pry_.config.twitter.access_token
       config.access_token_secret = _pry_.config.twitter.access_token_secret
-    }.tap {|client|
-      client.user_agent = _pry_.config.twitter.user_agent ||
+    }.tap {|twitter|
+      twitter.user_agent = _pry_.config.twitter.user_agent ||
                           "pry-send_tweet.rb v#{Pry::SendTweet::VERSION}"
     }
   end