quora-client 0.0.2

data/LICENSE.LGPLv3

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,49 @@
+
+# Introduction
+
+Quora client enables the communication with Quora API via REST
+interface.
+
+Actually there's no API security mechanism so interaction with API is based on authentication cookie.
+You can provide either a valid cookie or a valid pair user - password.
+
+If you want to get the cookie value, you can use a local proxy, sniffer, etc to get the correct value, that
+should be something similar to: 
+
+  "m-b=<m-b-value>; m-f=<m-f-value>; m-s=<m-s-value>; ..."
+
+# Install
+
+Just install the gem:
+
+> gem install quora-client
+
+# How to use Quora Client
+
+> require 'rubygems'
+>
+> require 'quora-client'
+>
+> cookie ="<valid_value>"
+>
+> client = Quora::Client.new(cookie)
+>
+> # or...
+>
+> client = Quora::Client.new({:user => <user>, :password => <password>})
+>
+> user_data = client.get_all
+
+# Support methods
+
+Currently Quora supported fields include inbox, followers, following and notifs. Each field has an associated method in the client:
+
+> client.get_inbox
+>
+> client.get_followers
+>
+> client.get_following
+>
+> client.get_notifs
+>
+

data/lib/quora.rb

@@ -0,0 +1,10 @@
+require 'quora/client'
+
+#
+# Quora client enables the communication with Quora API via REST interface
+#
+# (c) Juan de Bravo <juandebravo@gmail.com>
+#
+module Quora
+  VERSION = "0.0.2"
+end

data/lib/quora/auth.rb

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'net/http'
+require 'uri'
+require 'cgi'
+
+
+module Quora
+  module Auth
+
+    QUORA_URI = "http://www.quora.com"
+
+    def login(user, password)
+      endpoint = URI.parse(QUORA_URI)
+
+      http = Net::HTTP.new(endpoint.host, endpoint.port)
+      resp = http.get('/login/')
+      cookie = resp["set-cookie"]
+
+      # TODO: improve this rubbish
+      # get formkey value
+      start = resp.body.index("Q.formkey")
+      formkey = resp.body[start..start+200].split("\"")[1]
+
+      # get window value
+      start = resp.body.index("webnode2.windowId")
+      window = resp.body[start..start+200].split("\"")[1]
+
+      # get __vcon_json value
+      start = resp.body.index("InlineLogin")
+      vcon_json = resp.body[start..start+200]
+      start = vcon_json.index("live")
+      vcon_json = vcon_json[start..-1]
+      vcon_json = vcon_json.split("\"")[0]
+      vcon_json = vcon_json.split(":")
+      vcon_json.map! { |value| "\"#{value}\"" }
+
+      vcon_json = "[#{vcon_json.join(",")}]"
+      vcon_json = CGI::escape(vcon_json)
+
+      user = CGI::escape(user)
+      password = CGI::escape(password)
+
+      body = "json=%7B%22args%22%3A%5B%22#{user}%22%2C%22#{password}%22%2Ctrue%5D%2C%22kwargs%22%3A%7B%7D%7D&formkey=#{formkey}&window_id=#{window}&__vcon_json=#{vcon_json}&__vcon_method=do_login"
+
+      headers = {
+        "Content-Type"     => "application/x-www-form-urlencoded",
+        "X-Requested-With" => "XMLHttpRequest",
+        "Accept"           => "application/json, text/javascript, */*",
+        "Cookie"           => cookie,
+        "User-Agent"       => "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_5; en-US) AppleWebKit/534.10 (KHTML, like Gecko) Chrome/8.0.552.237 Safari/534.10",
+        "Content-Length"   => body.length.to_s,
+        "Accept-Charset"   => "ISO-8859-1,utf-8;q=0.7,*;q=0.3",
+        "Accept-Language"  => "es-ES,es;q=0.8",
+        "Accept-Encoding"  => "gzip,deflate,sdch",
+        "Origin"           => "http://www.quora.com",
+        "Host"             => "www.quora.com",
+        "Referer"          => "http://www.quora.com/login/"
+      }
+
+      resp = http.post("/webnode2/server_call_POST", body, headers)
+
+      if resp.code == "200"
+        cookie
+      else
+        ""
+      end
+    end
+  end
+end

data/lib/quora/client.rb

