companion_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: faaf43ab4e675ad4722c24ffa580e0733d85096cb2a2b4af6521d24103112752
+  data.tar.gz: c15027cddb74d2517e52aa5f428333d604b23729aa90bc06e97f13f4aa2397a0
+SHA512:
+  metadata.gz: 634fa00ee966d63382e3a951c960f027ccf6c8e9557f0e419d04850d161d05052e71f390fb2bba57ac7d67b596fcfeff03a8aa955464ecc0886d5ab22c742740
+  data.tar.gz: 3757590fbd5d285c6523f9c681873a8c66637375cba0aa7df4082725bdf5b420a0a00f1d1ff2b265910d85573ea5be2ba901177e34ef06056bf0fafa32ee521c

data/.gitignore

@@ -0,0 +1,22 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.bundle
+Gemfile.lock
+
+.DS_Store
+
+.rvmrc
+.idea
+
+.env
+.test.credentials

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,190 @@
+require: rubocop-rspec
+
+AllCops:
+  # Enable all the rules by default
+  EnabledByDefault: true
+  # Command line rubocop options
+  ExtraDetails: true
+  DisplayStyleGuide: true
+  DisplayCopNames: true
+  # Target versions
+  # We do not specify Ruby version, because CodeClimate should by default
+  # read .ruby-version, and send it down to Rubocop
+  # (see https://github.com/codeclimate/codeclimate-rubocop/pull/68)
+  # TargetRubyVersion: 2.4
+  # We will lock Rails version to the newest we have in the company, so we're
+  # always looking to the future.
+  TargetRailsVersion: 5.1
+  # Exclude auto-generated and vendored files
+  Exclude:
+  - 'db/schema.rb'
+
+#-------------------------------------------------------------------------------
+# Rules configuration
+#-------------------------------------------------------------------------------
+
+Bundler/OrderedGems:
+  TreatCommentsAsGroupSeparators: true
+
+Layout/AlignHash:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+  EnforcedLastArgumentHashStyle: always_inspect
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/MultilineAssignmentLayout:
+  EnforcedStyle: same_line
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+# Requere spaces inside of brackets, e.g. [ 1, 2, 3 ]
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: false
+  EnforcedStyle: compact
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/ClassLength:
+  Max: 250
+  CountComments: false
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+  - 'db/migrate/*'
+  - 'spec/**/*'
+  IgnoredPatterns:
+  - '^#.*'
+
+Metrics/MethodLength:
+  Max: 30
+  Exclude:
+  - 'db/migrate/*'
+
+Metrics/ModuleLength:
+  Max: 250
+  CountComments: false
+
+Rails/SafeNavigation:
+  ConvertTry: true
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+#-------------------------------------------------------------------------------
+# RSpec rules
+#-------------------------------------------------------------------------------
+
+RSpec/MultipleExpectations:
+  Max: 7
+
+# Name your test subject if you need to reference it explicitly. (http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/NamedSubject)
+RSpec/NamedSubject:
+  Enabled: false
+
+# Spec path should end with _spec (http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FilePath)
+# example: meta_tags/view_helper*displayingdescription*_spec.rb.
+RSpec/FilePath:
+  Enabled: false
+
+# The second argument to describe should be the method being tested. '#instance' or '.class'. (http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/DescribeMethod)
+# example: describe MetaTags::ViewHelper, 'displaying description' do
+RSpec/DescribeMethod:
+  Enabled: false
+
+# Example has too many lines. (http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExampleLength)
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+#-------------------------------------------------------------------------------
+# Disabled rules
+#-------------------------------------------------------------------------------
+
+# Yes, we have meta-tags.rb for simplicity
+Naming/FileName:
+  Enabled: false
+
+# Allow not null columns without a default value
+Rails/NotNullColumn:
+  Enabled: false
+
+# This check does not distinguish between "private :x" and "private def x"
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Do not require copyright information
+Style/Copyright:
+  Enabled: false
+
+# Do not require class and module documentation
+Style/Documentation:
+  Enabled: false
+
+# Do not require method documentation
+Style/DocumentationMethod:
+  Enabled: false
+
+# Allow double negation (!!@var)
+Style/DoubleNegation:
+  Enabled: false
+
+# Do not enforce if modifier, sometimes it is better to split for long lines
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Allow trailing comments
+Style/InlineComment:
+  Enabled: false
+
+# Do not require parentheses around method arguments
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+
+# Do not enforce `else` on conditions
+Style/MissingElse:
+  Enabled: false
+
+# Allow both `.positive?` and `> 0` variants
+Style/NumericPredicate:
+  Enabled: false
+
+# Do not enforce using symbols for hash keys
+Style/StringHashKeys:
+  Enabled: false
+
+# Do not enforce usage of single quotes on strings
+Style/StringLiterals:
+  Enabled: false
+
+# Do not require to use %i[] around symbol arrays
+Style/SymbolArray:
+  Enabled: false
+
+# Do not require to use %w[] around word arrays
+Style/WordArray:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.3

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gem 'pbkdf2', github: 'emerose/pbkdf2-ruby', ref: 'f9a337e3559de7e61792f2c761a91ea57d53e095'
+
+group :test do
+  gem 'rubocop', '0.60.0'
+  gem 'rubocop-rspec', require: false
+end
+
+# Specify your gem's dependencies in companion_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nils Berenbold
+
+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,91 @@
+# CompanionApi
+
+This gem provides a wrapper to the SE Companion App Api, right now it only supports the marketplace, you are free to add the other endpoints.
+
+This gem is basically a rewrite of the php Version from Vekien (https://github.com/xivapi/companion-php)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'companion_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install companion_api
+
+## Usage
+
+```ruby
+CompanionApi.configure do |config|
+  config.profile_directory = "PATH" # Here are the profiles stored for later use
+  config.logger = Logger.new("PATH")
+  config.debug = false
+end
+```
+
+For rails put initialization into config/initializers/global.rb
+
+```ruby
+CompanionApi.configure do |config|
+  config.profile_directory = Rails.root.join("tmp", "profiles").to_s # Here are the profiles stored for later use
+  config.logger = Logger.new(Rails.root.join("log", "companion.log"))
+  config.debug = false
+end
+```
+
+### Login
+
+```ruby
+api = CompanionApi::Base.new('test_profile')
+api.login!("USERNAME", "PASSWORD")
+```
+
+afterwards you are able to select a character and use it for the marketplace Api
+
+The token you'll receive is valid for 24 hours, if the token expires a custom ```CompanionApi::TokenExpiredError``` is raised
+
+```ruby
+characters = api.login.characters
+api.login.select_character(characters.first['cid'])
+```
+
+you can check if you are logged in to a character by using ```api.loggedin?```
+
+### Marketplace
+
+```ruby
+# load a earth shards
+result = api.market.market_listings_by_category(58)
+>> result["items"]
+ 
+result = api.market.item_market_listings(5)
+>> result["entries"]
+
+# load only hq results
+result = api.market.item_market_listings(23_769, hq: true)
+>> result["entriesHq"]
+
+result = api.market.transaction_history(5)
+>> result["history"]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nberenbold/companion-api-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'companion_api'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/companion_api.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'companion_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'companion_api'
+  spec.version       = CompanionApi::VERSION
+  spec.authors       = ['Nils Berenbold']
+  spec.email         = ['nils.berenbold@gmail.com']
+
+  spec.summary       = 'A Wrapper for the Companion App Api'
+  spec.description   = 'A Wrapper for the Companion App Api'
+  spec.homepage      = 'https://xivapi.com'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'activesupport', '~> 5'
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'httpclient'
+  spec.add_dependency 'nokogiri'
+
+  spec.required_ruby_version = '>= 2.2.0'
+end

data/config/public-key.pem

@@ -0,0 +1 @@
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtDLA2/jQxScusojWLHyhCYNW8S9yM+DuaLgiXZC/tk79H1u4jiip1kRx2zrQ9nvnMqYMNYarqKDlJmIL10B5UWY+vDXdXXiXx5qQtj+NgPslhiZMDxpA0EfDvBdQ7Hmk/m1qocP0i0uYVzvyZBKWN1Xj1QDuZzKfXP6rpfPVB1rSwxAMpEcyMHhtsTsEf+w9Sr+Wy/oJQau+k+rLhYtln+HsF9LCn5d1O4AuBFOHDh5gAitRjl2cp0hHYRYHQ0WAwYqeTqi+HW2XJAU/cCWXF9LFjKH7Q6LBrcQzgbFsn1jwE4gKGl/DxZWFFLMYoUrHU5z/cGfVH8k6Lheu02b9hQIDAQAB

data/lib/companion_api/base.rb

@@ -0,0 +1,35 @@
+module CompanionApi
+  class Base
+    attr_accessor :profile
+    attr_accessor :account
+    attr_accessor :login
+    attr_accessor :market
+
+    def initialize(profile_name)
+      @profile = Profile.new(profile_name)
+      @account = CompanionApi::Resources::Account.new(@profile)
+      @login = CompanionApi::Resources::Login.new(@profile)
+      @market = CompanionApi::Resources::Market.new(@profile)
+    end
+
+    def login!(username, password)
+      raise CompanionApi::Error, 'no username or password specified' if username.blank? || password.blank?
+
+      @account.auto_login!(username, password)
+    end
+
+    def token_auth!
+      @account.token_login!
+
+      url = @account.login_url
+      CompanionApi.config.logger.info("please visit #{url} and hit enter afterwards")
+      gets
+      res = @login.post_auth
+      raise CompanionApi::Error, 'invalid response received' if res['status'] != 200
+    end
+
+    def loggedin?
+      @login.character.present?
+    end
+  end
+end

data/lib/companion_api/configuration.rb

@@ -0,0 +1,28 @@
+module CompanionApi
+  class Configuration
+    attr_accessor :profile_directory
+
+    attr_accessor :directory
+
+    attr_accessor :logger
+
+    attr_accessor :debug
+
+    def initialize
+      @directory = File.join(File.dirname(__FILE__), '..', '..', 'config')
+      @debug = false
+      @logger = Logger.new(STDOUT)
+    end
+  end
+
+  class << self
+    def configure
+      @config ||= Configuration.new
+      yield @config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end

data/lib/companion_api/error.rb

@@ -0,0 +1,5 @@
+module CompanionApi
+  class Error < StandardError; end
+  class LoginError < StandardError; end
+  class TokenExpiredError < StandardError; end
+end

data/lib/companion_api/profile.rb

@@ -0,0 +1,37 @@
+module CompanionApi
+  class Profile
+    attr_accessor :profile_name
+    attr_accessor :file
+    attr_accessor :settings
+
+    def initialize(profile_name)
+      @file = File.join(CompanionApi.config.profile_directory, "#{profile_name}.json")
+      @settings = {}
+
+      load
+    end
+
+    def set(key, value)
+      @settings[key.to_sym] = value
+      save!
+    end
+
+    def get(key)
+      @settings[key.to_sym]
+    end
+
+    protected
+
+    def load
+      return save unless File.exist?(@file)
+
+      @settings = JSON.parse(open(@file).read, symbolize_names: true)
+    end
+
+    def save!
+      File.open(@file, 'w') do |f|
+        f.write(@settings.to_json)
+      end
+    end
+  end
+end

data/lib/companion_api/request.rb

@@ -0,0 +1,96 @@
+module CompanionApi
+  class Request
+    SQEX_AUTH_URI     = 'https://secure.square-enix.com/oauth/oa/oauthauth'.freeze
+    SQEX_LOGIN_URI    = 'https://secure.square-enix.com/oauth/oa/oauthlogin'.freeze
+    OAUTH_CALLBACK    = 'https://companion.finalfantasyxiv.com/api/0/auth/callback'.freeze
+
+    URI     = 'https://companion.finalfantasyxiv.com'.freeze
+    URI_SE  = 'https://secure.square-enix.com'.freeze
+    VERSION = '/sight-v060/sight'.freeze
+
+    attr_accessor :args
+
+    attr_accessor :headers
+
+    def initialize(args = {})
+      defaults = {
+        version:   VERSION,
+        endpoint:  nil,
+        json:      nil,
+        form:      nil,
+        query:     nil,
+        cookies:   nil,
+        redirect:  true,
+        return202: false,
+      }
+
+      @args = args.reverse_merge(defaults)
+
+      raise ComapnionApi::Error, 'maximum redirects reached' if args[:redirects].to_i > 3
+
+      @args[:version] = '' if @args[:uri].include?(URI_SE)
+
+      @headers = {
+        'Accept'          => '*/*',
+        'Accept-Language' => 'en-gb',
+        'Accept-Encoding' => 'br, gzip, deflate',
+        'User-Agent'      => 'ffxivcomapp-e/1.0.3.0 CFNetwork/974.2.1 Darwin/18.0.0',
+        'request-id'      => @args[:requestId] || CompanionApi.uuid,
+        'token'           => @args[:token],
+      }
+
+      @headers = @headers.reverse_merge(args[:headers]) if args[:headers].present?
+    end
+
+    def post!
+      execute!(:post)
+    end
+
+    def get!
+      execute!(:get)
+    end
+
+    protected
+
+    def execute!(method)
+      CompanionApi.debug("executing %{method} to endpoint %{endpoint} with url %{uri}", method: method, endpoint: endpoint, uri: @args[:uri])
+
+      conn = Faraday.new(url: @args[:uri]) do |builder|
+        # builder.response :logger
+        builder.request :url_encoded
+        builder.use FaradayMiddleware::FollowRedirects
+        builder.adapter :httpclient
+
+        # builder.adapter :httpclient do |http|
+        #   http.set_cookie_store("/tmp/test.dat")
+        # end
+      end
+
+      30.times do
+        body = (@args[:json] || @args[:form])
+
+        res = conn.send(method) do |req|
+          req.url(endpoint, @args[:query])
+          req.headers = @headers
+          req.body = body
+        end
+
+        CompanionApi.debug("received status %{status}", status: res.status)
+
+        raise CompanionApi::TokenExpiredError, 'token has expired' if res.status == 403
+
+        return res if @args[:return202] || res.status != 202
+
+        sleep(0.5)
+      end
+
+      raise CompanionApi::Error, 'could not get a valid response after 30 tries'
+    end
+
+    def endpoint
+      return '' if @args[:absolute]
+
+      @args[:version] + @args[:endpoint]
+    end
+  end
+end

data/lib/companion_api/resources/account.rb

@@ -0,0 +1,121 @@
+module CompanionApi
+  module Resources
+    class Account
+      PLATFORM_IOS = 1
+      PLATFORM_ANDROID = 2
+
+      attr_accessor :profile
+
+      def initialize(profile)
+        @profile = profile
+      end
+
+      def auto_login!(username, password)
+        req = CompanionApi::Request.new(
+          uri:       login_url,
+          requestId: CompanionApi.uuid,
+          absolute:  true,
+        )
+
+        res = req.get!
+        body = res.body
+
+        if !body.include?('cis_sessid') && body.include?('loginForm')
+          html = Nokogiri::HTML(body)
+          form = html.at_css("form[id='loginForm']")
+          stored = form.at_css("input[name='_STORED_']")[:value]
+
+          action = CGI.unescape(form[:action])
+
+          data = {
+            "_STORED_": stored,
+            "sqexid":   username,
+            "password": password,
+          }
+
+          req = CompanionApi::Request.new(
+            uri:       CompanionApi::Request::URI_SE,
+            endpoint:  "/oauth/oa/#{action}",
+            requestId: CompanionApi.uuid,
+            # token: profile.get("token"),
+            form:      data,
+          )
+
+          res = req.post!
+          body = res.body
+        end
+
+        html = Nokogiri::HTML(body)
+        form = html.at_css("form[name='mainForm']")
+        raise CompanionApi::LoginError, 'unexpected response received' if form.nil?
+
+        cis_sessid = form.at_css("input[name='cis_sessid']")[:value]
+
+        data = {
+          "cis_sessid": cis_sessid,
+          "provision":  '',
+          "_c":         1,
+        }
+
+        req = CompanionApi::Request.new(
+          uri:       form[:action],
+          absolute:  true,
+          # requestId: CompanionApi.uuid,
+          query:     {
+            token: @profile.get('token'),
+            uid:   @profile.get('uid'),
+          },
+          return202: true,
+          form:      data,
+        )
+
+        res = req.post!
+
+        raise CompanionApi::LoginError, 'Login status could not be validated.' if res.status != 202
+
+        CompanionApi.refresh_uuid
+        true
+      end
+
+      def login_url
+        @profile.set('userId', CompanionApi.uuid)
+
+        json = get_token
+        @profile.set('token', json['token'])
+        @profile.set('salt', json['salt'])
+
+        CompanionApi::Request::SQEX_AUTH_URI + '?' + {
+          'client_id'     => 'ffxiv_comapp',
+          'lang'          => 'en-us',
+          'response_type' => 'code',
+          'redirect_uri'  => redirect_uri,
+        }.to_query
+      end
+
+      def redirect_uri
+        uid = CompanionApi.pbkdf2(@profile.get('userId'), @profile.get('salt'))
+        @profile.set('uid', uid)
+
+        CompanionApi::Request::OAUTH_CALLBACK + '?' + {
+          'token'      => @profile.get('token'),
+          'uid'        => uid,
+          'request_id' => CompanionApi.uuid,
+        }.to_query
+      end
+
+      def get_token
+        crypted_uuid = CompanionApi.rsa.public_encrypt(@profile.get('userId'))
+        uid = Base64.encode64(crypted_uuid)
+
+        req = CompanionApi::Request.new(
+          uri:      CompanionApi::Request::URI,
+          endpoint: '/login/token',
+          json:     { 'platform' => PLATFORM_ANDROID, 'uid' => uid },
+        )
+
+        res = req.post!
+        JSON.parse(res.body)
+      end
+    end
+  end
+end

data/lib/companion_api/resources/login.rb

@@ -0,0 +1,83 @@
+module CompanionApi
+  module Resources
+    class Login
+      attr_accessor :profile
+      attr_accessor :account
+      attr_accessor :characters
+      attr_accessor :character
+
+      def initialize(profile)
+        @profile = profile
+      end
+
+      def post_auth
+        req = CompanionApi::Request.new(
+          uri:       CompanionApi::Request::URI,
+          endpoint:  '/login/auth',
+          requestId: CompanionApi.uuid,
+          token:     @profile.get('token'),
+          query:     {
+            token:      @profile.get('token'),
+            uid:        @profile.get('uid'),
+            request_id: CompanionApi.uuid,
+          },
+        )
+
+        res = req.post!
+        JSON.parse(res.body)
+      end
+
+      def characters
+        return @characters if @characters.present?
+
+        req = CompanionApi::Request.new(
+          uri:      CompanionApi::Request::URI,
+          endpoint: '/login/characters',
+          token:    @profile.get("token"),
+        )
+
+        res = req.get!
+        json = JSON.parse(res.body)
+
+        raise CompanionApi::LoginError, 'no valid accounts found' if json["accounts"].blank?
+
+        @account = json["accounts"][0]
+        @characters = @account["characters"]
+
+        @characters
+      end
+
+      def select_character(cid)
+        req = CompanionApi::Request.new(
+          uri:      CompanionApi::Request::URI,
+          endpoint: "/login/characters/#{cid}",
+          token:    @profile.get("token"),
+          json:     {
+            'appLocaleType' => 'EU',
+          },
+        )
+
+        res = req.post!
+        json = JSON.parse(res.body)
+
+        region = json["region"].chomp("/")
+        @profile.set("region", region)
+
+        load_character
+      end
+
+      def load_character
+        req = CompanionApi::Request.new(
+          uri:      @profile.get('region'),
+          endpoint: '/login/character',
+          token:    @profile.get("token"),
+        )
+
+        res = req.get!
+        json = JSON.parse(res.body)
+
+        @character = json
+      end
+    end
+  end
+end

data/lib/companion_api/resources/market.rb

@@ -0,0 +1,39 @@
+module CompanionApi
+  module Resources
+    class Market
+      attr_accessor :profile
+
+      def initialize(profile)
+        @profile = profile
+      end
+
+      def item_market_listings(item_id, hq: false)
+        endpoint = "/market/items/catalog/#{item_id}"
+        endpoint += "/hq" if hq
+
+        request_result(endpoint)
+      end
+
+      def market_listings_by_category(category_id)
+        request_result("/market/items/category/#{category_id}")
+      end
+
+      def transaction_history(catalog_id)
+        request_result("/market/items/history/catalog/#{catalog_id}")
+      end
+
+      protected
+
+      def request_result(endpoint)
+        req = CompanionApi::Request.new(
+          uri:      @profile.get('region'),
+          endpoint: endpoint,
+          token:    @profile.get("token"),
+        )
+
+        res = req.get!
+        JSON.parse(res.body)
+      end
+    end
+  end
+end

data/lib/companion_api/version.rb

@@ -0,0 +1,3 @@
+module CompanionApi
+  VERSION = '0.1.0'.freeze
+end

data/lib/companion_api.rb

@@ -0,0 +1,51 @@
+require 'faraday'
+require 'httpclient'
+require 'faraday_middleware'
+require 'nokogiri'
+
+require 'json'
+require 'base64'
+require 'openssl'
+require 'securerandom'
+require 'pbkdf2'
+require 'logger'
+
+require 'active_support/core_ext/hash'
+
+require 'companion_api/version'
+require 'companion_api/base'
+require 'companion_api/configuration'
+require 'companion_api/profile'
+require 'companion_api/request'
+require 'companion_api/error'
+
+require 'companion_api/resources/account'
+require 'companion_api/resources/login'
+require 'companion_api/resources/market'
+
+module CompanionApi
+  class << self
+    def uuid
+      @uuid ||= SecureRandom.uuid.upcase
+    end
+
+    def refresh_uuid
+      @uuid = SecureRandom.uuid.upcase
+    end
+
+    def pbkdf2(value, salt)
+      PBKDF2.new(password: value, salt: salt, iterations: 1000, hash_function: OpenSSL::Digest::SHA1, key_length: 128).hex_string
+    end
+
+    def rsa
+      pem = File.read(File.join(CompanionApi.config.directory, 'public-key.pem')).strip
+      OpenSSL::PKey::RSA.new(Base64.decode64(pem))
+    end
+
+    def debug(message, args = {})
+      return if config.debug == false || config.logger.nil?
+
+      config.logger.debug(format(message, args))
+    end
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: companion_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nils Berenbold
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-27 00:00:00.000000000 Z
+dependencies:
+- !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: 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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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: httpclient
+  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'
+description: A Wrapper for the Companion App Api
+email:
+- nils.berenbold@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- companion_api.gemspec
+- config/public-key.pem
+- lib/companion_api.rb
+- lib/companion_api/base.rb
+- lib/companion_api/configuration.rb
+- lib/companion_api/error.rb
+- lib/companion_api/profile.rb
+- lib/companion_api/request.rb
+- lib/companion_api/resources/account.rb
+- lib/companion_api/resources/login.rb
+- lib/companion_api/resources/market.rb
+- lib/companion_api/version.rb
+homepage: https://xivapi.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: A Wrapper for the Companion App Api
+test_files: []