pupil 0.1.3 → 0.1.4

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+0.1.4
+----------------
+
+* Rename Search stream method, :filter to :search
+* Search REST API are supported
+* Pupil::Stream::Shash is outdated. Instead, use Pupil::Stream::Hash
+* New class, Pupil::Stream::Array
+* Pupil#public_timeline are supported
+
 0.1.3
 ----------------
 

data/README.md

@@ -45,10 +45,10 @@ Examples
 	pupil.home_timeline :count => 50, :exclude => :replies
 	
 	# Follow User
-	pupil.follow :screen_name  => :twitterapi
+	pupil.follow :screen_name => :twitterapi
 	
 	# Update URL on profile
-	pupil.update_profile :url  => "http://oameya.com"
+	pupil.update_profile :url => "http://oameya.com"
 
 Using Streaming API
 
@@ -71,15 +71,15 @@ Using Streaming API
 	
 	# Userstream
 	stream.start :userstream do |status|
-		puts status.event #=> Show type of status
+		puts status.event #=> Show type of event
 		if status.event == :retweeted
-			puts "#{status.user.screen_name} : #{status.text}"
+			puts "#{status.user.screen_name}: #{status.text}"
 		end
 	end
 	
 	# Search stream
-	stream.start :filter, :track => "#MerryChristmas" do |status|
-		puts "#{status['user']['screen_name']: #{status['text']}"
+	stream.start :search, :track => "#MerryChristmas" do |status|
+		puts "#{status.user.screen_name}: #{status.text}"
 	end
 
 Making `pupil_key`

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/lib/pupil.rb

@@ -9,4 +9,5 @@ require "pupil/users"
 require "pupil/direct_messages"
 require "pupil/lists"
 require "pupil/friendships"
-require "pupil/blocks"
+require "pupil/blocks"
+require "pupil/search"

data/lib/pupil/search.rb

@@ -0,0 +1,14 @@
+class Pupil
+  # @param [String] keyword Search word
+  # @param [Hash]  option
+  # @return [Array] Tweets
+  def search(keyword, option={})
+    response = self.get("http://search.twitter.com/search.json", {:q => keyword}.update(option))
+    statuses = Array.new
+    response["results"].each do |element|
+      status = Status.new element
+      statuses << status
+    end
+    return statuses
+  end
+end

data/lib/pupil/statuses.rb

@@ -9,7 +9,7 @@ class Pupil
   # @option param [Symbol] :include #=> [:rts]
   # @option param [Symbol] :exclude #=> [:replies]
   # @option param [Symbol] :contributor_details
-  def home_timeline param={}
+  def home_timeline(param={})
     response = self.get("/statuses/home_timeline.json", param)
     statuses = Array.new
     response.each do |element|
@@ -19,9 +19,9 @@ class Pupil
     return statuses
   end
   
-  # @return [Hash] mention
+  # @return [Array] Mention
   # @param [Hash] param
-  def mentions param={}
+  def mentions(param={})
     response = self.get("/statuses/mentions.json", param)
     statuses = Array.new
     response.each do |element|
@@ -32,7 +32,7 @@ class Pupil
   end
   
   # Returning user timeline
-  # @return [Hash] timeline
+  # @return [Array] timeline
   # @param [Hash] param
   # @option param [Fixnum] :user_id The ID of user
   # @option param [String] :screen_name The Screen name of user
@@ -49,7 +49,7 @@ class Pupil
   #   twitter.user_timeline(:screen_name => 'o_ame', :exclude => :replies).each do |status|
   #     puts "#{status.user.screen_name}: #{status.text}"
   #   end
-  def user_timeline param={}
+  def user_timeline(param={})
     response = self.get("/statuses/user_timeline.json", param)
     statuses = Array.new
     response.each do |element|
@@ -58,8 +58,20 @@ class Pupil
     end
     return statuses
   end
+  # Returning public timeline
+  # @return [Array] Timeline
+  # @param [Hash] param
+  def public_timeline(param={})
+    response = self.get("/statuses/public_timeline.json", param)
+    statuses = Array.new
+    response.each do |element|
+      status = Status.new element
+      statuses << status
+    end
+    return statuses
+  end
   
-  def show_status status_id
+  def show_status(status_id)
     response = @access_token.get("/statuses/show/#{status_id}.json").body
     return response
     status = Status.new response

data/lib/pupil/stream/base.rb

@@ -4,7 +4,7 @@ class Pupil
     class StreamError < StandardError ; end
     STREAM_APIS = {
       :userstream => "https://userstream.twitter.com/2/user.json",
-      :filter => "https://stream.twitter.com/1/statuses/filter.json%s"
+      :search => "https://stream.twitter.com/1/statuses/filter.json%s"
     }
 
     def initialize key
@@ -21,14 +21,14 @@ class Pupil
       key[:access_token_secret]
       )
     end
-    
+
     # @return [Pupil::Stream::Shash, Pupil::Stream::Status] event variable supported :status, :retweeted, :favorite, :friends and :delete
     def start(type, param=nil, &block)
       raise ArgumentError unless block_given?
-      
+
       run_get_stream type, param, &block
     end
-    
+
     def run_get_stream(type, param=nil, &block)
       uri = URI.parse(STREAM_APIS[type] % Pupil.param_serializer(param))
       https = Net::HTTP.new(uri.host, uri.port)
@@ -54,7 +54,7 @@ class Pupil
                   rescue
                     break
                   end
-                  
+
                   event = self.guess_event status
                   block.call event
                 end
@@ -66,53 +66,55 @@ class Pupil
         end
       end
     end
-    
+
     def guess_event status
       if status["delete"]
