xing_api 0.1

data/lib/xing_api/activity/comment.rb

@@ -0,0 +1,17 @@
+module XingApi
+  class Activity::Comment < XingApi::Base
+
+    def self.list(activity_id, options={})
+      request(:get, "/v1/activities/#{activity_id}/comments", options)
+    end
+
+    def self.create(activity_id, comment, options={})
+      request(:post, "/v1/activities/#{activity_id}/comments", {:text => comment}.merge(options))
+    end
+
+    def self.delete(activity_id, comment_id, options={})
+      request(:delete, "/v1/activities/#{activity_id}/comments/#{comment_id}", options)
+    end
+
+  end
+end

data/lib/xing_api/activity/like.rb

@@ -0,0 +1,17 @@
+module XingApi
+  class Activity::Like < XingApi::Base
+
+    def self.list(activity_id, options={})
+      request(:get, "/v1/activities/#{activity_id}/likes", options)
+    end
+
+    def self.create(activity_id, options={})
+      request(:put, "/v1/activities/#{activity_id}/likes", options)
+    end
+
+    def self.delete(activity_id, options={})
+      request(:delete, "/v1/activities/#{activity_id}/likes", options)
+    end
+
+  end
+end

data/lib/xing_api/activity.rb

@@ -0,0 +1,17 @@
+module XingApi
+  class Activity < XingApi::Base
+
+    def self.find(activity_id, options={})
+      request(:get, "/v1/activities/#{activity_id}", options)
+    end
+
+    def self.delete(activity_id, options={})
+      request(:delete, "/v1/activities/#{activity_id}", options)
+    end
+
+    def self.share(activity_id, options={})
+      request(:post, "/v1/activities/#{activity_id}/share", options)
+    end
+
+  end
+end

data/lib/xing_api/base.rb

@@ -0,0 +1,18 @@
+module XingApi
+  class Base
+    class << self
+
+      def request(http_verb, url, options={})
+        client = options.delete(:client) || default_client
+        client.request(http_verb, url, options)
+      end
+
+      private
+
+      def default_client
+        XingApi::Client.new
+      end
+
+    end
+  end
+end

data/lib/xing_api/bookmark.rb

@@ -0,0 +1,17 @@
+module XingApi
+  class Bookmark < XingApi::Base
+
+    def self.list(options={})
+      request(:get, "/v1/users/me/bookmarks", options)
+    end
+
+    def self.create(user_id, options={})
+      request(:put, "/v1/users/me/bookmarks/#{user_id}", options)
+    end
+
+    def self.delete(user_id, options={})
+      request(:delete, "/v1/users/me/bookmarks/#{user_id}", options)
+    end
+
+  end
+end

data/lib/xing_api/client.rb

