godville_kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c27965def16332d0f30147863804dd8dc70341d
+  data.tar.gz: d2691ac5187e3be0babd1afcba48c92d310f66ba
+SHA512:
+  metadata.gz: 67d666fdf8fd2f22044d56775496e40b4766cf4cd2144ec0daba6500e62f125aab9b63d4037d4ce5b9cdd5ab89631408703b9fe539c187707faa24f51d90f9bc
+  data.tar.gz: 68a204eea2a2d77b198c1721e941d5a56aeed9650107556885db8d447d4965508233eec93fb699d6f52a2894d98f2950992de508997072da5c62de50f5b35be7

data/lib/godville_kit.rb

@@ -0,0 +1 @@
+require 'godville_kit/initialize'

data/lib/godville_kit/api_requester.rb

@@ -0,0 +1,77 @@
+module GodvilleKit
+  class APIRequester
+    attr_reader :username,
+                :password,
+                :hero_guid,
+                :pantheons_guid
+
+    class UnexpectedResponseException < StandardError; end
+    class InvalidAuthenticationException < StandardError; end
+    class AuthenticationCaptchaException < StandardError; end
+
+    def initialize(username, password, hero_guid, pantheons_guid)
+      @username = username
+      @password = password
+      @hero_guid = hero_guid
+      @pantheons_guid = pantheons_guid
+    end
+
+    def request_hero
+      authenticate
+      GodvilleKit::Hero.new(request_raw_hero_data, request_raw_pantheons_data)
+    end
+
+    def authenticate
+      return if authenticated?
+
+      RestClient.post(
+        'https://godvillegame.com/login/login',
+        { username: @username,
+          password: @password },
+        content_type: :json, accept: :json
+      )do |response, request, result, &block|
+        case response.code
+        when 302
+          @cookies = response.cookies
+        when 200
+          if response.to_s.include? 'captcha'
+            raise AuthenticationCaptchaException, 'Too many failed logins, manual login required due to captcha'
+          else
+            raise InvalidAuthenticationException, 'Invalid Username/Password'
+          end
+        else
+          raise UnexpectedResponseCodeException, "Unexpected response code #{response.code}"
+        end
+      end
+    rescue => e
+      @cookies = nil
+      puts e.message
+    end
+
+    def authenticated?
+      !@cookies.nil?
+    end
+
+    # Request the raw hero data from godville
+    def request_raw_hero_data
+      return unless authenticated?
+
+      response = RestClient.get(
+        "https://godvillegame.com/fbh/feed?a=#{@hero_guid}",
+        cookies: @cookies, content_type: :json, accept: :json
+      )
+      JSON.parse(response)
+    end
+
+    # Request the raw pantheons data from godville
+    def request_raw_pantheons_data
+      return unless authenticated?
+
+      response = RestClient.get(
+        "https://godvillegame.com/fbh/feed?a=#{@pantheons_guid}",
+        cookies: @cookies, content_type: :json, accept: :json
+      )
+      JSON.parse(response)
+    end
+  end
+end

data/lib/godville_kit/diary_entry.rb

@@ -0,0 +1,11 @@
+module GodvilleKit
+  class DiaryEntry
+    attr_reader :message,
+                :time
+
+    def initialize(raw_diary_entry_data)
+      @message = raw_diary_entry_data['msg'].to_s
+      @time = raw_diary_entry_data['time'].to_s
+    end
+  end
+end

data/lib/godville_kit/equipment.rb

@@ -0,0 +1,21 @@
+module GodvilleKit
+  class Equipment
+    attr_reader :weapon,
+                :shield,
+                :head,
+                :body,
+                :arms,
+                :legs,
+                :tailsman
+
+    def initialize(raw_equipment_data)
+      @weapon = GodvilleKit::Gear.new(raw_equipment_data['weapon'])
+      @shield = GodvilleKit::Gear.new(raw_equipment_data['shield'])
+      @head = GodvilleKit::Gear.new(raw_equipment_data['head'])
+      @body = GodvilleKit::Gear.new(raw_equipment_data['body'])
+      @arms = GodvilleKit::Gear.new(raw_equipment_data['arms'])
+      @legs = GodvilleKit::Gear.new(raw_equipment_data['legs'])
+      @talisman = GodvilleKit::Gear.new(raw_equipment_data['talisman'])
+    end
+  end
+end

data/lib/godville_kit/gear.rb

@@ -0,0 +1,11 @@
+module GodvilleKit
+  class Gear
+    attr_reader :name,
+                :level
+
+    def initialize(raw_gear_data)
+      @name = raw_gear_data['name'].to_s
+      @level = raw_gear_data['level'].to_s
+    end
+  end
+end

