wikian 0.1.6 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e066880739b70e35ea72420c4692f03b06edb3e166de62e4266c2fb0ed987361
-  data.tar.gz: 2844bbad116737e2325e917670bb2e91820ccc8f6d4304cf1f84e826832cc0b5
+  metadata.gz: 6a043e93eb44e9e28a9ce90970196b4ba1c3a07ed485969b699afa2cdad61591
+  data.tar.gz: a848bf0d381a11fd3836cb4eb1557f2681933e182ea84fc2243f0bead9a0840f
 SHA512:
-  metadata.gz: '065693de9893b9741bd4b6cc3ee86c66ae7c7d9406acede75cedc78dba156351f0412ce187aed004325ebd7e9c0bdb1bada66ffabf9df158b304ec2f6d178c26'
-  data.tar.gz: 50feea8fa794dfe9b53acce2cbd161bd641a6407df241c5c69ebcacfe6a5930ed9be2e68f37911d82455d143526d4ae14ce3da577b374d36b09ab725f8b77dd4
+  metadata.gz: 980ee96658d992854345d9a8e411299d6a427358cac77cf1c16d1010140706e296ba44ebac2c266d7eb12cd29635eed5fdf1ab11a102a61b5e9a1f7e651b1708
+  data.tar.gz: 81a4423049990447c690e60b5294fd0566f0d7de631b4f4083ff05ff89fabc20c5912e729e228c692da3764c4425d53cd986d2f157240d16c1df522c8858b737

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wikian (0.1.6)
+    wikian (0.1.11)
 
 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,7 +56,7 @@ Writing to Wikipedia:Sandbox.en.wikipedia.org.json
 Writing to Wikipedia:Sandbox.en.wikipedia.org.wiki
 ```
 
-Then edit the the article in your favorite text editor and upload it:
+Then edit the article and upload it:
 
 ```bash
 $ wi post Wikipedia:Sandbox.en.wikipedia.org.wiki
@@ -69,15 +70,24 @@ $ wi post -s 2 Wikipedia:Sandbox.en.wikipedia.org.wiki
 Article uploaded
 ```
 
-To search for a pattern in wikipedia:
+To search for a pattern in Wikipedia:
 
 ```
 $ wi search -t
 Creating template wiki.yml
 
-$ wi search
-Article uploaded
+$ wi s
+Writing to Mr. Fixit.json
+```
+
+To get your last 10 Wikipedia contributions:
+
 ```
+$ wi c -t
+Creating template wiki.yml
 
-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.
+$ 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
@@ -88,9 +75,10 @@ class Wikian
         -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,48 @@
+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:
+          site: en.wikipedia.org
+          headers:
+            user-agent: Wikian
+        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
 
@@ -73,6 +72,7 @@ class Wikian
 
     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
@@ -90,8 +90,6 @@ class Wikian
             - 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
 

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:
@@ -32,8 +32,6 @@ class Wikian
             - search
           srsearch: # text to search for. You can use multiple
             - Mr. Fixit
-          format:
-            - json
       eos
     end
   end

data/lib/wikian/subcommand.rb

@@ -2,6 +2,7 @@
 class Wikian
   class WikianSubcommandError < StandardError; end
   class MissingConfigFileError < WikianSubcommandError; end
+  class BadUrlError < WikianSubcommandError; end
 
   # class to be inherited by other Wikian classes
   class Subcommand
@@ -35,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
 
@@ -67,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.6"
+  VERSION = "0.1.11"
 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.6
+  version: 0.1.11
 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: []