@@ -0,0 +1,112 @@
+module XingApi
+  class Client
+    include XingApi::ResponseHandler
+
+    OAUTH_ATTRIBUTES = [:consumer_key, :consumer_secret, :oauth_token, :oauth_token_secret]
+    attr_writer *OAUTH_ATTRIBUTES
+    attr_accessor :request_token_hash
+
+    class << self
+      attr_accessor :default_options
+
+      def configure(&block)
+        instance = self.new
+        yield instance
+        self.default_options = instance.send(:to_hash)
+      end
+    end # class << self
+
+    def initialize(options={})
+      options = (self.class.default_options ||= {}).merge(options)
+      OAUTH_ATTRIBUTES.each do |attribute|
+        send "#{attribute}=", options[attribute]
+      end
+    end
+
+    def request(http_verb, url, options={})
+      full_url = url + hash_to_params(options)
+      handle(access_token.request(http_verb, full_url))
+    end
+
+    def get_request_token(oauth_callback='oob')
+      ensure_attributes_are_set! %w(consumer_key consumer_secret)
+
+      request_token = request_token(oauth_callback)
+      self.request_token_hash = {
+        request_token: request_token.token,
+        request_token_secret: request_token.secret,
+        authorize_url: request_token.authorize_url
+      }
+    end
+
+    def get_access_token(verifier, options={})
+      ensure_attributes_are_set! %w(consumer_key consumer_secret)
+
+      options = request_token_hash.merge(options) if request_token_hash
+      request_token = options[:request_token] || raise('request_token missing')
+      request_token_secret = options[:request_token_secret] || raise('request_token_secret missing')
+
+      request_token = OAuth::RequestToken.new(consumer, request_token, request_token_secret)
+      access_token = request_token.get_access_token(:oauth_verifier => verifier)
+      self.oauth_token = access_token.token
+      self.oauth_token_secret = access_token.secret
+      {
+        access_token: access_token.token,
+        access_token_secret: access_token.secret
+      }
+    end
+
+    OAUTH_ATTRIBUTES.each do |attribute|
+      define_method(attribute) do
+        instance_variable_get("@#{attribute}") || self.class.default_options[attribute]
+      end
+    end
+
+    private
+
+    def to_hash
+      {
+        :consumer_key => consumer_key,
+        :consumer_secret => consumer_secret,
+        :oauth_token => oauth_token,
+        :oauth_token_secret => oauth_token_secret
+      }
+    end
+
+    def request_token(oauth_callback)
+      @request_token ||= consumer.get_request_token(:oauth_callback => oauth_callback)
+    end
+
+    def consumer
+      OAuth::Consumer.new(consumer_key, consumer_secret, xing_oauth_options)
+    end
+
+    def access_token
+      OAuth::AccessToken.new(consumer, oauth_token, oauth_token_secret)
+    end
+
+    def xing_oauth_options
+      {
+        :site               => ENV['XING_API_SITE'] || 'https://api.xing.com',
+        :request_token_path => '/v1/request_token',
+        :authorize_path     => '/v1/authorize',
+        :access_token_path  => '/v1/access_token',
+        :signature_method   => 'PLAINTEXT',
+        :oauth_version      => '1.0',
+        :scheme             => 'query_string'
+      }
+    end
+
+    def hash_to_params(hash)
+      return '' if hash.empty?
+      '?' + hash.map {|k,v| "#{k}=#{CGI.escape(v.to_s)}"}.join('&')
+    end
+
+    def ensure_attributes_are_set!(attribute_names)
+      Array(attribute_names).each do |attribute_name|
+        raise "#{attribute_name} is missing" unless send(attribute_name)
+      end
+    end
+
+  end
+end

data/lib/xing_api/contact/tag.rb

@@ -0,0 +1,9 @@
+module XingApi
+  class Contact::Tag < XingApi::Base
+
+    def self.list(user_id, options={})
+      request(:get, "/v1/users/me/contacts/#{user_id}/tags", options)
+    end
+
+  end
+end

data/lib/xing_api/contact.rb

@@ -0,0 +1,13 @@
+module XingApi
+  class Contact < XingApi::Base
+
+    def self.list(user_id, options={})
+      request(:get, "/v1/users/#{user_id}/contacts", options)
+    end
+
+    def self.shared(user_id, options={})
+      request(:get, "/v1/users/#{user_id}/contacts/shared", options)
+    end
+
+  end
+end

data/lib/xing_api/contact_request.rb

@@ -0,0 +1,25 @@
+module XingApi
+  class ContactRequest < XingApi::Base
+
+    def self.list(options={})
+      request(:get, '/v1/users/me/contact_requests', options)
+    end
+
+    def self.create(user_id, options={})
+      request(:post, "/v1/users/#{user_id}/contact_requests", options)
+    end
+
+    def self.accept(user_id, options={})
+      request(:put, "/v1/users/#{user_id}/contact_requests/me/accept", options)
+    end
+
+    def self.deny(user_id, options={})
+      request(:delete, "/v1/users/me/contact_requests/#{user_id}", options)
+    end
+
+    def self.sent(options={})
+      request(:get, '/v1/users/me/contact_requests/sent', options)
+    end
+
+  end
+end

data/lib/xing_api/conversation/attachment.rb

