tweet_sanitizer 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1260735d1dce2e00d66d4817e292d2fee9f047b
-  data.tar.gz: c0b26d8442c0a2c629a80f68c437c87562a6a0ee
+  metadata.gz: f81ed3decd1defa109db3cb5dcd3ff146b9d2377
+  data.tar.gz: f788cc11a47f4ccbc626846f3977ca6170ea99f0
 SHA512:
-  metadata.gz: e1e79f701eb86fe751dd0f1df9de6853e2482de756acb27361798644e7dd5a07b7296e4d2d63bb654b2f17d9f5790a52852f94620b3a94108100e919b9b00ad0
-  data.tar.gz: 22e8583b42b7e1b1dc94f7c87b74eeb939484c4ae31199ea91ab55d96cd92f447e3ddb6875b3e06ccec489eda210724fd65f990934ef60de02218fb36902a92d
+  metadata.gz: d76f6708fdb977de53aa3f00155d4292203ffaa730a9828ec5af244b5539b4fef23e39e195f945f911383fbe10d0a0825662179be6d71b51dae129e3d6aa4551
+  data.tar.gz: 365728cef1fe75877b00cff14e0a0ebbd0d088fecb1a0b51a3fa5654989ee5ce49867d3454b2c05f5a612754a63f8c2f3c972d85d5dac9e7356f20b9d4322aa1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Unreleased
-[full changelog](https://github.com/sue445/tweet_sanitizer/compare/v0.1.1...master)
+[full changelog](https://github.com/sue445/tweet_sanitizer/compare/v0.2.0...master)
+
+## v0.2.0
+[full changelog](https://github.com/sue445/tweet_sanitizer/compare/v0.1.1...v0.2.0)
+
+* Add sanitize options
+  * https://github.com/sue445/tweet_sanitizer/pull/12
 
 ## v0.1.1
 [full changelog](https://github.com/sue445/tweet_sanitizer/compare/v0.1.0...v0.1.1)

data/README.md

@@ -67,6 +67,40 @@ See following.
 
 https://dev.twitter.com/overview/api/upcoming-changes-to-tweets
 
+### Options
+Same to `Twitter::Tweet#sanitized_text` and `TweetSanitizer.sanitize`. (By default all are `true`)
+
+* `use_retweeted_tweet` : Whether use original retweeted tweet if exists
+* `expand_url` : Whether expand url in tweet (e.g. `t.co` url -> original url)
+* `remove_media_url` : Whether remove media url in tweet
+* `unescape` : Whether unescape in tweet (e.g. `(&gt; &lt;)` -> `(> <)`)
+
+#### Example
+
+```ruby
+tweet = @client.status("https://twitter.com/github/status/900456141557080065", tweet_mode: "extended")
+
+# all are false
+tweet.sanitized_text(use_retweeted_tweet: false, expand_url: false, remove_media_url: false, unescape: false)
+#=> "RT @GitHubEducation: Announcing two new GitHub Classroom features: Assignment Deadlines and Class Rosters: https://t.co/bNiJnlps5e https://…"
+
+# Only use_retweeted_tweet is true
+tweet.sanitized_text(use_retweeted_tweet: true, expand_url: false, remove_media_url: false, unescape: false)
+#=> "Announcing two new GitHub Classroom features: Assignment Deadlines and Class Rosters: https://t.co/bNiJnlps5e https://t.co/C02G05tUvu"
+
+# Only expand_url is true
+tweet.sanitized_text(use_retweeted_tweet: false, expand_url: true, remove_media_url: false, unescape: false)
+#=> "RT @GitHubEducation: Announcing two new GitHub Classroom features: Assignment Deadlines and Class Rosters: https://github.com/blog/2418-github-classroom-now-supports-deadlines-and-class-rosters https://…"
+
+# Only remove_media_url is true
+tweet.sanitized_text(use_retweeted_tweet: false, expand_url: false, remove_media_url: true, unescape: false)
+#=> "RT @GitHubEducation: Announcing two new GitHub Classroom features: Assignment Deadlines and Class Rosters: https://t.co/bNiJnlps5e https://…"
+
+# all are true (default)
+tweet.sanitized_text
+#=> "Announcing two new GitHub Classroom features: Assignment Deadlines and Class Rosters: https://github.com/blog/2418-github-classroom-now-supports-deadlines-and-class-rosters"
+```
+
 ## Development
 
 ```bash

data/lib/tweet_sanitizer.rb

@@ -3,22 +3,30 @@ require "tweet_sanitizer/version"
 require "tweet_sanitizer/twitter_extension"
 
 module TweetSanitizer
+  # Sanitize tweet
   # @param tweet [Twitter:Tweet]
+  # @param use_retweeted_tweet [Boolean] Whether use original retweeted tweet if exists
+  # @param expand_url          [Boolean] Whether expand url in tweet (e.g. `t.co` url -> original url)
+  # @param remove_media_url    [Boolean] Whether remove media url in tweet
+  # @param unescape            [Boolean] Whether unescape in tweet (e.g. `(&gt; &lt;)` -> `(> <)`)
   # @return [String]
-  def self.sanitize(tweet)
+  def self.sanitize(tweet, use_retweeted_tweet: true, expand_url: true, remove_media_url: true, unescape: true)
     # Original RT status is exists in retweeted_status
-    tweet = Twitter::Tweet.new(tweet.attrs[:retweeted_status]) if tweet.attrs[:retweeted_status]
+    if use_retweeted_tweet && tweet.attrs[:retweeted_status]
+      tweet = Twitter::Tweet.new(tweet.attrs[:retweeted_status])
+    end
 
-    text = expand_urls_text(tweet)
-    text = remove_media_urls_in_tweet(tweet, text)
-    text = CGI.unescapeHTML(text)
+    text = tweet_full_text(tweet)
+    text = expand_urls_text(tweet, text) if expand_url
+    text = remove_media_urls_in_tweet(tweet, text) if remove_media_url
+    text = CGI.unescapeHTML(text) if unescape
     text
   end
 
   # @param tweet [Twitter:Tweet]
+  # @param text [String]
   # @return [String]
-  def self.expand_urls_text(tweet)
-    text = tweet_full_text(tweet)
+  def self.expand_urls_text(tweet, text)
     return text unless tweet.uris?
 
     tweet.uris.reverse.each_with_object(text.dup) do |uri, expanded|

data/lib/tweet_sanitizer/twitter_extension.rb

@@ -1,9 +1,20 @@
 module TweetSanitizer
   module TwitterExtension
     refine(Twitter::Tweet) do
+      # Sanitize tweet
+      # @param use_retweeted_tweet [Boolean] Whether use original retweeted tweet if exists
+      # @param expand_url          [Boolean] Whether expand url in tweet (e.g. `t.co` url -> original url)
+      # @param remove_media_url    [Boolean] Whether remove media url in tweet
+      # @param unescape            [Boolean] Whether unescape in tweet (e.g. `(&gt; &lt;)` -> `(> <)`)
       # @return [String]
-      def sanitized_text
-        TweetSanitizer.sanitize(self)
+      def sanitized_text(use_retweeted_tweet: true, expand_url: true, remove_media_url: true, unescape: true)
+        TweetSanitizer.sanitize(
+          self,
+          use_retweeted_tweet: use_retweeted_tweet,
+          expand_url:          expand_url,
+          remove_media_url:    remove_media_url,
+          unescape:            unescape,
+        )
       end
     end
   end

data/lib/tweet_sanitizer/version.rb

@@ -1,3 +1,3 @@
 module TweetSanitizer
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tweet_sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter