fake_friends 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91c52fe6550cce6abc312dbfccd2743415889406
-  data.tar.gz: e1fda60d62b933d57fd7073f02239e0b48ad3a20
+  metadata.gz: d060a2e210db540b54d69e31c77119dda83fb339
+  data.tar.gz: 864176c9c950e903a21951cbd63534ef9a8bb9f7
 SHA512:
-  metadata.gz: 7fda149947ae5445946d3e0076291e85be64afd91cbca5256a28141463ae8497ccf5e6ee2acd97782547c4ff65ef18a4c61a6a7e84648b2c5835a383ddb38b81
-  data.tar.gz: 47cb69a59f89ab1ba33c1edc85343513efc08260d1fb520bc04a7976ce890c99f3ba330645216e6e74f4c3100d107fd3a68e31d5f4b478198a0761beb958a29d
+  metadata.gz: 75fb2ced330d3f161fdc5a9e5b7d4966f8a5780ed26b80cf5b6b78f73f084314e525cb243a5f7e2d143819468c3a35187fe4a6471280da8483a2b2e2e8282c38
+  data.tar.gz: 0ae9b218e5732ed6afbf74d48e03d6e89990a4942a9dc904f739ccb762371729d38e7630d9868b78716fb8f9a2f95cc87c2581119e2731c6e2bf991fec3bb522

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 1.9.3
+  - ruby-head
+

data/README.md

@@ -1,34 +1,40 @@
 # 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)
+
 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
+## Release Notes
+**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>
 
-Add this line to your application's Gemfile: `gem 'fake_friends'`
 
-And then execute: `$ bundle`
+## Installation
 
-Or install it yourself as: `$ gem install fake_friends`
+Add this line to your application's Gemfile: `gem 'fake_friends'`<br>
+And then execute: `$ bundle`<br>
+Or install it yourself as: `$ gem install fake_friends`<br>
 
 
 ## The FakeFriend class
 
 #### class methods
-* `::gather(n)`      
+* `::gather(n)`
   `n`: int (number of user objects to create)
-* `::find_by(options)`      
+* `::find_by(options)`
   `options`: { `username:` string (twitter username) } or { `id:` int (from 1 to 101) }
 
 #### instance methods
 * `#username`
 * `#name`
 * `#description`
-* `#avatar_url(size)`     
-  `size`: requested size of image. Available in 128, 73, 48, and 24 px.       
+* `#avatar_url(size)`
+  `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`
@@ -66,7 +72,7 @@ Many thanks to these users for their contributions.
 
 ## Future work
 
-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.
+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. The script used to fetch data from the Twitter API is included in the `dev` folder.
 
 ## Contributing
 

data/Rakefile

@@ -2,4 +2,4 @@ require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new('spec')
-task default: :spec
+task default: :spec

data/dev/fetch_from_twitter.rb

@@ -55,46 +55,51 @@ class TweetFetcher
 
     puts ""
     users.each_with_index do |username, user_num|
-      fake_friends[username] = create_user_hash_for username
-      update_output_file_with 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)
+      end
     end
 
     puts "Finished fetching users and tweets"
   end
 
+  private
+
+  # ---
+  # helper method
+  # ---
+  def user_exists_and_tweets_are_public?(u)
+    twitter_client.user?(u) && !twitter_client.user(u).protected?
+  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
+    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
 
   # ---
@@ -123,20 +128,16 @@ class TweetFetcher
   # ---
   def countdown_minutes(min)
     puts "taking a #{min}-minute power nap to stay within Twitter API rate limits..."
+    seconds = (min * 60).to_i
 
-    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 ""
+    (1..seconds).reverse_each do |sec|
+      print "\r%02d:%02d:%02d" % [ sec / 3600, sec / 60, sec % 60 ]
+      $stdout.flush
+      sleep 1
+    end
+    puts
   end
 end
 
 twitter_api = TweetFetcher.new
-twitter_api.fetch_users_and_their_tweets
+twitter_api.fetch_users_and_their_tweets

data/fake_friends.gemspec

@@ -5,13 +5,13 @@ require 'fake_friends/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "fake_friends"
-  spec.version       = FalseFriends::VERSION
+  spec.version       = FakeFriends::VERSION
   spec.authors       = ["Jake Romer"]
-  spec.email         = ["jake@jakeromer.com"]
+  spec.email         = ["jacob.romer@icloud.com"]
   spec.description   = %q{A simple fake user generator}
   spec.summary       = %q{Generates fake users with consistent
-                        attributes, up to 30 from local dictionary,
-                        up to 100 pulling fresh data using the Twitter gem}
+                        attributes from public Twitter accounts
+                        and image urls from uiFaces.com.}
   spec.homepage      = "http://github.com/jmromer/FakeFriends"
   spec.license       = "MIT"
   spec.files         = `git ls-files`.split($/)
