wot_api_ru 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 015e79bfe20d833906c92aba519a451b75dfba50
-  data.tar.gz: 67135721d0606a3550cd597b8db267f37b4dbdb6
+  metadata.gz: 952a84805fac7710edd19fb79e18d2285c0fd6a1
+  data.tar.gz: ebaa8b54aa08c27d3e84d780e4ffba140efbd932
 SHA512:
-  metadata.gz: e7cdb11d46943bfe8e2ab0817f1bc87a1b3f27398895a4a7666f9e3c9136ab6048213876b16902245a69eaaa19d1d8abfab9b45c9642e112a386280a212792c7
-  data.tar.gz: a322809d1c13c704c62085fd8c0f02ded4a266c2717eaedaf3b0a17d71262c15285201468a1b45ff648c2b301db0e26f337d47bfe0741537eea9e5479184a748
+  metadata.gz: 5cbc9730e656a3fc94b42350af158d0482d61755ee0088ec85445d8288468d7e7e4b1699e3077d83b4dfb9354b68399c8586072a0f78f76a6c5f465eb38b9870
+  data.tar.gz: d46d685972e6ac22ef3c67f90997fec6bbcec22a165c69052d349cc8bc4ef08b01735af88003efd95e1d90cefbec2182bd49bf0c32c593a16c471aea37ea0165

data/.gitignore

@@ -1,6 +1,8 @@
 .bundle/
 log/*.log
 pkg/
+doc/
+.yardoc/
 spec/dummy/db/*.sqlite3
 spec/dummy/db/*.sqlite3-journal
 spec/dummy/log/*.log

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wot_api_ru (0.1.1)
+    wot_api_ru (0.1.2)
       rails (~> 4.1, >= 4.1.4)
       rest_client (~> 1.7, >= 1.7.3)
 
@@ -36,6 +36,9 @@ GEM
       tzinfo (~> 1.1)
     arel (5.0.1.20140414130214)
     builder (3.2.2)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
     coveralls (0.7.0)
       multi_json (~> 1.3)
       rest-client
@@ -45,20 +48,41 @@ GEM
     diff-lcs (1.2.5)
     docile (1.1.5)
     erubis (2.7.0)
+    ffi (1.9.3)
+    formatador (0.2.5)
     generator_spec (0.9.2)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
+    guard (2.6.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.2.10)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
     hike (1.2.3)
     i18n (0.6.11)
     json (1.8.1)
+    listen (2.7.9)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
+    method_source (0.8.2)
     mime-types (1.25.1)
     minitest (5.4.0)
     multi_json (1.10.1)
     netrc (0.7.7)
     polyglot (0.3.5)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
@@ -78,11 +102,18 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.3.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
     rest-client (1.7.2)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
     rest_client (1.7.3)
       netrc (~> 0.7.7)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
     rspec-core (3.0.2)
       rspec-support (~> 3.0.0)
     rspec-expectations (3.0.2)
@@ -104,6 +135,7 @@ GEM
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
+    slop (3.5.0)
     sprockets (2.12.1)
       hike (~> 1.2)
       multi_json (~> 1.0)
@@ -119,12 +151,14 @@ GEM
     thor (0.19.1)
     thread_safe (0.3.4)
     tilt (1.4.1)
+    timers (1.1.0)
     tins (1.3.0)
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
     tzinfo (1.2.1)
       thread_safe (~> 0.1)
+    yard (0.8.7.4)
 
 PLATFORMS
   ruby
@@ -132,6 +166,8 @@ PLATFORMS
 DEPENDENCIES
   coveralls (~> 0.7, >= 0.7.0)
   generator_spec (~> 0.9, >= 0.9.2)
+  guard-rspec (~> 4.2, >= 4.2.10)
   rspec-rails (~> 3.0, >= 3.0.1)
   sqlite3 (~> 1.3, >= 1.3.9)
   wot_api_ru!
+  yard (~> 0.8, >= 0.8.7.4)

data/Guardfile

@@ -0,0 +1,23 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/dummy/app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/dummy/app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^spec/dummy/app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^spec/dummy/app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/README.md

@@ -2,9 +2,10 @@ WotApiRu
 =======
 [![Gem Version](https://badge.fury.io/rb/wot_api_ru.svg)](http://badge.fury.io/rb/wot_api_ru)
 [![Code Climate](https://codeclimate.com/github/shved270189/wot_api_ru.png)](https://codeclimate.com/github/shved270189/wot_api_ru)
-[![Dependency Status](https://gemnasium.com/shved270189/wot_api_ru.svg)](https://gemnasium.com/shved270189/wot_api_ru)
 [![Build Status](https://travis-ci.org/shved270189/wot_api_ru.svg?branch=master)](https://travis-ci.org/shved270189/wot_api_ru)
 [![Coverage Status](https://img.shields.io/coveralls/shved270189/wot_api_ru.svg)](https://coveralls.io/r/shved270189/wot_api_ru?branch=master)
+[![Inline docs](http://inch-ci.org/github/shved270189/wot_api_ru.svg?branch=master)](http://inch-ci.org/github/shved270189/wot_api_ru)
+[![Dependency Status](https://gemnasium.com/shved270189/wot_api_ru.svg)](https://gemnasium.com/shved270189/wot_api_ru)
 [![PullReview stats](https://www.pullreview.com/github/shved270189/wot_api_ru/badges/master.svg?)](https://www.pullreview.com/github/shved270189/wot_api_ru/reviews/master)
 
 Ruby gem for [Wargaming.net Public API](http://ru.wargaming.net/developers/documentation/guide/getting-started/)

data/Rakefile

@@ -4,18 +4,4 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'WotApiRu'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
 Bundler::GemHelper.install_tasks
-

data/lib/generators/wot_api_ru/install_generator.rb

@@ -1,16 +1,22 @@
 require 'rails/generators'
 
 module WotApiRu
+  # @author Ivan Bondarenko
+  # Rails generator for generate initializer wot_api_ru file
   class InstallGenerator < Rails::Generators::Base
     include Rails::Generators::ResourceHelpers
     desc 'Generate initialize file of wot_api_ru'
 
+    # Generator name
+    # @return [String] generator name
     def name
       'wot_api_ru'
     end
 
     source_root File.expand_path('../templates', __FILE__)
 
+    # Create initialize wot_api_ru file
+    # @note This method create config/initializers/wot_api_ru.rb in rails application
     def copy_initializer_file
       copy_file 'wot_api_ru.rb', 'config/initializers/wot_api_ru.rb'
     end

data/lib/wot_api_ru.rb

@@ -1,5 +1,6 @@
 require 'generators/wot_api_ru/install_generator'
 require 'wot_api_ru/client'
 
+# Module for namespace wot_api_ru gem
 module WotApiRu
 end

data/lib/wot_api_ru/client.rb

@@ -3,7 +3,11 @@ require 'wot_api_ru/settings'
 require 'rest_client'
 
 module WotApiRu
+  # @author Ivan Bondarenko
+  # Class of client for send response to Wargaming.net Public API
   class Client
+    # This method dynamic call Wargaming.net Public API methods from WotApiRu::PATH values
+    # @note If you call method which undefined as key in WotApiRu::PATH then method raise NoMethodError
     def method_missing(meth, *args, &block)
       raise NoMethodError, "undefined method #{meth} for #{self.class.to_s}" if WotApiRu::Constants::PATH[meth.to_sym].nil?
       options = args[0] || {}

data/lib/wot_api_ru/constants.rb

@@ -1,7 +1,11 @@
 module WotApiRu
+  # @author Ivan Bondarenko
+  # Class of application constants
   module Constants
+    # Host for response to Wargaming.net Public API
     HOST = 'https://api.worldoftanks.ru/wot/'
 
+    # Hash of pathes to Wargaming.net Public API methods
     PATH = {
         # All pathes require: application_id
 

data/lib/wot_api_ru/settings.rb

@@ -1,12 +1,23 @@
 module WotApiRu
+  # @author Ivan Bondarenko
+  # Storage for application settings
   class Settings
     @options = Hash.new
 
     class << self
+      # Get settings
+      # @note This method may get parameter which user set in initializer wot_api_ru
+      # @param ind [String, Symbol] the key of setting value
+      # @return [String] value settings
       def [](ind)
         @options[ind.to_sym]
       end
 
+      # Set settings
+      # @note This method may set or modify application settings
+      # @param ind [String, Symbol] the key of setting value
+      # @param val [] the value of setting value
+      # @return [] val
       def []=(ind, val)
         @options[ind.to_sym] = val.to_s
       end

data/lib/wot_api_ru/version.rb

@@ -1,3 +1,4 @@
 module WotApiRu
-  VERSION = '0.1.1'
+  # Current gem version
+  VERSION = '0.1.2'
 end

data/spec/lib/wot_api_ru/version_spec.rb

@@ -1,5 +1,5 @@
 require 'rails_helper'
 
 describe WotApiRu do
-  it { expect(WotApiRu::VERSION).to eq '0.1.1' }
+  it { expect(WotApiRu::VERSION).to eq '0.1.2' }
 end

data/wot_api_ru.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec-rails", '~> 3.0', '>= 3.0.1'
   s.add_development_dependency "coveralls", '~> 0.7', '>= 0.7.0'
   s.add_development_dependency "generator_spec", '~> 0.9', '>= 0.9.2'
+  s.add_development_dependency "guard-rspec", '~> 4.2', '>= 4.2.10'
+  s.add_development_dependency "yard", '~> 0.8', '>= 0.8.7.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wot_api_ru
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ivan Bondarenko
@@ -130,6 +130,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7.4
 description: Gem for Wargaming.net Public API http://ru.wargaming.net/developers/api_reference
   .
 email:
@@ -145,10 +185,10 @@ files:
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE
 - MIT-LICENSE
 - README.md
-- README.rdoc
 - Rakefile
 - lib/generators/wot_api_ru/install_generator.rb
 - lib/generators/wot_api_ru/templates/wot_api_ru.rb
@@ -234,3 +274,4 @@ signing_key:
 specification_version: 4
 summary: Wargaming.net Public API.
 test_files: []
+has_rdoc: 

data/README.rdoc

@@ -1,3 +0,0 @@
-= WotApiRu
-
-This project rocks and uses MIT-LICENSE.