linkedin-oauth2 0.1.1 → 1.0.0

data/linkedin-oauth2.gemspec

@@ -1,25 +1,39 @@
 # encoding: utf-8
-require File.expand_path('../lib/linked_in/version', __FILE__)
+# Follow http://guides.rubygems.org/ best practices
+
+require File.expand_path("../lib/linked_in/version", __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.add_dependency 'hashie', ['>= 1.2', '< 2.1']
-  gem.add_dependency 'multi_json', '~> 1.0'
-  gem.add_dependency 'oauth2', '~> 0.8'
-  gem.add_development_dependency 'json', '~> 1.6'
-  gem.add_development_dependency 'rake', '~> 0.9'
-  gem.add_development_dependency 'rdoc', '~> 3.8'
-  gem.add_development_dependency 'rspec', '~> 2.6'
-  gem.add_development_dependency 'simplecov', '~> 0.5'
-  gem.add_development_dependency 'vcr', '~> 1.10'
-  gem.add_development_dependency 'webmock', '~> 1.9'
-  gem.authors = ["Evan Morikawa", "Wynn Netherland", "Josh Kalderimis"]
-  gem.description = %q{Ruby wrapper for the LinkedIn OAuth 2.0 API}
-  gem.email = ['evan@evanmorikawa.com', 'wynn.netherland@gmail.com', 'josh.kalderimis@gmail.com']
-  gem.files = `git ls-files`.split("\n")
-  gem.homepage = 'http://github.com/emorikawa/linkedin-oauth2'
-  gem.name = 'linkedin-oauth2'
-  gem.require_paths = ['lib']
-  gem.summary = gem.description
-  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.version = LinkedIn::VERSION::STRING
+  gem.name        = "linkedin-oauth2"
+  gem.email       = ["evan@evanmorikawa.com"]
+  gem.version     = LinkedIn::VERSION
+  gem.authors     = ["Evan Morikawa"]
+  gem.summary     = "Ruby wrapper for the LinkedIn OAuth 2.0 API"
+  gem.license     = "MIT"
+  gem.homepage    = "http://github.com/emorikawa/linkedin-oauth2"
+  gem.description = gem.summary
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- spec/**/*`.split("\n")
+  gem.require_paths = ["lib"]
+
+  # To support native JSON. Same requirements as Rails.
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.add_dependency "oauth2",  "~> 1.0"
+  gem.add_dependency "hashie",  "~> 3.2"
+  gem.add_dependency "faraday", "~> 0.9"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 3.0"
+
+  # We use YARD for documentation
+  # Extra gems for GitHub flavored MarkDown in YARD
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "redcarpet"
+  gem.add_development_dependency "github-markdown"
+
+  # We use VCR to mock LinkedIn API calls
+  gem.add_development_dependency "vcr"
+  gem.add_development_dependency "webmock"
 end

data/spec/linked_in/api/api_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe LinkedIn::API do
+  context "With no access token" do
+    let(:err_msg) { LinkedIn::ErrorMessages.no_access_token }
+
+    it "Raises an error" do
+      expect{LinkedIn::API.new}.to raise_error(LinkedIn::InvalidRequest, err_msg)
+    end
+  end
+
+  shared_examples "test access token" do
+    it "Build a LinkedIn::API instance" do
+      expect(subject).to be_kind_of LinkedIn::API
+    end
+
+    it "Sets the access_token object" do
+      expect(subject.access_token).to be_kind_of LinkedIn::AccessToken
+    end
+
+    it "Sets the access_token string" do
+      expect(subject.access_token.token).to eq access_token
+    end
+  end
+
+  context "With a string access token" do
+    let(:access_token) { "dummy_access_token" }
+    subject {LinkedIn::API.new(access_token)}
+
+    include_examples "test access token"
+  end
+
+  context "With a LinkedIn::AccessToken object" do
+    let(:access_token) { "dummy_access_token" }
+    let(:access_token_obj) { LinkedIn::AccessToken.new(access_token) }
+
+    subject {LinkedIn::API.new(access_token_obj)}
+
+    include_examples "test access token"
+  end
+end

data/spec/linked_in/api/communications_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe LinkedIn::Communications do
+  let(:access_token) {"dummy_access_token"}
+  let(:api) {LinkedIn::API.new(access_token)}
+
+  it "should be able to send a message" do
+    stub_request(:post, "https://api.linkedin.com/v1/people/~/mailbox?oauth2_access_token=dummy_access_token").to_return(body: "", status: 201)
+    response = api.send_message("subject", "body", ["recip1", "recip2"])
+    expect(response.body).to eq ""
+    expect(response.status).to eq 201
+  end
+end

data/spec/linked_in/api/companies_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe LinkedIn::Companies do
+  let(:access_token) {"dummy_access_token"}
+  let(:api) {LinkedIn::API.new(access_token)}
+
+  def stub(url)
+    url += "oauth2_access_token=#{access_token}"
+    stub_request(:get, url).to_return(body: '{}')
+  end
+
+  it "should be able to view a company profile" do
+    stub("https://api.linkedin.com/v1/companies/1586?")
+    expect(api.company(id: 1586)).to be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to view a company by universal name" do
+    stub("https://api.linkedin.com/v1/companies/universal-name=acme?")
+    expect(api.company(name: "acme")).to be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to view a company by e-mail domain" do
+    stub("https://api.linkedin.com/v1/companies?email-domain=acme.com&")
+    expect(api.company(domain: "acme.com")).to be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should load correct company data" do
+    VCR.use_cassette("companies data") do
+      data = api.company(id: 1586, fields: %w{ id name industry locations:(address:(city state country-code) is-headquarters) employee-count-range })
+      expect(data.id).to eq 1586
+      expect(data.name).to eq "Amazon"
+      expect(data.industry).to eq "Internet"
+      expect(data.employee_count_range.name).to eq "10001+"
+      expect(data.locations.all[0].address.city).to eq "Seattle"
+      expect(data.locations.all[0].is_headquarters).to eq true
+    end
+  end
+
+  it "should be able to share a new company status" do
+    stub_request(:post, "https://api.linkedin.com/v1/companies/123456/shares?oauth2_access_token=#{access_token}").to_return(body: "", status: 201)
+    response = api.add_company_share("123456", { comment: "Testing, 1, 2, 3" })
+    expect(response.body).to eq ""
+    expect(response.status).to eq 201
+  end
+
+  it "should be able to follow a company" do
+    stub_request(:post, "https://api.linkedin.com/v1/people/~/following/companies?oauth2_access_token=#{access_token}").to_return(body: "", status: 201)
+    response = api.follow_company(1586)
+    expect(response.body).to eq ""
+    expect(response.status).to eq 201
+  end
+
+  it "should be able to unfollow a company" do
+    stub_request(:delete, "https://api.linkedin.com/v1/people/~/following/companies/id=1586?oauth2_access_token=#{access_token}").to_return(body: "", status: 201)
+    response = api.unfollow_company(1586)
+    expect(response.body).to eq ""
+    expect(response.status).to eq 201
+  end
+end

data/spec/linked_in/api/groups_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+describe LinkedIn::Groups do
+  let(:access_token) {"dummy_access_token"}
+  let(:api) {LinkedIn::API.new(access_token)}
+
+  def stub(url)
+    url += "oauth2_access_token=#{access_token}"
+    stub_request(:get, url).to_return(body: '{}')
+  end
+
+  it "should be able to list group memberships for a profile" do
+    stub("https://api.linkedin.com/v1/people/~/group-memberships?")
+    expect(api.group_memberships).to be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to list suggested groups for a profile" do
+    stub("https://api.linkedin.com/v1/people/~/suggestions/groups?")
+    expect(api.group_suggestions).to be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to parse nested fields" do
+    stub("https://api.linkedin.com/v1/people/~/group-memberships:(group:(id,name,small-logo-url,short-description))?")
+    expect(api.group_memberships(fields: [{group: ["id",
+                                                   "name",
+                                                   "small-logo-url",
+                                                   "short-description"]}])
+          ).to be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to join a group" do
+    stub_request(:put, "https://api.linkedin.com/v1/people/~/group-memberships/123?oauth2_access_token=#{access_token}").to_return(body: "", status: 201)
+
+    response = api.join_group(123)
+    expect(response.body).to eq ""
+    expect(response.status).to eq 201
+  end
+
+  it "should be able to list a group profile" do
+    stub("https://api.linkedin.com/v1/groups/123?")
+    expect(api.group_profile(:id => 123)).to be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to list group posts" do
+    stub("https://api.linkedin.com/v1/groups/123/posts?")
+    expect(api.group_posts(:id => 123)).to be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to share a new group status" do
+    stub_request(:post, "https://api.linkedin.com/v1/groups/1/posts?oauth2_access_token=#{access_token}").to_return(body: "", status: 201)
+    response = api.add_group_share(1, comment: "Testing, 1, 2, 3")
+    expect(response.body).to eq ""
+    expect(response.status).to eq 201
+  end
+end

data/spec/linked_in/api/jobs_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe LinkedIn::Jobs, helpers: :api do
+  let(:access_token) {"dummy_access_token"}
+  let(:api) {LinkedIn::API.new(access_token)}
+
+  def stub(url)
+    url += "oauth2_access_token=#{access_token}"
+    stub_request(:get, url).to_return(body: '{}')
+  end
+
+  it "should be able to view a job listing" do
+    stub("https://api.linkedin.com/v1/jobs/id=1586?")
+    expect(api.job(:id => 1586)).to be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to view its job bookmarks" do
+    stub("https://api.linkedin.com/v1/people/~/job-bookmarks?")
+    expect(api.job_bookmarks).to be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to view its job suggestion" do
+    stub("https://api.linkedin.com/v1/people/~/suggestions/job-suggestions?")
+    expect(api.job_suggestions).to be_an_instance_of(LinkedIn::Mash)
+  end
+
+  it "should be able to add a bookmark" do
+    stub_request(:post, "https://api.linkedin.com/v1/people/~/job-bookmarks?oauth2_access_token=#{access_token}").to_return(body: "", status: 201)
+    response = api.add_job_bookmark(id: 1452577)
+    expect(response.body).to eq ""
+    expect(response.status).to eq 201
+  end
+end

data/spec/linked_in/api/people_spec.rb

@@ -0,0 +1,181 @@
+describe LinkedIn::People do
+  let(:uid) {"SDmkCxL2ya"}
+  let(:url) {"http://www.linkedin.com/in/evanmorikawa"}
+  let(:access_token) {"dummy_access_token"}
+
+  let(:api) {LinkedIn::API.new(access_token)}
+
+  def verify(result)
+    expect(result).to be_kind_of LinkedIn::Mash
+  end
+
+  ###### PROFILES
+  # Self
+  it "grabs your own profile" do
+    VCR.use_cassette("people profile own") do
+      result = api.profile
+      verify result
+      expect(result["firstName"]).to be_kind_of String
+    end
+  end
+
+  # Secure
+  it "accepts secure-urls param via secure option" do
+    VCR.use_cassette("people profile own secure") do
+      verify api.profile(secure: true)
+    end
+  end
+
+  # Language
+  it "gets profiles in a different language" do
+    VCR.use_cassette("people profile lang spanish") do
+      verify api.profile(lang: "es")
+    end
+  end
+
+  # Others
+  it "gets another users profile by user id" do
+    VCR.use_cassette("people profile other uid") do
+      result = api.profile(id: uid)
+      verify result
+      expect(result["firstName"]).to be_kind_of String
+    end
+  end
+  it "gets another users profile by url" do
+    VCR.use_cassette("people profile other url") do
+      result = api.profile(url: url)
+      verify result
+      expect(result["firstName"]).to be_kind_of String
+    end
+  end
+  it "gets another users profile by user id" do
+    VCR.use_cassette("people profile other uid") do
+      verify api.profile(uid)
+    end
+  end
+  it "gets another users profile by url" do
+    VCR.use_cassette("people profile other url") do
+      verify api.profile(url)
+    end
+  end
+
+  # Errors
+  it "errors on bad input" do
+    expect{api.profile("Bad input")}.to raise_error
+  end
+  it "errors on email deprecation" do
+    msg = LinkedIn::ErrorMessages.deprecated
+    expect{api.profile(email: "email@email.com")}.to raise_error(LinkedIn::Deprecated, msg)
+  end
+
+  # Fields
+  it "grabs certain profile fields" do
+    VCR.use_cassette("people profile fields simple") do
+      result = api.profile(fields: ["id","industry"])
+      verify result
+      expect(result["industry"]).to be_kind_of String
+    end
+  end
+  it "grabs more complex profile fields" do
+    VCR.use_cassette("people profile fields complex") do
+      result = api.profile(fields: ["id",{"positions" => ["title"]}])
+      verify result
+      expect(result["positions"]["values"][0]["title"]).to be_kind_of String
+    end
+  end
+
+  # Multiple people
+  it "grabs multiple people by uids" do
+    VCR.use_cassette("people profile multiple uids") do
+      result = api.profile(ids: ["self", uid])
+      verify result
+      expect(result["values"].length).to eq 2
+    end
+  end
+  it "grabs multiple people by urls" do
+    VCR.use_cassette("people profile multiple urls") do
+      result = api.profile(urls: ["self", url])
+      verify result
+      expect(result["values"].length).to eq 2
+    end
+  end
+  it "grabs multiple people by uids and urls" do
+    VCR.use_cassette("people profile multiple uids and urls") do
+      result = api.profile(ids: ["self", uid], urls: [url])
+      verify result
+      expect(result["values"].length).to eq 3
+    end
+  end
+  it "grabs certain fields for multiple people" do
+    VCR.use_cassette("people profile multiple fields") do
+      result = api.profile(ids: ["self", uid], fields: ["id", "industry"])
+      verify result
+      expect(result["values"][0]["industry"]).to be_kind_of String
+    end
+  end
+
+  ###### CONNECTIONS
+  it "grabs your own connections" do
+    VCR.use_cassette("people profile connections self") do
+      result = api.connections
+      verify result
+      expect(result["values"].length).to eq 3
+    end
+  end
+  it "grabs the connections of others" do
+    VCR.use_cassette("people profile connections other") do
+      result = api.connections(id: uid)
+      verify result
+      expect(result["values"].length).to eq 3
+    end
+  end
+  it "grabs certain fields for those connections" do
+    VCR.use_cassette("people profile connections fields") do
+      result = api.connections(fields: ["id", "industry"])
+      verify result
+      expect(result["values"].length).to eq 4
+      expect(result["values"][0]["industry"]).to be_kind_of String
+    end
+  end
+
+  it "grabs new connections since a string date" do
+    VCR.use_cassette("people profile new connections self") do
+      result = api.new_connections("2014-01-01")
+      verify result
+      expect(result["values"].length).to eq 2
+    end
+  end
+  it "grabs new connections since a numeric date" do
+    VCR.use_cassette("people profile new connections self") do
+      verify api.new_connections(1388534400000)
+    end
+  end
+  it "grabs new connections since a Time.utc object" do
+    VCR.use_cassette("people profile new connections self") do
+      verify api.new_connections(Time.utc(2014,1,1))
+    end
+  end
+  it "grabs new connections for another user" do
+    VCR.use_cassette("people profile new connections other") do
+      result = api.new_connections("2014-01-01", id: uid)
+      verify result
+      expect(result["values"].length).to eq 2
+    end
+  end
+  it "grabs certain fields of new connections" do
+    VCR.use_cassette("people profile new connections fields") do
+      result = api.new_connections("2014-01-01", fields: ["id", "industry"])
+      verify result
+      expect(result["values"].length).to eq 3
+      expect(result["values"][0]["industry"]).to be_kind_of String
+    end
+  end
+
+  it "grabs picture urls" do
+    VCR.use_cassette("people picture urls") do
+      result = api.picture_urls
+      verify result
+      expect(result["values"][0] =~ URI::regexp).to_not be_nil
+    end
+  end
+end