@@ -0,0 +1,164 @@
+require 'rubygems'
+require 'net/http'
+require 'uri'
+require 'json'
+require 'quora/auth'
+
+#
+# Quora client enables the communication with Quora API via REST interface
+#
+# (c) Juan de Bravo <juandebravo@gmail.com>
+#
+
+module Quora
+  #
+  # This is the main class to interact with Quora API.
+  # 
+  # Actually there's no API security mechanism so interaction with API is
+  # based on authentication cookie. You should get all the Quora cookies value
+  # from you browser and use it as argument while creating the Quora client.
+  #
+  # cookie = "m-b=<m-b-value>; m-f=<m-f-value>; m-s=<m-s-value>; ..."
+  #
+  # client = Quora::Client.new(cookie)
+  #
+  # values = client.get_all
+  #
+
+  class Client
+    include Quora::Auth
+
+    QUORA_URI = "http://api.quora.com"
+
+    RESP_PREFIX = "while(1);"
+
+    BASEPATH = "/api/logged_in_user"
+
+    SUPPORTED_FIELDS = %W{inbox followers following notifs}
+
+    #
+    # Initialize the client.
+    # @param [required, string|Hash] User identification. Can be either a valid cookie
+    #               previously authenticated or an Hash with :user and :password
+    #
+    # client = Client.new(valid_cookie)
+    # client = Client.new({:user => valid_user, :password => valid_password})
+    #
+    def initialize(params)
+      if params.nil?
+        raise ArgumentError, "Cookie value must be provided"
+      else
+        if params.instance_of?(String)
+          cookie = params
+        elsif params.instance_of?(Hash)
+          user = params[:user]
+          password = params[:password]
+          user.nil? or password.nil? and raise ArgumentError, "user and password must be provided"
+          cookie = login(user, password)
+        end
+      end
+      @cookie = cookie
+    end
+
+    #
+    # Get all the user information available
+    #
+    def get_all
+      fields = SUPPORTED_FIELDS.join(",")
+      get(fields)
+    end
+
+    #
+    # Base method to send a request to Quora API.
+    # @param [required, string] supported field (or multiple fields CSV) to retrieve
+    # @param [optional, bool] filter if field is a key in result hash, only this
+    #       value is returned
+    #
+    def get(field, filter = true)
+      if field.nil? or !field.instance_of?(String)
+        raise ArgumentError, "Field value must be a string"
+      end
+      resp = http.get("#{BASEPATH}?fields=#{field}", headers)
+      data = resp.body[RESP_PREFIX.length..-1]
+      data = JSON.parse(data)
+      if filter && data.has_key?(field)
+        data[field]
+      else
+        data
+      end
+    end
+
+    #
+    # Define a method for each of the supported fields
+    #
+    SUPPORTED_FIELDS.each{|field|
+      define_method("get_#{field}"){
+        get(field)
+      }
+    }
+
+    #
+    # Any method that starts with "get_" will be defined so if new fields
+    # are supported there's no need to fix the client
+    #
+    def respond_to?(method_id, include_private = false)
+      if method_id.to_s =~ /^get_[\w]+/
+        true
+      else
+        super
+      end
+    end
+
+    #
+    # Override method_missing so any method that starts with "get_" will be
+    # defined.
+    #
+    # i.e.
+    # client.get_profile
+    #
+    # will generate =>
+    #
+    # def get_profile
+    #   get("profile")
+    # end
+    #
+    def method_missing(method_id, *arguments, &block)
+      if method_id.to_s =~ /^get_[\w]+/
+        self.class.send :define_method, method_id do
+          field = method_id.to_s[4..-1]
+          get(field)
+        end
+        self.send(method_id)
+      else
+        super
+      end
+    end
+
+    private
+
+    #
+    # Create (if not done before) and return the instance HTTP client
+    #
+    def http
+      @http ||= Net::HTTP.new(endpoint.host, endpoint.port)
+    end
+
+    #
+    # Create (if not done before) and return the Quora API endpoint
+    #
+    def endpoint
+      @@endpoint ||= URI.parse(QUORA_URI)
+    end
+
+    #
+    # Set headers
+    #
+    def headers
+      @cookie.nil? and raise ArgumentError, "cookie must be provided"
+      {
+        "Cookie" => @cookie
+      }
+    end
+
+  end
+end

data/test/test_quora_client.rb

@@ -0,0 +1,79 @@
+#!/opt/local/bin/ruby
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'quora'
+
+
+#
+# Quora client enables the communication with Quora API via REST interface
+#
+# (c) Juan de Bravo <juandebravo@gmail.com>
+# 
+# Methods to test Quora client
+#
+class TestQuoraClient < Test::Unit::TestCase
+
+  include Quora::Auth
+
+  def setup
+    if ARGV.length == 0
+      @cookie = "invalid value"
+    elsif ARGV.length == 1
+      @cookie = ARGV[0]
+    else
+      @user     = ARGV[0]
+      @password = ARGV[1]
+    end
+    
+  end
+
+  def test_get_all    
+    p client.get_all
+  end
+
+
+  def test_get_client_methods
+    Quora::Client::SUPPORTED_FIELDS.each{|field|
+      assert_equal client.class.instance_methods.index("get_#{field}") > 0, true
+    }
+    
+  end
+
+  def test_respond_to?
+    client.class.instance_methods(false).each{|method|
+      assert_equal client.respond_to?(method), true
+    }
+  end
+
+  def test_login
+    assert_equal login(@user, @password).length > 0, true
+  end
+
+  private
+
+  def client
+    if !@user.nil?
+      client = Quora::Client.new({:user => @user, :password => @password})
+    else
+      client = Quora::Client.new(@cookie)
+    end
+  end
+end
+
+#
+# Define a test helper to retrieve per each supported field
+# test_get_inbox
+# test_get_notifs
+# test_get_followers
+# test_get_following
+#
+Quora::Client::SUPPORTED_FIELDS.each{|field|
+  TestQuoraClient.send :define_method, "test_get_#{field}" do
+    p client.send "get_#{field}".to_s
+  end
+}
+
+
+

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: quora-client
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Juan de Bravo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-17 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 4
+        - 3
+        version: 1.4.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  version_requirements: *id002
+description: This GEM provides an easy way to access Quora Alpha API
+email: juandebravo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE.LGPLv3
+files: 
+- lib/quora/auth.rb
+- lib/quora/client.rb
+- lib/quora.rb
+- README.md
+- LICENSE.LGPLv3
+- test/test_quora_client.rb
+has_rdoc: true
+homepage: http://github.com/juandebravo/quora-client
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: This GEM provides an easy way to access Quora Alpha API
+test_files: 
+- test/test_quora_client.rb