tweet_sanitizer 0.1.0.beta1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95ee13f344a020fee8f62754894bff6ce604aa41
-  data.tar.gz: 0dd22db74f75368271ed62f967141dd009290e40
+  metadata.gz: b6373a02a1ea05e0096cdffb9398f175e7f7a9f2
+  data.tar.gz: 12bbee7bc87e4bf0c0765e54f13cf0347d107a48
 SHA512:
-  metadata.gz: b9d8a7efbec32e451c484d4f2b9c0bc85d391d890c299a81cb7ac366a2773e6a3636b064ae21404e001331ae9eec156549cea0c459c63002f1f422edda3605f0
-  data.tar.gz: e075a6c9f8f5e6b29b5ae67e8294edb7f8a69a5f744d552969237a80c59487ef2092b1c87c9ebe85955d15776bfffd5e785fe3bac07a42a6acbd9637ddbb4bd1
+  metadata.gz: 259a3972322175046a8a85256a15870532656e1a482e33d6f2da79089fdbc3421a195da343a9fac062d7a8df8a771e30393fac69db859d911e44571eb0cb2f38
+  data.tar.gz: 07da5186868e2f7ba9fd86131872d2b7d310b1522e581b4949bd1b08a0c4e429bea6ba9a88bce9cc1782237b8c658eee47fef88dc9d6eb5b0ea110c39963fbf2

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: kZmA3FzhK4Oou7s7aQPRcAW0e8RbRlzhD

data/.travis.yml

@@ -1,5 +1,27 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
+- 2.1
+- 2.2
+- 2.3
+- 2.4.1
+- ruby-head
+bundler_args: "--jobs=2"
+cache: bundler
 before_install: gem install bundler -v 1.15.3
