social_net 0.1.1

data/lib/social_net/twitter/errors.rb

@@ -0,0 +1,4 @@
+require 'social_net/twitter/errors/response_error'
+require 'social_net/twitter/errors/suspended_user'
+require 'social_net/twitter/errors/too_many_users'
+require 'social_net/twitter/errors/unknown_user'

data/lib/social_net/twitter/models/user.rb

@@ -0,0 +1,81 @@
+require 'social_net/twitter/api/request'
+require 'social_net/twitter/errors'
+
+module SocialNet
+  module Twitter
+    module Models
+      class User
+        attr_reader :screen_name, :follower_count
+
+        def initialize(attrs = {})
+          attrs.each{|k, v| instance_variable_set("@#{k}", v) unless v.nil?}
+          @follower_count = attrs['followers_count']
+        end
+
+        # Returns the existing Twitter user matching the provided attributes or
+        # nil when the user is not found.
+        #
+        # @return [SocialNet::Twitter::Models::User] when the user is found.
+        # @return [nil] when the user is not found or suspended.
+        # @param [Hash] params the attributes to find a user by.
+        # @option params [String] :screen_name The Twitter user’s screen name
+        #   (case-insensitive).
+        def self.find_by(params = {})
+          find_by! params
+        rescue Errors::UnknownUser, Errors::SuspendedUser
+          nil
+        end
+
+        # Returns the existing Twitter user matching the provided attributes or
+        # raises an error when the user is not found or suspended.
+        #
+        # @return [SocialNet::Twitter::Models::User] the Twitter user.
+        # @param [Hash] params the attributes to find a user by.
+        # @option params [String] :screen_name The Twitter user’s screen name
+        #   (case-insensitive).
+        # @raise [SocialNet::Errors::UnknownUser] if the user cannot be found.
+        # @raise [SocialNet::Errors::SuspendedUser] if the user account is suspended.
+        def self.find_by!(params = {})
+          request = Api::Request.new endpoint: 'users/show', params: params
+          user_data = request.run
+          new user_data
+        rescue Errors::ResponseError => error
+          case error.response
+            when Net::HTTPNotFound then raise Errors::UnknownUser
+            when Net::HTTPForbidden then raise Errors::SuspendedUser
+          end
+        end
+
+        # Returns up to 100 existing Twitter users matching the provided
+        # attributes. Raises an error when requesting more than 100 users.
+        # Does not return users in the same order that they are requested.
+
+        # @return [Array<SocialNet::Twitter::Models::User>] the Twitter users.
+        # @param [Hash] conditions The attributes to find users by.
+        # @option conditions [Array<String>] screen_name The Twitter user's
+        #   screen names (case-insensitive).
+        # @raise [SocialNet::Errors::TooManyUsers] when more than 100 Twitter users
+        #   match the provided attributes.
+        def self.where(conditions = {})
+          params = to_where_params conditions
+          request = Api::Request.new endpoint: 'users/lookup', params: params
+          users_data = request.run
+          users_data.map{|user_data| new user_data}
+        rescue Errors::ResponseError => error
+          case error.response
+            when Net::HTTPNotFound then []
+            when Net::HTTPForbidden then raise Errors::TooManyUsers
+          end
+        end
+
+      private
+
+        def self.to_where_params(conditions = {})
+          conditions.dup.tap do |params|
+            params.each{|k,v| params[k] = v.join(',') if v.is_a?(Array)}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/social_net/twitter/models.rb

@@ -0,0 +1 @@
+require 'social_net/twitter/models/user'

data/lib/social_net/twitter.rb

@@ -0,0 +1,11 @@
+require 'social_net/twitter/config'
+require 'social_net/twitter/errors'
+require 'social_net/twitter/models'
+
+module SocialNet
+  module Twitter
+    extend Config
+    include Errors
+    include Models
+  end
+end

data/lib/social_net/version.rb

@@ -0,0 +1,3 @@
+module SocialNet
+  VERSION = "0.1.1"
+end

