wikian 0.1.5 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7641f6124dd8e9db31fa2dc7688146107db693d65d8347af57d45ee40205519
-  data.tar.gz: a9def9f5d7d2cc6a00c375f9e690e96aaf193a601359ae98fb1f4abea1f31402
+  metadata.gz: 9b9d29a2c2542c0fab6ff8a49f2f3803250b497956b62b1ae4985e6edfb1aead
+  data.tar.gz: 524ab9f53e433589678b3751bac059fcec6293b2620f89523285dee5d5db75a0
 SHA512:
-  metadata.gz: d7887e82d7f20332717314772cba3ca4bbb4d7cb54d5a1dab3235f1c248654949c3427feaa6915324b437117d0e87147c219a2acbed7654ddeb22c89541abc50
-  data.tar.gz: 37998e9226c13ddfa504921859e4da1f9f8e96a19edcc617faaf30a7a387d80fff4768e29c868f9ebfb363c168baaada1f3280cbc241c3f91c10c732e378c790
+  metadata.gz: 12844ea63af9aba3181ace13c9f1c36dfb7448df719925f21bc93a4e15ec105e1846bfbbb47cb8101432682674bfb895baaefca22df5e1d45d6d76dbc821002e
+  data.tar.gz: 2e4eba98c8ba630050bf650b496f3221e388449ae963ab78c49cd0acf8708d76293905909e7bccd613a56eb5bb94bd5c9c5d239cb3fe3f4658bdafae6f872361

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wikian (0.1.5)
+    wikian (0.1.10)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,7 +1,8 @@
 # Wikian
 
-Want to be happier while editing wiki files?
-Me too, that's why I use [Wikian](https://rubygems.org/gems/wikian):
+Want to be a happier [Wikipedian](https://en.wikipedia.org/wiki/Wikipedia:Wikipedians)?
+Then you want [Wikian](https://rubygems.org/gems/wikian), which lets you edit Wikipedia pages locally, with your favorite text editor.
+To install it:
 
 ```
 $ gem install wikian
@@ -39,7 +40,7 @@ $ cat User:$WIKI_USER.en.wikitionary.org.wiki
 == Last section==
 testing
 
-$ wi post -p User:$WIKI_USER.en.wikitionary.org.wiki
+$ wi post -a User:$WIKI_USER.en.wikitionary.org.wiki
 Article uploaded
 ```
 
@@ -55,12 +56,38 @@ Writing to Wikipedia:Sandbox.en.wikipedia.org.json
 Writing to Wikipedia:Sandbox.en.wikipedia.org.wiki
 ```
 
-You can then edit the the article in your favorite text editor and uploaded:
+Then edit the article and upload it:
 
 ```bash
 $ wi post Wikipedia:Sandbox.en.wikipedia.org.wiki
 Article uploaded
 ```
 
-Vim users should try out [mediawiki.vim](https://en.wikipedia.org/wiki/Help:Text_editor_support#Vim) which defines syntax highlighting and abbreviations for wikitext files.
+To append wikitext to section 2:
 
+```bash
+$ wi post -s 2 Wikipedia:Sandbox.en.wikipedia.org.wiki
+Article uploaded
+```
+
+To search for a pattern in Wikipedia:
+
+```
+$ wi search -t
+Creating template wiki.yml
+
+$ wi s
+Writing to Mr. Fixit.json
+```
+
+To get your last 10 Wikipedia contributions:
+
+```
+$ wi c -t
+Creating template wiki.yml
+
+$ wi c
+Writing to User:Example_User.contributions.en.wikipedia.org.json
+```
+
+Vim users should try [mediawiki.vim](https://en.wikipedia.org/wiki/Help:Text_editor_support#Vim) which adds syntax highlighting and abbreviations for wikitext files.

data/lib/wikian.rb

@@ -1,7 +1,9 @@
 $LOAD_PATH.unshift __dir__
 
 require 'wikian/subcommand'
+require 'wikian/contributions'
 require 'wikian/get'
+require 'wikian/monkeypatches'
 require 'wikian/post'
 require 'wikian/search'
 require 'wikian/version'
@@ -13,24 +15,6 @@ require 'net/http'
 require 'open-uri'
 require 'yaml'
 
-# external libraries
-require 'byebug'
-
-class Array
-  # return true if `self` and `elms` have any element in common
-  def have?(elms)
-    (self & elms).length > 0 ? true : false
-  end
-  alias_method :has?, :have?
-end
-
-class Hash
-  # return a query string representation of a hash
-  def to_query
-    URI.decode(URI.encode_www_form(self))
-  end
-end
-
 class Wikian
   class WikianError < StandardError; end
   class UnknownSubcommandError < WikianError; end
@@ -53,7 +37,7 @@ class Wikian
 
     @subcommand = args.shift
 
-    raise(UnknownSubcommandError, "Unkown Subcommand") unless %w(g p s get post search).include?(subcommand)
+    raise(UnknownSubcommandError, "Unkown Subcommand") unless %w(c g p s contributions get post search).include?(subcommand)
 
     if subcommand[0] == 'g'
       api = Wikian::Get.new(args)
@@ -62,13 +46,16 @@ class Wikian
     elsif subcommand[0] == 's'
       api = Wikian::Search.new(args)
       api.doit
+    elsif subcommand[0] == 'c'
+      api = Wikian::Contributions.new(args)
+      api.doit
     else
       api = Wikian::Post.new(args)
       api.post
     end
 
   rescue UnknownSubcommandError => e
-    puts "#{e.class} #{e.message}"
+    puts "#{e.class} #{e.message} in #{__FILE__}"
   end
 
   def help
@@ -83,13 +70,15 @@ class Wikian
         -m, --message MESSAGE      add a commit message (HIGHLY recommended)
         -p, --prepend              prepend the input file
         -r, --remove-cookie        remove API cookie
+        -s, --section NUMBER       section to edit
         -t, --template             create template configuration file
         -v, --version
 
       Subcommands:
-        g, get           get wikitext file from a wikipedia article
-        p, post          post wikitext file to a wikipedia article
-        s, search        search wikitext file to a wikipedia article
+        c, contributions [N]    get user last N contributions. N defaults to 20
+        g, get                  get wikitext file from a wikipedia article
+        p, post                 post wikitext file to a wikipedia article
+        s, search               search wikitext file to a wikipedia article
 
       Examples:
         # create wiki.yml template

data/lib/wikian/contributions.rb

@@ -0,0 +1,50 @@
+class Wikian
+  class WikianGetError < StandardError; end
+  class ExtractWikiError < WikianGetError; end
+  class ArgumentRequiredError < WikianGetError; end
+
+  class Contributions < Subcommand
+    DEFAULT_MAX_CONTRIBUTIONS = 20
+
+    def initialize(args)
+      super
+
+      max_contributions = args.find(&:numeric?) || DEFAULT_MAX_CONTRIBUTIONS
+
+      raise(BadUrlError, "Try passing the '-t' option") unless yaml['meta']['site']
+
+      @output_file = 'User:' +  ENV['WIKI_USER'] + '.contributions.' + yaml['meta']['site']
+
+      @params.merge!('ucuser' => ENV['WIKI_USER'], 'uclimit' => max_contributions, 'format' => Wikian::RESPONSE_FORMAT)
+
+      @query = @params.to_query
+
+      @api_url = URI("https://#{yaml['meta']['site']}/w/api.php?#{query}")
+    rescue => e
+      puts "#{e.class} in #{__FILE__}. #{e.message}"
+      exit
+    end
+
+    def template
+      <<~eos
+        # for a list of parameters to use here see: https://www.mediawiki.org/wiki/API:Usercontribs
+        meta:
+          http_method: get
+          site: en.wikipedia.org
+          headers:
+            #accept-encoding: gzip
+            user-agent:  Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:60.0) Gecko/20100101 Firefox/60.0
+        api:
+          action:
+            - query
+          list:
+            - usercontribs
+          ucprop:
+            - title
+            - comment
+            - timestamp
+            - sizediff
+      eos
+    end
+  end
+end

data/lib/wikian/get.rb

@@ -2,7 +2,6 @@ class Wikian
   class WikianGetError < StandardError; end
   class ExtractWikiError < WikianGetError; end
   class ArgumentRequiredError < WikianGetError; end
-  class BadUrlError < WikianGetError; end
 
   class Get < Subcommand
     attr_accessor :title
@@ -26,7 +25,7 @@ class Wikian
 
       @api_url = URI("https://#{url.host}/w/api.php?#{query}")
     rescue => e
-      puts "#{e.class} #{e.message} in #{__FILE__}"
+      puts "#{e.class} in #{__FILE__}. #{e.message}"
       exit
     end
 
@@ -57,7 +56,6 @@ class Wikian
 
       # this is ugly, but Wikipedia is inconsistent in their JSON value for 'pages'. Sometimes it's a hash, sometimes it's an array.
       if pages.respond_to? :keys
-        byebug
         create_wiki.call(pages.values.first['title'], pages.values.first['revisions'])
       else
         pages.each do |page|
@@ -68,12 +66,13 @@ class Wikian
     rescue => e
       puts "An error occurred while extracting the wikitext",
            "Try using a new config file by pasing the '-t' option.",
-           "Or pass '-d' option for debugging"
+           "Or pass the '-d' option for debugging"
       exit
     end
 
     def template
       <<~eos
+        # for a list of parameters to use here see: https://www.mediawiki.org/wiki/API:Get_the_contents_of_a_page
         meta:
           headers:
             user-agent: Wikian
@@ -84,15 +83,13 @@ class Wikian
             - revisions
           rvprop:
             - content
-              #rvsection:
-              #  - 0
-              #  - 2
+          #rvsection: # get specific sections
+          #  - 0
+          #  - 2
           rvslots:
             - main
           formatversion:
             - 2
-          format:
-            - json
       eos
     end
   end

data/lib/wikian/monkeypatches.rb

@@ -0,0 +1,24 @@
+class Array
+  # return true if `self` and `elms` have any element in common
+  def have?(elms)
+    (self & elms).length > 0 ? true : false
+  end
+  alias_method :has?, :have?
+end
+
+class Hash
+  # return a query string representation of a hash
+  def to_query
+    URI.decode(URI.encode_www_form(self))
+  end
+end
+
+class String
+  # check is a string is numeric
+  #
+  # usage: 'asdf'.numeric? # => false
+  #        '5.1'.numeric?  # => true
+  def numeric?
+    Float(self) != nil rescue false
+  end
+end

data/lib/wikian/post.rb

@@ -23,7 +23,7 @@ class Wikian
 
       @debug = (args & %w(-d --debug)).length > 0 ? true : false
     rescue => e
-      puts "#{e.class} in #{__FILE__}"
+      puts "#{e.class} in #{__FILE__}. #{e.message}"
       exit
     end
 
@@ -107,12 +107,15 @@ class Wikian
         # pass the wikitext in request body
         @body_text = wikitext
       end
-      if args.include?('-c')
+      if args.have?(%w(-c --captcha))
         params['captchaid'], params['captchaword'] = args[args.index('-c')+1].split(':')
       end
-      if args.include?('-m')
+      if args.have?(%w(-m --message))
         params['summary'] = args[args.index('-m')+1]
       end
+      if args.have?(%w(-s --section))
+        params['section'] = args[args.index('-s')+1]
+      end
       @query = URI.encode_www_form(params)
     end
 

data/lib/wikian/search.rb

@@ -14,13 +14,13 @@ class Wikian
 
       @api_url = URI("https://#{yaml['meta']['site']}/w/api.php?#{query}")
     rescue => e
-      puts "#{e.class} #{e.message} in #{__FILE__}"
+      puts "#{e.class} in #{__FILE__}. #{e.message}"
       exit
     end
 
     def template
       <<~eos
-        # Get last 5 revisions of the Main Page.
+        # for a list of parameters to use here see: https://www.mediawiki.org/wiki/API:Search
         meta:
           site: en.wikipedia.org
           headers:
@@ -30,10 +30,8 @@ class Wikian
             - query
           list:
             - search
-          srsearch:
-            - Craig Noone
-          format:
-            - json
+          srsearch: # text to search for. You can use multiple
+            - Mr. Fixit
       eos
     end
   end

data/lib/wikian/subcommand.rb

@@ -1,5 +1,9 @@
 #!/usr/bin/env -S ruby -W0
 class Wikian
+  class WikianSubcommandError < StandardError; end
+  class MissingConfigFileError < WikianSubcommandError; end
+  class BadUrlError < WikianSubcommandError; end
+
   # class to be inherited by other Wikian classes
   class Subcommand
     attr_accessor :args, :res, :yaml, :query, :title, :api_url, :debug, :output_file
@@ -15,10 +19,14 @@ class Wikian
 
       @debug = (args & %w(-d --debug)).length > 0 ? true : false
 
+      raise MissingConfigFileError unless File.exist?(Wikian::CONFIG_FILE)
       @yaml=YAML.load(File.open(Wikian::CONFIG_FILE))
 
       # some params like 'titles' can contain multiple entries joined by '|'. More info in Wikipedia API docs
       @params = Hash[yaml['api'].keys.zip(yaml['api'].values.map{|arr| arr.join("|")})]
+    rescue MissingConfigFileError => e
+      puts "#{e.class} try passing the '-t' option to generate #{Wikian::CONFIG_FILE} in #{__FILE__}"
+      exit
     end
 
     def make_template
@@ -28,9 +36,7 @@ class Wikian
         (puts 'Bye'; exit) if answer != 'y'
       end
 
-      File.open(CONFIG_FILE, 'w') do |f|
-        f.write template
-      end
+      File.write(CONFIG_FILE, template)
       exit
     end
 
@@ -60,7 +66,7 @@ class Wikian
 
       write_response
     rescue => e
-      puts "#{e.class} #{e.message} in #{__FILE__}"
+      puts "#{e.class} in #{__FILE__}. #{e.message}"
       exit
     end
 

data/lib/wikian/version.rb

@@ -1,3 +1,3 @@
 class Wikian
-  VERSION = "0.1.5"
+  VERSION = "0.1.10"
 end

data/wikian.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["sergioro"]
   spec.email         = ["yo@sergioro.com"]
 
-  spec.summary       = %q{Get and edit wikipedia articles}
-  spec.description   = %q{Get and edit wikipedia articles}
-  #spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.summary       = %q{Get and update Wikipedia articles}
+  spec.description   = %q{Get and update Wikipedia articles}
+  spec.homepage      = "https://sergioro.mx/posts/wikian"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: wikian
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.10
 platform: ruby
 authors:
 - sergioro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-09-13 00:00:00.000000000 Z
 dependencies: []
-description: Get and edit wikipedia articles
+description: Get and update Wikipedia articles
 email:
 - yo@sergioro.com
 executables:
@@ -32,13 +32,15 @@ files:
 - exe/wikian
 - lib/.gitignore
 - lib/wikian.rb
+- lib/wikian/contributions.rb
 - lib/wikian/get.rb
+- lib/wikian/monkeypatches.rb
 - lib/wikian/post.rb
 - lib/wikian/search.rb
 - lib/wikian/subcommand.rb
 - lib/wikian/version.rb
 - wikian.gemspec
-homepage: 
+homepage: https://sergioro.mx/posts/wikian
 licenses:
 - MIT
 metadata: {}
@@ -60,5 +62,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Get and edit wikipedia articles
+summary: Get and update Wikipedia articles
 test_files: []