me2day-ruby 0.1.1 → 0.2.0

data/README.markdown

@@ -1,22 +1,47 @@
-An API client for me2day(http://me2day.net), a Twitter-like Korean popular social networking service.
+An API client for me2day(http://me2day.net), a twitter-like popular Korean social networking service.
 
-Install
+설치(Installation)
 =====
 
 $ (sudo) gem install me2day-ruby
 
-
-me2day "Easy Authentication (Web-based)"
+기본 사용법(Basic Usage)
 =====
 
+우선 클라이언트를 생성합니다. 이 때 app_key, user_id, user_key가 필요합니다.
+app_key는 미투데이로부터 부여받은 APPLICATION_KEY이며, user_id와 user_key는 인증을 통해 획득할 수 있습니다.
+
 	require 'me2day'
-	
-	@auth_url = Me2day::Client.get_auth_url(:app_key => "YOUR_ME2DAY_APPLICATION_KEY")
+
+	@client = Me2day::Client.new(
+		:user_id => user_id,
+		:user_key => user_key,
+		:app_key => "YOUR_ME2DAY_APPLICATION_KEY"
+	)
+
+생성된 클라이언트에 대해 메서드를 호출합니다.
+미투데이 사용설명서에 있는 모든 메서드를 호출할 수 있으며, 모든 파라미터를 이름 그래도 사용하면 됩니다. 
+자세한 사용법은 미투데이 사용설명서를 참고하시면 됩니다.
+
+	@client.noop
+	@client.create_post "me2_id", 'post[body]' => "안녕하세요, 미투데이!"
+	@client.get_comments :post_id => '123456'
+	@client.get_person "me2_id"
+	@client.get_friends "me2_id"
+
+웹 기반 쉬운 인증
+=====
+
+미투데이는 웹 기반 쉬운 인증이라는 자체 인증방식을 제공하며, 이 방법을 사용하면 사용자의 user_id와 user_key를 쉽게 얻을 수 있습니다.
+
+1. 인증 URL을 얻습니다.
+
+	auth_url = Me2day::Client.get_auth_url(:app_key => "YOUR_ME2DAY_APPLICATION_KEY")
 	=> "http://me2day.net/api/start_auth?token=XXXXXXXXXXXXXX"
 
-.. then redirection to the auth_url
-.. and then user accept the auth
-.. and then in callback
+2. 위 auth_url로 리다이렉션(redirect) 합니다.	
+
+3. 설정한 콜백(callback)에서 다음과 같이 처리 합니다.
 
 	token, user_id, user_key, result = request.params["token"], request.params["user_id"], request.params["user_key"], request.params["result"]
 
@@ -28,23 +53,9 @@ me2day "Easy Authentication (Web-based)"
 			:app_key => "YOUR_ME2DAY_APPLICATION_KEY"
 		)
 
-		@client.get("/noop")
-		=> {"error"=>{"code"=>"0", "description"=>nil, "message"=>"\354\204\261\352\263\265\355\226\210\354\212\265\353\213\210\353\213\244."}}
-
-		OR 
-		
 		@client.noop
 		=> {"error"=>{"code"=>"0", "description"=>nil, "message"=>"\354\204\261\352\263\265\355\226\210\354\212\265\353\213\210\353\213\244."}}
 
-		OR
-
-		client.noop(:format => 'json')
-		=> {"code"=>1007, "description"=>"\354\225\224\355\230\270\352\260\200 \354\235\274\354\271\230\355\225\230\354\247\200 \354\225\212\354\212\265\353\213\210\353\213\244.", "message"=>"\354\235\270\354\246\235 \354\213\244\355\214\250"}
-
-		@client.post("/create_post/[me2_user_id]", :query => { 'post[body]' => "Hello! me2!!" })
-
-		OR
-	
 		@client.create_post('me2_user_id', "Hi!, How are you!!")
 
 	end
@@ -53,8 +64,7 @@ me2day "Easy Authentication (Web-based)"
 Todos
 =====
 
-	* Add more methods
-	* Error Handling
+	* Enhancing error handling
 	* DRY cleaning!
 
 

data/Rakefile

@@ -12,7 +12,7 @@ Rake::TestTask.new("test:units") { |t|
   t.warning = true
 }
 
-Echoe.new('me2day-ruby', '0.1.1') do |p|
+Echoe.new('me2day-ruby', '0.2.0') do |p|
   p.description    = "a me2day API client"
   p.url            = "https://github.com/sjoonk/me2day-ruby"
   p.author         = "Sukjoon Kim"

data/lib/me2day/client.rb

@@ -2,78 +2,76 @@ module Me2day
   class Client
     include HTTParty
     base_uri "http://me2day.net/api"
-    DEFAULT_FORMAT = 'xml'
+    DEFAULT_FORMAT = 'json'
+    @@apis = %w(
+      accept_friendship_request
+      create_comment
+      create_post
+      delete_comment
+      delete_post
+      friendship
+      get_bands
+      get_comments
+      get_friends
+      get_friendship_requests
+      get_latests 
+      get_metoos
+      get_person
+      get_posts
+      get_settings
+      metoo
+      noop
+      track_comments
+    )
+
+    class UnauthenticatedError < RuntimeError; end
+    class InternalServerError < RuntimeError; end
+
+    class << self
+      # attr_accessor :app_key
+
+      def get_auth_url(options={})
+        raise "app_key is required" unless options[:app_key]
+        self.headers 'me2_application_key' => options[:app_key]
+        @auth_url ||= get("/get_auth_url.json")["url"]
+      end
+    end
 
     def initialize(options={})
       @app_key = options[:app_key]
       @user_id = options[:user_id]
       @user_key = options[:user_key]
+      @auth = { :uid => @user_id, :ukey => u_key(@user_key) }
       self.class.headers 'me2_application_key' => @app_key
-      self.class.default_params.merge!(:uid => @user_id, :ukey => u_key(@user_key))
     end
     
-    def self.get_auth_url(options={})
-      raise "app_key is required" unless options[:app_key]
-      self.headers 'me2_application_key' => options[:app_key]
-      get("/get_auth_url.json")["url"]
+    def method_missing(method_sym, *args, &block)
+      if @@apis.include?(method_sym.to_s)
+        id_part = args.first.is_a?(String) ? "/#{args.first}" : ''
+        options = args.last.is_a?(Hash) ? args.last : {}
+        format = options ? (options.delete(:format) || DEFAULT_FORMAT) : DEFAULT_FORMAT
+        options.merge!(@auth)
+        resp = self.class.get("/#{method_sym}#{id_part}.#{format}", :query => options)
+        case resp.response.code.to_s
+          when "200"
+            resp
+          when "401"
+            raise UnauthenticatedError, resp.parsed_response.to_s  
+          when "500"
+            raise InternalServerError, resp.parsed_response.to_s
+          else
+            raise "Unknown Error", resp.inspect
+          end       
+      else    
+        super
+      end
     end
-    
-    # General helper methods
+
+    # General helper methods (deprecated)
 
     def get(path, options={}); self.class.get(path, options).parsed_response end
     def post(path, options={}); self.class.post(path, options).parsed_response end
 
-    # API wrappers
-
-    def accept_friendship_request(friendship_request_id, message)
-      format = options.delete(:format) || DEFAULT_FORMAT
-      post("/accept_friendship_request.#{format}", 
-            :query => {:friendship_request_id => friendship_request_id, :message => message})
-    end
-
-    def create_comment(post_id, body)
-      format = options.delete(:format) || DEFAULT_FORMAT
-      post("/create_comment.#{format}", :query => {:post_id => post_id, :body => body})
-    end
-
-    def create_post(user_id, post_body, options={})
-      format = options.delete(:format) || DEFAULT_FORMAT
-      post("/create_post/#{user_id}.#{format}", :query => options.merge('post[body]' => post_body))
-    end
-    
-    def delete_comment(comment_id)
-      format = options.delete(:format) || DEFAULT_FORMAT
-      post("/delete_comment.#{format}", :query => {:comment_id => comment_id})
-    end
-
-    def delete_post(post_id)
-      format = options.delete(:format) || DEFAULT_FORMAT
-      post("/delete_post.#{format}", :query => {:post_id => post_id})
-    end
-
-    def friendship(user_id, options={})
-      format = options.delete(:format) || DEFAULT_FORMAT
-      scope = options.delete(:scope)
-      value = options.delete(:value)
-      post("/delete_post.#{format}", :query => {:user_id => user_id, :scope => scope, :value => value})
-    end
-
-    def get_bands(band_id, include_members=false)
-      format = options.delete(:format) || DEFAULT_FORMAT
-      get("/get_bands.#{format}", :query => {:band_id => band_id, :include_members => include_members.to_s})
-    end
-    
-    def noop(options={})
-      format = options.delete(:format) || DEFAULT_FORMAT
-      get("/noop.#{format}")
-    end
-
-    def get_person(user_id)
-      format = options.delete(:format) || DEFAULT_FORMAT
-      get("/get_person/#{user_id}.#{format}")
-    end
-
-    
     private
 
     def u_key(user_key)

data/lib/me2day.rb

@@ -1,8 +1,8 @@
-require 'digest/md5'
 require 'httparty'
+require 'digest/md5'
 require 'me2day/client'
 
 module Me2day
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end
 

data/me2day-ruby.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{me2day-ruby}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sukjoon Kim"]
-  s.date = %q{2011-01-12}
+  s.date = %q{2011-01-22}
   s.description = %q{a me2day API client}
   s.email = %q{sjoonk@gmail.com}
   s.extra_rdoc_files = ["LICENSE", "README.markdown", "lib/me2day.rb", "lib/me2day/client.rb"]
@@ -15,11 +15,12 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Me2day-ruby", "--main", "README.markdown"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{me2day-ruby}
-  s.rubygems_version = %q{1.4.2}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{a me2day API client}
   s.test_files = ["test/client_test.rb", "test/test_helper.rb"]
 
   if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/test/client_test.rb

@@ -2,17 +2,54 @@ require File.join(File.dirname(__FILE__), "/test_helper")
 
 class ClientTest < Test::Unit::TestCase
   include Me2day
+  
+  context "get_auth_url" do
+    setup do
+      FakeWeb.register_uri(:get, 
+        'http://me2day.net/api/get_auth_url.json', 
+        :body => "#{FIXTURES_DIR}/get_auth_url.json", 
+        :content_type => "text/json")
+    end
+  
+    should "require a app_key" do
+      lambda { Client.get_auth_url }.should raise_error
+      Client.get_auth_url(:app_key => 'YOUR_ME2DAY_APPLICATION_KEY').should == "http://me2day.net/api/start_auth?token=2d76abbbca0db990d17fd5e84227041e"
+    end
+  end
 
-  context "A client instance" do
+  context "Calling api" do
+    setup do 
+      @client = Client.new(
+        :user_id => "tester",
+        :user_key => "nonce_plus_md5_hash",
+        :app_key => "YOUR_ME2DAY_APPLICATION_KEY"
+      )
+    end
 
-    setup do
-      @client = Client.new
+    context "noop" do
+      setup do
+        FakeWeb.register_uri(:get, %r|http://me2day\.net/api/noop.json|, 
+          :body => "#{FIXTURES_DIR}/noop.json", :content_type => "text/json")
+      end
+
+      should "return valid response code" do
+        @client.noop["code"].should == 0
+      end
     end
 
-    should "be kind of Me2day client" do
-      assert_kind_of Me2day::Client, @client
+    context "create_post" do
+      setup do
+        FakeWeb.register_uri(:get, %r|http://me2day\.net/api/create_post/sjoonk.json|, 
+          :body => "#{FIXTURES_DIR}/create_post.json", :content_type => "text/json")
+      end
+
+      should "return valid response" do
+        post = @client.create_post("sjoonk", :'post[body]' => 'blablabla')
+        post['body'].should == 'blablabla'
+      end
     end
-    
-  end  
+
+
+  end
   
 end

data/test/test_helper.rb

@@ -1,10 +1,17 @@
 require 'rubygems'
+require 'test/unit'
 require 'shoulda'
 require 'redgreen'
-require 'mocha'
+require 'matchy'
+require 'fakeweb'
 
-lib_files = File.join(File.dirname(__FILE__), "..", "lib")
+FakeWeb.allow_net_connect = false # blocking all real requests
 
-Dir.glob(File.join(lib_files, "**")).each do |file|
-  require file
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+FIXTURES_DIR = File.join(File.dirname(__FILE__), 'fixtures')
+
+require 'me2day'
+
+class Test::Unit::TestCase
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: me2day-ruby
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: 
+  hash: 23
+  prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Sukjoon Kim
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-12 00:00:00 +09:00
+date: 2011-01-22 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: me2day-ruby
-rubygems_version: 1.4.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: a me2day API client