data/lib/social_net.rb

@@ -0,0 +1,7 @@
+require "social_net/version"
+require "social_net/twitter"
+require "social_net/instagram"
+require "social_net/facebook"
+
+module SocialNet
+end

data/social_net.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'social_net/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "social_net"
+  spec.version       = SocialNet::VERSION
+  spec.authors       = ["Jeremy Cohen Hoffing"]
+  spec.email         = ["jeremy@collabcreators.com"]
+  spec.summary       = %q{An API Client for social networks}
+  spec.description   = %q{Retrieves information for Instagram users}
+  spec.homepage      = "https://github.com/CollabCreators/social_net"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "yard", "~> 0.8.7"
+  spec.add_development_dependency "coveralls", "~> 0.7.1"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "webmock", "~> 1.19"
+end

data/spec/social_net/facebook/models/pages_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe SocialNet::Facebook::Page do
+  let(:unknown_username) { 'qeqwe09qlkmhkjh' }
+  let(:existing_username) { 'collab' }
+
+  describe '.find_by' do
+    subject(:page) { SocialNet::Facebook::Page.find_by username: username }
+
+    context 'given an existing (case-insensitive) username' do
+      let (:username) { existing_username }
+
+      it 'returns an object representing the page for that user' do
+        expect(page.username).to eq 'collab'
+        expect(page.likes).to be_an Integer
+      end
+    end
+
+    context 'given an unknown username' do
+      let(:username) { unknown_username }
+      it { expect(page).to be_nil }
+    end
+  end
+
+  describe '.find_by!' do
+    subject(:page) { SocialNet::Facebook::Page.find_by! username: username }
+
+    context 'given an existing (case-insensitive) username' do
+      let(:username) { existing_username }
+
+      it 'returns an object representing the page for that user' do
+        expect(page.username).to eq 'collab'
+        expect(page.likes).to be_an Integer
+      end
+    end
+
+    context 'given an unknown username' do
+      let(:username) { unknown_username }
+      it { expect{page}.to raise_error SocialNet::Facebook::UnknownUser }
+    end
+  end
+end

data/spec/social_net/facebook/models/users_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe SocialNet::Facebook::User do
+  let(:unknown_username) { 'qeqwe09qlkmhkjh' }
+  let(:existing_username) { '1453280268327112' }
+
+  describe '.find_by' do
+    subject(:user) { SocialNet::Facebook::User.find_by username: username }
+
+    context 'given an existing (case-insensitive) username' do
+      let (:username) { existing_username }
+
+      it 'returns an object representing the user' do
+        expect(user.first_name).to eq 'Jeremy'
+        expect(user.last_name).to eq 'Dev'
+        expect(user.gender).to eq 'male'
+      end
+    end
+
+    context 'given an unknown username' do
+      let(:username) { unknown_username }
+      it { expect(user).to be_nil }
+    end
+  end
+
+  describe '.find_by!' do
+    subject(:user) { SocialNet::Facebook::User.find_by! username: username }
+
+    context 'given an existing (case-insensitive) username' do
+      let(:username) { existing_username }
+
+      it 'returns an object representing the user' do
+        expect(user.first_name).to eq 'Jeremy'
+        expect(user.last_name).to eq 'Dev'
+        expect(user.gender).to eq 'male'
+      end
+    end
+
+    context 'given an unknown username' do
+      let(:username) { unknown_username }
+      it { expect{user}.to raise_error SocialNet::Facebook::UnknownUser }
+    end
+  end
+end

data/spec/social_net/instagram/models/user_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'social_net/instagram'
+
+describe SocialNet::Instagram::User, :vcr do
+  before :all do
+    SocialNet::Instagram.configure do |config|
+      if config.access_token.blank?
+        config.access_token = 'ACCESS_TOKEN'
+      end
+    end
+  end
+
+  let(:existing_username) { 'Collab' }
+  let(:unknown_username) { '01LjqweoojkjR' }
+
+  describe '.find_by' do
+    subject(:user) { SocialNet::Instagram::User.find_by username: username }
+
+    context 'given an existing (case-insensitive) username' do
+      let(:username) { existing_username }
+
+      it 'returns an object representing that user' do
+        expect(user.username).to eq 'collab'
+        expect(user.follower_count).to be_an Integer
+      end
+    end
+
+    context 'given an unknown username' do
+      let(:username) { unknown_username }
+      it { expect(user).to be_nil }
+    end
+  end
+
+  describe '.find_by!' do
+    subject(:user) { SocialNet::Instagram::User.find_by! username: username }
+    context 'given an existing (case-insensitive) username' do
+      let(:username) { existing_username }
+
+      it 'returns an object representing that user' do
+        expect(user.username).to eq 'collab'
+        expect(user.follower_count).to be_an Integer
+      end
+    end
+
+    context 'given an unknown username' do
+      let(:username) { unknown_username }
+      it { expect{user}.to raise_error SocialNet::Instagram::UnknownUser }
+    end
+  end
+end

data/spec/social_net/twitter/models/user_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'social_net/twitter'
+
+describe SocialNet::Twitter::User, :vcr do
+  let(:unknown_screen_name) { '09hlQHE29534awe' }
+  let(:suspended_screen_name) { 'CodFatherLucas' }
+  let(:existing_screen_name) { 'collab' }
+
+  describe '.find_by' do
+    subject(:user) { SocialNet::Twitter::User.find_by screen_name: screen_name }
+
+    context 'given an existing (case-insensitive) screen name' do
+      let(:screen_name) { existing_screen_name }
+
+      it 'returns an object representing that user' do
+        expect(user.screen_name).to eq 'Collab'
+        expect(user.follower_count).to be_an Integer
+      end
+    end
+
+    context 'given an unknown screen name' do
+      let(:screen_name) { unknown_screen_name }
+      it { expect(user).to be_nil }
+    end
+
+    context 'given a suspended screen name' do
+      let(:screen_name) { suspended_screen_name }
+      it { expect(user).to be_nil }
+    end
+  end
+
+  describe '.find_by!' do
+    subject(:user) { SocialNet::Twitter::User.find_by! screen_name: screen_name }
+
+    context 'given an existing (case-insensitive) screen name' do
+      let(:screen_name) { existing_screen_name }
+
+      it 'returns an object representing that user' do
+        expect(user.screen_name).to eq 'Collab'
+        expect(user.follower_count).to be_an Integer
+      end
+    end
+
+    context 'given an unknown screen name' do
+      let(:screen_name) { unknown_screen_name }
+      it { expect{user}.to raise_error SocialNet::Twitter::UnknownUser }
+    end
+
+    context 'given a suspended screen name' do
+      let(:screen_name) { suspended_screen_name }
+      it { expect{user}.to raise_error SocialNet::Twitter::SuspendedUser }
+    end
+  end
+
+  describe '.where' do
+    context 'given multiple existing (case-insensitive) screen names' do
+      let(:screen_names) { ['brohemian6', existing_screen_name, suspended_screen_name, unknown_screen_name] }
+      subject(:users) { SocialNet::Twitter::User.where screen_name: screen_names }
+
+      it 'returns an array of objects representing those users' do
+        expect(users.map &:screen_name).to contain_exactly('Collab', 'brohemian6')
+        expect(users.map &:follower_count).to all(be_an Integer)
+      end
+    end
+
+    context 'given multiple unknown or suspended screen names' do
+      let(:screen_names) { [suspended_screen_name, unknown_screen_name] }
+      subject(:users) { SocialNet::Twitter::User.where screen_name: screen_names }
+
+      it 'returns an empty array' do
+        expect(users).to be_empty
+      end
+    end
+
+    # @see https://dev.twitter.com/rest/reference/get/users/lookup
+    context 'given more screen names than allowed by Twitter' do
+      let(:screen_names) { ('a'..'z').map{|x| ('a'..'e').map{|y| "#{x}#{y}"}}.flatten }
+      subject(:users) { SocialNet::Twitter::User.where screen_name: screen_names }
+
+      it { expect{users}.to raise_error SocialNet::Twitter::TooManyUsers }
+    end
+
+    # @see https://dev.twitter.com/rest/public/rate-limits
+    context 'called more times than Twitter’s rate limit' do
+
+      before { expect(Time).to receive(:now).at_least(:once).and_return 12345678 }
+      let(:lookup_limit) { 60 }
+      let(:screen_names) { [existing_screen_name] }
+      subject(:user_sets) { (lookup_limit + 1).times.map do
+        SocialNet::Twitter::User.where screen_name: screen_names
+      end}
+
+      it 'waits for the rate limit to expire then continues' do
+        expect(user_sets.compact.size).to be > lookup_limit
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+ SimpleCov::Formatter::HTMLFormatter,
+ Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require 'social_net'
+Dir['./spec/support/**/*.rb'].each {|f| require f}

