nov-iknow 0.2.0 → 0.2.2

data/ChangeLog

@@ -18,4 +18,16 @@
 
 == 0.1.1
 
-* remove Mechanize
+* remove Mechanize
+
+== 0.2.0
+
+* support almost all API calls
+
+== 0.2.1
+
+* maintenance release
+
+== 0.2.2
+
+* add attribution support for add_image & add_sound APIs

data/README

@@ -1,6 +1,6 @@
 = iknow
 
-  by nov <nmatake@cerego.co.jp>
+  by nov <developer@iknow.co.jp>
 
 == Description
 
@@ -40,6 +40,6 @@
 
 == Copyright
 
-Author::    nov <nmatake@cerego.co.jp>
+Author::    nov <developer@iknow.co.jp>
 Copyright:: Copyright (c) 2008 nov
 License::   MIT License

data/Rakefile

@@ -14,7 +14,7 @@ NAME              = "iknow"
 AUTHOR            = "nov"
 EMAIL             = "developer@iknow.co.jp"
 DESCRIPTION       = "A rubygem for iKnow! APIs"
-RUBYFORGE_PROJECT = "iknow"
+RUBYFORGE_PROJECT = NAME
 HOMEPATH          = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 BIN_FILES         = %w(  )
 
@@ -60,10 +60,9 @@ spec = Gem::Specification.new do |s|
 	#s.autorequire       = ""
 	s.test_files        = Dir["test/*_test.rb"]
 
-	s.add_dependency('rails', '>=2.1.0')
 	s.add_dependency('json')
-	s.add_dependency('oauth', '>=0.2.7')
-	s.required_ruby_version = '>= 1.8.6'
+	s.add_dependency('oauth')
+  # s.required_ruby_version = '>= 1.8.6'
 
 	s.files = %w(README ChangeLog Rakefile) +
 		Dir.glob("{bin,doc,test,lib,templates,extras,website,script}/**/*") + 

data/examples/pure_ruby.rb

@@ -7,6 +7,8 @@ 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.oauth_http_method     = :post
+  conf.oauth_scheme          = :header
   conf.timeout               = 15
 end
 

data/lib/iknow/core/auth.rb

@@ -28,10 +28,10 @@ class Iknow::Auth
     @@consumer ||= OAuth::Consumer.new(
       Iknow::Config.oauth_consumer_key,
       Iknow::Config.oauth_consumer_secret,
-      :http_method   => :get,
-      :schema        => :query_string,
-      :site          => Iknow::Config.iknow_api_base_url,
-      :authorize_url => "#{Iknow::Config.iknow_base_url}/oauth/authorize"
+      :http_method   => Iknow::Config.oauth_http_method,
+      :scheme        => Iknow::Config.oauth_scheme,
+      :site          => Iknow::Config.api_base_url,
+      :authorize_url => "#{Iknow::Config.base_url}/oauth/authorize"
     )
   end
 

data/lib/iknow/core/config.rb

@@ -2,9 +2,10 @@ require 'singleton'
 
 class Iknow::Config
   include Singleton
-  attr_accessor :protocol, :host, :port, :api_protocol, :api_host, :api_port, :timeout,
-                :api_key, :oauth_consumer_key, :oauth_consumer_secret,
-                :user_agent, :application_name, :application_version, :application_url, :source
+  ATTRIBUTES = [ :protocol, :host, :port, :api_protocol, :api_host, :api_port, :api_key, :timeout,
+                 :oauth_consumer_key, :oauth_consumer_secret, :oauth_http_method, :oauth_scheme,
+                 :user_agent, :application_name, :application_version, :application_url ]
+  attr_accessor *ATTRIBUTES
 
   def self.init(&block)
     conf = Iknow::Config.instance
@@ -14,10 +15,12 @@ class Iknow::Config
       :api_protocol          => 'http',
       :api_host              => 'api.iknow.co.jp',
       :api_port              => 80,
-      :timeout               => 30,
       :api_key               => '',
+      :timeout               => 30,
       :oauth_consumer_key    => '',
       :oauth_consumer_secret => '',
+      :oauth_http_method     => :post,
+      :oauth_scheme          => :header,
       :user_agent            => 'default',
       :application_name      => 'iKnow! Gem',
       :application_version   => Iknow::Version.to_version,
@@ -27,18 +30,22 @@ class Iknow::Config
     conf
   end
 
-  def iknow_base_url
+  def base_url
     port = self.port==80 ? nil : ":#{self.port}"
     "#{self.protocol}://#{self.host}#{port}"
   end
 
-  def iknow_api_base_url
+  def 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)
+  # hack: Object.timeout is already defined..
+  def self.timeout
+    instance.timeout
   end
 
-end
+  def self.method_missing(method, *args)
+    Iknow::Config.instance.send(method, *args)
+  end
+end

data/lib/iknow/core/version.rb

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

data/lib/iknow/model/item.rb

@@ -78,20 +78,46 @@ class Iknow::Item < Iknow::Base
 
   def add_image(iknow_auth, params)
     post_params = if params.is_a?(String)
-      {'image[url]' => params,}
+      { 'image[url]' => params }
     else
-      {'image[url]' => params[:url],
-       'image[list_id]' => params[:list_id] }
+      image_params = { 
+        'image[url]'     => params[:url],
+        'image[list_id]' => params[:list_id]
+      }
+      if params[:attribution]
+        attribution_params = { 
+          'attribution[media_entity]'           => params[:attribution][:media_entity],
+          'attribution[author]'                 => params[:attribution][:media_entity],
+          'attribution[author_url]'             => params[:attribution][:media_entity],
+          'attribution[attribution_license_id]' => params[:attribution][:media_entity]
+        }
+        image_params.merge(attribution_params)
+      else
+        image_params
+      end
     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,}
+      { 'sound[url]' => params }
     else
-      {'sound[url]' => params[:url],
-       'sound[list_id]' => params[:list_id] }
+      sound_params = {
+        'sound[url]' => params[:url],
+        'sound[list_id]' => params[:list_id]
+      }
+      if params[:attribution]
+        attribution_params = { 
+          'attribution[media_entity]'           => params[:attribution][:media_entity],
+          'attribution[author]'                 => params[:attribution][:media_entity],
+          'attribution[author_url]'             => params[:attribution][:media_entity],
+          'attribution[attribution_license_id]' => params[:attribution][:media_entity]
+        }
+        sound_params.merge(attribution_params)
+      else
+        sound_params
+      end
     end
     Iknow::RestClient::Item.add_sound(iknow_auth, post_params.merge(:id => self.id))
   end
@@ -99,7 +125,12 @@ class Iknow::Item < Iknow::Base
   def add_tags(iknow_auth, *tags)
     post_params = {}
     tags.each_with_index do |tag, idx|
-      post_params["semantic_tags[#{idx}][name]"] = tag
+      if tag.is_a?(String)
+        post_params["semantic_tags[#{idx}][name]"] = tag
+      else
+        post_params["semantic_tags[#{idx}][name]"] = tag[:name]
+        post_params["semantic_tags[#{idx}][disambiguation]"] = tag[:disambiguation]
+      end
     end
     Iknow::RestClient::Item.add_tags(iknow_auth, post_params.merge(:id => self.id))
   end

data/lib/iknow/model/list.rb

@@ -14,7 +14,7 @@
 #     "author_url": "http://www.iknow.co.jp/user/Cerego"
 
 class Iknow::List < Iknow::Base
