cl_linkedin 0.2.3

data/.autotest

@@ -0,0 +1,14 @@
+Autotest.add_hook(:initialize) do |at|
+  at.add_exception(".git")
+end
+
+Autotest.add_hook(:initialize) do |at|
+  at.clear_mappings
+
+  at.add_mapping %r%/^lib/(.*)\.rb$% do |_, m|
+    possible = File.basename(m[1])
+    files_matching %r%^test/.*(#{possible}_test|test_#{possible})\.rb$%
+  end
+
+  at.add_mapping(%r%^test/.*\.rb$%) {|filename, _| filename }
+end

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+examples/wynn.rb
+
+## Bundler
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Wynn Netherland
+
+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.markdown

@@ -0,0 +1,80 @@
+# LinkedIn
+
+Ruby wrapper for the [LinkedIn API](http://developer.linkedin.com). Heavily inspired by [John Nunemaker's](http://github.com/jnunemaker) [Twitter gem](http://github.com/jnunemaker/twitter), the LinkedIn gem provides an easy-to-use wrapper for LinkedIn's Oauth/XML APIs.
+
+Travis CI : [![Build Status](http://travis-ci.org/pengwynn/linkedin.png)](http://travis-ci.org/pengwynn/linkedin)
+
+## Installation
+
+    [sudo] gem install linkedin
+
+## Usage
+
+### Authenticate
+
+LinkedIn's API uses Oauth for authentication. Luckily, the LinkedIn gem hides most of the gory details from you.
+
+    require 'rubygems'
+    require 'linkedin'
+
+    # get your api keys at https://www.linkedin.com/secure/developer
+    client = LinkedIn::Client.new('your_consumer_key', 'your_consumer_secret')
+    rtoken = client.request_token.token
+    rsecret = client.request_token.secret
+
+    # to test from your desktop, open the following url in your browser
+    # and record the pin it gives you
+    client.request_token.authorize_url
+    => "https://api.linkedin.com/uas/oauth/authorize?oauth_token=<generated_token>"
+
+    # then fetch your access keys
+    client.authorize_from_request(rtoken, rsecret, pin)
+    => ["OU812", "8675309"] # <= save these for future requests
+
+    # or authorize from previously fetched access keys
+    c.authorize_from_access("OU812", "8675309")
+
+    # you're now free to move about the cabin, call any API method
+
+### Profile examples
+
+    # get the profile for the authenticated user
+    client.profile
+
+    # get a profile for someone found in network via ID
+    client.profile(:id => 'gNma67_AdI')
+
+    # get a profile for someone via their public profile url
+    client.profile(:url => 'http://www.linkedin.com/in/netherland')
+
+
+
+More examples in the [examples folder](http://github.com/pengwynn/linkedin/blob/master/examples).
+
+For a nice example on using this in a [Rails App](http://pivotallabs.com/users/will/blog/articles/1096-linkedin-gem-for-a-web-app).
+
+If you want to play with the LinkedIn api without using the gem, have a look at the [apigee LinkedIn console](http://app.apigee.com/console/linkedin).
+
+Full request string for test XML data http://api.linkedin.com/v1/people/~:(id,first-name,last-name,headline,location,industry,distance,current-share,connections,num-connections,num-connections-capped,summary,specialties,proposal-comments,associations,honors,interests,positions,publications,patents,languages,skills,certifications,educations,three-current-positions,three-past-positions,num-recommenders,recommendations-received,phone-numbers,im-accounts,twitter-accounts,date-of-birth,main-address,member-url-resources,picture-url,site-standard-profile-request,api-public-profile-request,api-standard-profile-request,public-profile-url)
+
+## TODO
+
+* Change to json api
+* Update and correct test suite
+* Change to Faraday for authentication
+* Implement Messaging APIs
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009-11 [Wynn Netherland](http://wynnnetherland.com). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommened for running the tests'
+end
+
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["--color", '--format doc']
+end
+
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "linkedin #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.3

data/changelog.markdown

@@ -0,0 +1,76 @@
+# Changelog
+
+##  0.2.3 - July 20, 2011
+
+* Added twitter_accounts and profile fields missing from updated LinkedIn docs
+* Added im_accounts and profile fields missing from LinkedIn docs
+
+##  0.2.2 - March 3, 2010
+
+* Removed Crack as a dependency, Nokogiri FTW
+
+##  0.2.1 - March 1, 2010
+
+* Big dependency clean up, only OAuth and Nokogiri are really needed.
+
+* Use Nokogiri for xml generation (thanks Leonid Shevtsov - leonid-shevtsov)
+
+* Like and Likes supported
+
+* Escape querystring args
+
+* General coding cleanup
+
+* Added Languages, Skills, Publications, Patents and Phone Numbers (thanks Tadas Tamošauskas - medwezys)
+
+* Extra fields added to profile (thanks Tadas Tamošauskas - medwezys)
+
+* public\_profile\_field added to Profile (thanks troysteinbauer)
+
+* Added recommendations (thanks Erol)
+
+* Added current-share
+
+* Added default\_profile\__fields config option
+
+##  0.1.7 - February 5, 2010
+
+* New group join status support JGRP from Terry Ray
+
+##  0.1.6 - January 20, 2010
+
+* Fixed bug with network status update connection collections - thanks Terry Ray
+
+##  0.1.5 - January 13, 2010
+
+* Added education and profile fields missing from updated LinkedIn docs
+
+##  0.1.4 - January 13, 2010
+
+* Applied patch for position end month/year from @holman
+
+##  0.1.3 - December 24, 2009
+
+* Added configure block for easier initialization of consumer token, secret
+
+##  0.1.1 - December 8, 2009
+
+* Applied patch from [nfo](http://github.com/nfo) to fix error handling
+
+## 0.1.0 - November 25, 2009
+
+* Network updates API support
+
+* Search API support
+
+* Updates API support
+
+## 0.0.2 - November 25, 2009
+
+* Swapped out Crack for ROXML for prettier object access
+
+* Added more tests for Profile API
+
+## 0.0.1 - November 24, 2009
+
+* Initial release

data/examples/authenticate.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'cl_linkedin'
+
+# get your api keys at https://www.linkedin.com/secure/developer
+client = LinkedIn::Client.new('LinkedInAPIKey', 'LinkedInAPISecret')
+rtoken = client.request_token.token
+rsecret = client.request_token.secret
+
+# to test from your desktop, open the following url in your browser
+# and record the pin it gives you
+client.request_token.authorize_url
+=> "https://api.linkedin.com/uas/oauth/authorize?oauth_token=<generated_token>"
+
+# then fetch your access keys
+client.authorize_from_request(rtoken, rsecret, pin)
+=> ["OU812", "8675309"] # <= save these for future requests
+
+# or authorize from previously fetched access keys
+client.authorize_from_access("", "")
+
+# you're now free to move about the cabin, call any API method

data/examples/network.rb

@@ -0,0 +1,12 @@
+# AUTHENTICATE FIRST found in examples/authenticate.rb
+
+# client is a LinkedIn::Client
+
+# get network updates for the authenticated user
+client.network_updates
+
+# get profile picture changes
+client.network_updates(:type => 'PICT')
+
+# view connections for the currently authenticated user
+client.connections

data/examples/profile.rb

@@ -0,0 +1,12 @@
+# AUTHENTICATE FIRST found in examples/authenticate.rb
+
+# client is a LinkedIn::Client
+
+# get the profile for the authenticated user
+client.profile
+
+# get a profile for someone found in network via ID
+client.profile(:id => 'gNma67_AdI')
+
+# get a profile for someone via their public profile url
+client.profile(:url => 'http://www.linkedin.com/in/netherland')

data/examples/status.rb

@@ -0,0 +1,9 @@
+# AUTHENTICATE FIRST found in examples/authenticate.rb
+
+# client is a LinkedIn::Client
+
+# update status for the authenticated user
+client.update_status('is playing with the LinkedIn Ruby gem')
+
+# clear status for the currently logged in user
+client.clear_status

data/lib/linked_in/api_standard_profile_request.rb

@@ -0,0 +1,17 @@
+module LinkedIn
+  class ApiStandardProfileRequest < LinkedIn::Base
+
+    def url
+      @doc.xpath("//api-standard-profile-request/url").text
+    end
+
+    # returning a hash should be ok, but suggestions are welcome
+    def headers
+      hash = {}
+      hash[:name]  = @doc.xpath("//api-standard-profile-request/headers/http-header/name").text
+      hash[:value] = @doc.xpath("//api-standard-profile-request/headers/http-header/value").text
+      hash
+    end
+
+  end
+end

data/lib/linked_in/authorization_helpers.rb

@@ -0,0 +1,48 @@
+module LinkedIn
+
+  module AuthorizationHelpers
+
+    def consumer
+      @consumer ||= begin
+        options = { :site => 'https://api.linkedin.com' }.merge(@consumer_options)
+        ::OAuth::Consumer.new(@ctoken, @csecret, options)
+      end
+    end
+
+    def set_callback_url(url)
+      clear_request_token
+      request_token(:oauth_callback => url)
+    end
+
+    # Note: If using oauth with a web app, be sure to provide :oauth_callback.
+    # Options:
+    #   :oauth_callback => String, url that LinkedIn should redirect to
+    def request_token(options={})
+      @request_token ||= consumer.get_request_token(options)
+    end
+
+    # For web apps use params[:oauth_verifier], for desktop apps,
+    # use the verifier is the pin that LinkedIn gives users.
+    def authorize_from_request(rtoken, rsecret, verifier_or_pin)
+      request_token = ::OAuth::RequestToken.new(consumer, rtoken, rsecret)
+      access_token = request_token.get_access_token(:oauth_verifier => verifier_or_pin)
+      @atoken, @asecret = access_token.token, access_token.secret
+    end
+
+    def access_token
+      @access_token ||= ::OAuth::AccessToken.new(consumer, @atoken, @asecret)
+    end
+
+    def authorize_from_access(atoken, asecret)
+      @atoken, @asecret = atoken, asecret
+    end
+
+    private
+
+      def clear_request_token
+        @request_token = nil
+      end
+
+  end
+
+end

data/lib/linked_in/base.rb

@@ -0,0 +1,13 @@
+module LinkedIn
+  class Base
+
+    def self.from_xml(doc)
+      new(Nokogiri::XML(doc))
+    end
+
+    def initialize(doc)
+      @doc = doc
+    end
+
+  end
+end

data/lib/linked_in/birthdate.rb

@@ -0,0 +1,21 @@
+module LinkedIn
+  class Birthdate < LinkedIn::Base
+
+    def year
+      @year ||= @doc.xpath("/person/date-of-birth/year").text.to_i
+    end
+
+    def day
+      @day ||= @doc.xpath("/person/date-of-birth/day").text.to_i
+    end
+
+    def month
+      @month ||= @doc.xpath("/person/date-of-birth/month").text.to_i
+    end
+
+    def to_date
+      Date.civil(y=year,m=month,d=day)
+    end
+
+  end
+end

data/lib/linked_in/client.rb

@@ -0,0 +1,154 @@
+module LinkedIn
+  class Client
+    include ToXmlHelpers
+    include RequestHelpers
+    include AuthorizationHelpers
+
+    attr_reader :ctoken, :csecret, :consumer_options
+
+    def initialize(ctoken=LinkedIn.token, csecret=LinkedIn.secret, options={})
+      opts = {
+        :request_token_path => "/uas/oauth/requestToken",
+        :access_token_path  => "/uas/oauth/accessToken",
+        :authorize_path     => "/uas/oauth/authorize"
+      }
+      @ctoken, @csecret, @consumer_options = ctoken, csecret, opts.merge(options)
+    end
+    
+    def profile(options={})
+      path   = person_path(options)
+      fields = options[:fields] || LinkedIn.default_profile_fields
+
+      if options[:public]
+        path +=":public"
+      elsif fields
+        path +=":(#{fields.map{ |f| f.to_s.gsub("_","-") }.join(',')})"
+      end
+
+      Profile.from_xml(get(path))
+    end
+
+    def connections(options={})
+      path = "#{person_path(options)}/connections"
+      fields = options[:fields] || LinkedIn.default_profile_fields
+
+      if options[:public]
+        path +=":public"
+      elsif fields
+        path +=":(#{fields.map{ |f| f.to_s.gsub("_","-") }.join(',')})"
+      end
+
+      Connections.from_xml(get(path)).profiles
+    end
+
+    def search(options={})
+      path = "/people"
+      options = { :keywords => options } if options.is_a?(String)
+      options = format_options_for_query(options)
+
+      People.from_xml(get(to_uri(path, options)))
+    end
+
+    def current_status
+      path = "/people/~/current-status"
+      Nokogiri::XML(get(path)).xpath('//current-status').text
+    end
+
+    def update_status(text)
+      path = "/people/~/current-status"
+      put(path, status_to_xml(text))
+    end
+
+    def share(options={})
+      path = "/people/~/shares"
+      defaults = { :visability => 'anyone' }
+      post(path, share_to_xml(defaults.merge(options)))
+    end
+
+    def update_comment(network_key, comment)
+      path = "/people/~/network/updates/key=#{network_key}/update-comments"
+      post(path, comment_to_xml(comment))
+    end
+
+    def like(network_key, is_liked=true)
+      path = "/people/~/network/updates/key=#{network_key}/is-liked"
+      put(path, is_liked_to_xml(is_liked))
+    end
+
+    def likes(network_key)
+      path = "/people/~/network/updates/key=#{network_key}/likes"
+      Likes.from_xml(get(path)).likes
+    end
+
+    def update_network(message)
+      path = "/people/~/person-activities"
+      post(path, network_update_to_xml(message))
+    end
+
+    def clear_status
+      path = "/people/~/current-status"
+      delete(path).code
+    end
+
+    def send_message(subject, body, recipient_paths)
+      path = "/people/~/mailbox"
+
+      message         = LinkedIn::Message.new
+      message.subject = subject
+      message.body    = body
+      recipients      = LinkedIn::Recipients.new
+
+      recipients.recipients = recipient_paths.map do |profile_path|
+        recipient             = LinkedIn::Recipient.new
+        recipient.person      = LinkedIn::Person.new
+        recipient.person.path = "/people/#{profile_path}"
+        recipient
+      end
+
+      message.recipients = recipients
+      post(path, message_to_xml(message)).code
+    end
+
+    def network_statuses(options={})
+      options[:type] = 'STAT'
+      network_updates(options)
+    end
+
+    def network_updates(options={})
+      path = "/people/~/network"
+      Network.from_xml(get(to_uri(path, options)))
+    end
+
+    # helpful in making authenticated calls and writing the
+    # raw xml to a fixture file
+    def write_fixture(path, filename)
+      file = File.new("test/fixtures/#{filename}", "w")
+      file.puts(access_token.get(path).body)
+      file.close
+    end
+
+    private
+
+      def format_options_for_query(opts)
+        opts.keys.each do |key|
+          value = opts.delete(key)
+          value = value.join("+") if value.is_a?(Array)
+          value = value.gsub(" ", "+") if value.is_a?(String)
+          opts[key.to_s.gsub("_","-")] = value
+        end
+        opts
+      end
+
+      def person_path(options)
+        path = "/people/"
+        if options[:id]
+          path += "id=#{options[:id]}"
+        elsif options[:url]
+          path += "url=#{CGI.escape(options[:url])}"
+        else
+          path += "~"
+        end
+      end
+
+  end
+end