grailbird_updater 0.2.0 → 0.2.1

data/README.md

@@ -8,14 +8,72 @@ Turns out the contents in the archive are partial/trimmed API responses from
 the Twitter API, so it is actually possible to drop a whole API response in
 there, do some sorting and update the archive.
 
-This currently does not work with a private/protected Twitter account, see 
-[this issue](https://github.com/DeMarko/grailbird_updater/issues/6)
 
-## How do I know if I have a Twitter archive?
+## Installation
+
+Install it yourself as:
+
+    $ gem install grailbird_updater
+
+Or add this line to your application's Gemfile:
+
+    gem 'grailbird_updater'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```
+grailbird_updater /path/to/twitter/archive
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## FAQ
+
+* _I have a protected Twitter account, can I still use this updater with my Twitter archive?_
+
+    Actually, yes! However, you will need to create your own "application" on
+    Twitter and then use your own consumer key/secret pair to let the application
+    use the oauth tokens for a user and then follow the authorization steps for
+    a given protected user.
+
+    Once you have auth'd the application for a protected user, you do not have to do
+    it again, the consumer key/secret and oauth token/secret are stored in a YAML file
+    at the root of your tweet archive.
+
+    __IMPORTANT__ Do NOT commit or post your own consumer key/secret or your oauth
+    token/secret anywhere.
+
+    Note: you will only need to create a single application on Twitter even if you
+    are using this to update multiple protected account. You can reuse the consumer
+    key/secret and just authorize each account individually.
+
+    Please see [this wiki article](https://github.com/DeMarko/grailbird_updater/wiki/Authorizing-grailbird_updater-to-work-with-Protected-Twitter-accounts) for step-by-step instructions.
+
+* _How do I know if I have a Twitter archive?_
+
+    Hopefully, you downloaded it from Twitter once the feature was made available
+    to you and have their web application which can consume it.
+
+    This gem only modifies what's in the `data` directory for a given archive,
+    the rest of the files are provided by Twitter.
+
+    To check if you can download a copy of your Twitter archive, go to your
+    [Account Settings](https://twitter.com/settings/account) and scroll all
+    the way to the bottom. If the feature is enabled for you, you should see
+    a section labeled "Your Twitter Archive".
+
+    The file structure looks somewhat like this (as of 19.12.12):
 
-Hopefully, you downloaded it from Twitter once the feature was made available
-to you and have their web application which can consume it. The file structure
-looks somewhat like this (as of 19.12.12):
 
 ```
 tweets
@@ -52,36 +110,3 @@ tweets
     └─ ... // provided by Twitter
 ```
 
-This gem only modifies what's in the data directory for a given archive, 
-the rest of the files are provided by Twitter. To check if you can download
-a copy of your Twitter archive, go to your [Account Settings](https://twitter.com/settings/account)
-and scroll all the way to the bottom. If the feature is enabled for you, you should 
-see a section labeled "Your Twitter Archive".
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'grailbird_updater'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install grailbird_updater
-
-## Usage
-
-```
-grailbird_updater /path/to/twitter/archive
-```
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/lib/grailbird_updater.rb

@@ -98,19 +98,24 @@ class GrailbirdUpdater
       :include_entities => true}
     twitter_uri.query = URI.encode_www_form(params)
 
-    vputs "Making request to #{twitter_uri}"
+    vputs "\nMaking request to #{twitter_uri}"
     response = Net::HTTP.get_response(twitter_uri)
 
     if response.is_a?(Net::HTTPUnauthorized)
       access_token = do_oauth_dance(screen_name)
       response = access_token.request(:get, twitter_uri.to_s)
+      if response.is_a?(Net::HTTPUnauthorized)
+        puts "\nSomething went wrong trying to authorize grailbird_updater with the account: " + "@#{screen_name}".blue
+        puts "Please delete #{@base_dir}/#{screen_name}_keys.yaml and follow the authorize steps again."
+        exit
+      end
     end
 
     return response.body
   end
 
   def do_oauth_dance(screen_name)
-    puts "It seems " + "@#{screen_name}".blue + " has a protected account."
+    puts "\nIt seems " + "@#{screen_name}".blue + " has a protected account."
     key_file_path = "#{@base_dir}/#{screen_name}_keys.yaml"
     if File.exists?(key_file_path)
         keys = YAML.load_file(key_file_path)
@@ -120,23 +125,23 @@ class GrailbirdUpdater
         token_secret = keys['secret']
     else
       puts <<-EOS
-          To be able to retrieve your protected tweets, you will need a consumer key/secret
+      To be able to retrieve your protected tweets, you will need a consumer key/secret
 
-          Please follow these steps to authorize grailbird_updater to download tweets:
-              1. Go to https://dev.twitter.com/apps/new
-              2. Give it a name (I recommend #{screen_name}_grailbird), description and URL
-              3. Create application
-              4. Go to your application page, you should see a "Consumer key" and a "Consumer secret"
+      Please follow these steps to authorize grailbird_updater to download tweets:
+          1. Go to https://dev.twitter.com/apps/new
+          2. Give it a name (I recommend #{screen_name}_grailbird), description and URL
+          3. Create application
+          4. Go to your application page, you should see a "Consumer key" and a "Consumer secret"
 
-          Note: you will only need to create this application once!
+      Note: you will only need to create this application once!
 
-          So you don't have to enter these again, we'll save a copy of your keys in a file called #{screen_name}_keys.yaml
+      So you don't have to enter these again, we'll save a copy of your keys in a file called #{screen_name}_keys.yaml
 
-          IMPORTANT: Do NOT store the folder of your tweets on a public server. If someone gets access to #{screen_name}_keys.yaml they can access your entire account!
-          Did I mention that was IMPORTANT? BECAUSE IT IS.
+      #{"IMPORTANT".red.blink} Do NOT store the folder of your tweets on a public server. 
+                If someone gets access to #{screen_name}_keys.yaml they can access your entire account!
       EOS
 
-      puts "Enter your 'Consumer key'"
+      puts "\nEnter your 'Consumer key'"
       consumer_key = STDIN.gets.chomp
       puts "Enter your 'Consumer secret'"
       consumer_secret = STDIN.gets.chomp
@@ -149,7 +154,7 @@ class GrailbirdUpdater
           :authorize_path => '/oauth/authorize' }
       )
       request_token = consumer.get_request_token
-      puts "Go to this URL: #{request_token.authorize_url()}"
+      puts "\nGo to this URL: #{request_token.authorize_url()}"
       puts "Authorize the application and you will receive a PIN"
       puts "Enter the PIN here:"
       pin = STDIN.gets.chomp

data/lib/grailbird_updater/version.rb

@@ -1,3 +1,3 @@
 class GrailbirdUpdater
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grailbird_updater
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors: