curate_tumblr 1.0.3

data/.project

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>curate_tumblr</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>com.aptana.ide.core.unifiedBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.projects.webnature</nature>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/README.md

@@ -0,0 +1,219 @@
+# Curate Tumblr Ruby Gem
+
+Reblog and follow in your Tumblr from a file of links.
+
+Grow you Tumblr audience by automating the boring tasks !
+
+### Installation
+
+gem install curate_tumblr
+
+### Quick Example
+
+require 'curate_tumblr'
+
+**CurateTumblr.reblog( "kubricklove", "/home/tumblr" )**
+
+reblog links in the queue of tumblr "kubricklove" where config is in 
+/home/tumblr/kubricklove/kubricklove_config.yaml
+and links to reblog are in 
+/home/tumblr/kubricklove/links/kubricklove_links
+
+### Features
+
+* *polite with tumblr* : random sleep and stop if tumblr send errors
+* *extract informations from posts* : other tumblrs to follow, external links to see...
+* *add visibility to your reblogs* : add tags and link
+* *separate follow from reblog* : not to waste Tumblr requests
+* *config in realtime* : you can stop it or change parameters when running
+
+### Important
+
+Please note before all **you have to config oauth** for your tumblr.
+
+You can see an example of reblog and follow for a kubrick tumblr in the *example* folder.
+
+## Usage
+
+### oAuth
+
+#### Create a Tumblr
+
+First create a test tumblr if you have not
+
+ex : mytumblrtest.tumblr.com
+
+#### oAuth
+
+Follow the tumblr process to have oauth authenficiation :
+https://www.tumblr.com/login?redirect_to=%2Foauth%2Fapps
+
+more infos : http://www.tumblr.com/docs/en/api/v2#blog-likes
+
+This application **must be authorized** by your tumblr
+
+#### Result
+
+At the end you must have this codes :
+
+    consumer_key: XX        
+    consumer_secret: XX     
+    token: XX               
+    token_secret: XX  
+
+
+### Config
+
+Curate Tumblr uses the name of your tumblr to find the folder for links (to reblog and follow) and config file
+
+#### Create folders
+
+Create a folder where you will have your config and links files :
+
+ex : /home/tumblr
+
+Create in this folder another folder with your test tumblr name :
+
+ex : /home/tumblr/mytumblrtest
+
+In this folder create a folder links and a folder logs
+
+ex :
+
+/home/tumblr/mytumblrtest/links
+
+/home/tumblr/mytumblrtest/logs
+
+
+#### Create config file
+
+Create a config file in this folder. 
+
+You can copy *kubricklove_config.yaml* from the example and rename it with your tumblr name :
+
+ex  /home/tumblr/mytumblrtest/mytumblrtest_config.yaml
+
+Put your oauth codes in the config file
+
+  oauth:  
+
+    consumer_key:        
+    consumer_secret:     
+    token:               
+    token_secret: 
+
+Congratulations! :-)
+
+
+## Some examples
+
+#### Reblog or follow from a links file
+
+The easy way is to render tumblr links from file, with *CurateTumblr::Render* module :
+
+require "curate_tumblr"
+
+CurateTumblr.reblog( "mytumblrtest", "/home/tumblr" )
+
+CurateTumblr.follow( "mytumblrtest", "/home/tumblr" )
+
+#### Reblog or follow a link
+
+You can also use *CurateTumblr::Curator* :
+
+require "curate_tumblr"
+
+curator = Curator.new( "mytumblrtest", "/home/tumblr" )
+
+curator.reblog_and_extract( "http://joshbrooksonfilm.tumblr.com/post/58294445822/barry-lyndon-1975-kubrick-1st-viewing-if-i" )
+
+curator.reblog_and_extract( "http://oh-lesedi.tumblr.com" )
+
+## Config options
+
+client: basic config for manage Tumblr
+  * *is_running* : if false stop the application
+  * *sleep_before_client_min and max* : random sleep before each request (important to not be blocked by Tumblr)
+  * *sleep_before_follow_min and max* : random sleep before following, can simulate a queue
+  * *max_requests_and_posts* : max of all requests before stop 
+  * *max_posted* : max of posted (text, image) before stop
+  * *max_reblogged* : max of reblogged before stop
+  * *max_followed* : max of followed before stop
+  * *oauth: consumer_key, consumer_secret, token, token_secret*
+
+infos: infos to add to your posts
+  * *tags* : a string with list of tags
+  * *title* : to add a link to your tumblr   
+
+
+## Rspec 
+
+**Before testing code you have to set oauth and create a config file** (you can copy the example config file)
+
+In *spec/factories.rb* change *get_tumblr_name* and *get_tumblr_directory*
+
+in the config file set oauth
+  oauth:  
+
+    consumer_key:        
+    consumer_secret:     
+    token:               
+    token_secret: 
+
+
+## Tumblr errors
+
+The application manage these tumblr errors :
+* *Rate limit exceeded* : too much requests, try to incread the sleep time in config file **=> the application stop**
+* *Bad request* : perhaps the link has been deleted
+* *Too much bad requests* : there is no enough place in the queue, or there is a problem with your tumblr **=> the application stop**
+
+
+## Tips
+
+### Realtime
+
+Config file is read before each operation.
+
+You can stop a cron reblog or follow by changing *is_running* in config file 
+(ex /home/tumblr/mytumblrtest/mytumblrtest_config.yaml) 
+
+*is_running:   false*
+
+you can also change other parameters (max to reblog, sleep time...)
+
+
+### Problems
+
+If strange things happen :
+* please note by default reblogged posts are published in queue (not visible)
+* check there is enough place in the queue (max 300 posts in queue)
+* check your tumblr name (ex : mytumblrtest if you have created mytumblrtest.tumblr.com)
+* check oauth is ok in your config file
+* check log file (ex in /home/tumblr/mytumblrtest/logs)
+
+### About reblog
+
+To reblog a post you need its reblog key.
+
+You have to send a request to tumblr with the post tumblr and id.
+
+You can use :
+
+*CurateTumblr::Tumblr::ExtractLinks.get_reblog_key_from_reblog_url*
+
+and *reblog_post_key* in CurateTumblr::Publish.Reblog
+
+
+## Todo
+
+* memory (to not follow tumblrs already followed)
+* hidden oauth (are you enough paranoid ?)
+
+
+## Copyright
+
+The Curate Tumblr gem is Copyright (c) 2013 David Tysman and is licensed under the MIT License.
+Feel free to use it for any project.
+
+Tumblr is Copyright (c) Tumblr, Inc. The Curate Tumblr gem is NOT affiliated with Tumblr, Inc.

