pupil 0.0.4 → 0.0.5

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "pupil"
   gem.homepage = "http://github.com/oame/pupil"
   gem.license = "MIT"
-  gem.summary = %Q{The Twitter API Wrapper for Ruby}
-  gem.description = %Q{The "Lazy" Twitter API wrapper for Ruby. It was made for Kbot library.}
+  gem.summary = %Q{The "Lazy" Twitter API Wrapper for Ruby}
+  gem.description = %Q{The "Lazy" Twitter API Wrapper for Ruby 1.9.2}
   gem.email = "oame@oameya.com"
   gem.authors = ["Oame"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/pupil.rb

@@ -12,7 +12,6 @@ require 'pupil/keygen'
 
 class Pupil
   attr_reader :screen_name
-  
   class UnsupportedParameter < StandardError; end
   
   # @param [Hash] pupil_key
@@ -33,7 +32,7 @@ class Pupil
   end
   
   # @param [Hash] parameter
-  # @return [String] serialized parameters
+  # @return [String] URL Serialized parameters
   def param_serializer parameter
     ant = Hash.new
     parameter.each do |key, value|
@@ -81,7 +80,7 @@ class Pupil
   
   public
   
-  # @return [Hash] user profile
+  # @return [Hash] User credentials
   def verify_credentials
     response = @access_token.get('/account/verify_credentials.xml')
     doc = REXML::Document.new(response.body)
@@ -90,8 +89,9 @@ class Pupil
     return user
   end
   
+  # Alias to Pupil#home_timeline
   # @param [Hash] param
-  # @return [Hash] alias to Pupil#home_timeline
+  # @return [Array] Timeline
   # @deprecated Use {#home_timeline} instead of this method because
   #   is was obsoleted.
   def friends_timeline(param = {})
@@ -114,7 +114,7 @@ class Pupil
   end
   
   # @param [Hash] param
-  # @return [Array] timeline
+  # @return [Array] Timeline
   def home_timeline(param = {})
     param_s = param_serializer(param)
     begin
@@ -132,6 +132,7 @@ class Pupil
     return statuses
   end
   
+  # Returning user timeline
   # @param [Hash] param
   # @return [Hash] timeline
   # @option param [Fixnum] :user_id The ID of user
@@ -141,12 +142,12 @@ class Pupil
   # @option param [Fixnum] :count
   # @option param [Fixnum] :page Specifies
   # @option param [Symbol] :trim_user
-  # @option param [Symbol] :include => :rts
-  # @option param [Symbol] :exclude => :replies
+  # @option param [Symbol] :include #=> [:rts]
+  # @option param [Symbol] :exclude #=> [:replies]
   # @option param [Symbol] :contributor_details
   # @example
   #   twitter = Pupil.new PUPIL_KEY
-  #   twitter.user_timeline(:screen_name => 'o_ame', :exclude_replies => :true).each do |status|
+  #   twitter.user_timeline(:screen_name => 'o_ame', :exclude => :replies).each do |status|
   #     puts "#{status.user.screen_name}: #{status.text}"
   #   end
   def user_timeline(param = {})
@@ -187,6 +188,7 @@ class Pupil
     return statuses
   end
   
+  # Returning direct messages
   # @param [Hash] param
   # @return [Hash] directmessages
   def dm(param = {})
@@ -208,6 +210,7 @@ class Pupil
     return directmessages
   end
   
+  # Returning direct messages you sent
   # @param [Hash] param
   # @return [Hash] directmessage you sent
   def dm_sent(param = {})
@@ -229,6 +232,7 @@ class Pupil
     return directmessages
   end
   
+  # Delete direct message
   # @param [Fixnum] dm_id message id that you want to delete
   # @return [Hash] response
   def dm_destroy(dm_id)
@@ -240,6 +244,7 @@ class Pupil
     return response
   end
   
+  # Check friendships
   # @param [String] src source user
   # @param [String] dst destination user
   # @return [Boolean] return true if paired users have friendship, or ruturn false
@@ -258,6 +263,7 @@ class Pupil
     end
   end
   
+  # Follow user for screen_name
   # @param [String] name screen_name
   # @return [Hash] response
   def follow name
@@ -269,6 +275,7 @@ class Pupil
     return response
   end
   
+  # Unfollow user for screen_name
   # @param [String] name screen_name
   # @return [Hash] response
   def unfollow name

data/lib/pupil/keygen.rb

@@ -2,8 +2,12 @@
 
 class Pupil
   class Keygen
-    class MissingRequiedTokens < StandardError; end
-    
+    attr_reader :con_key
+    attr_reader :con_sec
+    attr_reader :act_key
+    attr_reader :act_sec
+    class MissingRequiredTokens < StandardError; end
+
     def initialize opts={}
       @con_key = opts[:consumer_key] rescue nil
       @con_sec = opts[:consumer_secret] rescue nil
@@ -11,20 +15,30 @@ class Pupil
       @act_sec = opts[:access_token_secret] rescue nil
     end
     
-    def access_token
-      raise MissingRequiedTokens, "Keygen#access_token require consumer_key and consumer_secret" unless @con_key && @con_sec
+    def get_auth_url
+      raise MissingRequiredTokens, "Pupil::Keygen#get_auth_url require consumer_key and consumer_secret when initialized" unless @con_key || @con_sec
+      consumer = OAuth::Consumer.new(@con_key, @con_sec, :site => 'http://twitter.com')
+      request_token = consumer.get_request_token
+      return request_token.authorize_url
     end
     
-    def interactive
-      print "Enter OAuth Consumer_Key: "
-      oauth_consumer_key = gets.chomp.strip
-      print "Enter OAuth Consumer_Secret: "
-      oauth_consumer_secret = gets.chomp.strip
+    def issue_token verifier
+      raise MissingRequiredTokens, "Pupil::Keygen#get_auth_url require consumer_key and consumer_secret when initialized" unless @con_key || @con_sec
+      consumer = OAuth::Consumer.new(@con_key, @con_sec, :site => 'http://twitter.com')
+      request_token = consumer.get_request_token
+      access_token = request_token.get_access_token(:oauth_verifier => verifier)
+      @act_key = access_token.token
+      @act_sec = access_token.secret
+      return {:access_token => access_token.token, :access_token_secret => access_token.secret}
+    end
 
-      CONSUMER_KEY = oauth_consumer_key
-      CONSUMER_SECRET = oauth_consumer_secret
+    def interactive
+      print "Enter OAuth Consumer Key: " unless @con_key
+      @con_key = gets.chomp.strip unless @con_key
+      print "Enter OAuth Consumer Secret: " unless @con_sec
+      @con_sec = gets.chomp.strip unless @con_sec
 
-      consumer = OAuth::Consumer.new(CONSUMER_KEY, CONSUMER_SECRET, :site => 'http://twitter.com')
+      consumer = OAuth::Consumer.new(@con_key, @con_sec, :site => 'http://twitter.com')
 
       request_token = consumer.get_request_token
 
@@ -34,9 +48,12 @@ class Pupil
       oauth_verifier = gets.chomp.strip
 
       access_token = request_token.get_access_token(:oauth_verifier => oauth_verifier)
+      @act_key = access_token.token
+      @act_sec = access_token.secret
 
       puts "Process complete!"
       puts "Access token: #{access_token.token}"
       puts "Access token secret: #{access_token.secret}"
     end
+  end
 end

data/pupil.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{pupil}
-  s.version = "0.0.4"
+  s.name = "pupil"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Oame}]
-  s.date = %q{2011-10-10}
-  s.description = %q{The "Lazy" Twitter API wrapper for Ruby. It was made for Kbot library.}
-  s.email = %q{oame@oameya.com}
+  s.authors = ["Oame"]
+  s.date = "2011-10-22"
+  s.description = "The \"Lazy\" Twitter API Wrapper for Ruby 1.9.2"
+  s.email = "oame@oameya.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -28,14 +28,15 @@ Gem::Specification.new do |s|
     "lib/pupil.rb",
     "lib/pupil/keygen.rb",
     "pupil.gemspec",
+    "samples/generate-key.rb",
     "spec/pupil_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/oame/pupil}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.5}
-  s.summary = %q{The Twitter API Wrapper for Ruby}
+  s.homepage = "http://github.com/oame/pupil"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "The \"Lazy\" Twitter API Wrapper for Ruby"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/samples/generate-key.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require "rubygems" if RUBY_VERSION < "1.9.0"
+$LOAD_PATH << File.join(File.dirname(File.expand_path(__FILE__)), "../")
+require "lib/pupil"
+
+keygen = Pupil::Keygen.new
+keygen.interactive

data/spec/pupil_spec.rb

@@ -16,3 +16,14 @@ describe Pupil, "が #home_timeline を呼ぶ時は" do
     @home_timeline.class.should == Array
   end
 end
+
+describe Pupil, "が #mentions を呼ぶ時は" do
+  before do
+    pupil = Pupil.new PUPIL_TESTKEY
+    @mentions = pupil.mentions
+  end
+  
+  it "Array型を返すこと" do
+    @mentions.class.should == Array
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pupil
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-10 00:00:00.000000000Z
+date: 2011-10-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &2154343320 !ruby/object:Gem::Requirement
+  requirement: &70097782606580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154343320
+  version_requirements: *70097782606580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2154342740 !ruby/object:Gem::Requirement
+  requirement: &70097782605800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2154342740
+  version_requirements: *70097782605800
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2154342160 !ruby/object:Gem::Requirement
+  requirement: &70097782605080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *2154342160
+  version_requirements: *70097782605080
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2154341560 !ruby/object:Gem::Requirement
+  requirement: &70097782604380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2154341560
+  version_requirements: *70097782604380
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2154340980 !ruby/object:Gem::Requirement
+  requirement: &70097782603500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2154340980
+  version_requirements: *70097782603500
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2154340400 !ruby/object:Gem::Requirement
+  requirement: &70097782602860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,8 +76,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154340400
-description: The "Lazy" Twitter API wrapper for Ruby. It was made for Kbot library.
+  version_requirements: *70097782602860
+description: The "Lazy" Twitter API Wrapper for Ruby 1.9.2
 email: oame@oameya.com
 executables: []
 extensions: []
@@ -96,6 +96,7 @@ files:
 - lib/pupil.rb
 - lib/pupil/keygen.rb
 - pupil.gemspec
+- samples/generate-key.rb
 - spec/pupil_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/oame/pupil
@@ -113,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 422837417626133980
+      hash: -2681516288239048624
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -122,8 +123,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: The Twitter API Wrapper for Ruby
+summary: The "Lazy" Twitter API Wrapper for Ruby
 test_files: []