social_count 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/support/credentials.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in social_count.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Isaac Betesh
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# SocialCount
+
+This gem is an incredibly ligh-weight wrapper for finding how many facebook friends and twitter followers someone has.
+
+## Installation
+
+    gem 'social_count' # In your Gemfile
+
+    $ gem install social_count # Install locally
+
+## Usage
+
+1) Configure your credentials:
+
+    # Instantiate the credentials object
+    SocialCount.credentials = SocialCount::Credentials.new
+
+    # Then set the following values
+    SocialCount.credentials.twitter_consumer_key
+    SocialCount.credentials.twitter_consumer_secret
+    SocialCount.credentials.twitter_oauth_token
+    SocialCount.credentials.twitter_oauth_token_secret
+    SocialCount.credentials.fb_app_id
+    SocialCount.credentials.fb_app_secret
+
+2) Get the Facebook follower count of any business page:
+
+    SocialCount::FacebookUser.new('zuck').follower_count # Find out how many people are following Mark Zuckerberg
+    SocialCount::FacebookUser.new('zuck').friend_count # nil -- Mark has a business page because he's so famous
+
+3) Get the Facebook friend count of any regular facebook user:
+
+    SocialCount::FacebookUser.new('jose.valim').friend_count # Find out how many friends Jose Valim has -- I wish he were as famous as Mark
+    SocialCount::FacebookUser.new('jose.valim').follower_count # nil
+    # I think there are more Devise users than Facebook users in China.  As least that's on place where Jose is more famous than Mark
+
+
+4) Get the Twitter follower count of any user:
+
+    SocialMedia::TwitterUser.new('tsa').follower_count # Find out how many people are following the Transportation security Administration
+
+5) Check if someone is on Facebook:
+
+    orwell = SocialCount::FacebookUser.new('george_orwell')
+    orwell.valid? # False -- Not everyone is cool enough to be one Facebook
+    orwell.friend_count # nil
+
+6) Check if someone is on Twitter:
+
+    nsa = SocialCount::TwitterUser.new('no_such_agency')
+    nsa.valid? # False -- Nobody can follow the NSA
+    nsa.follower_count # nil

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/social_count/api_base.rb

@@ -0,0 +1,23 @@
+require 'net/http'
+
+module SocialCount
+  class ApiBase
+    attr_reader :name
+    def initialize(name)
+      @name = name
+    end
+    class << self
+      def get_http_response(uri)
+        uri = URI.escape(uri)
+        url = URI.parse(uri)
+        http = Net::HTTP.new(url.host, url.port)
+        http.use_ssl = true
+        http.request(Net::HTTP::Get.new(uri))
+      end
+      private
+        def credentials
+          @credentials ||= SocialCount.credentials
+        end
+    end
+  end
+end

data/lib/social_count/facebook_user.rb

@@ -0,0 +1,47 @@
+require 'fb_graph'
+require 'social_count/api_base'
+
+module SocialCount
+  class FacebookUser < ApiBase
+    DOMAIN = "https://graph.facebook.com"
+    def valid?
+      return @valid unless @valid.nil?
+      @valid = self.class.get_http_response("#{DOMAIN}/#{name}").is_a?(Net::HTTPOK)
+    end
+    def user
+      return unless valid?
+      @user ||= FbGraph::User.fetch(name, :access_token => URI.escape(self.class.access_token))
+    end
+    def id
+      return unless valid?
+      @id ||= user.identifier.to_i
+    end
+    def friend_count
+      run_query(:friend)
+    end
+    def follower_count
+      count = run_query(:subscriber)
+      count.zero? ? nil : count
+    end
+    private
+      def run_query(column)
+        return unless valid?
+        url = "#{DOMAIN}/fql?q=#{query(column)}"
+        response = self.class.get_http_response(url)
+        JSON.parse(response.body)["data"][0]["#{column}_count"]
+      end
+      def query(column)
+        "SELECT #{column}_count FROM user WHERE uid=#{id}"
+      end
+
+    class << self
+      def access_token
+        @access_token ||= get_http_response(access_url).body.split("access_token=")[1]
+      end
+      private
+        def access_url
+          @access_url ||= "#{DOMAIN}/oauth/access_token?client_id=#{credentials.fb_app_id}&client_secret=#{credentials.fb_app_secret}&grant_type=client_credentials"
+        end
+    end
+  end
+end

data/lib/social_count/twitter_user.rb

@@ -0,0 +1,37 @@
+require 'twitter_oauth'
+require 'social_count/api_base'
+
+module SocialCount
+  class TwitterUser < ApiBase
+    API_DOMAIN = "https://api.twitter.com"
+    USER_DOMAIN = "https://twitter.com"
+    CONSUMER_OPTIONS = { :site => API_DOMAIN, :scheme => :header }
+
+    def valid?
+      return @valid unless @valid.nil?
+      @valid = self.class.get_http_response("#{USER_DOMAIN}/#{name}").is_a?(Net::HTTPOK)
+    end
+
+    def follower_count
+      response = self.class.access_token.request(:get, follower_count_url)
+      JSON.parse(response.body)["followers_count"]
+    end
+    private
+      def follower_count_url
+        @follower_count_url ||= "#{API_DOMAIN}/1.1/users/show.json?screen_name=#{URI.escape(name)}"
+      end
+
+    class << self
+      def access_token
+        @access_token ||= OAuth::AccessToken.from_hash(consumer, token_hash)
+      end
+      private
+        def consumer
+          @consumer ||= OAuth::Consumer.new(credentials.twitter_consumer_key, credentials.twitter_consumer_secret, CONSUMER_OPTIONS)
+        end
+        def token_hash
+          @token_hash ||= { :oauth_token => credentials.twitter_oauth_token, :oauth_token_secret => credentials.twitter_oauth_token_secret }
+        end
+    end
+  end
+end

data/lib/social_count/version.rb

@@ -0,0 +1,3 @@
+module SocialCount
+  VERSION = "0.0.2"
+end

data/lib/social_count.rb

@@ -0,0 +1,26 @@
+require "social_count/version"
+require "social_count/facebook_user"
+require "social_count/twitter_user"
+
+module SocialCount
+  REQUIRED_CREDENTIALS = [:twitter_consumer_key, :twitter_consumer_secret, :twitter_oauth_token, :twitter_oauth_token_secret, :fb_app_id, :fb_app_secret]
+  class Error < StandardError; end
+  class Credentials
+    attr_reader *REQUIRED_CREDENTIALS
+  end
+  class << self
+    def credentials
+      raise SocialCount::Error, "You must set SocialCount.credentials before making an API call" if @credentials.nil?
+      @credentials
+    end
+
+    def credentials=(credentials)
+      validate_credentials(credentials)
+      @credentials = credentials
+    end
+    private
+      def validate_credentials(_credentials)
+        REQUIRED_CREDENTIALS.each { |attr| raise SocialCount::Error, "SocialCount.credentials must respond to #{attr}" unless _credentials.respond_to?(attr.to_s) }
+      end
+  end
+end

data/social_count.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'social_count/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "social_count"
+  spec.version       = SocialCount::VERSION
+  spec.authors       = ["Isaac Betesh"]
+  spec.email         = ["iybetesh@gmail.com"]
+  spec.description   = %q{Want to know how popular you are?  This gem helps you look up how many Facebook friends and Twitter followers you have.}
+  spec.summary       = `cat README.md`
+  spec.homepage      = "https://github.com/betesh/social_count"
+  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.add_dependency "fb_graph"
+  spec.add_dependency "twitter_oauth", '~> 0.4.94'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/social_count/credentials_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module SocialCount
+  class << self
+    def reset_credentials
+      @credentials = nil
+    end
+  end
+end
+
+
+def credentials_without(attr)
+  SocialCount::REQUIRED_CREDENTIALS.dup.tap { |a| a.delete(attr) }
+end
+
+describe SocialCount::Credentials do
+  SocialCount::REQUIRED_CREDENTIALS.each do |credential|
+    it "should require credentials to have a #{credential}" do
+      credentials = Class.new do attr_reader *credentials_without(credential); end
+      expect{SocialCount.credentials = credentials.new}.to raise_error(SocialCount::Error, "SocialCount.credentials must respond to #{credential}")
+    end
+  end
+
+  it "shouldn't change state when an exception is raised" do
+    credentials = Class.new do attr_reader *credentials_without(:twitter_consumer_secret); end
+    SocialCount.reset_credentials
+    expect{SocialCount.credentials = credentials.new}.to raise_error(SocialCount::Error, "SocialCount.credentials must respond to twitter_consumer_secret")
+    expect(SocialCount.instance_variable_get("@credentials")).to be_nil
+  end
+
+  it "shouldn't allow access untill credentials have been set" do
+    SocialCount.reset_credentials
+    expect{SocialCount.credentials}.to raise_error(SocialCount::Error, "You must set SocialCount.credentials before making an API call")
+  end
+
+  it "can be a SocialCount::Credentials instance" do
+    expect{SocialCount.credentials = SocialCount::Credentials.new}.to_not raise_error
+  end
+end

