fake_friends 0.1.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa126944bb6f960473714414b4cb44a87ed8deef
-  data.tar.gz: bc9568f7a519b8fd8f16585d12a60cc7953a2157
+  metadata.gz: 91c52fe6550cce6abc312dbfccd2743415889406
+  data.tar.gz: e1fda60d62b933d57fd7073f02239e0b48ad3a20
 SHA512:
-  metadata.gz: f4647bda8cbefc8938ccbb4bcf80b644784cfb4852bd041a6894ea1ed8c3c02d1bdcad310cf8e6dd1633740d4fd0e2d606c62ee9665032518109b9cb14ec8b19
-  data.tar.gz: 60ee89b9a857e5b7ca077cf18aee6be1f57256945e97296f81aa56e64f95cf562a5ccb8e649fbff36e59a79ce88afaefacf25507e5f37ca0350615f0280b2c7a
+  metadata.gz: 7fda149947ae5445946d3e0076291e85be64afd91cbca5256a28141463ae8497ccf5e6ee2acd97782547c4ff65ef18a4c61a6a7e84648b2c5835a383ddb38b81
+  data.tar.gz: 47cb69a59f89ab1ba33c1edc85343513efc08260d1fb520bc04a7976ce890c99f3ba330645216e6e74f4c3100d107fd3a68e31d5f4b478198a0761beb958a29d

data/README.md

@@ -1,6 +1,10 @@
 # FakeFriends
 
-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).
+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
+0.1.6 December 2, 2013 (152 KB) Adds tests in RSpec    
+0.1.5 November 26, 2013 (148 KB) Inital release
 
 ## Installation
 
@@ -24,7 +28,7 @@ Or install it yourself as: `$ gem install fake_friends`
 * `#name`
 * `#description`
 * `#avatar_url(size)`     
-  `size`: requested size of image. Available in 128, 64, 48, and 24 px.       
+  `size`: requested size of image. Available in 128, 73, 48, and 24 px.       
    Returns a url to an image in the closest available size.
 * `#url`
 * `#posts`
@@ -42,7 +46,7 @@ to return an array of 5 `FakeFriend` objects.
 returns the fifth user in the library and assigns it to `user`.
 
 `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, 64, 48, and 24. The method will choose the image closest in size
+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`).
@@ -57,14 +61,12 @@ The library currently holds 101 users with associated status updates. Associated
 ## Source
 Images come from user contributions on uiFaces.com.
 Posts are non-retweet tweets from the associated twitter profiles (all public).
-
 Many thanks to these users for their contributions.
 
 
 ## Future work
 
-A hundred users should be enough for most demoing needs, but a method to fetch new user
-data right from the FakeFriends class may be added in future.
+A hundred users should be enough for most demoing needs, but a class method to fetch fresh data from the Twitter API may be added in future.
 
 ## Contributing
 

data/dev/fetch_from_twitter.rb

