wowapi 0.0.4 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a815973b1eb6200d1975606140a55a3345d0efc8
-  data.tar.gz: d8cabaf6a239f7f35c34904f12a86fcb999fc042
+  metadata.gz: be6791e7a0e1cb8e1b3e493a561e6621cc37e133
+  data.tar.gz: 8590259e83af1a16622284167b0c98b6c67aab6d
 SHA512:
-  metadata.gz: 805819f1915045afc074052dff53e43dc2b74ab521e68e7f3773cdaca14d7460d6147146f7c2ce781e0d73f47b4034144d534dbddaea74f2ee4e82c7ee7ed205
-  data.tar.gz: bab72ba9e28aad5a3188b914f6f655ecf7ca95dbfaba295bb62deba0503784a638d64a9fe9751de02e78d6dcee8dc983546efef8ff591f2c8d8b574dd94c5a85
+  metadata.gz: 407ae47b2d7b8c158f2f9544ec4952ac75ff7bfcd46613dd3b5bd046e2b8972b290acff51e75309de53292b4916b65ce6a641dc0c2f08c0b862c61c72f1b216f
+  data.tar.gz: 47bf975e46da5de2aebe1699b42ed2171f2e3e873241e6feabdc66874b7e52bb8e46afb2fcfcd0ff236ce801f058faae6b055f7d5d586d143ce48320ac6d6b9d

data/.gitignore

@@ -7,4 +7,10 @@
 # rDOC-generated documentation
 # run `rdoc` in order to generate .html files
 doc/
-.DS_Store
+.DS_Store
+
+.ruby-version
+
+# Gemfile.lock should not be contained in
+# Gem repository
+Gemfile.lock

data/README.md

@@ -17,22 +17,50 @@ 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. 
-
-You may also browse *ri* documentation which installs by default when you install the gem. Just type `ri Wowapi`. 
+### Installation
+
+#### Rubygems
+ This gem is available on Rubygems: https://rubygems.org/gems/wowapi
+ ```
+ gem install wowapi
+ ```
+ And everything should work just fine. For a list of compatible (tested) Rubies, see 'Support' at the bottom.
+#### Download & build yourself
+ You can also build it from scratch.
+ * clone the repo:
+ ```
+ git clone https://git.3lab.re/marahin/wowapi.git
+ ```
+ * enter the directory:
+ ```
+ cd wowapi
+ ```
+ * run bundler, so you have everything you need already:
+ ```
+ bundle install
+ ```
+ * build gem:
+ ```
+ gem build wowapi.gemspec
+ ```
+ * if build passes, install it from your local environment:
+ ```
+ gem install --local wowapi*.gem
+ ```
 ### Resources
 
+<< DUE TO FAST DEVELOPMENT CYCLE THIS PART OF DOCUMENTATION IS LACKING. >>  
+
 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(*)
-  
+
+Every resource is called as a method on `Wowapi` Object.  
+
 | Resource(s) 	| query fields 	|               	|            	|          	|
 |:-----------:	|:------------:	|:-------------:	|:----------:	|:--------:	|
-|    Guilds   	|     :news    	| :achievements 	| :challenge 	| :members 	|
-|             	|              	|               	|            	|          	|
-|             	|              	|               	|            	|          	| _
-* temporarily_ - see #1, #2, #3 @ ([git.3lab.re](https://git.3lab.re/marahin/wowapi/issues))
+|    .guild   	|     :news    	| :achievements 	| :challenge 	| :members 	|
+|    .character |
 
+### Examples
 ```
 require 'wowapi'
 
@@ -42,8 +70,19 @@ api = Wowapi.new do |config|
   # 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}}
+# returns guild profile
+guild = api.guild('Argent Dawn', 'The Aspects')  
+
+# returns guild profile & members list
+guild = api.guild('Argent Dawn', 'The Aspects', :members) 
+guild.members # Array of CharacterClass objects
+
+# returns guild profile, members list & news
+guild = api.guild('Argent Dawn', 'The Aspects', :members, :news)
+guild.news # array of Hashes containing news
+ 
+# returns character profile
+character = api.character('Argent Dawn', 'Marahin')
 
 ```
 
@@ -60,7 +99,27 @@ Make sure your Wowapi instance contains `public_key` (and/or, if necessary - `se
 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.
+Everything >= 2.0.0 should work just fine. Below you can see a table with different MRI Ruby versions which we tested the gem on:
+
+| Ruby (MRI) | Does it work?                                   |
+|------------|-------------------------------------------------|
+| 1.9.3      | **NO**. Some flow in Object class is different. |
+| 2.0.0      | Hell **YES**.                                   |
+| 2.2.3      | Sure, **YES**.                                  |
+| 2.3.0      | Just fine, **YES**.                             |
+| 2.3.1      | **YES**, uh huh.                                |
+
+As it's early stage development, and as it's stated in the LICENSE, I do not guarantee that any other Rubies will make allow you to use this library.
+Hell, I do not guarantee _anything_.
+
+## Documentation
+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. 
+
+You may also browse *ri* documentation which installs by default when you install the gem. Just type `ri Wowapi`. 
+
+**But it should work just fine on Rubies >= 2.0.0.**
+
 ## Regions
 ### Region defaults to :eu!
 List of currently supported regions:
@@ -77,5 +136,19 @@ end
 ```
 
 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.
+
+### 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. 
+
+### I want to help
+If you want to help, make sure you understand how the library works. Ask me, don't feel shy. As a beginner, making me know that someone actually uses it will make my heart warm.  
+If you already know what you're doing, and you know how to fix the bug / make something work better / improve the library, create a pull request. 
+
+Or either create an issue with the code, explaining how it works and why is it better / how does it fix stuff. I don't really care, whatever is easier / friendlier for you. 
 ## Games
-**There is no plan of supporting anything but World of Warcraft. Sorry.**
+**There is no plan of supporting anything but World of Warcraft. Sorry.**  
+Unless money is involved. :^)

