wowapi 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be6791e7a0e1cb8e1b3e493a561e6621cc37e133
-  data.tar.gz: 8590259e83af1a16622284167b0c98b6c67aab6d
+  metadata.gz: 01f7fb2b3b80e6594f57deb3882de162fb879af2
+  data.tar.gz: f0b935e7a633887c89d973ffdbb41c6317a6812a
 SHA512:
-  metadata.gz: 407ae47b2d7b8c158f2f9544ec4952ac75ff7bfcd46613dd3b5bd046e2b8972b290acff51e75309de53292b4916b65ce6a641dc0c2f08c0b862c61c72f1b216f
-  data.tar.gz: 47bf975e46da5de2aebe1699b42ed2171f2e3e873241e6feabdc66874b7e52bb8e46afb2fcfcd0ff236ce801f058faae6b055f7d5d586d143ce48320ac6d6b9d
+  metadata.gz: e03811c8a93a23217b9546371e41146c8bfa5f09954bbf471d50106561c6fde931592764dc82f2bd105181dc606106362bd826c75741352e9f0d2794af6c079a
+  data.tar.gz: e19fd9e9e7998c99840df71cfe2b14e2d5e326b51950f84912991601501869a180f89c1433c4030c8511b34446452c77140d459ad107ab79b30cde35509b2139

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.2.3
+  - 2.3.0
+script:
+  - bundle install
+  - gem build wowapi.gemspec
+notifications:
+  email: true
+  irc:
+    on_success: change
+    on_failure: always
+    channels:
+      - "irc.freenode.org#wowapi"

data/README.md

@@ -1,5 +1,10 @@
 # WoWAPI
