dota_api_wrapper 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: f788517f93d09fac1b53caf832e09c5deccda09e
4
+ data.tar.gz: 55d1ae53567bf03693d912e44e7c61122bc17d5d
5
+ SHA512:
6
+ metadata.gz: a6a10073798c17e9be4445b3f8a2eb212b1869eb2150efd81a7c7c271df9510cd1fda0db0537e8d50150601213cd104b28c31af954064d38c2aa72512f3261a8
7
+ data.tar.gz: 92d2f65b6dd277d32eb86310c5946902d5a7574d9720a780a89f89fb487060d1df9930afa19db942cabb32fe2705d17eedd17e3d05e84697d2cd1d0d46ffa783
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.3.0
4
+ before_install: gem install bundler -v 1.11.2
5
+ addons:
6
+ code_climate:
7
+ repo_token: f6beb531e0e4c1b6dfc79c2c8a660c7d58fa0d11b96cc088ca564c9cf9dcc103
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at ej.perezgomez@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in dota_api_wrapper.gemspec
4
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Eloy
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,45 @@
1
+ # DotaApiWrapper
2
+ [![Build Status](https://travis-ci.org/epergo/dota_api_wrapper.svg?branch=master)](https://travis-ci.org/epergo/dota_api_wrapper)
3
+ [![Code Climate](https://codeclimate.com/github/epergo/dota_api_wrapper/badges/gpa.svg)](https://codeclimate.com/github/epergo/dota_api_wrapper)
4
+ [![Test Coverage](https://codeclimate.com/github/epergo/dota_api_wrapper/badges/coverage.svg)](https://codeclimate.com/github/epergo/dota_api_wrapper/coverage)
5
+
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'dota_api_wrapper'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install dota_api_wrapper
22
+
23
+ ## Steam API Key
24
+
25
+ In order to use this API first you need to get your API key. You can get it [here](http://steamcommunity.com/dev/apikey)
26
+
27
+ This gem will read your key from an environment variable, so once you have it you'll need to export it in your environment.
28
+
29
+ `export STEAM_API_KEY=0123456789`
30
+
31
+ ## Examples of usage
32
+
33
+ ### Heroes
34
+
35
+ `heroes = DotaApiWrapper::Hero.new`
36
+
37
+ `heroes.find_by_id(25) => {"name"=>"npc_dota_hero_lina", "id"=>25, "localized_name"=>"Lina"}`
38
+
39
+ ## Development
40
+
41
+ After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests. You can also run `rake console` for an interactive prompt that will allow you to experiment.
42
+
43
+ ## Contributing
44
+
45
+ Bug reports and pull requests are welcome on GitHub at https://github.com/epergo/dota_api_wrapper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
data/Rakefile ADDED
@@ -0,0 +1,13 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rake/testtask'
3
+
4
+ Rake::TestTask.new do |t|
5
+ t.test_files = FileList['spec/lib/dota_api_wrapper/*_spec.rb']
6
+ t.verbose = true
7
+ end
8
+
9
+ task :console do
10
+ exec 'pry -r dota_api_wrapper -I ./lib'
11
+ end
12
+
13
+ task default: :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "dota_api_wrapper"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,38 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'dota_api_wrapper/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "dota_api_wrapper"
8
+ spec.version = DotaApiWrapper::VERSION
9
+ spec.authors = ["Eloy"]
10
+ spec.email = ["ej.perezgomez@gmail.com"]
11
+
12
+ spec.summary = %q{Wrapper for Valve's DOTA 2 API.}
13
+ spec.description = %q{}
14
+ spec.homepage = ""
15
+
16
+ # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
17
+ # delete this section to allow pushing this gem to any host.
18
+ if spec.respond_to?(:metadata)
19
+ spec.metadata['allowed_push_host'] = 'https://rubygems.org'
20
+ else
21
+ raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
22
+ end
23
+
24
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
25
+ spec.bindir = "exe"
26
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
27
+ spec.require_paths = ["lib"]
28
+
29
+ spec.add_dependency "httparty"
30
+
31
+ spec.add_development_dependency "bundler"
32
+ spec.add_development_dependency "rake"
33
+ spec.add_development_dependency "webmock"
34
+ spec.add_development_dependency "vcr"
35
+ spec.add_development_dependency "minitest-reporters"
36
+ spec.add_development_dependency "pry"
37
+ spec.add_development_dependency 'codeclimate-test-reporter'
38
+ end
@@ -0,0 +1,6 @@
1
+ require "dota_api_wrapper/version"
2
+ require 'httparty'
3
+
4
+ Dir[File.dirname(__FILE__) + '/dota_api_wrapper/*.rb'].each do |file|
5
+ require file
6
+ end
@@ -0,0 +1,12 @@
1
+ module DotaApiWrapper
2
+ class Base
3
+ include HTTParty
4
+
5
+ BASE_URI = 'http://api.steampowered.com'.freeze
6
+ API_KEY = ENV['STEAM_API_KEY']
7
+
8
+ def get(uri, options)
9
+ self.class.get(uri, options)
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,13 @@
1
+ require_relative 'base'
2
+
3
+ module DotaApiWrapper
4
+ class Econ < Base
5
+ base_uri(BASE_URI + '/IEconDOTA2_570')
6
+
7
+ attr_accessor :language
8
+
9
+ def initialize(lang = 'en_us')
10
+ @language = lang
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,28 @@
1
+ require_relative 'econ'
2
+
3
+ module DotaApiWrapper
4
+ class Hero < Econ
5
+ attr_accessor :heroes
6
+
7
+ def initialize(lang = 'en_us')
8
+ super(lang)
9
+ @heroes = retrieve_heroes
10
+ end
11
+
12
+ def retrieve_heroes
13
+ query_params = { 'key' => API_KEY, 'language' => language }
14
+ api_result = get('/GetHeroes/v0001', query: query_params, headers: {})
15
+
16
+ return if api_result.empty?
17
+
18
+ res = {}
19
+ api_result['result']['heroes'].each { |a| res[a['id']] = a }
20
+
21
+ res
22
+ end
23
+
24
+ def find_by_id(id)
25
+ heroes[id]
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,28 @@
1
+ require_relative 'econ'
2
+
3
+ module DotaApiWrapper
4
+ class Item < Econ
5
+ attr_accessor :items
6
+
7
+ def initialize(lang = 'en_us')
8
+ super(lang)
9
+ @items = retrieve_items
10
+ end
11
+
12
+ def retrieve_items
13
+ query_params = { 'key' => API_KEY, 'language' => language }
14
+ api_result = get('/GetGameItems/v0001', query: query_params, headers: {})
15
+
16
+ return if api_result.empty?
17
+
18
+ res = {}
19
+ api_result['result']['items'].each { |i| res[i['id']] = i }
20
+
21
+ res
22
+ end
23
+
24
+ def find_by_id(id)
25
+ items[id]
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,33 @@
1
+ require_relative 'base'
2
+
3
+ module DotaApiWrapper
4
+ class Player < Base
5
+ base_uri(BASE_URI + '/ISteamUser')
6
+
7
+ attr_accessor :steam_id
8
+ attr_accessor :player_info
9
+
10
+ def initialize(steam_id)
11
+ @steamid = steam_id
12
+ end
13
+
14
+ # If the parameter name exists in the hash, it will be returned
15
+ # In other case in will raise an exception 'NoMethodError'
16
+ def method_missing(name, *args, &block)
17
+ player_info.key?(name.to_s) ? player_info[name.to_s] : super
18
+ end
19
+
20
+ def player_info
21
+ @player_info ||= retrieve_info
22
+ end
23
+
24
+ def retrieve_info
25
+ query_params = { 'key' => API_KEY, 'steamids' => @steamid }
26
+ api_result = get('/GetPlayerSummaries/v0002', query: query_params, headers: {})
27
+
28
+ return if api_result.empty?
29
+
30
+ api_result['response']['players'][0]
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,3 @@
1
+ module DotaApiWrapper
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,173 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: dota_api_wrapper
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Eloy
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-03-13 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: httparty
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: webmock
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: vcr
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: minitest-reporters
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: pry
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: codeclimate-test-reporter
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ description: ''
126
+ email:
127
+ - ej.perezgomez@gmail.com
128
+ executables: []
129
+ extensions: []
130
+ extra_rdoc_files: []
131
+ files:
132
+ - ".gitignore"
133
+ - ".travis.yml"
134
+ - CODE_OF_CONDUCT.md
135
+ - Gemfile
136
+ - LICENSE
137
+ - README.md
138
+ - Rakefile
139
+ - bin/console
140
+ - bin/setup
141
+ - dota_api_wrapper.gemspec
142
+ - lib/dota_api_wrapper.rb
143
+ - lib/dota_api_wrapper/base.rb
144
+ - lib/dota_api_wrapper/econ.rb
145
+ - lib/dota_api_wrapper/hero.rb
146
+ - lib/dota_api_wrapper/item.rb
147
+ - lib/dota_api_wrapper/player.rb
148
+ - lib/dota_api_wrapper/version.rb
149
+ homepage: ''
150
+ licenses: []
151
+ metadata:
152
+ allowed_push_host: https://rubygems.org
153
+ post_install_message:
154
+ rdoc_options: []
155
+ require_paths:
156
+ - lib
157
+ required_ruby_version: !ruby/object:Gem::Requirement
158
+ requirements:
159
+ - - ">="
160
+ - !ruby/object:Gem::Version
161
+ version: '0'
162
+ required_rubygems_version: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - ">="
165
+ - !ruby/object:Gem::Version
166
+ version: '0'
167
+ requirements: []
168
+ rubyforge_project:
169
+ rubygems_version: 2.5.1
170
+ signing_key:
171
+ specification_version: 4
172
+ summary: Wrapper for Valve's DOTA 2 API.
173
+ test_files: []