@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # TO BE ADDED
-  # spec.add_runtime_dependency "twitter", "~> 5.2.0"
+  # spec.add_runtime_dependency "twitter", "~> 5.6.0"
 
-  spec.add_development_dependency "twitter", "~> 5.2.0"
+  spec.add_development_dependency "twitter", "~> 5.6.0"
   spec.add_development_dependency "rspec", "~> 2.14.1"
 
-  spec.add_development_dependency "bundler", "~> 1.3.5"
+  spec.add_development_dependency "bundler", "~> 1.5.2"
   spec.add_development_dependency "rake", "~> 10.1.0"
 end

data/lib/fake_friends/version.rb

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

data/lib/fake_friends.rb

@@ -9,28 +9,36 @@ module FakeFriends
   class FakeFriend
     attr_reader :username, :name, :location, :description, :url, :posts
 
-    # Friend.gather(n)
-    # returns an array of n user objects
+    # Public: FakeFriend.gather(n)
+    # Returns n FakeFriend objects
+    #
+    # n  - An Integer from 1 to 101.
+    #
+    # Examples
+    #
+    #   FakeFriend.gather(2)
+    #   # => [#<FakeFriend:0x00..>, #<FakeFriend:0x00..>]
+    #
+    # Returns an array of n FakeFriend objects
     def self.gather(n)
       raise ArgumentError, "Can only gather 1 to 101 FakeFriends" unless n.between?(1, 101)
       users = FakeFriend.list.keys.sample(n)
       users.map{ |username| FakeFriend.new(username) }
     end
 
-    # FakeFriend.find_by(options)
+    # Public: FakeFriend.find_by(options)
+    # Returns a FakeFriend object for a specific user in the user listing
     #
-    # options <hash>
-    # id: n <int>
-    #   position in the users list, 1-101
+    # options - The Hash of options (default: {}):
+    #           :id - Integer - User's position in the user listing, 1 to 101
+    #           :username - String - User's Twitter username
     #
-    # username: str <string>
-    #   twitter username
+    # Examples
     #
-    # Example: FakeFriend.find_by(id: 101)
-    # => #<User:0x007ff0f286e2d8 ...>
+    #   FakeFriend.find_by(id: 101)
+    #   # => #<FakeFriend:0x007ff0f286e2d8 ...>
     #
-    # returns the requested user object
-
+    # Returns the requested FakeFriend object if found, else raises ArgumentError
     def self.find_by(options)
       if options[:id] && options[:id].between?(1, FakeFriend.list.count)
         username = FakeFriend.list.keys[options[:id]-1]
@@ -42,13 +50,18 @@ module FakeFriends
       end
     end
 
-    # FakeFriend.new(username)
+    # Public: FakeFriend.new(username)
+    # Creates a FakeFriend object with attributes fetched from
+    # the user listing defined in users.yml and accesses via FakeFriend.list
     #
-    # username <string>
-    #   twitter username
+    # username  - String - a Twitter username found in the user listing
     #
-    # returns user object
-
+    # Examples
+    #
+    #   FakeFriend.new('idiot')
+    #   # => #<FakeFriend:0x00000101348a80 @username="idiot"...>
+    #
+    # Returns a FakeFriend object with attributes populated from FakeFriend.list
     def initialize(username)
       @username    = username
       @name        = FakeFriend.list[username][:name]
@@ -58,8 +71,11 @@ module FakeFriends
       @posts       = FakeFriend.list[username][:posts]
     end
 
-    # avatar_url(size)
-    # returns the user's uiFaces url in the closest available size
+    # Public: returns a user's uiFaces url in the closest available size
+    #
+    # size  - Integer - the requested image size (length = width), in pixels
+    #
+    # Returns a string with the appropriate url.
     def avatar_url(size)
       valid_sizes = [128, 73, 48, 24]
       size = valid_sizes.min { |a,b| (size-a).abs <=> (size-b).abs }
@@ -71,6 +87,10 @@ module FakeFriends
       libary_file   = mydir + '/fake_friends/users.yml'
       @friends_list = File.open(libary_file, 'r'){|f| YAML.load(f) }
 
+      # Private: FakeFriend.list
+      #
+      # Returns a class instance Hash variable holding the
+      #   user list defined in users.yml
       def self.list
         @friends_list
       end

metadata

@@ -1,80 +1,81 @@
 --- !ruby/object:Gem::Specification
 name: fake_friends
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jake Romer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-18 00:00:00.000000000 Z
+date: 2014-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 5.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 5.6.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: 1.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.1.0
 description: A simple fake user generator
 email:
-- jake@jakeromer.com
+- jacob.romer@icloud.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -97,21 +98,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Generates fake users with consistent attributes, up to 30 from local dictionary,
-  up to 100 pulling fresh data using the Twitter gem
+summary: Generates fake users with consistent attributes from public Twitter accounts
+  and image urls from uiFaces.com.
 test_files:
 - spec/fake_friends_spec.rb
 - spec/spec_helper.rb
+has_rdoc: