cinch-twitter 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Version 0.2.0
+  * The plugin can now be included via `Cinch::Plugins::Twitter`.
+
+# Version 0.1.0
+  * Initial release

data/README.md

@@ -3,8 +3,6 @@ cinch-twitter
 
 A Cinch plugin for accessing Twitter, using [John Nunemaker's](https://github.com/jnunemaker) wonderful [Twitter gem](https://github.com/jnunemaker/twitter).
 
-Requiring the gem: `require 'cinch/plugins/twitter'`
-
 Usage
 -----
 
@@ -16,17 +14,18 @@ Usage
 Shorthand commands are also available: 
 * `@[username]<+D>`, @#[id]
 
-Loading
--------
-
-This should be obvious, right? Not so. 
-
-`c.plugins.plugins << Cinch::Plugins::Twitter::Client`
+Requiring and including the plugin
+----------------------------------
+    require 'cinch/plugins/twitter'
+    # ...
+    Bot.config {|c|
+    # ...
+      c.plugins.plugins << Cinch::Plugins::Twitter
 
 Configuration
 -------------
 
-To configure the plugin, you must insert your access keys for the client. If you wish, you may use `JSON` or `YAML` to store and deserialize them.
+To configure the plugin, you must insert your access keys for the client.
 
 To retrieve your access keys and `oauth` tokens, if you already have an application set up, please visit https://dev.twitter.com/apps, otherwise visit https://dev.twitter.com/apps/new and follow the instructions.
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/cinch-twitter.gemspec

@@ -5,19 +5,21 @@
 
 Gem::Specification.new do |s|
   s.name = "cinch-twitter"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Seymour"]
-  s.date = "2012-06-27"
+  s.date = "2012-06-28"
   s.description = "A Twitter plugin for Cinch."
   s.email = "mark.seymour.ns@gmail.com"
   s.extra_rdoc_files = [
+    "CHANGELOG.md",
     "LICENSE.txt",
     "README.md"
   ]
   s.files = [
     ".document",
+    "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",

data/lib/cinch/plugins/twitter/error_handler.rb

@@ -2,7 +2,7 @@
 
 module Cinch
   module Plugins
-    module Twitter
+    class Twitter
       module ErrorHandler
 
         class Warnings < StandardError

data/lib/cinch/plugins/twitter/formatter.rb

@@ -1,22 +1,23 @@
 # coding: utf-8
 require 'cgi'
+require 'cinch/formatting'
 
 module Cinch
   module Plugins
-    module Twitter
+    class Twitter
       module Formatter
 
         def format_tweet(tweet)
           tweet_text = expand_uris(tweet.text, tweet.attrs["entities"]["urls"])
           parts, head, body, tail, urls = [], [], [], [], []
-          head = Format(:bold,"#{tweet.user.screen_name} »")
+          head = Cinch::Formatting.format(:bold,"#{tweet.user.screen_name} »")
           body << CGI::unescapeHTML(tweet_text.gsub("\n", " ").squeeze(" "))
-          body << Format(:aqua,"*twoosh*") if tweet.text.length == 140
+          body << Cinch::Formatting.format(:aqua,"*twoosh*") if tweet.text.length == 140
           tail << "From #{tweet.place.full_name}" if !tweet.place.blank?
           tail << "at #{tweet.created_at.strftime("%B %-d, %Y, %-I:%m%P")}"
           tail << "via #{tweet.source.gsub( %r{</?[^>]+?>}, '' )}"
           urls << "https://twitter.com/#{tweet.user.screen_name}"
-          urls << Format(:grey,"in reply to") if !tweet.in_reply_to_screen_name.blank?
+          urls << Cinch::Formatting.format(:grey,"in reply to") if !tweet.in_reply_to_screen_name.blank?
           urls << "http://twitter.com/#{tweet.in_reply_to_screen_name}#{"/statuses/#{tweet.in_reply_to_status_id.to_s}" if !tweet.in_reply_to_status_id.blank?}" if !tweet.in_reply_to_screen_name.blank?
           parts = [head, body, ["(", tail.join(" "), ")"].join, urls].flatten
           parts.join(" ")
@@ -25,9 +26,9 @@ module Cinch
         def format_search(tweet)
           tweet_text = expand_uris(tweet.text, tweet.attrs["entities"]["urls"])
           parts, head, body, tail, urls = [], [], [], [], []
-          head = Format(:bold,"#{tweet.from_user} »")
+          head = Cinch::Formatting.format(:bold,"#{tweet.from_user} »")
           body << CGI::unescapeHTML(tweet_text.gsub("\n", " ").squeeze(" "))
-          body << Format(:aqua,"*twoosh*") if tweet.text.length == 140
+          body << Cinch::Formatting.format(:aqua,"*twoosh*") if tweet.text.length == 140
           tail << "at #{tweet.created_at.strftime("%B %-d, %Y, %-I:%m%P")}"
           urls << "https://twitter.com/#{tweet.from_user}"
           parts = [head, body, ["(", tail.join(" "), ")"].join, urls].flatten
@@ -36,11 +37,11 @@ module Cinch
 
         def format_tweep_info(tweep)
           tweep_status_text = expand_uris(tweep.status.text, tweep.status.attrs["entities"]["urls"])
-          head =  "#{Format(:aqua,tweep.name)}" + Format(:silver," (#{tweep.screen_name})") + Format(:grey," - #{tweep.url} https://twitter.com/#{tweep.screen_name}")
+          head =  "#{Cinch::Formatting.format(:aqua,tweep.name)}" + Cinch::Formatting.format(:silver," (#{tweep.screen_name})") + Cinch::Formatting.format(:grey," - #{tweep.url} https://twitter.com/#{tweep.screen_name}")
           bio = ""
-          bio = Format(:aqua,"\"#{tweep.description.strip}\"") if !tweep.description.blank?
+          bio = Cinch::Formatting.format(:aqua,"\"#{tweep.description.strip}\"") if !tweep.description.blank?
           location = ""
-          location = "They are from #{Format(:aqua,tweep.location.strip)}" if !tweep.location.blank?
+          location = "They are from #{Cinch::Formatting.format(:aqua,tweep.location.strip)}" if !tweep.location.blank?
           desc = [] << "has made #{tweep.statuses_count} tweets since #{tweep.created_at.strftime("%B %-d, %Y")}"
           desc << "follows #{tweep.friends_count} tweeps" if tweep.friends_count > 0
           desc << "has #{tweep.followers_count} followers" if tweep.followers_count > 0
@@ -51,14 +52,14 @@ module Cinch
           flags << "is a translator for Twitter" if tweep.is_translator?
           flags << "is verified" if tweep.verified?
           flags << "would rather keep their life secret" if tweep.protected?
-          tweet = [] << Format(:aqua,"Their latest tweet:")
+          tweet = [] << Cinch::Formatting.format(:aqua,"Their latest tweet:")
           tweet << CGI::unescapeHTML(tweep_status_text.gsub("\n", " ").squeeze(" "))
           tweet_tail = []
           tweet_tail << "from #{tweep.status.place.full_name}" if !tweep.status.place.blank?
           tweet_tail << "at #{tweep.status.created_at.strftime("%B %-d, %Y, %-I:%m%P")}"
 
           parts = [head, bio, location, desc, flags].reject(&:blank?).map {|e| e.is_a?(Array) ? "#{tweep.name} " + e.to_sentence + "." : e }
-          parts << [tweet, Format(:silver,["(", tweet_tail.join(" "), ")"].join)].join(" ")
+          parts << [tweet, Cinch::Formatting.format(:silver,["(", tweet_tail.join(" "), ")"].join)].join(" ")
           parts.join("\n")
         end
       

data/lib/cinch/plugins/twitter/tweet_handler.rb

@@ -4,69 +4,71 @@ require 'cinch/plugins/twitter/error_handler'
 
 module Cinch
   module Plugins
-    module Twitter
+    class Twitter
       module TweetHandler
-        include Formatter
-        include ErrorHandler
-
-        EXCEPTIONS = [::Twitter::Error, ErrorHandler::Warnings]
-        AMessage = Struct.new(:message,:type)
-
         # Handler methods
+        class << self
+          include Formatter
+          include ErrorHandler
 
-        def tweet_by_username(params={})
-          params = { username: "Twitter", nth_tweet: 0 }.merge(params)
-          begin
-            raise Warnings::TooManyTweets if params[:nth_tweet].to_i > 20
-            timeline = ::Twitter.user_timeline params[:username], include_entities: true, include_rts: true, count: params[:nth_tweet].to_i.succ
-            raise Warnings::NoTweets if timeline.blank?
-            tweet = timeline.last
-            params[:username] = tweet.user.screen_name if !tweet.user.nil? # For proper case.
+          EXCEPTIONS = [::Twitter::Error, ErrorHandler::Warnings]
+          AMessage = Struct.new(:message,:type)
 
-            return "No tweets!" if timeline.blank?
-            return "Protected!" if tweet.user.protected?
+          def tweet_by_username(params={})
+            params = { username: "Twitter", nth_tweet: 0 }.merge(params)
+            begin
+              raise Warnings::TooManyTweets if params[:nth_tweet].to_i > 20
+              timeline = ::Twitter.user_timeline params[:username], include_entities: true, include_rts: true, count: params[:nth_tweet].to_i.succ
+              raise Warnings::NoTweets if timeline.blank?
+              tweet = timeline.last
+              params[:username] = tweet.user.screen_name if !tweet.user.nil? # For proper case.
 
-            AMessage.new format_tweet(tweet) # The fun starts here. If there is ever a problem, it'll bubble up here and be caught.
+              return "No tweets!" if timeline.blank?
+              return "Protected!" if tweet.user.protected?
 
-          rescue *EXCEPTIONS => ex
-            AMessage.new handle_error(ex, params[:username], @bot.nick), :notice
+              AMessage.new format_tweet(tweet) # The fun starts here. If there is ever a problem, it'll bubble up here and be caught.
+
+            rescue *EXCEPTIONS => ex
+              AMessage.new handle_error(ex, params[:username], @bot.nick), :notice
+            end
           end
-        end
 
-        def tweet_by_id(params={})
-          params = {id: 0 }.merge(params)
-          begin
-            tweet = ::Twitter.status params[:id], include_entities: true
-            params[:username] = tweet.user.screen_name if !tweet.user.nil? # For easy access.
-            AMessage.new format_tweet(tweet) # If there is ever a problem, it'll bubble up here and be caught.
-          rescue *EXCEPTIONS => ex
-            AMessage.new handle_error(ex, params[:username], @bot.nick), :notice
+          def tweet_by_id(params={})
+            params = {id: 0 }.merge(params)
+            begin
+              tweet = ::Twitter.status params[:id], include_entities: true
+              params[:username] = tweet.user.screen_name if !tweet.user.nil? # For easy access.
+              AMessage.new format_tweet(tweet) # If there is ever a problem, it'll bubble up here and be caught.
+            rescue *EXCEPTIONS => ex
+              AMessage.new handle_error(ex, params[:username], @bot.nick), :notice
+            end
           end
-        end
 
-        def tweep_info(params={})
-          params = {username: "Twitter"}.merge(params)
-          begin
-            tweep = ::Twitter.user params[:username], include_entities: true
-            AMessage.new format_tweep_info(tweep)
-          rescue *EXCEPTIONS => ex
-            AMessage.new handle_error(ex, params[:username], @bot.nick), :notice
+          def tweep_info(params={})
+            params = {username: "Twitter"}.merge(params)
+            begin
+              tweep = ::Twitter.user params[:username], include_entities: true
+              AMessage.new format_tweep_info(tweep)
+            rescue *EXCEPTIONS => ex
+              AMessage.new handle_error(ex, params[:username], @bot.nick), :notice
+            end
           end
-        end
 
-        def search_by_term(params={})
-          params = {term: "cat"}.merge(params)
-          begin
-            results = []
-            ::Twitter.search(params[:term], include_entities: true, rpp: 3, result_type: "recent").each {|status|
-              params[:username] = status.from_user
-              results << format_search(status)
-            }
-            results << "There are no results for \"#{params[:term]}\"." if results.empty?
-            AMessage.new results.join("\n")
-          rescue *EXCEPTIONS => ex
-            AMessage.new handle_error(ex, params[:username], @bot.nick), :notice
+          def search_by_term(params={})
+            params = {term: "cat"}.merge(params)
+            begin
+              results = []
+              ::Twitter.search(params[:term], include_entities: true, rpp: 3, result_type: "recent").each {|status|
+                params[:username] = status.from_user
+                results << format_search(status)
+              }
+              results << "There are no results for \"#{params[:term]}\"." if results.empty?
+              AMessage.new results.join("\n")
+            rescue *EXCEPTIONS => ex
+              AMessage.new handle_error(ex, params[:username], @bot.nick), :notice
+            end
           end
+
         end
 
       end

data/lib/cinch/plugins/twitter.rb

@@ -7,80 +7,77 @@ require 'cinch/plugins/twitter/tweet_handler'
 
 module Cinch
   module Plugins
-    module Twitter
+    class Twitter
+      include Cinch::Plugin
+      #include Twitter::TweetHandler
 
-      class Client
-        include Cinch::Plugin
-        include Twitter::TweetHandler
+      set(
+        plugin_name: "Twitter",
+        help: "Access Twitter from the comfort of your IRC client! Usage:\n* `!tw <username><+D>` - Gets the latest tweet of the specified user, or the tweet 'D' tweets back, between 1 and 20.\n* `!tw #[id]` - Gets the tweet at the specified ID\n* `?tw [username]` - Gets the specified user's Twitter profile\n* `?ts [term]` - Searches for three of the most recent tweets regarding the specified query\n\nShorthand: `@[username]<+D>`, @#[id]",
+        required_options: [:access_keys])
 
-        set(
-          plugin_name: "Twitter",
-          help: "Access Twitter from the comfort of your IRC client! Usage:\n* `!tw <username><+D>` - Gets the latest tweet of the specified user, or the tweet 'D' tweets back, between 1 and 20.\n* `!tw #[id]` - Gets the tweet at the specified ID\n* `?tw [username]` - Gets the specified user's Twitter profile\n* `?ts [term]` - Searches for three of the most recent tweets regarding the specified query\n\nShorthand: `@[username]<+D>`, @#[id]",
-          required_options: [:access_keys])
-
-        def initialize(*args)
-          super
-          keys = config[:access_keys]
-          ::Twitter.configure do |c|
-            c.consumer_key = keys["consumer_key"]
-            c.consumer_secret = keys["consumer_secret"]
-            c.oauth_token = keys["oauth_token"]
-            c.oauth_token_secret = keys["oauth_token_secret"]
-          end
+      def initialize(*args)
+        super
+        keys = config[:access_keys]
+        ::Twitter.configure do |c|
+          c.consumer_key = keys["consumer_key"]
+          c.consumer_secret = keys["consumer_secret"]
+          c.oauth_token = keys["oauth_token"]
+          c.oauth_token_secret = keys["oauth_token_secret"]
         end
+      end
 
-        def is_notice?(m)
-          m.type == :notice ? true : false
-        end
+      def is_notice?(m)
+        m.type == :notice ? true : false
+      end
 
 
-        match /tw$/, method: :execute_tweet
-        match /tw (\w+)(?:-(\d+))?$/, method: :execute_tweet
-        match /^@(\w+)(?:-(\d+))?$/, method: :execute_tweet, use_prefix: false
-        def execute_tweet(m, username = nil, nth_tweet = nil)
-          options = {}
-          options[:username] = username unless username.nil?
-          options[:nth_tweet] = nth_tweet unless nth_tweet.nil?
-          result = tweet_by_username(options)
-          if is_notice?(result)
-            m.user.notice result.message
-          else
-            m.reply result.message
-          end
+      match /tw$/, method: :execute_tweet
+      match /tw (\w+)(?:-(\d+))?$/, method: :execute_tweet
+      match /^@(\w+)(?:-(\d+))?$/, method: :execute_tweet, use_prefix: false
+      def execute_tweet(m, username = nil, nth_tweet = nil)
+        options = {}
+        options[:username] = username unless username.nil?
+        options[:nth_tweet] = nth_tweet unless nth_tweet.nil?
+        result = TweetHandler.tweet_by_username(options)
+        if is_notice?(result)
+          m.user.notice result.message
+        else
+          m.reply result.message
         end
+      end
 
-        match /tw #(\d+)$/, method: :execute_id
-        match /^@#(\d+)$/, method: :execute_id, use_prefix: false
-        def execute_id(m, id)
-          result = tweet_by_id(id: id)
-          if is_notice?(result)
-            m.user.notice result.message
-          else
-            m.reply result.message
-          end
+      match /tw #(\d+)$/, method: :execute_id
+      match /^@#(\d+)$/, method: :execute_id, use_prefix: false
+      def execute_id(m, id)
+        result = TweetHandler.tweet_by_id(id: id)
+        if is_notice?(result)
+          m.user.notice result.message
+        else
+          m.reply result.message
         end
+      end
 
-        match /\?tw (\w+)$/, method: :execute_info, use_prefix: false
-        def execute_info(m, username)
-          result = tweep_info(username: username)
-          if is_notice?(result)
-            m.user.notice result.message
-          else
-            m.reply result.message
-          end
+      match /\?tw (\w+)$/, method: :execute_info, use_prefix: false
+      def execute_info(m, username)
+        result = TweetHandler.tweep_info(username: username)
+        if is_notice?(result)
+          m.user.notice result.message
+        else
+          m.reply result.message
         end
+      end
 
-        match /\?ts (.+)$/, method: :execute_search, use_prefix: false
-        def execute_search(m, term)
-          result = search_by_term(term: term)
-          if is_notice?(result)
-            m.user.notice result.message
-          else
-            m.reply result.message
-          end
+      match /\?ts (.+)$/, method: :execute_search, use_prefix: false
+      def execute_search(m, term)
+        result = TweetHandler.search_by_term(term: term)
+        if is_notice?(result)
+          m.user.notice result.message
+        else
+          m.reply result.message
         end
-
       end
+
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-twitter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-27 00:00:00.000000000 Z
+date: 2012-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -128,10 +128,12 @@ email: mark.seymour.ns@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 files:
 - .document
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -158,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -858696623
+      hash: -173112557
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: