rubytter 0.3.3

data/README.rdoc

@@ -0,0 +1,97 @@
+= rubytter
+
+http://github.com/jugyo/rubytter
+
+== DESCRIPTION:
+
+Rubytter is simple twitter library.
+
+== FEATURES/PROBLEMS:
+
+implemented methods:
+
+- /statuses/update
+- /statuses/destroy/id
+- /statuses/public_timeline
+- /statuses/friends_timeline
+- /statuses/replies
+- /statuses/user_timeline/id
+- /statuses/show/id
+- /statuses/friends/id
+- /statuses/followers/id
+- /users/show/id
+- /direct_messages
+- /direct_messages/sent
+- /direct_messages/new
+- /direct_messages/destroy/id
+- /friendships/create/id
+- /friendships/destroy/id
+- /friendships/exists
+- /followers/ids/id
+- /friends/ids/id
+- /favorites
+- /favorites/create/id
+- /favorites/destroy/id
+- /account/verify_credentials
+- /account/end_session
+- /account/update_delivery_device
+- /account/update_profile_colors
+- /account/rate_limit_status
+- /account/update_profile
+- /notifications/follow/id
+- /notifications/leave/id
+- /blocks/create/id
+- /blocks/destroy/id
+
+== SYNOPSIS:
+
+update status
+
+ client = Rubytter.new(user_id, password)
+ client.update('hello twitter!!')
+
+get friends timeline
+
+ client = Rubytter.new(user_id, password)
+ client.friends_timeline.each do |status|
+   puts "#{status.user.screen_name}: #{status.text}"
+ end
+
+== REQUIREMENTS:
+
+* json
+
+== INSTALL:
+
+ gem source -a http://gems.github.com
+ sudo gem install jugyo-rubytter
+
+== TODO:
+
+- search
+- favorite
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008-2009 jugyo
+
+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/examples/friends_timeline.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rubytter'
+
+if ARGV.size < 2
+  puts "Usage: ruby #{File.basename(__FILE__)} user_id password"
+  exit
+end
+
+client = Rubytter.new(ARGV[0], ARGV[1])
+client.friends_timeline.each do |status|
+  puts "#{status.user.screen_name}: #{status.text}"
+end

data/examples/update_status.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rubytter'
+
+if ARGV.size < 3
+  puts "Usage: ruby #{File.basename(__FILE__)} user_id password text"
+  exit
+end
+
+client = Rubytter.new(ARGV[0], ARGV[1])
+client.update(ARGV[2])

data/lib/rubytter/connection.rb

@@ -0,0 +1,37 @@
+class Rubytter
+  class Connection
+    attr_reader :protocol, :port, :proxy_uri
+
+    def initialize(options = {})
+      @proxy_host = options[:proxy_host]
+      @proxy_port = options[:proxy_port]
+      @proxy_user = options[:proxy_user_name]
+      @proxy_password = options[:proxy_password]
+      @proxy_uri = nil
+      @enable_ssl = options[:enable_ssl]
+
+      if @proxy_host
+        @http_class = Net::HTTP::Proxy(@proxy_host, @proxy_port,
+                                       @proxy_user, @proxy_password)
+        @proxy_uri =  "http://" + @proxy_host + ":" + @proxy_port.to_s + "/"
+      else
+        @http_class = Net::HTTP
+      end
+
+      if @enable_ssl
+        @protocol = "https"
+        @port = 443
+      else
+        @protocol = "http"
+        @port = 80
+      end
+    end
+
+    def start(host, port = nil, &block)
+      http = @http_class.new(host, port || @port)
+      http.use_ssl = @enable_ssl
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE if http.use_ssl?
+      http.start(&block)
+    end
+  end
+end

data/lib/rubytter.rb

