wowapi 0.0.3 → 0.0.4

checksums.yaml

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

data/.gitignore

@@ -1,4 +1,10 @@
 # Gem itself should not be included
 *.gem
+
 # JetBrains IDE
 .idea
+
+# rDOC-generated documentation
+# run `rdoc` in order to generate .html files
+doc/
+.DS_Store

data/Gemfile

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

data/README.md

@@ -1,5 +1,7 @@
 # WoWAPI
-**EARLY STAGE DEVELOPMENT. HERE BE DRAGONS**
+[![Gem Version](https://badge.fury.io/rb/wowapi.svg)](https://badge.fury.io/rb/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
@@ -11,24 +13,25 @@ This project began during a search for an easy-to-use gem that allows to access
 
 ## 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.
+It gives you a pretty interface to Blizzard's Community API. 
 
 ## How do I use this?
 
+Before you start tinkering, I suggest generating *rDOC* documentation.  
+To do so, run `rdoc` in the root directory of Wowapi. Then navigate to doc/index.html in your browser, and voila - you have your offline documentation with all methods, classes and pretty-displayed README.md. 
 
-### Guilds
-
-Guilds can take couple of arguments to query: 
+You may also browse *ri* documentation which installs by default when you install the gem. Just type `ri Wowapi`. 
+### Resources
 
-* 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. (:
+We have different resources for different parts of the API. Each resource can be queried with query fields.
+  Currently, everything is returned as a Hash(*)
+  
+| Resource(s) 	| query fields 	|               	|            	|          	|
+|:-----------:	|:------------:	|:-------------:	|:----------:	|:--------:	|
+|    Guilds   	|     :news    	| :achievements 	| :challenge 	| :members 	|
+|             	|              	|               	|            	|          	|
+|             	|              	|               	|            	|          	| _
+* temporarily_ - see #1, #2, #3 @ ([git.3lab.re](https://git.3lab.re/marahin/wowapi/issues))
 
 ```
 require 'wowapi'
@@ -44,32 +47,6 @@ api.guild('Argent Dawn', 'The Aspects')
 
 ```
 
-#### 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

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

@@ -1,8 +1,8 @@
-# A simple .try method for Object,
-# which mimics the Rails one (probably poorly)
-
 module CoreExtensions
   module Object
+    # Simple shim that adds .try(:symbol)
+    # method for Object, mimicing ActiveSupport one
+    # (probably poorly, todo: rewrite?)
     def try(method)
       begin
         self.send(method)

data/lib/wowapi/exceptions/api_exception.rb

@@ -1,4 +1,5 @@
 class Wowapi
+  # Thrown when API does not return any data / something goes wrong
   class ApiException < Exception
     def initialize(msg = 'API request failed.')
       super

data/lib/wowapi/exceptions/auth_exception.rb

@@ -1,4 +1,5 @@
 class Wowapi
+  # Currently unused; deprecated?
   class AuthException < Exception
     def initialize(msg = 'Could not authenticate.')
       super

data/lib/wowapi/exceptions/no_credentials_exception.rb

@@ -1,4 +1,5 @@
 class Wowapi
+  # Thrown when either public and/or secret key was not provided
   class NoCredentialsException < Exception
     def initialize(msg = 'Public and/or secret key was not provided.')
       super

data/lib/wowapi/exceptions/region_exception.rb

@@ -1,4 +1,5 @@
 class Wowapi
+  # Thrown when supplied Region is unsupported
   class RegionException < Exception
     def initialize(msg = 'Provided unsupported region.')
       super

data/lib/wowapi/modules/guild.rb

@@ -1,11 +1,17 @@
 class Wowapi
   module Modules
+    # Guild module which handles all guild API actions
+    # note: this _probably_ should be handled with
+    # some kind of GuildClass, see:
+    # https://git.3lab.re/marahin/wowapi/issues/1
     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. )
+      # Asks Blizzard API for Guild resource
+      # with (any) given fields
+      # Example:
+      # ```
+      # api.guild 'Argent Dawn', 'The Aspects', :members, :news, ...
+      # ```
+      # Currently returns Hash
       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')}"

data/lib/wowapi/version.rb

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

data/lib/wowapi/wowapi.rb

@@ -1,6 +1,5 @@
 require 'open-uri'
 require 'json'
-require 'pry'
 require 'wowapi/core_extensions/object/try'
 require 'wowapi/exceptions'
 require 'wowapi/version'
@@ -27,6 +26,8 @@ class Wowapi
     yield self if block_given?
   end
 
+  # Method to handle all requests, properly
+  # interpreting HTTP answer & returning it's response
   def get(path, params = {})
     res = make_request(path, params)
     if !(res.status.include?('200') or res.status.include?(200)) && ! Wowapi.fail_silently
@@ -37,6 +38,8 @@ class Wowapi
 
   private
 
+  # Making open-uri request, catching exceptions
+  # and returning data back to #get method
   def make_request(path, params)
     begin
       raise Wowapi::NoCredentialsException unless public_key
@@ -47,6 +50,8 @@ class Wowapi
     end
   end
 
+  # Returns URL for particular region
+  # or throws an exception if region is nonexistent
   def base_url
     case self.region
     when :eu

data/wowapi.gemspec

@@ -18,8 +18,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 0'
-  spec.add_development_dependency 'rake', '~> 0'
   spec.add_development_dependency 'pry', '~> 0'
-
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wowapi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jan Matusz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-02 00:00:00.000000000 Z
+date: 2016-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !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
@@ -96,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: World of Warcraft API