cinch-links-tumblr 0.0.3 → 1.0.0

data/.gitignore

@@ -12,6 +12,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/secret.rb
 test/tmp
 test/version_tmp
 tmp

data/.travis.yml

@@ -0,0 +1,27 @@
+---
+language: ruby
+rvm:
+- 1.9.2
+- 1.9.3
+env:
+  global:
+  - secure: ! 'bANxESoL2yYVy4pzpRKSWqQkQ4e5kplZbVgUwjplXU91HfJbnubgdFPcQ9ol
+
+      /Df9+Fq9kZ6Kc2JIXeVB/Rd1knse+ZtJloCiVpCwtrhrp66anjJmq4awZwcr
+
+      WJrkUtmwOi0wahkGr1J4B3mukCQSqr/ygD0C1Vu1CIuGmjmDSNc='
+  - secure: ! 'HpgfiFkdpMBppgOHMSX9fn1gZWldqvnp2DrwiIhPT5jxm6vUnrMkxv1C2oY1
+
+      uWnJEo4k1Bj8VYtDfzOABhV4hi5+rBRbjSLNxe4FP0biT45guQ5DmSHIlk/x
+
+      EZfqHalormTJnPBpval5+3rNPJCh5Ti+X7sdExI7hLdog0WmhsY='
+  - secure: ! 'NTyLUDha9LG8B6KwZvqTWQQTicVptMKW27qnEXxgVcHoPu4U/KqLSGNEXyL7
+
+      CsdF/L8OTctdjBXzQhQjgT2sQAyrO1tIkcK2flV3YH8GpHaVOfvRJmY+0Fqr
+
+      S/xbgOnegiOsm+xOVMw3zw4dMsdcVejV6IUJrShiMkN8VlT1MRY='
+  - secure: ! 'l9HRgebKrJYXeiGzWxtKOO8I/j0u/u+V7b8SpDcq7UUi+ViXvHajYy3HIJ9M
+
+      Hh1KwfAtf/FExDTXALQMVJqxavpHsvmjq7tZZSk/0NGCxWMjSt1AvbJkxc7H
+
+      s3iSP2fiWsOEtDV/zCCJ6mEa6li4QQFYRc0RWXZggbyh7PPzqdg='

data/README.md

@@ -1,5 +1,11 @@
 # Cinch::Plugins::LinksTumblr
 
