ariesms 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e337d4795efce5d9fcc6c9f8133daa727269e54f
+  data.tar.gz: 399b64464ad169a8e79efe0084e9cf0ae6c37d00
+SHA512:
+  metadata.gz: 6bb6e3401ef8989aea4ccb1eb5bfd1c57b0f7b2a33128de7d3c1fa49bd67fe5baa3a50f26b0309d946df1fd181be0ba35a1a6f4ca4e5e7408a24a58382a308fa
+  data.tar.gz: df7c9d702d97adca4f212803edf2b3cf999b1d482cac689e3021257676440de303975c0b0838c9c5f25b8b17a2eea583c3c2610557aa045519345b6f60c9d2cf

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in zippyrb.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Lotus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+[![Build Status](https://travis-ci.org/yoru/aries.svg?branch=master)](https://travis-ci.org/yoru/aries)
+[![Gem](https://img.shields.io/gem/v/ariesms.svg)](https://rubygems.org/gems/ariesms)
+
+# Aries
+
+An unofficial Ruby library for AriesMS rankings. It scrapes the ranking page and
+present the data in a organised fashion.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ariesms'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ariesms
+
+## Usage
+
+```ruby
+require 'aries'
+
+# Returns a single Character object.
+character = Aries::Character.find('Ruby')
+
+# Returns the number of online characters.
+characters = Aries::Character.online
+
+# Returns the overall ranking.
+characters = Aries::Character.all
+
+# Returns the job ranking.
+characters = Aries::Character.job('phantom')
+
+# Returns the most famed characters.
+characters = Aries::Character.fame
+```
+
+You can pass a page number as an argument, e.g. `Aries::Character.all(2)`. Each
+page returns an array of 10 Character objects.
+
+### Aries::Character
+
+It's self explanatory.
+
+```ruby
+{
+         @id => 1,
+       @name => "Yakan",
+        @job => "Bow Master",
+      @world => "Scania"
+      @level => 219,
+    @paragon => 0,
+       @fame => 117
+}
+```
+
+Unfortunately the ID present in the ranking table is relative, so it doesn't
+reflect the ranking position when using `Aries::Character.find`. It's not a lib
+issue.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Fix offenses (`rubocop -a`)
+4. Run the tests (`rake spec`)
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/data/classes.json

@@ -0,0 +1,154 @@
+[
+  {
+    "id": -1,
+    "name": "islander"
+  },
+  {
+    "id": 0,
+    "name": "beginner"
+  },
+  {
+    "id": 1,
+    "name": "warrior"
+  },
+  {
+    "id": 2,
+    "name": "magician"
+  },
+  {
+    "id": 3,
+    "name": "bowman"
+  },
+  {
+    "id": 4,
+    "name": "thief"
+  },
+  {
+    "id": 5,
+    "name": "pirate"
+  },
+  {
+    "id": 10,
+    "name": "noblesse"
+  },
+  {
+    "id": 11,
+    "name": "dawn_warrior"
+  },
+  {
+    "id": 12,
+    "name": "blaze_wizard"
+  },
+  {
+    "id": 13,
+    "name": "wind_archer"
+  },
+  {
+    "id": 14,
+    "name": "night_walker"
+  },
+  {
+    "id": 15,
+    "name": "thunder_breaker"
+  },
+  {
+    "id": 20,
+    "name": "legend"
+  },
+  {
+    "id": 21,
+    "name": "aran"
+  },
+  {
+    "id": 22,
+    "name": "evan"
+  },
+  {
+    "id": 23,
+    "name": "mercedes"
+  },
+  {
+    "id": 24,
+    "name": "phantom"
+  },
+  {
+    "id": 25,
+    "name": "shade"
+  },
+  {
+    "id": 27,
+    "name": "luminous"
+  },
+  {
+    "id": 30,
+    "name": "citizen"
+  },
+  {
+    "id": 31,
+    "name": "demon_slayer"
+  },
+  {
+    "id": 32,
+    "name": "battle_mage"
+  },
+  {
+    "id": 33,
+    "name": "wild_hunter"
+  },
+  {
+    "id": 35,
+    "name": "mechanic"
+  },
+  {
+    "id": 36,
+    "name": "xenon"
+  },
+  {
+    "id": 37,
+    "name": "blaster"
+  },
+  {
+    "id": 41,
+    "name": "hayato"
+  },
+  {
+    "id": 42,
+    "name": "kanna"
+  },
+  {
+    "id": 51,
+    "name": "mihile"
+  },
+  {
+    "id": 61,
+    "name": "kaiser"
+  },
+  {
+    "id": 64,
+    "name": "cadena"
+  },
+  {
+    "id": 65,
+    "name": "angelic_buster"
+  },
+  {
+    "id": 101,
+    "name": "zero"
+  },
+  {
+    "id": 112,
+    "name": "beast_tamer"
+  },
+  {
+    "id": 131,
+    "name": "pink_bean"
+  },
+  {
+    "id": 142,
+    "name": "kinesis"
+  },
+  {
+    "id": 152,
+    "name": "illium"
+  }
+]

data/lib/aries.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Aries
+  require 'aries/exceptions'
+  require 'aries/scraper'
+  require 'aries/models/character'
+end

data/lib/aries/exceptions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Aries
+  module Exception
+    class Base < RuntimeError
+      def initialize(message)
+        super(message)
+      end
+    end
+
+    class Scraper < Base; end
+    class NotFoundError < Base; end
+    class InvalidJobError < Base; end
+  end
+end

data/lib/aries/models/character.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Aries
+  class Character
+    attr_reader :id, :name, :job, :world, :level, :paragon, :fame
+
+    def initialize(attributes)
+      @id      = attributes[:id]
+      @name    = attributes[:name]
+      @job     = attributes[:job]
+      @world   = attributes[:world] || 'Scania'
+      @level   = attributes[:level]
+      @paragon = attributes[:paragon]
+      @fame    = attributes[:fame]
+    end
+
+    def to_json
+      hash = {}
+      instance_variables.each do |var|
+        var = var[1..-1]
+        hash[var] = send(var.to_sym)
+      end
+
+      JSON.pretty_generate(hash)
+    end
+
+    def to_hash
+      JSON.parse(to_json, symbolize_names: true)
+    end
+
+    def self.online
+      online = Aries::Scraper.raw(page: 'home')
+                             .body
+                             .match(/(\d+)\sONLINE/)
+
+      return false unless online
+
+      online.captures.first.to_i
+    end
+
+    def self.all(n = 1)
+      Aries::Scraper.get(page: 'ranking', overall: skip(n))
+                    .map { |attr| new(attr) }
+    end
+
+    def self.fame(n = 1)
+      Aries::Scraper.get(page: 'ranking', fame: 1, start: skip(n))
+                    .map { |attr| new(attr) }
+    end
+
+    def self.job(name, n = 1)
+      Aries::Scraper.get(page: 'ranking', job: job_id(name), start: skip(n))
+                    .map { |attr| new(attr) }
+    end
+
+    def self.find(ign)
+      new Aries::Scraper.post({ page: 'ranking', name: 1 }, username: ign)
+                        .first
+    end
+
+    class << self
+      protected
+
+      # HACK: Pagination
+      # Skip <number> of characters
+      def skip(page)
+        (page * 10) - 10
+      end
+
+      def job_id(name)
+        file = File.read \
+          File.expand_path('../../../../data/classes.json', __FILE__)
+        job = JSON.parse(file).find { |j| j['name'] == name }
+
+        raise Aries::Exception::InvalidJobError, 'Invalid job' if job.nil?
+
+        job['id']
+      end
+    end
+  end
+end

data/lib/aries/scraper.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'rest_client'
+
+module Aries
+  module Scraper
+    class << self
+      def url_for(params = {})
+        url = URI.parse('https://aries.elluel.net/')
+        url.query = URI.encode_www_form(params) if params
+        url.to_s
+      end
+
+      def get(params)
+        perform_request do
+          parse_response(RestClient.get(url_for(params)))
+        end
+      end
+
+      def post(params, form_data = {})
+        perform_request do
+          parse_response(RestClient.post(url_for(params), form_data))
+        end
+      end
+
+      def raw(params)
+        perform_request do
+          RestClient.get(url_for(params))
+        end
+      end
+
+      private
+
+      def perform_request
+        yield
+      rescue RestClient::Exception => e
+        raise Aries::Exception::Scraper, e.message
+      end
+
+      def parse_response(response_body)
+        characters = []
+
+        table = Nokogiri::HTML(response_body).at('table').search('tr')
+        table.drop(1).each do |tr|
+          cells = tr.search('th', 'td')
+          characters << {
+            id:      cells[0].text.to_i,
+            name:    cells[1].text,
+            job:     cells[2].text.strip,
+            level:   cells[3].children[0].text.to_i,
+            paragon: cells[4].children[0].text.to_i,
+            fame:    cells[5].text.to_i
+          }
+        end
+
+        if characters.empty?
+          raise Aries::Exception::NotFoundError,
+                'No character was found'
+        end
+
+        characters
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: ariesms
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Lotus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+description: 
+email: lotus@disr.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- data/classes.json
+- lib/aries.rb
+- lib/aries/exceptions.rb
+- lib/aries/models/character.rb
+- lib/aries/scraper.rb
+homepage: https://github.com/yoru/aries
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: An unofficial Ruby library for AriesMS rankings
+test_files: []