iknow 0.1.1 → 0.2.0

data/ChangeLog

@@ -18,4 +18,8 @@
 
 == 0.1.1
 
-* remove Mechanize
+* remove Mechanize
+
+== 0.2.0
+
+* support almost all API calls

data/examples/pure_ruby.rb

@@ -7,6 +7,7 @@ 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'
+  conf.timeout               = 15
 end
 
 # Edit here
@@ -36,7 +37,10 @@ end
 ## WITHOUT AUTHORIZATION ##
 ###########################
 
+puts "WITHOUT AUTHORIZATION"
+
 ## User API
+puts "# User API Calls"
 @user = Iknow::User.find('kirk')
 @user.items(:include_sentences => true)
 @user.lists
@@ -46,6 +50,7 @@ end
 @matched_users = Iknow::User.matching('matake')
 
 ## List API
+puts "# List API Calls"
 @recent_lists = Iknow::List.recent
 @list = Iknow::List.find(31509, :include_sentences => true, :include_items => true)
 @list.items
@@ -53,6 +58,7 @@ end
 @matched_lists = Iknow::List.matching("イタリア語であいさつ")
 
 ## Item API
+puts "# Item API Calls"
 @recent_items = Iknow::Item.recent(:include_sentences => true)
 @item = Iknow::Item.find(437525)
 @matched_items = Iknow::Item.matching('record', :include_sentences => true)
@@ -60,6 +66,7 @@ end
 @items.first.sentences
 
 ## Sentence API
+puts "# Sentence API Calls"
 @recent_sentences = Iknow::Sentence.recent
 @sentence = Iknow::Sentence.find(312271)
 @matched_sentences = Iknow::Sentence.matching('record')
@@ -84,15 +91,26 @@ unless iknow_auth
   puts "Skip calls which require authentication"
   exit
 else
-  puts "Authenticate Mode :: #{iknow_auth.mode}"
+  puts "## WITH AUTHORIZATION :: #{iknow_auth.mode}"
 end
 
 ## List API
-
+puts "# List API"
 @list = Iknow::List.create(iknow_auth, :title => 'iKnow! gem test', :description => 'A list for iKnow! gem test')
 @list.add_item(iknow_auth, Iknow::Item.find(437525))
-unless OAUTH_ACCESS_TOKEN.empty?
-  # A kind of weird, only with basic auth...
-  @list.delete_item(iknow_auth, @list.items.first)
-end
-@list.delete(iknow_auth)
+@list.delete_item(iknow_auth, @list.items.first)
+@list.delete(iknow_auth)
+
+## Item API
+puts "# Item API"
+@item = Iknow::Item.create(iknow_auth, :cue => {:text => 'hello world! 2', :language => 'en', :part_of_speech => 'E'}, 
+                                       :response => {:text => 'ハローワールド！', :language => 'ja'})
+@item.add_image(iknow_auth, 'http://farm4.static.flickr.com/3276/3102381796_a33c1ffdf1.jpg')
+@item.add_sound(iknow_auth, 'http://matake.jp/download/hello_world.mp3')
+@item.add_tags(iknow_auth, 'sample', 'programming')
+
+## Sentence API
+puts "# Sentence API"
+@sentence = Iknow::Sentence.create(iknow_auth, :text => 'Hello World!', :item => Iknow::Item.matching('hello world').first)
+@sentence.add_image(iknow_auth, 'http://farm4.static.flickr.com/3276/3102381796_a33c1ffdf1.jpg')
+@sentence.add_sound(iknow_auth, 'http://matake.jp/download/hello_world.mp3')

data/lib/iknow/core/config.rb

@@ -14,7 +14,7 @@ class Iknow::Config
       :api_protocol          => 'http',
       :api_host              => 'api.iknow.co.jp',
       :api_port              => 80,
-      :timeout               => 5,
+      :timeout               => 30,
       :api_key               => '',
       :oauth_consumer_key    => '',
       :oauth_consumer_secret => '',

data/lib/iknow/core/version.rb

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

data/lib/iknow/model/item.rb

@@ -1,10 +1,14 @@
 class Iknow::Item < Iknow::Base
-  ATTRIBUTES = [:sentences, :hash, :cue, :id]
-  attr_reader *ATTRIBUTES
+  ATTRIBUTES = [:sentences, :responses, :cue, :id, :list]
+  READONLY_ATTRIBUTES = [:sentences, :responses, :cue, :id]
+  attr_accessor *(ATTRIBUTES - READONLY_ATTRIBUTES)
+  attr_reader *READONLY_ATTRIBUTES
 
   class Response
-    ATTRIBUTES = [:text, :type, :language]
-    attr_reader *ATTRIBUTES
+    ATTRIBUTES = [:text, :text_with_character, :type, :language]
+    READONLY_ATTRIBUTES = [:type]
+    attr_accessor *(ATTRIBUTES - READONLY_ATTRIBUTES)
+    attr_reader *READONLY_ATTRIBUTES
     
     def initialize(params = {})
       @text     = params[:text]
@@ -15,9 +19,9 @@ class Iknow::Item < Iknow::Base
 
   class Cue
     ATTRIBUTES = [:text, :sound, :part_of_speech, :language]
-    NOT_WRITABLE_ATTRIBUTES = [:text]
-    attr_accessor *(ATTRIBUTES - NOT_WRITABLE_ATTRIBUTES)
-    attr_reader *NOT_WRITABLE_ATTRIBUTES
+    READONLY_ATTRIBUTES = [:sound]
+    attr_accessor *(ATTRIBUTES - READONLY_ATTRIBUTES)
+    attr_reader *READONLY_ATTRIBUTES
     
     def initialize(params = {})
       @text           = params[:text]
@@ -50,11 +54,87 @@ class Iknow::Item < Iknow::Base
     self.deserialize(hash) || []
   end
 
+  def self.create(iknow_auth, params = {})
+    self.new(params).save(iknow_auth)
+  end
+
   def initialize(params = {})
+    params[:responses] = [params[:response]] if params[:response]
     @id        = params[:id].to_i
+    @list      = params[:list]
     @cue       = self.deserialize(params[:cue], :as => Iknow::Item::Cue)
-    @hashs = self.deserialize(params[:hashs], :as => Iknow::Item::Response)
+    @responses = self.deserialize(params[:responses], :as => Iknow::Item::Response)
     @sentences = self.deserialize(params[:sentences], :as => Iknow::Sentence)
   end
 
+  def save(iknow_auth)
+    begin
+      item_id = Iknow::RestClient::Item.create(iknow_auth, self.to_post_data)
+    rescue
+      return false
+    end
+    Iknow::Item.find(item_id)
+  end
+
+  def add_image(iknow_auth, params)
+    post_params = if params.is_a?(String)
+      {'image[url]' => params,}
+    else
+      {'image[url]' => params[:url],
+       'image[list_id]' => params[:list_id] }
+    end
+    Iknow::RestClient::Item.add_image(iknow_auth, post_params.merge(:id => self.id))
+  end
+
+  def add_sound(iknow_auth, params)
+    post_params = if params.is_a?(String)
+      {'sound[url]' => params,}
+    else
+      {'sound[url]' => params[:url],
+       'sound[list_id]' => params[:list_id] }
+    end
+    Iknow::RestClient::Item.add_sound(iknow_auth, post_params.merge(:id => self.id))
+  end
+
+  def add_tags(iknow_auth, *tags)
+    post_params = {}
+    tags.each_with_index do |tag, idx|
+      post_params["semantic_tags[#{idx}][name]"] = tag
+    end
+    Iknow::RestClient::Item.add_tags(iknow_auth, post_params.merge(:id => self.id))
+  end
+
+  protected
+
+  def to_post_data
+    self.validate
+    post_data = {
+      'cue[text]'           => self.cue.text,
+      'cue[language]'       => self.cue.language,
+      'cue[part_of_speech]' => self.cue.part_of_speech,
+      'response[text]'      => self.response.text,
+      'response[language]'  => self.response.language
+    }
+    # Optional attributes
+    if self.list
+      post_data['item[list_id]'] = self.list.id
+    end
+    if response.text_with_character
+      post_data['character_response[text]'] = self.response.character_text
+    end
+    post_data
+  end
+
+  def validate
+    raise ArgumentError.new("Item cue[text] is required.") if self.cue.text.nil? or self.cue.text.empty?
+    raise ArgumentError.new("Item cue[language] is required.") if self.cue.language.nil? or self.cue.language.empty?
+    raise ArgumentError.new("Item cue[part_of_speech] is required.") if self.cue.part_of_speech.nil? or self.cue.part_of_speech.empty?
+    raise ArgumentError.new("Item response[text] is required.") if self.response.text.nil? or self.response.text.empty?
+    raise ArgumentError.new("Item response[language] is required.") if self.response.language.nil? or self.response.language.empty?
+  end
+
+  def response
+    self.responses.first
+  end
+
 end

data/lib/iknow/model/list.rb

@@ -18,9 +18,9 @@ class Iknow::List < Iknow::Base
                 :language, :translation_language, :list_type, :transcript, :embed,
                 :tags, :media_entry, :author, :author_id, :author_url, :attribution_license_id,
                 :items, :sentences]
-  NOT_WRITABLE_ATTRIBUTES = [:id, :icon, :item_count, :user_count, :iknow, :dictation, :brainspeed]
-  attr_accessor *(ATTRIBUTES - NOT_WRITABLE_ATTRIBUTES)
-  attr_reader   *NOT_WRITABLE_ATTRIBUTES
+  READONLY_ATTRIBUTES = [:id, :icon, :item_count, :user_count, :iknow, :dictation, :brainspeed]
+  attr_accessor *(ATTRIBUTES - READONLY_ATTRIBUTES)
+  attr_reader   *READONLY_ATTRIBUTES
 
   class Application
     attr_reader :application, :list_id, :lang
@@ -100,8 +100,8 @@ class Iknow::List < Iknow::Base
   def save(iknow_auth)
     begin
       list_id = Iknow::RestClient::List.create(iknow_auth, self.to_post_data)
-    # rescue
-    #   return false
+    rescue
+      return false
     end
     Iknow::List.find(list_id)
   end
@@ -122,8 +122,7 @@ class Iknow::List < Iknow::Base
   protected
 
   def to_post_data
-    raise ArgumentError.new("List title is needed.") if self.title.nil? or self.title.empty?
-    
+    self.validate
     post_data = {
       'list[name]'                 => self.title,
       'list[description]'          => self.description,
@@ -143,4 +142,9 @@ class Iknow::List < Iknow::Base
     post_data
   end
 
+  def validate
+    raise ArgumentError.new("List title is required.")       if self.title.nil?       or self.title.empty?
+    raise ArgumentError.new("List description is required.") if self.description.nil? or self.description.empty?
+  end
+
 end

data/lib/iknow/model/sentence.rb

@@ -1,8 +1,8 @@
 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)
+  ATTRIBUTES = [:sound, :image, :text, :language, :id, :transliterations, :translations, :item, :list]
+  READONLY_ATTRIBUTES = [:id]
+  attr_accessor *(ATTRIBUTES - READONLY_ATTRIBUTES)
+  attr_reader *READONLY_ATTRIBUTES
 
   def self.recent(params = {})
     hash = Iknow::RestClient::Sentence.recent(params)
@@ -21,8 +21,16 @@ class Iknow::Sentence < Iknow::Base
     self.deserialize(hash) || []
   end
 
+  def self.create(iknow_auth, params = {})
+    self.new(params).save(iknow_auth)
+  end
+
   def initialize(params = {})
+    params[:translations] = [params[:translation]] if params[:translation]
+    params[:transliterations] = [params[:transliteration]] if params[:transliteration]
     @id       = params[:id]
+    @item     = params[:item]
+    @list     = params[:list]
     @sound    = params[:sound]
     @image    = params[:image]
     @text     = params[:text]
@@ -31,4 +39,73 @@ class Iknow::Sentence < Iknow::Base
     @translations = self.deserialize(params[:translations], :as => Iknow::Sentence)
   end
 