data/spec/support/cassettes/SocialNet_Instagram_Models_User/_find_by/given_an_existing_case-insensitive_username/returns_an_object_representing_that_user.yml

@@ -0,0 +1,106 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.instagram.com/v1/users/search?access_token=INSTAGRAM_ACCESS_TOKEN&q=Collab
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Language:
+      - en
+      Content-Type:
+      - application/json; charset=utf-8
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      Pragma:
+      - no-cache
+      Date:
+      - Mon, 13 Mar 2017 22:40:44 GMT
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Vary:
+      - Cookie, Accept-Language, Accept-Encoding
+      X-Ratelimit-Limit:
+      - '500'
+      X-Ratelimit-Remaining:
+      - '482'
+      Set-Cookie:
+      - csrftoken=sJx8yhBIvtY9pJhFPBm5aLxZ82tlNgGP; expires=Mon, 12-Mar-2018 22:40:44
+        GMT; Max-Age=31449600; Path=/; Secure
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '260'
+    body:
+      encoding: ASCII-8BIT
+      string: '{"meta": {"code": 200}, "data": [{"bio": "Funemployed \ud83d\ude0e
+        Twitter/Musically: @collab \ud83e\udd18", "full_name": "Collab", "website":
+        "http://bit.ly/2nolE10", "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/s150x150/13414208_199612667102550_1239056879_a.jpg",
+        "username": "collab", "id": "487786346"}]}'
+    http_version: 
+  recorded_at: Mon, 13 Mar 2017 22:40:44 GMT
+- request:
+    method: get
+    uri: https://api.instagram.com/v1/users/487786346?access_token=INSTAGRAM_ACCESS_TOKEN
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Pragma:
+      - no-cache
+      Content-Language:
+      - en
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      X-Ratelimit-Limit:
+      - '500'
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ratelimit-Remaining:
+      - '481'
+      Date:
+      - Mon, 13 Mar 2017 22:40:44 GMT
+      Vary:
+      - Cookie, Accept-Language, Accept-Encoding
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Set-Cookie:
+      - csrftoken=ZQU37JFc9ra6IQo1cWoC0xw78IcGwbYI; expires=Mon, 12-Mar-2018 22:40:44
+        GMT; Max-Age=31449600; Path=/; Secure
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '287'
+    body:
+      encoding: ASCII-8BIT
+      string: '{"meta": {"code": 200}, "data": {"counts": {"followed_by": 23286, "media":
+        627, "follows": 369}, "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/s150x150/13414208_199612667102550_1239056879_a.jpg",
+        "username": "collab", "id": "487786346", "website": "http://bit.ly/2nolE10",
+        "bio": "Funemployed \ud83d\ude0e Twitter/Musically: @collab \ud83e\udd18",
+        "full_name": "Collab"}}'
+    http_version: 
+  recorded_at: Mon, 13 Mar 2017 22:40:44 GMT
+recorded_with: VCR 2.9.3