+before_script:
+- export CODECLIMATE_REPO_TOKEN=b275edefb84b9adf2e55846adb2c2649072895873f85eacafff3cb9a31aec846
+- export CI=true
+script:
+- bundle exec rspec
+- bundle exec codeclimate-test-reporter
+branches:
+  only:
+  - master
+notifications:
+  email: false
+  slack:
+    secure: Sv+kslA+VVRafEOYfWVM7f+9Tryw+OKFdyqLOodduDexNoLedeqCqYSASJsw33vxgSGhRnWgcCHLzpLdK211bn6H6q3JgKKJQdO9Zxci7iftqn2lXiltL8EdIIHreW7qKYUJhWeM0CCpdLD7R8IGvPv7HbWko2g3JRYqmAmPMBZBU99uX0Sa0pWirEGAY7asqbz4yU2ugCEIRiD5/Ao9y8AltTn4r7m3puIKgm/3WhjJJtasWZFohFf3d/QEybefYoTcEOmRK3WI1yeRC2t0fK55yOLRgndUggSz1DSIad+f+PeyaTG24ErmkaxfGg086OIT8fB/39UNqrxC9xIMWGKLF0g2Xb09JrnvZbl9QVhdTqre/jbaflsQLanSd/nGA3f1uXk/QESL7zYz1qxgXkcREmrQxrZ0yC11L7Xz6nqigkAt/V5/zRM2LOuYBEO+d4hPHAO7IJMyLfppPd8P07QAW9jSmYoDIRqmZfKz/hQ2aUlubc5D64VcLECgbtMUbj6mOEVl4H8ygAJvBOkrx4gJGEU5YxMDDRJt3yAb8VD7Ek2fw5ovLFqkNTp+a8TjksGTA2s2vpNE1dnDhJb6OrCgQNC8hkFkkVhV1V5a0bNuJE+lybErzWzaT/y8YSCCcY8FCytOZOs63zfIWqCDLjJq9/juThUx3hKndYXtc70=
+matrix:
+  allow_failures:
+  - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## Unreleased
+[full changelog](https://github.com/sue445/tweet_sanitizer/compare/v0.1.0...master)
+
+## v0.1.0
+* first release

data/README.md

@@ -1,8 +1,31 @@
 # TweetSanitizer
+[![Gem Version](https://badge.fury.io/rb/tweet_sanitizer.svg)](https://badge.fury.io/rb/tweet_sanitizer)
+[![Build Status](https://travis-ci.org/sue445/tweet_sanitizer.svg?branch=master)](https://travis-ci.org/sue445/tweet_sanitizer)
+[![Code Climate](https://codeclimate.com/github/sue445/tweet_sanitizer.png)](https://codeclimate.com/github/sue445/tweet_sanitizer)
+[![Coverage Status](https://coveralls.io/repos/github/sue445/tweet_sanitizer/badge.svg?branch=master)](https://coveralls.io/github/sue445/tweet_sanitizer?branch=master)
+[![Dependency Status](https://gemnasium.com/badges/github.com/sue445/tweet_sanitizer.svg)](https://gemnasium.com/github.com/sue445/tweet_sanitizer)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tweet_sanitizer`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is extension of [twitter](https://github.com/sferik/twitter). Sanitize `Twitter::Tweet#text`
 
-TODO: Delete this and the text above, and describe your gem
+## Example
+```ruby
+tweet = @client.status("https://twitter.com/github/status/866677968608927744")
+tweet.text
+#=> "Introducing GitHub Marketplace, a new place to browse and buy integrations using your GitHub account.… https://t.co/dK0Tmcmm72"
+```
+
+```ruby
+using TweetSanitizer::TwitterExtension
+
+extended_tweet = @client.status("https://twitter.com/github/status/866677968608927744", tweet_mode: "extended")
+extended_tweet.sanitized_text
+#=> "Introducing GitHub Marketplace, a new place to browse and buy integrations using your GitHub account. https://github.com/blog/2359-introducing-github-marketplace-and-more-tools-to-customize-your-workflow"
+```
+
+## Features
+* Expand urls in `Twitter::Tweet#text` (e.g. `t.co` url -> original url)
+* Remove media urls in `Twitter::Tweet#text`
+* Unescape special html characters in `Twitter::Tweet#text` (e.g. `(&gt; &lt;)` -> `(> <)`)
 
 ## Installation
 
@@ -21,8 +44,28 @@ Or install it yourself as:
     $ gem install tweet_sanitizer
 
 ## Usage
+### Case 1. Use `TweetSanitizer::TwitterExtension` and `Twitter::Tweet#sanitized_text` (Recommended)
+```ruby
+using TweetSanitizer::TwitterExtension
+
+extended_tweet = @client.status("https://twitter.com/github/status/866677968608927744", tweet_mode: "extended")
+extended_tweet.sanitized_text
+```
+
+### Case 2. Use `TweetSanitizer.sanitize`
+```ruby
+extended_tweet = @client.status("https://twitter.com/github/status/866677968608927744", tweet_mode: "extended")
+TweetSanitizer.sanitize(extended_tweet)
+```
+
+### :warning: Note
+When you get `Twitter::Tweet` instance, pass `tweet_mode: "extended"` option to methods. (e.g. `Twitter::REST::Client#status`, `Twitter::REST::Client#search`)
+
+Because `full_text` attribute is returned when **only** `tweet_mode=extended` is passed to Twitter API
+
+See following.
 
-TODO: Write usage instructions here
+https://dev.twitter.com/overview/api/upcoming-changes-to-tweets
 
 ## Development
 
@@ -39,7 +82,7 @@ vi .env
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tweet_sanitizer.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sue445/tweet_sanitizer.
 
 ## License
 

data/bin/console

@@ -15,4 +15,6 @@ Dotenv.load
   config.access_token_secret = ENV["TWITTER_ACCESS_TOKEN_SECRET"]
 end
 
+using TweetSanitizer::TwitterExtension
+
 Pry.start

data/lib/tweet_sanitizer.rb

@@ -1,5 +1,6 @@
-require "tweet_sanitizer/version"
 require "twitter"
+require "tweet_sanitizer/version"
+require "tweet_sanitizer/twitter_extension"
 
 module TweetSanitizer
   # @param tweet [Twitter:Tweet]
@@ -14,24 +15,31 @@ module TweetSanitizer
   # @param tweet [Twitter:Tweet]
   # @return [String]
   def self.expand_urls_text(tweet)
-    text = tweet.text.dup
+    text = tweet_full_text(tweet)
     return text unless tweet.uris?
 
-    tweet.uris.reverse.each_with_object(text) do |uri, expanded|
+    tweet.uris.reverse.each_with_object(text.dup) do |uri, expanded|
       pos1 = uri.indices[0]
       pos2 = uri.indices[1]
       expanded[pos1, pos2-pos1] = uri.expanded_url
     end
   end
 
+  # @param tweet [Twitter:Tweet]
+  # @return [String] `full_text` attribute if exist
+  def self.tweet_full_text(tweet)
+    # NOTE: Twitter::Tweet#full_text doesn't returns full_text attribute
+    # https://github.com/sferik/twitter/blob/v6.1.0/lib/twitter/tweet.rb#L37-L44
+    tweet.attrs[:full_text] || tweet.text
+  end
+
   # @param tweet [Twitter:Tweet]
   # @param text [String]
   # @return [String]
   def self.remove_media_urls_in_tweet(tweet, text)
-    text = text.dup
     return text unless tweet.media?
 
-    tweet.media.each_with_object(text) do |media, t|
+    tweet.media.each_with_object(text.dup) do |media, t|
       t.gsub!(media.url, "")
       t.strip!
     end

data/lib/tweet_sanitizer/twitter_extension.rb

@@ -0,0 +1,10 @@
+module TweetSanitizer
+  module TwitterExtension
+    refine(Twitter::Tweet) do
+      # @return [String]
+      def sanitized_text
+        TweetSanitizer.sanitize(self)
+      end
+    end
+  end
+end

data/lib/tweet_sanitizer/version.rb

@@ -1,3 +1,3 @@
 module TweetSanitizer
-  VERSION = "0.1.0.beta1"
+  VERSION = "0.1.0"
 end

data/tweet_sanitizer.gemspec

@@ -14,6 +14,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/sue445/tweet_sanitizer"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = ">= 2.1.0"
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -24,9 +26,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "twitter"
 
   spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
+  spec.add_development_dependency "coveralls"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-parameterized"
+  spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tweet_sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.1.0
 platform: ruby
 authors:
 - sue445
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-13 00:00:00.000000000 Z
+date: 2017-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: sanitize tweet
 email:
 - sue445@sue445.net
@@ -115,10 +157,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".env.example"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -126,6 +170,7 @@ files:
 - bin/console
 - bin/setup
 - lib/tweet_sanitizer.rb
+- lib/tweet_sanitizer/twitter_extension.rb
 - lib/tweet_sanitizer/version.rb
 - tweet_sanitizer.gemspec
 homepage: https://github.com/sue445/tweet_sanitizer
@@ -140,12 +185,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.11