pry-send_tweet.rb 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4464a0e5487676221d3f0809dab2dcdb2ac192d84ded42dbbae6cb9d8593e459
-  data.tar.gz: 4944d0716568bb7687a5ca0917cd2df1772b4af5cb2bb25117a51d79a8ea9a45
+  metadata.gz: d1b348df95911cd2447ff36cd711b031eb3b874a14b4cf9392182d0a744ec760
+  data.tar.gz: ecd6e2c63167b4fca8721422e55daa70712d87e210b5ba5f21953b1576dad480
 SHA512:
-  metadata.gz: 39cca7be237772f1ee3e4ad9c60d4db9bd35a7e96a23274c3d1bb852b838879b20dffe8a7c63568980e3ab022d67b2ae04c2615afea4e99f1fb6469c87bc2509
-  data.tar.gz: 71ffdc012830a01ceb5a03b1b9ada4bb8899e7422a0e74e6824ff19296cea032fabca05d511dbdcbd202baf37816547414c89b01ad68806f2a083be8e46b5156
+  metadata.gz: 1d54e4d6756e28910ef90821fe1ac8b6c13e78d496cbe57265f16b040f256bb078eb1f1928c2f8767f68681a14ac4b1dfbbd09bfe569cedc14741b6d25ab2b48
+  data.tar.gz: ba04afd09168981415684e4779dbebd83cc34b5c0f5281318bc1503297faa8e624bb70d6bd4b38b914377dc44191820f2b79d83e73f4fa3287ede2c76d8e390b

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # CHANGELOG
 
+## v0.11.0
+
+* Apply a fix to tty-box for the `on-twitter --show-followers`, and
+  `on-twitter --show-following` commands.
+
+* Add unicode support by applying a fix - as a monkey patch - to the `tty-box`  
+  gem.
+
+* Add `unicode-display_width`, and `unicode-emoji` as runtime dependencies.  
+
+* Add `read-tweets -x`, `read-tweets --translate` -  for translating tweets,  
+  using the Yandex translation API.
+
+* `on-twitter --follow` & `on-twitter --unfollow` understand a string such as  
+  `https://twitter.com/StephenKing/media` to mean `@StephenKing`.
+
+* Include a URL to a users profile when following or unfollowing them.
+
+* Remove duplicate username when replying to a tweet. This could happen when the  
+  tweet author and the person replying to the tweet are the same.  
+
+* Update `Pry::SendTweet::UserRenderer` to use `config.box_width`, and  
+  `config.box_height`.
+
+* Use `page_ok()` from `send-tweet` command.  
+
 ## v0.10.1
 
 * Improve forking implementation in `Pry::SendTweet::TweetRenderer`.

data/README.md

@@ -52,15 +52,21 @@ Pry.configure do |config|
     consumer_key: '<consumer key>',
     consumer_secret: '<consumer secret>',
     access_token: '<access token>',
-    access_token_secret: '<access token secret>'
+    access_token_secret: '<access token secret>',
     # 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',
+    # Optional configuration
     # The width & height of a box that contains a tweet or user.
     # The default width is 100 and the default height is 8.
     box_width: 120,
-    box_height: 10
+    box_height: 10,
+    # Optional configuration
+    # A Yandex API key for translating tweets when using `read-tweets -x`.
+    yandex_key: 'xxx',
+    # The language tweets should be translated to, the default is 'en' (English).
+    yandex_lang: 'ru'
   })
 end
 ```
@@ -79,6 +85,9 @@ access_token_secret: '<access token secret>'
 # Optional
 user_agent: 'Your User-Agent string'
 line_width: 120
+# Optional
+yandex_key: xxx
+yandex_lang: xx
 ```
 
 ## <a id='usage'>Usage</a>
@@ -165,6 +174,12 @@ feature.
 
       [1] pry(main)> read-tweets --replies github
 
+* Read a translated copy of a tweet, using the
+  [Yandex translation API](https://translate.yandex.com/developers).  
+  The configuration instructions for Yandex are included in the [configuration section](#configuration).
+
+      [1] pry(main) read-tweets -x https://twitter.com/user/status/1
+
 * Read 100 recent tweets instead of the default 200 recent tweets.    
   **Tip:** `--count` can be combined with all of the options described above.
 

data/lib/pry-send_tweet.rb

@@ -28,7 +28,7 @@ class Pry
     require 'timeout'
     require 'yaml'
     require 'time-lord'
-    require 'tty/box'
+    require_relative 'pry/send_tweet/tty-box'
     require_relative 'pry/send_tweet/renderers/tweet_renderer'
     require_relative 'pry/send_tweet/renderers/user_renderer'
     require_relative 'pry/send_tweet/commands/paging/paging_support'

data/lib/pry/send_tweet/commands/base_command.rb

@@ -25,11 +25,12 @@ class Pry::SendTweet::BaseCommand < Pry::ClassCommand
   def box_width
     _pry_.config.twitter.box_width || Pry::SendTweet::DEFAULT_BOX_WIDTH
   end
-  
+
   def search_str_for_users(*ary)
     ary.map do |str|
       if str.start_with?('https://twitter.com')
-        File.basename URI.parse(URI.escape(str)).path
+        path = URI.parse(URI.escape(str)).path
+        path.split('/').reject(&:empty?).first
       elsif str.start_with?('@')
         str[1..-1]
       else
@@ -40,6 +41,7 @@ class Pry::SendTweet::BaseCommand < Pry::ClassCommand
 
   # With thanks to ActionView for this method
   def word_wrap(text, options = {})
+   line_width = box_width
    text.split("\n").collect! do |line|
      line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
    end * "\n"
@@ -57,11 +59,4 @@ class Pry::SendTweet::BaseCommand < Pry::ClassCommand
   def twitter
     @twitter ||= _pry_.binding_stack[-1].eval('_twitter_')
   end
-
-  # @api private
-  # TTY::Box doesn't handle unicode well, we remove non-ASCII characters as a
-  # temporary work around.
-  def __tty_box_sanitize(str)
-    CGI.unescapeHTML str.chars.reject {|c| c.ord > 255}.join
-  end
 end

data/lib/pry/send_tweet/commands/read_tweets.rb

@@ -1,4 +1,7 @@
 class Pry::SendTweet::ReadTweets < Pry::SendTweet::BaseCommand
+  require_relative 'read_tweets/translate_actions'
+  include TranslateActions
+  
   match 'read-tweets'
   description 'A command for reading tweets.'
   banner <<-BANNER
@@ -18,12 +21,14 @@ class Pry::SendTweet::ReadTweets < Pry::SendTweet::BaseCommand
          argument: :optional
     o.on 'r=', 'replies=', 'A username whose replies you want to read'
     o.on 'm', 'mentions', 'Read tweets that @mention you.'
+    o.on 'x=', 'translate=', 'Translate a tweet'
     o.on 'w', 'with-retweets', 'Include retweets.'
   end
 
   def process
     super
     case
+    when opts.present?('translate') then translate_tweet(opts['translate'])
     when opts.present?('replies') then show_replies(user: opts['replies'])
     when opts.present?('likes') then show_likes(user: opts['likes'])
     when opts.present?('mentions') then show_mentions

data/lib/pry/send_tweet/commands/read_tweets/translate_actions.rb

@@ -0,0 +1,38 @@
+module Pry::SendTweet::ReadTweets::TranslateActions
+  YANDEX_ENDPOINT = "https://translate.yandex.net/api/v1.5/tr.json/translate?" \
+                    "key=%{key}&text=%{text}&lang=%{lang}"
+
+  def translate_tweet(tweet_url)
+    tweet = twitter.status(tweet_url)
+    uri_endpoint = __build_yandex_endpoint(tweet)
+    res = Net::HTTP.get_response(uri_endpoint)
+    case res
+    when Net::HTTPOK
+      tweet.attrs[:full_text] = JSON.parse(res.body)["text"][0]
+      render_tweets [tweet], title: "Translated tweet"
+    else
+      raise Pry::CommandError, "Bad response from Yandex (#{res.class})"
+    end
+  end
+
+  private
+
+  # @api private
+  def __build_yandex_endpoint(tweet)
+    URI.parse format(YANDEX_ENDPOINT,
+      lang: _pry_.config.twitter.yandex_lang || "en",
+      key: __yandex_key,
+      text: URI.encode_www_form_component(__read_tweet_body(tweet))
+    )
+  end
+
+  # @api private
+  def __yandex_key
+    k = _pry_.config.twitter.yandex_key
+    if !k || k.strip.empty?
+      raise Pry::CommandError,
+            "fatal: _pry_.config.twitter.yandex_key is nil, false or empty"
+    end
+    URI.encode_www_form_component(k)
+  end
+end

data/lib/pry/send_tweet/commands/send_tweet.rb

@@ -41,10 +41,10 @@ class Pry::SendTweet::SendTweet < Pry::SendTweet::BaseCommand
       publish_time = (time_obj ? time_obj : Time.now + sleep_seconds)
                       .getlocal
                       .strftime(time_format)
-      page bold("Tweet will be published at approximately #{publish_time}.")
+      page_ok bold("Tweet will be published at approximately #{publish_time}.")
     else
       tweet = create_tweet.call
-      page tweet.url
+      page_ok tweet.url
     end
   end
 
@@ -69,8 +69,8 @@ class Pry::SendTweet::SendTweet < Pry::SendTweet::BaseCommand
 
   def prepend_username_to_reply!(tweet_url, file)
     tweet = twitter.status(tweet_url)
-    mentions = tweet.user_mentions.map{|u| "@#{u.screen_name}"}.join(' ')
-    file.write "@#{tweet.user.screen_name} #{mentions}"
+    mentions = [tweet.user.screen_name].concat tweet.user_mentions.map(&:screen_name)
+    file.write mentions.uniq(&:downcase).map{|u| "@#{u}" }.join(' ')
   end
 
   def replying_to_other_tweet?

data/lib/pry/send_tweet/commands/twitter_action/follow_actions.rb

@@ -51,7 +51,7 @@ module Pry::SendTweet::TwitterAction::FollowActions
   # @api private
   def join_usernames(users)
     users.map do |username|
-      bold("@#{username}")
+      bold("@#{username}") + " ( https://twitter.com/#{username} )"
     end.join(', ')
   end
 end

data/lib/pry/send_tweet/renderers/tweet_renderer.rb

@@ -1,11 +1,11 @@
 module Pry::SendTweet::TweetRenderer
   include Timeout
 
-  def render_tweets(tweet_fetcher, title:, timeout: _pry_.config.twitter.refresh_interval)
+  def render_tweets(tweet_fetcher, title: nil, timeout: _pry_.config.twitter.refresh_interval)
     pid = nil
     timeout(__choose_render_interval(timeout)) {
       tweets = __fetch_tweets(tweet_fetcher)
-      pid = __fork_pager(tweets)
+      pid = __fork_pager(title, tweets)
       Process.wait(pid)
     }
   rescue Interrupt
@@ -19,12 +19,12 @@ module Pry::SendTweet::TweetRenderer
 
   private
   # @api private
-  def __fork_pager(tweets)
+  def __fork_pager(title, tweets)
     Kernel.fork do
       _pry_.pager.open do |pager|
         __trap_signal_in_fork(pager)
         tweets.empty? ? pager.write("No tweets to show.") :
-                        pager.write(__render_tweets("Twitter", tweets))
+                        pager.write(__render_tweets(title || "Twitter", tweets))
 
       end
     end
@@ -38,7 +38,7 @@ module Pry::SendTweet::TweetRenderer
 
   # @api private
   def __render_tweet(tweet)
-    contents = __get_tweet_contents(tweet)
+    contents = __read_tweet_body(tweet)
     TTY::Box.frame(height: box_height,
                    width: box_width,
                    title: {top_left: __render_tweet_title(tweet)}) do
@@ -58,11 +58,10 @@ module Pry::SendTweet::TweetRenderer
   end
 
   # @api private
-  def __get_tweet_contents(tweet)
+  def __read_tweet_body(tweet)
     text = tweet.attrs[:full_text] ? tweet.attrs[:full_text] :
                                      tweet.full_text
-    text = __tty_box_sanitize(CGI.unescapeHTML(text)).strip
-    text.size == 0 || text !~ /[a-z0-9]{1,}/i ? "\n[ Outside ASCII charset ]\n" : text
+    CGI.unescapeHTML(text).strip
   end
 
   # @api private
@@ -95,7 +94,8 @@ module Pry::SendTweet::TweetRenderer
     trap('SIGINT') {
       if Pry::Pager::SystemPager === pager
         syspager = pager.send(:pager)
-        Process.kill('SIGKILL', syspager.pid) rescue nil
+        pid = syspager.pid
+        Process.kill('SIGKILL', pid) rescue nil
       end
       Process.kill('SIGKILL', Process.pid)
     }

data/lib/pry/send_tweet/renderers/user_renderer.rb

@@ -1,15 +1,16 @@
 module Pry::SendTweet::UserRenderer
   def render_user(user)
-    body = <<-USER
-    #{bold("Tweets")}    #{user.tweets_count}
-    #{bold("Followers")} #{user.followers_count}
-    #{bold("Following")} #{user.friends_count}
-    #{__tty_box_sanitize(user.description)}
-    USER
+    title = "@#{user.screen_name} ( https://twitter.com/#{user.screen_name} )"
+    body = CGI.unescapeHTML <<-USER.each_line.map(&:strip).join("\n")
+#{bold("Tweets")}    #{user.tweets_count}
+#{bold("Followers")} #{user.followers_count}
+#{bold("Following")} #{user.friends_count}
+#{user.description}
+USER
     TTY::Box.frame(
-      height: 8,
-      width: 80,
-      title: {top_left: "@#{user.screen_name} ( https://twitter.com/#{user.screen_name} )"}
+      height: box_height,
+      width: box_width,
+      title: {top_left: title}
     ) { body }.to_s
   end
 end

data/lib/pry/send_tweet/tty-box.rb

@@ -0,0 +1,74 @@
+#
+# A monkey patch module that implements unicode & emoji support in the gem
+# 'tty-box' when using its `frame` method.
+#
+module Pry::SendTweet::TTYPatch
+  require 'tty-box'
+  require 'unicode/display_width'
+  require 'unicode/emoji'
+  # Create a frame
+  #
+  # @api public
+  def frame(top: nil, left: nil, width: 35, height: 3, align: :left, padding: 0,
+            title: {}, border: :light, style: {})
+    output = []
+    content = []
+    position = top && left
+
+    border = TTY::Box::Border.parse(border)
+    top_size    = border.top? ? 1: 0
+    bottom_size = border.bottom? ? 1: 0
+    left_size   = border.left? ? 1 : 0
+    right_size  = border.right ? 1 : 0
+
+    if block_given?
+      content = format(yield, width, padding, align)
+    end
+
+    fg, bg = *extract_style(style)
+    border_fg, border_bg = *extract_style(style[:border] || {})
+
+    if border.top?
+      output << cursor.move_to(left, top) if position
+      output << top_border(title, width, border, style)
+      output << "\n" unless position
+    end
+
+    (height - top_size - bottom_size).times do |i|
+      output << cursor.move_to(left, top + i + top_size) if position
+      if border.left?
+        output << border_bg.(border_fg.(pipe_char(border.type)))
+      end
+
+      content_size = width - left_size - right_size
+      unless content[i].nil?
+        output << bg.(fg.(content[i]))
+        plain_content = Pry::Helpers::Text.strip_color(content[i])
+        content_size -= Unicode::DisplayWidth.of(plain_content, 1, {}, emoji: true)
+      end
+      if style[:fg] || style[:bg] || !position # something to color
+        output << bg.(fg.(' ' * content_size))
+      end
+
+      if border.right?
+        if position
+          output << cursor.move_to(left + width - right_size, top + i + top_size)
+        end
+        output << border_bg.(border_fg.(pipe_char(border.type)))
+      end
+      output << "\n" unless position
+    end
+
+    if border.bottom?
+      output << cursor.move_to(left, top + height - bottom_size) if position
+      output << bottom_border(title, width, border, style)
+      output << "\n" unless position
+    end
+    output.join
+  end
+end
+
+module TTY::Box
+  prepend Pry::SendTweet::TTYPatch
+  singleton_class.module_eval { prepend Pry::SendTweet::TTYPatch }
+end

data/lib/pry/send_tweet/version.rb

@@ -1,5 +1,5 @@
 class Pry
   module SendTweet
-    VERSION = '0.10.1'
+    VERSION = '0.11.0'
   end
 end

data/pry-send_tweet.gemspec

@@ -13,5 +13,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "pry", "~> 0.12"
   spec.add_runtime_dependency "twitter", "~> 6.0"
   spec.add_runtime_dependency "time-lord", "~> 1.0"
-  spec.add_runtime_dependency "tty-box"
+  spec.add_runtime_dependency "tty-box", "= 0.3.0"
+  spec.add_runtime_dependency "unicode-display_width", "~> 1.4"
+  spec.add_runtime_dependency "unicode-emoji", "~> 1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-send_tweet.rb
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Robert Gleeson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-14 00:00:00.000000000 Z
+date: 2019-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -56,16 +56,44 @@ dependencies:
   name: tty-box
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: unicode-display_width
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: unicode-emoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: A Twitter client for the Pry REPL.
 email: trebor.g@protonmail.com
 executables: []
@@ -82,6 +110,7 @@ files:
 - lib/pry/send_tweet/commands/base_command.rb
 - lib/pry/send_tweet/commands/paging/paging_support.rb
 - lib/pry/send_tweet/commands/read_tweets.rb
+- lib/pry/send_tweet/commands/read_tweets/translate_actions.rb
 - lib/pry/send_tweet/commands/send_tweet.rb
 - lib/pry/send_tweet/commands/twitter_action.rb
 - lib/pry/send_tweet/commands/twitter_action/delete_tweet_actions.rb
@@ -93,6 +122,7 @@ files:
 - lib/pry/send_tweet/commands/twitter_search.rb
 - lib/pry/send_tweet/renderers/tweet_renderer.rb
 - lib/pry/send_tweet/renderers/user_renderer.rb
+- lib/pry/send_tweet/tty-box.rb
 - lib/pry/send_tweet/version.rb
 - pry-send_tweet.gemspec
 homepage: https://github.com/r-obert/pry-send_tweet.rb