linkedin 0.2.2 → 0.3.1

data/spec/cases/linkedin_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require 'helper'
 
 describe LinkedIn do
 
@@ -9,10 +9,10 @@ describe LinkedIn do
   end
 
   it "should be able to set the consumer token and consumer secret" do
-    LinkedIn.token = 'consumer_token'
+    LinkedIn.token  = 'consumer_token'
     LinkedIn.secret = 'consumer_secret'
 
-    LinkedIn.token.should == 'consumer_token'
+    LinkedIn.token.should  == 'consumer_token'
     LinkedIn.secret.should == 'consumer_secret'
   end
 
@@ -24,14 +24,14 @@ describe LinkedIn do
 
   it "should be able to set the consumer token and consumer secret via a configure block" do
     LinkedIn.configure do |config|
-      config.token = 'consumer_token'
+      config.token  = 'consumer_token'
       config.secret = 'consumer_secret'
       config.default_profile_fields = ['education', 'positions']
     end
 
-    LinkedIn.token.should == 'consumer_token'
+    LinkedIn.token.should  == 'consumer_token'
     LinkedIn.secret.should == 'consumer_secret'
     LinkedIn.default_profile_fields.should == ['education', 'positions']
   end
 
-end
+end

data/spec/cases/mash_spec.rb

@@ -0,0 +1,85 @@
+require 'helper'
+
+describe LinkedIn::Mash do
+
+  describe ".from_json" do
+    it "should convert a json string to a Mash" do
+      json_string = "{\"name\":\"Josh Kalderimis\"}"
+      mash = LinkedIn::Mash.from_json(json_string)
+
+      mash.should have_key('name')
+      mash.name.should == 'Josh Kalderimis'
+    end
+  end
+
+  describe "#convert_keys" do
+    let(:mash) do
+      LinkedIn::Mash.new({
+        'firstName' => 'Josh',
+        'LastName' => 'Kalderimis',
+        '_key' => 1234,
+        '_total' => 1234,
+        'values' => {},
+        'numResults' => 'total_results'
+      })
+    end
+
+    it "should convert camal cased hash keys to underscores" do
+      mash.should have_key('first_name')
+      mash.should have_key('last_name')
+    end
+
+    it "should convert the key _key to id" do
+      mash.should have_key('id')
+    end
+
+    it "should convert the key _total to total" do
+      mash.should have_key('total')
+    end
+
+    it "should convert the key values to all" do
+      mash.should have_key('all')
+    end
+
+    it "should convert the key numResults to total_results" do
+      mash.should have_key('total_results')
+    end
+  end
+
+  describe '#timestamp' do
+    it "should return a valid Time if a key of timestamp exists and the value is an int" do
+      time_mash = LinkedIn::Mash.new({ 'timestamp' => 1297083249 })
+
+      time_mash.timestamp.should be_a_kind_of(Time)
+      time_mash.timestamp.to_i.should  == 1297083249
+    end
+
+    it "should return a valid Time if a key of timestamp exists and the value is an int which is greater than 9999999999" do
+      time_mash = LinkedIn::Mash.new({ 'timestamp' => 1297083249 * 1000 })
+
+      time_mash.timestamp.should be_a_kind_of(Time)
+      time_mash.timestamp.to_i.should  == 1297083249
+    end
+
+    it "should not try to convert to a Time object if the value isn't an Integer" do
+      time_mash = LinkedIn::Mash.new({ 'timestamp' => 'Foo' })
+
+      time_mash.timestamp.class.should be String
+    end
+  end
+
+  describe "#to_date" do
+    let(:date_mash) do
+      LinkedIn::Mash.new({
+        'year' => 2010,
+        'month' => 06,
+        'day' => 23
+      })
+    end
+
+    it "should return a valid Date if the keys year, month, day all exist" do
+      date_mash.to_date.should == Date.civil(2010, 06, 23)
+    end
+  end
+
+end

data/spec/cases/oauth_spec.rb

@@ -1,109 +1,163 @@
-require 'spec_helper'
-
-describe "LinkedIn::Client OAuth" do
-  let(:client) { LinkedIn::Client.new('token', 'secret') }
-  
-  it "should initialize with consumer token and secret" do
-    client.ctoken.should == 'token'
-    client.csecret.should == 'secret'
-  end
+require 'helper'
 
-  it "should set authorization path to '/uas/oauth/authorize' by default" do
-    client.consumer.options[:authorize_path].should == '/uas/oauth/authorize'
-  end
+describe "LinkedIn::Client" do
 
-  it "should have a consumer" do
-    consumer = mock('oauth consumer')
-    options = {
-      :request_token_path => "/uas/oauth/requestToken",
-      :access_token_path  => "/uas/oauth/accessToken",
-      :authorize_path     => "/uas/oauth/authorize",
-      :site => 'https://api.linkedin.com'
-    }
-    OAuth::Consumer.should_receive(:new).with('token', 'secret', options).and_return(consumer)
-
-    client.consumer.should == consumer
+  let(:client) do
+    key    = ENV['LINKED_IN_CONSUMER_KEY'] || '1234'
+    secret = ENV['LINKED_IN_CONSUMER_SECRET'] || '1234'
+    LinkedIn::Client.new(key, secret)
   end
 
-  it "should have a request token from the consumer" do
-    options = {
-      :request_token_path => "/uas/oauth/requestToken",
-      :access_token_path  => "/uas/oauth/accessToken",
-      :authorize_path     => "/uas/oauth/authorize",
-      :site => 'https://api.linkedin.com'
-    }
-    consumer = mock('oauth consumer')
-    request_token = mock('request token')
-    consumer.should_receive(:get_request_token).and_return(request_token)
-    OAuth::Consumer.should_receive(:new).with('token', 'secret', options).and_return(consumer)
-
-    client.request_token.should == request_token
+  describe "#consumer" do
+    describe "default oauth options" do
+      let(:consumer) { client.consumer }
+
+      it "should return a configured OAuth consumer" do
+        consumer.site.should == ''
+        consumer.request_token_url.should == 'https://api.linkedin.com/uas/oauth/requestToken'
+        consumer.access_token_url.should == 'https://api.linkedin.com/uas/oauth/accessToken'
+        consumer.authorize_url.should == 'https://www.linkedin.com/uas/oauth/authorize'
+      end
+    end
+
+    describe "different api and auth hosts options" do
+      let(:consumer) do
+        LinkedIn::Client.new('1234', '1234', {
+          :api_host => 'https://api.josh.com',
+          :auth_host => 'https://www.josh.com'
+        }).consumer
+      end
+
+      it "should return a configured OAuth consumer" do
+        consumer.request_token_url.should == 'https://api.josh.com/uas/oauth/requestToken'
+        consumer.access_token_url.should == 'https://api.josh.com/uas/oauth/accessToken'
+        consumer.authorize_url.should == 'https://www.josh.com/uas/oauth/authorize'
+      end
+    end
+
+    describe "different oauth paths" do
+      let(:consumer) do
+        LinkedIn::Client.new('1234', '1234', {
+          :request_token_path => "/secure/oauth/requestToken",
+          :access_token_path  => "/secure/oauth/accessToken",
+          :authorize_path     => "/secure/oauth/authorize",
+        }).consumer
+      end
+
+      it "should return a configured OAuth consumer" do
+        consumer.request_token_url.should == 'https://api.linkedin.com/secure/oauth/requestToken'
+        consumer.access_token_url.should == 'https://api.linkedin.com/secure/oauth/accessToken'
+        consumer.authorize_url.should == 'https://www.linkedin.com/secure/oauth/authorize'
+      end
+    end
+
+    describe "specify oauth urls" do
+      let(:consumer) do
+        LinkedIn::Client.new('1234', '1234', {
+          :request_token_url => "https://api.josh.com/secure/oauth/requestToken",
+          :access_token_url  => "https://api.josh.com/secure/oauth/accessToken",
+          :authorize_url     => "https://www.josh.com/secure/oauth/authorize",
+        }).consumer
+      end
+
+      it "should return a configured OAuth consumer" do
+        consumer.request_token_url.should == 'https://api.josh.com/secure/oauth/requestToken'
+        consumer.access_token_url.should == 'https://api.josh.com/secure/oauth/accessToken'
+        consumer.authorize_url.should == 'https://www.josh.com/secure/oauth/authorize'
+      end
+    end
+
+    describe "use the :site option to specify the host of all oauth urls" do
+      let(:consumer) do
+        LinkedIn::Client.new('1234', '1234', {
+          :site => "https://api.josh.com"
+        }).consumer
+      end
+
+      it "should return a configured OAuth consumer" do
+        consumer.request_token_url.should == 'https://api.josh.com/uas/oauth/requestToken'
+        consumer.access_token_url.should == 'https://api.josh.com/uas/oauth/accessToken'
+        consumer.authorize_url.should == 'https://api.josh.com/uas/oauth/authorize'
+      end
+    end
   end
 