data/curate_tumblr.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |gem|
+	gem.add_dependency 'tumblr_client'
+	gem.add_dependency 'logger'
+	gem.name = 'curate_tumblr'
+	gem.version = '1.0.3'
+	gem.authors = ['David Tysman']
+	gem.description = 'CurateTumblr - reblog and follow Tumblr links'
+	gem.summary = 'Reblog and follow Tumblr'
+	gem.email = 'web@davidtysman.com'
+	gem.files = `git ls-files`.split("\n")
+	gem.homepage = "https://github.com/davidtysman/curate_tumblr"
+end

data/example/kubricklove/kubricklove_config.yaml

@@ -0,0 +1,20 @@
+client:
+  is_running:             true
+  sleep_before_client_min:    1
+  sleep_before_client_max:    3
+  sleep_before_follow_min:    3*60
+  sleep_before_follow_max:    6*60
+  max_requests_and_posts: 80
+  max_posted:             50
+  max_reblogged:          40
+  max_followed:           30
+  oauth:
+    consumer_key:        ""
+    consumer_secret:     ""
+    token:               ""
+    token_secret:        ""
+
+infos:
+  tags:                  "kubrick, film, classic"
+  title:                 "Kubrick Love <br>&nbsp;&nbsp;&nbsp;&nbsp;Kubrick Photos, Films & Secrets"
+

data/example/kubricklove/links/kubricklove_links

@@ -0,0 +1,4 @@
+http://joshbrooksonfilm.tumblr.com/post/58294445822/barry-lyndon-1975-kubrick-1st-viewing-if-i
+http://www.tumblr.com/reblog/58327106557/9riXdZGo?redirect_to=%2Ftagged%2Fstanley-kubrick
+http://withoutjudgementwhatwouldwedo.tumblr.com/post/58321322530/this-is-my-rifle-there-are-many-like-it-but-this
+http://oh-lesedi.tumblr.com/

