duwanis-rubyku 0.0.1 → 0.0.2

data/README

@@ -8,7 +8,25 @@ Rubyku is a ruby library for accessing data via the Jaiku API.
 
 == FEATURES/PROBLEMS:
 
-Nothing happens! I know, you're excited, I can tell.
+Authorization against Jaiku is done using the Rubyku::Credentials object.
+  While the Jaiku API uses an API key instead of the username/password, I
+  thought it would be nice to allow for both.
+  So the api_key property on credentials will lazy-load itself (by logging
+  into the site and fetching it for you) if you populate the Credentials
+  object with a proper username and password.
+  Example:
+    cred = Rubyku::Credentials.new
+    cred.username = 'duwanis'
+    cred.password = 'notmyrealpassword'
+    cred.api_key
+    > "1n2o3t4m5y6a7p8i9k0e1y"
+    
+  Everything you may need to configure should be accessible via the
+  Rubyku::Settings object. So far:
+    proxy_url
+    proxy_port
+    jaiku_credentials #this is a place to save a default login, for a single-user app
+    logger            #an instance of Logger that will be used by rubyku for, well, logging.
 
 == SYNOPSIS:
 

data/Rakefile

@@ -0,0 +1,7 @@
+task :build_gem do
+  system("gem build rubyku.gemspec")
+end
+
+task :prepare_commit do
+  system("rm logs/*")
+end

data/lib/rubyku.rb

@@ -1,6 +1,22 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-module Rubyku
-  
-end
+# Just to make our requires at the top of the gem a little easier.
+require 'pathname'
+module Kernel
+  def __DIR__
+    Pathname(__FILE__).dirname.expand_path
+  end
+end 
+
+require 'net/http'
+require 'logger'
+#rubyku requires
+require __DIR__ + 'rubyku/settings'
+require __DIR__ + 'rubyku/user'
+require __DIR__ + 'rubyku/credentials'
+require __DIR__ + 'rubyku/version'
+
+# The basic Rubyku exception.
+class RubykuError < RuntimeError
+end

data/lib/rubyku/credentials.rb

@@ -0,0 +1,103 @@
+module Rubyku
+  class Credentials
+    attr_accessor :username
+    attr_accessor :password
+    attr_writer   :api_key
+    
+    ##
+    # returns the Jaiku API key for these credentials.
+    #  This is a lazy-load property. Since there is a method
+    #  that can be used to retrieve the API key with the username
+    #  and password, rubyku does not require you to specify that
+    #  key if you would rather specify a username and password.
+    #
+    # @return <String> the API key for this user.
+    #
+    # @raise <Rubyku::InvalidCredentialsError> indicates that the provided
+    #  username and password are not valid for Jaiku.
+    #
+    # @raise <RubykuError> indicates that there was an error communicating
+    #   to the Jaiku servers.
+    #
+    def api_key
+      log = Rubyku::Settings.logger
+      unless @api_key
+        log.info("api key for user #{username} requested - attempting to fetch.")
+        unless(@username and @password)
+          raise Rubyku::InvalidCredentialsError, "Need both username and password to fetch api_key."
+        end
+        @api_key = Rubyku::Credentials.fetch_api_key(@username, @password)
+      end
+      
+      @api_key
+    end
+    
+    class << self
+      
+      ##
+      # Given a username and password, retrieve that user's API key.
+      #   this works by logging the user in, stripping cookie information
+      #   off of the response, and then using that cookie information
+      #   to hit http://api.jaiku.com/key . All credit for this approach
+      #   to this python snippet on DZone: http://snippets.dzone.com/posts/show/5539
+      #   For the record, I'm torn about leaving this in. On the one hand it assumes
+      #   a lot about the internals of jaiku - on the other, it allows the user
+      #   to be oblivious to the API key and any changes it may undergo.
+      #
+      # @param username<String> the username to use for authentication.
+      #
+      # @param password<String> the password to use for authentication.
+      #
+      # @raise <Rubyku::InvalidCredentialsError> indicates that the provided
+      #  username and password are not valid for Jaiku.
+      #
+      # @raise <RubykuError> indicates that there was an error communicating
+      #   to the Jaiku servers.
+      #     
+      def fetch_api_key(username, password)
+        log = Rubyku::Settings.logger
+        
+        #login to the site
+        log.info "Attempting to log into Jaiku"
+        log.debug "Username: #{username}\nPassword: #{password}"
+        cookie_res = Net::HTTP::Proxy(Rubyku::Settings.proxy_url, Rubyku::Settings.proxy_port) \
+                    .post_form(URI.parse('http://jaiku.com/login'),
+                    {:log=> username, :pwd=> password, :rememberme => '1'})
+        log.info "Login response: " + cookie_res.to_s
+        if cookie_res.code == "200"
+          #If Jaiku returns a 200 OK, the login failed (bad credentials).
+          log.error "Jaiku returned 200 OK, this means the username and password weren't valid"
+          raise Rubyku::InvalidCredentialsError
+        end
+        unless cookie_res.code == "303"
+          #If Jaiku returns anything other than a redirect (which is expected
+          # for a successful logon), then something's broke.
+          log.error "Jaiku returned something other than a 303. Something borked."
+          raise RubykuError, "Could not connect to http://www.jaiku.com/login to retrieve API key."
+        end
+        
+        #retrieve the cookie contents from the successful login result
+        cookie_match = /(jaikuuser_[^;]*).*(jaikupass_[^;]*)/.match(cookie_res['set-cookie'])
+        cookie = "%s; %s" % [cookie_match[1], cookie_match[2]]
+        log.debug "Cookie: #{cookie}"
+        log.info "Attempting to connect to api.jaiku.com and get the API key..."
+        #now that we have the cookie information, let's grab the API key.
+        url = URI.parse('http://api.jaiku.com/key')
+        api_req = Net::HTTP::Get.new(url.path)
+        api_req.add_field("Cookie", cookie)
+        api_res = Net::HTTP::Proxy(Rubyku::Settings.proxy_url, Rubyku::Settings.proxy_port) \
+                      .start(url.host, url.port) {|http|
+          http.request(api_req)
+        }
+        log.debug "api.jaiku.com responded with " + api_res.code
+        log.debug api_res.to_s
+        #If this request was good, then the body should just be the API key.
+        api_res.body
+      end
+    end #end class << self
+    
+  end #end class
+  
+  class InvalidCredentialsError < RuntimeError
+  end
+end

data/lib/rubyku/settings.rb

@@ -0,0 +1,28 @@
+module Rubyku
+  class Settings
+    class << self
+      #Yay logger! Default logger is initialized below. Override it
+      # if you want to use your own logger.
+      attr_accessor :logger
+      
+      # Anywhere a rubyku method needs credentials, it will default
+      # to this property.
+      # You shouldn't use this property if you are writing a multi-user
+      # app. If you're writing a single user app, however, setting the
+      # credentials here lets you set-and-forget.
+      attr_accessor :jaiku_credentials
+      
+      # Proxy settings. If these are nil, net/http just ignores it.
+      # So set these to nil if you don't need a proxy.
+      attr_accessor :proxy_url
+      attr_accessor :proxy_port
+    end
+  end
+end
+
+#initialize the default logger
+Rubyku::Settings.logger= Logger.new(__DIR__ + '../logs/rubyku.log')
+Rubyku::Settings.logger.sev_threshold = Logger::INFO #DON'T set this line to DEBUG.
+# Do that in your own code if you want. Rubyku spews user information and such on DEBUG
+# And so it would be a very bad idea for DEBUG to make it into the gem.
+

data/lib/rubyku/user.rb

@@ -0,0 +1,64 @@
+module Rubyku
+
+  class User
+    attr_accessor :avatar_url
+    attr_accessor :first_name
+    attr_accessor :last_name
+    attr_accessor :nick
+    attr_accessor :jaiku_url
+    attr_writer   :contacts
+
+    ##
+    # Returns the list of contacts for the current user.
+    #  Contacts is the only property of User that is lazy-loaded.
+    #  This is because if it wasn't lazy-loaded, you'd be perpetually
+    #  creating user objects.
+    #
+    # @param jaiku_credentials<Rubyku::Credentials> the credentials to use
+    #   for authenticating with Jaiku. Defaults to any credentials set in <Rubyku::Settings>.
+    #
+    # @return <Array{Rubyku::User}> the users that this user follows on Jaiku. 
+    #
+    # @raise <Rubyku::UserNotFoundError> indicates that the user could not be found
+    #   in Jaiku.
+    #
+    # @raise <RubykuError> indicates that there was an error communicating
+    #   to the Jaiku servers.
+    #
+    def contacts(jaiku_credentials=Rubyku::Settings.jaiku_credentials)
+      unless @contacts
+        @contacts = User.fetchContacts(@username, jaiku_credentials)
+      end
+      
+      @contacts
+    end
+
+    class << self
+      ##
+      # Retrieves a user's information from Jaiku.
+      #  All properties but contacts are loaded. @see <Rubyku::User.contacts>
+      #
+      # @param username<String> the user to fetch.
+      # 
+      # @param jaiku_credentials<Rubyku::Credentials> the credentials to use
+      #   for authenticating with Jaiku. Defaults to any credentials set in <Rubyku::Defaults>.
+      #
+      # @return <Rubyku::User> the requested user.
+      #
+      # @raise <Rubyku::UserNotFoundError> indicates that the user could not be found
+      #   in Jaiku.
+      #
+      # @raise <RubykuError> indicates that there was an error communicating
+      #   to the Jaiku servers.      
+      # 
+      def fetch(username,jaiku_credentials=Rubyku::Settings.jaiku_credentials)  
+        
+      end
+    end
+    
+      
+  end
+  
+  class UserNotFoundError < RuntimeError
+  end
+end

data/lib/rubyku/version.rb

@@ -2,7 +2,7 @@ module Rubyku #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: duwanis-rubyku
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Tommy Morgan
@@ -25,8 +25,12 @@ extra_rdoc_files:
 files: 
 - LICENSE
 - README
+- Rakefile
 - lib/rubyku.rb
 - lib/rubyku/version.rb
+- lib/rubyku/credentials.rb
+- lib/rubyku/settings.rb
+- lib/rubyku/user.rb
 - test/test_helper.rb
 - test/test_rubyku.rb
 has_rdoc: true