nov-iknow 0.0.1 → 0.0.2

data/README

@@ -1,53 +1,37 @@
-
 = iknow
 
-A rubygem for iKnow! APIs
-by nov <nmatake@cerego.co.jp>
+  by nov <nmatake@cerego.co.jp>
 
 == Description
 
-## Set API Key (in environment.rb etc.)
-Iknow::Config.init do |conf|
-  conf.api_key  = YOUR_API_KEY
-end
-
-## User API
-@user = Iknow::User.find('matake')
-@user.items
-@user.lists
-@user.study_results
-@matchied_users = Iknow::User.matching('matake')
-
-## List API
-@recent_lists = Iknow::List.recent
-@list  = @recent_lists.first
-@list.items
-@list.sentences
-
-## Item API
-@recent_items = Iknow::Item.recent
-@matchied_items = Iknow::Item.matching('record')
-
-## Sentence API
-@recent_sentences = Iknow::Sentence.recent
-@matchied_sentences = Iknow::Sentence.matching('record')
+  This rubygem is a wrapper of iKnow! API.
+  You can get pure-ruby example at examples/pure_ruby.rb.
 
 == Installation
 
+  git clone http://github.com/nov/iknow.git
+  cd iknow
+  rake install
+
 === Archive Installation
 
 	rake install
 
 === Gem Installation
 
-	gem install iknow
-
+	gem install nov-iknow 
 
 == Features/Problems
 
+  Test! Test!! Test!!!
+
+  Create/Add/Delete APIs are not implemented.
+  They will be implemented in a few weeks.
 
 == Synopsis
 
+  See examples and iKnow! Developers, please.
+  iKnow! Developers (http://developer.iknow.co.jp)
 
 == Copyright
 

data/Rakefile

@@ -60,12 +60,13 @@ spec = Gem::Specification.new do |s|
 	#s.autorequire       = ""
 	s.test_files        = Dir["test/*_test.rb"]
 
-	#s.add_dependency('activesupport', '>=1.3.1')
+	s.add_dependency('rails', '>=2.1.0')
 	s.add_dependency('json')
-	#s.required_ruby_version = '>= 1.8.2'
+	s.add_dependency('oauth', '=0.2.4')
+	s.required_ruby_version = '>= 1.8.6'
 
 	s.files = %w(README ChangeLog Rakefile) +
-		Dir.glob("{bin,doc,test,lib,templates,generator,extras,website,script}/**/*") + 
+		Dir.glob("{bin,doc,test,lib,templates,generators,extras,website,script}/**/*") + 
 		Dir.glob("ext/**/*.{h,c,rb}") +
 		Dir.glob("examples/**/*.rb") +
 		Dir.glob("tools/*.rb") +

data/examples/iknow_on_rails/app/controllers/application.rb

@@ -0,0 +1,15 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+
+  # See ActionController::RequestForgeryProtection for details
+  # Uncomment the :secret if you're not using the cookie session store
+  protect_from_forgery # :secret => 'e1ab9cfeba306b3feb0b9156d59c3e15'
+  
+  # See ActionController::Base for details 
+  # Uncomment this to filter the contents of submitted sensitive data parameters
+  # from your application log (in this case, all fields with names like "password"). 
+  # filter_parameter_logging :password
+end

data/examples/iknow_on_rails/app/controllers/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/examples/iknow_on_rails/app/controllers/users_controller.rb

@@ -0,0 +1,10 @@
+class UsersController < ApplicationController
+
+  def index
+    unless params[:iknow_username].blank?
+      @user = Iknow::User.find(params[:iknow_username])
+      flash[:notice] = "404 User Not Found" unless @user
+    end
+  end
+
+end

data/examples/iknow_on_rails/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/examples/iknow_on_rails/app/helpers/iknow_oauth_helper.rb

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

data/examples/iknow_on_rails/app/helpers/users_helper.rb

@@ -0,0 +1,2 @@
+module UsersHelper
+end

data/examples/iknow_on_rails/app/models/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/examples/iknow_on_rails/config/boot.rb

@@ -0,0 +1,109 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion if defined? Gem::RubyGemsVersion
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.1.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/examples/iknow_on_rails/config/environment.rb

@@ -0,0 +1,76 @@
+# Be sure to restart your server when you modify this file
+
+# Uncomment below to force Rails into production mode when
+# you don't control web/app server and can't set it the proper way
+# ENV['RAILS_ENV'] ||= 'production'
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.1.1' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # Settings in config/environments/* take precedence over those specified here.
+  # Application configuration should go into files in config/initializers
+  # -- all .rb files in that directory are automatically loaded.
+  # See Rails::Configuration for more options.
+
+  # Skip frameworks you're not going to use. To use Rails without a database
+  # you must remove the Active Record framework.
+  # config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+
+  # Specify gems that this application depends on. 
+  # They can then be installed with "rake gems:install" on new installations.
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "aws-s3", :lib => "aws/s3"
+
+  # Only load the plugins named here, in the order given. By default, all plugins 
+  # in vendor/plugins are loaded in alphabetical order.
+  # :all can be used as a placeholder for all plugins not explicitly named
+  # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+  # Add additional load paths for your own custom dirs
+  # config.load_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Force all environments to use the same logger level
+  # (by default production uses :info, the others :debug)
+  # config.log_level = :debug
+
+  # Make Time.zone default to the specified zone, and make Active Record store time values
+  # in the database in UTC, and return them converted to the specified local zone.
+  # Run "rake -D time" for a list of tasks for finding time zone names. Comment line to use default local time.
+  config.time_zone = 'UTC'
+
+  # Your secret key for verifying cookie session data integrity.
+  # If you change this key, all old sessions will become invalid!
+  # Make sure the secret is at least 30 characters and all random, 
+  # no regular words or you'll be exposed to dictionary attacks.
+  config.action_controller.session = {
+    :session_key => '_iknow_on_rails_session',
+    :secret      => '5f988e6a1b554e6434373fbdb5506382102bffd1903e0b54a0d9e50745feb850ca5c228f25629402343b34af3e87315e69adf609e4fed030b07e3894cbe86736'
+  }
+
+  # Use the database for sessions instead of the cookie-based default,
+  # which shouldn't be used to store highly confidential information
+  # (create the session table with "rake db:sessions:create")
+  # config.action_controller.session_store = :active_record_store
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector
+end
+
+
+# Set your key and secret
+require 'iknow'
+Iknow::Config.init do |conf|
+  conf.api_key               = ''
+  conf.oauth_consumer_key    = ''
+  conf.oauth_consumer_secret = ''
+end

data/examples/iknow_on_rails/config/environments/development.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/examples/iknow_on_rails/config/environments/production.rb

@@ -0,0 +1,22 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The production environment is meant for finished, "live" apps.
+# Code is not reloaded between requests
+config.cache_classes = true
+
+# Use a different logger for distributed setups
+# config.logger = SyslogLogger.new
+
+# Full error reports are disabled and caching is turned on
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+config.action_view.cache_template_loading            = true
+
+# Use a different cache store in production
+# config.cache_store = :mem_cache_store
+
+# Enable serving of images, stylesheets, and javascripts from an asset server
+# config.action_controller.asset_host                  = "http://assets.example.com"
+
+# Disable delivery errors, bad email addresses will be ignored
+# config.action_mailer.raise_delivery_errors = false

data/examples/iknow_on_rails/config/environments/test.rb

@@ -0,0 +1,22 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test

data/examples/iknow_on_rails/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format 
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/examples/iknow_on_rails/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/examples/iknow_on_rails/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,17 @@
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+if defined?(ActiveRecord)
+  # Include Active Record class name as root for JSON serialized output.
+  ActiveRecord::Base.include_root_in_json = true
+
+  # Store the full class name (including module namespace) in STI type column.
+  ActiveRecord::Base.store_full_sti_class = true
+end
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false

data/examples/iknow_on_rails/config/routes.rb

@@ -0,0 +1,44 @@
+ActionController::Routing::Routes.draw do |map|
+  # The priority is based upon order of creation: first created -> highest priority.
+
+  # Sample of regular route:
+  #   map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   map.resources :products
+
+  # Sample resource route with options:
+  #   map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
+
+  # Sample resource route with sub-resources:
+  #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
+  
+  # Sample resource route with more complex sub-resources
+  #   map.resources :products do |products|
+  #     products.resources :comments
+  #     products.resources :sales, :collection => { :recent => :get }
+  #   end
+
+  # Sample resource route within a namespace:
+  #   map.namespace :admin do |admin|
+  #     # Directs /admin/products/* to Admin::ProductsController (app/controllers/admin/products_controller.rb)
+  #     admin.resources :products
+  #   end
+
+  # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
+  # map.root :controller => "welcome"
+  map.root :controller => "users"
+  
+  # See how all your routes lay out with "rake routes"
+
+  # Install the default routes as the lowest priority.
+  # Note: These default routes make all actions in every controller accessible via GET requests. You should
+  # consider removing the them or commenting them out if you're using named routes and resources.
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end

data/examples/iknow_on_rails/db/migrate/20081017012212_create_iknow_oauth_tokens.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/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