data/example/kubricklove_follow.rb

@@ -0,0 +1,6 @@
+require "curate_tumblr"
+
+CurateTumblr.follow( "kubricklove", "./" )
+
+
+

data/example/kubricklove_reblog.rb

@@ -0,0 +1,6 @@
+require "curate_tumblr"
+
+CurateTumblr.reblog( "kubricklove", "./" )
+
+
+

data/example/readme

@@ -0,0 +1,9 @@
+Reblog and follow tumblr links in the queue of a (fictive) kubricklove.tumblr.com
+
+kubricklove_reblog.rb :
+For each tumblr link, it puts the link in queue with tags and title, puts the tumblr and the source in tofollow links, and search in content if there is any link to follow or to add to external links    
+Reblog and Follow scripts set the tumblr name and the folder for config, links and logs.
+
+Important : this tumblr doesn't exist and oauth in config yaml is empty
+You can copy this example and make it work by replacing "kubricklove" by your tumblr name and set valid oauth in config file 
+To config oauth please follow the tumblr documentation (your tumblr must give the authorization to the application) : http://www.tumblr.com/docs/en/api/v2#blog-likes

data/lib/curate_tumblr.rb

@@ -0,0 +1,25 @@
+require 'tumblr_client'
+require 'logger'
+require 'yaml'
+
+require 'curate_tumblr/tumblr/client'
+require 'curate_tumblr/tumblr/infos'
+require 'curate_tumblr/tumblr/extract_links'
+
+require 'curate_tumblr/publish/post'
+require 'curate_tumblr/publish/reblog'
+require 'curate_tumblr/publish/follow'
+
+require 'curate_tumblr/curator'
+
+require 'curate_tumblr/values'
+require 'curate_tumblr/utilities/utilities'
+require 'curate_tumblr/utilities/monkey'
+
+require 'curate_tumblr/render/render_links'
+require 'curate_tumblr/render/render_reblog'
+require 'curate_tumblr/render/render_follow'
+
+
+
+

data/lib/curate_tumblr/curator.rb

