quora-client 0.1.1 → 0.1.2

data/README.md

@@ -30,7 +30,7 @@ Just install the gem:
 >
 > # or...
 >
-> client = Quora::Client.new({:user => <user>, :password => <password>})
+> client = Quora::Client.new({:user => "<user>", :password => "<password>"})
 >
 > user_data = client.get_all
 

data/lib/quora/auth.rb

@@ -4,11 +4,23 @@ require 'uri'
 require 'cgi'
 
 
+#
+# Quora client enables the communication with Quora API via REST interface
+#
+# (c) Juan de Bravo <juandebravo@gmail.com>
+#
+#
 module Quora
+  #
+  # This mixin provides useful methods for authentication
+  #
   module Auth
 
     QUORA_URI = "http://www.quora.com"
 
+    #
+    # login with Quora user and password
+    #
     def login(user, password)
       endpoint = URI.parse(QUORA_URI)
 

data/lib/quora/client.rb

@@ -15,13 +15,19 @@ 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.
+  # based on authentication cookie or web authentication (providing user and password).
+  # If you don't want to expose user credentials 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)
   #
+  # Or using user credentials:
+  #
+  # client = Quora::Client.new({:user => valid_user, :password => valid_password})
+  #
   # values = client.get_all
   #
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: quora-client
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Juan de Bravo