viadeo 0.0.1

data/fixtures/vcr_cassettes/user/save_response.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://api.viadeo.com/me?interests=---
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Viadeo gem/0.0.1
+      Authorization:
+      - Bearer access_token_test_3e8c55877482b2
+      Content-Type:
+      - application/x-www-form-urlencoded;charset=UTF-8
+      Content-Length:
+      - '0'
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Uuid:
+      - d395b761-7e80-4589-aae0-4e21405b11b3
+      Content-Type:
+      - application/json;charset=UTF-8
+      Content-Length:
+      - '16'
+      Date:
+      - Fri, 03 May 2013 11:05:19 GMT
+    body:
+      encoding: US-ASCII
+      string: ! '{"updated":true}'
+    http_version: 
+  recorded_at: Fri, 03 May 2013 11:05:19 GMT
+recorded_with: VCR 2.4.0

data/fixtures/vcr_cassettes/user/update_response.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://api.viadeo.com/me?interests=---
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Viadeo gem/0.0.1
+      Authorization:
+      - Bearer access_token_test_3e8c55877482b2
+      Content-Type:
+      - application/x-www-form-urlencoded;charset=UTF-8
+      Content-Length:
+      - '0'
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Uuid:
+      - 67d17999-da99-4b73-a6a9-7953f2e1df49
+      Content-Type:
+      - application/json;charset=UTF-8
+      Content-Length:
+      - '16'
+      Date:
+      - Fri, 03 May 2013 11:05:20 GMT
+    body:
+      encoding: US-ASCII
+      string: ! '{"updated":true}'
+    http_version: 
+  recorded_at: Fri, 03 May 2013 11:05:21 GMT
+recorded_with: VCR 2.4.0

data/lib/viadeo/configuration.rb

@@ -0,0 +1,21 @@
+require "singleton"
+module Viadeo
+  class Configuration
+    include Singleton
+
+    DEFAULT_CONFIG = {timeout: 30, open_timeout: 30, url: 'https://api.viadeo.com'}
+    attr_accessor :logger, :timeout, :open_timeout, :url
+
+    def timeout
+      @timeout ||= DEFAULT_CONFIG[:timeout]
+    end
+
+    def open_timeout
+      @open_timeout ||= DEFAULT_CONFIG[:open_timeout]
+    end
+
+    def url 
+      @url ||= DEFAULT_CONFIG[:url]
+    end
+  end
+end

data/lib/viadeo/error.rb

@@ -0,0 +1,5 @@
+module Viadeo
+  class Error < StandardError; end
+  class MissingResourceError < Error; end
+  class MissingAccessTokenError < Error; end
+end

data/lib/viadeo/graph_connection.rb

@@ -0,0 +1,10 @@
+module Viadeo 
+  class GraphConnection < GraphObject
+
+    def initialize(access_token, options={})
+      @connection = options[:connection] if options[:connection]
+      super(access_token, options)
+    end
+  end
+end
+

data/lib/viadeo/graph_object.rb