data/lib/wowapi/fail_silently.rb

@@ -0,0 +1,11 @@
+class Wowapi
+  # Metaprogramming!
+  class << self
+    # Raise exceptions on error responses from API endpoint?
+    attr_accessor :fail_silently
+  end
+
+  # Defaults to false
+  @fail_silently = false
+end
+

data/lib/wowapi/modules.rb

@@ -0,0 +1,11 @@
+require 'wowapi/modules/character'
+require 'wowapi/modules/guild'
+
+class Wowapi
+  # 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::Character
+  include Wowapi::Modules::Guild
+end

data/lib/wowapi/modules/character.rb

@@ -0,0 +1,19 @@
+class Wowapi
+  module Modules
+    # Character module containing methods for
+    # character data retrieval & definition of
+    # CharacterClass
+    module Character
+      # todo: issue-13
+      class CharacterClass < Wowapi::ResponseData; end
+
+      # Retrieve data about particular Character
+      # For a list of fields visit README.md
+      def character(realm, name, *args)
+        args = args.map{|n| n if n.is_a?(Symbol) }
+        res = get 'character/', "#{realm}/#{name}?fields=#{args.join(',')}"
+        Wowapi::Modules::Character::CharacterClass.new(JSON.parse(res))
+      end
+    end
+  end
+end

data/lib/wowapi/modules/guild.rb

@@ -5,17 +5,25 @@ class Wowapi
     # some kind of GuildClass, see:
     # https://git.3lab.re/marahin/wowapi/issues/1
     module Guild
+
+      # GuildClass - represents the Guild resource
+      class GuildClass < Wowapi::ResponseData
+        def initialize(data={})
+          super
+          if @table
+            @table[:members].map!{ |player_hash|
+              Wowapi::Modules::Character::CharacterClass.new(player_hash)
+            } if @table[:members]
+          end
+        end
+      end
+
       # Asks Blizzard API for Guild resource
-      # with (any) given fields
-      # Example:
-      # ```
-      # api.guild 'Argent Dawn', 'The Aspects', :members, :news, ...
-      # ```
-      # Currently returns Hash
+      # for list of fields visit README.md
       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)
+        args = args.map{|n| n if n.is_a?(Symbol) }
+        res = get 'guild/', "#{realm}/#{name}?fields=#{args.join(',')}"
+        Wowapi::Modules::Guild::GuildClass.new(JSON.parse(res))
       end
     end
   end

data/lib/wowapi/response_data.rb

@@ -0,0 +1,26 @@
+class Wowapi
+  # Every ModuleClass inherits from this object,
+  # so GuildClass, AchievementClass etc.
+  # ResponseData class inherits from OpenStruct which makes it easy to
+  # define arbitrary fields, using a Hash (so a default response object)
+  # http://www.ruby-doc.org/stdlib-2.0/libdoc/ostruct/rdoc/OpenStruct.html
+  class ResponseData < OpenStruct
+    # Raw holds the response Hash, untouched
+    attr_accessor :raw
+
+    def initialize(data={})
+      unless data.is_a?(Hash)
+        raise ArgumentError, 'Data has to be passed as a Hash object.'
+      end
+      @raw = data # Assign raw data to @raw instance variable
+      super
+    end
+
+    # Override default .to_json method
+    # this one returns raw data that was assigned
+    # during initialization
+    def to_json
+      @raw
+    end
+  end
+end

data/lib/wowapi/version.rb

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

data/lib/wowapi/wowapi.rb

@@ -1,26 +1,17 @@
 require 'open-uri'
 require 'json'
 require 'wowapi/core_extensions/object/try'
+require 'wowapi/fail_silently'
 require 'wowapi/exceptions'
 require 'wowapi/version'
-require 'wowapi/modules/guild'
+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
 
-  # 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
-
+  # Creating an instance of Wowapi class
   def initialize
     self.region ||= :eu
     yield self if block_given?

data/wowapi.gemspec

@@ -4,20 +4,22 @@ $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.name                   = 'wowapi'
+  spec.version                = Wowapi::VERSION
+  spec.required_ruby_version  = '>= 2.0.0'
+  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 'pry', '~> 0'
+  if spec.respond_to?(:add_development_dependency)
+    spec.add_development_dependency 'pry', '~> 0.10'
+  end
 end
 

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: wowapi
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.1
 platform: ruby
 authors:
 - Jan Matusz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-07 00:00:00.000000000 Z
+date: 2016-09-11 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: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 description: An easy-to-use gem providing access to World of Warcraft part of Blizzard
   Community API.
 email:
@@ -48,7 +34,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - lib/wowapi.rb
@@ -58,7 +43,11 @@ files:
 - lib/wowapi/exceptions/auth_exception.rb
 - lib/wowapi/exceptions/no_credentials_exception.rb
 - lib/wowapi/exceptions/region_exception.rb
+- lib/wowapi/fail_silently.rb
+- lib/wowapi/modules.rb
+- lib/wowapi/modules/character.rb
 - lib/wowapi/modules/guild.rb
+- lib/wowapi/response_data.rb
 - lib/wowapi/version.rb
 - lib/wowapi/wowapi.rb
 - wowapi.gemspec
@@ -74,7 +63,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile.lock

@@ -1,19 +0,0 @@
-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