grailbird_updater 0.2.1 → 0.3.0

data/lib/grailbird_updater.rb

@@ -4,6 +4,36 @@ class GrailbirdUpdater
 
   KEEP_FIELDS = {'user' => ['name', 'screen_name', 'protected', 'id_str', 'profile_image_url_https', 'id', 'verified']}
 
+  class JsFile
+    # Read UTF-8 file and return hash of contents (files being read contain JS arrays)
+    #
+    # @param file_path [String] path to file being read
+    def self.read(file_path)
+      file_contents = open(file_path).read.force_encoding("UTF-8").split("\n").join(" ")
+      json_file_contents = file_contents.gsub(/^((var)?\s*(.+?)\s+=\s+)/m, '')
+      return JSON.parse(json_file_contents)
+    end
+
+    # Checks if file being read exists, stops everything if it doesn't
+    #
+    # @param file_path [String] path to file being read
+    # @raise [IOError] if the required file isn't found
+    def self.read_required(file_path)
+      raise IOError "#{file_path} must exist" unless File.exists?(file_path)
+      read(file_path)
+    end
+
+    # Write files Twitter's Archive app likes with specific headings
+    #
+    # @param contents [Object] object whose contents are to be written to the file
+    # @param file_path [String] path to file being written
+    # @param heading [String] heading for file, usually "var Something"
+    def self.write_with_heading(contents, file_path, heading)
+      json_pretty_contents = JSON.pretty_generate(contents)
+      File.open(file_path, 'w') {|f| f.write("#{heading} = #{json_pretty_contents}")}
+    end
+  end
+
   def initialize(dir, count, verbose, prune)
     @base_dir = dir
     data_path = dir + "/data"
@@ -17,23 +47,22 @@ class GrailbirdUpdater
 
   def update_tweets
     # find user_id in data/js/user_details.js
-    user_details = read_required_twitter_js_file("#{@js_path}/user_details.js")
+    user_details = GrailbirdUpdater::JsFile.read_required("#{@js_path}/user_details.js")
     user_id = user_details["id"]
     screen_name = user_details["screen_name"]
     vputs "Twitter Archive for " + "@#{screen_name}".light_blue + " (##{user_id}) found"
 
     # find archive details
-    archive_details = read_required_twitter_js_file("#{@js_path}/payload_details.js")
+    archive_details = GrailbirdUpdater::JsFile.read_required("#{@js_path}/payload_details.js")
     vputs "Found archive payload containing #{archive_details['tweets']} tweets, created at #{archive_details['created_at']}"
 
     # find latest month file (should be last when sorted alphanumerically)
     twitter_js_files = Dir.glob("#{@js_path}/tweets/*.js")
-    latest_month = read_required_twitter_js_file(twitter_js_files.sort.last)
+    latest_month = GrailbirdUpdater::JsFile.read_required(twitter_js_files.sort.last)
 
     # find last_tweet_id in latest_month (should be first, because Twitter)
     last_tweet = latest_month.first
     last_tweet_id = last_tweet["id_str"]
-    last_tweet_date = Date.parse(last_tweet["created_at"])
 
     vputs "Last tweet in archive is\n\t" + display_tweet(last_tweet)
 
@@ -53,38 +82,27 @@ class GrailbirdUpdater
     end
 
     # add tweets to json data file
-    tweet_index = read_required_twitter_js_file("#{@js_path}/tweet_index.js")
+    tweet_index = GrailbirdUpdater::JsFile.read_required("#{@js_path}/tweet_index.js")
     collected_months.each do |year_month, month_tweets|
       month_path = "#{@js_path}/tweets/#{year_month}.js"
 
-      existing_month_tweets = (File.exists?(month_path)) ? read_twitter_js_file(month_path) : []
+      existing_month_tweets = (File.exists?(month_path)) ? GrailbirdUpdater::JsFile.read(month_path) : []
       all_month_tweets = month_tweets | existing_month_tweets
       # sort new collection of tweets for this month by reverse date
       all_month_tweets.sort_by {|t| -Date.parse(t['created_at']).strftime("%s").to_i }
 
       # overwrite existing file (or create new if doesn't exist)
-      write_twitter_js_to_path_with_heading(all_month_tweets, "#{@js_path}/tweets/#{year_month}.js", "Grailbird.data.tweets_#{year_month}")
+      GrailbirdUpdater::JsFile.write_with_heading(all_month_tweets, "#{@js_path}/tweets/#{year_month}.js", "Grailbird.data.tweets_#{year_month}")
       tweet_index = update_tweet_index(tweet_index, year_month, month_tweets.length)
     end
 
     # write new tweet_index.js once
-    write_twitter_js_to_path_with_heading(tweet_index, "#{@js_path}/tweet_index.js", "var tweet_index")
+    GrailbirdUpdater::JsFile.write_with_heading(tweet_index, "#{@js_path}/tweet_index.js", "var tweet_index")
 
     # add count to payload_details.js
     archive_details['tweets'] += tweets.length
     archive_details['updated_at'] = Time.now.getgm.strftime("%a %b %d %T %z %Y")
-    write_twitter_js_to_path_with_heading(archive_details, "#{@js_path}/payload_details.js", "var payload_details")
-  end
-
-  def read_required_twitter_js_file(file_path)
-    raise "#{file_path} must exist" unless  File.exists?(file_path)
-    read_twitter_js_file(file_path)
-  end
-
-  def read_twitter_js_file(file_path)
-    file_contents = open(file_path).read.force_encoding("UTF-8").split("\n").join(" ")
-    json_file_contents = file_contents.gsub(/^((var)?\s*(.+?)\s+=\s+)/m, '')
-    return JSON.parse(json_file_contents)
+    GrailbirdUpdater::JsFile.write_with_heading(archive_details, "#{@js_path}/payload_details.js", "var payload_details")
   end
 
   def get_twitter_user_timeline_response(screen_name, user_id, last_tweet_id, count)
@@ -98,7 +116,7 @@ class GrailbirdUpdater
       :include_entities => true}
     twitter_uri.query = URI.encode_www_form(params)
 
-    vputs "\nMaking request to #{twitter_uri}"
+    vputs "\nMaking request to #{twitter_uri}\n"
     response = Net::HTTP.get_response(twitter_uri)
 
     if response.is_a?(Net::HTTPUnauthorized)
@@ -137,7 +155,7 @@ class GrailbirdUpdater
 
       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".red.blink} Do NOT store the folder of your tweets on a public server. 
+      #{"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
 
@@ -187,7 +205,6 @@ class GrailbirdUpdater
     return access_token
   end
 
-
   def prune_tweet(tweet)
     KEEP_FIELDS.each do |parent_field, field_names|
       tweet[parent_field].delete_if { |key, value| !field_names.include?(key) }
@@ -225,11 +242,6 @@ class GrailbirdUpdater
     return tweet_index.unshift(new_month).sort_by {|m| [-m['year'], -m['month']]}
   end
 
-  def write_twitter_js_to_path_with_heading(contents, path, heading)
-    json_pretty_contents = JSON.pretty_generate(contents)
-    File.open(path, 'w') {|f| f.write("#{heading} = #{json_pretty_contents}")}
-  end
-
   private
 
   # only puts if we're verbose

data/lib/grailbird_updater/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grailbird_updater
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-23 00:00:00.000000000 Z
+date: 2012-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -106,3 +106,4 @@ summary: A way to keep an updated archive of Twitter tweets.
 test_files:
 - test/grailbird_updater_test.rb
 - test/test_helper.rb
+has_rdoc: