diablo3_api 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in diablo3_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mikhail Nikalyukin
+
+MIT License
+
+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,26 @@
+# Diablo3Api
+
+Ruby Wrapper for Diablo 3 API that let you fetch your d3 profile
+
+## Installation
+
+Install gem:
+
+    $ gem install diablo3_api
+
+## Usage
+
+```ruby
+  require 'diablo3_api'
+  player = Diablo3Api::Player.new("Dpsk-2824")
+  puts player.inspect
+```
+``player`` variable now contains information about requested profile.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/diablo3_api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'diablo3_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "diablo3_api"
+  spec.version       = Diablo3Api::VERSION
+  spec.authors       = ["Mikhail Nikalyukin"]
+  spec.email         = ["idups1k@gmail.com"]
+  spec.description   = %q{Simple Ruby client for Diablo 3 API}
+  spec.summary       = %q{Ruby Wrapper for Diablo 3 API that let you fetch your d3 profile}
+  spec.homepage      = "https://github.com/dpsk/diablo3_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "httparty"
+  spec.add_development_dependency "webmock", "~> 1.8.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "rake"
+end

data/lib/diablo3_api.rb

@@ -0,0 +1,8 @@
+require 'diablo3_api/version'
+require 'diablo3_api/configuration'
+require 'diablo3_api/client'
+require 'diablo3_api/player'
+
+module Diablo3Api
+  extend Configuration
+end

data/lib/diablo3_api/client.rb

@@ -0,0 +1,21 @@
+module Diablo3Api
+
+  class Client
+
+    attr_accessor *Configuration::VALID_CONFIG_KEYS
+
+    def initialize(options={})
+      # Merge the config values from the module and those passed
+      # to the client.
+      merged_options = Diablo3Api.options.merge(options)
+
+      # Copy the merged values to this client and ignore those
+      # not part of our configuration
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+  end
+
+end

data/lib/diablo3_api/configuration.rb

@@ -0,0 +1,31 @@
+module Diablo3Api
+  module Configuration
+    VALID_CONFIG_KEYS    = [:endpoint, :user_agent, :method, :format].freeze
+
+    DEFAULT_ENDPOINT    = 'http://us.battle.net/api/d3'
+    DEFAULT_METHOD      = :get
+    DEFAULT_USER_AGENT  = "diablo3_api Ruby Gem #{Diablo3Api::VERSION}".freeze
+    DEFAULT_FORMAT       = :json
+
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.endpoint   = DEFAULT_ENDPOINT
+      self.method     = DEFAULT_METHOD
+      self.user_agent = DEFAULT_USER_AGENT
+      self.format     = DEFAULT_FORMAT
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+  end
+end

data/lib/diablo3_api/player.rb

@@ -0,0 +1,22 @@
+require 'httparty'
+
+module Diablo3Api
+
+  class Player
+
+    attr_accessor :username
+
+    include HTTParty
+    base_uri Diablo3Api::Configuration::DEFAULT_ENDPOINT
+
+    def initialize(username)
+      self.username = username
+    end
+
+    def profile
+      self.class.get "/profile/#{self.username}/"
+    end
+
+  end
+
+end

data/lib/diablo3_api/version.rb

@@ -0,0 +1,3 @@
+module Diablo3Api
+  VERSION = "0.0.1"
+end

data/spec/diablo3_api/client_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Diablo3Api::Client do
+
+  before do
+    @keys = Diablo3Api::Configuration::VALID_CONFIG_KEYS
+  end
+
+  describe 'with module configuration' do
+    before do
+      Diablo3Api.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      Diablo3Api.reset
+    end
+
+    it "should inherit module configuration" do
+      api = Diablo3Api::Client.new
+      @keys.each do |key|
+        api.send(key).should eql key
+      end
+    end
+
+    describe 'with class configuration' do
+      before do
+        @config = {
+          :format     => 'of',
+          :endpoint   => 'ep',
+          :user_agent => 'ua',
+          :method     => 'hm',
+        }
+      end
+
+      it 'should override module configuration' do
+        api = Diablo3Api::Client.new(@config)
+        @keys.each do |key|
+          api.send(key).should eql @config[key]
+        end
+      end
+
+      it 'should override module configuration after' do
+        api = Diablo3Api::Client.new
+
+        @config.each do |key, value|
+          api.send("#{key}=", value)
+        end
+
+        @keys.each do |key|
+          api.send("#{key}").should eql @config[key]
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/diablo3_api/configuration_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+describe 'configuration' do
+
+  Diablo3Api::Configuration::VALID_CONFIG_KEYS.each do |key|
+    describe ".#{key}" do
+      it 'should return the default value' do
+        Diablo3Api.send(key).should eql Diablo3Api::Configuration.const_get("DEFAULT_#{key.upcase}")
+      end
+    end
+  end
+
+  describe '.configure' do
+    after { Diablo3Api.reset }
+    Diablo3Api::Configuration::VALID_CONFIG_KEYS.each do |key|
+      it "should set the #{key}" do
+        Diablo3Api.configure do |config|
+          config.send("#{key}=", key)
+          Diablo3Api.send(key).should eql key
+        end
+      end
+    end
+  end 
+end

data/spec/diablo3_api/diablo3_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Diablo3Api do
+  it 'should have a version' do
+    Diablo3Api::VERSION.should_not be_nil
+  end
+end

data/spec/diablo3_api/player_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Diablo3Api::Player do
+  describe "default instance attributes" do
+
+    let(:player) { Diablo3Api::Player.new("Dpsk-2824") }
+
+    it "must have an id attribute" do
+      player.should respond_to :username
+    end
+
+    it "must have the right id" do
+      player.username.should eql 'Dpsk-2824'
+    end
+
+  end
+
+  describe "GET profile" do
+
+    let(:player) { Diablo3Api::Player.new("Dpsk-2824") }
+
+    before do
+      VCR.insert_cassette 'base', :record => :new_episodes
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    it "must have a profile method" do
+      player.should respond_to :profile
+    end
+
+    it "must parse the api response from JSON to Hash" do
+      player.profile.should be_instance_of Hash
+    end
+  end
+end

data/spec/fixtures/vcr_cassettes/base.yml

@@ -0,0 +1,678 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://us.battle.net/api/d3/profile/Dpsk-2824/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 22 Aug 2013 14:58:59 GMT
+      Server:
+      - Apache
+      X-Frame-Options:
+      - SAMEORIGIN
+      Content-Language:
+      - en-US
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json;charset=UTF-8
+    body:
+      encoding: US-ASCII
+      string: ! '{
+
+        "heroes" : [ {
+
+        "name" : "Vas",
+
+        "id" : 32351570,
+
+        "level" : 37,
+
+        "hardcore" : false,
+
+        "paragonLevel" : 0,
+
+        "gender" : 1,
+
+        "dead" : false,
+
+        "class" : "wizard",
+
+        "last-updated" : 1365105795
+
+        }, {
+
+        "name" : "Iaw",
+
+        "id" : 32576165,
+
+        "level" : 6,
+
+        "hardcore" : false,
+
+        "paragonLevel" : 0,
+
+        "gender" : 1,
+
+        "dead" : false,
+
+        "class" : "demon-hunter",
+
+        "last-updated" : 1365102110
+
+        } ],
+
+        "lastHeroPlayed" : 32351570,
+
+        "lastUpdated" : 1365105795,
+
+        "artisans" : [ {
+
+        "slug" : "blacksmith",
+
+        "level" : 6,
+
+        "stepCurrent" : 4,
+
+        "stepMax" : 5
+
+        }, {
+
+        "slug" : "jeweler",
+
+        "level" : 3,
+
+        "stepCurrent" : 0,
+
+        "stepMax" : 1
+
+        } ],
+
+        "hardcoreArtisans" : [ {
+
+        "slug" : "blacksmith",
+
+        "level" : 0,
+
+        "stepCurrent" : -1,
+
+        "stepMax" : 5
+
+        }, {
+
+        "slug" : "jeweler",
+
+        "level" : 0,
+
+        "stepCurrent" : 0,
+
+        "stepMax" : 1
+
+        } ],
+
+        "kills" : {
+
+        "monsters" : 16695,
+
+        "elites" : 629,
+
+        "hardcoreMonsters" : 0
+
+        },
+
+        "timePlayed" : {
+
+        "barbarian" : 0.0,
+
+        "demon-hunter" : 0.029,
+
+        "monk" : 0.0,
+
+        "witch-doctor" : 0.0,
+
+        "wizard" : 1.0
+
+        },
+
+        "fallenHeroes" : [ ],
+
+        "battleTag" : "dpsk#2824",
+
+        "progression" : {
+
+        "normal" : {
+
+        "act1" : {
+
+        "completed" : true,
+
+        "completedQuests" : [ {
+
+        "slug" : "the-fallen-star",
+
+        "name" : "The Fallen Star"
+
+        }, {
+
+        "slug" : "the-legacy-of-cain",
+
+        "name" : "The Legacy of Cain"
+
+        }, {
+
+        "slug" : "a-shattered-crown",
+
+        "name" : "A Shattered Crown"
+
+        }, {
+
+        "slug" : "reign-of-the-black-king",
+
+        "name" : "Reign of the Black King"
+
+        }, {
+
+        "slug" : "sword-of-the-stranger",
+
+        "name" : "Sword of the Stranger"
+
+        }, {
+
+        "slug" : "the-broken-blade",
+
+        "name" : "The Broken Blade"
+
+        }, {
+
+        "slug" : "the-doom-in-wortham",
+
+        "name" : "The Doom in Wortham"
+
+        }, {
+
+        "slug" : "trailing-the-coven",
+
+        "name" : "Trailing the Coven"
+
+        }, {
+
+        "slug" : "the-imprisoned-angel",
+
+        "name" : "The Imprisoned Angel"
+
+        }, {
+
+        "slug" : "return-to-new-tristram",
+
+        "name" : "Return to New Tristram"
+
+        } ]
+
+        },
+
+        "act2" : {
+
+        "completed" : true,
+
+        "completedQuests" : [ {
+
+        "slug" : "shadows-in-the-desert",
+
+        "name" : "Shadows in the Desert"
+
+        }, {
+
+        "slug" : "the-road-to-alcarnus",
+
+        "name" : "The Road to Alcarnus"
+
+        }, {
+
+        "slug" : "city-of-blood",
+
+        "name" : "City of Blood"
+
+        }, {
+
+        "slug" : "a-royal-audience",
+
+        "name" : "A Royal Audience"
+
+        }, {
+
+        "slug" : "unexpected-allies",
+
+        "name" : "Unexpected Allies"
+
+        }, {
+
+        "slug" : "betrayer-of-the-horadrim",
+
+        "name" : "Betrayer of the Horadrim"
+
+        }, {
+
+        "slug" : "blood-and-sand",
+
+        "name" : "Blood and Sand"
+
+        }, {
+
+        "slug" : "the-black-soulstone",
+
+        "name" : "The Black Soulstone"
+
+        }, {
+
+        "slug" : "the-scouring-of-caldeum",
+
+        "name" : "The Scouring of Caldeum"
+
+        }, {
+
+        "slug" : "lord-of-lies",
+
+        "name" : "Lord of Lies"
+
+        } ]
+
+        },
+
+        "act3" : {
+
+        "completed" : true,
+
+        "completedQuests" : [ {
+
+        "slug" : "the-siege-of-bastions-keep",
+
+        "name" : "The Siege of Bastion''s Keep"
+
+        }, {
+
+        "slug" : "turning-the-tide",
+
+        "name" : "Turning the Tide"
+
+        }, {
+
+        "slug" : "the-breached-keep",
+
+        "name" : "The Breached Keep"
+
+        }, {
+
+        "slug" : "tremors-in-the-stone",
+
+        "name" : "Tremors in the Stone"
+
+        }, {
+
+        "slug" : "machines-of-war",
+
+        "name" : "Machines of War"
+
+        }, {
+
+        "slug" : "siegebreaker",
+
+        "name" : "Siegebreaker"
+
+        }, {
+
+        "slug" : "heart-of-sin",
+
+        "name" : "Heart of Sin"
+
+        } ]
+
+        },
+
+        "act4" : {
+
+        "completed" : true,
+
+        "completedQuests" : [ {
+
+        "slug" : "fall-of-the-high-heavens",
+
+        "name" : "Fall of the High Heavens"
+
+        }, {
+
+        "slug" : "the-light-of-hope",
+
+        "name" : "The Light of Hope"
+
+        }, {
+
+        "slug" : "beneath-the-spire",
+
+        "name" : "Beneath the Spire"
+
+        }, {
+
+        "slug" : "prime-evil",
+
+        "name" : "Prime Evil"
+
+        } ]
+
+        }
+
+        },
+
+        "nightmare" : {
+
+        "act1" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ {
+
+        "slug" : "the-fallen-star",
+
+        "name" : "The Fallen Star"
+
+        }, {
+
+        "slug" : "the-legacy-of-cain",
+
+        "name" : "The Legacy of Cain"
+
+        }, {
+
+        "slug" : "a-shattered-crown",
+
+        "name" : "A Shattered Crown"
+
+        }, {
+
+        "slug" : "reign-of-the-black-king",
+
+        "name" : "Reign of the Black King"
+
+        }, {
+
+        "slug" : "sword-of-the-stranger",
+
+        "name" : "Sword of the Stranger"
+
+        }, {
+
+        "slug" : "the-broken-blade",
+
+        "name" : "The Broken Blade"
+
+        }, {
+
+        "slug" : "the-doom-in-wortham",
+
+        "name" : "The Doom in Wortham"
+
+        } ]
+
+        },
+
+        "act2" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act3" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act4" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        }
+
+        },
+
+        "hell" : {
+
+        "act1" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act2" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act3" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act4" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        }
+
+        },
+
+        "inferno" : {
+
+        "act1" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act2" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act3" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act4" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        }
+
+        }
+
+        },
+
+        "hardcoreProgression" : {
+
+        "normal" : {
+
+        "act1" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act2" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act3" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act4" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        }
+
+        },
+
+        "nightmare" : {
+
+        "act1" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act2" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act3" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act4" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        }
+
+        },
+
+        "hell" : {
+
+        "act1" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act2" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act3" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act4" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        }
+
+        },
+
+        "inferno" : {
+
+        "act1" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act2" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act3" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        },
+
+        "act4" : {
+
+        "completed" : false,
+
+        "completedQuests" : [ ]
+
+        }
+
+        }
+
+        }
+
+        }'
+    http_version: 
+  recorded_at: Thu, 22 Aug 2013 14:58:59 GMT
+recorded_with: VCR 2.5.0