fake_friends 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d060a2e210db540b54d69e31c77119dda83fb339
-  data.tar.gz: 864176c9c950e903a21951cbd63534ef9a8bb9f7
+  metadata.gz: 7fa347b02b31c2cda971456e866fff0c9050cab3
+  data.tar.gz: c93a5bd06c8fc75a765a909a3ea8d897b223207b
 SHA512:
-  metadata.gz: 75fb2ced330d3f161fdc5a9e5b7d4966f8a5780ed26b80cf5b6b78f73f084314e525cb243a5f7e2d143819468c3a35187fe4a6471280da8483a2b2e2e8282c38
-  data.tar.gz: 0ae9b218e5732ed6afbf74d48e03d6e89990a4942a9dc904f739ccb762371729d38e7630d9868b78716fb8f9a2f95cc87c2581119e2731c6e2bf991fec3bb522
+  metadata.gz: 7f9b02a59830956ed2be01dd9ec8634f6a407816432c6d70f364fca54ec641b9505b40e498504dff7a1b8d2ba0348824848328ca792e42034b1b60416edc0df7
+  data.tar.gz: fd363a0e634549019d7ac362981342d48c3fea158c3801c503c7d76d4b1b9f899cf4e2046c8bdd613e2de0a898ded71568c4437510035ccd7b30e686b9eab435

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+application.yml

data/README.md

@@ -1,14 +1,21 @@
 # FakeFriends
 
 [![Gem Version](https://badge.fury.io/rb/fake_friends.png)](http://badge.fury.io/rb/fake_friends)
-[![Code Climate](https://codeclimate.com/github/jmromer/FakeFriends.png)](https://codeclimate.com/github/jmromer/FakeFriends)
-[![Dependency Status](https://gemnasium.com/jmromer/FakeFriends.png)](https://gemnasium.com/jmromer/FakeFriends)
-[![Build Status](https://travis-ci.org/jmromer/FakeFriends.png?branch=master)](https://travis-ci.org/jmromer/FakeFriends)
+[![Code Climate](https://codeclimate.com/github/jkrmr/fake_friends.png)](https://codeclimate.com/github/jkrmr/fake_friends)
+[![Build Status](https://travis-ci.org/jkrmr/fake_friends.png?branch=master)](https://travis-ci.org/jkrmr/fake_friends)
+[![Dependency Status](https://gemnasium.com/jkrmr/fake_friends.svg)](https://gemnasium.com/jkrmr/fake_friends)
 
-A simple [ruby gem](https://rubygems.org/gems/fake_friends) to generate consistent and realistic fake user data for demoing social networking apps (e.g., user names match their avatars, fake posts are pulled from actual Twitter posts rather than lorem text, etc), modeled on the popular [Faker](https://github.com/stympy/faker) gem.
+
+A simple [ruby gem](https://rubygems.org/gems/fake_friends) to generate
+consistent and realistic fake user data for demoing social networking apps
+(e.g., user names match their avatars, fake posts are pulled from actual Twitter
+posts rather than lorem text, etc), modeled on the popular
+[faker](https://github.com/stympy/faker) gem.
 
 
 ## Release Notes
+**1.0.2** Refreshes user library contents, goes back to 100 users, makes `::all` public<br>
+**1.0.1** Clarifies documentation, updates dependencies, fixes gemspec typos<br>
 **1.0.0** Rewrites fetch script and updates it for Twitter API v1.1 (backwards incompatible), minor bug fixed<br>
 **0.1.6** Adds tests in RSpec<br>
 **0.1.5** Inital release<br>
@@ -24,17 +31,18 @@ Or install it yourself as: `$ gem install fake_friends`<br>
 ## The FakeFriend class
 
 #### class methods
-* `::gather(n)`
+* `::gather(n)`<br>
   `n`: int (number of user objects to create)
-* `::find_by(options)`
-  `options`: { `username:` string (twitter username) } or { `id:` int (from 1 to 101) }
+* `::find_by(options)`<br>
+  `options`: { `username:` string (twitter username) } or { `id:` int (from 1 to 100) }
+* `::all`
 
 #### instance methods
 * `#username`
 * `#name`
 * `#description`
 * `#avatar_url(size)`
-  `size`: requested size of image. Available in 128, 73, 48, and 24 px.
+  `size`: requested size of image. Available in 128, 73, 48, and 24 px.<br>
    Returns a url to an image in the closest available size.
 * `#url`
 * `#posts`
@@ -49,11 +57,13 @@ to return an array of 5 `FakeFriend` objects.
 
     user = FakeFriend.find_by(id: 5)
 
-returns the fifth user in the library and assigns it to `user`.
+returns the fifth user in the library and assigns it to `user`, and use
+
+    FakeFriend.all
+
+to return all the users in the library.
 
-`user.avatar_url(size)` pulls an avatar from uiFaces.com, where Twitter users have contributed their profile photos.
-The available sizes (in pixels) are 128, 73, 48, and 24. The method will choose the image closest in size
-to the requested `size`.
+`user.avatar_url(size)` pulls an avatar from uiFaces.com, where Twitter users have contributed their profile photos. The available sizes (in pixels) are 128, 73, 48, and 24. The method will choose the image closest in size to the requested `size`.
 
 `user.url` returns a hash with an `:expanded` url (e.g. `http://www.google.com`) and a `:display` url (e.g. `google.com`).
 
@@ -62,11 +72,11 @@ to the requested `size`.
 
 ## Data
 
-The library currently holds 101 users with associated status updates. Associated image urls are generated from the username.
+The library currently holds 100 users with associated status updates. Associated image urls are generated from the username.
 
 ## Source
-Images come from user contributions on uiFaces.com.
-Posts are non-retweet tweets from the associated twitter profiles (all public).
+Images come from user contributions on uiFaces.com.<br>
+Posts are non-retweet tweets from the associated twitter profiles (all public).<br>
 Many thanks to these users for their contributions.
 
 

data/Rakefile

@@ -1,5 +1,18 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yaml'
 
 RSpec::Core::RakeTask.new('spec')
 task default: :spec
+
+
+namespace :fake_friends do
+  desc 'Re-generates library with fresh data from twitter'
+  task :refresh do
+    credentials = YAML.load_file('application.yml')
+    credentials.each_pair{ |key, val| ENV[key] = val }
+    ruby "dev/fetch_from_twitter.rb"
+  end
+end
+
+

data/dev/fetch_from_twitter.rb

@@ -1,13 +1,15 @@
 require 'twitter'
 require 'yaml'
 
+PROJ_ROOT = File.expand_path("../../", __FILE__)
+
 class TweetFetcher
   attr_reader :twitter_client, :number_of_users, :max_posts_per_user,
               :avail_users, :output_file_rel_path, :fake_friends
 
-  def initialize(opt={ users: 100, max_posts_per_user: 50,
-                       user_list: 'usernames.yml',
-                       output_file: '../lib/fake_friends/users.yml' } )
+  def initialize(opt={ users: 100, max_posts_per_user: 60,
+                       user_list: "#{PROJ_ROOT}/dev/usernames.yml",
+                       output_file: "#{PROJ_ROOT}/lib/fake_friends/users.yml" } )
 
     @number_of_users      = opt[:users]
     @max_posts_per_user   = opt[:max_posts_per_user]
@@ -16,23 +18,19 @@ class TweetFetcher
 
     @fake_friends   = {} # users to be stored as FakeFriend objects
     @twitter_client = initialize_twitter_api_client
+    puts "\nTwitter API credentials set."
   end
 
   # ---
   # prompts for twitter api credentials and returns a client
   # ---
   def initialize_twitter_api_client
-    puts 'Enter your Twitter API credentials (get some @ dev.twitter.com).'
-
+    puts "\nEnter your Twitter API credentials (get some @ dev.twitter.com)."
     Twitter::REST::Client.new do |config|
-      print 'consumer key: '
-      config.consumer_key        = gets.chomp
-      print 'consumer secret: '
-      config.consumer_secret     = gets.chomp
-      print 'oauth token: '
-      config.oauth_token         = gets.chomp
-      print 'oauth token secret: '
-      config.oauth_token_secret  = gets.chomp
+      config.consumer_key        = ENV["API_KEY"]   || prompt_for('api key')
+      config.consumer_secret     = ENV["API_SEC"]   || prompt_for('api secret')
+      config.access_token        = ENV["TOKEN"]     || prompt_for('access token')
+      config.access_token_secret = ENV["TOKEN_SEC"] || prompt_for('access token secret')
     end
   end
 
@@ -51,13 +49,19 @@ class TweetFetcher
   # Fetches users and their tweets, iteratively saves them to file as YAML
   # ---
   def fetch_users_and_their_tweets
-    users = avail_users.sample( number_of_users )
+    users = avail_users.take(number_of_users)
 
-    puts ""
     users.each_with_index do |username, user_num|
-      if user_exists_and_tweets_are_public?(username)
-        fake_friends[username] = create_user_hash_for(username)
-        update_output_file_with(username, user_num)
+      begin
+        if user_exists_and_tweets_are_public?(username)
+          fake_friends[username] = create_user_hash_for(username)
+          update_output_file_with(username, user_num)
+        else
+          puts "user #{username} no longer exists or does not have a public account."
+        end
+      rescue Twitter::Error::RequestTimeout
+        countdown_minutes(1)
+        retry
       end
     end
 
@@ -67,38 +71,43 @@ class TweetFetcher
   private
 
   # ---
-  # helper method
+  # Prompts for user input, returns string
+  # ---
+  def prompt_for(string)
+    print "#{string}: "
+    gets.chomp
+  end
+
+  # ---
+  # Returns true only if the requested account exists and is public
   # ---
   def user_exists_and_tweets_are_public?(u)
     twitter_client.user?(u) && !twitter_client.user(u).protected?
+  rescue Twitter::Error::Forbidden
+    false
   end
 
   # ---
   # For a given Twitter user, returns a hash with the following strings:
   # name, location, description, url[:expanded], url[:display], image url
-  # and an array containing the desired number of tweets
+  # and an array containing the desired maximum number of tweets
   # ---
   def create_user_hash_for(u)
     user  = twitter_client.user(u)       # load user
-    posts = posts(u, max_posts_per_user) # fetch 100 posts
+    posts = posts(u, max_posts_per_user) # fetch <= 100 posts
 
-    begin     # get expanded url if it exists
+    begin     # get urls if they exist
       expanded_url = user.attrs[:entities][:url][:urls].first[:expanded_url]
-    rescue
-      expanded_url = nil
-    end
-
-    begin     # get display url if it exists
-      display_url = user.attrs[:entities][:url][:urls].first[:display_url]
-    rescue
-      display_url = nil
+      display_url  = user.attrs[:entities][:url][:urls].first[:display_url]
+    rescue NoMethodError
+      expanded_url = display_url = nil
     end
 
     {
       name: user.name, location: user.location,
       description: user.description,
       url: { expanded: expanded_url, display: display_url },
-      image: user.profile_image_url, posts: posts
+      image: user.profile_image_url.to_s, posts: posts
     }
   end
 
@@ -111,7 +120,7 @@ class TweetFetcher
       f.write(fake_friends.to_yaml)
     end
 
-    puts "fetched and saved user #{number+1}: #{user}"
+    puts "\nfetched and saved user #{number+1}: #{user}"
 
     if number_of_users <= 75
       # small number fetched in batches, rest every 15th user
@@ -130,7 +139,7 @@ class TweetFetcher
     puts "taking a #{min}-minute power nap to stay within Twitter API rate limits..."
     seconds = (min * 60).to_i
 
-    (1..seconds).reverse_each do |sec|
+    seconds.downto 0 do |sec|
       print "\r%02d:%02d:%02d" % [ sec / 3600, sec / 60, sec % 60 ]
       $stdout.flush
       sleep 1

data/dev/usernames.yml

@@ -62,8 +62,6 @@
 - igorgarybaldi
 - marakasina
 - areus
-- fuck_you_two
-- abdullindenis
 - andyisonline
 - damenleeturks
 - devankoshal

data/fake_friends.gemspec

@@ -4,27 +4,21 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fake_friends/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fake_friends"
+  spec.name          = 'fake_friends'
   spec.version       = FakeFriends::VERSION
-  spec.authors       = ["Jake Romer"]
-  spec.email         = ["jacob.romer@icloud.com"]
-  spec.description   = %q{A simple fake user generator}
-  spec.summary       = %q{Generates fake users with consistent
-                        attributes from public Twitter accounts
-                        and image urls from uiFaces.com.}
-  spec.homepage      = "http://github.com/jmromer/FakeFriends"
-  spec.license       = "MIT"
+  spec.authors       = ['Jake Romer']
+  spec.email         = ['jacob.romer@icloud.com']
+  spec.description   = 'A simple fake user generator'
+  spec.summary       = 'Generates fake users with consistent attributes from public Twitter accounts and image urls from uiFaces.com.'
+  spec.homepage      = 'http://github.com/jkrmr/fake_friends'
+  spec.license       = 'MIT'
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  # TO BE ADDED
-  # spec.add_runtime_dependency "twitter", "~> 5.6.0"
-
-  spec.add_development_dependency "twitter", "~> 5.6.0"
-  spec.add_development_dependency "rspec", "~> 2.14.1"
-
-  spec.add_development_dependency "bundler", "~> 1.5.2"
-  spec.add_development_dependency "rake", "~> 10.1.0"
+  spec.add_development_dependency 'twitter', '~> 5.6'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.1'
 end