wikipedia-client 1.15.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af50d4fda3d70e5bd837bde17b2ca86ec4c653c92891a5088246772da4ca45b5
-  data.tar.gz: 6366ad0bf999ed51533fd49963b4fa6d36e7181d49fc9bab227407cc3f76300f
+  metadata.gz: 36017e939b6473fd18fa5f2fd9703518d65308da4c945a1fc5684a22c341dc27
+  data.tar.gz: 6d0b8ae5850085c7fdebb24a7e6f1906c4df5b2c03ca29566aa010cc0d5bec73
 SHA512:
-  metadata.gz: d0f6e70ee49591fb4fb1238cd35ede198ff14e6efd89ddfbc972e4c7b03ff3aeabc2770c80f7981af5ec30d820ffbd5ca4a4870da944686d612134d34dacde87
-  data.tar.gz: 701089ac1c06f95ea5b67afba9b7d6754c967d0d4411f7b95b3f8a8f456b9adabc4ab67036be5024c70a1d21022144a5e88d4693c76d719ab3ad4bff0cd01e9d
+  metadata.gz: 478d443be7e1f2ed909ef247f6ea5dd20ae9b5b06ae2d0205094df8d6ea97849d7cb222aefcd8bfc77eb294106007f24c290217a3530a6629f4a4bbad84c6e6a
+  data.tar.gz: c88caabd2ee0b32936211e5c3cc1ce006cb4afa687b5671511df56430e5081b9717f34711e501e9c9e4732028de382f34d7091bda8ddac087c7fbe7cdcee555d

data/.github/workflows/test.yml

@@ -8,11 +8,11 @@ jobs:
     name: Ruby ${{ matrix.ruby }}
     runs-on: ubuntu-latest
     strategy:
-      matrix: { ruby: ['2.5', '2.6', '2.7', '3.0'] }
+      matrix: { ruby: ['2.5', '2.6', '2.7', '3.0', '3.1', '3.2'] }
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Setup Ruby
       uses: ruby/setup-ruby@v1

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  NewCops: disable
+
 Metrics/LineLength:
   Max: 120
   AllowURI: true
@@ -5,13 +8,13 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 15
 
-Style/SpaceInsideParens:
+Layout/SpaceInsideParens:
   Enabled: false
 
 Style/RescueModifier:
   Enabled: false
 
-Style/SpaceInsidePercentLiteralDelimiters:
+Layout/SpaceInsidePercentLiteralDelimiters:
   Enabled: false
 
 Style/RegexpLiteral:
@@ -25,3 +28,55 @@ Style/SymbolArray:
 
 Metrics/ClassLength:
   Max: 130
+
+# TODO: Remove each of the rules below once fixed.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/ExpandPathArguments:
+  Enabled: false
+
+Lint/MissingCopEnableDirective:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/RedundantRegexpEscape:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Style/RedundantAssignment:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/LeadingEmptyLines:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+Lint/NonDeterministicRequireOrder:
+  Enabled: false

data/Gemfile

@@ -1,12 +1,11 @@
 source 'https://rubygems.org'
 
-gem 'jeweler'
 gem 'pry'
 gem 'rake'
 gem 'rdoc'
 gem 'rspec'
 # FIXME: Remove rubocop version restriction and fix or disable cops
-gem 'rubocop', '= 0.48.1'
+gem 'rubocop', '~> 1.22', require: false
 gem 'thoughtbot-shoulda'
 
 gemspec

data/README.md