data/spec/social_count/facebook_user_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe SocialCount::FacebookUser do
+  before(:all) do
+    SocialCount.credentials = TestCredentials::INSTANCE
+  end
+
+  def username
+    @username ||= 'zuck'
+  end
+  def access_token_did_not_match_specified_format
+    @access_token_did_not_match_specified_format ||= "Facebook Access Token #{@access_token} did not match specified format"
+  end
+  describe "class methods" do
+    it "should receive an access token" do
+      @access_token = SocialCount::FacebookUser.access_token.split("|")
+      @access_token.count.should eq(2), access_token_did_not_match_specified_format
+      @access_token[0].should eq(SocialCount.credentials.fb_app_id), access_token_did_not_match_specified_format
+      @access_token[1].should match(/[_A-Za-z0-9]{27}/), access_token_did_not_match_specified_format
+    end
+  end
+  describe "user that supports following" do
+    before(:all) do
+      @facebook = SocialCount::FacebookUser.new(username)
+    end
+    it "should be valid" do
+      @facebook.valid?.should be_true
+    end
+    it "should get user data" do
+      user = @facebook.user
+      user.username.should eq(username)
+      user.first_name.should eq('Mark')
+      user.last_name.should eq('Zuckerberg')
+      user.link.should eq("http://www.facebook.com/#{username}")
+      user.gender.should eq('male')
+    end
+    it "should get the user's id" do
+      @facebook.id.should eq(4)
+    end
+    it "should get the user's follower count" do
+      count = @facebook.follower_count
+      count.should be_a(Fixnum)
+      count.should eq(19528198)
+    end
+    it "should handle friend_count gracefully" do
+      @facebook.friend_count.should be_nil
+    end
+  end
+  describe "user that supports friending" do
+    before(:all) do
+      @facebook = SocialCount::FacebookUser.new('jose.valim')
+    end
+    it "should get the user's friend count" do
+      count = @facebook.friend_count
+      count.should be_a(Fixnum)
+      count.should eq(568)
+    end
+    it "should handle friend_count gracefully" do
+      @facebook.follower_count.should be_nil
+    end
+  end
+  describe "non-existent user" do
+    def non_existent_user
+      SocialCount::FacebookUser.new("george_orwell")
+    end
+    it "should fail gracefully" do
+      expect{non_existent_user}.to_not raise_error
+    end
+    it "should be invalid" do
+      non_existent_user.valid?.should be_false
+    end
+    it "should have nil user" do
+      non_existent_user.user.should be_nil
+    end
+    it "should have nil id" do
+      non_existent_user.id.should be_nil
+    end
+    it "should have nil friend_count" do
+      non_existent_user.friend_count.should be_nil
+    end
+  end
+end

data/spec/social_count/twitter_user_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe SocialCount::TwitterUser do
+  before(:all) do
+    SocialCount.credentials = TestCredentials::INSTANCE
+  end
+  def username
+    @username ||= 'tsa'
+  end
+
+  describe "existent user" do
+    before(:each) do
+      @twitter = SocialCount::TwitterUser.new(username)
+    end
+
+    it "should be valid" do
+      @twitter.valid?.should be_true
+    end
+
+    it "should get the follow count" do
+      @twitter.follower_count.should eq(12171)
+    end
+  end
+
+  describe "non-existent user" do
+    def non_existent_user
+      SocialCount::TwitterUser.new('no_such_agency')
+    end
+
+    it "should fail gracefully" do
+      expect{non_existent_user}.to_not raise_error
+    end
+
+    it "should be invalid" do
+      non_existent_user.valid?.should be_false
+    end
+
+    it "should have nil follower_count" do
+      non_existent_user.follower_count.should be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'social_count'
+
+Dir[File.expand_path("#{__FILE__}/../support/*.rb")].each {|f| require f }
+
+RSpec.configure do |config|
+  config.order = "random"
+end

data/spec/support/credentials.rb.example

@@ -0,0 +1,11 @@
+class TestCredentials
+  INSTANCE = TestCredentials.new(
+    # Configure these values before running specs
+    'MY_TWITTER_CONSUMER_KEY',
+    'MY_TWITTER_CONSUMER_SECRET',
+    'MY_TWITTER_OAUTH_TOKEN',
+    'MY_TWITTER_OAUTH_TOKEN_SECRET',
+    'MY_FACEBOOK_APP_ID',
+    'MY_FACEBOOK_APP_SECRET'
+  )
+end

data/spec/support/test_credentials.rb

@@ -0,0 +1,12 @@
+class TestCredentials
+  attr_reader :twitter_consumer_key, :twitter_consumer_secret, :twitter_oauth_token, :twitter_oauth_token_secret, :fb_app_id, :fb_app_secret
+  def initialize twitter_consumer_key, twitter_consumer_secret, twitter_oauth_token, twitter_oauth_token_secret, fb_app_id, fb_app_secret
+    @twitter_consumer_key, @twitter_consumer_secret, @twitter_oauth_token, @twitter_oauth_token_secret, @fb_app_id, @fb_app_secret = twitter_consumer_key, twitter_consumer_secret, twitter_oauth_token, twitter_oauth_token_secret, fb_app_id, fb_app_secret
+  end
+  credentials_file = File.expand_path("#{__FILE__}/../credentials.rb")
+  unless File.exists?(credentials_file)
+    puts "Please configure your Facebook and Twitter application credentials by copying #{credentials_file}.example to #{credentials_file} and configuring the required values there appropriately."
+    puts "Then comment out the 'exit' line in #{File.expand_path(__FILE__)} before running rspec."
+    exit
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: social_count
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Isaac Betesh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fb_graph
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: twitter_oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.94
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.94
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Want to know how popular you are?  This gem helps you look up how many
+  Facebook friends and Twitter followers you have.
+email:
+- iybetesh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/social_count.rb
+- lib/social_count/api_base.rb
+- lib/social_count/facebook_user.rb
+- lib/social_count/twitter_user.rb
+- lib/social_count/version.rb
+- social_count.gemspec
+- spec/social_count/credentials_spec.rb
+- spec/social_count/facebook_user_spec.rb
+- spec/social_count/twitter_user_spec.rb
+- spec/spec_helper.rb
+- spec/support/credentials.rb.example
+- spec/support/test_credentials.rb
+homepage: https://github.com/betesh/social_count
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1024359385876280514
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1024359385876280514
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ! '# SocialCount  This gem is an incredibly ligh-weight wrapper for finding
+  how many facebook friends and twitter followers someone has.  ## Installation  gem
+  ''social_count'' # In your Gemfile  $ gem install social_count # Install locally  ##
+  Usage  1) Configure your credentials:  # Instantiate the credentials object SocialCount.credentials
+  = SocialCount::Credentials.new  # Then set the following values SocialCount.credentials.twitter_consumer_key
+  SocialCount.credentials.twitter_consumer_secret SocialCount.credentials.twitter_oauth_token
+  SocialCount.credentials.twitter_oauth_token_secret SocialCount.credentials.fb_app_id
+  SocialCount.credentials.fb_app_secret  2) Get the Facebook follower count of any
+  business page:  SocialCount::FacebookUser.new(''zuck'').follower_count # Find out
+  how many people are following Mark Zuckerberg SocialCount::FacebookUser.new(''zuck'').friend_count
+  # nil -- Mark has a business page because he''s so famous  3) Get the Facebook friend
+  count of any regular facebook user:  SocialCount::FacebookUser.new(''jose.valim'').friend_count
+  # Find out how many friends Jose Valim has -- I wish he were as famous as Mark SocialCount::FacebookUser.new(''jose.valim'').follower_count
+  # nil # I think there are more Devise users than Facebook users in China.  As least
+  that''s on place where Jose is more famous than Mark   4) Get the Twitter follower
+  count of any user:  SocialMedia::TwitterUser.new(''tsa'').follower_count # Find
+  out how many people are following the Transportation security Administration  5)
+  Check if someone is on Facebook:  orwell = SocialCount::FacebookUser.new(''george_orwell'')
+  orwell.valid? # False -- Not everyone is cool enough to be one Facebook orwell.friend_count
+  # nil  6) Check if someone is on Twitter:  nsa = SocialCount::TwitterUser.new(''no_such_agency'')
+  nsa.valid? # False -- Nobody can follow the NSA nsa.follower_count # nil'
+test_files:
+- spec/social_count/credentials_spec.rb
+- spec/social_count/facebook_user_spec.rb
+- spec/social_count/twitter_user_spec.rb
+- spec/spec_helper.rb
+- spec/support/credentials.rb.example
+- spec/support/test_credentials.rb