+[![Gem Version](https://badge.fury.io/rb/cinch-links-tumblr.png)](http://badge.fury.io/rb/cinch-links-tumblr)
+[![Dependency Status](https://gemnasium.com/bhaberer/cinch-links-tumblr.png)](https://gemnasium.com/bhaberer/cinch-links-tumblr)
+[![Build Status](https://travis-ci.org/bhaberer/cinch-links-tumblr.png?branch=master)](https://travis-ci.org/bhaberer/cinch-links-tumblr)
+[![Coverage Status](https://coveralls.io/repos/bhaberer/cinch-links-tumblr/badge.png?branch=master)](https://coveralls.io/r/bhaberer/cinch-links-tumblr?branch=master)
+[![Code Climate](https://codeclimate.com/github/bhaberer/cinch-links-tumblr.png)](https://codeclimate.com/github/bhaberer/cinch-links-tumblr)
+
 This plugin takes all links from the channel and posts them to a Tumblr.
 
 You can optionally specify a password if you want to use a private Tumblr.
@@ -54,7 +60,7 @@ Once you have your Tumblr credentials, you need to add them to the configuration
     end
 
 That should be all you need to get the Plugin working! Users can get the Tumblr info
-(hostname / password) at any time by using `.tumblr` in the channel.
+(hostname / password) at any time by using `!tumblr` in the channel.
 
 By default links tumbled will be logged to `yaml/tumblr.yml`, you can change this by specifying
 a different loation with `c.plugins.options[Cinch::Plugins::LinksTumblr][:filename] = NEW_PATH`.

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/cinch-links-tumblr.gemspec

@@ -17,9 +17,15 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency('cinch-storage', '>= 0.0.1')
-  gem.add_dependency('cinch-toolbox', '>= 0.0.5')
-  gem.add_dependency('cinch',         '>= 2.0.0')
-  gem.add_dependency('tumblr-rb',     '>= 2.0.0')
-  gem.add_dependency('weary',         '>= 1.1.3')
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'cinch-test'
+  gem.add_development_dependency 'json'
+
+  gem.add_dependency  'cinch-storage', '~> 1.0.0'
+  gem.add_dependency  'cinch-toolbox', '~> 1.0.3'
+  gem.add_dependency  'cinch',         '~> 2.0.5'
+  gem.add_dependency  'tumblr-rb',     '~> 2.1.1'
+  gem.add_dependency  'weary',         '~> 1.1.3'
 end

data/lib/cinch/plugins/links-tumblr/links-tumblr.rb

@@ -1,83 +1,75 @@
 # -*- coding: utf-8 -*-
-require 'nokogiri'
 require 'open-uri'
 require 'tumblr'
+require 'cinch'
 require 'cinch-storage'
-require 'cinch-toolbox'
+require 'cinch/toolbox'
 
 module Cinch::Plugins
   class LinksTumblr
     include Cinch::Plugin
 
     listen_to :channel
+
     match /tumblr/
 
     self.help = 'Use .tumblr for the url and password (if any) for the channel\'s tumblr.'
 
-
     def initialize(*args)
       super
       @storage = CinchStorage.new(config[:filename] || 'yaml/tumblr.yml')
-      @storage.data[:history] ||= Hash.new
-      @hostname = config[:hostname] 
+      @storage.data ||= {}
+      @hostname = config[:hostname]
       @password = config[:password]
-      @creds = { :consumer_key      => config[:consumer_key],
-                 :consumer_secret   => config[:consumer_secret],
-                 :token             => config[:token],
-                 :token_secret      => config[:token_secret] }
+      @creds = { consumer_key:    config[:consumer_key],
+                 consumer_secret: config[:consumer_secret],
+                 token:           config[:token],
+                 token_secret:    config[:token_secret] }
+      credential_check
     end
 
     def execute(m)
-      if m.channel.nil?
-        # Tumblr's are channel bound, so require the user to be in a channel
-        m.user.msg "You must use that command in the main channel."
-        return
-      else
-        if @hostname
-          msg = "Links are available @ http://#{@hostname}"
-          msg << " Password: #{@password}" unless @password.nil?
-          m.user.send msg
-        else
-          debug "ERROR: Tumblr hostname has not been specified, see docs for info."
-        end
+      return if Cinch::Toolbox.sent_via_private_message?(m)
+
+      if @hostname
+        msg = "Links are available @ http://#{@hostname}"
+        msg << " Password: #{@password}" unless @password.nil?
+        m.user.send msg
       end
     end
 
     def listen(m)
       urls = URI.extract(m.message, ["http", "https"])
       urls.each do |url|
-        @storage.data[:history][m.channel.name] ||= Hash.new
+        @storage.data[m.channel.name] ||= []
 
         # Check to see if we've seen the link
-        unless @storage.data[:history][m.channel.name].key?(url)
-          short_url = Cinch::Toolbox.shorten(url)
-          title = Cinch::Toolbox.get_page_title(url)
-          tumble(url, title, m.user.nick)
+        unless @storage.data[m.channel.name].include?(url)
+          tumble(url, m.user.nick)
 
           # Store the links to try and cut down on popular urls getting tumbled 20 times
-          @storage.data[:history][m.channel.name][url] = { :time => Time.now }
-        end
-      end
-
-      if urls
-        synchronize(:save_links) do
-          @storage.save
+          @storage.data[m.channel.name] << url
         end
+        @storage.synced_save(@bot)
       end
     end
 
     private
 
-    def tumble(url, title, nick)
-      # Redit
+    def tumble(url, nick)
+      title = Cinch::Toolbox.get_page_title(url)
+      # Parse out common Redit formats
       if redit = url.match(/^https?:\/\/.*imgur\.com.*\/([A-Za-z0-9]+\.\S{3})/)
         post_image("http://i.imgur.com/#{redit[1]}", title, nick)
+      elsif redit = url.match(/^https?:\/\/.*imgur\.com.*\/([A-Za-z0-9]+)\/?/)
+        # It may not be a jpg, but most browsers will read the meta regardless.
+        post_image("http://i.imgur.com/#{redit[1]}.jpg", title, nick)
       # Images
       elsif url.match(/\.jpg|jpeg|gif|png$/i)
         post_image(url, title, nick)
       # Youtube / Vimeo
       elsif url.match(/https?:\/\/[^\/]*\.?(youtube|youtu|vimeo)\./)
-        post_video(url, nil, nick)
+        post_video(url, title, nick)
       # Everything else
       else
         post_link(url, title, nick)
@@ -85,37 +77,37 @@ module Cinch::Plugins
     end
 
     def post_link(url, title = nil, nick = nil)
-      document = tumblr_header('link', { 'name' => title, 'tags' => nick })
+      document = tumblr_header(:link, { title: title, tags: nick })
       document << url
-      tublr_post(document)
-    end
-
-    def post_quote(quote, source, nick = nil)
-      document = tumblr_header('quote', { 'source' => source, 'tags' => [nick, 'twitter'] })
-      document << quote
-      tublr_post(document)
+      tumblr_post(document)
     end
 
     def post_image(url, title = nil, nick = nil)
-      document = tumblr_header('text', { 'title' => title, 'tags' => [nick, 'image'] })
+      document = tumblr_header(:text, { title: title, tags: [nick, 'image'] })
       document << "<p><a href='#{url}'><img src='#{url}' style='max-width: 650px;'/></a><br/><a href='#{url}'>#{url}</a></p>"
-      tublr_post(document)
+      tumblr_post(document)
     end
 
     def post_video(url, title, nick = nil)
-      document = tumblr_header('video', { 'caption' => title, 'tags' => [nick, 'video'] })
+      document = tumblr_header(:video, { caption: title, tags: [nick, 'video'] })
       document << url
-      tublr_post(document)
+      tumblr_post(document)
     end
 
-    def tumblr_header(type = 'text', options = {})
-      opts = { 'type' => type, 'hostname' => @hostname }.update(options)
+    def tumblr_header(type = :text, options = {})
+      opts = { type: type, hostname: @hostname }.update(options)
       doc = YAML::dump(opts)
       doc << "---\n"
       return doc
     end
 
-    def tublr_post(doc)
+    def credential_check
+      if @creds.values.include?(nil)
+        raise ArgumentError, 'Credentials are not set correctly, please see documentation.'
+      end
+    end
+
+    def tumblr_post(doc)
       client = Tumblr::Client.new(@hostname, @creds)
       post = Tumblr::Post.load(doc)
       request = post.post(client)

data/lib/cinch/plugins/links-tumblr/version.rb

@@ -1,7 +1,7 @@
 module Cinch
   module Plugins
     class LinksTumblr
-      VERSION = "0.0.3"
+      VERSION = "1.0.0"
     end
   end
 end

data/spec/cinch-links-tumblr_spec.rb

@@ -0,0 +1,111 @@
+# -*- coding: utf-8 -*-
+require 'cinch'
+require 'spec_helper'
+describe Cinch::Plugins::LinksTumblr do
+  include Cinch::Test
+
+  before(:all) do
+    @bot = build_bot('password')
+  end
+
+  after(:all) do
+    purge_tumblr_posts
+  end
+
+  it 'should return the links url and password if one is defined' do
+    get_replies(make_message(@bot, '!tumblr', { channel: '#foo', nick: 'bar' })).
+      first.text.should == "Links are available @ http://marvintesting.tumblr.com Password: password"
+  end
+
+  it 'should not send url and password if sent via pm' do
+    get_replies(make_message(@bot, '!tumblr')).
+      first.text.should == "You must use that command in the main channel."
+  end
+
+  it 'should not return a password if one is not defined' do
+    get_replies(make_message(build_bot, '!tumblr', { channel: '#foo', nick: 'bar' })).
+      first.text.should == "Links are available @ http://marvintesting.tumblr.com"
+  end    
+
+  it 'should capture links' do
+    get_replies(make_message(@bot, 'http://github.com', { channel: '#foo', nick: 'bar' }))
+    post = get_last_tumblr_post
+    post['url'].should == 'http://github.com'
+    post["type"].should == 'link'
+  end
+
+  it 'should capture youtube links and post them as videos' do
+    get_replies(make_message(@bot, 'https://www.youtube.com/watch?v=-xiAbDkXDgg', { channel: '#foo', nick: 'bar' }))
+    post = get_last_tumblr_post
+    post['caption'].should == '<p>Lo Pan Style (Gangnam Style Parody) Official - YouTube</p>'
+    post['tags'].should == ['bar', 'video']
+    post['type'].should == 'video'
+  end
+
+  it 'should capture imgur links' do
+    get_replies(make_message(@bot, 'http://imgur.com/oMndYK7', { channel: '#foo', nick: 'bar' }))
+    post = get_last_tumblr_post
+    post['title'].should == 'Anybody with a cat will relate. - Imgur'
+    post['type'].should == 'text'
+  end
+
+  it 'should capture imgur links and tumble them with title' do
+    get_replies(make_message(@bot, 'http://i.imgur.com/NWq5WIq.gif', { channel: '#foo', nick: 'bar' }))
+    post = get_last_tumblr_post
+    post['title'].should == '"ball, ball, ball, BALL!!" - Corgi - Imgur'
+    post['type'].should == 'text'
+  end
+
+  it 'should capture image links' do
+    get_replies(make_message(@bot, 'http://tmp.weirdo513.org/choc.jpg', { channel: '#foo', nick: 'bar' }))
+    post = get_last_tumblr_post
+    post['title'].should == 'Image from http://tmp.weirdo513.org'
+    post['type'].should == 'text'
+  end
+end
+
+def get_last_tumblr_post
+  sleep 60
+  posts = JSON.parse(get_client.posts.perform.body)["response"]["posts"][0]
+end
+
+def get_tumblr_posts
+  client = get_client
+  JSON.parse(client.posts.perform.body)["response"]["posts"]
+end
+
+def purge_tumblr_posts
+  client  = get_client
+  entries = JSON.parse(client.posts.perform.body)["response"]["posts"]
+  entries.map! { |p| p["id"] }
+
+  entries.each do |id|
+    client.delete(id: id).perform do |response|
+      if response.success?
+        puts "Deleted #{id}"
+      else
+        puts "Something went wrong posting to Tumblr #{response.code} #{response.message}"
+      end
+    end
+  end
+end
+
+def get_client
+  @creds = { consumer_key:    ENV['CONSUMER_KEY'],
+             consumer_secret: ENV['CONSUMER_SECRET'],
+             token:           ENV['TOKEN'],
+             token_secret:    ENV['TOKEN_SECRET'] }
+  Tumblr::Client.new('marvintesting.tumblr.com', @creds)
+end
+
+def build_bot(password = nil)
+  conf =  { filename:        '/dev/null',
+            hostname:        'marvintesting.tumblr.com',
+            consumer_key:    ENV['CONSUMER_KEY'],
+            consumer_secret: ENV['CONSUMER_SECRET'],
+            token:           ENV['TOKEN'],
+            token_secret:    ENV['TOKEN_SECRET'] }
+  conf[:password] = password unless password.nil?
+  
+  make_bot(Cinch::Plugins::LinksTumblr, conf)
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'coveralls'
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+if File::exist? File.join(File.dirname(__FILE__), "secret.rb")
+  require 'secret'
+end
+
+require 'json'
+require 'cinch-links-tumblr'
+require 'cinch/test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-links-tumblr
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,78 +9,158 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: cinch-storage
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.1
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: cinch-toolbox
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.5
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: cinch
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: tumblr-rb
+  name: cinch-test
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: weary
+  name: json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cinch-storage
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: cinch-toolbox
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: tumblr-rb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: weary
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.3
   type: :runtime
@@ -88,7 +168,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.1.3
 description: Cinch gem that logs every link posted in the channel to a Tumblr
@@ -99,6 +179,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -107,6 +188,8 @@ files:
 - lib/cinch-links-tumblr.rb
 - lib/cinch/plugins/links-tumblr/links-tumblr.rb
 - lib/cinch/plugins/links-tumblr/version.rb
+- spec/cinch-links-tumblr_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bhaberer/cinch-links-tumblr
 licenses: []
 post_install_message: 
@@ -127,8 +210,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Cinch Tumblr Plugin
-test_files: []
+test_files:
+- spec/cinch-links-tumblr_spec.rb
+- spec/spec_helper.rb
+has_rdoc: