iknow 0.0.4

data/examples/iknow_on_rails/db/schema.rb

@@ -0,0 +1,23 @@
+# This file is auto-generated from the current state of the database. Instead of editing this file, 
+# please use the migrations feature of Active Record to incrementally modify your database, and
+# then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your database schema. If you need
+# to create the application database on another system, you should be using db:schema:load, not running
+# all the migrations from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20081016145649) do
+
+  create_table "iknow_oauth_tokens", :force => true do |t|
+    t.string "iknow_username", :null => false
+    t.string "token"
+    t.string "secret"
+  end
+
+  add_index "iknow_oauth_tokens", ["iknow_username"], :name => "index_iknow_oauth_tokens_on_iknow_username"
+  add_index "iknow_oauth_tokens", ["token"], :name => "index_iknow_oauth_tokens_on_token", :unique => true
+
+end

data/examples/iknow_on_rails/lib/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/examples/iknow_on_rails/public/dispatch.rb

@@ -0,0 +1,10 @@
+#!/usr/local/ruby//bin/ruby
+
+require File.dirname(__FILE__) + "/../config/environment" unless defined?(RAILS_ROOT)
+
+# If you're using RubyGems and mod_ruby, this require should be changed to an absolute path one, like:
+# "/usr/local/lib/ruby/gems/1.8/gems/rails-0.8.0/lib/dispatcher" -- otherwise performance is severely impaired
+require "dispatcher"
+
+ADDITIONAL_LOAD_PATHS.reverse.each { |dir| $:.unshift(dir) if File.directory?(dir) } if defined?(Apache::RubyRun)
+Dispatcher.dispatch

data/examples/iknow_on_rails/test/functional/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/examples/iknow_on_rails/test/functional/users_controller_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class UsersControllerTest < ActionController::TestCase
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/examples/iknow_on_rails/test/test_helper.rb

@@ -0,0 +1,38 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class Test::Unit::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually 
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/examples/iknow_on_rails/test/unit/iknow_oauth_token_test.rb

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

data/examples/pure_ruby.rb

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'iknow'
+
+Iknow::Config.init do |conf|
+  conf.api_key               = 'SET_YOUR_API_KEY'
+  conf.oauth_consumer_key    = 'SET_YOUR_OAUTH_CONSUMER_KEY'
+  conf.oauth_consumer_secret = 'SET_YOUR_OAUTH_CONSUMER_SECRET'
+end
+
+please_get_api_key =<<EOS
+This example needs your own iKnow! API key.
+(for only Iknow::Item.extract example)
+
+You can get iKnow! API key at iKnow! Developers.
+iKnow! Developers (http://developer.iknow.co.jp/)
+
+Thanks!
+EOS
+
+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('kirk')
+# @user.items(:include_sentences => true)
+# @user.lists
+# @user.friends
+# @user.study.results
+# @user.study.total_results
+# @matched_users = Iknow::User.matching('matake')
+# 
+# ## List API
+# @recent_lists = Iknow::List.recent
+# @list = Iknow::List.find(31509, :include_sentences => true, :include_items => true)
+# @list.items
+# @list.sentences
+# @matched_lists = Iknow::List.matching("イタリア語であいさつ")
+# 
+puts Iknow::List.find(31509, :include_sentences => true, :include_items => true).inspect
+# 
+# ## Item API
+# @recent_items = Iknow::Item.recent(:include_sentences => true)
+# @item = Iknow::Item.find(437525)
+# @matched_items = Iknow::Item.matching('record', :include_sentences => true)
+# @items = Iknow::Item.extract("sometimes, often, electrical")
+# @items.first.sentences
+# 
+# ## Sentence API
+# @recent_sentences = Iknow::Sentence.recent
+# @sentence = Iknow::Sentence.find(312271)
+# @matched_sentences = Iknow::Sentence.matching('record')

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/ext/hash.rb

@@ -0,0 +1,23 @@
+class Hash
+  def to_http_str
+    result = ''
+    return result if self.empty?
+    self.each do |key, val|
+      result << "#{key}=#{URI.encode(val.to_s)}&"
+    end
+    result.chop
+  end
+  def symbolize_keys!
+    self.each do |key, value|
+      unless self.delete(key.to_s).nil?
+        if value.is_a?(Hash)
+          value.symbolize_keys!
+        elsif value.is_a?(Array)
+          value.map!{ |v| v.symbolize_keys! if v.is_a?(Hash) }
+        end
+        self[key.to_sym] = value
+      end
+    end  
+    self
+  end
+end

data/lib/iknow/core/config.rb

@@ -0,0 +1,44 @@
+require 'singleton'
+
+class Iknow::Config
+  include Singleton
+  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                  => '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
+  end
+
+  def iknow_base_url
+    port = self.port==80 ? nil : ":#{self.port}"
+    "#{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

@@ -0,0 +1,14 @@
+module Iknow::Version
+  MAJOR = 0
+  MINOR = 0
+  REVISION = 4
+  class << self
+    def to_version
+      "#{MAJOR}.#{MINOR}.#{REVISION}"
+    end
+    
+    def to_name
+      "#{MAJOR}_#{MINOR}_#{REVISION}"
+    end
+  end
+end

data/lib/iknow/core.rb

@@ -0,0 +1,2 @@
+require 'iknow/core/version'
+require 'iknow/core/config'

data/lib/iknow/model/base.rb

@@ -0,0 +1,29 @@
+class Iknow::Base
+
+  def self.attributes; self::ATTRIBUTES end
+
+  def attributes; self.class.attributes  end
+
+  def self.deserialize(response, params = {})
+    return nil if response.nil? or
+                 (response.is_a?(Hash) and
+                 !response['error'].nil? and
+                  response['error']['code'].to_i == 404)
+
+    klass = params[:as] ? params[:as] : self
+    if response.is_a?(Array)
+      response.inject([]) { |results, hash|
+        hash.symbolize_keys!
+        results << klass.new(hash)
+      }
+    else
+      response.symbolize_keys!
+      klass.new(response)
+    end
+  end
+
+  def deserialize(response, params = {})
+    self.class.deserialize(response, params)
+  end
+
+end

data/lib/iknow/model/item.rb

@@ -0,0 +1,60 @@
+class Iknow::Item < Iknow::Base
+  ATTRIBUTES = [:sentences, :response, :cue, :id]
+  attr_reader *ATTRIBUTES
+
+  class Response
+    ATTRIBUTES = [:text, :type, :language]
+    attr_reader *ATTRIBUTES
+    
+    def initialize(params = {})
+      @text     = params[:text]
+      @type     = params[:type]
+      @language = params[:language]
+    end
+  end
+
+  class Cue
+    ATTRIBUTES = [:text, :sound, :part_of_speech, :language]
+    NOT_WRITABLE_ATTRIBUTES = [:text]
+    attr_accessor *(ATTRIBUTES - NOT_WRITABLE_ATTRIBUTES)
+    attr_reader *NOT_WRITABLE_ATTRIBUTES
+    
+    def initialize(params = {})
+      @text           = params[:text]
+      @sound          = params[:sound]
+      @part_of_speech = params[:part_of_speech]
+      @language       = params[:language]
+    end
+  end
+
+  def self.recent(params = {})
+    response = Iknow::RestClient::Item.recent(params)
+    self.deserialize(response) || []
+  end
+
+  def self.find(item_id, params = {})
+    params[:id] = item_id
+    response = Iknow::RestClient::Item.find(params)
+    self.deserialize(response)
+  end
+
+  def self.matching(keyword, params = {})
+    params[:keyword] = keyword
+    response = Iknow::RestClient::Item.matching(params)
+    self.deserialize(response) || []
+  end
+
+  def self.extract(text, params = {})
+    params[:text] = text
+    response = Iknow::RestClient::Item.extract(params)
+    self.deserialize(response) || []
+  end
+
+  def initialize(params = {})
+    @id        = params[:id].to_i
+    @cue       = self.deserialize(params[:cue], :as => Iknow::Item::Cue)
+    @responses = self.deserialize(params[:responses], :as => Iknow::Item::Response)
+    @sentences = self.deserialize(params[:sentences], :as => Iknow::Sentence)
+  end
+
+end

data/lib/iknow/model/list.rb

@@ -0,0 +1,133 @@
+#     "iknow": true,
+#     "description": "hogehoge",
+#     "translation_language": "ja",
+#     "dictation": true,
+#     "icon": "http://www.iknow.co.jp/assets/courses/m4.jpg",
+#     "brainspeed": true,
+#     "language": "en",
+#     "item_count": 117,
+#     "author_id": "Cerego",
+#     "user_count": 45056,
+#     "author": "Team iKnow!",
+#     "title": "\u65c5\u306b\u51fa\u3088\u3046\uff01\uff08\u51fa\u56fd\uff06\u8857\u3092\u6b69\u304f\uff09",
+#     "id": 708,
+#     "author_url": "http://www.iknow.co.jp/user/Cerego"
+
+class Iknow::List < Iknow::Base
+  ATTRIBUTES = [:list_id, :title, :description, :icon, :item_count, :user_count, :iknow, :dictation, :brainspeed,
+                :language, :translation_language, :list_type, :transcript, :embed,
+                :tags, :media_entry, :author, :author_id, :author_url, :attribution_license_id,
+                :items, :sentences]
+  NOT_WRITABLE_ATTRIBUTES = [:list_id, :icon, :item_count, :user_count, :iknow, :dictation, :brainspeed]
+  attr_accessor *(ATTRIBUTES - NOT_WRITABLE_ATTRIBUTES)
+  attr_reader   *NOT_WRITABLE_ATTRIBUTES
+
+  class Application
+    attr_reader :application, :list_id, :lang
+    def initialize(params = {})
+      @application  = params[:application]
+      @list_id      = params[:list_id]
+      @lang         = params[:lang]
+    end
+    def url
+      "http://www.iknow.co.jp/flash?swf=#{self.name}&course_id=#{self.list_id}&lang=#{self.lang}"
+    end
+  end
+
+  def self.recent(params = {})
+    response = Iknow::RestClient::List.recent(params)
+    self.deserialize(response) || []
+  end
+
+  def self.find(list_id, params = {})
+    params[:id] = list_id
+    response = Iknow::RestClient::List.find(params)
+    self.deserialize(response)
+  end
+
+  def self.matching(keyword, params = {})
+    params[:keyword] = keyword
+    response = Iknow::RestClient::List.matching(params)
+    self.deserialize(response) || []
+  end
+
+  def self.create(params = {})
+    new_list = self.new(params)
+    new_list.save!
+  end
+
+  def initialize(params = {})
+    @list_id     = (params[:id].to_i rescue nil)
+    @title       = params[:title]
+    @description = params[:description]
+    @icon        = params[:icon]
+    @item_count  = (params[:item_count].to_i rescue nil)
+    @user_count  = (params[:user_count].to_i rescue nil)
+    @language    = params[:language]
+    @translation_language = params[:translation_language]
+    if @list_id and @translation_language
+      common_settings = {:list_id => @list_id, :lang => @translation_language}
+      @iknow      = Application.new(common_settings.merge(:application => 'iknow'))      if params[:iknow]
+      @dictation  = Application.new(common_settings.merge(:application => 'dictation'))  if params[:dictation]
+      @brainspeed = Application.new(common_settings.merge(:application => 'brainspeed')) if params[:brainspeed]
+    end
+    @author      = params[:author]      # display_name or username
+    @author_id   = params[:author_id]   # username
+    @author_url  = params[:author_url]
+    @list_type   = params[:list_type]   # for list creation
+    @transcript  = params[:transcript]  # for list creation
+    @embed       = params[:embed]       # for list creation
+    @tags        = params[:tags]        # for list creation
+    @media_entry = params[:media_entry] # for list creation
+    @attribution_license_id = params[:attribution_license_id] # for list creation
+    @items     = self.deserialize(params[:items],     :as => Iknow::Item)
+    @sentences = self.deserialize(params[:sentences], :as => Iknow::Sentence)
+  end
+
+  def items(params = {})
+    response = Iknow::RestClient::List.items(params.merge(:id => self.list_id))
+    self.deserialize(response, :as => Iknow::Item) || []
+  end
+
+  def sentences(params = {})
+    response = Iknow::RestClient::List.sentences(params.merge(:id => self.list_id))
+    self.deserialize(response, :as => Iknow::Sentence) || []
+  end
+
+  def save!
+    Iknow::RestClient::List.create(self.to_post_data)
+  end
+
+  def save
+    self.save!
+    true
+  rescue
+    false
+  end
+
+  protected
+
+  def to_post_data
+    raise ArgumentError.new("List title is needed.") if self.title.nil? or self.title.empty?
+    
+    post_data = {
+      'list[name]'                 => self.title,
+      'list[description]'          => self.description,
+      'list[language]'             => self.language             || 'en',
+      'list[translation_language]' => self.translation_language || 'ja'
+    }
+    # Object#type should not be used
+    if self.list_type
+      post_data['list[type]'] = self.list_type
+    end
+    # Optional attributes
+    [ :transcript, :embed, :tags, :media_entry,
+      :author, :author_url, :attribution_license_id ].each do |key|
+      if self.send("#{key}")
+        post_data["list[#{key}]"] = self.send("#{key}")
+      end
+    end
+    post_data
+  end
+
+end