factorio-mod 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8417b98fa7593e0defd4c676d400840e998ab87fd5a63e2c625df220bb8be24
-  data.tar.gz: ecd77d7c281591a9642d193d135552d6b4ac08079b070ce2c53728e8ed6c7160
+  metadata.gz: 2499144d6520545aead798fd61a95fd8ed40a3ee57cfcfdf271dcb4a2a752cf0
+  data.tar.gz: f63270dbc3eb0694861c72c9b57732b0caecb7c2bfa39eb581dc9def5fa3577a
 SHA512:
-  metadata.gz: 95279289b28a0d647187119ae06da9af3c4b334d105f491e6dd85ffe7c30b24fe30d0d64e140b1d7be90cca1a30aae38105292c286637676e199b0b8c6caaf26
-  data.tar.gz: 27b3e5dd78066ef18f123407130598c6a37d1b33f5f3b145f855008e38c64437eb68591264daf5d1d97146f65abe3c87177cfe2df0bff037c4705289d2776e32
+  metadata.gz: 0bc79117a850a53d01518aa0a4f928675ed8c9dae509a458dcbcb9cd8ddc0ff04bad444d298a6a88cbbcac8d451868fe5cee2e2c32d3062d3925a2ff977d9b3c
+  data.tar.gz: 7d926df0ea9cd9ccdc79824a8e7b6fe311c72889f637c819084a72f9f916f98b6e01e0d928d9dba15344fdf741408a5ac7f13d49e3cf47125da6e2fad2b3dd67

data/.gitlab-ci.yml

@@ -1,3 +1,4 @@
+image: ruby:2.6.0
 before_script:
   - ruby -v
   - which ruby

data/.rubocop.yml

@@ -1,2 +1,4 @@
 AllCops:
   TargetRubyVersion: '2.6.0'
+Metrics/ClassLength:
+  Enabled: false

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    factorio-mod (0.6.0)
+    factorio-mod (0.7.0)
       activesupport (~> 5.2)
+      addressable (~> 2.6)
       nokogiri (~> 1.8)
 
 GEM
@@ -13,13 +14,15 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
     bump (0.7.0)
     coco (0.15.0)
     coderay (1.1.2)
     concurrent-ruby (1.1.4)
     diff-lcs (1.3)
-    i18n (1.5.2)
+    i18n (1.5.3)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.2)
     method_source (0.9.2)
@@ -34,6 +37,7 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    public_suffix (3.0.3)
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)

data/factorio-mod.gemspec

@@ -34,5 +34,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
 
   spec.add_dependency 'activesupport', '~> 5.2'
+  spec.add_dependency 'addressable', '~> 2.6'
   spec.add_dependency 'nokogiri', '~> 1.8'
 end

data/lib/factorio/mod.rb

@@ -12,7 +12,7 @@ require 'factorio/mod/cache'
 require 'open-uri'
 require 'net/http'
 require 'nokogiri'
-require 'erb' # for uri encode
+require 'addressable'
 
 require 'active_support'
 require 'active_support/core_ext/object/blank.rb'

data/lib/factorio/mod/cache.rb

@@ -7,9 +7,10 @@ module Factorio
 
     attr_reader :cache
 
-    # @param uri [String] Mod URI like `https://mods.factorio.com/mod/LTN-easier`
-    def initialize(uri, cookie = '')
-      @uri = uri
+    # @param name [String] Mod name
+    def initialize(name, cookie = '')
+      @name = name
+      @uri = Addressable::URI.encode("mod/#{@name}")
       @cookie = cookie
       @cache = {}
     end
@@ -17,13 +18,13 @@ module Factorio
     # Get the `Information` page.
     # @return [Nokogiri::HTML]
     def information
-      get :information, @uri
+      get :information, Addressable::URI.join(Mod::MOD_URI, @uri)
     end
 
     # Get the `Downloads` page.
     # @return [Nokogiri::HTML]
     def downloads
-      get :downloads, "#{@uri}/downloads"
+      get :downloads, Addressable::URI.join(Mod::MOD_URI, "#{@uri}/downloads")
     end
 
     # Get any page that already downloads.
@@ -51,7 +52,7 @@ module Factorio
       symbol = symbol.to_sym
       @cache[symbol] ||= Nokogiri::HTML(URI.open(uri, 'Cookie' => @cookie))
     rescue OpenURI::HTTPError => e
-      raise NoMODError.new "MOD #{@uri.split('/').last} not found", e.io
+      raise NoModError.new "MOD #{@name} not found", e.io
     end
   end
 end

data/lib/factorio/mod/exception.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Factorio
-  # The Exception that can't find MOD
-  class NoMODError < StandardError
+  # The Exception that can't find Mod
+  class NoModError < StandardError
     attr_reader :io
     def initialize(msg, io)
       @io = io

data/lib/factorio/mod/mod.rb

@@ -25,17 +25,17 @@ module Factorio
     # @param cookie [String] logged in cookie
     def initialize(name, cookie = '')
       @name = name
-      @mod = Cache.new "#{MOD_URI}/mod/#{ERB::Util.url_encode @name}", cookie
+      @mod = Cache.new name, cookie
     end
 
     private
 
     # Get the meta table from Information page.
     def data_table(key = nil)
-      table = @mod.information.xpath("//div[@class='mod-page-data-table']")
+      table = @mod.information.xpath(".//div[@class='mod-page-data-table']")
       return table if key.blank?
 
