iknow 0.0.4

data/lib/iknow/model/sentence.rb

@@ -0,0 +1,34 @@
+class Iknow::Sentence < Iknow::Base
+  ATTRIBUTES = [:sound, :image, :text, :language, :id, :transliterations, :translations]
+  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) || []
+  end
+
+  def self.find(sentence_id, params = {})
+    params[:id] = sentence_id
+    response = Iknow::RestClient::Sentence.find(params)
+    self.deserialize(response)
+  end
+
+  def self.matching(keyword, params = {})
+    params[:keyword] = keyword
+    response = Iknow::RestClient::Sentence.matching(params)
+    self.deserialize(response) || []
+  end
+
+  def initialize(params = {})
+    @id       = params[:id]
+    @sound    = params[:sound]
+    @image    = params[:image]
+    @text     = params[:text]
+    @language = params[:language]
+    @transliterations = params[:transliterations]
+    @translations = self.deserialize(params[:translations], :as => Iknow::Sentence)
+  end
+
+end

data/lib/iknow/model/user.rb

@@ -0,0 +1,102 @@
+class Iknow::User < Iknow::Base
+  ATTRIBUTES = [:username, :profile]
+  attr_reader *ATTRIBUTES
+
+  class Profile < Iknow::Base
+    ATTRIBUTES = [:name, :gender, :birthday, :description, :blog_url, :profile_url, :foaf_url, :icon_url]
+    attr_reader *ATTRIBUTES
+
+    def initialize(params = {})
+      @name        = params[:name]
+      @gender      = params[:gender]
+      @birthday    = (Date.parse(params[:birthday]) rescue nil)
+      @description = params[:description]
+      @blog_url    = params[:blog_url]
+      @profile_url = params[:profile_url]
+      @foaf_url    = params[:foaf_url]
+      @icon_url    = params[:icon_url]
+    end
+  end
+
+  class Study < Iknow::Base
+    ATTRIBUTES = [:today, :results, :total_summary]
+    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
+
+    class TotalSummary < Iknow::Base
+      ATTRIBUTES = [:studied, :completed, :performance, :best_speed, :best_score]
+      attr_reader *ATTRIBUTES
+
+      def initialize(params = {})
+        @studied     = params[:studied]
+        @completed   = params[:completed]
+        @performance = params[:performance]
+        @best_speed  = params[:best_speed]
+        @best_score  = params[:best_score]
+      end
+    end
+
+    def initialize(params = {})
+      @today         = (Date.parse(params[:today]) rescue nil)
+      @results       = self.deserialize(params[:study_results], :as => Iknow::User::Study::Result)
+      @total_summary = self.deserialize(params[:total_summary], :as => Iknow::User::Study::TotalSummary)
+    end
+
+  end
+
+  def self.find(username, params = {})
+    params[:username] = username
+    response = Iknow::RestClient::User.find(params)
+    self.deserialize(response)
+  end
+
+  def self.matching(keyword, params = {})
+    params[:keyword] = keyword
+    response = Iknow::RestClient::User.matching(params)
+    self.deserialize(response) || []
+  end
+
+  def initialize(params)
+    @profile  = Profile.new(params[:profile])
+    @username = params[:username]
+  end
+
+  def items(params = {})
+    response = Iknow::RestClient::User.items(params.merge(:username => self.username))
+    self.deserialize(response, :as => Iknow::Item) || []
+  end
+
+  def lists(params = {})
+    response = Iknow::RestClient::User.lists(params.merge(:username => self.username))
+    self.deserialize(response, :as => Iknow::List) || []
+  end
+
+  def friends(params = {})
+    response = Iknow::RestClient::User.friends(params.merge(:username => self.username))
+    self.deserialize(response) || []
+  end
+
+  def study(params = {})
+    params[:application] ||= 'iknow'
+    response = Iknow::RestClient::User.study_results(params.merge(:username => self.username))
+    self.deserialize(response, :as => Iknow::User::Study)
+  end
+
+end

data/lib/iknow/model.rb

@@ -0,0 +1,5 @@
+require 'iknow/model/base'
+require 'iknow/model/user'
+require 'iknow/model/list'
+require 'iknow/model/item'
+require 'iknow/model/sentence'

data/lib/iknow/rest_client/base.rb

@@ -0,0 +1,114 @@
+class Iknow::RestClient::Base
+
+  class RESTError < Exception
+    attr_accessor :code, :message, :uri
+
+    def initialize(params = {})
+      self.code    = params[:code]
+      self.message = params[:message]
+      self.uri     = params[:uri]
+    end
+
+    def to_s
+      "HTTP #{@code}: #{@message} at #{@uri}"
+    end
+  end
+
+  def self.valid_action?(action) ; self::ACTIONS.keys.include? action.to_sym          end
+  def self.path(action)          ; self::ACTIONS[action.to_sym][:path]                end
+  def self.http_method(action)   ; self::ACTIONS[action.to_sym][:http_method] || :get end
+
+  def self.method_missing(action, *args)
+    # GET methods are handled here
+    # POST and DELETE methods should be implemented in each class
+    super unless self.valid_action?(action)
+    uri, params = replace_uri_params(self.path(action), args[0])
+    http_connect do |conn|
+      case self.http_method(action)
+      when :get
+        http_get_request(uri, params)
+      when :post
+        http_post_request(uri, params)
+      when :delete
+        http_delete_request(uri, params)
+      end
+    end
+  end
+
+  private
+
+  def self.config; Iknow::Config end
+  
+  def self.api_key_required
+    raise ArgumentError.new("iKnow! API key is required") if self.config.api_key == ''
+  end
+
+  def self.http_connect
+    connection = Net::HTTP.new(self.config.api_host, self.config.api_port)
+    connection.start do |conn|
+      request  = yield connection
+      response = conn.request(request)
+      handle_rest_response(response)
+      JSON.parse(response.body)
+    end
+  end
+
+  def self.raise_rest_error(response, uri = nil)
+    raise RESTError.new(:code => response.code, :message => response.message, :uri => uri)
+  end
+
+  def self.handle_rest_response(response, uri = nil)
+    raise_rest_error(response, uri) unless response.is_a?(Net::HTTPSuccess)
+  end
+
+  def self.http_header
+    @@http_header ||= {
+      'User-Agent'             => "iKnow! API v#{Iknow::Version.to_version} [#{self.config.user_agent}]",
+      'Accept'                 => 'text/x-json',
+      'X-iKnow-Client'         => self.config.application_name,
+      'X-iKnow-Client-Version' => self.config.application_version,
+      'X-iKnow-Client-URL'     => self.config.application_url,
+    }
+    @@http_header
+  end
+
+  def self.replace_uri_params(uri, params = {})
+    replaced_uri = uri.clone
+    unless params.empty?
+      params.each do |key, value|
+        if replaced_uri=~/__#{key}__/
+          replaced_uri.sub!(/__#{key}__/, value.to_s)
+          params.delete(key)
+        end
+      end
+    end
+    return replaced_uri, params
+  end
+
+  def self.http_get_request(uri, params = {})
+    unless self.config.api_key == ''
+      params.merge!(:api_key => self.config.api_key)
+    end
+    path = (params.size > 0) ? "#{uri}?#{params.to_http_str}" : uri
+    Net::HTTP::Get.new(path, http_header)
+  end
+
+  def self.http_post_request(uri, params = {})
+    self.api_key_required
+    request = Net::HTTP::Post.new(uri, http_header)
+    request.body = params.merge(:api_key => self.config.api_key).to_http_str
+    request
+  end
+
+  def self.http_delete_request(uri, params = {})
+    unless self.config.api_key == ''
+      params.merge!(:api_key => self.config.api_key)
+    end
+    path = (params.size > 0) ? "#{uri}?#{params.to_http_str}" : uri
+    Net::HTTP::Delete.new(path, http_header)
+  end
+
+  private_class_method :http_connect, :raise_rest_error, :handle_rest_response, :http_header,
+                       :replace_uri_params, :http_get_request, :http_post_request, :http_delete_request
+
+end

data/lib/iknow/rest_client/item.rb

@@ -0,0 +1,12 @@
+class Iknow::RestClient::Item < Iknow::RestClient::Base
+  
+  ACTIONS = {
+    :recent    => { :path => '/items'                                      },
+    :find      => { :path => '/items/__id__'                               },
+    :matching  => { :path => '/items/matching/__keyword__'                 },
+    :add_image => { :path => '/items/__id__/images', :http_method => :post },
+    :add_sound => { :path => '/items/__id__/sounds', :http_method => :post },
+    :extract   => { :path => '/items/extract',       :http_method => :post }
+  }
+  
+end

data/lib/iknow/rest_client/list.rb

@@ -0,0 +1,13 @@
+class Iknow::RestClient::List < Iknow::RestClient::Base
+  
+  ACTIONS = {
+    :recent    => { :path => '/lists'                                 },
+    :find      => { :path => '/lists/__id__'                          },
+    :items     => { :path => '/lists/__id__/items'                    },
+    :sentences => { :path => '/lists/__id__/sentences'                },
+    :matching  => { :path => '/lists/matching/__keyword__'            },
+    :create    => { :path => '/lists',        :http_method => :post   },
+    :delete    => { :path => '/lists/__id__', :http_method => :delete }
+  }
+
+end

data/lib/iknow/rest_client/sentence.rb

@@ -0,0 +1,12 @@
+class Iknow::RestClient::Sentence < Iknow::RestClient::Base
+  
+  ACTIONS = {
+    :recent    => { :path => '/sentences'                                      },
+    :find      => { :path => '/sentences/__id__'                               },
+    :matching  => { :path => '/sentences/matching/__keyword__'                 },
+    :create    => { :path => '/sentences',               :http_method => :post },
+    :add_image => { :path => '/sentences/__id__/images', :http_method => :post },
+    :add_sound => { :path => '/sentences/__id__/sounds', :http_method => :post }
+  }
+  
+end

data/lib/iknow/rest_client/user.rb

@@ -0,0 +1,12 @@
+class Iknow::RestClient::User < Iknow::RestClient::Base
+  
+  ACTIONS = {
+    :find          => { :path => '/users/__username__'         },
+    :lists         => { :path => '/users/__username__/lists'   },
+    :items         => { :path => '/users/__username__/items'   },
+    :friends       => { :path => '/users/__username__/friends' },
+    :study_results => { :path => '/users/__username__/study_results/__application__'   },
+    :matching      => { :path => '/users/matching/__keyword__' }
+  }
+  
+end

data/lib/iknow/rest_client.rb

@@ -0,0 +1,8 @@
+module Iknow::RestClient
+end
+
+require 'iknow/rest_client/base'
+require 'iknow/rest_client/user'
+require 'iknow/rest_client/list'
+require 'iknow/rest_client/item'
+require 'iknow/rest_client/sentence'

data/lib/iknow.rb

@@ -0,0 +1,14 @@
+module Iknow
+end
+
+require 'date'
+require 'net/https'
+require 'uri'
+
+require 'rubygems'
+require 'json'
+
+require 'ext/hash'
+require 'iknow/core'
+require 'iknow/rest_client'
+require 'iknow/model'

data/test/iknow_test.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+require "test/unit"
+class IknowTest < Test::Unit::TestCase
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/iknow'
+

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: iknow
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- nov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-01 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.4
+    version: 
+description: A rubygem for iKnow! APIs
+email: developer@iknow.co.jp
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- ChangeLog
+files: 
+- README
+- ChangeLog
+- Rakefile
+- test/iknow_test.rb
+- test/test_helper.rb
+- lib/ext
+- lib/ext/hash.rb
+- lib/iknow
+- lib/iknow/core
+- lib/iknow/core/config.rb
+- lib/iknow/core/version.rb
+- lib/iknow/core.rb
+- lib/iknow/model
+- lib/iknow/model/base.rb
+- lib/iknow/model/item.rb
+- lib/iknow/model/list.rb
+- lib/iknow/model/sentence.rb
+- lib/iknow/model/user.rb
+- lib/iknow/model.rb
+- lib/iknow/rest_client
+- lib/iknow/rest_client/base.rb
+- lib/iknow/rest_client/item.rb
+- lib/iknow/rest_client/list.rb
+- lib/iknow/rest_client/sentence.rb
+- lib/iknow/rest_client/user.rb
+- lib/iknow/rest_client.rb
+- lib/iknow.rb
+- generators/iknow_oauth
+- generators/iknow_oauth/iknow_oauth_generator.rb
+- generators/iknow_oauth/templates
+- generators/iknow_oauth/templates/iknow_oauth_controller.rb
+- generators/iknow_oauth/templates/iknow_oauth_controller_test.rb
+- generators/iknow_oauth/templates/iknow_oauth_helper.rb
+- generators/iknow_oauth/templates/iknow_oauth_system.rb
+- generators/iknow_oauth/templates/iknow_oauth_token.rb
+- generators/iknow_oauth/templates/iknow_oauth_token_test.rb
+- generators/iknow_oauth/templates/iknow_oauth_tokens_migration.rb
+- generators/iknow_oauth/templates/index.rhtml
+- generators/iknow_oauth/USAGE
+- examples/iknow_on_rails/app/controllers/application.rb
+- examples/iknow_on_rails/app/controllers/iknow_oauth_controller.rb
+- examples/iknow_on_rails/app/controllers/users_controller.rb
+- examples/iknow_on_rails/app/helpers/application_helper.rb
+- examples/iknow_on_rails/app/helpers/iknow_oauth_helper.rb
+- examples/iknow_on_rails/app/helpers/users_helper.rb
+- examples/iknow_on_rails/app/models/iknow_oauth_token.rb
+- examples/iknow_on_rails/config/boot.rb
+- examples/iknow_on_rails/config/environment.rb
+- examples/iknow_on_rails/config/environments/development.rb
+- examples/iknow_on_rails/config/environments/production.rb
+- examples/iknow_on_rails/config/environments/test.rb
+- examples/iknow_on_rails/config/initializers/inflections.rb
+- examples/iknow_on_rails/config/initializers/mime_types.rb
+- examples/iknow_on_rails/config/initializers/new_rails_defaults.rb
+- examples/iknow_on_rails/config/routes.rb
+- examples/iknow_on_rails/db/migrate/20081017012212_create_iknow_oauth_tokens.rb
+- examples/iknow_on_rails/db/schema.rb
+- examples/iknow_on_rails/lib/iknow_oauth_system.rb
+- examples/iknow_on_rails/public/dispatch.rb
+- examples/iknow_on_rails/test/functional/iknow_oauth_controller_test.rb
+- examples/iknow_on_rails/test/functional/users_controller_test.rb
+- examples/iknow_on_rails/test/test_helper.rb
+- examples/iknow_on_rails/test/unit/iknow_oauth_token_test.rb
+- examples/pure_ruby.rb
+has_rdoc: true
+homepage: http://iknow.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --title
+- iknow documentation
+- --charset
+- utf-8
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --inline-source
+- --exclude
+- ^(examples|extras)/
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: iknow
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A rubygem for iKnow! APIs
+test_files: 
+- test/iknow_test.rb