@@ -0,0 +1,133 @@
+require 'rubygems'
+require 'json'
+require 'net/https'
+require 'cgi'
+
+require 'rubytter/connection'
+
+class Rubytter
+  APP_NAME = 'Rubytter'
+  HOMEPAGE = 'http://github.com/jugyo/rubytter'
+
+  def initialize(login, password, options = {})
+    @login = login
+    @password = password
+    @host = options[:host] || 'twitter.com'
+    @connection = Connection.new(options)
+  end
+
+  def self.api_settings
+    # method name             path for API                    http method
+    "
+      status_update           /statuses/update                post
+      destroy                 /statuses/destroy/%s            delete
+      public_timeline         /statuses/public_timeline
+      friends_timeline        /statuses/friends_timeline
+      replies                 /statuses/replies
+      user_timeline           /statuses/user_timeline/%s
+      show                    /statuses/show/%s
+      friends                 /statuses/friends/%s
+      followers               /statuses/followers/%s
+      user                    /users/show/%s
+      direct_messages         /direct_messages
+      sent_direct_messages    /direct_messages/sent
+      send_direct_message     /direct_messages/new            post
+      destroy_direct_message  /direct_messages/destroy/%s     delete
+      create_friendship       /friendships/create/%s          post
+      destroy_friendship      /friendships/destroy/%s         delete
+      friendship_exists       /friendships/exists
+      followers_ids           /followers/ids/%s
+      friends_ids             /friends/ids/%s
+      favorites               /favorites
+      favorite                /favorites/create/%s            post
+      unfavorite              /favorites/destroy/%s           delete
+      verify_credentials      /account/verify_credentials     get
+      end_session             /account/end_session            post
+      update_delivery_device  /account/update_delivery_device post
+      update_profile_colors   /account/update_profile_colors  post
+      rate_limit_status       /account/rate_limit_status
+      update_profile          /account/update_profile         post
+      enable_notification     /notifications/follow/%s        post
+      disable_notification    /notifications/leave/%s         post
+      block                   /blocks/create/%s               post
+      unblock                 /blocks/destroy/%s              delete
+    ".strip.split("\n").map{|line| line.strip.split(/\s+/)}
+  end
+
+  api_settings.each do |array|
+    method, path, http_method = *array
+    http_method ||= 'get'
+    if /%s$/ =~ path
+      eval <<-EOS
+        def #{method}(id, params = {})
+          #{http_method}('#{path}' % id, params)
+        end
+      EOS
+    else
+      eval <<-EOS
+        def #{method}(params = {})
+          #{http_method}('#{path}', params)
+        end
+      EOS
+    end
+  end
+
+  def update(status, params = {})
+    status_update(params.merge({:status => status}))
+  end
+
+  def direct_message(user, text, params = {})
+    send_direct_message(params.merge({:user => user, :text => text}))
+  end
+
+  def get(path, params = {})
+    path += '.json'
+    param_str = '?' + params.to_a.map{|i| i[0].to_s + '=' + CGI.escape(i[1]) }.join('&')
+    path = path + param_str unless param_str.empty?
+    req = prepare_request(Net::HTTP::Get.new(path))
+    res_body = @connection.start(@host) do |http|
+      http.request(req).body
+    end
+    json_to_struct(JSON.parse(res_body))
+  end
+
+  def post(path, params = {})
+    path += '.json'
+    param_str = params.to_a.map{|i| i[0].to_s + '=' + CGI.escape(i[1]) }.join('&')
+    req = prepare_request(Net::HTTP::Post.new(path))
+    res_body = @connection.start(@host) do |http|
+      http.request(req, param_str).body
+    end
+    json_to_struct(JSON.parse(res_body))
+  end
+
+  alias delete post
+
+  def prepare_request(req)
+    req.add_field('User-Agent', "#{APP_NAME} #{HOMEPAGE}")
+    req.basic_auth(@login, @password)
+    return req
+  end
+
+  def json_to_struct(json)
+    case json
+    when Array
+      json.map{|i| json_to_struct(i)}
+    when Hash
+      struct_values = {}
+      json.each do |k, v|
+        case k
+        when String, Symbol
+          struct_values[k.to_sym] = json_to_struct(v)
+        end
+      end
+      unless struct_values.empty?
+        Struct.new(*struct_values.keys).new(*struct_values.values)
+      else
+        nil
+      end
+    else
+      json
+    end
+  end
+end

data/spec/rubytter_spec.rb