@@ -0,0 +1,142 @@
+require 'twitter'
+require 'yaml'
+
+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' } )
+
+    @number_of_users      = opt[:users]
+    @max_posts_per_user   = opt[:max_posts_per_user]
+    @output_file_rel_path = opt[:output_file]
+    @avail_users          = YAML.load_file(opt[:user_list])
+
+    @fake_friends   = {} # users to be stored as FakeFriend objects
+    @twitter_client = initialize_twitter_api_client
+  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).'
+
+    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
+    end
+  end
+
+  # ---
+  # returns array of non-retweet tweets, each as a hash containing
+  # the tweet's with :time of creation and :text
+  # ---
+  def posts(twitter_username, count)
+    options = { count: count, exclude_replies: true }
+    twitter_client.user_timeline(twitter_username, options)
+           .delete_if{ |t| t.retweeted || (t.text =~ /^RT\s@/) } # remove retweets
+           .map { |tweet| { time: tweet.created_at, text: tweet.text } }
+  end
+
+  # ---
+  # 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 )
+
+    puts ""
+    users.each_with_index do |username, user_num|
+      fake_friends[username] = create_user_hash_for username
+      update_output_file_with username, user_num
+    end
+
+    puts "Finished fetching users and tweets"
+  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
+  # ---
+  def create_user_hash_for(u)
+    ## Ensure user exists and tweets are public
+    if twitter_client.user?(u)
+      unless twitter_client.user(u).protected?
+
+        user = twitter_client.user(u)  # load user
+        posts = posts(u, max_posts_per_user) # fetch 100 posts
+
+        begin     # get expanded url if it exists
+          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
+        end
+
+        {
+          name: user.name, location: user.location,
+          description: user.description,
+          url: { expanded: expanded_url, display: display_url },
+          image: user.profile_image_url, posts: posts
+        }
+      end
+    end
+  end
+
+  # ---
+  # Updates the ouput file with YAML for the array of
+  # users in its current state
+  # ---
+  def update_output_file_with(user, number)
+    File.open(output_file_rel_path, 'w') do |f|
+      f.write(fake_friends.to_yaml)
+    end
+
+    puts "fetched and saved user #{number+1}: #{user}"
+
+    if number_of_users <= 75
+      # small number fetched in batches, rest every 15th user
+      countdown_minutes(15) if (number+1 % 15 == 0)
+    else
+      # large number fetched at slow, steady pace
+      countdown_minutes(1)
+    end
+  end
+
+  # ---
+  # Displays a countdown timer on the command line
+  # for the given number of minutes
+  # ---
+  def countdown_minutes(min)
+    puts "taking a #{min}-minute power nap to stay within Twitter API rate limits..."
+
+    clock =<<-SHELL
+      MIN=#{min}
+      for i in $(seq $(($MIN*60)) -1 1);
+        do
+          printf "\r%02d:%02d:%02d" $((i/3600)) $(( (i/60)%60)) $((i%60));
+          sleep 1;
+        done
+    SHELL
+
+    system(clock)
+    puts ""
+  end
+end
+
+twitter_api = TweetFetcher.new
+twitter_api.fetch_users_and_their_tweets

data/fake_friends.gemspec

@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # TO BE ADDED
-  # spec.add_runtime_dependency "twitter", "~> 4.8.1"
+  # spec.add_runtime_dependency "twitter", "~> 5.2.0"
 
-  spec.add_development_dependency "twitter", "~> 4.8.1"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "twitter", "~> 5.2.0"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler", "~> 1.3.5"
+  spec.add_development_dependency "rake", "~> 10.1.0"
 end

data/lib/fake_friends/version.rb

@@ -1,3 +1,3 @@
 module FalseFriends
-  VERSION = "0.1.6"
+  VERSION = "1.0.0"
 end

data/lib/fake_friends.rb

@@ -61,7 +61,7 @@ module FakeFriends
     # avatar_url(size)
     # returns the user's uiFaces url in the closest available size
     def avatar_url(size)
-      valid_sizes = [128, 64, 48, 24]
+      valid_sizes = [128, 73, 48, 24]
       size = valid_sizes.min { |a,b| (size-a).abs <=> (size-b).abs }
       "https://s3.amazonaws.com/uifaces/faces/twitter/#{username}/#{size}.jpg"
     end

data/spec/fake_friends_spec.rb

@@ -3,11 +3,7 @@ include FakeFriends
 
 describe FakeFriend do
 
-  # it { should respond_to(:gather).with(1).argument }
-  # it { should respond_to(:find_by).with(1).argument }
-
   describe "::gather" do
-
     context "with valid input" do
       let(:users){ FakeFriend.gather(5) }
 
@@ -16,12 +12,12 @@ describe FakeFriend do
         expect(users).to be_composed_of FakeFriend
       end
 
-      it "returns the requested number objects" do
+      it "returns the requested number of FakeFriends" do
         expect(users.count).to be 5
       end
 
       it "does not return duplicates" do
-        expect(users.uniq.count).to be users.count
+        expect(users.count).to be users.map(&:username).uniq.count
       end
     end
 
@@ -35,6 +31,7 @@ describe FakeFriend do
     end
   end
 
+
   describe "::find_by" do
     context "with valid input (by id)" do
       let(:user){ FakeFriend.find_by(id: 1) }
@@ -72,4 +69,4 @@ describe FakeFriend do
       end
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -11,10 +11,10 @@ end
 
 RSpec::Matchers.define :be_composed_of do |expected_type|
   match do |actual|
-    actual.all?{|u| u.is_a? expected_type} == true
+    actual.all?{|u| u.is_a? expected_type}
   end
 
   failure_message_for_should do |actual|