@@ -124,6 +124,29 @@ page.raw_data
 "lastrevid"=>348481810, "counter"=>0, "length"=>7891}}}}
 ```
 
+### Additional HTTP headers
+
+Some API features require tweaking HTTP headers. You can add additional headers via configuration.
+
+For example, to retrieve the same page in different language variants:
+
+```ruby
+Wikipedia.configure do
+   domain 'zh.wikipedia.org'
+   headers({ 'Accept-Language' => 'zh-tw' })
+end
+
+Wikipedia.find('牛肉').summary #=> "牛肉是指從牛身上得出的肉，為常見的肉品之一。肌肉部分可以切成牛排、牛肉塊或牛仔骨，也可以與其他的肉混合做成香腸或血腸。"
+
+Wikipedia.configure do
+   domain 'zh.wikipedia.org'
+   headers({ 'Accept-Language' => 'zh-cn' })
+end
+
+Wikipedia.find('牛肉').summary #=> "牛肉是指从牛身上得出的肉，为常见的肉品之一。肌肉部分可以切成牛排、牛肉块或牛仔骨，也可以与其他的肉混合做成香肠或血肠。"
+```
+
+
 ## Contributing
 
 ### Getting the code, and running the tests

data/lib/wikipedia/client.rb

@@ -73,7 +73,7 @@ module Wikipedia
     end
 
     def request( options )
-      URI.parse( url_for( options ) ).read( 'User-Agent' => @configuration[:user_agent] )
+      URI.parse( url_for( options ) ).read( headers )
     end
 
     protected
@@ -114,5 +114,11 @@ module Wikipedia
       end
       [h1, h2]
     end
+
+    def headers
+      {
+        'User-Agent' => @configuration[:user_agent]
+      }.merge( @configuration[:headers] )
+    end
   end
 end

data/lib/wikipedia/configuration.rb

@@ -4,7 +4,8 @@ module Wikipedia
       protocol: 'https',
       domain: 'en.wikipedia.org',
       path: 'w/api.php',
-      user_agent: 'wikipedia-client/1.7 (https://github.com/kenpratt/wikipedia-client)'
+      user_agent: 'wikipedia-client/1.7 (https://github.com/kenpratt/wikipedia-client)',
+      headers: {}
     }.freeze
 
     def initialize(configuration = DEFAULT)
@@ -25,6 +26,6 @@ module Wikipedia
       end
     end
 
-    directives :protocol, :domain, :path, :user_agent
+    directives :protocol, :domain, :path, :user_agent, :headers
   end
 end

data/lib/wikipedia/url.rb

@@ -11,7 +11,12 @@ module Wikipedia
       return @title if @title
 
       uri     = URI.parse( @wiki_url )
-      @title  = Addressable::URI.unencode( uri.path.sub(/\/wiki\//, '') )
+      @title  =
+        if uri.path.empty?
+          @wiki_url
+        else
+          Addressable::URI.unencode( uri.path.sub(/\/wiki\//, '') )
+        end
     end
   end
 end

data/lib/wikipedia/version.rb

@@ -1,3 +1,3 @@
 module Wikipedia
-  VERSION = '1.15.0'.freeze
+  VERSION = '1.17.0'.freeze
 end

data/lib/wikipedia-client.rb

@@ -0,0 +1,2 @@
+# rubocop:disable Naming/FileName
+require 'wikipedia'

data/lib/wikipedia.rb

@@ -24,10 +24,10 @@ module Wikipedia
   end
 
   def self.configure(&block)
-    @configuration.instance_eval(&block)
+    configuration.instance_eval(&block)
   end
 
-  # rubocop:disable Style/MethodName
+  # rubocop:disable Naming/MethodName
   def self.Configure(&block)
     configure(&block)
   end
@@ -35,9 +35,12 @@ module Wikipedia
   class << self
     private
 
-    def client
+    def configuration
       @configuration ||= Wikipedia::Configuration.new
-      @client ||= Wikipedia::Client.new @configuration
+    end
+
+    def client
+      @client ||= Wikipedia::Client.new configuration
     end
   end
 end

data/spec/lib/client_spec.rb

@@ -1,7 +1,6 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 require 'json'
 
-# rubocop:disable Metrics/BlockLength
 describe Wikipedia::Client, '.find page (mocked)' do
   before(:each) do
     @client = Wikipedia::Client.new
@@ -161,7 +160,6 @@ describe Wikipedia::Client, '.find page (Edsger_Dijkstra)' do
     @client.follow_redirects = true
     @page = @client.find('Edsger Dijkstra')
     [
-      '/commons/5/57/Dijkstra_Animation.gif',
       '/commons/c/c9/Edsger_Dijkstra_1994.jpg',
       '/commons/d/d9/Edsger_Wybe_Dijkstra.jpg'
     ].each do |image|
@@ -173,7 +171,6 @@ describe Wikipedia::Client, '.find page (Edsger_Dijkstra)' do
     @client.follow_redirects = true
     @page = @client.find('Edsger Dijkstra')
     [
-      '/commons/thumb/5/57/Dijkstra_Animation.gif/200px-Dijkstra_Animation.gif',
       '/commons/thumb/c/c9/Edsger_Dijkstra_1994.jpg/200px-Edsger_Dijkstra_1994.jpg',
       '/commons/thumb/d/d9/Edsger_Wybe_Dijkstra.jpg/200px-Edsger_Wybe_Dijkstra.jpg'
     ].each do |image|
@@ -185,7 +182,6 @@ describe Wikipedia::Client, '.find page (Edsger_Dijkstra)' do
     @client.follow_redirects = true
     @page = @client.find('Edsger Dijkstra')
     [
-      '/commons/thumb/5/57/Dijkstra_Animation.gif/100px-Dijkstra_Animation.gif',
       '/commons/thumb/c/c9/Edsger_Dijkstra_1994.jpg/100px-Edsger_Dijkstra_1994.jpg',
       '/commons/thumb/d/d9/Edsger_Wybe_Dijkstra.jpg/100px-Edsger_Wybe_Dijkstra.jpg'
     ].each do |image|
@@ -196,7 +192,7 @@ describe Wikipedia::Client, '.find page (Edsger_Dijkstra)' do
   it 'should collect the main image thumburl' do
     @client.follow_redirects = true
     @page = @client.find('Edsger Dijkstra')
-    image = '/commons/thumb/d/d9/Edsger_Wybe_Dijkstra.jpg/150px-Edsger_Wybe_Dijkstra.jpg'
+    image = '/commons/thumb/d/d9/Edsger_Wybe_Dijkstra.jpg/200px-Edsger_Wybe_Dijkstra.jpg'
     expect(@page.main_image_thumburl).to include('https://upload.wikimedia.org/wikipedia' + image)
   end
 end

data/spec/lib/url_spec.rb

@@ -6,3 +6,10 @@ describe Wikipedia::Url, 'like http://en.wikipedia.org/wiki/Getting_Things_Done'
     expect(url.title).to eq('Getting_Things_Done')
   end
 end
+
+describe Wikipedia::Url, 'like "? (Lost)"' do
+  it 'should return input as title' do
+    url = Wikipedia::Url.new('? (Lost)')
+    expect(url.title).to eq('? (Lost)')
+  end
+end

data/spec/lib/wikipedia_spec.rb

@@ -18,3 +18,15 @@ describe Wikipedia, '.find' do
     expect(page1.title).to eq(page2.title)
   end
 end
+
+describe Wikipedia, '.configure' do
+  it 'should set configuration' do
+    Wikipedia.configure do
+      protocol 'https'
+      domain 'zh.wikipedia.org'
+    end
+
+    page = Wikipedia.find('Getting_Things_Done')
+    expect(page.fullurl).to start_with('https://zh.wikipedia.org')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wikipedia-client
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Cyril David
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-06 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -46,6 +46,7 @@ files:
 - Rakefile
 - init.rb
 - install.rb
+- lib/wikipedia-client.rb
 - lib/wikipedia.rb
 - lib/wikipedia/client.rb
 - lib/wikipedia/configuration.rb