-  ATTRIBUTES = [:id, :title, :description, :icon, :item_count, :user_count, :iknow, :dictation, :brainspeed,
+  ATTRIBUTES = [:id, :title, :description, :icon, :square_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]
@@ -64,6 +64,7 @@ class Iknow::List < Iknow::Base
     @title       = params[:title]
     @description = params[:description]
     @icon        = params[:icon]
+    @square_icon = params[:square_icon]
     @item_count  = (params[:item_count].to_i rescue nil)
     @user_count  = (params[:user_count].to_i rescue nil)
     @language    = params[:language]

data/lib/iknow/model/sentence.rb

@@ -1,5 +1,5 @@
 class Iknow::Sentence < Iknow::Base
-  ATTRIBUTES = [:sound, :image, :text, :language, :id, :transliterations, :translations, :item, :list]
+  ATTRIBUTES = [:sound, :image, :square_image, :text, :language, :id, :transliterations, :translations, :item, :list]
   READONLY_ATTRIBUTES = [:id]
   attr_accessor *(ATTRIBUTES - READONLY_ATTRIBUTES)
   attr_reader *READONLY_ATTRIBUTES
@@ -33,6 +33,7 @@ class Iknow::Sentence < Iknow::Base
     @list     = params[:list]
     @sound    = params[:sound]
     @image    = params[:image]
+    @square_image = params[:square_image]
     @text     = params[:text]
     @language = params[:language]
     @transliterations = params[:transliterations]
@@ -50,20 +51,46 @@ class Iknow::Sentence < Iknow::Base
 
   def add_image(iknow_auth, params)
     post_params = if params.is_a?(String)
-      {'image[url]' => params,}
+      { 'image[url]' => params }
     else
-      {'image[url]' => params[:url],
-       'image[list_id]' => params[:list_id] }
+      image_params = { 
+        'image[url]'     => params[:url],
+        'image[list_id]' => params[:list_id]
+      }
+      if params[:attribution]
+        attribution_params = { 
+          'attribution[media_entity]'           => params[:attribution][:media_entity],
+          'attribution[author]'                 => params[:attribution][:media_entity],
+          'attribution[author_url]'             => params[:attribution][:media_entity],
+          'attribution[attribution_license_id]' => params[:attribution][:media_entity]
+        }
+        image_params.merge(attribution_params)
+      else
+        image_params
+      end
     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,}
+      { 'sound[url]' => params }
     else
-      {'sound[url]' => params[:url],
-       'sound[list_id]' => params[:list_id] }
+      sound_params = {
+        'sound[url]' => params[:url],
+        'sound[list_id]' => params[:list_id]
+      }
+      if params[:attribution]
+        attribution_params = { 
+          'attribution[media_entity]'           => params[:attribution][:media_entity],
+          'attribution[author]'                 => params[:attribution][:media_entity],
+          'attribution[author_url]'             => params[:attribution][:media_entity],
+          'attribution[attribution_license_id]' => params[:attribution][:media_entity]
+        }
+        sound_params.merge(attribution_params)
+      else
+        sound_params
+      end
     end
     Iknow::RestClient::Sentence.add_sound(iknow_auth, post_params.merge(:id => self.id))
   end

data/lib/iknow.rb

@@ -11,4 +11,6 @@ require 'json'
 require 'ext/hash'
 require 'iknow/core'
 require 'iknow/rest_client'
-require 'iknow/model'
+require 'iknow/model'
+
+Iknow::Config.init

data/test/iknow_test.rb

@@ -2,4 +2,7 @@ require File.dirname(__FILE__) + '/test_helper.rb'
 
 require "test/unit"
 class IknowTest < Test::Unit::TestCase
+  def test_truth
+    true
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nov-iknow
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors: 
 - nov
@@ -9,18 +9,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-21 00:00:00 -08:00
+date: 2008-12-24 00:00:00 -08:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rails
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.1.0
-    version: 
 - !ruby/object:Gem::Dependency 
   name: json
   version_requirement: 
@@ -37,7 +28,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.7
+        version: "0"
     version: 
 description: A rubygem for iKnow! APIs
 email: developer@iknow.co.jp
@@ -100,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.8.6
+      version: "0"
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: