wowapi 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e686e355a23bee293048d3ad3763e1b095b76fb8
+  data.tar.gz: 925371780e6d9bd96ce59ce4226e1da0b13324ca
+SHA512:
+  metadata.gz: 0561ca37e80e469de28109c003c92dc410a55996c01d287c9a4903002453cf1a2441aac3bcc26b0002e75d50678af4cf492f00c5847f6ba8548b949b12d615bf
+  data.tar.gz: 0a886207b1266b9d841d6a080133acc427d71581fb98e17e12db2844a253b7e1022065513f02e0e1f068a40e12204f61fad27760b6a86ba10b952a48ef78d827

data/.gitignore

@@ -0,0 +1,4 @@
+# Gem itself should not be included
+*.gem
+# JetBrains IDE
+.idea

data/Gemfile

@@ -0,0 +1,5 @@
+# GEMS SOURCE
+source 'https://rubygems.org'
+
+
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,19 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.1)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,6 @@
+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,104 @@
+# WoWAPI
+**EARLY STAGE DEVELOPMENT. HERE BE DRAGONS**
+However, you are welcome to contribute and/or criticise (and/or) show me the way to handle things.
+ 
+# What this is
+**WoWAPI** project is created by [Jasiek ~marahin Matusz](https://marahin.pl/) with it's source on [git.3lab.re](https://git.3lab.re/marahin/wowapi), licensed under MIT license.
+
+This is a Ruby library, so called _gem_. It is targetted to be used in Ruby scripts, [Rails](http://rubyonrails.org/), [Sinatra](http://www.sinatrarb.com/) or anything that uses Ruby.
+
+This project began during a search for an easy-to-use gem that allows to access Blizzard's World of Warcraft Community API with ease. It is based on (now deprecated) [Battlenet GEM](https://github.com/BinaryMuse/battlenet) by [BinaryMuse](https://github.com/BinaryMuse), however it focuses purely on World of Warcraft.
+
+## What does it do?
+
+**WoWAPI** is a library that's dependant on _open-uri_ and _json_. Both are built-in Ruby libraries. Nothing more than that, just plain Ruby.
+
+## How do I use this?
+
+
+### Guilds
+
+Guilds can take couple of arguments to query: 
+
+* news
+* achievements
+* challenge
+* members
+
+Each of these will expand (temporarily*) returned Hash.
+ 
+ _* temporarily_ - in the end-stage of development I dream of having a `GuildClass` which would have a standardized structure. For now it just returns a `JSON.parse(obj)`, which is a simple `Hash`.
+ Please keep in mind that I am a working student. (:
+
+```
+require 'wowapi'
+
+api = Wowapi.new do |config|
+  config.public_key   = 'your-public-apikey'
+  # config.secret_Key = 'optional-secret-key'
+  # config.region     = :us # (optional)
+end
+
+api.guild('Argent Dawn', 'The Aspects')
+# => {"lastModified"=>1472853622000, "name"=>"The Aspects", "realm"=>"Argent Dawn", "battlegroup"=>"Reckoning / Abrechnung", "level"=>25, "side"=>1, "achievementPoints"=>1590, "emblem"=>{"icon"=>140, "iconColor"=>"ffdfa55a", "iconColorId"=>16, "border"=>1, "borderColor"=>"fff9cc30", "borderColorId"=>16, "backgroundColor"=>"ff232323", "backgroundColorId"=>45}}
+
+```
+
+#### Guild fields
+
+* news ([pastebin](http://d.gimb.us/b/fe26c9f380477d3a0293072385e61cab.txt))
+
+```
+irb(main):005:0> api.guild 'Argent Dawn', 'The Aspects', :news
+=> {"lastModified"=>1472853622000, "name"=>"The Aspects", "realm"=>"Argent Dawn", "battlegroup"=>"Reckoning / Abrechnung", "level"=>25, "side"=>1, "achievementPoints"=>1590, "emblem"=>{"icon"=>140, "iconColor"=>"ffdfa55a", "iconColorId"=>16, "border"=>1, "borderColor"=>"fff9cc30", "borderColorId"=>16, "backgroundColor"=>"ff232323", "backgroundColorId"=>45}, "news"=>[{"type"=>"itemLoot", "character"=>"Tormenthowl", "timestamp"=>1472858400000, "itemId"=>124325, "context"=>"raid-mythic", "bonusLists"=>[1799, 1502]}, {"type"=>"itemLoot", "character"=>"Tormenthowl", "timestamp"=>1472858400000, "itemId"=>113900, "context"=>"raid-mythic", "bonusLists"=>[567]}, {"type"=>"itemLoot", "character"=>"Humbakos", "timestamp"=>1472857980000, "itemId"=>130132, "context"=>"", "bonusLists"=>[1794, 1735]}, {"type"=>"itemLoot", "character"=>"Seszel", "timestamp"=>1472854680000, "itemId"=>131799, "context"=>"", "bonusLists"=>[1794, 1735]}, {"type"=>"itemLoot", "character"=>"Kurrash", "timestamp"=>1472854500000, "itemId"=>132970, "context"=>"quest-reward", "bonusLists"=>[767, 1734]}, {"type"=>"itemLoot", "character"=>"Greenzog", "timestamp"=>1472853960000, "itemId"=>131921, "context"=>"", "bonusLists"=>[1794, 1735]}, {"type"=>"itemLoot", "character"=>"Humbakos", "timestamp"=>1472853480000, "itemId"=>121660, "context"=>"quest-reward", "bonusLists"=>[768, 1740]}, {"type"=>"itemLoot", "character"=>"Dzidu", "timestamp"=>1472853060000, "itemId"=>138418, "context"=>"", "bonusLists"=>[1794, 1735]}, $$__***<<< A LOT OF DATA ... >>>***__$$ {"type"=>"itemLoot", "character"=>"Olvarus", "timestamp"=>1472248680000, "itemId"=>109970, "context"=>"dungeon-mythic", "bonusLists"=>[43, 642, 643]}, {"type"=>"playerAchievement", "character"=>"Guldav", "timestamp"=>1472247960000, "context"=>"", "bonusLists"=>[], "achievement"=>{"id"=>13, "title"=>"Level 80", "points"=>10, "description"=>"Reach level 80.", "rewardItems"=>[], "icon"=>"achievement_level_80", "criteria"=>[{"id"=>5212, "description"=>"Reach level 80", "orderIndex"=>1, "max"=>80}], "accountWide"=>false, "factionId"=>2}}]}
+
+```
+
+* achievements
+
+(to be filled)
+
+* challenge
+
+(to be filled)
+
+* members
+
+(to be filled)
+
+* __combined__
+
+(to be filled)
+
+
+You can easily combine fields. 
+# Support & requirements
+
+## API authentication
+In order to access World of Warcraft's API you need your API key. For most actions (guild info for example) you only need the public key. Nonetheless, both of these you can aquire at [Battle.net Developer Portal](https://dev.battle.net/).
+
+If you do not provide public (and/or private key) you will most likely step upon `Wowapi::NoCredentialsException` error. 
+Make sure your Wowapi instance contains `public_key` (and/or, if necessary - `secret_key`).
+
+If you fail to authenticate, you will most likely step upon `Wowapi::AuthException` error. This means either your credentials are invalid, or something is wrong with Blizzard services. Nonetheless, you have a problem.
+
+## Ruby
+Currently developed and tested only on 2.3.0, however _any_ Ruby >= 1.9.0 with _open-uri_ and _json_ support should be working properly.
+## Regions
+### Region defaults to :eu!
+List of currently supported regions:
+- Europe (**_:eu_**)
+- United States (**_:us_**)
+
+API region can be changed by passing proper symbol to the configuration, example:
+
+```
+api = Wowapi.new do |config|
+  config.region = :us
+  ...
+end
+```
+
+Keep in mind that this is completely optional, and default is **_:eu_**.
+## Games
+**There is no plan of supporting anything but World of Warcraft. Sorry.**

data/lib/wowapi/core_extensions/object/try.rb

@@ -0,0 +1,16 @@
+# A simple .try method for Object,
+# which mimics the Rails one (probably poorly)
+
+module CoreExtensions
+  module Object
+    def try(method)
+      begin
+        self.send(method)
+      rescue NoMethodError
+        nil
+      end
+    end
+  end
+end
+
+Object.include(CoreExtensions::Object) unless Object.methods.include?(:try)

data/lib/wowapi/exceptions/api_exception.rb

@@ -0,0 +1,7 @@
+class Wowapi
+  class ApiException < Exception
+    def initialize(msg = 'API request failed.')
+      super
+    end
+  end
+end

data/lib/wowapi/exceptions/auth_exception.rb

@@ -0,0 +1,7 @@
+class Wowapi
+  class AuthException < Exception
+    def initialize(msg = 'Could not authenticate.')
+      super
+    end
+  end
+end

data/lib/wowapi/exceptions/no_credentials_exception.rb

@@ -0,0 +1,7 @@
+class Wowapi
+  class NoCredentialsException < Exception
+    def initialize(msg = 'Public and/or secret key was not provided.')
+      super
+    end
+  end
+end

data/lib/wowapi/exceptions/region_exception.rb

@@ -0,0 +1,7 @@
+class Wowapi
+  class RegionException < Exception
+    def initialize(msg = 'Provided unsupported region.')
+      super
+    end
+  end
+end

data/lib/wowapi/exceptions.rb

@@ -0,0 +1,4 @@
+require 'wowapi/exceptions/region_exception'
+require 'wowapi/exceptions/auth_exception'
+require 'wowapi/exceptions/no_credentials_exception'
+require 'wowapi/exceptions/api_exception'

data/lib/wowapi/modules/guild.rb

@@ -0,0 +1,16 @@
+class Wowapi
+  module Modules
+    module Guild
+      # this should probably include
+      # a GuildClass definition which would properly
+      # handle blizzard apis' response.
+      # for now it returns just a simple JSON
+      # (also, written while drunk. sorry. )
+      def guild(realm, name, *args)
+        args = args.map{|n| n.to_s if n.is_a?(Symbol) }
+        res = get 'guild/', "#{realm}/#{name}?fields=#{args.join('%2C')}"
+        JSON.parse(res)
+      end
+    end
+  end
+end

data/lib/wowapi/version.rb

@@ -0,0 +1,4 @@
+class Wowapi
+  VERSION = '0.0.3'
+end
+

data/lib/wowapi/wowapi.rb

@@ -0,0 +1,60 @@
+require 'open-uri'
+require 'json'
+require 'pry'
+require 'wowapi/core_extensions/object/try'
+require 'wowapi/exceptions'
+require 'wowapi/version'
+require 'wowapi/modules/guild'
+
+class Wowapi
+  attr_accessor :region, :public_key, :secret_key
+
+  # Wowapi::Modules is a namespace which we keep our
+  # particular methods for different parts of Blizzard's
+  # World of Warcraft Community API handling
+  module Modules; end
+  include Wowapi::Modules::Guild
+
+  class << self
+    # Raise exceptions on error responses from API endpoint?
+    attr_accessor :fail_silently
+  end
+
+  @fail_silently = false
+
+  def initialize
+    self.region ||= :eu
+    yield self if block_given?
+  end
+
+  def get(path, params = {})
+    res = make_request(path, params)
+    if !(res.status.include?('200') or res.status.include?(200)) && ! Wowapi.fail_silently
+      raise Wowapi::ApiException.new, "Did not receive status 200, but #{res.try(:status).try(:first)} (#{res.class})."
+    end
+    res.read
+  end
+
+  private
+
+  def make_request(path, params)
+    begin
+      raise Wowapi::NoCredentialsException unless public_key
+      req_uri = URI.encode("https://#{base_url}#{path}#{params}&apikey=#{self.public_key}")
+      open(req_uri)
+    rescue OpenURI::HTTPError => e
+      raise Wowapi::ApiException.new, "Could not make a request:\n#{e.inspect}" unless Wowapi.fail_silently
+    end
+  end
+
+  def base_url
+    case self.region
+    when :eu
+      'eu.api.battle.net/wow/'
+    when :us
+      'us.api.battle.net/wow/'
+    else
+      raise Wowapi::RegionException
+    end
+  end
+end

data/lib/wowapi.rb

@@ -0,0 +1 @@
+require 'wowapi/wowapi'

data/wowapi.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wowapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wowapi'
+  spec.version       = Wowapi::VERSION
+  spec.authors       = ['Jan Matusz']
+  spec.email         = ['me@marahin.pl']
+  spec.description   = %q{An easy-to-use gem providing access to World of Warcraft part of Blizzard Community API.}
+  spec.summary       = %q{World of Warcraft API}
+  spec.homepage      = 'https://git.3lab.re/marahin/wowapi'
+  spec.license       = 'MIT'
+  spec.files 	       = `git ls-files -z`.split("\x0")
+  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', '~> 0'
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'pry', '~> 0'
+
+end
+

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: wowapi
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Jan Matusz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An easy-to-use gem providing access to World of Warcraft part of Blizzard
+  Community API.
+email:
+- me@marahin.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- lib/wowapi.rb
+- lib/wowapi/core_extensions/object/try.rb
+- lib/wowapi/exceptions.rb
+- lib/wowapi/exceptions/api_exception.rb
+- lib/wowapi/exceptions/auth_exception.rb
+- lib/wowapi/exceptions/no_credentials_exception.rb
+- lib/wowapi/exceptions/region_exception.rb
+- lib/wowapi/modules/guild.rb
+- lib/wowapi/version.rb
+- lib/wowapi/wowapi.rb
+- wowapi.gemspec
+homepage: https://git.3lab.re/marahin/wowapi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: World of Warcraft API
+test_files: []