data/spec/support/cassettes/SocialNet_Instagram_Models_User/_find_by/given_an_unknown_username/.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.instagram.com/v1/users/search?access_token=INSTAGRAM_ACCESS_TOKEN&q=01LjqweoojkjR
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 13 Mar 2017 22:40:44 GMT
+      X-Ratelimit-Limit:
+      - '500'
+      Content-Language:
+      - en
+      Content-Type:
+      - application/json; charset=utf-8
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Pragma:
+      - no-cache
+      Vary:
+      - Cookie, Accept-Language
+      X-Ratelimit-Remaining:
+      - '480'
+      Set-Cookie:
+      - csrftoken=DX2UJsWmSUGEDG4dpYP2kANHXRQAa96c; expires=Mon, 12-Mar-2018 22:40:44
+        GMT; Max-Age=31449600; Path=/; Secure
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '35'
+    body:
+      encoding: UTF-8
+      string: '{"data": [], "meta": {"code": 200}}'
+    http_version: 
+  recorded_at: Mon, 13 Mar 2017 22:40:44 GMT
+recorded_with: VCR 2.9.3

data/spec/support/cassettes/SocialNet_Instagram_Models_User/_find_by_/given_an_existing_case-insensitive_username/returns_an_object_representing_that_user.yml

@@ -0,0 +1,106 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.instagram.com/v1/users/search?access_token=INSTAGRAM_ACCESS_TOKEN&q=Collab
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      Content-Language:
+      - en
+      Date:
+      - Mon, 13 Mar 2017 22:40:45 GMT
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      X-Ratelimit-Remaining:
+      - '479'
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ratelimit-Limit:
+      - '500'
+      Vary:
+      - Cookie, Accept-Language, Accept-Encoding
+      Pragma:
+      - no-cache
+      Set-Cookie:
+      - csrftoken=dOXi0A6wyGvTVe3jfGPR8SwJvgVcQVF7; expires=Mon, 12-Mar-2018 22:40:45
+        GMT; Max-Age=31449600; Path=/; Secure
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '260'
+    body:
+      encoding: ASCII-8BIT
+      string: '{"data": [{"bio": "Funemployed \ud83d\ude0e Twitter/Musically: @collab
+        \ud83e\udd18", "full_name": "Collab", "website": "http://bit.ly/2nolE10",
+        "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/s150x150/13414208_199612667102550_1239056879_a.jpg",
+        "id": "487786346", "username": "collab"}], "meta": {"code": 200}}'
+    http_version: 
+  recorded_at: Mon, 13 Mar 2017 22:40:45 GMT
+- request:
+    method: get
+    uri: https://api.instagram.com/v1/users/487786346?access_token=INSTAGRAM_ACCESS_TOKEN
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      Content-Language:
+      - en
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Pragma:
+      - no-cache
+      X-Ratelimit-Limit:
+      - '500'
+      Date:
+      - Mon, 13 Mar 2017 22:40:45 GMT
+      Vary:
+      - Cookie, Accept-Language, Accept-Encoding
+      X-Ratelimit-Remaining:
+      - '478'
+      Content-Type:
+      - application/json; charset=utf-8
+      Set-Cookie:
+      - csrftoken=zpJ7PfW0ggBGglMrxHOG6wGSCTUJnIWB; expires=Mon, 12-Mar-2018 22:40:45
+        GMT; Max-Age=31449600; Path=/; Secure
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '290'
+    body:
+      encoding: ASCII-8BIT
+      string: '{"data": {"bio": "Funemployed \ud83d\ude0e Twitter/Musically: @collab
+        \ud83e\udd18", "counts": {"followed_by": 23286, "media": 627, "follows": 369},
+        "website": "http://bit.ly/2nolE10", "full_name": "Collab", "username": "collab",
+        "profile_picture": "https://scontent.cdninstagram.com/t51.2885-19/s150x150/13414208_199612667102550_1239056879_a.jpg",
+        "id": "487786346"}, "meta": {"code": 200}}'
+    http_version: 
+  recorded_at: Mon, 13 Mar 2017 22:40:45 GMT
+recorded_with: VCR 2.9.3