armory_api 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+.yardoc
+coverage/*
+doc/*
+.bundle
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,4 @@
+ArmoryApi
+=========
+
+A Ruby Gem for the World of Warcraft API.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+task default: :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ['README.md', 'LICENSE.txt', 'lib/**/*.rb']
+    t.options = [
+      '--output-dir', 'doc/yard',
+      '--markup', 'markdown'
+    ]
+  end
+end

data/armory_api.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path('../lib/armory_api/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'armory_api'
+  s.version = ArmoryApi::VERSION
+  s.description = 'Wrapper for the World of Warcraft API'
+  s.summary = s.description
+  s.authors = ['Francesco Ceccon']
+  s.email = ['francesco@ceccon.me']
+  s.homepage = 'https://github.com/fracek/armory_api'
+  s.platform = Gem::Platform::RUBY
+  s.require_path = ['lib']
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency 'faraday', '~> 0.8'
+  s.add_dependency 'faraday_middleware', '~> 0.8'
+  s.add_dependency 'hashie', '~> 1.2'
+  s.add_dependency 'multi_json', '~> 1.3'
+
+  s.add_development_dependency 'json', '~> 1.7'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'yard'
+end

data/lib/armory_api/client/character.rb

@@ -0,0 +1,24 @@
+module ArmoryApi
+  class Client
+    module Character
+
+      # Retrieves a character from the Armory
+      #
+      # @param [String] name
+      # @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)
+      def character(name, realm=nil, fields=[])
+        if realm.class == Array
+          fields = realm
+          realm = nil
+        end
+        realm ||= @realm
+        raise ArmoryApi::RealmNotFound if realm.nil?
+        fields ||= []
+        params = { fields: fields.join(',') } unless fields.empty?
+        get("/api/wow/character/#{realm}/#{name}", params)
+      end
+    end
+  end
+end

data/lib/armory_api/client.rb

@@ -0,0 +1,58 @@
+require 'faraday'
+require 'uri'
+
+require 'armory_api/client/character'
+
+module ArmoryApi
+  class Client
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    # Initializes a new Client object
+    #
+    # @param [Hash] options
+    # @return [ArmoryApi::Client]
+    def initialize(options={})
+      options = ArmoryApi.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    # Performs an HTTP GET request
+    def get(path, params={}, options={})
+      request(:get, path, params, options)
+    end
+
+    include ArmoryApi::Client::Character
+   private
+    def endpoint
+      "http://#{@region}.battle.net"
+    end
+
+    # TODO: don't make a new connection on each request
+    def connection
+      @connection = Faraday.new(endpoint,
+                                @connection_options.merge(builder: @middleware))
+    end
+
+    def request(method, path, params={}, options={})
+      uri = options[:endpoint] || endpoint
+      uri = URI(uri) unless uri.respond_to?(:host)
+      uri += path
+      request_headers = {}
+      params ||= {}
+      connection.url_prefix = options[:endpoint] || endpoint
+      res = connection.run_request(method.to_sym, path, nil, request_headers) do |req|
+        unless params.empty?
+          case req.method
+          when :post, :put
+            req.body = params
+          else
+            req.params.update(params)
+          end
+        end
+      end
+      res.body
+    end
+  end
+end

data/lib/armory_api/configuration.rb

@@ -0,0 +1,63 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/response/raise_armory_api_error'
+require 'armory_api/version'
+
+module ArmoryApi
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :region,
+      :locale,
+      :realm,
+      :endpoint,
+      :user_agent,
+      :connection_options,
+      :middleware
+    ].freeze
+
+    DEFAULT_REGION     = 'us'
+    DEFAULT_LOCALE     = 'en_US'
+    DEFAULT_ENDPOINT   = "http://#{DEFAULT_REGION}.battle.net"
+    DEFAULT_USER_AGENT = "ArmoryApi Ruby Gem #{ArmoryApi::VERSION}".freeze
+    DEFAULT_CONNECTION_OPTIONS = {
+      headers: {
+        accept: 'application/json',
+        user_agent: DEFAULT_USER_AGENT
+      },
+      raw: true
+    }
+    DEFAULT_MIDDLEWARE = Faraday::Builder.new do |builder|
+      builder.request :json
+
+      builder.use Faraday::Response::RaiseArmoryApiError
+      builder.use FaradayMiddleware::Mashify
+      builder.use FaradayMiddleware::ParseJson
+
+      builder.adapter Faraday.default_adapter
+    end
+
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def reset
+      self.region     = DEFAULT_REGION
+      self.locale     = DEFAULT_LOCALE
+      self.realm      = nil
+      self.endpoint   = DEFAULT_ENDPOINT
+      self.user_agent = DEFAULT_USER_AGENT
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.middleware = DEFAULT_MIDDLEWARE
+    end
+  end
+end

data/lib/armory_api/error.rb

@@ -0,0 +1,13 @@
+module ArmoryApi
+  # Custom error class for rescuing from all Armory errors
+  class Error < StandardError; end
+
+  # Raised when the Armory returned a 404 status code
+  class NotFound < Error; end
+
+  # Raised when the Armory return a 500 status code
+  class InternalServerError < Error; end
+
+  # Raised when the realm is not set
+  class RealmNotFound < Error; end
+end

data/lib/armory_api/version.rb

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

data/lib/armory_api.rb

@@ -0,0 +1,28 @@
+require 'armory_api/configuration'
+require 'armory_api/client'
+require 'armory_api/error'
+
+module ArmoryApi
+  extend Configuration
+  class << self
+
+    # Shortcut for ArmoryApi::Client.new
+    #
+    # @return [ArmoryApi::Client]
+    def new(options={})
+      ArmoryApi::Client.new(options)
+    end
+
+    # Delegate to ArmoryApi::Client.new
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end
+
+ArmoryApi.reset

data/lib/faraday/response/raise_armory_api_error.rb

@@ -0,0 +1,19 @@
+require 'faraday'
+
+# @api private
+module Faraday
+  class Response::RaiseArmoryApiError < Response::Middleware
+    def on_complete(res)
+      case res[:status].to_i
+      when 404
+        raise ArmoryApi::NotFound, error_message(res)
+      when 500
+        raise ArmoryApi::InternalServerError, error_message(res)
+      end
+    end
+
+    def error_message(res)
+      "#{res[:method].to_s.upcase} #{res[:url].to_s}: #{res[:body]["reason"]}"
+    end
+  end
+end

data/spec/armory_api/client/character_spec.rb

@@ -0,0 +1,50 @@
+require 'helper'
+
+describe ArmoryApi::Client::Character do
+  describe ".character" do
+    before do
+      @client = ArmoryApi::Client.new realm: 'realm'
+    end
+
+    context "without a realm passed" do
+      it "returns the character" do
+        stub_request(:get, 'http://us.battle.net/api/wow/character/realm/peratryn')
+          .to_return(body: fixture('character/character.json'))
+        char = @client.character('peratryn')
+        expect(char.name.downcase).to eq 'peratryn'
+      end
+
+      it "returns the character with additional fields" do
+        stub_request(:get, 'http://us.battle.net/api/wow/character/realm/peratryn?fields=feed')
+          .to_return(body: fixture('character/character-feed.json'))
+        char = @client.character('peratryn', ['feed'])
+        expect(char.feed).to be_an Array
+      end
+
+      it "raises an error if the client does not have a realm set" do
+        client = ArmoryApi::Client.new
+        expect{client.character('peratryn')}.to raise_error(ArmoryApi::RealmNotFound)
+      end
+    end
+
+    context "with a realm passed" do
+      before do
+        @client = ArmoryApi::Client.new
+      end
+
+      it "returns the character" do
+        stub_request(:get, 'http://us.battle.net/api/wow/character/realm/peratryn')
+          .to_return(body: fixture('character/character.json'))
+        char = @client.character('peratryn', 'realm')
+        expect(char.name.downcase).to eq 'peratryn'
+      end
+
+      it "returns the character with additional fields" do
+        stub_request(:get, 'http://us.battle.net/api/wow/character/realm/peratryn?fields=feed')
+          .to_return(body: fixture('character/character-feed.json'))
+        char = @client.character('peratryn', 'realm', ['feed'])
+        expect(char.feed).to be_an Array
+      end
+    end
+  end
+end