-  it "#set_callback_url should clear the request token and set the callback url" do
-    consumer = mock('oauth consumer')
-    request_token = mock('request token')
-    options = {
-            :request_token_path => "/uas/oauth/requestToken",
-            :access_token_path  => "/uas/oauth/accessToken",
-            :authorize_path     => "/uas/oauth/authorize",
-            :site => 'https://api.linkedin.com'
-          }
-    OAuth::Consumer.
-      should_receive(:new).
-      with('token', 'secret', options).
-      and_return(consumer)
-
-    linkedin = LinkedIn::Client.new('token', 'secret')
-
-    consumer.
-      should_receive(:get_request_token).
-      with({:oauth_callback => 'http://myapp.com/oauth_callback'})
-
-    linkedin.set_callback_url('http://myapp.com/oauth_callback')
+  describe "#request_token" do
+    describe "with default options" do
+      use_vcr_cassette :record => :new_episodes
+
+      it "should return a valid request token" do
+        request_token = client.request_token
+
+        request_token.should be_a_kind_of OAuth::RequestToken
+        request_token.authorize_url.should include("https://www.linkedin.com/uas/oauth/authorize?oauth_token=")
+
+        a_request(:post, "https://api.linkedin.com/uas/oauth/requestToken").should have_been_made.once
+      end
+    end
+
+    describe "with a callback url" do
+      use_vcr_cassette :record => :new_episodes
+
+      it "should return a valid access token" do
+        request_token = client.request_token(:oauth_callback => 'http://www.josh.com')
+
+        request_token.should be_a_kind_of OAuth::RequestToken
+        request_token.authorize_url.should include("https://www.linkedin.com/uas/oauth/authorize?oauth_token=")
+        request_token.callback_confirmed?.should == true
+
+        a_request(:post, "https://api.linkedin.com/uas/oauth/requestToken").should have_been_made.once
+      end
+    end
   end
 
-  it "should be able to create access token from request token, request secret and verifier" do
-    consumer = OAuth::Consumer.new('token', 'secret', {:site => 'https://api.linkedin.com'})
-    client.stub(:consumer).and_return(consumer)
-
-    access_token  = mock('access token', :token => 'atoken', :secret => 'asecret')
-    request_token = mock('request token')
-    request_token.
-      should_receive(:get_access_token).
-      with(:oauth_verifier => 'verifier').
-      and_return(access_token)
-
-    OAuth::RequestToken.
-      should_receive(:new).
-      with(consumer, 'rtoken', 'rsecret').
-      and_return(request_token)
-
-    client.authorize_from_request('rtoken', 'rsecret', 'verifier')
-    client.access_token.class.should be(OAuth::AccessToken)
-    client.access_token.token.should == 'atoken'
-    client.access_token.secret.should == 'asecret'
+  describe "#authorize_from_request" do
+    let(:access_token) do
+      # if you remove the related casssette you will need to do the following
+      # authorize_from_request request manually
+      #
+      # request_token = client.request_token
+      # puts "token    : #{request_token.token} - secret #{request_token.secret}"
+      # puts "auth url : #{request_token.authorize_url}"
+      # raise 'keep note of the token and secret'
+      #
+      client.authorize_from_request('dummy-token', 'dummy-secret', 'dummy-pin')
+    end
+
+    use_vcr_cassette :record => :new_episodes, :match_requests_on => [:uri, :method]
+
+    it "should return a valid access token" do
+      access_token.should be_a_kind_of Array
+      access_token[0].should be_a_kind_of String
+      access_token[1].should be_a_kind_of String
+
+      a_request(:post, "https://api.linkedin.com/uas/oauth/accessToken").should have_been_made.once
+    end
   end
 
-  it "should be able to create access token from access token and secret" do
-    consumer = OAuth::Consumer.new('token', 'secret', {:site => 'https://api.linkedin.com'})
-    client.stub(:consumer).and_return(consumer)
+  describe "#access_token" do
+    let(:access_token) do
+      client.authorize_from_access('dummy-token', 'dummy-secret')
+      client.access_token
+    end
 
-    client.authorize_from_access('atoken', 'asecret')
-    client.access_token.class.should be(OAuth::AccessToken)
-    client.access_token.token.should == 'atoken'
-    client.access_token.secret.should == 'asecret'
+    it "should return a valid auth token" do
+      access_token.should be_a_kind_of OAuth::AccessToken
+      access_token.token.should be_a_kind_of String
+      access_token.token.should be_a_kind_of String
+    end
   end
 
-  it "should be able to configure consumer token and consumer secret without passing to initialize" do
-    LinkedIn.configure do |config|
-      config.token = 'consumer_token'
-      config.secret = 'consumer_secret'
+  describe "#authorize_from_access" do
+    let(:auth_token) do
+      client.authorize_from_access('dummy-token', 'dummy-secret')
     end
 
-    linkedin = LinkedIn::Client.new
-    linkedin.ctoken.should == 'consumer_token'
-    linkedin.csecret.should == 'consumer_secret'
+    it "should return a valid auth token" do
+      auth_token.should be_a_kind_of Array
+      auth_token[0].should be_a_kind_of String
+      auth_token[1].should be_a_kind_of String
+    end
   end
 