@@ -0,0 +1,17 @@
+module XingApi
+  class Conversation::Attachment < XingApi::Base
+
+    def self.list(conversation_id, options={})
+      request(:get, "/v1/users/me/conversations/#{conversation_id}/attachments", options)
+    end
+
+    def self.find(conversation_id, attachment_id, options={})
+      request(:get, "/v1/users/me/conversations/#{conversation_id}/attachments/#{attachment_id}", options)
+    end
+
+    def self.download_url(conversation_id, attachment_id, options={})
+      request(:post, "/v1/users/me/conversations/#{conversation_id}/attachments/#{attachment_id}/download", options)
+    end
+
+  end
+end

data/lib/xing_api/conversation/message.rb

@@ -0,0 +1,25 @@
+module XingApi
+  class Conversation::Message < XingApi::Base
+
+    def self.list(conversation_id, options={})
+      request(:get, "/v1/users/me/conversations/#{conversation_id}/messages", options)
+    end
+
+    def self.create(conversation_id, content, options={})
+      request(:post, "/v1/users/me/conversations/#{conversation_id}/messages", {:content => content}.merge(options))
+    end
+
+    def self.find(conversation_id, message_id, options={})
+      request(:get, "/v1/users/me/conversations/#{conversation_id}/messages/#{message_id}", options)
+    end
+
+    def self.read(conversation_id, message_id, options={})
+      request(:put, "/v1/users/me/conversations/#{conversation_id}/messages/#{message_id}/read", options)
+    end
+
+    def self.unread(conversation_id, message_id, options={})
+      request(:delete, "/v1/users/me/conversations/#{conversation_id}/messages/#{message_id}/read", options)
+    end
+
+  end
+end

data/lib/xing_api/conversation.rb

@@ -0,0 +1,37 @@
+module XingApi
+  class Conversation < XingApi::Base
+
+    def self.list(options={})
+      request(:get, '/v1/users/me/conversations', options)
+    end
+
+    def self.find(conversation_id, options={})
+      request(:get, "/v1/users/me/conversations/#{conversation_id}", options)
+    end
+
+    def self.create(recipient_ids, subject, content, options={})
+      request(:post, '/v1/users/me/conversations', {
+        :recipient_ids => recipient_ids,
+        :subject => subject,
+        :content => content
+      }.merge(options))
+    end
+
+    def self.delete(conversation_id, options={})
+      request(:delete, "/v1/users/me/conversations/#{conversation_id}", options)
+    end
+
+    def self.valid_recipient(recipient_id, options={})
+      request(:get, "/v1/users/me/conversations/valid_recipients/#{recipient_id}", options)
+    end
+
+    def self.invite(conversation_id, user_id, options={})
+      request(:put, "/v1/users/me/conversations/#{conversation_id}/participants/#{user_id}", options)
+    end
+
+    def self.read(conversation_id, options={})
+      request(:put, "/v1/users/me/conversations/#{conversation_id}/read", options)
+    end
+
+  end
+end

data/lib/xing_api/error.rb

@@ -0,0 +1,24 @@
+module XingApi
+  class Error < StandardError
+    attr_reader :status_code, :name, :text
+
+    def initialize(status_code, name = '', text = '')
+      @status_code = status_code
+      @name = name
+      @text = text
+      super(text)
+    end
+
+    def to_s
+      [status_code, name, text].join(' - ')
+    end
+
+  end
+
+  class OauthError             < XingApi::Error; end
+  class ServerError            < XingApi::Error; end
+  class AccessDeniedError      < XingApi::Error; end
+  class InvalidParameterError  < XingApi::Error; end
+  class InvalidOauthTokenError < XingApi::Error; end
+  class RateLimitExceededError < XingApi::Error; end
+end

data/lib/xing_api/geo_location.rb

@@ -0,0 +1,17 @@
+module XingApi
+  class GeoLocation < XingApi::Base
+
+    def self.create(accuracy, latitude, longitude, options={})
+      request(:put, '/v1/users/me/geo_location', {
+        :accuracy => accuracy,
+        :latitude => latitude,
+        :longitude => longitude
+      }.merge(options))
+    end
+
+    def self.nearby_users(options={})
+      request(:get, '/v1/users/me/nearby_users', options)
+    end
+
+  end
+end

data/lib/xing_api/invite.rb

@@ -0,0 +1,9 @@
+module XingApi
+  class Invite < XingApi::Base
+
+    def self.create(emails, options={})
+      request(:post, '/v1/users/invite', {:to_emails => emails}.merge(options))
+    end
+
+  end
+end

data/lib/xing_api/job.rb

@@ -0,0 +1,17 @@
+module XingApi
+  class Job < XingApi::Base
+
+    def self.find(job_id, options={})
+      request(:get, "/v1/jobs/#{job_id}", options)
+    end
+
+    def self.search(query, options={})
+      request(:get, '/v1/jobs/find', {:query => query}.merge(options))
+    end
+
+    def self.recommendations(options={})
+      request(:get, '/v1/users/me/jobs/recommendations', options)
+    end
+
+  end
+end

data/lib/xing_api/profile_message.rb

@@ -0,0 +1,17 @@
+module XingApi
+  class ProfileMessage < XingApi::Base
+
+    def self.find(user_id, options={})
+      request(:get, "/v1/users/#{user_id}/profile_message", options)
+    end
+
+    def self.update(message, options={})
+      request(:put, '/v1/users/me/profile_message', {:message => message}.merge(options))
+    end
+
+    def self.delete(options={})
+      request(:put, '/v1/users/me/profile_message', {:message => ''}.merge(options))
+    end
+
+  end
+end

data/lib/xing_api/profile_visit.rb

@@ -0,0 +1,13 @@
+module XingApi
+  class ProfileVisit < XingApi::Base
+
+    def self.list(options={})
+      request(:get, '/v1/users/me/visits', options)
+    end
+
+    def self.create(user_id, options={})
+      request(:post, "/v1/users/#{user_id}/visits", options)
+    end
+
+  end
+end

data/lib/xing_api/response_handler.rb

@@ -0,0 +1,69 @@
+module XingApi
+  module ResponseHandler
+
+    OAUTH_ERROR_RESPONSES = %w(
+      INVALID_OAUTH_CONSUMER
+      CONSUMER_MISMATCH
+      INVALID_OAUTH_SIGNATURE_METHOD
+      INVALID_OAUTH_SIGNATURE
+      INVALID_TIMESTAMP
+      TIMESTAMP_EXPIRED
+      NONCE_ALREADY_USED
+      NONCE_MISSING
+      INVALID_OAUTH_VERSION
+      REQUIRED_PARAMETER_MISSING
+    )
+
+    def handle(response)
+      return {} if response.code.to_i == 204
+
+      unless (200..299).include?(response.code.to_i)
+        raise_failed_response!(response)
+      end
+
+      JSON.parse(response.body.to_s, :symbolize_names => true)
+    rescue JSON::ParserError
+      {}
+    end
+
+    private
+
+    def raise_failed_response!(response)
+      status_code = response.code.to_i
+      body = parse_json(response)
+      error_class = failed_response_for(status_code, body[:error_name])
+
+      raise error_class.new(status_code, body[:error_name], body[:message])
+    end
+
+    def failed_response_for(status_code, error_name)
+      case status_code
+      when 401
+        case error_name
+        when *OAUTH_ERROR_RESPONSES
+          XingApi::OauthError
+        when 'INVALID_OAUTH_TOKEN'
+          XingApi::InvalidOauthTokenError
+        end
+      when 403
+        case error_name
+        when 'RATE_LIMIT_EXCEEDED'
+          XingApi::RateLimitExceededError
+        when 'ACCESS_DENIED'
+          XingApi::AccessDeniedError
+        when 'INVALID_PARAMETERS'
+          XingApi::InvalidParameterError
+        end
+      when (500..504)
+        XingApi::ServerError
+      end || XingApi::Error
+    end
+
+    def parse_json(response)
+      body = JSON.parse(response.body.to_s, :symbolize_names => true)
+    rescue JSON::ParserError
+      { message: response.body.to_s }
+    end
+
+  end
+end

data/lib/xing_api/user/recommendation.rb

@@ -0,0 +1,13 @@
+module XingApi
+  class User::Recommendation < XingApi::Base
+
+    def self.list(options={})
+      request(:get, '/v1/users/me/network/recommendations', options)
+    end
+
+    def self.delete(user_id, options={})
+      request(:delete, "/v1/users/me/network/recommendations/user/#{user_id}", options)
+    end
+
+  end
+end

data/lib/xing_api/user.rb

@@ -0,0 +1,41 @@
+module XingApi
+  class User < XingApi::Base
+
+    def self.find(user_id, options={})
+      request(:get, "/v1/users/#{user_id}", options)
+    end
+
+    def self.me(options={})
+      find('me', options)
+    end
+
+    def self.id_card(options={})
+      request(:get, '/v1/users/me/id_card', options)
+    end
+
+    def self.activities(user_id, options={})
+      request(:get, "/v1/users/#{user_id}/feed", options)
+    end
+
+    def self.network_activities(options={})
+      request(:get, "/v1/users/me/network_feed", options)
+    end
+
+    def self.shared(user_id, options={})
+      request(:get, "/v1/users/#{user_id}/contacts/shared", options)
+    end
+
+    def self.paths(user_id, options={})
+      request(:get, "/v1/users/me/network/#{user_id}/paths", options)
+    end
+
+    def self.find_by_emails(emails, options={})
+      request(:get, '/v1/users/find_by_emails', {:emails => emails}.merge(options))
+    end
+
+    def self.status_message(message, options={})
+      request(:post, '/v1/users/me/status_message', {:message => message}.merge(options))
+    end
+
+  end
+end

data/lib/xing_api/version.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+module XingApi
+  VERSION = '0.1' unless defined?(XingApi::VERSION)
+end

data/lib/xing_api.rb

@@ -0,0 +1,29 @@
+require 'oauth'
+require 'oauth/signature/plaintext'
+require 'json'
+
+require 'xing_api/response_handler'
+require 'xing_api/client'
+require 'xing_api/base'
+require 'xing_api/error'
+
+require 'xing_api/activity'
+require 'xing_api/activity/comment'
+require 'xing_api/activity/like'
+require 'xing_api/bookmark'
+require 'xing_api/contact'
+require 'xing_api/contact/tag'
+require 'xing_api/contact_request'
+require 'xing_api/conversation'
+require 'xing_api/conversation/attachment'
+require 'xing_api/conversation/message'
+require 'xing_api/geo_location'
+require 'xing_api/invite'
+require 'xing_api/job'
+require 'xing_api/profile_message'
+require 'xing_api/profile_visit'
+require 'xing_api/user'
+require 'xing_api/user/recommendation'
+
+module XingApi
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: xing_api
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Mark Schmidt
+- Johannes Strampe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.7
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides access to every endpoint of the XING API. Takes care of oauth,
+  reponse parsing and simplifies error handling. You can get the required consumer_key
+  and consumer_secret at https://dev.xing.com
+email:
+- api-support@xing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/xing_api/activity/comment.rb
+- lib/xing_api/activity/like.rb
+- lib/xing_api/activity.rb
+- lib/xing_api/base.rb
+- lib/xing_api/bookmark.rb
+- lib/xing_api/client.rb
+- lib/xing_api/contact/tag.rb
+- lib/xing_api/contact.rb
+- lib/xing_api/contact_request.rb
+- lib/xing_api/conversation/attachment.rb
+- lib/xing_api/conversation/message.rb
+- lib/xing_api/conversation.rb
+- lib/xing_api/error.rb
+- lib/xing_api/geo_location.rb
+- lib/xing_api/invite.rb
+- lib/xing_api/job.rb
+- lib/xing_api/profile_message.rb
+- lib/xing_api/profile_visit.rb
+- lib/xing_api/response_handler.rb
+- lib/xing_api/user/recommendation.rb
+- lib/xing_api/user.rb
+- lib/xing_api/version.rb
+- lib/xing_api.rb
+homepage: https://github.com/xing/xing_api
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Official Ruby wrapper for the XING API
+test_files: []