-      table.xpath "//td[../td[@class='data-name'][.='#{key}:']]"
+      table.xpath ".//td[../td[@class='data-name'][.='#{key}:']]"
     end
 
     public
@@ -98,26 +98,68 @@ module Factorio
     # @return [String] The logged in cookie
     def self.login_cookie(username, password)
       csrf_token, cookie = csrf_and_cookie
-      data = URI.encode_www_form(
+      data = Addressable::URI.form_encode(
         'csrf_token' => csrf_token,
         'username' => username,
         'password' => password
       )
-      Net::HTTP.post(URI(MOD_URI + '/login'), data, 'Cookie' => cookie) \
+      Net::HTTP.post(Addressable::URI.join(MOD_URI, '/login'),
+                     data, 'Cookie' => cookie) \
                .response['set-cookie'].split('; ').first
     end
 
+    # Get mod name from mod card.
+    #
+    # @param card [Nokogiri::HTML]
+    # @return [String] The name in
+    def self.name_from_card(card)
+      card.xpath('.//h2[@class="mod-card-title"]/a/@href').text \
+          .split('/').last.then(&Addressable::URI.method(:unencode))
+    end
+
+    # Search mod.
+    #
+    # @param keyword [String] search keyword
+    # @param cookie [String] cookie
+    # @param version [String] factorio version, `any` for any version
+    # @return [Array<Mod>] all mod searched on the first page with card cache
+    def self.search(keyword, cookie = '', version: 'any')
+      uri = Addressable::URI.join(
+        MOD_URI, "/query/#{Addressable::URI.encode keyword}?version=#{version}"
+      )
+      Nokogiri::HTML(URI.open(uri, 'Cookie' => cookie)) \
+              .css('.mod-card').map do |card|
+        Mod.new(name_from_card(card), cookie).tap do |mod|
+          mod.instance_eval { @mod.cache[:card] = card.clone }
+        end
+      end
+    end
+
+    # Get mod if exist.
+    #
+    # @param name [String] name of the mod
+    # @return [Bool] is exist
+    def self.exist?(name)
+      uri = Addressable::URI.encode("mod/#{name}")
+      URI.open(Addressable::URI.join(MOD_URI, uri))
+      true
+    rescue OpenURI::HTTPError
+      false
+    end
+
     # Extend relative links to absolute links
     # @param rel [String] relative link
     # @return [String] absolute link
     # @raise [NotLoginError]
     def self.extend_uri(rel)
-      MOD_URI + rel.tap { |a| raise NotLoginError if a =~ %r{^/login} }
+      raise NotLoginError if rel =~ %r{^/login}
+
+      Addressable::URI.join(MOD_URI, rel)
     end
 
     # Get href in Nokogiri node
     # @param item [Nokogiri::HTML]
-    # @return [String] relative link
+    # @return [Addressable::URI] relative link
     def self.get_href(item)
       extend_uri(item.xpath('a/@href').text)
     end
@@ -136,15 +178,16 @@ module Factorio
     end
 
     # Get the GitHub URI.
-    # @return [String] GitHub URI
+    # @return [Addressable::URI] GitHub URI
     def github
-      @mod.any.xpath('//a[@class="source-code-link"]/@href').text.presence
+      @mod.any.xpath('.//a[@class="source-code-link"]/@href').text.presence \
+        &.then(&Addressable::URI.method(:parse))
     end
 
     # Get the git repo URI that can be cloned.
-    # @return [String] git URI
+    # @return [Addressable::URI] git URI
     def git
-      github &.+ '.git'
+      github&.to_s&.+('.git')&.then(&Addressable::URI.method(:parse))
     end
 
     # Get the license that the Mod use.
@@ -154,28 +197,28 @@ module Factorio
     end
 
     # Get the license URI.
-    # @return [String] license URI
+    # @return [Addressable::URI] license URI
     def license_uri
-      data_table('License').xpath('a/@href').to_s
+      Addressable::URI.parse(data_table('License').xpath('a/@href').text)
     end
     alias license_link license_uri
 
     # Get the author of the Mod.
     # @return [String] author
     def author
-      @mod.any.xpath('//div[@class="mod-card-author"]/a').text
+      @mod.any.xpath('.//div[@class="mod-card-author"]/a').text
     end
 
     # Whether Mod is deprecated
     # @return [Bool] is deprecated
     def deprecated?
-      @mod.any.xpath('//span[@class="mod-card-title-deprecated"]').any?
+      @mod.any.xpath('.//span[@class="mod-card-title-deprecated"]').any?
     end
 
     # Get the totle number of downloads of Mod.
     # @return [Integer] number of downloads
     def download_times
-      xpath = "//span[@class='mod-card-info-tag'][@title='Downloads']/div"
+      xpath = ".//span[@class='mod-card-info-tag'][@title='Downloads']/div"
       @mod.any.xpath(xpath).text.to_i
     end
 
@@ -196,7 +239,7 @@ module Factorio
     end
 
     # Get latest download uri by download button in card
-    # @return [String] download uri
+    # @return [Addressable::URI] download uri
     def latest_download_uri
       Mod.get_href(@mod.any.css('.mod-download-button'))
     end

data/lib/factorio/mod/version.rb

@@ -2,6 +2,6 @@
 
 module Factorio
   class Mod
-    VERSION = '0.6.0'
+    VERSION = '0.7.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factorio-mod
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - 71e6fd52
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2019-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement