alltweets 1.1.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: afdb6ffada5c2f392b6f688516d6aaa9e4b2442f
-  data.tar.gz: 55b92feec7640055f5b1a0bbb9939426df016210
+SHA256:
+  metadata.gz: 92146e6194c50c37002547794b336da5feaf3997909799fb2dc74ff1d1f0bab3
+  data.tar.gz: c36a5f0e5275cb84cb6ce09021e5ea56f7ad4132c04d5a6da20d0140a260f402
 SHA512:
-  metadata.gz: 275ba472d8dc176c1d0d6b53a2cbcdcb90e7742bfc335a16508505c3f691c636c4c3bbfc64556864090145bdd60f46a212fa7df83813896c70a1ddb5d087360e
-  data.tar.gz: 3fe5265bc5cdf12735ccf54347345e9a36e4687c7d931fc858519e90368cf8441ddb0f1abc64b12f4601be93ff2af9f35488112451c3ec770e1ff5a8699fbdee
+  metadata.gz: a91de2daddb3406b1b2978ae0b09b1bb0dde4a95b5908df89b695fa314e79a16384185c175778874ae1151d1ec745fab621b2d49a64063b0e5cd9c722c4d7abc
+  data.tar.gz: df0c149c0261c221b975d0f9036490939ae71022ff52fde833e16be5ae5494f89594211bce0c1b3920f1d79310259f40093cd524b8cc5d70cce0d46804046100

data/CHANGELOG.md

@@ -0,0 +1,101 @@
+## [Unreleased]
+
+## [2.0.0] - 2021-06-27
+### Added
+- Detail the token/secret pair message
+- Add error handling when invalid options are specified
+- Rewrite README
+- We finally added CHANGELOG!
+
+### Changed
+- Include retweets
+- Update dependencies
+- Use rainbow instead of colorize
+
+### Removed
+- Remove `-r, --retweets` options
+- Remove `-y, --yaml` options
+- Remove Ruby code description from README
+
+### Fixed
+- Change the author name
+- Fix failed spec
+- Added standard gem to run lint
+
+## [1.1.3] - 2016-12-10
+### Changed
+- Update dependencies
+
+## [1.1.2] - 2016-12-10
+### Changed
+- Update description
+
+### Removed
+- Remove additional dependency and using optparse standard library
+
+### Fixed
+- Add missing requirements
+
+## [1.1.1] - 2016-09-13
+### Fixed
+- Change settings file permissions to `0600`
+
+## [1.1.0] - 2016-05-11
+### Added
+- Add Ruby code example to README
+
+### Changed
+- Don't open the browser automatically
+- Rename class name: `Collector` => `Fetcher`
+- Rename method name: `Fetcher#get_all_tweets` => `Fetcher#fetch_all_tweets`
+- Allow `Fetcher#initialize` to be passed `Twitter::REST::Client` as an argument
+- Change default `include_rts` from `false` to `true`. Note that only the default values have been changed when running the Ruby code directly, not when running alltweets from the command line
+
+## [1.0.2] - 2016-03-15
+### Changed
+- Update description
+
+### Fixed
+- Continue processing even if opening browser is failed
+
+## [1.0.1] - 2016-03-08
+### Changed
+- Update description
+
+### Removed
+- Remove Oj dependency
+
+### Fixed
+- Fix typo of gemfile homepage URL
+
+## [1.0.0] - 2016-02-04
+### Changed
+- Update dependencies
+- Print result to stdout instead of a file
+- Change default format from YAML to JSON
+- Print system messages to stderr instead of stdout
+
+### Fixed
+- Show an error if multiple username is given
+- Return a status code 1 if an error occurs
+- Support old Ruby 2.0 syntax
+
+## [0.1.3] - 2015-12-17
+### Changed
+- Change consumer key/secret
+- Update description
+- Update dependencies
+
+## [0.1.2] - 2015-11-10
+### Changed
+- Update description
+
+## [0.1.1] - 2015-10-30
+### Fixed
+- Show an error if username is not specified
+- Change the author name
+
+
+## [0.1.0] - 2015-07-29
+### Added
+- Initial release

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in alltweets.gemspec
 gemspec

data/README.md

@@ -1,62 +1,36 @@
-# AllTweets
+# alltweets
 
 Downloads someone's all tweets.
 
 ## Installation
 