@@ -0,0 +1,132 @@
+# -*- coding: utf-8 -*-
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+class Rubytter
+  describe Rubytter do
+    before do
+      @rubytter = Rubytter.new('test', 'test')
+    end
+
+    it 'should receive ...' do
+      @rubytter.should_receive(:user_timeline).with(1)
+      @rubytter.user_timeline(1)
+      @rubytter.should_receive(:friend_timeline)
+      @rubytter.friend_timeline
+      @rubytter.should_receive(:replies).with({:page => 2})
+      @rubytter.replies(:page => 2)
+      # more...
+    end
+
+    it 'should get or post' do
+      # TODO: split specs
+      @rubytter.should_receive(:get).with('/statuses/replies', {})
+      @rubytter.replies
+
+      @rubytter.should_receive(:get).with('/statuses/replies', {:page => 2})
+      @rubytter.replies(:page => 2)
+
+      @rubytter.should_receive(:get).with('/statuses/user_timeline/1', {})
+      @rubytter.user_timeline(1)
+
+      @rubytter.should_receive(:get).with('/users/show/1', {})
+      @rubytter.user(1)
+
+      @rubytter.should_receive(:delete).with('/statuses/destroy/1', {})
+      @rubytter.destroy(1)
+    end
+
+    # direct_messages
+
+    it 'should respond to direct_messages' do
+      @rubytter.should_receive(:get).with('/direct_messages', {})
+      @rubytter.direct_messages()
+    end
+
+    it 'should respond to sent_direct_messages' do
+      @rubytter.should_receive(:get).with('/direct_messages/sent', {})
+      @rubytter.sent_direct_messages()
+    end
+
+    it 'should respond to send_direct_message' do
+      @rubytter.should_receive(:post).with('/direct_messages/new', {})
+      @rubytter.send_direct_message()
+    end
+
+    it 'should respond to destroy_direct_message' do
+      @rubytter.should_receive(:delete).with('/direct_messages/destroy/1', {})
+      @rubytter.destroy_direct_message(1)
+    end
+
+    it 'should respond to direct_message' do
+      @rubytter.should_receive(:post).with('/direct_messages/new', {:user => 'test', :text => 'aaaaaaaaaaaaa'})
+      @rubytter.direct_message('test', 'aaaaaaaaaaaaa')
+    end
+
+    # statuses
+
+    it 'should respond to update' do
+      @rubytter.should_receive(:post).with('/statuses/update', {:status => 'test'})
+      @rubytter.update('test')
+    end
+
+    it 'should respond to status_update' do
+      @rubytter.should_receive(:post).with('/statuses/update', {:status => 'test'})
+      @rubytter.status_update(:status => 'test')
+    end
+
+    # friendship
+
+    it 'should respond to create_friendship' do
+      @rubytter.should_receive(:post).with('/friendships/create/test', {})
+      @rubytter.create_friendship('test')
+    end
+
+    it 'should respond to destroy_friendship' do
+      @rubytter.should_receive(:delete).with('/friendships/destroy/test', {})
+      @rubytter.destroy_friendship('test')
+    end
+
+    it 'should respond to friendship_exists' do
+      @rubytter.should_receive(:get).with('/friendships/exists', {:user_a => 'a', :user_b => 'b'})
+      @rubytter.friendship_exists(:user_a => 'a', :user_b => 'b')
+    end
+
+    # Social Graph Methods
+
+    it 'should respond to followers_ids' do
+      @rubytter.should_receive(:get).with('/friends/ids/test', {})
+      @rubytter.friends_ids('test')
+    end
+
+    it 'should respond to followers_ids' do
+      @rubytter.should_receive(:get).with('/followers/ids/test', {})
+      @rubytter.followers_ids('test')
+    end
+
+    it 'should create struct from json' do
+      hash = {
+        :a => 'a',
+        'b' => 1,
+        1 => 'a',
+        /regex/ => 'regex',
+        nil => nil,
+        :c => {:a => 1, :b => 2},
+        :d => {:a => {:a => 1, :b => 2}, :b => 1},
+        :e => [{:a => 1, :b => 2}, {:c => 3}]
+      }
+      struct = @rubytter.json_to_struct(hash)
+      struct.a.should == 'a'
+      struct.b.should == 1
+      struct.c.a.should == 1
+      struct.c.b.should == 2
+      struct.d.a.a.should == 1
+      struct.e[0].a.should == 1
+      struct.e[0].b.should == 2
+      struct.e[1].c.should == 3
+      lambda {struct.x}.should raise_error(NoMethodError)
+      lambda {struct.regex}.should raise_error(NoMethodError)
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'rubytter'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: rubytter
+version: !ruby/object:Gem::Version 
+  version: 0.3.3
+platform: ruby
+authors: 
+- jugyo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-14 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+description: Rubytter is a simple twitter client.
+email: jugyo.org@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- History.txt
+files: 
+- lib/rubytter.rb
+- lib/rubytter/connection.rb
+- examples/friends_timeline.rb
+- examples/update_status.rb
+- spec/rubytter_spec.rb
+- spec/spec_helper.rb
+- README.rdoc
+- History.txt
+has_rdoc: true
+homepage: http://github.com/jugyo/rubytter
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --exclude
+- spec
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rubytter
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Simple twitter client.
+test_files: []
+