data/lib/godville_kit/hero.rb

@@ -0,0 +1,106 @@
+module GodvilleKit
+  class Hero
+    attr_reader :name,
+                :god_name,
+                :level,
+                :quest,
+                :quest_progress,
+                :exp_progress,
+                :health,
+                :max_health,
+                :alignment,
+                :motto,
+                :guild,
+                :guild_rank,
+                :ark,
+                :temple_completed_at,
+                :ark_completed_at,
+                :town,
+                :next_town,
+                :distance,
+                :bricks,
+                :wood,
+                :god_power,
+                :gold,
+                :monsters_killed,
+                :deaths,
+                :arena_wins,
+                :arena_losses,
+                :approximate_age,
+                :birthday,
+                :accumulator,
+                :quests_completed,
+                :monster_name,
+                :monster_progress,
+                :aura_name,
+                :aura_time,
+                :max_inventory,
+                :inventory,
+                :pantheons,
+                :equipment,
+                :skills,
+                :diary
+
+    def initialize(raw_hero_data, raw_pantheons_data)
+      if raw_hero_data
+        @name = raw_hero_data['hero']['name'].to_s
+        @god_name = raw_hero_data['hero']['godname'].to_s
+        @level = raw_hero_data['hero']['level'].to_s
+        @quest = raw_hero_data['hero']['quest'].to_s
+        @quest_progress = raw_hero_data['hero']['quest_progress'].to_s
+        @exp_progress = raw_hero_data['hero']['exp_progress'].to_s
+        @health = raw_hero_data['hero']['health'].to_s
+        @max_health = raw_hero_data['hero']['max_health'].to_s
+        @alignment = raw_hero_data['hero']['alignment'].to_s
+        @motto = raw_hero_data['hero']['motto'].to_s
+        @guild = raw_hero_data['hero']['clan'].to_s
+        @guild_rank = raw_hero_data['hero']['clan_position'].to_s
+        @temple_completed_at = raw_hero_data['hero']['temple_completed_at'].to_s
+        @ark_completed_at = raw_hero_data['hero']['ark_completed_at'].to_s
+        @town = raw_hero_data['hero']['town_name'].to_s
+        @next_town = raw_hero_data['hero']['c_town'].to_s
+        @distance = raw_hero_data['hero']['distance'].to_s
+        @bricks = raw_hero_data['hero']['bricks_cnt'].to_s
+        @wood = raw_hero_data['hero']['wood'].to_s
+        @god_power = raw_hero_data['hero']['godpower'].to_s
+        @gold = raw_hero_data['hero']['gold'].to_s
+        @monsters_killed = raw_hero_data['hero']['monsters_killed'].to_s
+        @deaths = raw_hero_data['hero']['death_count'].to_s
+        @arena_wins = raw_hero_data['hero']['arena_won'].to_s
+        @arena_losses = raw_hero_data['hero']['arena_lost'].to_s
+        @approximate_age = raw_hero_data['hero']['age_str'].to_s
+        @birthday = raw_hero_data['hero']['birthday'].to_s
+        @accumulator = raw_hero_data['hero']['accumulator'].to_s
+        @quests_completed = raw_hero_data['hero']['quests_completed'].to_s
+        @monster_name = raw_hero_data['hero']['monster_name'].to_s
+        @monster_progress = raw_hero_data['hero']['monster_progress'].to_s
+        @aura_name = raw_hero_data['hero']['aura_name'].to_s
+        @aura_time = raw_hero_data['hero']['aura_time'].to_s
+        @max_inventory = raw_hero_data['hero']['inventory_max_num'].to_s
+
+        # Inventory
+        @inventory = raw_hero_data['inventory'].keys.map do |key|
+          GodvilleKit::Item.new(key, raw_hero_data['inventory'][key].to_s)
+        end
+
+        # Equipment
+        @equipment = GodvilleKit::Equipment.new(raw_hero_data['equipment'])
+
+        # Skils
+        @skills = raw_hero_data['skills'].map do |raw_skill_data|
+          GodvilleKit::Skill.new(raw_skill_data)
+        end
+
+        # Diary
+        @diary = raw_hero_data['diary'].map do |raw_diary_entry_data|
+          GodvilleKit::DiaryEntry.new(raw_diary_entry_data)
+        end
+      end
+
+      # Pantheons
+      if raw_pantheons_data
+        @pantheons = GodvilleKit::Pantheons.new(raw_pantheons_data)
+      end
+    end
+  end
+end

data/lib/godville_kit/initialize.rb

@@ -0,0 +1,4 @@
+require 'rest_client'
+require 'json'
+
+Dir.glob(File.dirname(__FILE__) + '/**/*.rb') { |file| require file }

data/lib/godville_kit/item.rb

@@ -0,0 +1,18 @@
+module GodvilleKit
+  class Item
+    attr_reader :name,
+                :activate_by_use,
+                :god_power_required,
+                :description,
+                :type
+
+    def initialize(name, raw_item_data)
+      @name = name
+
+      @activate_by_use = raw_item_data['activate_by_user'].to_s
+      @god_power_required = raw_item_data['needs_godpower'].to_s
+      @description = raw_item_data['description'].to_s
+      @type = raw_item_data['type'].to_s
+    end
+  end
+end

data/lib/godville_kit/pantheons.rb

@@ -0,0 +1,47 @@
+module GodvilleKit
+  class Pantheons
+    attr_reader :gratitude,
+                :might,
+                :templehood,
+                :gladiatorship,
+                :storytelling,
+                :mastery,
+                :construction,
+                :taming,
+                :survival,
+                :savings,
+                :creation,
+                :destruction,
+                :arkeology,
+                :unity,
+                :popularity,
+                :aggressiveness
+
+    def initialize(raw_pantheons_data)
+      pantheon_groups = raw_pantheons_data['groups'].map do |groups|
+        groups['pantheons']
+      end
+
+      pantheon_groups.each do |pantheons|
+        pantheons.each do |pantheon|
+          case pantheon['name'].downcase
+          when 'gratitude' then @gratitude = pantheon['position'].to_s
+          when 'might' then @might = pantheon['position'].to_s
+          when 'templehood' then @templehood = pantheon['position'].to_s
+          when 'gladiatorship' then @gladiatorship = pantheon['position'].to_s
+          when 'storytelling' then @storytelling = pantheon['position'].to_s
+          when 'mastery' then @mastery = pantheon['position'].to_s
+          when 'taming' then @taming = pantheon['position'].to_s
+          when 'survival' then @survival = pantheon['position'].to_s
+          when 'creation' then @creation = pantheon['position'].to_s
+          when 'destruction' then @destruction = pantheon['position'].to_s
+          when 'arkeology' then @arkeology = pantheon['position'].to_s
+          when 'unity' then @unity = pantheon['position'].to_s
+          when 'popularity' then @popularity = pantheon['position'].to_s
+          when 'aggressiveness' then @aggressiveness = pantheon['position'].to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/godville_kit/skill.rb

@@ -0,0 +1,13 @@
+module GodvilleKit
+  class Skill
+    attr_reader :name,
+                :level,
+                :type
+
+    def initialize(raw_skill_data)
+      @name = raw_skill_data['name'].to_s
+      @level = raw_skill_data['level'].to_s
+      @type = raw_skill_data['type'].to_s
+    end
+  end
+end

data/lib/godville_kit/version.rb

@@ -0,0 +1,3 @@
+module GodvilleKit
+  VERSION = '0.1.0'
+end

data/spec/godville_kit/api_requester_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe 'APIRequester' do
+  subject { GodvilleKit::APIRequester.new(nil, nil, nil, nil) }
+
+  describe '#request_raw_hero_data' do
+    context 'when authenticated' do
+      it 'returns json' do
+        allow(subject).to receive(:authenticated?) { true }
+        allow(RestClient).to receive(:get) { fixture_contents('raw_hero_data.json') }
+        expect(subject.request_raw_hero_data).to be_a(Hash)
+      end
+    end
+
+    context 'when not authenticated' do
+      it 'returns nil' do
+        allow(subject).to receive(:authenticated?) { false }
+        allow(RestClient).to receive(:get) { fixture_contents('raw_hero_data.json') }
+        expect(subject.request_raw_hero_data).to be_nil
+      end
+    end
+  end
+
+  describe '#request_raw_pantheons_data' do
+    context 'when authenticated' do
+      it 'returns json' do
+        allow(subject).to receive(:authenticated?) { true }
+        allow(RestClient).to receive(:get) { fixture_contents('raw_pantheons_data.json') }
+        expect(subject.request_raw_pantheons_data).to be_a(Hash)
+      end
+    end
+
+    context 'when not authenticated' do
+      it 'returns nil' do
+        allow(subject).to receive(:authenticated?) { false }
+        allow(RestClient).to receive(:get) { fixture_contents('raw_pantheons_data.json') }
+        expect(subject.request_raw_pantheons_data).to be_nil
+      end
+    end
+  end
+
+  describe '#request_hero' do
+    before do
+      allow(subject).to receive(:authenticate)
+      allow(subject).to receive(:request_raw_hero_data)
+      allow(subject).to receive(:request_raw_pantheons_data)
+    end
+
+    it 'returns valid hero object' do
+      expect(subject.request_hero).to be_a(GodvilleKit::Hero)
+    end
+  end
+end

data/spec/godville_kit/hero_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe 'Hero' do
+  subject { GodvilleKit::Hero.new(raw_hero_data, raw_pantheons_data) }
+
+  let(:raw_hero_data) { JSON.parse(fixture_contents('raw_hero_data.json')) }
+  let(:raw_pantheons_data) { JSON.parse(fixture_contents('raw_pantheons_data.json')) }
+
+  describe '#new' do
+    it { should be_a(GodvilleKit::Hero) }
+    its(:equipment) { should be_a(GodvilleKit::Equipment) }
+    its('equipment.weapon') { should be_a(GodvilleKit::Gear) }
+    its('inventory.first') { should be_a(GodvilleKit::Item) }
+    its('skills.first') { should be_a(GodvilleKit::Skill) }
+    its('diary.first') { should be_a(GodvilleKit::DiaryEntry) }
+
+    context 'with no raw_hero_data' do
+      let(:raw_hero_data) { nil }
+
+      its(:pantheons) { should be_a(GodvilleKit::Pantheons) }
+      its(:equipment) { should be_nil }
+      its('inventory') { should be_nil }
+      its('skills') { should be_nil }
+      its('diary') { should be_nil }
+    end
+
+    context 'with no raw_pantheons_data' do
+      let(:raw_pantheons_data) { nil }
+
+      its(:pantheons) { should be_nil }
+      its(:equipment) { should be_a(GodvilleKit::Equipment) }
+      its('equipment.weapon') { should be_a(GodvilleKit::Gear) }
+      its('inventory.first') { should be_a(GodvilleKit::Item) }
+      its('skills.first') { should be_a(GodvilleKit::Skill) }
+      its('diary.first') { should be_a(GodvilleKit::DiaryEntry) }
+    end
+
+    context 'with no raw_hero_data and raw_pantheons_data' do
+      let(:raw_hero_data) { nil }
+      let(:raw_pantheons_data) { nil }
+
+      its(:pantheons) { should be_nil }
+      its(:equipment) { should be_nil }
+      its('inventory') { should be_nil }
+      its('skills') { should be_nil }
+      its('diary') { should be_nil }
+    end
+  end
+end

data/spec/godville_kit/pantheons_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'Pantheons' do
+  subject { GodvilleKit::Pantheons.new(raw_pantheons_data) }
+
+  let(:raw_pantheons_data) { JSON.parse(fixture_contents('raw_pantheons_data.json')) }
+
+  describe '#new' do
+    it { should be_a(GodvilleKit::Pantheons) }
+    its(:gratitude) { should eq('−') }
+    its(:might) { should eq('−') }
+    its(:templehood) { should eq('−') }
+    its(:gladiatorship) { should eq('−') }
+    its(:storytelling) { should eq('−') }
+    its(:mastery) { should eq('12269') }
+    its(:taming) { should eq('−') }
+    its(:survival) { should eq('2607') }
+    its(:creation) { should eq('163') }
+    its(:destruction) { should eq('−') }
+    its(:arkeology) { should eq('−') }
+    its(:unity) { should eq('2') }
+    its(:popularity) { should eq('4') }
+    its(:aggressiveness) { should eq('2') }
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: godville_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Jalbert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-09 00:00:00.000000000 Z
+dependencies: []
+description: A gem kit to instantiate your hero's state from Godville
+email:
+- kevin.j.jalbert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/godville_kit.rb
+- lib/godville_kit/api_requester.rb
+- lib/godville_kit/diary_entry.rb
+- lib/godville_kit/equipment.rb
+- lib/godville_kit/gear.rb
+- lib/godville_kit/hero.rb
+- lib/godville_kit/initialize.rb
+- lib/godville_kit/item.rb
+- lib/godville_kit/pantheons.rb
+- lib/godville_kit/skill.rb
+- lib/godville_kit/version.rb
+- spec/godville_kit/api_requester_spec.rb
+- spec/godville_kit/hero_spec.rb
+- spec/godville_kit/pantheons_spec.rb
+homepage: https://github.com/kevinjalbert/godville_kit
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A gem kit to instantiate your hero's state from Godville
+test_files:
+- spec/godville_kit/api_requester_spec.rb
+- spec/godville_kit/hero_spec.rb
+- spec/godville_kit/pantheons_spec.rb