linkedin-idkmybffjill 0.1.9

data/Gemfile

@@ -0,0 +1,16 @@
+source :gemcutter
+
+gem 'oauth', '~> 0.3.5'
+gem 'nokogiri'
+gem 'crack', '>= 0.1.4'
+
+group :development do
+  gem 'jeweler'
+  gem 'rake'
+  gem 'test-unit'
+  # gem 'redgreen'
+  gem 'shoulda'
+  gem 'jnunemaker-matchy', "= 0.4.0", :require => 'matchy'
+  gem 'mocha'
+  gem 'fakeweb', ">= 1.2.5"
+end

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,74 @@
+# 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.
+
+## Installation
+
+    sudo gem install gemcutter
+    gem tumble
+    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).
+
+
+## TODO
+
+* 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 [Wynn Netherland](http://wynnnetherland.com). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "linkedin-idkmybffjill"
+    gem.summary = %Q{Ruby wrapper for the LinkedIn API}
+    gem.description = %Q{Ruby wrapper for the LinkedIn API}
+    gem.email = "wynn.netherland@gmail.com"
+    gem.homepage = "http://github.com/idkmybffjill/linkedin"
+    gem.authors = ["Wynn Netherland, idkmybffjill"]
+    gem.files   = FileList["[A-Z]*", "{lib,test}/**/*"]
+    
+    
+    gem.add_dependency('oauth', '~> 0.3.5')
+
+    # roxml dependency removed
+    # gem.add_dependency('roxml', '~> 3.1.3')
+    
+    gem.add_dependency('crack', '~> 0.1.4')
+    
+    # updated gem dependency to shoulda
+    # gem.add_development_dependency('thoughtbot-shoulda', '>= 2.10.1')
+    gem.add_development_dependency('shoulda', '>= 2.10.1')
+    
+    gem.add_development_dependency('jnunemaker-matchy', '0.4.0')
+    gem.add_development_dependency('mocha', '>= 0.9.4')
+    gem.add_development_dependency('fakeweb', '>= 1.2.5')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.ruby_opts << '-rubygems'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+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
+
+task :test => :check_dependencies
+
+task :default => :test
+
+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.1.9

data/examples/authenticate.rb

@@ -0,0 +1,21 @@
+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 

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,14 @@
+# 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/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,267 @@
+module LinkedIn
+  class Client
+
+    # TODO: @ http://developer.linkedin.com/docs/DOC-1061 && / DOC-1014
+    # add in client.get("/people/~:(im-accounts)")
+    #        client.get("/people/~:(twitter-accounts)")
+    #        client.get("/people/~:(date-of-birth)")
+    #        client.get("/people/~:(main-address)")
+    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 consumer
+      @consumer ||= ::OAuth::Consumer.new(@ctoken, @csecret, {:site => 'https://api.linkedin.com'}.merge(@consumer_options))
+    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
+
+    def get(path, options={})
+      path = "/v1#{path}"
+      response = access_token.get(path, options)
+      raise_errors(response)
+      response.body
+    end
+
+
+    def post(path, body='', options={})
+      path = "/v1#{path}"
+      response = access_token.post(path, body, options)
+      raise_errors(response)
+      response
+    end
+    
+    def put(path, body, options={})
+      path = "/v1#{path}"
+      response = access_token.put(path, body, options)
+      raise_errors(response)
+      response
+    end
+
+    def delete(path, options={})
+      path = "/v1#{path}"
+      response = access_token.delete(path, options)
+      raise_errors(response)
+      response
+    end
+
+
+    def profile(options={})
+
+      path = person_path(options)
+
+      unless options[:fields].nil?
+        if options[:public]
+          path +=":public"
+        else
+          path +=":(#{options[:fields].map{|f| f.to_s.gsub("_","-")}.join(',')})"
+        end
+      end
+
+      Profile.from_xml(get(path))
+    end
+
+    def connections(options={})
+      path = "#{person_path(options)}/connections"
+
+      unless options[:fields].nil?
+        if options[:public]
+          path +=":public"
+        else
+          path +=":(#{options[:fields].map{|f| f.to_s.gsub("_","-")}.join(',')})"
+        end
+      end
+
+      Connections.from_xml(get(path)).profiles
+    end
+
+    ##
+    #  usage:
+    #    dob = client.birthdate
+    #      returns a birthdate object allowing access to day, month, year
+    #      dob.to_date will return a DATE object
+    def birthdate
+      path = "/people/~:(date-of-birth)"
+      Birthdate.from_xml(get(path))
+    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"
+      Crack::XML.parse(get(path))['current_status']
+    end
+
+    def update_status(text)
+      path = "/people/~/current-status"
+      put(path, status_to_xml(text))
+    end
+
+    def update_comment(network_key, comment)
+      path = "/people/~/network/updates/key=#{network_key}/update-comments"
+      post(path,comment_to_xml(comment),{'Content-Type' => 'application/xml'})
+    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), { "Content-Type" => "text/xml" }).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 clear_request_token
+        @request_token = nil
+      end
+
+      def raise_errors(response)
+        # Even if the XML answer contains the HTTP status code, LinkedIn also sets this code
+        # in the HTTP answer (thankfully).
+        case response.code.to_i
+        when 400
+          data = LinkedIn::Error.from_xml(response.body)
+          raise RateLimitExceeded.new(data), "(#{response.code}): #{response.message} - #{data.code if data}"
+        when 401
+          data = LinkedIn::Error.from_xml(response.body)
+          raise Unauthorized.new(data), "(#{response.code}): #{response.message} - #{data.code if data}"
+        when 403
+          data = LinkedIn::Error.from_xml(response.body)
+          raise General.new(data), "(#{response.code}): #{response.message} - #{data.code if data}"
+        when 404
+          raise NotFound, "(#{response.code}): #{response.message}"
+        when 500
+          raise InformLinkedIn, "LinkedIn had an internal error. Please let them know in the forum. (#{response.code}): #{response.message}"
+        when 502..503
+          raise Unavailable, "(#{response.code}): #{response.message}"
+        end
+      end
+
+      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 to_query(options)
+        options.inject([]) do |collection, opt|
+          collection << "#{opt[0]}=#{opt[1]}"
+          collection
+        end * '&'
+      end
+
+      def to_uri(path, options)
+        uri = URI.parse(path)
+
+        if options && options != {}
+          uri.query = to_query(options)
+        end
+        uri.to_s
+      end
+
+      def person_path(options)
+        path = "/people/"
+        if options[:id]
+          path += "id=#{options[:id]}"
+        elsif options[:email]
+          path += "email=#{options[:email]}"
+        elsif options[:url]
+          path += "url=#{CGI.escape(options[:url])}"
+        else
+          path += "~"
+        end
+      end
+
+      def status_to_xml(status)
+        %Q{<?xml version="1.0" encoding="UTF-8"?>
+           <current-status>#{status}</current-status>}
+      end
+
+      def comment_to_xml(comment)
+        %Q{<?xml version="1.0" encoding="UTF-8"?><update-comment><comment>#{comment}</comment></update-comment>}
+      end
+      
+      def message_to_xml(message)
+        %Q{<?xml version="1.0" encoding="UTF-8"?>
+        #{message.to_xml}}
+      end
+    
+  end
+end