-        return Shash.new(:delete, status["delete"]["status"])
+        return Pupil::Stream::Hash.new(status["delete"]["status"], :delete)
       elsif status["friends"]
-        return Shash.new(:friends, status["friends"])
+        return Pupil::Stream::Array.new(status["friends"], :friends)
       elsif status["event"] == "favorite"
-        return Shash.new(:favorite, status)
+        return Pupil::Stream::Hash.new(status, :favorite)
       elsif status["retweeted_status"]
-        return Status.new(status, :retweeted)
+        return Pupil::Stream::Status.new(status, :retweeted)
       elsif status["text"]
-        return Status.new(status)
+        return Pupil::Stream::Status.new(status)
       else
-        return Shash.new(:unknown, status)
+        return Pupil::Stream::Hash.new(status, :unknown)
       end
     end
-    
+
     # Stream Status
     class Status < Pupil::Status
       attr_reader :event
       attr_reader :retweeted_status
-      
-      def initialize status, event=nil
+
+      def initialize(status, event=nil)
         super(status)
         @event = (event)? event : :status
         @retweeted_status = status["retweeted_status"]
       end
     end
-    
+
     # Stream Hash
-    class Shash
+    class Hash < Hash
       attr_reader :event
-      
-      def initialize event, status
-        @hash = status
+
+      def initialize(status, event)
+        super()
+        self.update(status)
         @event = event
       end
-      
-      def [] param
-        @hash[param]
-      end
-      
-      def size
-        @hash.size
+    end
+
+    # Stream Array
+    class Array < Array
+      attr_reader :event
+
+      def initialize(status, event)
+        super(status)
+        #self.update(status)
+        @event = event
       end
-      
-      alias_method :length, :size
     end
   end
 end

data/pupil.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "pupil"
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Oame"]
-  s.date = "2011-12-17"
+  s.date = "2011-12-29"
   s.description = "The \"Lazy\" Twitter API Library for Ruby 1.9.x. Easy to use."
   s.email = "oame@oameya.com"
   s.extra_rdoc_files = [
@@ -65,6 +65,7 @@ Gem::Specification.new do |s|
     "lib/pupil/keygen/base.rb",
     "lib/pupil/lists.rb",
     "lib/pupil/schemes.rb",
+    "lib/pupil/search.rb",
     "lib/pupil/statuses.rb",
     "lib/pupil/stream.rb",
     "lib/pupil/stream/base.rb",

data/spec/pupil_spec.rb

@@ -6,6 +6,17 @@
 
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
+describe Pupil, "が #verify_credentials を呼ぶ時は" do
+  before do
+    pupil = Pupil.new PUPIL_TESTKEY
+    @vc = pupil.verify_credentials
+  end
+  
+  it "Pupil::User型を返すこと" do
+    @vc.class.should == Pupil::User
+  end
+end
+
 describe Pupil, "が #home_timeline を呼ぶ時は" do
   before do
     pupil = Pupil.new PUPIL_TESTKEY
@@ -36,17 +47,6 @@ describe Pupil, "が #mentions を呼ぶ時は" do
   end
 end
 
-describe Pupil, "が #verify_credentials を呼ぶ時は" do
-  before do
-    pupil = Pupil.new PUPIL_TESTKEY
-    @vc = pupil.verify_credentials
-  end
-  
-  it "Pupil::User型を返すこと" do
-    @vc.class.should == Pupil::User
-  end
-end
-
 describe Pupil, "が #user_timeline を呼ぶ時は" do
   before do
     pupil = Pupil.new PUPIL_TESTKEY
@@ -147,4 +147,19 @@ describe Pupil, "が #blocking を呼ぶ時は" do
   it "Array型を返すこと" do
     @blocking.class.should == Array
   end
+end
+
+describe Pupil, "が、 #search を呼ぶ時は" do
+  before do
+    pupil = Pupil.new PUPIL_TESTKEY
+    @search = pupil.search("Twitter", :rpp => 10)
+  end
+  
+  it "Array型を返すこと" do
+    @search.class.should == Array
+  end
+  
+  it "sizeが10であること" do
+    @search.size.should == 10
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pupil
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-17 00:00:00.000000000Z
+date: 2011-12-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70175508522040 !ruby/object:Gem::Requirement
+  requirement: &70151989267360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70175508522040
+  version_requirements: *70151989267360
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70175508519700 !ruby/object:Gem::Requirement
+  requirement: &70151989266380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70175508519700
+  version_requirements: *70151989266380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70175508512420 !ruby/object:Gem::Requirement
+  requirement: &70151989265220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70175508512420
+  version_requirements: *70151989265220
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70175508505560 !ruby/object:Gem::Requirement
+  requirement: &70151989263920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *70175508505560
+  version_requirements: *70151989263920
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70175508490580 !ruby/object:Gem::Requirement
+  requirement: &70151989262100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70175508490580
+  version_requirements: *70151989262100
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70175508473000 !ruby/object:Gem::Requirement
+  requirement: &70151989246200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70175508473000
+  version_requirements: *70151989246200
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70175508470300 !ruby/object:Gem::Requirement
+  requirement: &70151989243220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70175508470300
+  version_requirements: *70151989243220
 description: The "Lazy" Twitter API Library for Ruby 1.9.x. Easy to use.
 email: oame@oameya.com
 executables: []
@@ -144,6 +144,7 @@ files:
 - lib/pupil/keygen/base.rb
 - lib/pupil/lists.rb
 - lib/pupil/schemes.rb
+- lib/pupil/search.rb
 - lib/pupil/statuses.rb
 - lib/pupil/stream.rb
 - lib/pupil/stream/base.rb