-    "expected that #{actual.class} would be composed of #{expected_type}s"
+    "expected #{actual.class} to be composed of #{expected_type}s"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fake_friends
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Jake Romer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-02 00:00:00.000000000 Z
+date: 2013-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.8.1
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.8.1
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
 description: A simple fake user generator
 email:
 - jake@jakeromer.com
@@ -79,7 +79,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- dev/pull_from_twitter.rb
+- dev/fetch_from_twitter.rb
 - dev/usernames.yml
 - fake_friends.gemspec
 - lib/fake_friends.rb

data/dev/pull_from_twitter.rb

@@ -1,116 +0,0 @@
-require 'twitter'
-require 'yaml'
-
-# TODO: Method to pull a user from Twitter directly into FakeFriend.find_by(username)
-
-puts 'Enter your Twitter API credentials (get some @ dev.twitter.com).'
-print 'consumer key: '
-twitter_cons_key = gets.chomp
-print 'consumer secret: '
-twitter_cons_sec = gets.chomp
-print 'oauth token: '
-twitter_auth_tok = gets.chomp
-print 'oauth token secret: '
-twitter_auth_sec = gets.chomp
-
-Twitter.configure do |config|
-  config.consumer_key        = twitter_cons_key
-  config.consumer_secret     = twitter_cons_sec
-  config.oauth_token         = twitter_auth_tok
-  config.oauth_token_secret  = twitter_auth_sec
-end
-
-# returns array of non-retweets with time and text
-def posts(twitter_username, count)
-  options = { count: count, exclude_replies: true }
-
-  Twitter.user_timeline(twitter_username, options)
-         .delete_if{ |t| t.retweeted || (t.text =~ /^RT\s@/) } # remove retweets
-         .map do |tweet|
-          { time: tweet.created_at, text: tweet.text }
-          end
-end
-
-
-number_of_users_to_pull = 100
-number_of_posts_to_pull = 50
-
-usernames = 'usernames.yml'
-users     = File.open(usernames, 'r'){|file| YAML.load(file, usernames) }
-users     = users.sample(number_of_users_to_pull)
-friends   = {}
-
-users.each_with_index do |u, i|
-  ## Ensure user exists and tweets are public
-  if Twitter.user?(u)
-    unless Twitter.user(u).protected?
-
-      # load user
-      user = Twitter.user(u)
-
-      # pull 100 posts
-      posts = posts(u, number_of_posts_to_pull)
-
-      # get urls if they exist
-      begin
-        expanded_url = user.attrs[:entities][:url][:urls].first[:expanded_url]
-      rescue
-        expanded_url = nil
-      end
-
-      begin
-        display_url = user.attrs[:entities][:url][:urls].first[:display_url]
-      rescue
-        display_url = nil
-      end
-
-      # populate friends hash
-      friends[u] = {
-        name: user.name,
-        location: user.location,
-        description: user.description,
-        url: { expanded: expanded_url, display: display_url },
-        image: user.profile_image_url,
-        posts: posts
-      }
-    end
-  end
-
-  # write to file as yaml
-  users_lib = '../lib/fake_friends/users.yml'
-  File.open(users_lib, 'w'){|f| f.write(friends.to_yaml) }
-  puts "loaded #{i+1}: #{u}"
-
-  if number_of_users_to_pull <= 75
-    # Twitter API limit: 15 per 15 minutes
-    if (i+1 % 15 == 0)
-      puts "taking a 15-minute power nap to stay within Twitter API rate limits..."
-
-      clock =<<-SHELL
-        MIN=15
-        for i in $(seq $(($MIN*60)) -1 1);
-          do
-            printf "\r%02d:%02d:%02d" $((i/3600)) $(( (i/60)%60)) $((i%60));
-            sleep 1;
-          done
-      SHELL
-
-      system(clock)
-      puts ""
-    end
-  else
-    puts "taking a 1-minute power nap to stay within Twitter API rate limits..."
-
-    clock =<<-SHELL
-      MIN=1
-      for i in $(seq $(($MIN*60)) -1 1);
-        do
-          printf "\r%02d:%02d:%02d" $((i/3600)) $(( (i/60)%60)) $((i%60));
-          sleep 1;
-        done
-    SHELL
-
-    system(clock)
-    puts ""
-  end
-end