-end
+end

data/spec/fixtures/cassette_library/LinkedIn_Client/_authorize_from_request.yml

@@ -0,0 +1,28 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: https://api.linkedin.com:443/uas/oauth/accessToken
+    body: 
+    headers: 
+      user-agent: 
+      - OAuth gem v0.4.4
+      authorization: 
+      - OAuth oauth_body_hash="2jmj7l5rSw0yVb%2FvlWAYkK%2FYBwk%3D", oauth_consumer_key="eAI15DqRUTTd7OuQJBG3Mo0aw2Ekx5yoLX3x3NaLnbTnZbaU46OEii7uNTKijII4", oauth_nonce="ztYyddIoKJ8flDjBJyveOSqm96CLaEM4QpOC0CSW0E", oauth_signature="NSp3ZDtycelP7wsDM7dsuDTZGys%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1297095033", oauth_token="2f5b42dd-1e0e-4f8f-a03c-1e510bde5935", oauth_verifier="25038", oauth_version="1.0"
+      content-length: 
+      - "0"
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - text/plain
+      server: 
+      - Apache-Coyote/1.1
+      date: 
+      - Mon, 07 Feb 2011 16:10:34 GMT
+      content-length: 
+      - "156"
+    body: oauth_token=28774cd4-fbe1-4e6e-a05e-1243f6471933&oauth_token_secret=2fafe259-976e-41ad-a6f5-d26bbba42923&oauth_expires_in=0&oauth_authorization_expires_in=0
+    http_version: "1.1"

data/spec/fixtures/cassette_library/LinkedIn_Client/_request_token.yml

@@ -0,0 +1,28 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: https://api.linkedin.com:443/uas/oauth/requestToken
+    body: 
+    headers: 
+      user-agent: 
+      - OAuth gem v0.4.4
+      authorization: 
+      - OAuth oauth_body_hash="2jmj7l5rSw0yVb%2FvlWAYkK%2FYBwk%3D", oauth_callback="oob", oauth_consumer_key="eAI15DqRUTTd7OuQJBG3Mo0aw2Ekx5yoLX3x3NaLnbTnZbaU46OEii7uNTKijII4", oauth_nonce="jSQpxoXaoTl2e0dALgc7VKzRJE993wqzRWuXuF0H0", oauth_signature="wn%2Bw0Jvyb9TQ4DC8sq3CxWMDM7Y%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1297093507", oauth_version="1.0"
+      content-length: 
+      - "0"
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - text/plain
+      server: 
+      - Apache-Coyote/1.1
+      date: 
+      - Mon, 07 Feb 2011 15:45:08 GMT
+      content-length: 
+      - "236"
+    body: oauth_token=95f8619b-7069-433b-ac9e-35dfba02b0f7&oauth_token_secret=dffd7996-6943-48ce-be6b-771e86b10f92&oauth_callback_confirmed=true&xoauth_request_auth_url=https%3A%2F%2Fapi.linkedin.com%2Fuas%2Foauth%2Fauthorize&oauth_expires_in=599
+    http_version: "1.1"

data/spec/fixtures/cassette_library/LinkedIn_Client/_request_token/with_a_callback_url.yml

@@ -0,0 +1,28 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: https://api.linkedin.com:443/uas/oauth/requestToken
+    body: 
+    headers: 
+      user-agent: 
+      - OAuth gem v0.4.4
+      authorization: 
+      - OAuth oauth_body_hash="2jmj7l5rSw0yVb%2FvlWAYkK%2FYBwk%3D", oauth_callback="http%3A%2F%2Fwww.josh.com", oauth_consumer_key="eAI15DqRUTTd7OuQJBG3Mo0aw2Ekx5yoLX3x3NaLnbTnZbaU46OEii7uNTKijII4", oauth_nonce="OYVkd4yi5oe16NGQMbANhBB8cabeynkTX28fOEjG1rs", oauth_signature="%2BwgZ8nb2CM5oWRpJEC5U0554uGk%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1297103790", oauth_version="1.0"
+      content-length: 
+      - "0"
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - text/plain
+      server: 
+      - Apache-Coyote/1.1
+      date: 
+      - Mon, 07 Feb 2011 18:36:30 GMT
+      content-length: 
+      - "236"
+    body: oauth_token=f8af7ca2-ca1a-48f2-be6a-bd7b721e2868&oauth_token_secret=c5ec7928-7740-4813-a202-2be8800a0b32&oauth_callback_confirmed=true&xoauth_request_auth_url=https%3A%2F%2Fapi.linkedin.com%2Fuas%2Foauth%2Fauthorize&oauth_expires_in=599
+    http_version: "1.1"