data/spec/armory_api/client_spec.rb

@@ -0,0 +1,74 @@
+require 'helper'
+
+describe ArmoryApi::Client do
+  describe "region" do
+    after :each do
+      ArmoryApi.reset
+    end
+
+    it "defaults to us" do
+      c = ArmoryApi::Client.new
+      expect(c.region).to eq 'us'
+    end
+
+    it "is settable" do
+      ArmoryApi.region = 'eu'
+      c = ArmoryApi::Client.new
+      expect(c.region).to eq 'eu'
+    end
+  end
+
+  describe "locale" do
+    after :each do
+      ArmoryApi.reset
+    end
+
+    it "defaults to en_US" do
+      c = ArmoryApi::Client.new
+      expect(c.locale).to eq 'en_US'
+    end
+
+    it "is settable" do
+      ArmoryApi.locale = 'en_GB'
+      c = ArmoryApi::Client.new
+      expect(c.locale).to eq 'en_GB'
+    end
+  end
+
+  describe "realm" do
+    after :each do
+      ArmoryApi.reset
+    end
+
+    it "defaults to nil" do
+      c = ArmoryApi::Client.new
+      expect(c.realm).to be_nil
+    end
+
+    it "is settable" do
+      ArmoryApi.realm = 'Stormrage'
+      c = ArmoryApi::Client.new
+      expect(c.realm).to eq 'Stormrage'
+    end
+  end
+
+  describe "connection" do
+    after :each do
+      ArmoryApi.reset
+    end
+
+    it "looks like a Farady connection" do
+      c = ArmoryApi::Client.new
+      expect(c.send('connection')).to respond_to(:run_request)
+    end
+  end
+
+  describe "request" do
+    it "encodes the params in the body" do
+      stub_request(:get, 'http://us.battle.net/api/wow/character/realm/name?fields=one,two')
+        .with(params: { fields: 'one,two' })
+      c = ArmoryApi::Client.new
+      c.character('name', 'realm', ['one', 'two'])
+    end
+  end
+end

data/spec/armory_api_spec.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+describe ArmoryApi do
+  describe ".new" do
+    it "is an ArmoryApi::Client" do
+      expect(ArmoryApi.new).to be_a ArmoryApi::Client
+    end
+  end
+
+  describe ".configure" do
+    after :each do
+      ArmoryApi.reset
+    end
+
+    ArmoryApi.options.keys.each do |key|
+      it "sets the #{key.to_s.gsub('_', ' ')}" do
+        ArmoryApi.configure do |conf|
+          conf.send("#{key}=", key)
+        end
+        expect(ArmoryApi.instance_variable_get(:"@#{key}")).to eq key
+      end
+    end
+  end
+end

data/spec/faraday/response_spec.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+describe Faraday::Response do
+  before do
+    @client = ArmoryApi::Client.new
+  end
+
+  {
+    404 => ArmoryApi::NotFound,
+    500 => ArmoryApi::InternalServerError
+  }.each do |status, exception|
+    context "when HTTP status is #{status}" do
+      before do
+        stub_request(:get, 'http://us.battle.net/api/wow/character/realm/name')
+          .to_return(status: status,
+                     body: '{"status":"nok", "reason": "When in doubt, blow it up. (page not found)"}')
+      end
+
+      it "raises #{exception.name} error" do
+        expect{@client.character('name', 'realm')}.to raise_exception(exception)
+      end
+    end
+  end
+end