-[![Gem Version](https://badge.fury.io/rb/wowapi.svg)](https://badge.fury.io/rb/wowapi)  
+[![Gem Version](https://badge.fury.io/rb/wowapi.svg)](https://badge.fury.io/rb/wowapi)
+[![Build Status](https://travis-ci.org/Marahin/wowapi.svg?branch=master)](https://travis-ci.org/Marahin/wowapi)
+[![Code Climate](https://codeclimate.com/github/Marahin/wowapi/badges/gpa.svg)](https://codeclimate.com/github/Marahin/wowapi)
+[![Dependency Status](https://gemnasium.com/badges/github.com/Marahin/wowapi.svg)](https://gemnasium.com/github.com/Marahin/wowapi)
+[![security](https://hakiri.io/github/Marahin/wowapi/master.svg)](https://hakiri.io/github/Marahin/wowapi/master)
+[![Inline docs](http://inch-ci.org/github/Marahin/wowapi.svg?branch=master)](http://inch-ci.org/github/Marahin/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.
@@ -58,16 +63,60 @@ Every resource is called as a method on `Wowapi` Object.
 | Resource(s) 	| query fields 	|               	|            	|          	|
 |:-----------:	|:------------:	|:-------------:	|:----------:	|:--------:	|
 |    .guild   	|     :news    	| :achievements 	| :challenge 	| :members 	|
-|    .character |
+|    .character |    :avatar    |
 
 ### Examples
+
+#### Rails
+* Create initializer called `wowapi.rb` in your Rails app's `config/initializers` directory,
+* fill it with following:
+```
+require 'wowapi'
+
+## Set region (defaults to :eu)
+## Wowapi.region = :us
+
+## Create Api variable usable ANYWHERE in your Rails app
+::Api = Wowapi.new do |config|
+  config.public_key = 'your-public-apikey'
+  ## config.secret_key = 'your-secret-key'
+end
+
+## Create your Guild name variable, usually GuildName or GuildNameApi that holds information about your guild.  
+## ::YourGuildName = Api.guild('Realm', 'Guild name', :field1, :field2)
+::Aspects = Api.guild('Argent Dawn', 'The Aspects', :members, :news)
+```
+
+Now, in any controller / view you can do:
+
+* controllers/pages_controller.rb
+
+```
+class PagesController < ApplicationController
+  def index
+    @news = Aspects.news
+  end
+end
+
+```
+
+* in views:
+
+```
+@news.last(7).each do |news|
+    ... 
+end
+```
+
+
+#### Plain ruby
+You can use simple variables. For more advanced usage with global variables and namespaces, see above (Rails usage).
 ```
 require 'wowapi'
 
 api = Wowapi.new do |config|
   config.public_key   = 'your-public-apikey'
   # config.secret_Key = 'optional-secret-key'
-  # config.region     = :us # (optional)
 end
 
 # returns guild profile
@@ -140,6 +189,8 @@ Keep in mind that this is completely optional, and default is **_:eu_**.
 ## Contributing
 I'm a single developer here. I'm working student. This is an introduction.
 
+### IRC
+`#wowapi` at Freenode 
 ### Bugtracking / I have a question / I have a problem
 Every problem / feature / bug / anything that concerns you should find place in Issues tab up top.
 As soon as you get your answer, the issue will also be labeled. 

data/lib/wowapi/modules/character.rb

@@ -5,7 +5,20 @@ class Wowapi
     # CharacterClass
     module Character
       # todo: issue-13
-      class CharacterClass < Wowapi::ResponseData; end
+      class CharacterClass < Wowapi::ResponseData
+        def initialize(res)
+          super
+
+          if @table
+            @table[:character]['thumbnail'] = "http://render-api-#{Wowapi.region}.worldofwarcraft.com/static-render/#{Wowapi.region}/#{@table[:character]['thumbnail']}"
+          end
+        end
+
+        ## Character avatar image
+        def avatar
+          @table[:character]['thumbnail']
+        end
+      end
 
       # Retrieve data about particular Character
       # For a list of fields visit README.md

data/lib/wowapi/region.rb

@@ -0,0 +1,17 @@
+class Wowapi
+  class << self
+    # Wowapi.region class variable that holds
+    # customer region (:eu, :us, ...)
+    # DEFAULTS TO :eu
+    attr_accessor :region
+    Wowapi.region ||= :eu
+  end
+
+  def region=(region)
+    Wowapi.region = region if region.is_a?(Symbol)
+  end
+
+  def region
+    Wowapi.region
+  end
+end

data/lib/wowapi/version.rb

@@ -1,4 +1,4 @@
 class Wowapi
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end
 

data/lib/wowapi/wowapi.rb

@@ -2,18 +2,18 @@ require 'open-uri'
 require 'json'
 require 'wowapi/core_extensions/object/try'
 require 'wowapi/fail_silently'
+require 'wowapi/region'
 require 'wowapi/exceptions'
 require 'wowapi/version'
 require 'wowapi/response_data'
 require 'wowapi/modules'
 
 class Wowapi
-  # Instance variables we keep our region, public_key and secret_key in
-  attr_accessor :region, :public_key, :secret_key
+  # Instance variables we keep public_key and secret_key in
+  attr_accessor :public_key, :secret_key
 
   # Creating an instance of Wowapi class
   def initialize
-    self.region ||= :eu
     yield self if block_given?
   end
 
@@ -44,7 +44,7 @@ class Wowapi
   # Returns URL for particular region
   # or throws an exception if region is nonexistent
   def base_url
-    case self.region
+    case Wowapi.region
     when :eu
       'eu.api.battle.net/wow/'
     when :us

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wowapi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jan Matusz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-11 00:00:00.000000000 Z
+date: 2016-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -33,6 +33,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -47,6 +48,7 @@ files:
 - lib/wowapi/modules.rb
 - lib/wowapi/modules/character.rb
 - lib/wowapi/modules/guild.rb
+- lib/wowapi/region.rb
 - lib/wowapi/response_data.rb
 - lib/wowapi/version.rb
 - lib/wowapi/wowapi.rb