covetous 0.0.1 → 0.1.0

data/README.md

@@ -1,6 +1,6 @@
 # Covetous
 
-TODO: Write a gem description
+Covetous is a Ruby Wrapper for the Diablo 3 Web API
 
 ## Installation
 
@@ -18,7 +18,40 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+As of now, Covetous is just a plain ol' gee-- Ruby gem. He is basically just a Ruby wrapper(as I keep repeating...)
+for the Diablo 3 Web API. After installing, all you have to do is require it where you like and just use it!
+
+Some example usage would be:
+
+### Career Profile
+
+**Note**: Top level keys from the hashes are available as methods for your convenience
+
+    my_profile = Covetous::Profile::Career.new 'corroded-6950'
+    puts my_profile.heroes
+    puts my_profile.kills
+
+### Hero Profile
+
+    my_hero = Covetous::Profile::Hero.new 'corroded-6950', '12793941'
+    puts my_hero.skills
+    puts my_hero.paragon_level
+
+### Artisan Data
+
+    artisan = Covetous::Data::Artisan.new 'blacksmith'
+    puts artisan.name
+
+### Follower Data
+
+    follower = Covetous::Data::Follower.new 'enchantress'
+    puts artisan.name
+
+### Item Data
+
+    item = Covetous::Data::Item.new 'CkMIz4LU4AoSBwgEFX35Tl0dLWYPvh194Mt2Ha3H5XEdElz0_B2H9XtuIgsIARWFQgMAGAAgCjAJOLYEQABIAVAOYPkEGPrl99QLUAZYAA'
+    puts item.name
+    puts item.attributes
 
 ## Contributing
 

data/lib/covetous/profile/career.rb

@@ -1,3 +1,6 @@
+class NoHeroFoundForProfileError < StandardError
+end
+
 module Covetous
   module Profile
     class Career < Covetous::Shen
@@ -9,6 +12,14 @@ module Covetous
       def hero_names
         heroes.map{ |hero| hero['name'] }
       end
+
+      def get_hero_details_of(hero_name)
+        raise NoHeroFoundForProfileError, "No such hero was found under #{battle_tag}" unless hero_names.include? hero_name
+        
+        hero_index = hero_names.index hero_name
+        battle_tag_for_api = battle_tag.gsub('#', '-')
+        Covetous::Profile::Hero.new battle_tag_for_api, heroes[hero_index]['id']
+      end
     end
   end
 end

data/lib/covetous/version.rb

@@ -1,3 +1,3 @@
 module Covetous
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/covetous/{info → data}/item_spec.rb

@@ -15,6 +15,13 @@ describe 'Item' do
     it 'should have the correct url' do
       @my_item.url.must_equal 'http://us.battle.net/api/d3/data/item/CkMIz4LU4AoSBwgEFX35Tl0dLWYPvh194Mt2Ha3H5XEdElz0_B2H9XtuIgsIARWFQgMAGAAgCjAJOLYEQABIAVAOYPkEGPrl99QLUAZYAA'
     end
-  end
 
+    it 'should have the top level keys available as methods' do
+      top_level_keys = %w{ id name icon displayColor tooltipParams requiredLevel itemLevel bonusAffixes typeName type armor attributes attributesRaw socketEffects salvage gems }
+
+      top_level_keys.each do |tl_key|
+        @my_item.send(tl_key).must_equal @my_item.response[tl_key.camelize(:lower)]
+      end
+    end
+  end
 end

data/spec/covetous/profile/career_spec.rb

@@ -34,4 +34,29 @@ describe 'Career' do
       lambda { @my_profile.foo_attribute }.must_raise NoMethodError
     end
   end
+
+  describe '#get_hero_details_of' do
+    before do
+      VCR.use_cassette('sample_hero_data') do
+        @sample_hero_data = Covetous::Profile::Hero.new 'corroded-6950', '20042961'
+      end
+
+      VCR.use_cassette('get_hero_response') do
+        @get_hero_response = @my_profile.get_hero_details_of('corrodee')
+      end
+    end
+
+    after do
+      VCR.eject_cassette
+      VCR.eject_cassette
+    end
+
+    it 'should return a hero object' do
+      @get_hero_response.must_be_instance_of Covetous::Profile::Hero
+    end
+
+    it 'should raise a NoHeroFoundForProfileError when given a wrong hero name' do
+      lambda { @my_profile.get_hero_details_of('multipleman') }.must_raise NoHeroFoundForProfileError
+    end
+  end
 end