wikian 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e066880739b70e35ea72420c4692f03b06edb3e166de62e4266c2fb0ed987361
-  data.tar.gz: 2844bbad116737e2325e917670bb2e91820ccc8f6d4304cf1f84e826832cc0b5
+  metadata.gz: 4365188a029e7d0d76f906b95ed64da8c5a8e6bdca0f31aa7b6fabde41d228be
+  data.tar.gz: 464993485465534f4d43fc7162d224780ed11ccf40bad13c0d66dda6e3de0b14
 SHA512:
-  metadata.gz: '065693de9893b9741bd4b6cc3ee86c66ae7c7d9406acede75cedc78dba156351f0412ce187aed004325ebd7e9c0bdb1bada66ffabf9df158b304ec2f6d178c26'
-  data.tar.gz: 50feea8fa794dfe9b53acce2cbd161bd641a6407df241c5c69ebcacfe6a5930ed9be2e68f37911d82455d143526d4ae14ce3da577b374d36b09ab725f8b77dd4
+  metadata.gz: 8b7393793bb7f0c62d1e1a3910a1a99e39c7abd4e0e2374eaf7e376f2cbc125734543feb3a16cda505668b7cb09dd90d35903c87367293d82afc9c408d9768d6
+  data.tar.gz: 3c2ccd2cb6a1b753175a9b0a9bd0b545ea6ea3346418a17bd555df28e9bce88b4c236fab0a800018a9839c0a3e76c21abcff3e62acfdfd140c043e2b6cbb91bd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wikian (0.1.6)
+    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
 ```
 
@@ -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
 ```
 
-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 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
@@ -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,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

@@ -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
 
@@ -90,8 +89,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,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
 
@@ -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
@@ -67,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.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wikian
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  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