nov-smartfm 0.4.0

data/ChangeLog

@@ -0,0 +1,43 @@
+== 0.0.1 / 2008-10-13
+
+* initial release
+
+== 0.0.2
+
+== 0.0.3
+
+== 0.0.4
+
+* add new API calls
+* add new attributes
+
+== 0.1.0
+
+* add Smartfm::Auth (supports basic_auth and oauth)
+* add List#create, List#delete, List#add_item, List#delete_item
+
+== 0.1.1
+
+* 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
+
+== 0.3.0
+
+* iKnow! => smart.fm
+* now, iKnow! is the name of Flash study application
+
+== 0.3.1
+
+* add sessions API support
+* fixed extract API bugs

data/README

@@ -0,0 +1,45 @@
+= smart.fm
+
+  by nov <nov@cerego.com>
+
+== Description
+
+  This rubygem is a wrapper of smart.fm API.
+  You can get pure-ruby example at examples/pure_ruby.rb.
+  http://github.com/nov/smartfm/tree/master/examples/pure_ruby.rb
+  
+  It shows all API calls you can use with this gem.
+
+== Installation
+
+  git clone http://github.com/nov/smartfm.git
+  cd smartfm
+  rake install
+
+=== Archive Installation
+
+	rake install
+
+=== Gem Installation
+
+	gem install smartfm
+
+== Features/Problems
+
+  Test! Test!! Test!!!
+
+  Create/Add/Delete APIs are not implemented.
+  They will be implemented in a few weeks.
+  
+  smart.fm OAuth is still pre-alpha.
+
+== Synopsis
+  
+  See examples and smart.fm Developers, please.
+  smart.fm Developers (http://developer.smart.fm)
+
+== Copyright
+
+Author::    nov <nov@cerego.com>
+Copyright:: Copyright (c) 2009 nov
+License::   MIT License

data/Rakefile

@@ -0,0 +1,155 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/sshpublisher'
+require 'fileutils'
+include FileUtils
+
+NAME              = "smartfm"
+AUTHOR            = "nov"
+EMAIL             = "developer@smart.fm"
+DESCRIPTION       = "A rubygem for smart.fm APIs"
+RUBYFORGE_PROJECT = NAME
+HOMEPATH          = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+BIN_FILES         = %w(  )
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/lib"
+require 'lib/smartfm'
+VERS              = Smartfm::Version.to_version
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = [
+	'--title', "#{NAME} documentation",
+	"--charset", "utf-8",
+	"--opname", "index.html",
+	"--line-numbers",
+	"--main", "README",
+	"--inline-source",
+]
+
+task :default => [:test]
+task :package => [:clean]
+
+Rake::TestTask.new("test") do |t|
+	t.libs   << "test"
+	t.pattern = "test/**/*_test.rb"
+	t.verbose = true
+end
+
+Rake::TestTask.new("spec") do |t|
+	t.libs   << "spec"
+	t.pattern = "spec/**/*_spec.rb"
+	t.verbose = true
+end
+
+spec = Gem::Specification.new do |s|
+	s.name              = NAME
+	s.version           = VERS
+	s.platform          = Gem::Platform::RUBY
+	s.has_rdoc          = true
+	s.extra_rdoc_files  = ["README", "ChangeLog"]
+	s.rdoc_options     += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
+	s.summary           = DESCRIPTION
+	s.description       = DESCRIPTION
+	s.author            = AUTHOR
+	s.email             = EMAIL
+	s.homepage          = HOMEPATH
+	s.executables       = BIN_FILES
+	s.rubyforge_project = RUBYFORGE_PROJECT
+	s.bindir            = "bin"
+	s.require_path      = "lib"
+	#s.autorequire       = ""
+	s.test_files        = Dir["test/*_test.rb"]
+
+	s.add_dependency('json')
+	s.add_dependency('oauth')
+  # s.required_ruby_version = '>= 1.8.6'
+
+	s.files = %w(README ChangeLog Rakefile) +
+		Dir.glob("{bin,doc,test,spec,lib,templates,extras,website,script}/**/*") + 
+		Dir.glob("ext/**/*.{h,c,rb}") +
+		Dir.glob("examples/**/*.rb") +
+		Dir.glob("tools/*.rb") +
+		Dir.glob("rails/*.rb")
+
+	s.extensions = FileList["ext/**/extconf.rb"].to_a
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+	p.need_tar = true
+	p.gem_spec = spec
+end
+
+desc "Install"
+task :install do
+	name = "#{NAME}-#{VERS}.gem"
+	sh %{rake package}
+	sh %{sudo gem install pkg/#{name}}
+end
+
+desc "Uninstall"
+task :uninstall => [:clean] do
+	sh %{sudo gem uninstall #{NAME}}
+end
+
+
+Rake::RDocTask.new do |rdoc|
+	rdoc.rdoc_dir = 'html'
+	rdoc.options += RDOC_OPTS
+	rdoc.template = "resh"
+	#rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+	if ENV['DOC_FILES']
+		rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
+	else
+		rdoc.rdoc_files.include('README', 'ChangeLog')
+		rdoc.rdoc_files.include('lib/**/*.rb')
+		rdoc.rdoc_files.include('ext/**/*.c')
+	end
+end
+
+desc "Publish to RubyForge"
+task :rubyforge => [:rdoc, :package] do
+	require 'rubyforge'
+	Rake::RubyForgePublisher.new(RUBYFORGE_PROJECT, 'nov').upload
+end
+
+# rake release VERSION=x.y.z
+desc 'Package and upload the release to rubyforge.'
+task :release => [:clean, :package] do |t|
+	v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+	abort "Versions don't match #{v} vs #{VERS}" unless v == VERS
+	pkg = "pkg/#{NAME}-#{VERS}"
+
+	require 'rubyforge'
+	rf = RubyForge.new.configure
+	puts "Logging in"
+	rf.login
+
+	c = rf.userconfig
+#	c["release_notes"] = description if description
+#	c["release_changes"] = changes if changes
+	c["preformatted"] = true
+
+	files = [
+		"#{pkg}.tgz",
+		"#{pkg}.gem"
+	].compact
+
+	puts "Releasing #{NAME} v. #{VERS}"
+	rf.add_release RUBYFORGE_PROJECT, NAME, VERS, *files
+end
+
+desc 'Show information about the gem.'
+task :debug_gem do
+	puts spec.to_ruby
+end
+
+desc 'Update gem spec'
+task :gemspec do
+  open("#{NAME}.gemspec", 'w').write spec.to_ruby
+end

data/examples/pure_ruby.rb

@@ -0,0 +1,119 @@
+require 'rubygems'
+require 'smartfm'
+require 'oauth/consumer'
+
+Smartfm::Config.init do |conf|
+  conf.api_host              = 'api.smart.fm'
+  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
+
+# Edit here
+OAUTH_ACCESS_TOKEN = ''
+OAUTH_ACCESS_TOKEN_SECRET = ''
+
+# Edit here
+SMARTFM_USERNAME = ''
+SMARTFM_PASSWORD = ''
+
+please_get_api_key =<<EOS
+This example needs your own smart.fm API key.
+(for only Smartfm::Item.extract example)
+
+You can get smart.fm API key at smart.fm Developers.
+smart.fm Developers (http://developer.smart.fm/)
+
+Thanks!
+EOS
+
+if Smartfm::Config.api_key == ''
+  raise ArgumentError.new(please_get_api_key)
+end
+
+
+###########################
+## WITHOUT AUTHORIZATION ##
+###########################
+
+puts "WITHOUT AUTHORIZATION"
+
+## User API
+puts "# User API Calls"
+@user = Smartfm::User.find('kirk')
+@user.items(:include_sentences => true)
+@user.lists
+@user.friends
+@user.study.results
+@user.study.total_summary
+@matched_users = Smartfm::User.matching('matake')
+
+## List API
+puts "# List API Calls"
+@recent_lists = Smartfm::List.recent
+@list = Smartfm::List.find(31509, :include_sentences => true, :include_items => true)
+@list.items
+@list.sentences
+@matched_lists = Smartfm::List.matching("イタリア語であいさつ")
+
+## Item API
+puts "# Item API Calls"
+@recent_items = Smartfm::Item.recent(:include_sentences => true)
+@item = Smartfm::Item.find(437525)
+@matched_items = Smartfm::Item.matching('record', :include_sentences => true)
+@items_hash = Smartfm::Item.extract("sometimes, often, electrical")
+@items = Smartfm::Item.extract("sometimes, often, electrical", :words_only => false)
+@items.first.sentences
+
+## Sentence API
+puts "# Sentence API Calls"
+@recent_sentences = Smartfm::Sentence.recent
+@sentence = Smartfm::Sentence.find(312271)
+@matched_sentences = Smartfm::Sentence.matching('record')
+
+
+########################
+## WITH AUTHORIZATION ##
+########################
+
+auth = case
+  when !OAUTH_ACCESS_TOKEN.empty?
+    if Smartfm::Config.oauth_consumer_key.empty? or Smartfm::Config.oauth_consumer_secret.empty?
+      raise ArgumentError.new("oauth_consumer_key and oauth_consumer_secret are required")
+    end
+    Smartfm::Auth.new(:token => OAUTH_ACCESS_TOKEN, :secret => OAUTH_ACCESS_TOKEN_SECRET)
+  when SMARTFM_USERNAME != ''
+    Smartfm::Auth.new(:username => SMARTFM_USERNAME, :password => SMARTFM_PASSWORD)
+  else
+    nil
+  end
+unless auth
+  puts "Skip calls which require authentication"
+  exit
+else
+  puts "## WITH AUTHORIZATION :: #{auth.mode}"
+end
+
+## List API
+puts "# List API"
+@list = Smartfm::List.create(auth, :title => 'smart.fm gem test', :description => 'A list for smart.fm gem test')
+@list.add_item(auth, Smartfm::Item.find(437525))
+@list.delete_item(auth, @list.items.first)
+@list.delete(auth)
+
+## Item API
+puts "# Item API"
+@item = Smartfm::Item.create(auth, :cue => {:text => 'hello world! 2', :language => 'en', :part_of_speech => 'E'}, 
+                                       :response => {:text => 'ハローワールド！', :language => 'ja'})
+@item.add_image(auth, 'http://farm4.static.flickr.com/3276/3102381796_a33c1ffdf1.jpg')
+@item.add_sound(auth, 'http://matake.jp/download/hello_world.mp3')
+@item.add_tags(auth, 'sample', 'programming')
+
+## Sentence API
+puts "# Sentence API"
+@sentence = Smartfm::Sentence.create(auth, :text => 'Hello World!', :item => Smartfm::Item.matching('hello world').first)
+@sentence.add_image(auth, 'http://farm4.static.flickr.com/3276/3102381796_a33c1ffdf1.jpg')
+@sentence.add_sound(auth, 'http://matake.jp/download/hello_world.mp3')

data/lib/ext/hash.rb

@@ -0,0 +1,52 @@
+class Hash
+
+  def to_http_str
+    result = ''
+    return result if self.empty?
+    self.each do |key, val|
+      result << "#{key}=#{URI.encode(val.to_s)}&"
+    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
+
+  def stringfy_keys!
+    self.each do |key, value|
+      unless self.delete(key.to_sym).nil?
+        if value.is_a?(Hash)
+          value.stringfy_keys!
+        elsif value.is_a?(Array)
+          value.map!{ |v| v.stringfy_keys! if v.is_a?(Hash) }
+        end
+        self[key.to_s] = value
+      end
+    end  
+    self  
+  end
+
+  def stringfy_values!
+    self.each do |key, value|
+      if value.is_a?(Hash)
+        value.stringfy_values!
+      elsif value.is_a?(Array)
+        value.map!{ |v| v.stringfy_values! if v.is_a?(Hash) }
+      end
+      self[key] = value.to_s
+    end  
+    self
+  end
+
+end

data/lib/smartfm/core/auth.rb

@@ -0,0 +1,39 @@
+require 'oauth/consumer'
+
+class Smartfm::Auth
+  attr_accessor :mode, :auth_token
+
+  class Basic
+    attr_reader :username, :password
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+    end
+  end
+
+  def initialize(options = {})
+    if options[:username] && options[:password]
+      @mode = :basic_auth
+      @auth_token = Basic.new(options[:username], options[:password])
+    elsif options[:token] && options[:secret]
+      @mode = :oauth
+      @auth_token = OAuth::AccessToken.new(Smartfm::Auth.consumer, options[:token], options[:secret])
+    else
+      raise ArgumentError.new('{:auth => "oauth_access_token", :secret => "oauth_access_token_secret"} or {:username "smartfm_username", :password => "smartfm_password"} is needed')
+    end
+  end
+
+  def self.consumer
+    @@consumer ||= OAuth::Consumer.new(
+      Smartfm::Config.oauth_consumer_key,
+      Smartfm::Config.oauth_consumer_secret,
+      :http_method   => Smartfm::Config.oauth_http_method,
+      :scheme        => Smartfm::Config.oauth_scheme,
+      :site          => Smartfm::Config.api_base_url,
+      :authorize_url => "#{Smartfm::Config.base_url}/oauth/authorize"
+    )
+  end
+
+  alias_method :account, :auth_token
+end

data/lib/smartfm/core/config.rb

@@ -0,0 +1,51 @@
+require 'singleton'
+
+class Smartfm::Config
+  include Singleton
+  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 = Smartfm::Config.instance
+    { :protocol              => 'http',
+      :host                  => 'smart.fm',
+      :port                  => 80,
+      :api_protocol          => 'http',
+      :api_host              => 'api.smart.fm',
+      :api_port              => 80,
+      :api_key               => '',
+      :timeout               => 30,
+      :oauth_consumer_key    => '',
+      :oauth_consumer_secret => '',
+      :oauth_http_method     => :post,
+      :oauth_scheme          => :header,
+      :user_agent            => 'default',
+      :application_name      => 'smart.fm gem',
+      :application_version   => Smartfm::Version.to_version,
+      :application_url       => 'http://github.com/nov/smartfm'
+    }.each do |key, value| conf.send("#{key}=", value) end
+    yield conf if block_given?
+    conf
+  end
+
+  def base_url
+    port = self.port==80 ? nil : ":#{self.port}"
+    "#{self.protocol}://#{self.host}#{port}"
+  end
+
+  def api_base_url
+    port = self.api_port==80 ? nil : ":#{self.api_port}"
+    "#{self.api_protocol}://#{self.api_host}#{port}"
+  end
+
+  # hack: Object.timeout is already defined..
+  def self.timeout
+    instance.timeout
+  end
+
+  def self.method_missing(method, *args)
+    Smartfm::Config.instance.send(method, *args)
+  end
+end

data/lib/smartfm/core/version.rb

@@ -0,0 +1,14 @@
+module Smartfm::Version
+  MAJOR = 0
+  MINOR = 4
+  REVISION = 0
+  class << self
+    def to_version
+      "#{MAJOR}.#{MINOR}.#{REVISION}"
+    end
+    
+    def to_name
+      "#{MAJOR}_#{MINOR}_#{REVISION}"
+    end
+  end
+end

data/lib/smartfm/core.rb

@@ -0,0 +1,3 @@
+require 'smartfm/core/version'
+require 'smartfm/core/config'
+require 'smartfm/core/auth'

data/lib/smartfm/model/base.rb

@@ -0,0 +1,26 @@
+class Smartfm::Base
+
+  def self.attributes; self::ATTRIBUTES end
+
+  def attributes; self.class.attributes  end
+
+  def self.deserialize(hash, params = {})
+    return nil if hash.nil?
+
+    klass = params[:as] ? params[:as] : self
+    if hash.is_a?(Array)
+      hash.inject([]) { |results, hash|
+        hash.symbolize_keys!
+        results << klass.new(hash)
+      }
+    else
+      hash.symbolize_keys!
+      klass.new(hash)
+    end
+  end
+
+  def deserialize(hash, params = {})
+    self.class.deserialize(hash, params)
+  end
+
+end