armory_api 0.1.0 → 0.1.1

data/.gitignore

@@ -1,6 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
 Gemfile.lock
+
+# YARD artifacts
 .yardoc
-coverage/*
-doc/*
-.bundle
-*.gem
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+matrix:
+  allow_failures:
+      - rvm: ruby-head
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head

data/LICENSE.txt

@@ -0,0 +1,26 @@
+Copyright (c) 2012, Francesco Ceccon
+All rights reserved.
+
+Redistribution and  use in  source and binary  forms, with  or without
+modification, are permitted provided that the following conditions are
+met:
+
+1. Redistributions of  source code  must retain  the above  copyright
+   notice,  this  list of  conditions  and  the following  disclaimer.
+2. Redistributions  in  binary   form  must  reproduce  the  above
+   copyright  notice,  this  list  of  conditions  and  the  following
+   disclaimer  in the  documentation and/or  other materials  provided
+   with the distribution.
+
+
+THIS SOFTWARE  IS PROVIDED BY  THE COPYRIGHT HOLDERS  AND CONTRIBUTORS
+"AS  IS" AND  ANY EXPRESS  OR IMPLIED  WARRANTIES, INCLUDING,  BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES  OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE  ARE DISCLAIMED. IN NO EVENT  SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL,  EXEMPLARY,  OR  CONSEQUENTIAL DAMAGES  (INCLUDING,  BUT  NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE  GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS  INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF  LIABILITY, WHETHER IN  CONTRACT, STRICT LIABILITY,  OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN  ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,4 +1,25 @@
 ArmoryApi
 =========
 
-A Ruby Gem for the World of Warcraft API.
+Ruby wrapper for the official World of Warcraft REST APIs.
+
+Installation
+------------
+
+Usage
+-----
+
+Documentation
+-------------
+
+Acknowledgements
+----------------
+
+ArmoryApi was largely inspired by [sferik's twitter](https://github.com/sferik/twitter)
+gem.
+
+Copyright
+---------
+
+Copyright © 2012 Francesco Ceccon.  
+See LICENSE.txt for details.

data/lib/armory_api/api.rb

@@ -0,0 +1,10 @@
+require 'uri'
+
+module ArmoryApi
+  module API
+
+    def character(realm, name, options={})
+      get("/api/wow/character/#{realm}/#{URI.escape(name)}")
+    end
+  end
+end

data/lib/armory_api/client.rb

@@ -1,7 +1,9 @@
 require 'faraday'
 require 'uri'
 
+require 'armory_api/client/achievement'
 require 'armory_api/client/character'
+require 'armory_api/client/item'
 
 module ArmoryApi
   class Client
@@ -23,7 +25,9 @@ module ArmoryApi
       request(:get, path, params, options)
     end
 
+    include ArmoryApi::Client::Achievement
     include ArmoryApi::Client::Character
+    include ArmoryApi::Client::Item
    private
     def endpoint
       "http://#{@region}.battle.net"

data/lib/armory_api/client/achievement.rb

@@ -0,0 +1,14 @@
+module ArmoryApi
+  class Client
+    module Achievement
+
+      # Retrieves the achievement `id` from the Armory
+      #
+      # @param [Integer] id the achievement id
+      # @return [Hash] the achievement
+      def achievement(id)
+        get("/api/wow/achievement/#{id}")
+      end
+    end
+  end
+end

data/lib/armory_api/client/character.rb

@@ -1,3 +1,5 @@
+require 'uri'
+
 module ArmoryApi
   class Client
     module Character
@@ -8,6 +10,7 @@ module ArmoryApi
       # @param [String] realm
       # @param [Array] fields optional fields, a list can be found on the
       #  [official page](http://blizzard.github.com/api-wow-docs/#character-profile-api)
+      # @return [Hash] the character hash
       def character(name, realm=nil, fields=[])
         if realm.class == Array
           fields = realm
@@ -17,7 +20,7 @@ module ArmoryApi
         raise ArmoryApi::RealmNotFound if realm.nil?
         fields ||= []
         params = { fields: fields.join(',') } unless fields.empty?
-        get("/api/wow/character/#{realm}/#{name}", params)
+        get("/api/wow/character/#{realm}/#{URI.escape(name)}", params)
       end
     end
   end

data/lib/armory_api/client/item.rb

@@ -0,0 +1,28 @@
+module ArmoryApi
+  class Client
+    module Item
+
+      # Retrieve an item
+      #
+      # @param [Integer] id the item id
+      # @return [Hash] the item
+      def item(id)
+        get("/api/wow/item/#{id}")
+      end
+
+      # Retrieve an item set.  
+      # If full is set to true ArmoryApi will retrieve each item of the set.
+      #
+      # @param [Integer] id the set id
+      # @param [Boolean] full also retrieve each item of the set
+      # @return [Hash] the item set
+      def item_set(id, full=false)
+        res = get("/api/wow/item/set/#{id}")
+        if full
+          res.items.map! {|i| item(i)}
+        end
+        res
+      end
+    end
+  end
+end

data/lib/armory_api/configurable.rb

@@ -0,0 +1,41 @@
+require 'armory_api/default'
+
+module ArmoryApi
+  module Configurable
+    attr_writer :region, :locale
+    attr_accessor :region, :locale, :endpoint, :connection_options, :middleware
+
+    class << self
+
+      def keys
+        @keys ||= [
+          :region,
+          :locale,
+          :connection_options,
+          :middleware
+        ]
+      end
+    end
+
+    def configure
+      yield self
+      self
+    end
+
+    def reset!
+      ArmoryApi::Configurable.keys.each do |k|
+        instance_variable_set(:"@#{k}", ArmoryApi::Default.options[k])
+      end
+      self
+    end
+    alias setup reset!
+
+    def endpoint
+      if region == 'cn'
+        "www.battlenet.com.cn"
+      else
+        "http://#{region}.battle.net"
+      end
+    end
+  end
+end

data/lib/armory_api/default.rb

@@ -0,0 +1,45 @@
+require 'faraday'
+require 'armory_api/version'
+
+module ArmoryApi
+  module Default
+    REGION = 'us' unless defined? REGION
+    LOCALE = 'en_US' unless defined? LOCALE
+    CONNECTION_OPTIONS = {
+      headers: {
+        user_agent: "ArmoryApi Ruby Gem (#{ArmoryApi::Version})"
+      },
+      raw: true,
+      timeout: 10
+    } unless defined? CONNECTION_OPTIONS
+    MIDDLEWARE = Faraday::Builder.new(
+      &Proc.new do |builder|
+        builder.adapter Faraday.default_adapter
+      end
+    )
+
+    class << self
+
+      # @return [Hash]
+      def options
+        Hash[ArmoryApi::Configurable.keys.each.map{|k| [k, send(k)]}]
+      end
+
+      def region
+        REGION
+      end
+
+      def locale
+        LOCALE
+      end
+
+      def connection_options
+        CONNECTION_OPTIONS
+      end
+
+      def middleware
+        MIDDLEWARE
+      end
+    end
+  end
+end

data/lib/armory_api/version.rb

@@ -1,3 +1,3 @@
 module ArmoryApi
-  VERSION = "0.1.0" unless defined?(ArmoryApi::VERSION)
+  VERSION = "0.1.1" unless defined?(ArmoryApi::VERSION)
 end

data/spec/armory_api/client/achievement_spec.rb

@@ -0,0 +1,16 @@
+require 'helper'
+
+describe ArmoryApi::Client::Achievement do
+  describe ".achievement" do
+    before do
+      @client = ArmoryApi::Client.new
+    end
+
+    it "returns the specified achievement" do
+      stub_request(:get, 'http://us.battle.net/api/wow/achievement/2144')
+        .to_return(body: fixture('achievement/achievement.json'))
+      achievement = @client.achievement(2144)
+      expect(achievement.id).to eq 2144
+    end
+  end
+end

data/spec/armory_api/client/character_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'helper'
 
 describe ArmoryApi::Client::Character do
@@ -46,5 +47,14 @@ describe ArmoryApi::Client::Character do
         expect(char.feed).to be_an Array
       end
     end
+
+    context "with a name rich name" do
+      it "works" do
+        stub_request(:get, 'http://us.battle.net/api/wow/character/realm/Nor%C3%B0ri')
+          .to_return(body: fixture('character/character.json'))
+        char = ArmoryApi.character('Norðri', 'realm')
+        expect(char.name).not_to be_nil
+      end
+    end
   end
 end

data/spec/armory_api/client/item_spec.rb

@@ -0,0 +1,43 @@
+require 'helper'
+
+describe ArmoryApi::Client::Item do
+  before do
+    @client = ArmoryApi::Client.new
+  end
+
+  describe ".item" do
+    it "returns the item" do
+      stub_request(:get, 'http://us.battle.net/api/wow/item/18803')
+        .to_return(body: fixture('item/item.json'))
+      item = @client.item(18803)
+      expect(item.id).to eq 18803
+    end
+  end
+
+  describe ".item_set" do
+    context "with full set to true" do
+      it "returns the set with each item informations" do
+        stub_request(:get, 'http://us.battle.net/api/wow/item/set/1060')
+          .to_return(body: fixture('item/item-set.json'))
+        5.times do
+          stub_request(:get, /http:\/\/us.battle.net\/api\/wow\/item\/\d*$/)
+            .to_return(body: fixture('item/item.json'))
+        end
+        set = @client.item_set(1060, true)
+        expect(set.id).to eq 1060
+        set.items.each do |item|
+          expect(item).to be_a Hash
+        end
+      end
+    end
+
+    context "without full set to true" do
+      it "returns the set" do
+        stub_request(:get, 'http://us.battle.net/api/wow/item/set/1060')
+          .to_return(body: fixture('item/item-set.json'))
+        set = @client.item_set(1060)
+        expect(set.id).to eq 1060
+      end
+    end
+  end
+end

data/spec/fixtures/achievement/achievement.json

@@ -0,0 +1,68 @@
+{
+    "accountWide": true, 
+    "criteria": [
+        {
+            "description": "To Honor One's Elders", 
+            "id": 7553, 
+            "max": 1, 
+            "orderIndex": 0
+        }, 
+        {
+            "description": "Fool For Love", 
+            "id": 7561, 
+            "max": 1, 
+            "orderIndex": 1
+        }, 
+        {
+            "description": "Noble Gardener", 
+            "id": 9880, 
+            "max": 1, 
+            "orderIndex": 2
+        }, 
+        {
+            "description": "For The Children", 
+            "id": 7555, 
+            "max": 1, 
+            "orderIndex": 3
+        }, 
+        {
+            "description": "The Flame Warden/Keeper", 
+            "id": 0, 
+            "max": 1, 
+            "orderIndex": 4
+        }, 
+        {
+            "description": "Brewmaster", 
+            "id": 7564, 
+            "max": 1, 
+            "orderIndex": 5
+        }, 
+        {
+            "description": "Hallowed Be Thy Name", 
+            "id": 7558, 
+            "max": 1, 
+            "orderIndex": 6
+        }, 
+        {
+            "description": "Merrymaker", 
+            "id": 7566, 
+            "max": 1, 
+            "orderIndex": 7
+        }
+    ], 
+    "description": "Complete the world events achievements listed below.", 
+    "icon": "achievement_bg_masterofallbgs", 
+    "id": 2144, 
+    "points": 50, 
+    "reward": "Rewards: Violet Proto-Drake", 
+    "rewardItems": [
+        {
+            "icon": "ability_mount_drake_proto", 
+            "id": 44177, 
+            "name": "Reins of the Violet Proto-Drake", 
+            "quality": 4, 
+            "tooltipParams": {}
+        }
+    ], 
+    "title": "What a Long, Strange Trip It's Been"
+}

data/spec/fixtures/item/item-set.json

@@ -0,0 +1,21 @@
+{
+    "id": 1060, 
+    "items": [
+        76749, 
+        76750, 
+        76751, 
+        76752, 
+        76753
+    ], 
+    "name": "Deep Earth Vestments", 
+    "setBonuses": [
+        {
+            "description": "After using Innervate, the mana cost of your healing spells is reduced by 25% for 15 sec.", 
+            "threshold": 2
+        }, 
+        {
+            "description": "Your Rejuvenation and Regrowth spells have a 10% chance to Timeslip and have double the normal duration.", 
+            "threshold": 4
+        }
+    ]
+}

data/spec/fixtures/item/item.json

@@ -0,0 +1,65 @@
+{
+    "armor": 0, 
+    "baseArmor": 0, 
+    "bonusStats": [
+        {
+            "amount": 15, 
+            "reforged": false, 
+            "stat": 51
+        }, 
+        {
+            "amount": 24, 
+            "reforged": false, 
+            "stat": 5
+        }, 
+        {
+            "amount": 22, 
+            "reforged": false, 
+            "stat": 6
+        }, 
+        {
+            "amount": 25, 
+            "reforged": false, 
+            "stat": 7
+        }
+    ], 
+    "buyPrice": 474384, 
+    "containerSlots": 0, 
+    "description": "Property of Finkle Einhorn, Grandmaster Adventurer", 
+    "disenchantingSkillRank": 225, 
+    "displayInfoId": 31265, 
+    "equippable": true, 
+    "hasSockets": false, 
+    "icon": "inv_gizmo_02", 
+    "id": 18803, 
+    "inventoryType": 17, 
+    "isAuctionable": false, 
+    "itemBind": 1, 
+    "itemClass": 2, 
+    "itemLevel": 70, 
+    "itemSource": {
+        "sourceId": 179703, 
+        "sourceType": "GAME_OBJECT_DROP"
+    }, 
+    "itemSpells": [], 
+    "itemSubClass": 5, 
+    "maxCount": 0, 
+    "maxDurability": 120, 
+    "minFactionId": 0, 
+    "minReputation": 0, 
+    "name": "Finkle's Lava Dredger", 
+    "quality": 4, 
+    "requiredLevel": 60, 
+    "requiredSkill": 0, 
+    "requiredSkillRank": 0, 
+    "sellPrice": 94876, 
+    "stackable": 1, 
+    "weaponInfo": {
+        "damage": {
+            "max": 239, 
+            "min": 159
+        }, 
+        "dps": 68.62069, 
+        "weaponSpeed": 2.9
+    }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: armory_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-19 00:00:00.000000000 Z
+date: 2013-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &14270420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *14270420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &14269700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *14269700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &14269100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *14269100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &14268540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *14268540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &14268040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +85,15 @@ dependencies:
         version: '1.7'
   type: :development
   prerelease: false
-  version_requirements: *14268040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &14267620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +101,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14267620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &14267060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14267060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &14266500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +133,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14266500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &14264940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +149,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14264940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &14263780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +165,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14263780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Wrapper for the World of Warcraft API
 email:
 - francesco@ceccon.me
@@ -130,23 +180,35 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - armory_api.gemspec
 - lib/armory_api.rb
+- lib/armory_api/api.rb
 - lib/armory_api/client.rb
+- lib/armory_api/client/achievement.rb
 - lib/armory_api/client/character.rb
+- lib/armory_api/client/item.rb
+- lib/armory_api/configurable.rb
 - lib/armory_api/configuration.rb
+- lib/armory_api/default.rb
 - lib/armory_api/error.rb
 - lib/armory_api/version.rb
 - lib/faraday/response/raise_armory_api_error.rb
+- spec/armory_api/client/achievement_spec.rb
 - spec/armory_api/client/character_spec.rb
+- spec/armory_api/client/item_spec.rb
 - spec/armory_api/client_spec.rb
 - spec/armory_api_spec.rb
 - spec/faraday/response_spec.rb
+- spec/fixtures/achievement/achievement.json
 - spec/fixtures/character/character-feed.json
 - spec/fixtures/character/character.json
+- spec/fixtures/item/item-set.json
+- spec/fixtures/item/item.json
 - spec/helper.rb
 homepage: https://github.com/fracek/armory_api
 licenses: []
@@ -168,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Wrapper for the World of Warcraft API