+  def save(iknow_auth)
+    begin
+      sentence_id = Iknow::RestClient::Sentence.create(iknow_auth, self.to_post_data)
+    # rescue
+    #   return false
+    end
+    Iknow::Sentence.find(sentence_id)
+  end
+
+  def add_image(iknow_auth, params)
+    post_params = if params.is_a?(String)
+      {'image[url]' => params,}
+    else
+      {'image[url]' => params[:url],
+       'image[list_id]' => params[:list_id] }
+    end
+    Iknow::RestClient::Sentence.add_image(iknow_auth, post_params.merge(:id => self.id))
+  end
+
+  def add_sound(iknow_auth, params)
+    post_params = if params.is_a?(String)
+      {'sound[url]' => params,}
+    else
+      {'sound[url]' => params[:url],
+       'sound[list_id]' => params[:list_id] }
+    end
+    Iknow::RestClient::Sentence.add_sound(iknow_auth, post_params.merge(:id => self.id))
+  end
+
+  protected
+
+  def to_post_data
+    self.validate
+    post_data = {
+      'item_id' => self.item.id,
+      'sentence[text]' => self.text
+    }
+    # Optional attributes
+    if self.list
+      post_data['sentence[list_id]'] = self.list.id
+    end
+    [:language, :transliteration].each do |key|
+      if self.send("#{key}")
+        post_data["sentence[#{key}]"] = self.send("#{key}")
+      end
+    end
+    if self.translation
+      [:text, :language, :transliteration].each do |key|
+        if self.translation.send("#{key}")
+          post_data["translation[#{key}]"] = self.translation.send("#{key}")
+        end
+      end
+    end
+    post_data
+  end
+
+  def validate
+    raise ArgumentError.new("Item is required.") unless self.item
+    raise ArgumentError.new("Sentence text is required.") if self.text.nil? or self.text.empty?
+  end
+
+  def translation
+    self.translations.first rescue nil
+  end
+
+  def transliteration
+    self.transliterations.first rescue nil
+  end
+
 end

data/lib/iknow/rest_client/base.rb

@@ -63,16 +63,24 @@ class Iknow::RestClient::Base
       handle_json_response(response.body)
     when :nothing
       # success => nothing / failure => json error
-      handle_json_response(response.body) rescue :success
-    else
-      response.body
+      begin
+        handle_json_response(response.body)
+      rescue Exception => e
+        e.is_a?(RESTError) ? raise(e) : :success
+      end
+    else  
+      begin
+        handle_json_response(response.body)
+      rescue Exception => e
+        e.is_a?(RESTError) ? raise(e) : response.body
+      end
     end
   end
 
   def self.handle_json_response(json_response)
     hash = JSON.parse(json_response)
     unless (hash['error'].nil? rescue :success) # success response may be Array, not Hash.
-      if hash['error']['code'].to_i == 404
+      if hash['error']['code'] == 404
         return nil
       else
         raise RESTError.new(:code => hash['error']['code'], :message => hash['error']['message'])
@@ -111,7 +119,7 @@ class Iknow::RestClient::Base
     unless params.empty?
       params.each do |key, value|
         if path_with_params=~/__#{key}__/
-          path_with_params.sub!(/__#{key}__/, value.to_s)
+          path_with_params.sub!(/__#{key}__/, URI.encode(value.to_s))
           params.delete(key)
         end
       end

data/lib/iknow/rest_client/item.rb

@@ -5,8 +5,10 @@ class Iknow::RestClient::Item < Iknow::RestClient::Base
     :find      => { :path => '/items/__id__'               },
     :matching  => { :path => '/items/matching/__keyword__' },
     :extract   => { :path => '/items/extract',             },
+    :create    => { :path => '/items',               :http_method => :post },
     :add_image => { :path => '/items/__id__/images', :http_method => :post },
-    :add_sound => { :path => '/items/__id__/sounds', :http_method => :post }
+    :add_sound => { :path => '/items/__id__/sounds', :http_method => :post },
+    :add_tags  => { :path => '/items/__id__/tags',   :http_method => :post }
   }
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: iknow
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - nov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-20 00:00:00 +09:00
+date: 2008-12-21 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency