wikian 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91aba0c780899759805ebdd5d68297d87ecce58afaac94f99d2314883c760343
-  data.tar.gz: 4b586d366edfcddc22db22a4e56255845e2da3545aee038a888b69db123f7dc4
+  metadata.gz: e066880739b70e35ea72420c4692f03b06edb3e166de62e4266c2fb0ed987361
+  data.tar.gz: 2844bbad116737e2325e917670bb2e91820ccc8f6d4304cf1f84e826832cc0b5
 SHA512:
-  metadata.gz: 513a2b007c95ba82da1c701409a3cfe3323f406a97a13215db6edf4ea72693d1f11d43198a0f0c51dd7f82ff9d428f4b91cc21fed3dd46dcd63727a9936304ba
-  data.tar.gz: 58d5b4a8873584183b7efe189f56a8f3f762ff0326989cc38610fdc793ad8bb89310b1567536362c039bd0e87f7dc653b614ffe6c5cbd3f807a4d59927a341b6
+  metadata.gz: '065693de9893b9741bd4b6cc3ee86c66ae7c7d9406acede75cedc78dba156351f0412ce187aed004325ebd7e9c0bdb1bada66ffabf9df158b304ec2f6d178c26'
+  data.tar.gz: 50feea8fa794dfe9b53acce2cbd161bd641a6407df241c5c69ebcacfe6a5930ed9be2e68f37911d82455d143526d4ae14ce3da577b374d36b09ab725f8b77dd4

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.1)
+    wikian (0.1.6)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,28 +1,35 @@
 # Wikian
 
 Want to be happier while editing wiki files?
-Try [Wikian](https://rubygems.org/gems/wikian):
+Me too, that's why I use [Wikian](https://rubygems.org/gems/wikian):
 
 ```
 $ gem install wikian
 ```
 
-To use it, first create a wikipedia account and get a user name and a password.
-Then define and export the `WIKI_USER` and `SECRET_WIKI_PASS` variables in your `.bashrc`:
+To use it create a Wikipedia account, then define and export the `WIKI_USER` and `SECRET_WIKI_PASS` variables in your `.bashrc`:
 
 ```bash
-export WIKI_USER='Example_user'
-export SECRET_WIKI_PASS='example_password'
+export WIKI_USER='Example_wiki_user_name'
+export SECRET_WIKI_PASS='example_wiki_password'
 ```
 
-Wikian works across [Wikimedia sites](https://meta.wikimedia.org/wiki/Our_projects).
-Create a file following the convention:
+Wikian works across [Wikimedia sites](https://meta.wikimedia.org/wiki/Our_projects) and follows the file naming convention:
 
 ```
 <article_name>.<site>.wiki
 ```
 
-## Examples
+Some valid file names:
+
+```
+Spider_Man.en.wikipedia.org.wiki
+Spider_Man.es.wikipedia.org.wiki
+excelsior.es.wiktionary.org.wiki
+User:Example_User.www.mediawiki.org.wiki
+```
+
+#### Examples
 
 To append some text to your Wiktionary user profile:
 
@@ -36,27 +43,41 @@ $ wi post -p User:$WIKI_USER.en.wikitionary.org.wiki
 Article uploaded
 ```
 
-To edit an article first you need to get its wikitext.
-Generate a template `wiki.yml` config:
+To get an article's wikitext:
 
-```
-wi g -t
-```
 
-Then get an article to edit
+```
+$ wi get -t
+Creating template wiki.yml
 
-```bash
-$ wi get https://en.wikipedia.org/wiki/Wikipedia:Sandbox
+$ wi g https://en.wikipedia.org/wiki/Wikipedia:Sandbox
 Writing to Wikipedia:Sandbox.en.wikipedia.org.json
 Writing to Wikipedia:Sandbox.en.wikipedia.org.wiki
 ```
 
-Edits the wiki file in Vim, \*ahem\*, in your favorite text editor.
-When ready, uploaded it:
+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), it's awesome.
+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 search
+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.
+

data/lib/wikian.rb

@@ -47,6 +47,8 @@ class Wikian
   def run
     if args.have?(%w(-h --help))
       help
+    elsif args.have?(%w(-v --version))
+      version
     end
 
     @subcommand = args.shift
@@ -81,6 +83,7 @@ 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
 
@@ -119,4 +122,9 @@ class Wikian
     eos
     exit
   end
+
+  def version
+    puts "wikian #{VERSION}"
+    exit
+  end
 end

data/lib/wikian/get.rb

@@ -2,6 +2,7 @@ class Wikian
   class WikianGetError < StandardError; end
   class ExtractWikiError < WikianGetError; end
   class ArgumentRequiredError < WikianGetError; end
+  class BadUrlError < WikianGetError; end
 
   class Get < Subcommand
     attr_accessor :title
@@ -13,6 +14,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
@@ -54,7 +57,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 +67,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,9 +83,9 @@ class Wikian
             - revisions
           rvprop:
             - content
-              #rvsection:
-              #  - 0
-              #  - 2
+          #rvsection: # get specific sections
+          #  - 0
+          #  - 2
           rvslots:
             - main
           formatversion:

data/lib/wikian/post.rb

@@ -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

@@ -30,8 +30,8 @@ class Wikian
             - query
           list:
             - search
-          srsearch:
-            - Craig Noone
+          srsearch: # text to search for. You can use multiple
+            - Mr. Fixit
           format:
             - json
       eos

data/lib/wikian/subcommand.rb

@@ -1,5 +1,8 @@
 #!/usr/bin/env -S ruby -W0
 class Wikian
+  class WikianSubcommandError < StandardError; end
+  class MissingConfigFileError < 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 +18,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

data/lib/wikian/version.rb

@@ -1,3 +1,3 @@
 class Wikian
-  VERSION = "0.1.1"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wikian
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - sergioro