@@ -0,0 +1,200 @@
+
+module CurateTumblr
+
+  def self.reblog( tumblr_name, directory, is_display_infos=true )
+    Render::RenderLinks.render( Render::RenderReblog.new( tumblr_name, directory ), __method__, is_display_infos )
+  end  
+
+  def self.follow( tumblr_name, directory, is_display_infos=true )
+    Render::RenderLinks.render( Render::RenderFollow.new( tumblr_name, directory ), __method__, is_display_infos )
+  end     
+
+  class Curator
+    include Tumblr::Client
+    include Tumblr::Infos
+    include Tumblr::ExtractLinks
+    include Publish::Follow
+    include Publish::Reblog
+    include Publish::Post
+
+   	attr_accessor :tumblr_name, :is_stop, :is_debug, :log_tumblr, :directory
+
+    class << self
+      def create_config_yaml_file( file_yaml, hash_config )
+        check_config_hash( hash_config )
+        document = get_string_yaml_from_config( hash_config )
+        File.open( file_yaml, "w+") { |file| file.puts( document ) }
+      end
+
+      def get_string_yaml_from_config( hash_config )
+        Tumblr::Client::get_string_yaml_from_client_config( hash_config ) + "\n\n" +
+        Tumblr::Infos::get_string_yaml_from_infos_config( hash_config ) 
+      end
+   
+      def check_config_hash( hash_config )
+        raise "config must be a Hash instead of #{hash_config.class}" if !hash_config.is_a?( Hash )
+        Tumblr::Client::check_client_config_hash( hash_config )
+        Tumblr::Infos::check_infos_config_hash( hash_config )
+        hash_config
+      end
+    end      
+
+    # --- config ---
+
+   	def initialize( tumblr_name, directory='/home/tumblr' )
+      @tumblr_name = tumblr_name
+      @directory = directory 
+
+      init_tumblr!
+      check_config
+      @is_debug = false
+ 		end
+
+ 		def init_tumblr!( hash_config={} )
+       hash_config = get_config_from_yaml if hash_config.empty?
+       set_log
+			 init_client!( hash_config )
+       init_infos!( hash_config )
+       init_extract_links!( hash_config )
+       init_follow!( hash_config )
+       init_reblog!( hash_config )
+       init_post!( hash_config )
+       @is_stop = false    
+ 		end
+
+    def config_from_yaml
+      hash_config = get_config_from_yaml
+      config_client( hash_config )
+      config_infos( hash_config )
+    end      
+
+    def get_config_from_yaml
+      file_yaml = get_filename_config
+      raise "config file YAML #{file_yaml} doesn't exist" if !File.exist?( file_yaml )
+      begin
+        documents = YAML::load_documents( File.open( file_yaml ) )
+      rescue => exception
+        raise "can't load config from YAML #{file_yaml} : #{exception} "
+      end
+      raise "config from YAML #{file_yaml} is empty" if documents.empty?
+      Curator.check_config_hash( documents.first )
+    end  
+
+    def check_config
+      raise "directory is empty" if @directory.empty?
+      raise "tumblr_name is empty" if @tumblr_name.empty?
+      check_client_config
+      check_infos_config
+    end
+
+    # --- options ---
+
+    def stop_it!( reason='' )
+      @is_stop = true
+      @log_tumblr.warn( "stop it because " + reason ) if !reason.empty?
+    end       
+
+    def debug
+      @is_debug = true
+    end      
+
+    def can_run?
+      return false if self.is_stop
+      true
+    end
+
+    # --- files ---
+
+    def add_tofollow_tofile( is_delete_tofollow=true )
+      @all_tofollow_urls = CurateTumblr.get_format_tumblr_urls( @all_tofollow_urls )
+      return false if !CurateTumblr.add_set_tofile_without_repeat( get_filename_tofollow, @all_tofollow_urls  ) 
+      @all_tofollow_urls = Set.new if is_delete_tofollow
+      true
+    end       
+
+    def add_externallinks_tofile( is_delete_externallinks=true )
+      @all_external_links = CurateTumblr.get_format_urls( @all_external_links)
+      return false if !CurateTumblr.add_set_tofile_without_repeat( get_filename_external_links, @all_external_links ) 
+      @all_external_links = Set.new if is_delete_externallinks
+      true
+    end    
+
+    # --- paths ---
+
+    def get_path_tumblr
+      @directory + "/" + @tumblr_name
+    end
+
+    def get_path_logs
+      get_path_tumblr + "/logs" 
+    end
+
+    def get_path_links
+      get_path_tumblr + "/links"
+    end
+
+    def get_path_config
+      get_path_tumblr 
+    end
+
+    def get_filename_config
+      get_path_config + "/" + @tumblr_name + "_config.yaml"
+    end
+
+    def get_filename_values
+      get_path_config + "/" + @tumblr_name + "_values.yaml"
+    end
+
+    def get_filename_log
+      get_path_logs + "/" + @tumblr_name + "_log"
+    end
+
+    def get_filename_errors
+      get_path_logs + "/" + @tumblr_name + "_errors"
+    end      
+
+    def get_filename_links
+      get_path_links + "/" + @tumblr_name + "_links"
+    end
+
+    def get_filename_tofollow
+      get_path_links + "/" + @tumblr_name + "_tofollow"
+    end
+
+    def get_filename_external_links
+      get_path_links + "/" + @tumblr_name + "_external_links"
+    end
+
+    def set_log
+      @log_tumblr = Logger.new( get_filename_log )
+    end
+
+    def new_log( info )
+      default_log
+      @log_tumblr << "\n"
+      @log_tumblr.info( info )
+    end
+
+    private
+
+    def stop_and_alert(message, is_display=true, is_log=true )
+      @log_tumblr.error( message ) if is_log
+      puts "\n*** Stop it ! #{message} ***" if is_display
+      stop_it!
+    end  
+
+    def error( method, message, hash_infos={} )
+      error = "#{@domain} : #{message} in #{method} "
+      if !hash_infos.empty?
+      error = error + " with" 
+      hash_infos.each { |key, value| error = error + " [#{key} : #{value}]" }
+      end
+      @log_tumblr.error( error )
+     end
+       
+    def return_error( method, message, hash_infos={} )
+      error( method, message, hash_infos )
+      false
+    end    
+  end
+end