youroom_api 0.0.10

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2010-02-09
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,19 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/youroom_api.rb
+lib//object_extention.rb
+lib/youroom_api/youroom.rb
+lib/youroom_api/base.rb
+lib/youroom_api/request.rb
+lib/youroom_api/room.rb
+lib/youroom_api/user.rb
+lib/youroom_api/entry.rb
+lib/youroom_api/participation.rb
+lib/youroom_api/create_participation.rb
+lib/youroom_api/destroy_participation.rb
+lib/youroom_api/youroom_oauth.rb
+
+

data/README.txt

@@ -0,0 +1,106 @@
+= youroom_api
+
+* http://github.com/pochi/youroom_api
+
+== DESCRIPTION:
+
+simple api for youroom.
+
+== FEATURES/PROBLEMS:
+
+* youroom client (list of features or problems)
+
+-----------------------------
+how to use
+-----------------------------
+
+This api follow youroom api using oauth.(api doc:http://apidoc.youroom.in/)
+Each api follow:
+  Enterprise:Group/create          ---->     create_room(billing_id, name)
+  Enterprise:Group/index           ---->     get_room_list(billing_id)
+  Enterprise:Participation/add     ---->     create_participation(billing_id, billing_group_id, email)
+  Enterprise:Participation/remove  ---->     create_participation(billing_id, billing_group_id, email)
+  Enterprise:User/create           ---->     create_user(billing_id, user_params)
+  Enterprise:User/index            ---->     get_user_list(billing_id)
+  REST:Entry/create                ---->     post_entry(room_id, content)
+  REST:Entry/destroy               ---->     destroy_entry(room_id, mutter_id)
+  REST:Entry/show                  ---->     get_entry(room_id, mutter_id)
+  REST:Group/my                    ---->     get_my_group
+  REST:Home Timeline(all)          ---->     get_all_timeline
+  REST:Home Timeline(unreads)      ---->     get_unread_timeline
+  REST:Room Timeline               ---->     get_entry(room_id)
+
+-----------------------------
+sample1: Get my timeline
+-----------------------------
+
+require 'rubygems'
+require 'youroom_api'
+
+YOUROOM_URL = "https://www.youroom.in/"
+
+consumer = OAuth::Consumer.new(consumer_key,
+                               consumer_sercret,
+                               :site => YOUROOM_URL)
+
+info = consumer.get_access_token(nil, { },
+                                 {:x_auth_mode=>"client_auth",
+                                  :x_auth_username=> "pochi.black@gmail.com",
+                                  :x_auth_password=> password})
+
+access_token = OAuth::AccessToken.new(consumer,
+                                      info.params['oauth_token'],
+                                      info.params['oauth_token_secret'])
+
+client = Youroom::Request.new(access_token)
+client.get_all_timeline.each do |topic|
+  puts topic["entry"]["content"]
+end
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* ruby 1.8.7 or later
+* rspec 1.3.0 or later
+* ww
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'youroom_api' do
+  developer('rubypochi', 'pochi.black@gmail.com')
+
+  self.rubyforge_name = 'youroom_api' # if different than 'youroom_api'
+end
+

data/lib/object_extention.rb

@@ -0,0 +1,52 @@
+class Hash
+  # TODO: Refactoring
+  def optimize
+    routes = []
+    singleton_hash = {}
+    first_keys = self.keys
+    second_keys = []
+    third_keys = []
+
+    first_keys.each do |key|
+      unless self[key].is_a?(Hash)
+        routes << [key]
+        next
+      end
+      second_keys << [key, self[key].keys]
+    end
+
+    second_keys.each do |second_key|
+      second_key.last.each do |key|
+        unless self[second_key.first][key].is_a?(Hash)
+          routes << [second_key.first, key]
+          next
+        end
+        third_keys << [second_key.first, key, self[second_key.first][key].keys]
+      end
+    end
+
+    third_keys.each do |third_key|
+      third_key.last.each do |key|
+        unless self[third_key.first][third_key[1]][key].is_a?(Hash)
+          routes << [third_key.first, third_key[1], key]
+          next
+        end
+        force_keys << [third_key.first, third_key[1], key, self[third_key.first][third_key[1]][key].keys]
+      end
+    end
+
+    routes.each do |route|
+      val = self.dup
+      route.each do |key|
+        val = val[key]
+      end
+      base = route.shift.to_s
+      key_name = route.inject(base) {|key, map| key.to_s + "[" + map.to_s + "]" }
+      singleton_hash.update({key_name=>val.to_s})
+    end
+
+    singleton_hash
+  end
+end
+
+

data/lib/youroom_api/base.rb

@@ -0,0 +1,17 @@
+module Youroom
+  class Base
+    attr_reader :url, :host, :port
+
+    private
+    def required_structure(name, *elements)
+      raise ArgumentError unless elements.include?(name.class)
+    end
+
+    def parse(url)
+      @url = url
+      uri = URI.parse(url)
+      @host, @port = uri.host, uri.port
+    end
+
+  end
+end

data/lib/youroom_api/base_url.rb

@@ -0,0 +1,6 @@
+module Youroom
+  # production url
+  # BASE_URL = 'https://home.youroom.in/'
+  # development url
+  BASE_URL = 'https://www.youroom.in/'
+end

data/lib/youroom_api/request/add_participation.rb

@@ -0,0 +1,24 @@
+module Youroom
+  class AddParticipation < Request
+    attr_reader :billing_id, :billing_group_id, :email
+
+    def initialize(access_token, billing_id, billing_group_id, email, url=BASE_URL)
+      [billing_id, billing_group_id].each {|arg| required_structure(arg, String, Symbol, Fixnum)}
+      required_structure(email, String)
+      @billing_id, @billing_group_id, @email = billing_id.to_s, billing_group_id.to_s, email
+      super(access_token, url)
+    end
+
+    def path
+      if url == BASE_URL
+        File.join(::Youroom::BASE_URL, 'billings', billing_id, 'billing_groups', billing_group_id, 'participations', 'add?format=json')
+      else
+        File.join(url, 'enterprise', 'billings', billing_id, 'billing_groups', billing_group_id, 'participations', 'add?format=json')
+      end
+    end
+
+    def params
+      { :email => email }.optimize
+    end
+  end
+end

data/lib/youroom_api/request/add_room.rb

@@ -0,0 +1,20 @@
+module Youroom
+  class AddRoom < Request
+    attr_reader :name, :billing_id
+
+    def initialize(access_token, billing_id, name, url=BASE_URL)
+      required_structure(billing_id, String, Fixnum)
+      required_structure(name, String, Symbol)
+      @billing_id, @name = billing_id.to_s, name.to_s
+      super(access_token, url)
+    end
+
+    def path
+      File.join(url, 'billings', billing_id, 'billing_groups?format=json')
+    end
+
+    def params
+      { :billing_group => { :group_attributes => { :name => name } } }.optimize
+    end
+  end
+end

data/lib/youroom_api/request/add_user.rb

@@ -0,0 +1,28 @@
+module Youroom
+  class AddUser < Request
+    attr_reader :attributes, :billing_id
+
+    def initialize(access_token, billing_id, attributes, url=BASE_URL)
+      required_structure(billing_id, String, Fixnum)
+      required_structure(attributes, Hash)
+      @billing_id, @attributes = billing_id.to_s, attributes
+      super(access_token, url)
+    end
+
+    def path
+      File.join(url, 'billings', billing_id, 'billing_users?format=json')
+    end
+
+    def params
+      { :billing_user => { :name => name,
+                           :user_attributes => { :email => email,
+                                                 :password => password,
+                                                 :password_confirmation => password_confirmation }}}.optimize
+    end
+
+    # TODO: refactoring
+    def method_missing(name, *args)
+      attributes[name.to_sym]
+    end
+  end
+end

data/lib/youroom_api/request/destroy_entry.rb

@@ -0,0 +1,16 @@
+module Youroom
+  class DestroyEntry < Entry
+    attr_reader :room_id, :mutter_id
+
+    def initialize(access_token, room_id, mutter_id, url=BASE_URL)
+      required_structure(room_id, String, Symbol, Fixnum)
+      required_structure(mutter_id, String, Fixnum)
+      @room_id, @mutter_id = room_id, mutter_id
+      super(access_token, url)
+    end
+
+    def path
+      File.join(url, 'r', room_id.to_s, 'entries', mutter_id.to_s+'?format=json')
+    end
+  end
+end

data/lib/youroom_api/request/destroy_participation.rb

@@ -0,0 +1,24 @@
+module Youroom
+  class DestroyParticipation < Request
+    attr_reader :billing_id, :billing_group_id, :email
+
+    def initialize(access_token, billing_id, billing_group_id, email, url=BASE_URL)
+      [billing_id, billing_group_id].each {|arg| required_structure(arg, String, Symbol, Fixnum)}
+      required_structure(email, String)
+      @billing_id, @billing_group_id, @email = billing_id.to_s, billing_group_id.to_s, email
+      super(access_token, url)
+    end
+
+    def path
+      if url == BASE_URL
+        File.join(::Youroom::BASE_URL, 'billings', billing_id, 'billing_groups', billing_group_id, 'participations', 'remove?format=json')
+      else
+        File.join(url, 'enterprise', 'billings', billing_id, 'billing_groups', billing_group_id, 'participations', 'remove?format=json')
+      end
+    end
+
+    def params
+      { :email => email }.optimize
+    end
+  end
+end

data/lib/youroom_api/request/entry.rb

@@ -0,0 +1,4 @@
+module Youroom
+  class Entry < Request
+  end
+end

data/lib/youroom_api/request/get_entry.rb

@@ -0,0 +1,21 @@
+module Youroom
+  class GetEntry < Entry
+    attr_reader :room_id, :mutter_id
+
+    def initialize(access_token, room_id, mutter_id=nil, url=BASE_URL)
+      required_structure(room_id, String, Symbol, Fixnum)
+      required_structure(mutter_id, String, Symbol, Fixnum, NilClass)
+      @room_id, @mutter_id = room_id, mutter_id
+      super(access_token, url)
+    end
+
+    # Refactoring required
+    def path
+      if !mutter_id.nil?
+        File.join(url, 'r', room_id.to_s, 'entries', mutter_id.to_s+'.json')
+      else
+        File.join(url, 'r', room_id.to_s, 'all?format=json')
+      end
+    end
+  end
+end

data/lib/youroom_api/request/get_room_list.rb

@@ -0,0 +1,15 @@
+module Youroom
+  class GetRoomList < Request
+    attr_reader :billing_id
+
+    def initialize(access_token, billing_id, url=BASE_URL)
+      required_structure(billing_id, String, Fixnum)
+      @billing_id = billing_id.to_s
+      super(access_token, url)
+    end
+
+    def path
+      File.join(url, 'billings', billing_id, 'billing_groups?format=json')
+    end
+  end
+end

data/lib/youroom_api/request/get_user_list.rb

@@ -0,0 +1,15 @@
+module Youroom
+  class GetUserList < Request
+    attr_reader :billing_id
+
+    def initialize(access_token, billing_id, url=BASE_URL)
+      required_structure(billing_id, String, Fixnum)
+      @billing_id = billing_id.to_s
+      super(access_token, url)
+    end
+
+    def path
+      File.join(url, 'billings', billing_id, 'billing_users?format=json')
+    end
+  end
+end

data/lib/youroom_api/request/my_group.rb

@@ -0,0 +1,7 @@
+module Youroom
+  class MyGroup < Request
+    def path
+      File.join(url, 'groups', 'my?format=json')
+    end
+  end
+end

data/lib/youroom_api/request/participation.rb

@@ -0,0 +1,15 @@
+module Youroom
+  class Participation < Request
+    attr_reader :room_id, :participation_id
+
+    def initialize(access_token, room_id, participation_id,  url=BASE_URL)
+      [room_id, participation_id].each {|arg| required_structure(arg, String, Fixnum) }
+      @room_id, @participation_id = room_id, participation_id
+      super(access_token, url)
+    end
+
+    def path
+      File.join(url, "group", room_id.to_s, "participations", participation_id.to_s+".json")
+    end
+  end
+end

data/lib/youroom_api/request/post_entry.rb

@@ -0,0 +1,23 @@
+module Youroom
+  class PostEntry < Entry
+    attr_reader :room_id, :content, :parent_id
+
+    def initialize(access_token, room_id, content, parent_id=nil, url=BASE_URL)
+      [room_id, content].each { |arg| required_structure(arg, String, Symbol, Fixnum) }
+      @room_id, @content, @parent_id = room_id, content, parent_id
+      super(access_token, url)
+    end
+
+    def path
+      File.join(url, 'r', room_id.to_s, 'entries?format=json')
+    end
+
+    def params
+      if parent_id
+        { :entry => { :content => content.to_s, :parent_id => parent_id }, :insert_mention => "" }
+      else
+        { :entry => { :content => content.to_s }, :insert_mention => "" }
+      end.optimize
+    end
+  end
+end

data/lib/youroom_api/request/room_timeline.rb

@@ -0,0 +1,23 @@
+module Youroom
+  class RoomTimeline < Request
+    attr_reader :room_id, :since, :page, :flat, :search_query, :read_state
+    QUERY_KEYS = %w[since page flat search_query read_state]
+
+    def initialize(access_token, room_id, params={}, url=BASE_URL)
+      required_structure(room_id, String, Symbol, Fixnum)
+      required_structure(params, Hash)
+      @room_id = room_id
+      params.each { |k,v| self.instance_variable_set("@#{k}", v)}
+      super(access_token, url)
+    end
+
+    def path
+      query_str = "&"
+      QUERY_KEYS.each do |query_key|
+        val = self.instance_variable_get("@#{query_key}")
+        query_str += "#{query_key}=#{val}&" if !val.nil?
+      end
+      File.join(url, 'r', room_id.to_s, '?format=json'+"#{query_str.chop}")
+    end
+  end
+end

data/lib/youroom_api/request/show_attachment.rb

@@ -0,0 +1,15 @@
+module Youroom
+  class ShowAttachment < Request
+    attr_reader :room_id, :entry_id
+    def initialize(access_token, room_id, entry_id, url=BASE_URL)
+      [room_id, entry_id].each { |e| required_structure(e, String, Symbol, Fixnum) }
+      @room_id = room_id
+      @entry_id = entry_id
+      super(access_token, url)
+    end
+
+    def path
+      File.join(url, 'r', room_id.to_s, 'entries', entry_id.to_s, 'attachment', '?format=json')
+    end
+  end
+end

data/lib/youroom_api/request/timeline.rb

@@ -0,0 +1,8 @@
+module Youroom
+  class HomeTimeline < Request
+    # TODO: Request parameter feel bad
+    def path
+      File.join(url, '?format=json')
+    end
+  end
+end

data/lib/youroom_api/request/unread_timeline.rb

@@ -0,0 +1,12 @@
+module Youroom
+  class UnreadTimeline < Request
+    # TODO: Request parameter feel bad
+    def path
+      if url == BASE_URL
+        File.join(url, '?format=json&read_state=unread')
+      else
+        File.join(url, 'home', '?format=json&read_state=unread')
+      end
+    end
+  end
+end

data/lib/youroom_api/request/verify_credentials.rb

@@ -0,0 +1,7 @@
+module Youroom
+  class VerifyCredentials < Request
+    def path
+      File.join(url, 'verify_credentials', '?format=json')
+    end
+  end
+end

data/lib/youroom_api/request.rb

@@ -0,0 +1,85 @@
+module Youroom
+  class Request < Base
+    attr_reader :access_token
+
+    def initialize(access_token, url=BASE_URL)
+      required_structure(access_token, ::OAuth::AccessToken)
+      @access_token = access_token
+      parse(url)
+    end
+
+    def get_entry(room_id, mutter_id=nil)
+      GetEntry.new(access_token, room_id, mutter_id, url).get
+    end
+
+    def get_verify_credentials
+      VerifyCredentials.new(access_token, url).get
+    end
+
+    def get_attachment(room_id, mutter_id)
+      ShowAttachment.new(access_token, room_id, mutter_id, url).get
+    end
+
+    def get_all_timeline
+      HomeTimeline.new(access_token, url).get
+    end
+
+    def get_unread_timeline
+      UnreadTimeline.new(access_token, url).get
+    end
+
+    def get_room_timeline(room_id, params={ })
+      RoomTimeline.new(access_token, room_id, params, url).get
+    end
+
+    def create_entry(room_id, content, parent_id=nil)
+      PostEntry.new(access_token, room_id, content, parent_id, url).post
+    end
+
+    def destroy_entry(room_id, mutter_id)
+      DestroyEntry.new(access_token, room_id, mutter_id, url).delete
+    end
+
+    def get_my_group
+      MyGroup.new(access_token, url).get
+    end
+
+    def get
+      JSON.parse(access_token.get(path).body)
+    end
+
+    def post
+      JSON.parse(access_token.post(path, params).body)
+    end
+
+    def delete
+      JSON.parse(access_token.delete(path).body)
+    end
+
+    # enterprise api
+    def create_room(billing_id, name)
+      AddRoom.new(access_token, billing_id, name, url).post
+    end
+
+    def create_participation(billing_id, billin_group_id, email)
+      AddParticipation.new(access_token, billing_id, billin_group_id, email, url).post
+    end
+
+    def destroy_participation(billing_id, billing_group_id, email)
+      DestroyParticipation.new(access_token, billing_id, billing_group_id, email, url).delete
+    end
+
+    def get_room_list(billing_id)
+      GetRoomList.new(access_token, billing_id, url).get
+    end
+
+    def create_user(billing_id, user)
+      AddUser.new(access_token, billing_id, user, url).post
+    end
+
+    def get_user_list(billing_id)
+      GetUserList.new(access_token, billing_id, url).get
+    end
+
+  end
+end

data/lib/youroom_api/version.rb

@@ -0,0 +1,3 @@
+module Youroom
+  VERSION = "0.0.3"
+end

data/lib/youroom_api/youroom.rb

@@ -0,0 +1,32 @@
+module Youroom
+
+  class OAuth < Base
+    attr_accessor :request
+
+    def initialize(access_token, url=BASE_URL)
+      @request = Request.new(access_token, url)
+    end
+
+    def entry(room_id, mutter_id=nil)
+      request.get_entry(room_id, mutter_id)
+    end
+
+    def participation(room_id, participation_id)
+      request.get_participation(room_id, participation_id)
+    end
+
+    def all_timeline
+      request.get_all_timeline
+    end
+
+    def unread_timeline
+      request.get_unread_timeline
+    end
+
+    def update(room_id, content)
+      request.post_entry(room_id, content)
+    end
+  end
+end
+
+