@@ -0,0 +1,124 @@
+module Viadeo 
+  class GraphObject
+    include Enumerable
+
+    attr_reader :id, :access_token
+    @@initial_attributes = Set.new([:id, :access_token])
+
+    def initialize(access_token, options={})
+      raise Viadeo::MissingAccessTokenError.new("access_token parameter is mandatory") if (access_token.nil? ||  access_token.empty?)
+      @access_token = access_token
+      @id = options[:id] if options[:id]
+      @connection = options[:connection] if options[:connection]
+      @values = {}
+      @updated_attributes = Set.new
+    end
+
+    def self.new_from(values, access_token=nil)
+      obj = self.new(access_token, values)
+      obj.refresh_from(values, access_token)
+    end
+
+    def url
+      self.class.name.downcase.split('::')[-1] 
+    end
+
+    def reset
+      @values = {}
+      @updated_attributes = Set.new
+    end
+
+    def updated?(name=nil)
+      return !@updated_attributes.empty? unless name
+      return @updated_attributes.include?(name)
+    end
+
+    def to_s(*args)
+      MultiJson.dump(@values, :pretty => true)
+    end
+
+    def inspect()
+      id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
+      "#<#{self.class}:0x#{self.object_id.to_s(16)}#{id_string}> JSON: " + MultiJson.dump(@values, :pretty => true)
+    end
+
+    def refresh_from(values, access_token, partial=false)
+      @access_token = access_token
+      add_accessors(values.keys)
+      values.each do |k, v|
+        @values[k] = Util.convert_to_graph_object(v, access_token)
+        @updated_attributes.delete(k)
+      end
+      log("response : graph_object : ", self)
+      self
+    end
+
+    def [](k)
+      k = k.to_sym if k.kind_of?(String)
+      @values[k]
+    end
+
+    def []=(k, v)
+      send(:"#{k}=", v)
+    end
+
+    def keys
+      @values.keys
+    end
+
+    def values
+      @values.values
+    end
+
+    def to_json(*a)
+      MultiJson.dump(@values)
+    end
+
+    def to_hash
+      @values
+    end
+
+    def each(&blk)
+      @values.each(&blk)
+    end
+
+    protected
+
+    def log(message, arg=nil)
+      message += " : " + arg.inspect if arg
+      puts message
+    end
+
+    def metaclass
+      class << self; self; end
+    end
+
+    def add_accessors(keys)
+      metaclass.instance_eval do
+        keys.each do |k|
+          next if @@initial_attributes.include?(k)
+          k_eq = :"#{k}="
+          define_method(k) { @values[k] }
+          define_method(k_eq) do |v|
+            @values[k] = v
+            @updated_attributes.add(k)
+          end
+        end
+      end
+    end
+
+    def method_missing(name, *args)
+      if name.to_s.end_with?('=')
+        attr = name.to_s[0...-1].to_sym
+        @values[attr] = args[0]
+        @updated_attributes.add(attr)
+        add_accessors([attr])
+        return
+      else
+        return @values[name] if @values.has_key?(name)
+      end
+      super
+    end
+  end
+end
+

data/lib/viadeo/newsfeed.rb

@@ -0,0 +1,15 @@
+module Viadeo 
+  # == List of actions
+  # * find : Also aliased as : retrieve, get (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/newsfeed]
+  # 
+  # == Example :
+  #  require "viadeo"
+  #  # Retrieve a list of newsfeeds and limit the result to 5
+  #  newsfeed = Viadeo::Newsfeed.new(access_token)
+  #  newsfeed.find(limit: 5)
+
+  class Newsfeed < GraphObject
+    include Viadeo::Operations::Get
+  end
+end
+

data/lib/viadeo/operations/create.rb

@@ -0,0 +1,12 @@
+module Viadeo
+  module Operations
+    module Create
+      def create(options={})
+        data = Viadeo.request(:post, url: url , access_token: @access_token, params: options)
+        refresh_from(data, @access_token)
+        self
+      end
+      alias_method :post, :create
+    end
+  end
+end

data/lib/viadeo/operations/get.rb

@@ -0,0 +1,13 @@
+module Viadeo
+  module Operations
+    module Get
+      def find(options={})
+        data = Viadeo.request(:get, url: url , access_token: @access_token, params: options)
+        refresh_from(data, @access_token)
+        self
+      end
+      alias_method :retrieve, :find
+      alias_method :get, :find
+    end
+  end
+end

data/lib/viadeo/operations/list.rb

@@ -0,0 +1,12 @@
+module Viadeo
+  module Operations
+    module List
+      def all(options={})
+        data = Viadeo.request(:get, url: "#{url}/list" , access_token: @access_token, params: options)
+        refresh_from(data, @access_token)
+        self
+      end
+      alias_method :list, :all
+    end
+  end
+end

data/lib/viadeo/operations/update.rb

@@ -0,0 +1,25 @@
+module Viadeo
+  module Operations
+    module Update
+      def update(options={})
+        data = Viadeo.request(:put, url: url , access_token: @access_token, params: options)
+        refresh_from(data, @access_token)
+        self
+      end
+
+      def save
+        if updated?
+          update(params)
+        end
+        self
+      end
+
+      private
+      def params
+        values = {}
+        @updated_attributes.each { |k| values[k] = @values[k] }
+        values
+      end
+    end
+  end
+end

data/lib/viadeo/recommend.rb

@@ -0,0 +1,20 @@
+module Viadeo 
+  # == List of actions
+  # * find : Also aliased as : retrieve, get (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/recommend#GET_recommend]
+  # * create : Also aliased as post : (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/recommend#POST_recommend]
+  # == Examples :
+  #  require "viadeo"
+  #  
+  #  # Retrieve recommended URL infos and limit the result to 5
+  #  recommend = Viadeo::Recommend.new(access_token)
+  #  recommend.retrieve(url: "http://dev.viadeo.com", limit: 5)
+  #
+  #  #recommend a new URL
+  #  recommend.create(url: "http://dev.viadeo.com", title: "Get started with the Viadeo API")
+
+  class Recommend < GraphObject
+    include Viadeo::Operations::Get
+    include Viadeo::Operations::Create
+  end
+end
+

data/lib/viadeo/reference_data.rb

@@ -0,0 +1,43 @@
+module Viadeo 
+  # == List of actions
+  # * all : Also aliased as : list
+  # == List of  resources
+  # * companydepartment (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/companydepartment/list/&domains=,Reference%20data]
+  # * companyindustry (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/companyindustry/list/&domains=,Reference%20data]
+  # * companynewscategory (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/companynewscategory/list/&domains=,Reference%20data]
+  # * contracttype (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/contracttype/list/&domains=,Reference%20data]
+  # * country (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/country/list/&domains=,Reference%20data]
+  # * experiencelevel (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/experiencelevel/list/&domains=,Reference%20data]
+  # * imtype (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/imtype/list/&domains=,Reference%20data]
+  # * jobcategory (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/jobcategory/list/&domains=,Reference%20data]
+  # * language (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/language/list/&domains=,Reference%20data]
+  # * newscategory (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/newscategory/list/&domains=,Reference%20data]
+  # * professionalstatus (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/professionalstatus/list/&domains=,Reference%20data]
+  # * studylevel (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/studylevel/list/&domains=,Reference%20data]
+  # * videoprovider (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/videoprovider/list/&domains=,Reference%20data]
+  #
+  # == Example :
+  #  require "viadeo"
+  #
+  #  # Retrieve reference list of languages and limit the result to 5
+  #  reference_data = Viadeo::ReferenceData.new(access_token, resource: "language")
+  #  reference_data.all(limit: 5)
+  #
+  # *WARNING*: if it called without resource parameter it raise MissingResourceError
+
+  class ReferenceData < GraphObject
+    include Viadeo::Operations::List
+
+    def initialize(access_token, options={})
+      raise Viadeo::MissingResourceError.new("resource parameter is mandatory") unless options[:resource]
+      @resource = options[:resource]
+      super(access_token, options)
+    end
+
+    protected
+    def url
+      "#{@resource}"
+    end
+  end
+end
+

data/lib/viadeo/request.rb

@@ -0,0 +1,24 @@
+module Viadeo
+  def self.request(method, options={})
+    headers = {
+      :user_agent => "Viadeo gem/#{Viadeo::VERSION}",
+      :authorization => "Bearer #{options[:access_token]}",
+      :content_type => "application/x-www-form-urlencoded;charset=UTF-8"
+    }
+    timeout_options = {timeout: Viadeo.config.timeout, open_timeout: Viadeo.config.open_timeout}
+
+    conn = Faraday.new(:url => Viadeo.config.url) do |faraday|
+      faraday.request  :url_encoded             # form-encode POST params
+      faraday.response :logger                  # log requests to STDOUT
+      faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+    end
+    response = conn.send(method) do |req|
+      req.url(options[:id].nil? ?  options[:url] : options[:id])
+      req.headers = headers
+      req.options = timeout_options
+      req.params = options[:params] if options[:params] 
+    end
+    Viadeo.log "response : body : " + response.body
+    Viadeo::Util.filter_response(response)
+  end
+end

data/lib/viadeo/search.rb

@@ -0,0 +1,27 @@
+module Viadeo 
+  # == List of actions
+  # * retrieve (find, get)
+  # == List of connections
+  # * groups (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/search/groups]
+  # * joboffers (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/search/joboffers]
+  # * jobs (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/search/jobs]
+  # * schoolorganization (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/search/schoolorganization]
+  # * users (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/search/users]
+  # == Example :
+  #  require "viadeo"
+  #  # Search users at paris school and limit the result to 5
+  #  search = Viadeo::Search.new(access_token, connection: "users")
+  #  search.find(school: "paris", limit: 5)
+  #
+  # *WARNING*: if it called without connection it raise an error 
+
+  class Search < GraphConnection
+    include Viadeo::Operations::Get
+  
+    protected
+    def url
+      "#{super}/#{@connection}" 
+    end
+  end
+end
+

data/lib/viadeo/status.rb

@@ -0,0 +1,15 @@
+module Viadeo 
+  # == List of actions
+  # * create : Also aliased as post : (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/status]
+  # == Example :
+  #  require "viadeo"
+  #  
+  #  # Post a status
+  #  status = Viadeo::Status.new(access_token)
+  #  status.create(message: "Your message")
+
+  class Status < GraphObject
+    include Viadeo::Operations::Create
+  end
+end
+

data/lib/viadeo/user.rb

@@ -0,0 +1,41 @@
+module Viadeo 
+  # == List of actions
+  # * find : Also aliased as : retrieve, get (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/user#GET_user_id]
+  # * update : Also aliased as put : (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/user#POST_user_id]
+  # == Examples :
+  #  require "viadeo"
+  #  
+  #  # Retrieve information from a Viadeo member’s profile. An access to another user profile will count a new visit
+  #  user = Viadeo::User.new(access_token)
+  #  user.retrieve
+  #
+  #  # Update user information
+  #  user.update(country: "France")
+  #  # Alternative
+  #  user.country = "France"
+  #  user.save
+  #
+  # == List of connections
+  # * contacts (details)[http://dev.viadeo.com/documentation/graph-api-resource/?resource=/user/ID/contacts/&domains=,Entry%20points] 
+  # * ... (more)[http://dev.viadeo.com/graph-api-resource/?resource=%2Fuser%2F&domains=%2CEntry%20points#connections]
+  # == Examples :
+  #  require "viadeo"
+  #
+  #  # Retrieve a list of all a member’s premium contacts.
+  #  user = Viadeo::User.new(access_token, connection: "contacts")
+  #  user.retrieve(is_premium: true)
+
+
+
+  class User < GraphConnection
+    include Viadeo::Operations::Get
+    include Viadeo::Operations::Create
+    include Viadeo::Operations::Update
+   
+    protected
+    def url
+      id_or_me = @id.nil? ? "me" : @id 
+      @connection.nil? ? id_or_me : "#{id_or_me}/#{@connection}"
+    end
+  end
+end

data/lib/viadeo/util.rb

@@ -0,0 +1,21 @@
+module Viadeo
+  class Util
+    class << self
+      def convert_to_graph_object(data, access_token)
+        case data
+        when Array
+          data.map {|v| convert_to_graph_object(v, access_token) }
+        when Hash
+          data[:id].nil? ? data : Viadeo::GraphObject.new_from(data, access_token)
+        else
+          data
+        end
+      end
+
+      def filter_response(response)
+        data = response.body.split("\r\n\r\n")[-1]
+        data = MultiJson.load(data, :symbolize_keys => true)
+      end
+    end
+  end
+end

data/lib/viadeo/version.rb

@@ -0,0 +1,3 @@
+module Viadeo
+  VERSION = "0.0.1"
+end

data/lib/viadeo.rb

@@ -0,0 +1,56 @@
+require "multi_json"
+require "faraday"
+
+#Utils
+require "viadeo/version"
+require "viadeo/util"
+require "viadeo/configuration"
+require "viadeo/request"
+
+#Operations
+require "viadeo/operations/create"
+require "viadeo/operations/update"
+require "viadeo/operations/get"
+require "viadeo/operations/list"
+
+#Graph Objects
+require "viadeo/graph_object"
+require "viadeo/graph_connection"
+require "viadeo/user"
+require "viadeo/newsfeed"
+require "viadeo/recommend"
+require "viadeo/reference_data"
+require "viadeo/search"
+require "viadeo/status"
+
+#error
+require "viadeo/error"
+
+module Viadeo
+  class << self
+    def version_string
+      "Viadeo version #{Viadeo::VERSION}"
+    end
+
+    # Configure Viadeo parameters by passing block 
+    # === Example
+    #  Viadeo.configure do |config|
+    #    config.logger = logger
+    #    config.timeout = 30
+    #    config.open_timeout = 30
+    #    config.url = "https://api.viadeo.com"
+    #  end
+    def configure(&block)
+      block.call(config) if block_given?
+    end
+
+    def config
+      Viadeo::Configuration.instance
+    end
+
+    def log message
+      return if config.logger.nil? || message.nil?
+      config.logger.debug message
+    end
+  end
+end