factorio-mod 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cc46a6267996d8e4e5891e39918998a66ad25b738d85d44814426685662ea89
-  data.tar.gz: 83c21b87bdcd20990724ed98814c9bbde13280fba66a2d6d815dd5113bb10558
+  metadata.gz: f87061c490f02e803b9625ad9ee1430d95ade44ea3ec2aad5f7c4dfe467d964b
+  data.tar.gz: baf201035dfccf9c0afdd009c86cadc6699fe24c67cfdde6b937909c6982b666
 SHA512:
-  metadata.gz: 77486d9176c9398349bd7befbfab82ae12d02c3f77e7cdafa42933d4898be00f8b1596c4433e010149ab661de3ea63fbc5628352c7524b7cf7a199d0dd4acbe7
-  data.tar.gz: 5b1902aa35d4dd2a704e0ee50aeb0bab8c9c741aabf30a584c85e1d34cbe5cbc324b9152b1b0a2d66e97ab22fa168e618066d9e035b2d254464e63115f583314
+  metadata.gz: 1f0dbbc1048d6544a6fd1354d13e2b609a58451a7b3a8a28bb33944bc8eb7719d0f3cab94591c8785370be804d87fb71eec446780c8fa0e4bf873e6fdfb6ea41
+  data.tar.gz: 199ce9af9186305636a6e7bcd8b46d92a3835c992bbb27ecc3f3dc9dc928151a0125b7295b36dac98bd0c4c477010dd942de10ceb093974645d07bcc3740b2f6

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: '2.4.0'

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }

data/Gemfile.lock

@@ -1,20 +1,30 @@
 PATH
   remote: .
   specs:
