nov-iknow 0.0.1 → 0.0.2

data/examples/pure_ruby.rb

@@ -2,8 +2,9 @@ require 'rubygems'
 require 'iknow'
 
 Iknow::Config.init do |conf|
-  conf.api_key = "" # Set your iKnow! API key, here.
-  conf.host    = "api.iknow.co.jp"
+  conf.api_key               = 'yarpp3tnrk77qx9vwwjnpt42'
+  conf.oauth_consumer_key    = ''
+  conf.oauth_consumer_secret = ''
 end
 
 please_get_api_key =<<EOS
@@ -16,7 +17,11 @@ iKnow! Developers (http://developer.iknow.co.jp/)
 Thanks!
 EOS
 
-raise ArgumentError.new(please_get_api_key) if Iknow::Config.instance.api_key == ''
+if Iknow::Config.api_key == ''# or
+  # Iknow::Config.oauth_consumer_key == '' or
+  # Iknow::Config.oauth_consumer_secret == ''
+  raise ArgumentError.new(please_get_api_key)
+end
 
 ## User API
 @user = Iknow::User.find('matake')

data/generators/iknow/USAGE

@@ -0,0 +1,12 @@
+NAME
+    iknow_oauth - creates a functional iknow oauth consumer
+
+SYNOPSIS
+    nothing
+
+Description:
+    Generates a model, controller, helper, view and library for making a OAuth consumer of iKnow! API.
+    No arguments are needed.
+
+Example:
+    ./script/generate iknow_oauth

data/generators/iknow/iknow_generator.rb

@@ -0,0 +1,22 @@
+require 'rails_generator/base'
+
+class IknowGenerator < Rails::Generator::Base
+	def manifest
+		record do |m|
+		  m.class_collisions 'IknowOauthController', 'IknowOauthControllerTest', 'IknowOauthHelper',
+		                     'IknowOauthSystem', 'IknowOauthToken', 'IknowOauthTokenTest'
+
+		  m.migration_template 'iknow_oauth_tokens_migration.rb', 'db/migrate', :migration_file_name => 'create_iknow_oauth_tokens'
+
+			m.template 'iknow_oauth_controller.rb',      File.join('app/controllers', 'iknow_oauth_controller.rb'     )
+      m.template 'iknow_oauth_controller_test.rb', File.join('test/functional', 'iknow_oauth_controller_test.rb')
+			m.template 'iknow_oauth_helper.rb',          File.join('app/helpers',     'iknow_oauth_helper.rb'         )
+		  m.template 'iknow_oauth_system.rb',          File.join('lib',             'iknow_oauth_system.rb'         )
+			m.template 'iknow_oauth_token.rb',           File.join('app/models',      'iknow_oauth_token.rb'          )
+			m.template 'iknow_oauth_token_test.rb',      File.join('test/unit',       'iknow_oauth_token_test.rb'     )
+
+      m.directory File.join('app/views', 'iknow_oauth')
+      m.template 'index.rhtml', File.join('app/views', 'iknow_oauth', 'index.rhtml')
+		end
+	end
+end

data/generators/iknow/templates/iknow_oauth_controller.rb

@@ -0,0 +1,24 @@
+class IknowOauthController < ApplicationController
+
+  def index; end
+
+  def new_request
+    request_token = IknowOauthToken.new_request_token
+
+    session[:iknow_username]          = params[:iknow_username]
+    session[:request_token]           = request_token
+    session[:redirect_url_after_auth] = params[:redirect_url_after_auth] || request.referer
+
+    if request_token
+      redirect_to(request_token.authorize_url)
+    else
+      raise RuntimeError.new("Failed to get a iKnow! Request Token") 
+    end
+  end
+
+  def callback
+    AuthToken.establish_auth_token(session[:iknow_username], session[:request_token])
+    redirect_to(session[:redirect_url_after_auth])
+  end
+
+end

data/generators/iknow/templates/iknow_oauth_controller_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class IknowOauthControllerTest < ActionController::TestCase
+  def test_true
+    true
+  end
+end

data/generators/iknow/templates/iknow_oauth_helper.rb

@@ -0,0 +1,3 @@
+module IknowOauthHelper
+  # add any methods if you want
+end

data/generators/iknow/templates/iknow_oauth_system.rb

@@ -0,0 +1,26 @@
+module IknowOauthSystem
+
+  protected
+
+  def require_iknow_oauth
+    unless iknow_username_exists?
+      redirect_to(:controller => 'iknow_oauth', :action => 'index') 
+      return false
+    end
+
+    iknow_oauth_token = IknowOauthToken.find_by_username(session[:iknow_username])
+    unless iknow_oauth_token
+      redirect_to(:controller => 'iknow_oauth', :action => 'new_request')
+      return false
+    end
+
+    true
+  end
+
+  private
+
+  def iknow_username_exists?
+    !session[:iknow_username].blank?
+  end
+
+end

data/generators/iknow/templates/iknow_oauth_token.rb

@@ -0,0 +1,37 @@
+require 'oauth/consumer'
+
+class IknowOauthToken < ActiveRecord::Base
+
+  def self.consumer
+    @@consumer ||= OAuth::Consumer.new(
+      Iknow::Config.oauth_consumer_key,
+      Iknow::Config.oauth_consumer_secret,
+      :site          => Iknow::Config.iknow_api_base_url,
+      :authorize_url => "#{Iknow::Config.iknow_base_url}/oauth/authorize"
+    )
+  end
+
+  def self.new_request_token
+    begin
+      self.consumer.get_request_token
+    rescue Exception => e
+      nil
+    end
+  end
+
+  def self.establish_auth_token(iknow_username, request_token)
+    access_token = request_token.get_access_token
+
+    auth_token          = IknowAuthToken.new
+    auth_token.username = iknow_username
+    auth_token.token    = access_token.token
+    auth_token.secret   = access_token.secret
+    auth_token.save!
+  end
+
+  def to_access_token
+    OAuth::AccessToken.new(self.class.consumer, self.token, self.secret)
+  end
+
+end
+

data/generators/iknow/templates/iknow_oauth_token_test.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+class IkonwOauthTokenTest < Test::Unit::TestCase
+  def test_true
+    true
+  end
+end

data/generators/iknow/templates/iknow_oauth_tokens_migration.rb

@@ -0,0 +1,15 @@
+class CreateIknowOauthTokens < ActiveRecord::Migration
+  def self.up
+    create_table :iknow_oauth_tokens do |t|
+      t.column :iknow_username, :string, :null => false
+      t.column :token,          :string, :unique => true
+      t.column :secret,         :string
+    end
+    add_index :iknow_oauth_tokens, :token, :unique => true
+    add_index :iknow_oauth_tokens, :iknow_username
+  end
+  
+  def self.down
+    drop_table :iknow_oauth_tokens
+  end
+end

data/generators/iknow/templates/index.rhtml

@@ -0,0 +1,4 @@
+<%% form_tag(:controller => 'iknow_oauth', :action => 'new_request') do %>
+  <label for="iknow_username">iKnow! Username</label>
+  <%%= text_field_tag "iknow_username" %>
+<%% end %>

data/generators/iknow_oauth/USAGE

@@ -0,0 +1,12 @@
+NAME
+    iknow_oauth - creates a functional iknow oauth consumer
+
+SYNOPSIS
+    nothing
+
+Description:
+    Generates a model, controller, helper, view and library for making a OAuth consumer of iKnow! API.
+    No arguments are needed.
+
+Example:
+    ./script/generate iknow_oauth

data/generators/iknow_oauth/iknow_oauth_generator.rb

@@ -0,0 +1,22 @@
+require 'rails_generator/base'
+
+class IknowOauthGenerator < Rails::Generator::Base
+	def manifest
+		record do |m|
+		  m.class_collisions 'IknowOauthController', 'IknowOauthControllerTest', 'IknowOauthHelper',
+		                     'IknowOauthSystem', 'IknowOauthToken', 'IknowOauthTokenTest'
+
+		  m.migration_template 'iknow_oauth_tokens_migration.rb', 'db/migrate', :migration_file_name => 'create_iknow_oauth_tokens'
+
+			m.template 'iknow_oauth_controller.rb',      File.join('app/controllers', 'iknow_oauth_controller.rb'     )
+      m.template 'iknow_oauth_controller_test.rb', File.join('test/functional', 'iknow_oauth_controller_test.rb')
+			m.template 'iknow_oauth_helper.rb',          File.join('app/helpers',     'iknow_oauth_helper.rb'         )
+		  m.template 'iknow_oauth_system.rb',          File.join('lib',             'iknow_oauth_system.rb'         )
+			m.template 'iknow_oauth_token.rb',           File.join('app/models',      'iknow_oauth_token.rb'          )
+			m.template 'iknow_oauth_token_test.rb',      File.join('test/unit',       'iknow_oauth_token_test.rb'     )
+
+      m.directory File.join('app/views', 'iknow_oauth')
+      m.template 'index.rhtml', File.join('app/views', 'iknow_oauth', 'index.rhtml')
+		end
+	end
+end

data/generators/iknow_oauth/templates/iknow_oauth_controller.rb

@@ -0,0 +1,24 @@
+class IknowOauthController < ApplicationController
+
+  def index; end
+
+  def new_request
+    request_token = IknowOauthToken.new_request_token
+
+    session[:iknow_username]          = params[:iknow_username]
+    session[:request_token]           = request_token
+    session[:redirect_url_after_auth] = params[:redirect_url_after_auth] || request.referer
+
+    if request_token
+      redirect_to(request_token.authorize_url)
+    else
+      raise RuntimeError.new("Failed to get a iKnow! Request Token") 
+    end
+  end
+
+  def callback
+    AuthToken.establish_auth_token(session[:iknow_username], session[:request_token])
+    redirect_to(session[:redirect_url_after_auth])
+  end
+
+end

data/generators/iknow_oauth/templates/iknow_oauth_controller_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class IknowOauthControllerTest < ActionController::TestCase
+  def test_true
+    true
+  end
+end

data/generators/iknow_oauth/templates/iknow_oauth_helper.rb

@@ -0,0 +1,3 @@
+module IknowOauthHelper
+  # add any methods if you want
+end

data/generators/iknow_oauth/templates/iknow_oauth_system.rb

@@ -0,0 +1,26 @@
+module IknowOauthSystem
+
+  protected
+
+  def require_iknow_oauth
+    unless iknow_username_exists?
+      redirect_to(:controller => 'iknow_oauth', :action => 'index') 
+      return false
+    end
+
+    iknow_oauth_token = IknowOauthToken.find_by_username(session[:iknow_username])
+    unless iknow_oauth_token
+      redirect_to(:controller => 'iknow_oauth', :action => 'new_request')
+      return false
+    end
+
+    true
+  end
+
+  private
+
+  def iknow_username_exists?
+    !session[:iknow_username].blank?
+  end
+
+end

data/generators/iknow_oauth/templates/iknow_oauth_token.rb

@@ -0,0 +1,37 @@
+require 'oauth/consumer'
+
+class IknowOauthToken < ActiveRecord::Base
+
+  def self.consumer
+    @@consumer ||= OAuth::Consumer.new(
+      Iknow::Config.oauth_consumer_key,
+      Iknow::Config.oauth_consumer_secret,
+      :site          => Iknow::Config.iknow_api_base_url,
+      :authorize_url => "#{Iknow::Config.iknow_base_url}/oauth/authorize"
+    )
+  end
+
+  def self.new_request_token
+    begin
+      self.consumer.get_request_token
+    rescue Exception => e
+      nil
+    end
+  end
+
+  def self.establish_auth_token(iknow_username, request_token)
+    access_token = request_token.get_access_token
+
+    auth_token          = IknowAuthToken.new
+    auth_token.username = iknow_username
+    auth_token.token    = access_token.token
+    auth_token.secret   = access_token.secret
+    auth_token.save!
+  end
+
+  def to_access_token
+    OAuth::AccessToken.new(self.class.consumer, self.token, self.secret)
+  end
+
+end
+

data/generators/iknow_oauth/templates/iknow_oauth_token_test.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+
+class IkonwOauthTokenTest < Test::Unit::TestCase
+  def test_true
+    true
+  end
+end

data/generators/iknow_oauth/templates/iknow_oauth_tokens_migration.rb

@@ -0,0 +1,15 @@
+class CreateIknowOauthTokens < ActiveRecord::Migration
+  def self.up
+    create_table :iknow_oauth_tokens do |t|
+      t.column :iknow_username, :string, :null => false
+      t.column :token,          :string, :unique => true
+      t.column :secret,         :string
+    end
+    add_index :iknow_oauth_tokens, :token, :unique => true
+    add_index :iknow_oauth_tokens, :iknow_username
+  end
+  
+  def self.down
+    drop_table :iknow_oauth_tokens
+  end
+end

data/generators/iknow_oauth/templates/index.rhtml

@@ -0,0 +1,4 @@
+<%% form_tag(:controller => 'iknow_oauth', :action => 'new_request') do %>
+  <label for="iknow_username">iKnow! Username</label>
+  <%%= text_field_tag "iknow_username" %>
+<%% end %>

data/lib/iknow/core/config.rb

@@ -2,19 +2,26 @@ require 'singleton'
 
 class Iknow::Config
   include Singleton
-  attr_accessor :protocol, :host, :port, :user_agent, :api_key, :application_name, :application_version, :application_url, :source
+  attr_accessor :protocol, :host, :port, :api_protocol, :api_host, :api_port,
+                :api_key, :oauth_consumer_key, :oauth_consumer_secret,
+                :user_agent, :application_name, :application_version, :application_url, :source
 
   def self.init(&block)
     conf = Iknow::Config.instance
-    { :protocol            => 'http',
-      :host                => 'api.iknow.co.jp',
-      :port                => 80,
-      :user_agent          => 'default',
-      :api_key             => '',
-      :application_name    => 'iKnow! API',
-      :application_version => Iknow::Version.to_version,
-      :application_url     => 'http://github.com/nov/iknow',
-      :source              => 'iknow'
+    { :protocol              => 'http',
+      :host                  => 'www.iknow.co.jp',
+      :port                  => 80,
+      :api_protocol          => 'http',
+      :api_host              => 'api.iknow.co.jp',
+      :api_port              => 80,
+      :api_key               => '',
+      :oauth_consumer_key    => '',
+      :oauth_consumer_secret => '',
+      :user_agent            => 'default',
+      :application_name      => 'A rubygem for iKnow! API',
+      :application_version   => Iknow::Version.to_version,
+      :application_url       => 'http://github.com/nov/iknow_oauth_generator',
+      :source                => 'iknow'
     }.each do |key, value| conf.send("#{key}=", value) end
     yield conf if block_given?
     conf
@@ -25,4 +32,13 @@ class Iknow::Config
     "#{self.protocol}://#{self.host}#{port}"
   end
 
+  def iknow_api_base_url
+    port = self.api_port==80 ? nil : ":#{self.api_port}"
+    "#{self.api_protocol}://#{self.api_host}#{port}"
+  end
+
+  def self.method_missing(method, *args)
+    self.instance.send(method, *args)
+  end
+
 end

data/lib/iknow/core/version.rb

@@ -1,7 +1,7 @@
 module Iknow::Version
   MAJOR = 0
   MINOR = 0
-  REVISION = 1
+  REVISION = 2
   class << self
     def to_version
       "#{MAJOR}.#{MINOR}.#{REVISION}"

data/lib/iknow/model/base.rb

@@ -1,12 +1,19 @@
 class Iknow::Base
-  # TODO: define self.attributes
+
   def self.attributes; self::ATTRIBUTES end
+
   def attributes; self.class.attributes  end
 
   def self.deserialize(response, params = {})
+    return nil if response.is_a?(Hash) and
+                 !response['error'].blank? and
+                  response['error']['code'].to_i == 404
+
     klass = params[:as]   ? params[:as] : self
-    response.is_a?(Array) ? response.inject([]) { |results, params| results << klass.new(params) } : klass.new(response)
+    response.is_a?(Array) ? response.inject([]) { |results, params| results << klass.new(params) } :
+                            klass.new(response)
   end
+
   def deserialize(response, params = {})
     self.class.deserialize(response, params)
   end

data/lib/iknow/model/item.rb

@@ -26,19 +26,19 @@ class Iknow::Item < Iknow::Base
 
   def self.recent(params = {})
     response = Iknow::RestClient::Item.recent(params)
-    self.deserialize(response)
+    self.deserialize(response) || []
   end
 
   def self.matching(keyword, params = {})
     params[:keyword] = keyword
     response = Iknow::RestClient::Item.matching(params)
-    self.deserialize(response)
+    self.deserialize(response) || []
   end
 
   def self.extract(text, params = {})
     params[:text] = text
     response = Iknow::RestClient::Item.extract(params)
-    self.deserialize(response)
+    self.deserialize(response) || []
   end
 
   def initialize(params = {})

data/lib/iknow/model/list.rb

@@ -8,13 +8,13 @@ class Iknow::List < Iknow::Base
 
   def self.recent(params = {})
     response = Iknow::RestClient::List.recent(params)
-    self.deserialize(response)
+    self.deserialize(response) || []
   end
 
   def self.matching(keyword, params = {})
     params[:keyword] = keyword
     response = Iknow::RestClient::List.matching(params)
-    self.deserialize(response)
+    self.deserialize(response) || []
   end
 
   def self.create(params = {})
@@ -30,19 +30,13 @@ class Iknow::List < Iknow::Base
   end
 
   def items(params = {})
-    return @items if @items
-
     response = Iknow::RestClient::List.items(params.merge(:id => self.list_id))
-    @items = self.deserialize(response, :as => Iknow::Item)
-    @items
+    self.deserialize(response, :as => Iknow::Item) || []
   end
 
   def sentences(params = {})
-    return @sentences if @sentences
-
     response = Iknow::RestClient::List.sentences(params.merge(:id => self.list_id))
-    @sentences = self.deserialize(response, :as => Iknow::Sentence)
-    @sentences
+    self.deserialize(response, :as => Iknow::Sentence) || []
   end
 
   def save!

data/lib/iknow/model/sentence.rb

@@ -3,22 +3,22 @@ class Iknow::Sentence < Iknow::Base
   WRITABLE_ATTRIBUTES = [:sound, :image]
   attr_accessor *WRITABLE_ATTRIBUTES
   attr_reader *(ATTRIBUTES - WRITABLE_ATTRIBUTES)
-  
+
   def self.recent(params = {})
     response = Iknow::RestClient::Sentence.recent(params)
-    self.deserialize(response)
+    self.deserialize(response) || []
   end
-  
+
   def self.matching(keyword, params = {})
     params[:keyword] = keyword
     response = Iknow::RestClient::Sentence.matching(params)
-    self.deserialize(response)
+    self.deserialize(response) || []
   end
-  
+
   def initialize(params = {})
     @sound = params['sound']
     @image = params['image']
     @text  = params['text']
   end
-  
+
 end

data/lib/iknow/model/user.rb

@@ -2,7 +2,7 @@ class Iknow::User < Iknow::Base
   ATTRIBUTES = [:username, :profile]
   attr_reader *ATTRIBUTES
 
-  class Profile < Iknow::User
+  class Profile < Iknow::Base
     ATTRIBUTES = [:name, :gender, :birthday, :description, :blog_url, :profile_url, :foaf_url, :icon_url]
     attr_reader *ATTRIBUTES
 
@@ -18,22 +18,33 @@ class Iknow::User < Iknow::Base
     end
   end
 
-  class StudyResult < Iknow::User
-    ATTRIBUTES = [:timestamp, :seconds, :totals, :seen, :completed, :date]
+  class Study < Iknow::Base
+    ATTRIBUTES = [:today, :results]
     attr_reader *ATTRIBUTES
 
+    class Result < Iknow::Base
+      ATTRIBUTES = [:timestamp, :seconds, :totals, :seen, :completed, :date]
+      attr_reader *ATTRIBUTES
+
+      def initialize(params = {})
+        @timestamp = (params['timestamp'].to_i   rescue nil)
+        @seconds   = (params['seconds'].to_i     rescue nil)
+        @totals    = {
+          :seconds   => (params['totals']['seconds'].to_i   rescue nil),
+          :seen      => (params['totals']['seen'].to_i      rescue nil),
+          :completed => (params['totals']['completed'].to_i rescue nil)
+        }
+        @seen      = (params['seen'].to_i        rescue nil)
+        @completed = (params['completed'].to_i   rescue nil)
+        @date      = (Date.parse(params['date']) rescue nil)
+      end
+    end
+
     def initialize(params = {})
-      @timestamp = (params['timestamp'].to_i   rescue nil)
-      @seconds   = (params['seconds'].to_i     rescue nil)
-      @totals    = {
-        :seconds   => (params['totals']['seconds'].to_i   rescue nil),
-        :seen      => (params['totals']['seen'].to_i      rescue nil),
-        :completed => (params['totals']['completed'].to_i rescue nil)
-      }
-      @seen      = (params['seen'].to_i        rescue nil)
-      @completed = (params['completed'].to_i   rescue nil)
-      @date      = (Date.parse(params['date']) rescue nil)
+      @today   = (Date.parse(params['today']) rescue nil)
+      @results = self.deserialize(params['study_results'], :as => Iknow::User::Study::Result)
     end
+
   end
 
   def self.find(username)
@@ -44,7 +55,7 @@ class Iknow::User < Iknow::Base
   def self.matching(keyword, params = {})
     params[:keyword] = keyword
     response = Iknow::RestClient::User.matching(params)
-    self.deserialize(response)
+    self.deserialize(response) || []
   end
 
   def initialize(params)
@@ -53,32 +64,24 @@ class Iknow::User < Iknow::Base
   end
 
   def items(params = {})
-    return @items if @items
-
     response = Iknow::RestClient::User.items(params.merge(:username => self.username))
-    self.deserialize(response, :as => Iknow::Item)
+    self.deserialize(response, :as => Iknow::Item) || []
   end
 
   def lists(params = {})
-    return @lists if @lists
-
     response = Iknow::RestClient::User.lists(params.merge(:username => self.username))
-    self.deserialize(response, :as => Iknow::List)
+    self.deserialize(response, :as => Iknow::List) || []
   end
 
   def friends(params = {})
-    return @friends if @friends
-
     response = Iknow::RestClient::User.friends(params.merge(:username => self.username))
-    self.deserialize(response)
+    self.deserialize(response) || []
   end
 
-  def study_results(params = {})
-    return @study_results if @study_results
-
-    params[:application] ||= :iknow
+  def study(params = {})
+    params[:application] ||= 'iknow'
     response = Iknow::RestClient::User.study_results(params.merge(:username => self.username))
-    self.deserialize(response, :as => Iknow::User::StudyResult)
+    self.deserialize(response, :as => Iknow::User::Study)
   end
 
 end