tumblr_autofixer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a18737fe7b0fb91a113773ec90fbeda392143412
+  data.tar.gz: 970f4f5303a3137a2df386d7615b290494d09ecc
+SHA512:
+  metadata.gz: c94e3ff20eab1b4d230b26fd90ffe419ff14344d2363b57b2216561ba4baaca3ecc95e63e36eb58b66da3ed5c3c8c4862647cc40efff3f12bf83251527e2659b
+  data.tar.gz: 29217d34b0bb4157ef8bdff68368ec3b69724a472817bebe5a88651a71a420dc4511e670f2c514cd7a02968068bcd604d9e2460ea8f30ca576d5858c8a06d2a6

data/README.md

@@ -0,0 +1,58 @@
+# About  
+\- tumblr_autofix is a configurable comment generator for Tumblr.  
+\- Two configuration files are created in your home directory: taf_data.yml & taf_summary.yml  
+\- Careful when editing configuration files, as with all YAML files, indentation is crucial!   
+
+# Using ~/config_md/taf/data.yml
+no_names [Array]   - Blogs listed here will be ignored during processing  
+summary  [Array]   - Will apply capitalization, add prefix and postfix strings  
+last_tag [Array]   - Use the last available tag as your comment  
+tag_idx  [[Array]] - Indicated which tag to use as the new comment  
+  - Blogs listed in the first tag_idx[0] will use the first tag  
+  - Blogs listed in tag_idx[1] will use the second  
+
+
+# Using ~/config_md/taf/summary.yml  
+## Available variables  
+  \- `summary` - the plain text of the current post's caption  
+  \- `res`     - lower case version of summary, useful for simplified text searching  
+  \- `from`    - the blog name of the user you reblogged the post from  
+  \- `lines`   - original summary text, split into lines  
+
+## Returning  
+  \- using `return <value>` in your summary.yml will make that string your new comment  
+  \- storing your new comment in the `res` variable, without explicitly returning it, will subject it to a couple more modifications:  
+  1. capitalization - each word in the string will be capitalized  
+  2. prefix  - a string passed via the `-p <PREFIX>` option will be prepended to `res`  
+  3. postfix - a string passed via the `-P <POSTFIX>` option will be appended to `res`  
+
+## Summary Example  
+
+### Get the title from the first line, then add the author  
+Update ~/config_md/taf/summary.yml with the following
+```
+:angulargeometry:  
+- title = summary.split("\n")[0]  
+- return "#{title} by Angular Geometry"  
+```
+
+###  Add prefix & postfix to formatted strings  
+1 - Update ~/config_md/taf/summary.yml  
+note: string must be stored in the `res` variable for pre/postfixing to work
+```
+:kazu721010:  
+- title, architect = lines[0].split('/')  
+- photographer = lines[2].split("©").last  
+- res = "project: #{title}\narchitect: #{architect}\nphotographer: #{photographer}"  
+```
+2 - Run Autofixer with options: `taf -p '**\n' -P '\n--'`   
+
+
+3 - Resulting caption for kazu721010 posts:  
+```
+**  
+Project: Project Title  
+Architect: Architect Or Firm Name  
+Photographer: Photographers Name  
+--  
+```

data/bin/taf

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'tumblr_draftking'
+require_relative '../lib/tumblr_autofixer'
+# require File.join(Dir.home, '/coding/ruby/tumblr_autofixer/lib/tumblr_autofixer') # DEV ONLY - Run development source using system installed cli
+
+DK::Idable.new(ARGV)

data/lib/autofixer/commands/open_results.rb

@@ -0,0 +1,14 @@
+module DK
+  class Idable
+    def open_results(args)
+      return unless args.include?('open')
+      file = confile('needs_review.html')
+      `open #{file}` && exit(0) if File.exist?(file)
+      puts
+      puts 'Error:'
+      puts '  No results have been generated yet.'
+      puts
+      exit(0)
+    end
+  end
+end

data/lib/autofixer/commands/show_help.rb

@@ -0,0 +1,24 @@
+module DK
+  class Idable
+    def show_help(args, opts)
+      return unless (args.include?('help') || opts.find_index('-h'))
+      puts 'Usage: '
+      puts '  $ taf <command?> [options?]'
+      puts
+      puts ' Commands:'
+      puts '    help   Show this menu.'
+      puts '    show   Open a webpage with the latest taf results.'
+      puts
+      puts ' Options:'
+      puts '    -s             Simulate Run (no changes saved)'
+      puts '    -p [STRING]    Prefix for generated comments'
+      puts '    -P [STRING]    Prefix for generated comments'
+      puts '    -S [STRING]    Separator used between prefix/postfix and generated comment text.'
+      puts '    -l [INTEGER]   Number of Drafts to select for processing.'
+      puts '    --clear        Clear unprocessible Drafts by adding the given prefix (-p [STRING])'
+      puts '                    causing these posts to show as "Already Processed" in future runs.'
+      puts '    --show         Open the results webpage after processing is complete.'
+      exit(0)
+    end
+  end
+end

data/lib/autofixer/commands/show_version.rb

@@ -0,0 +1,10 @@
+module DK
+  class Idable
+    def show_version(opts)
+      return unless opts.include?('-v')
+      puts "\ntumblr_autofixer v#{VERSION}"
+      puts
+      exit(0)
+    end
+  end
+end

data/lib/autofixer/data_store.rb

@@ -0,0 +1,46 @@
+module DK
+  class Idable
+    private
+
+    def store(dstore, key, value)
+      dstore.transaction do
+        dstore[key] = value
+      end
+    end
+
+    def restore(dstore, key, default=nil)
+      dstore.transaction do
+        dstore[key] || default
+      end
+    end
+
+    def prep_user_data_files
+      ex_blog_name = 'example-blog-name'
+      keys = [:no_names, :last_tag, :tag_idx, :summary]
+      keys.each do |key|
+        unless restore(@ystore, key)
+          value = []
+          case key
+          when :no_names
+            value << 'Ignore the following blogs during processing.'
+            value << ex_blog_name
+          when :last_tag
+            value << 'Use the last available tag for these blogs.'
+            value << ex_blog_name
+          when :tag_idx
+            value = [
+              ['Use tag #1 for these blogs.', ex_blog_name],
+              ['Use tag #2 for these blogs.', ex_blog_name],
+              ['Use tag #3 for these blogs.', ex_blog_name]
+            ]
+          when :summary
+            value << 'Capitalize, add prefix and postfix to existing summary text'
+            value << ex_blog_name
+          end
+          store(@ystore, key, value)
+        end
+      end
+    end
+
+  end
+end

data/lib/autofixer/helpers.rb

@@ -0,0 +1,41 @@
+module DK
+  class Idable
+    private
+
+    def dk_opts
+      { simulate: @simulate, limit: @limit }
+    end
+
+    def capitalize(s)
+      return if s.nil?
+      res = s.gsub(/\d/,'').split(' ').map(&:strip).map(&:capitalize)
+      return res[0] if res.size < 2
+      res.join(' ')
+    end
+
+    def prefix(s)
+      "#{@prefix}#{' ' + @spliter + ' ' if @spliter}#{s}#{@postfix}"
+    end
+
+    def link_to_edit(post)
+      id = post.id rescue post['id']
+      "https://www.tumblr.com/edit/#{id}"
+    end
+
+    def pad(value, reference, prefix=nil)
+      s = value.to_s
+      r = reference.to_s.length
+      if prefix
+        s = ' ' + s while (s.length < r)
+      else
+        s += ' ' while (s.length < r)
+      end
+      s
+    end
+
+    def home_file(file)
+      DK::Config.home_path_file(file)
+    end
+
+  end
+end

data/lib/autofixer/results.rb

@@ -0,0 +1,134 @@
+module DK
+  class Idable
+    private
+
+    def bfrom(post)
+      post.trail.first.blog.name rescue '-no trail-'
+    end
+
+    def show_results
+      cli_header
+
+      fname1 = confile('already_processed.html')
+      fname2 = confile('need_review.html')
+      fname3 = confile('updated.html')
+
+      @file_index = [
+        ["Needs Review (#{@need_review.size})", fname2],
+        ["Updated (#{@updated.size})", fname3],
+        ["Already Processed (#{@already_processed.size})", fname1]
+      ]
+
+      msg1  = "(#{@already_processed.size}) Drafts are ready to be queued."
+      msg2  = "(#{@need_review.size}) Drafts need visual review."
+      msg3  = "(#{@updated.size}) Drafts were Autofixed."
+
+
+      # Already Processed
+      @already_processed.sort_by!{ |x| x.id }
+      generate_review_webpage(@already_processed, fname1, msg1)
+
+      # Need Review
+      @need_review.sort_by! do |x|
+        bname = bfrom(x)
+        [bname, x.id]
+      end
+      generate_review_webpage(@need_review, fname2, msg2)
+
+      # updated
+      @updated.sort_by!{ |x| bfrom(x)}
+      generate_review_webpage(@updated, fname3, msg3)
+
+      puts
+      puts
+      `open #{@file_index.first.last}` if @showres
+    end
+
+    def generate_review_webpage(post_info, fname, msg1='')
+      page = "<html><head>#{style}</head><body>"
+      page += page_nav
+      page += '<table>'
+      page += '<caption>'
+      page += "<p>***** SIMULATION RUN *****</p>" if @simulate
+      page += "<p>#{msg1}</p>"
+      page += "<p>Click a photo to be taken to it's edit page.</p>"
+      page += '</caption>'
+      page += table_header
+      post_info.each_slice(1) do |posts|
+        page += '<tr>'
+        posts.each{|post| page += post_image_code(post)}
+        page += '</tr>'
+      end
+      page += '</table>'
+      page += "</body></html>"
+
+      # Create directory structure and file if it doesn't exist
+      # FileUtils::mkdir_p File.dirname(fname) unless File.exist?(fname)
+      File.open(fname, 'w'){|f| f.puts page}
+      puts "** Updated file: #{fname} **:\n"
+    end
+
+    def post_image_code(post)
+      # Alt Sizes (0 - 6) Large to Small
+      photo = post.photos.first.alt_sizes[4].url
+      count = post.photos.size
+      res  = "<td><a target='_blank' href='#{link_to_edit(post)}'>"
+      res += "<img src='#{photo}'>#{'  (' + count.to_s + ')' if count > 1}</a></td>"
+      res += "<td><p>#{bfrom(post)}</p></td>"
+      res += "<td><p>#{post.comment.empty? ? '-no comment-' : post.comment}</p></td>"
+      res += "<td><p>#{post.tags.empty? ? '-no tags-' : post.tags.join(', ')}</p></td>"
+    end
+
+    def cli_header
+      puts ' '*80 + "\r\n"  # Clear any lingering text
+      if @simulate
+        puts '*'*40
+        puts '*'*14 + ' SIMULATION ' + '*'*14
+        puts '*'*40
+        puts
+      end
+      puts '_'*40
+      puts
+      puts "#{@total} drafts were retrieved."
+      puts "#{pad(@updated.size, @total, 1)} drafts were Autofixed."
+      puts "#{pad(@already_processed.size, @total, 1)} drafts were marked 'already processed'."
+      puts "#{pad(@need_review.size, @total, 1)} drafts require visual review."
+      puts '_'*40
+      puts
+    end
+
+    def page_nav
+      res = '<nav><ul>'
+      @file_index.each do |text, file|
+        res += %(<li><a href='#{file}'>#{text}</a></li>)
+      end
+      res += '</ul></nav>'
+    end
+
+    def table_header
+      res = '<thead><tr>'
+      res += '<th>Photo</th>'
+      res += '<th>Source</th>'
+      res += '<th>Caption</th>'
+      res += '<th>Tags</th>'
+      res += '</tr></thead>'
+    end
+
+    def style
+      %q(
+        <style>
+          table, tr, nav { width: 100%; text-align: center; vertical-align: middle; }
+          th { background-color: grey; border: 1px solid black; color: white; }
+          td { width: 25%; border: 1px solid gainsboro; }
+          table caption { background-color: rgb(43, 171, 171); }
+          nav { height: 100px; background-color: black; color: white; }
+          nav ul li { display: inline-block; width: 30%}
+          nav ul li a { display: inline-block; width: 100%; }
+          nav ul li:hover { background-color: rgb(43, 171, 171); }
+          a, a:visited { color: white; vertical-align: middle; line-height: 100px; }
+        </style>
+      )
+    end
+
+  end
+end

data/lib/autofixer/version.rb

@@ -0,0 +1,5 @@
+module DK
+  class Idable
+    VERSION = '0.0.1'
+  end
+end

data/lib/tumblr_autofixer.rb

@@ -0,0 +1,179 @@
+require 'tumblr_draftking'
+require 'yaml/store'
+require 'sanitize'
+require 'fileutils'
+Dir[File.join(__dir__, 'autofixer', '**', '*.rb')].each {|file| require file }
+# require 'pry'
+
+module DK
+  class Idable
+    C_LEN = 25
+    ERROR_STRING = '**'
+    def initialize(opts)
+      check_for_command(ARGV, opts)
+      extract_opts(opts)
+
+      @config_dir = home_file('/config_md/taf/')
+      @dk = DK::Client.new(dk_opts)
+
+      # Ensure my latest config files are in place.
+      `cp data.yml.bak #{confile('data.yml')}`   if File.exist?('data.yml.bak')
+      `cp summary.yml #{confile('summary.yml')}` if File.exist?('summary.yml')
+
+      read_configuration
+      @already_processed, @need_review, @updated = [], [], []
+
+      autofixer(get_informative_posts)
+      @need_review = clear(@need_review) if @clear
+      show_results
+    end
+
+    private
+
+    def read_configuration
+      # Ensure directory structure exists
+      FileUtils::makedirs @config_dir unless Dir.exist?(@config_dir)
+
+      # Ensure configuration files are present
+      @ystore   = YAML::Store.new("#{confile('data.yml')}")
+      @sstore   = YAML::Store.new("#{confile('summary.yml')}")
+      prep_user_data_files
+
+      # Cache config data
+      @last_tag = restore(@ystore, :last_tag)
+      @tag_idx  = restore(@ystore, :tag_idx)
+      @summary  = restore(@ystore, :summary)
+      @ignore   = restore(@ystore, :ignore)
+    end
+
+    def check_for_command(args, opts)
+      show_help(args, opts)
+      show_version(opts)
+      open_results(args)
+    end
+
+    def confile(fname)
+      @config_dir + fname
+    end
+
+    def extract_opts(opts)
+      @simulate = opts.include?('-s')
+      @limit    = opts[opts.find_index('-l') + 1].to_i rescue nil
+      @spliter  = opts[opts.find_index('-S') + 1] rescue ' '
+      @prefix   = opts[opts.find_index('-p') + 1] rescue ''
+      @postfix  = opts[opts.find_index('-P') + 1] rescue ''
+      @showres  = opts.find_index('--show')
+      @clear    = opts.find_index('--clear')
+    end
+
+    def get_informative_posts
+      drafts = @dk.get_posts.map{|post| DK::Post.new(post)}
+      @total = drafts.size
+      drafts.select do |draft|
+        ((@already_processed << draft) && next) if post_already_processed?(draft)
+        ((@need_review << draft) && next) unless post_has_info?(draft)
+        ((@need_review << draft) && next) unless post_has_trail?(draft)
+        true
+      end
+    end
+
+    # Post already has prefix?
+    def post_already_processed?(post)
+      summary = post.summary.chomp.strip
+      user_c  = Sanitize.fragment(post.comment).strip
+
+      user_c.start_with?(@prefix) || summary.start_with?(@prefix)
+    end
+
+    # Post has a summary or tags?
+    def post_has_info?(post)
+      summary = post.summary.chomp.strip
+      !summary.empty? || !post.tags.empty?
+    end
+
+    # Do we know where it was reblogged from?
+    def post_has_trail?(post)
+      !post.trail.empty?
+    end
+
+
+    def autofixer(posts)
+      posts.each_with_index do |post, idx|
+        tags = post.tags
+        trail_name   = post.trail.first.blog.name
+        post_summary = post.summary
+
+        ((@need_review << post) && next) if @ignore.include?(trail_name)
+        if fix_from_tag(post, trail_name)
+          next # Successfully used a tag-index to process post
+        elsif commands = restore(@sstore, trail_name.to_sym)
+          # Has custom processing of post.summary data defined
+          new_comment = special_summary(post_summary, trail_name, commands)
+        elsif @summary.include?(trail_name)
+          # Use default processing of post.summary data
+          new_comment = special_summary(post_summary, trail_name, [])
+        elsif @last_tag.include?(trail_name)
+          # Use the last available post.tags
+          new_comment = autofix(tags.last, trail_name)
+        else
+          # Don't know what to do with it.
+          new_comment = ERROR_STRING
+        end
+
+        ((@need_review << post) && next) if new_comment.eql?(ERROR_STRING)
+
+        success = update_post_comment(post, new_comment)
+        (success ? @updated : @need_review) << post
+      end
+    end
+
+    def fix_from_tag(post, blog_name)
+      @tag_idx.each_with_index do |names, idx|
+        next unless names.include?(blog_name)
+        new_comment = autofix(post.tags[idx])
+        if new_comment.eql?(ERROR_STRING)
+          # No tag at the expected tag-index
+          @need_review << post
+          return false
+        end
+        success = update_post_comment(post, new_comment)
+        (success ? @updated : @need_review) << post
+        return true
+      end
+      false
+    end
+
+    def autofix(tag, from='')
+      return ERROR_STRING if tag.nil?
+      prefix(capitalize(tag))
+    end
+
+    def update_post_comment(post, comment)
+      post.replace_comment_with(comment)
+      post.save(client: @dk.client, simulate: @dk.simulate)
+    end
+
+    def special_summary(summary, from, commands)
+      return '' if summary.nil? || from.nil?
+      lines = summary.split("\n")
+      res   = summary.downcase
+      b     = binding
+      commands.each{ |x| eval(x, b) }
+      prefix(capitalize(res))
+    end
+
+    def clear(posts)
+      error = []
+      posts.each do |post|
+        success = update_post_comment(post, @prefix)
+        (success ? @updated : error) << post
+      end
+      error
+    end
+
+  end # end of DK::Idable
+end # end of DK
+
+if __FILE__ == $0
+  DK::Idable.new(ARGV)
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: tumblr_autofixer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Meissa Dia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tumblr_draftking
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+description: "\n  Customizable automated comment generator!\n  "
+email:
+- meissadia@gmail.com
+executables:
+- taf
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/taf
+- lib/autofixer/commands/open_results.rb
+- lib/autofixer/commands/show_help.rb
+- lib/autofixer/commands/show_version.rb
+- lib/autofixer/data_store.rb
+- lib/autofixer/helpers.rb
+- lib/autofixer/results.rb
+- lib/autofixer/version.rb
+- lib/tumblr_autofixer.rb
+homepage: https://github.com/meissadia/tumblr_autofixer
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Customizable automated comment generator.
+test_files: []