nov-iknow 0.0.3 → 0.0.4

data/ChangeLog

@@ -2,3 +2,11 @@
 
 * initial release
 
+== 0.0.2
+
+== 0.0.3
+
+== 0.0.4
+
+* add new API calls
+* add new attributes

data/Rakefile

@@ -62,7 +62,7 @@ spec = Gem::Specification.new do |s|
 
 	s.add_dependency('rails', '>=2.1.0')
 	s.add_dependency('json')
-	s.add_dependency('oauth', '=0.2.4')
+	s.add_dependency('oauth', '>=0.2.4')
 	s.required_ruby_version = '>= 1.8.6'
 
 	s.files = %w(README ChangeLog Rakefile) +

data/examples/pure_ruby.rb

@@ -2,9 +2,9 @@ require 'rubygems'
 require 'iknow'
 
 Iknow::Config.init do |conf|
-  conf.api_key               = ''
-  conf.oauth_consumer_key    = ''
-  conf.oauth_consumer_secret = ''
+  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
@@ -24,25 +24,31 @@ if Iknow::Config.api_key == ''# or
 end
 
 ## User API
-@user = Iknow::User.find('matake')
-@user.items
+@user = Iknow::User.find('kirk')
+@user.items(:include_sentences => true)
 @user.lists
 @user.friends
 @user.study.results
-@matchied_users = Iknow::User.matching('matake')
+@user.study.total_results
+@matched_users = Iknow::User.matching('matake')
 
-# ## List API
+## List API
 @recent_lists = Iknow::List.recent
-@matchied_lists = Iknow::List.matching("遺伝的アルゴリズム")
-@matchied_lists.first.items
-@matchied_lists.first.sentences
+@list = Iknow::List.find(31509, :include_sentences => true, :include_items => true)
+@list.items
+@list.sentences
+@matched_lists = Iknow::List.matching("イタリア語であいさつ")
 
-# ## Item API
-@recent_items = Iknow::Item.recent
-@matchied_items = Iknow::Item.matching('record')
+# 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
-@matchied_sentences = Iknow::Sentence.matching('record')
+@sentence = Iknow::Sentence.find(312271)
+@matched_sentences = Iknow::Sentence.matching('record')

data/lib/ext/hash.rb

@@ -7,4 +7,17 @@ class Hash
     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/version.rb

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

data/lib/iknow/model/base.rb

@@ -5,13 +5,21 @@ class Iknow::Base
   def attributes; self.class.attributes  end
 
   def self.deserialize(response, params = {})
-    return nil if response.is_a?(Hash) and
+    return nil if response.nil? or
+                 (response.is_a?(Hash) and
                  !response['error'].nil? and
-                  response['error']['code'].to_i == 404
+                  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)
+    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 = {})

data/lib/iknow/model/item.rb

@@ -3,24 +3,27 @@ class Iknow::Item < Iknow::Base
   attr_reader *ATTRIBUTES
 
   class Response
-    ATTRIBUTES = [:text]
+    ATTRIBUTES = [:text, :type, :language]
     attr_reader *ATTRIBUTES
     
     def initialize(params = {})
-      @text = params['text']
+      @text     = params[:text]
+      @type     = params[:type]
+      @language = params[:language]
     end
   end
 
   class Cue
-    ATTRIBUTES = [:sound, :part_of_speech, :text]
+    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']
-      @image = params['part_of_speech']
+      @text           = params[:text]
+      @sound          = params[:sound]
+      @part_of_speech = params[:part_of_speech]
+      @language       = params[:language]
     end
   end
 
@@ -29,6 +32,12 @@ class Iknow::Item < Iknow::Base
     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)
@@ -42,13 +51,10 @@ class Iknow::Item < Iknow::Base
   end
 
   def initialize(params = {})
-    @id = params['id'].to_i
-    @sentences = []
-    params['sentences'].each do |sentence|
-      @sentences << Iknow::Sentence.new(sentence)
-    end
-    @response = params['response'] ? Iknow::Item::Response.new(params['response']) : nil
-    @cue      = Iknow::Item::Cue.new(params['cue'])
+    @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

@@ -1,16 +1,50 @@
+#     "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, :link,
+  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_url, :attribution_license_id]
-  NOT_WRITABLE_ATTRIBUTES = [:list_id]
+                :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)
@@ -23,10 +57,31 @@ class Iknow::List < Iknow::Base
   end
 
   def initialize(params = {})
-    @list_id     = params['id'].to_i if params['id']
-    @title       = params[:title]       || params['title']
-    @description = params[:description] || params['description']
-    @link        = params[:link]        || params['link']
+    @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 = {})

data/lib/iknow/model/sentence.rb

@@ -1,5 +1,5 @@
 class Iknow::Sentence < Iknow::Base
-  ATTRIBUTES = [:sound, :image, :text]
+  ATTRIBUTES = [:sound, :image, :text, :language, :id, :transliterations, :translations]
   WRITABLE_ATTRIBUTES = [:sound, :image]
   attr_accessor *WRITABLE_ATTRIBUTES
   attr_reader *(ATTRIBUTES - WRITABLE_ATTRIBUTES)
@@ -9,6 +9,12 @@ class Iknow::Sentence < Iknow::Base
     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)
@@ -16,9 +22,13 @@ class Iknow::Sentence < Iknow::Base
   end
 
   def initialize(params = {})
-    @sound = params['sound']
-    @image = params['image']
-    @text  = params['text']
+    @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

@@ -7,19 +7,19 @@ class Iknow::User < Iknow::Base
     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']
+      @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]
+    ATTRIBUTES = [:today, :results, :total_summary]
     attr_reader *ATTRIBUTES
 
     class Result < Iknow::Base
@@ -27,28 +27,43 @@ class Iknow::User < Iknow::Base
       attr_reader *ATTRIBUTES
 
       def initialize(params = {})
-        @timestamp = (params['timestamp'].to_i   rescue nil)
-        @seconds   = (params['seconds'].to_i     rescue nil)
+        @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)
+          :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)
+        @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)
+      @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)
-    response = Iknow::RestClient::User.find(:username => username)
+  def self.find(username, params = {})
+    params[:username] = username
+    response = Iknow::RestClient::User.find(params)
     self.deserialize(response)
   end
 
@@ -59,8 +74,8 @@ class Iknow::User < Iknow::Base
   end
 
   def initialize(params)
-    @profile  = Profile.new(params['profile'])
-    @username = params['username']
+    @profile  = Profile.new(params[:profile])
+    @username = params[:username]
   end
 
   def items(params = {})

data/lib/iknow/rest_client/item.rb

@@ -2,6 +2,7 @@ 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 },

data/lib/iknow/rest_client/list.rb

@@ -2,6 +2,7 @@ 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__'            },

data/lib/iknow/rest_client/sentence.rb

@@ -2,6 +2,7 @@ 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 },

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nov-iknow
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - nov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-18 00:00:00 -07:00
+date: 2008-11-29 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,7 +35,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 0.2.4
     version: