wikian 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c71c17137f4f13b8c1ac7da558e1219fd50a4fc425fc22fa2d7d2060c10af91
-  data.tar.gz: 579e18baa7d5c2a3fd3c0639561401212eac11ed6e623de3de7f8f200d0f2d3e
+  metadata.gz: 4365188a029e7d0d76f906b95ed64da8c5a8e6bdca0f31aa7b6fabde41d228be
+  data.tar.gz: 464993485465534f4d43fc7162d224780ed11ccf40bad13c0d66dda6e3de0b14
 SHA512:
-  metadata.gz: 89a90e0003596d229cc1cf3dfffb3f6313cd76e475c943bcfbb0c7b3b9755d0a0eec32e4857ebca2cd90fc81254ac46212358ad975590516c132eeeda7c7aa22
-  data.tar.gz: 73090be30a37ed6a8319e2bde35ec3301a6196bd747fbc95089125f01cc0a8ebed731c2675f08d4df3d602a937b233693020109b29abacadc4168b6db757f34c
+  metadata.gz: 8b7393793bb7f0c62d1e1a3910a1a99e39c7abd4e0e2374eaf7e376f2cbc125734543feb3a16cda505668b7cb09dd90d35903c87367293d82afc9c408d9768d6
+  data.tar.gz: 3c2ccd2cb6a1b753175a9b0a9bd0b545ea6ea3346418a17bd555df28e9bce88b4c236fab0a800018a9839c0a3e76c21abcff3e62acfdfd140c043e2b6cbb91bd

data/.gitignore

@@ -1,15 +1,6 @@
-# files without extensions except directories
-*
-!/**/
-!?*.*
-
 # directories
-.bundle/
-_yardoc/
-coverage/
 doc/
 pkg/
-spec/reports/
 tmp/
 vendor/
 
@@ -22,6 +13,7 @@ vendor/
 .*.swp
 .DS_Store
 .byebug
+.byebugrc
 .idea
 .project
 .rake*
@@ -46,12 +38,3 @@ secrets.yml
 ![MR]akefile
 !bin/**/[^.]*
 !exe/**/[^.]*
-
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wikian (0.1.2)
+    wikian (0.1.7)
 
 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)?
+Me too, that's why I use [Wikian](https://rubygems.org/gems/wikian) which lets me edit wikipedia pages locally, with my 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 the article in your favorite text editor 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 out [mediawiki.vim](https://en.wikipedia.org/wiki/Help:Text_editor_support#Vim) which defines 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
@@ -47,11 +31,13 @@ class Wikian
   def run
     if args.have?(%w(-h --help))
       help
+    elsif args.have?(%w(-v --version))
+      version
     end
 
     @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)
@@ -60,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
@@ -81,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
@@ -119,4 +110,9 @@ class Wikian
     eos
     exit
   end
+
+  def version
+    puts "wikian #{VERSION}"
+    exit
+  end
 end

data/lib/wikian/contributions.rb

@@ -0,0 +1,49 @@
+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
+        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

@@ -13,6 +13,8 @@ class Wikian
 
       url = URI(args.find{|arg| arg =~ URI.regexp})
 
+      raise BadUrlError unless url.path
+
       @title = File.basename(url.path)
 
       @output_file = title + '.' + url.host
@@ -23,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
 
@@ -54,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|
@@ -65,7 +66,7 @@ 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
 
@@ -81,15 +82,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,7 +14,7 @@ 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
 
@@ -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
@@ -60,7 +68,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.2"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wikian
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - sergioro
@@ -32,7 +32,9 @@ 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