-```
+```zsh
 $ gem install alltweets
 ```
 
 ## Usage
 
-### Commands
+Just specify the username. The results will be retrieved as JSON data and displayed on the stdout.
 
-* `alltweets [options] SCREEN_NAME`: Download SCREEN_NAME's all tweets.
+```zsh
+$ alltweets tatzyr > tweets.json
+```
 
-### Options
+## Options
 
-* `-r`, `--retweets`: Include retweets
-* `-y`, `--yaml`: Use YAML instead of JSON
 * `-v`, `--version`: Print version and exit
 * `-h`, `--help`: Show help message
 
-### Example
-
-* `alltweets tatzyr`: Download @tatzyr's all tweets.
-* `alltweets -r tatzyr`: Download @tatzyr's all tweets including retweets.
-* `alltweets -y tatzyr`: Download @tatzyr's all tweets as YAML instead of JSON.
-
-### Using AllTweets from Ruby
-
-```ruby
-require "alltweets"
+## Limitations
 
-fetcher = AllTweets::Fetcher.new(
-  consumer_key: "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
-  consumer_secret: "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
-  access_token: "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
-  access_token_secret: "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
-)
-
-# # alternatively
-# require "twitter"
-# client = Twitter::REST::Client.new(...)
-# fetcher = AllTweets::Fetcher.new(client)
-
-fetcher.fetch_all_tweets("tatzyr")
-# => [#<Twitter::Tweet id=...>, #<Twitter::Tweet id=...>, ...]
-
-fetcher.fetch_all_tweets("tatzyr", include_retweets: false)
-# => [#<Twitter::Tweet id=...>, #<Twitter::Tweet id=...>, ...]
-```
+alltweets can only retrieve 3200 tweets due to Twitter API limitations.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec alltweets` to use the gem in this directory, ignoring other installed copies of this gem.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` and `rake standard` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec alltweets` to use the gem in this directory, ignoring other installed copies of this gem.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Tatzyr/alltweets.
+Bug reports and pull requests are welcome on GitHub at https://github.com/tatzyr/alltweets.

data/Rakefile

@@ -1,6 +1,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "standard/rake"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/alltweets.gemspec

@@ -1,27 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'alltweets/version'
+require "alltweets/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "alltweets"
-  spec.version       = AllTweets::VERSION
-  spec.authors       = ["Tatsuya Otsuka"]
-  spec.email         = ["tatzyr@gmail.com"]
+  spec.name = "alltweets"
+  spec.version = AllTweets::VERSION
+  spec.authors = ["Tatsuya Otsuka"]
+  spec.email = ["tatzyr@gmail.com"]
 
-  spec.summary       = %q{Downloads someone's all tweets.}
-  spec.homepage      = "https://github.com/Tatzyr/alltweets"
+  spec.summary = "Downloads someone's all tweets."
+  spec.homepage = "https://github.com/tatzyr/alltweets"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "colorize", "~> 0.8.1"
-  spec.add_dependency "oauth", "~> 0.5.1"
-  spec.add_dependency "twitter", "~> 6.0"
+  spec.add_dependency "oauth", "~> 0.5"
+  spec.add_dependency "rainbow", "~> 3.0"
+  spec.add_dependency "twitter", "~> 7.0"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "standard"
 end

data/lib/alltweets/cli.rb

@@ -1,58 +1,39 @@
-require "colorize"
 require "json"
 require "optparse"
-require "yaml"
+require "rainbow/ext/string"
 require "alltweets/fetcher"
 require "alltweets/settings"
 require "alltweets/version"
 
 module AllTweets
   class CLI
-    def initialize
+    def run
+      Rainbow.enabled = true # forcing coloring even when stdout/stderr is not a tty
       @screen_name, @opts = parse_args
       @settings = Settings.new
       update_access_token
-      @fetcher = Fetcher.new(
-        consumer_key: @settings.consumer_key,
-        consumer_secret: @settings.consumer_secret,
-        access_token: @settings.access_token,
-        access_token_secret: @settings.access_token_secret
-      )
-    end
-
-    def run
-      warn "Downloading @#{@screen_name}'s all tweets"
-      result = @fetcher.fetch_all_tweets(@screen_name, include_retweets: @opts["retweets"]).map(&:to_h)
-
-      if @opts["yaml"]
-        dump_data = YAML.dump(result)
-      else
-        dump_data = JSON.dump(result)
-      end
-
-      puts dump_data
+      fetch_and_print
     rescue
-      warn "Error: #{$!}".colorize(:red)
+      warn "Error: #{$!}".color(:red)
       exit 1
     end
 
     private
+
     def parse_args
-      opts = ARGV.getopts("", "retweets", "yaml", "help", "version")
+      opts = ARGV.getopts("", "help", "version")
 
       if opts["help"]
-        puts <<EOS
-alltweets #{VERSION}
-
-Usage:
-  alltweets [options] SCREEN_NAME
-
-Options:
-  -r, --retweets    Include retweets
-  -y, --yaml        Use YAML instead of JSON
-  -v, --version     Print version and exit
-  -h, --help        Show this message
-EOS
+        puts <<~EOS
+          alltweets #{VERSION}
+          
+          Usage:
+            alltweets [options] SCREEN_NAME
+          
+          Options:
+            -v, --version     Print version and exit
+            -h, --help        Show this message
+        EOS
         exit
       end
 
@@ -80,15 +61,31 @@ EOS
         )
         request_token = consumer.get_request_token
 
-        warn "1) Open: #{request_token.authorize_url}".colorize(:cyan)
-        $stderr.print "2) Enter the PIN: ".colorize(:cyan)
+        warn "You need to get token/secret pair of Twitter OAuth.".color(:cyan)
+        warn "The token/secret pair will be saved to #{@settings.filename}".color(:cyan)
+        warn "".color(:cyan)
+        warn "1) Open: #{request_token.authorize_url}".color(:cyan)
+        $stderr.print "2) Enter the PIN: ".color(:cyan)
         pin = $stdin.gets.strip
 
         access_token = request_token.get_access_token(oauth_verifier: pin)
 
-        warn "Saving access token and access token secret to #{@settings.filename}"
         @settings.add_access_tokens(access_token.token, access_token.secret)
+        warn "Saved the token/secret pair to #{@settings.filename}".color(:cyan)
       end
     end
+
+    def fetch_and_print
+      fetcher = Fetcher.new(
+        consumer_key: @settings.consumer_key,
+        consumer_secret: @settings.consumer_secret,
+        access_token: @settings.access_token,
+        access_token_secret: @settings.access_token_secret
+      )
+
+      warn "Downloading @#{@screen_name}'s all tweets..."
+      result = fetcher.fetch_all_tweets(@screen_name).map(&:to_h)
+      puts JSON.dump(result)
+    end
   end
 end

data/lib/alltweets/fetcher.rb

@@ -3,24 +3,25 @@ require "twitter"
 module AllTweets
   class Fetcher
     def initialize(arg)
-      case arg
+      @client = case arg
       when Hash
-        @client = Twitter::REST::Client.new(arg)
+        Twitter::REST::Client.new(arg)
       else
-        @client = arg
+        arg
       end
     end
 
     def fetch_all_tweets(user, include_retweets: true)
       collect_with_max_id do |max_id|
-        options = { count: 200, include_rts: include_retweets }
+        options = {count: 200, include_rts: include_retweets}
         options[:max_id] = max_id unless max_id.nil?
         @client.user_timeline(user, options)
       end
     end
 
     private
-    def collect_with_max_id(collection=[], max_id = nil, &block)
+
+    def collect_with_max_id(collection = [], max_id = nil, &block)
       response = yield(max_id)
       collection += response
       if response.empty?

data/lib/alltweets/settings.rb

@@ -5,10 +5,10 @@ module AllTweets
   class Settings
     INITIAL_SETTINGS = {
       consumer_key: "GyRoi6Jx4T4olW1Rfwgfaa5kv",
-      consumer_secret: "OHx2XugBhtg7kuI4yaPANXh3rplREN0Si8CoLzVWYpkeDyH3NJ",
+      consumer_secret: "OHx2XugBhtg7kuI4yaPANXh3rplREN0Si8CoLzVWYpkeDyH3NJ"
     }
 
-    def initialize(filename = File.expand_path('~/.alltweets'))
+    def initialize(filename = File.expand_path("~/.alltweets"))
       @filename = filename
       @settings = load_file
     end
@@ -32,6 +32,7 @@ module AllTweets
     end
 
     private
+
     def load_file
       return INITIAL_SETTINGS unless exist?
 
@@ -39,7 +40,7 @@ module AllTweets
     end
 
     def dump_file
-      open(@filename, "w", 0600) do |f|
+      File.open(@filename, "w", 0o600) do |f|
         YAML.dump(@settings, f)
       end
     end

data/lib/alltweets/version.rb

@@ -1,3 +1,3 @@
 module AllTweets
-  VERSION = "1.1.3"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: alltweets
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Tatsuya Otsuka
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-12-10 00:00:00.000000000 Z
+date: 2021-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: oauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: oauth
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: twitter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: standard
+  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:
 email:
 - tatzyr@gmail.com
 executables:
@@ -104,7 +118,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -118,10 +132,10 @@ files:
 - lib/alltweets/fetcher.rb
 - lib/alltweets/settings.rb
 - lib/alltweets/version.rb
-homepage: https://github.com/Tatzyr/alltweets
+homepage: https://github.com/tatzyr/alltweets
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,9 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.2.21
+signing_key:
 specification_version: 4
 summary: Downloads someone's all tweets.
 test_files: []

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.10.6