net 0.0.1 → 0.1.0

data/lib/net/version.rb

@@ -1,3 +1,3 @@
 module Net
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/net.gemspec

@@ -6,11 +6,11 @@ require 'net/version'
 Gem::Specification.new do |spec|
   spec.name          = "net"
   spec.version       = Net::VERSION
-  spec.authors       = ["claudiob"]
-  spec.email         = ["claudiob@gmail.com"]
-  spec.summary       = %q{Write a short summary. Required.}
-  spec.description   = %q{Write a longer description. Optional.}
-  spec.homepage      = ""
+  spec.authors       = ["Jeremy Cohen Hoffing", "Claudio Baccigalupo"]
+  spec.email         = ["jcohenhoffing@gmail.com", "claudio@fullscreen.net"]
+  spec.summary       = %q{An API Client for social networks}
+  spec.description   = %q{Retrieves information for Twitter users}
+  spec.homepage      = "https://github.com/Fullscreen/net"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,6 +18,13 @@ Gem::Specification.new do |spec|
   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"
-end
+  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/net/twitter/models/user_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'net/twitter'
+
+describe Net::Twitter::User, :vcr do
+	let(:unknown_screen_name) { '09hlQHE29534awe' }
+	let(:suspended_screen_name) { 'CodFatherLucas' }
+	let(:existing_screen_name) { 'fullscreen' }
+
+	describe '.find_by' do
+	  subject(:user) { Net::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 'Fullscreen'
+				expect(user.followers_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) { Net::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 'Fullscreen'
+				expect(user.followers_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 Net::Twitter::UnknownUser }
+		end
+
+		context 'given a suspended screen name' do
+			let(:screen_name) { suspended_screen_name }
+			it { expect{user}.to raise_error Net::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) { Net::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('Fullscreen', 'brohemian6')
+				expect(users.map &:followers_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) { Net::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) { Net::Twitter::User.where screen_name: screen_names }
+
+			it { expect{users}.to raise_error Net::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
+        Net::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,21 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+ SimpleCov::Formatter::HTMLFormatter,
+ Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+Dir['./spec/support/**/*.rb'].each {|f| require f}
+
+RSpec.configure do |config|
+# config.order = 'random'
+  config.before(:all) do
+    Net::Twitter.configure do |config|
+      if config.apps.empty?
+        config.apps.push key: 'TWITTER_API_KEY', secret: 'TWITTER_API_SECRET'
+      end
+    end
+  end
+end

data/spec/support/cassettes/Net_Twitter_Models_User/_find_by/given_a_suspended_screen_name/.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.twitter.com/1.1/users/show.json?screen_name=CodFatherLucas
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Authorization:
+      - ACCESS_TOKEN
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Cache-Control:
+      - no-cache, no-store, must-revalidate, pre-check=0, post-check=0
+      Content-Length:
+      - '86'
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sat, 11 Oct 2014 01:08:22 UTC
+      Expires:
+      - Tue, 31 Mar 1981 05:00:00 GMT
+      Last-Modified:
+      - Sat, 11 Oct 2014 01:08:22 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - tsa_a
+      Set-Cookie:
+      - guest_id=v1%3A141298970231864986; Domain=.twitter.com; Path=/; Expires=Mon,
+        10-Oct-2016 01:08:22 UTC
+      Status:
+      - 403 Forbidden
+      Strict-Transport-Security:
+      - max-age=631138519
+      X-Access-Level:
+      - read
+      X-Connection-Hash:
+      - 5a90ce3d1871c791b4020318e67b4e6e
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Rate-Limit-Limit:
+      - '180'
+      X-Rate-Limit-Remaining:
+      - '177'
+      X-Rate-Limit-Reset:
+      - '1412990602'
+      X-Transaction:
+      - c977632fada49967
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"errors":[{"code":63,"message":"User has been suspended."}]}'
+    http_version: 
+  recorded_at: Sat, 11 Oct 2014 01:08:15 GMT
+recorded_with: VCR 2.9.3

data/spec/support/cassettes/Net_Twitter_Models_User/_find_by/given_an_existing_case-insensitive_screen_name/returns_an_object_representing_that_user.yml

@@ -0,0 +1,136 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://TWITTER_API_KEY:TWITTER_API_SECRET@api.twitter.com/oauth2/token
+    body:
+      encoding: US-ASCII
+      string: grant_type=client_credentials
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache, no-store, must-revalidate, pre-check=0, post-check=0
+      Content-Length:
+      - '157'
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sat, 11 Oct 2014 01:08:21 UTC
+      Expires:
+      - Tue, 31 Mar 1981 05:00:00 GMT
+      Last-Modified:
+      - Sat, 11 Oct 2014 01:08:21 GMT
+      Ml:
+      - S
+      Pragma:
+      - no-cache
+      Server:
+      - tsa_a
+      Set-Cookie:
+      - guest_id=v1%3A141298970195572286; Domain=.twitter.com; Path=/; Expires=Mon,
+        10-Oct-2016 01:08:21 UTC
+      Status:
+      - 200 OK
+      Strict-Transport-Security:
+      - max-age=631138519
+      X-Connection-Hash:
+      - d63d4d3bf2e355106c486bf3c279d075
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Transaction:
+      - 038d099f9b129c61
+      X-Ua-Compatible:
+      - IE=edge,chrome=1
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"token_type":"bearer","access_token":"ACCESS_TOKEN"}'
+    http_version: 
+  recorded_at: Sat, 11 Oct 2014 01:08:15 GMT
+- request:
+    method: get
+    uri: https://api.twitter.com/1.1/users/show.json?screen_name=fullscreen
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Authorization:
+      - ACCESS_TOKEN
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache, no-store, must-revalidate, pre-check=0, post-check=0
+      Content-Length:
+      - '1270'
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sat, 11 Oct 2014 01:08:22 UTC
+      Expires:
+      - Tue, 31 Mar 1981 05:00:00 GMT
+      Last-Modified:
+      - Sat, 11 Oct 2014 01:08:22 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - tsa_a
+      Set-Cookie:
+      - guest_id=v1%3A141298970205889731; Domain=.twitter.com; Path=/; Expires=Mon,
+        10-Oct-2016 01:08:22 UTC
+      Status:
+      - 200 OK
+      Strict-Transport-Security:
+      - max-age=631138519
+      X-Access-Level:
+      - read
+      X-Connection-Hash:
+      - 212c0e3bb4a455bc0ab147f8f4b9524b
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Rate-Limit-Limit:
+      - '180'
+      X-Rate-Limit-Remaining:
+      - '179'
+      X-Rate-Limit-Reset:
+      - '1412990602'
+      X-Transaction:
+      - f0566e9fa1c91113
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"id":238110322,"id_str":"238110322","name":"Fullscreen","screen_name":"Fullscreen","location":"LA
+        \/ Worldwide","description":"The First Media Company for the Connected Generation.\r\n#PowerToTheCreators","url":"http:\/\/t.co\/IuYBnxFitD","entities":{"url":{"urls":[{"url":"http:\/\/t.co\/IuYBnxFitD","expanded_url":"http:\/\/www.fullscreen.com","display_url":"fullscreen.com","indices":[0,22]}]},"description":{"urls":[]}},"protected":false,"followers_count":48138,"friends_count":2713,"listed_count":378,"created_at":"Fri
+        Jan 14 11:36:27 +0000 2011","favourites_count":58329,"utc_offset":-25200,"time_zone":"Pacific
+        Time (US & Canada)","geo_enabled":true,"verified":true,"statuses_count":19163,"lang":"en","status":{"created_at":"Sat
+        Oct 11 00:52:51 +0000 2014","id":520738765266886656,"id_str":"520738765266886656","text":"#ICYMI:
+        15 Secs of Fullscreen with @SourPatchKids @WalkingDead_AMC @AsapSCIENCE @WeeklyChris
+        @AndreaRussett + More! http:\/\/t.co\/zoLiS9CZSL","source":"\u003ca href=\"http:\/\/twitter.com\"
+        rel=\"nofollow\"\u003eTwitter Web Client\u003c\/a\u003e","truncated":false,"in_reply_to_status_id":null,"in_reply_to_status_id_str":null,"in_reply_to_user_id":null,"in_reply_to_user_id_str":null,"in_reply_to_screen_name":null,"geo":null,"coordinates":null,"place":null,"contributors":null,"retweet_count":4,"favorite_count":9,"entities":{"hashtags":[{"text":"ICYMI","indices":[0,6]}],"symbols":[],"urls":[{"url":"http:\/\/t.co\/zoLiS9CZSL","expanded_url":"http:\/\/instagram.com\/p\/t_iCt4rhXy\/","display_url":"instagram.com\/p\/t_iCt4rhXy\/","indices":[116,138]}],"user_mentions":[{"screen_name":"SourPatchKids","name":"Sour
+        Patch Kids","id":122480273,"id_str":"122480273","indices":[35,49]},{"screen_name":"WalkingDead_AMC","name":"The
+        Walking Dead AMC","id":65184105,"id_str":"65184105","indices":[50,66]},{"screen_name":"AsapSCIENCE","name":"AsapSCIENCE","id":592912724,"id_str":"592912724","indices":[67,79]},{"screen_name":"WeeklyChris","name":"Christian
+        Collins","id":125806240,"id_str":"125806240","indices":[80,92]},{"screen_name":"AndreaRussett","name":"Andrea
+        Russett","id":30495613,"id_str":"30495613","indices":[93,107]}]},"favorited":false,"retweeted":false,"possibly_sensitive":false,"lang":"en"},"contributors_enabled":false,"is_translator":false,"is_translation_enabled":false,"profile_background_color":"16121E","profile_background_image_url":"http:\/\/pbs.twimg.com\/profile_background_images\/449347350306111489\/zWlAXsXf.png","profile_background_image_url_https":"https:\/\/pbs.twimg.com\/profile_background_images\/449347350306111489\/zWlAXsXf.png","profile_background_tile":false,"profile_image_url":"http:\/\/pbs.twimg.com\/profile_images\/449344241752227841\/xJeF6VQn_normal.png","profile_image_url_https":"https:\/\/pbs.twimg.com\/profile_images\/449344241752227841\/xJeF6VQn_normal.png","profile_banner_url":"https:\/\/pbs.twimg.com\/profile_banners\/238110322\/1411497387","profile_link_color":"E62E4C","profile_sidebar_border_color":"FFFFFF","profile_sidebar_fill_color":"DDEEF6","profile_text_color":"333333","profile_use_background_image":false,"default_profile":false,"default_profile_image":false,"following":null,"follow_request_sent":null,"notifications":null}'
+    http_version: 
+  recorded_at: Sat, 11 Oct 2014 01:08:15 GMT
+recorded_with: VCR 2.9.3

data/spec/support/cassettes/Net_Twitter_Models_User/_find_by/given_an_unknown_screen_name/.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.twitter.com/1.1/users/show.json?screen_name=09hlQHE29534awe
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Authorization:
+      - ACCESS_TOKEN
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Cache-Control:
+      - no-cache, no-store, must-revalidate, pre-check=0, post-check=0
+      Content-Length:
+      - '92'
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sat, 11 Oct 2014 01:08:22 UTC
+      Expires:
+      - Tue, 31 Mar 1981 05:00:00 GMT
+      Last-Modified:
+      - Sat, 11 Oct 2014 01:08:22 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - tsa_a
+      Set-Cookie:
+      - guest_id=v1%3A141298970220021935; Domain=.twitter.com; Path=/; Expires=Mon,
+        10-Oct-2016 01:08:22 UTC
+      Status:
+      - 404 Not Found
+      Strict-Transport-Security:
+      - max-age=631138519
+      X-Access-Level:
+      - read
+      X-Connection-Hash:
+      - 278156e7b09f629df55ab8d5cf289b58
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Rate-Limit-Limit:
+      - '180'
+      X-Rate-Limit-Remaining:
+      - '178'
+      X-Rate-Limit-Reset:
+      - '1412990602'
+      X-Transaction:
+      - 2b2b1106b457ce4a
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"errors":[{"message":"Sorry, that page does not exist","code":34}]}'
+    http_version: 
+  recorded_at: Sat, 11 Oct 2014 01:08:15 GMT
+recorded_with: VCR 2.9.3

data/spec/support/cassettes/Net_Twitter_Models_User/_find_by_/given_a_suspended_screen_name/.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.twitter.com/1.1/users/show.json?screen_name=CodFatherLucas
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Authorization:
+      - ACCESS_TOKEN
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Cache-Control:
+      - no-cache, no-store, must-revalidate, pre-check=0, post-check=0
+      Content-Length:
+      - '86'
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sat, 11 Oct 2014 01:08:22 UTC
+      Expires:
+      - Tue, 31 Mar 1981 05:00:00 GMT
+      Last-Modified:
+      - Sat, 11 Oct 2014 01:08:22 GMT
+      Pragma:
+      - no-cache
+      Server:
+      - tsa_a
+      Set-Cookie:
+      - guest_id=v1%3A141298970268472432; Domain=.twitter.com; Path=/; Expires=Mon,
+        10-Oct-2016 01:08:22 UTC
+      Status:
+      - 403 Forbidden
+      Strict-Transport-Security:
+      - max-age=631138519
+      X-Access-Level:
+      - read
+      X-Connection-Hash:
+      - d5f954bca7a9b3a762c62153a96e442e
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Rate-Limit-Limit:
+      - '180'
+      X-Rate-Limit-Remaining:
+      - '174'
+      X-Rate-Limit-Reset:
+      - '1412990602'
+      X-Transaction:
+      - 5ec8678f24b910dd
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"errors":[{"code":63,"message":"User has been suspended."}]}'
+    http_version: 
+  recorded_at: Sat, 11 Oct 2014 01:08:16 GMT
+recorded_with: VCR 2.9.3