-    factorio-mod (0.4.0)
+    factorio-mod (0.5.0)
+      activesupport (~> 5.2)
       nokogiri (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
     ast (2.4.0)
     bump (0.6.1)
     coco (0.15.0)
     coderay (1.1.2)
+    concurrent-ruby (1.1.3)
     diff-lcs (1.3)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
     method_source (0.9.0)
     mini_portile2 (2.3.0)
+    minitest (5.11.3)
     nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
     parallel (1.12.1)
@@ -48,6 +58,9 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     unicode-display_width (1.4.0)
 
 PLATFORMS
@@ -64,4 +77,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   1.16.6
+   1.17.1

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'bump/tasks'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'factorio/mod'

data/factorio-mod.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'factorio/mod/version'
@@ -30,5 +32,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rubocop'
 
+  spec.add_dependency 'activesupport', '~> 5.2'
   spec.add_dependency 'nokogiri', '~> 1.8'
 end

data/lib/factorio/mod.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 
 require 'factorio/mod/version'
@@ -11,3 +13,7 @@ require 'open-uri'
 require 'net/http'
 require 'nokogiri'
 require 'erb' # for uri encode
+
+require 'active_support'
+require 'active_support/core_ext/object/blank.rb'
+require 'active_support/core_ext/array/access.rb'

data/lib/factorio/mod/cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Factorio
   # Cache mod info
   class Cache
@@ -27,12 +29,12 @@ module Factorio
     # @param better [Symbol] get which page if none of the pages exist.
     # @return [Nokogiri::HTML]
     def any(better = :information)
-      if @cache.key? :information
-        information
-      elsif @cache.key? :downloads
-        downloads
+      if @cache.key? better
+        @cache[better]
+      elsif @cache.any?
+        @cache.first.second
       else
-        send better
+        public_method(better).call
       end
     end
 
@@ -42,6 +44,7 @@ module Factorio
     def get(symbol, uri)
       symbol = symbol.to_sym
       return @cache[symbol] if @cache.key? symbol
+
       @cache[symbol] = Nokogiri::HTML(URI.open(uri, 'Cookie' => @cookie))
     rescue OpenURI::HTTPError => e
       raise NoMODError.new @name, e.io

data/lib/factorio/mod/download.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 module Factorio
   class Mod
     # store the entry of the _download_
     Download = Struct.new(:version, :game_version, :uri, :date, :times) do
       # `Download` page table header to attribute symbol
       TABLE_HEADER_TO_SYM = {
-        'Version'      => :version,
+        'Version' => :version,
         'Game Version' => :game_version,
-        'Download'     => :uri,
+        'Download' => :uri,
         'Release Date' => :date,
-        'Downloads'    => :times
+        'Downloads' => :times
       }.freeze
 
       HANDLE_VALUE = {

data/lib/factorio/mod/exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Factorio
   # The Exception that can't find MOD
   class NoMODError < StandardError

data/lib/factorio/mod/mod.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Factorio
   # Info interface
   #
@@ -11,9 +13,9 @@ module Factorio
   # puts "It latest version for factorio 0.16 can download at " \
   #   "#{mod.latest_download('0.16')[:uri]}"
   # ```
-  class Mod
+  class Mod # rubocop:disable ClassLength
     # factorio Mod portal website URI
-    MOD_URI = 'https://mods.factorio.com'.freeze
+    MOD_URI = 'https://mods.factorio.com'
 
     attr_reader :name
     alias id name
@@ -29,9 +31,10 @@ module Factorio
     private
 
     # Get the meta table from Information page.
-    def data_table(key = '')
+    def data_table(key = nil)
       table = @mod.information.xpath("//div[@class='mod-page-data-table']")
-      return table if key == ''
+      return table if key.blank?
+
       xpath = "//td[../td[@class='data-name'][.='#{key}:']]"
       table.xpath xpath
     end
@@ -50,7 +53,7 @@ module Factorio
       end
     end
 
-    # Get the logged in cookie.
+    # Get the logged in cookie by webdriver.
     #
     # @example
     #   # use firefox nightly
@@ -58,12 +61,12 @@ module Factorio
     #     `which firefox-nightly`.chomp
     #   # open firefox
     #   driver = Selenium::WebDriver.for :firefox
-    #   cookie = Factorio::Mod.login_cookie(driver)
+    #   cookie = Factorio::Mod.login_cookie_webdriver(driver)
     #   # the browser will automatically close
     # @param driver [Selenium::WebDriver::Driver] Web Driver
     # @param autoclose [Bool] automatically close the browser after logging in
     # @return [String] The logged in cookie
-    def self.login_cookie(driver, autoclose = true)
+    def self.login_cookie_webdirver(driver, autoclose = true)
       begin
         driver.navigate.to 'https://mods.factorio.com/login'
       rescue Net::ReadTimeout
@@ -77,12 +80,44 @@ module Factorio
       "session=#{session}"
     end
 
+    # @return [String, String] `csrf_token` and cookie
+    def self.csrf_and_cookie
+      resp = open 'https://mods.factorio.com/login'
+      cookie = resp.meta['set-cookie'].split('; ')[0]
+      csrf_token = Nokogiri::HTML(resp).css('#csrf_token @value').to_s
+      [csrf_token, cookie]
+    end
+    private_class_method :csrf_and_cookie
+
+    # Get the logged in cookie by username and password.
+    #
+    # @example
+    #   print 'username: '
+    #   user = gets.chomp
+    #   print 'password: '
+    #   pass = gets.chomp
+    #   cookie = Factorio::Mod.login_cookie user, pass
+    # @param username [String]
+    # @param password [String]
+    # @return [String] The logged in cookie
+    def self.login_cookie(username, password)
+      csrf_token, cookie = csrf_and_cookie
+      data = URI.encode_www_form(
+        'csrf_token' => csrf_token,
+        'username' => username,
+        'password' => password
+      )
+      resp = Net::HTTP.post(URI(MOD_URI + '/login'), data, 'Cookie' => cookie)
+      resp.response['set-cookie'].split('; ').first
+    end
+
     # Extend relative links to absolute links
     # @param rel [String] relative link
     # @return [String] absolute link
     # @raise [NotLoginError]
     def self.extend_uri(rel)
       raise NotLoginError if rel =~ %r{^/login}
+
       MOD_URI + rel
     end
 
@@ -109,16 +144,13 @@ module Factorio
     # Get the GitHub URI.
     # @return [String] GitHub URI
     def github
-      uri = @mod.any.xpath('//a[@class="source-code-link"]/@href').text
-      return if uri.empty?
-      uri
+      @mod.any.xpath('//a[@class="source-code-link"]/@href').text.presence
     end
 
     # Get the git repo URI that can be cloned.
     # @return [String] git URI
     def git
-      return if github.nil?
-      github + '.git'
+      github &.+ '.git'
     end
 
     # Get the license that the Mod use.
@@ -156,8 +188,9 @@ module Factorio
     # Get the latest _download_ of the Mod.
     # @param version [String] factorio version
     # @return [Download]
-    def latest_download(version = '')
-      return download_list.last if version == ''
+    def latest_download(version = nil)
+      return download_list.last if version.blank?
+
       download_list.each do |download|
         return download if download.game_version == version.to_s
       end

data/lib/factorio/mod/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Factorio
   class Mod
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factorio-mod
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - 71e6fd52
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-16 00:00:00.000000000 Z
+date: 2018-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +147,7 @@ files:
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".yardopts"
 - Gemfile
 - Gemfile.lock
@@ -167,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Get the info of Factorio's MOD.