warframe 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +75 -71
- data/lib/warframe/version.rb +1 -1
- data/warframe.gemspec +1 -2
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9366d7cdf95fbbfad6dcb23e4f7bdac4237c09ad8b3660cf4339df52d4f8dfdc
|
4
|
+
data.tar.gz: 8ed8bc2f67c78651e0f3201bb4f22561d57cd18da758822ce432970717352f43
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8995e720acd7917a9c7f8c097eba3e5ed444144a25506b622145d8a81b62307b4fdb77f5a084242928d405a9d161a01dfb716c3576406370dccb4d7d68f29c17
|
7
|
+
data.tar.gz: 0d6b384a787527d51a2d9ff788ff59edea2d20e5ff78e29cc3ea71364fb548df9a7e4e3271f3b6fcfaff44fdf2bece123e04673521ed0c262b9e17a002a5da98
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -1,71 +1,75 @@
|
|
1
|
-
# warframe-ruby
|
2
|
-
[](https://rubygems.org/gems/
|
3
|
-
[](https://rubygems.org/gems/
|
4
|
-
[](https://github.com/rubocop/rubocop)
|
5
|
-
[](https://www.ruby-lang.org/en/)
|
6
|
-
|
7
|
-
A Ruby client for [Warframe Stat](https://warframestat.us) bringing you live modeled data from their API.
|
8
|
-
|
9
|
-
## Installation
|
10
|
-
|
11
|
-
Add this line to your application's Gemfile:
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
gem 'warframe'
|
15
|
-
```
|
16
|
-
|
17
|
-
And then execute:
|
18
|
-
|
19
|
-
$ bundle install
|
20
|
-
|
21
|
-
Or install it yourself as:
|
22
|
-
|
23
|
-
$ gem install warframe
|
24
|
-
|
25
|
-
## Usage
|
26
|
-
|
27
|
-
To get started accessing live data, you must instantiate a new `Warframe::REST::Client`
|
28
|
-
```ruby
|
29
|
-
require 'warframe'
|
30
|
-
|
31
|
-
client = Warframe::REST::Client.new # => <Warframe::REST::Client platform='pc' language='en'>
|
32
|
-
|
33
|
-
# You can supply a hash to set your preferred platform or language.
|
34
|
-
my_custom_options = { platform: 'ps4', language: 'de' }
|
35
|
-
german_ps4 = Warframe::REST:Client.new my_custom_options # => <Warframe::REST::Client platform='ps4' language='de'>
|
36
|
-
```
|
37
|
-
|
38
|
-
This gives us access to a plethora of methods, check out the [documentation](https://rubydoc.info/gems/warframe) for more info.
|
39
|
-
```ruby
|
40
|
-
|
41
|
-
client = Warframe::REST::Client.new
|
42
|
-
client.nightwave # => <Warframe::Models::Nightwave>
|
43
|
-
client.alerts # => [ <Warframe::Models::Alert>, <Warframe::Models::Alert> ]
|
44
|
-
```
|
45
|
-
|
46
|
-
## Documentation
|
47
|
-
|
48
|
-
Documentation is currently provided by [rubydoc.info](https://rubydoc.info), check out the current versions documentation at https://rubydoc.info/gems/warframe.
|
49
|
-
|
50
|
-
## Development
|
51
|
-
|
52
|
-
### Dependency Management
|
53
|
-
After checking out the repo, run `bundle install` to install required dependencies.
|
54
|
-
|
55
|
-
### Testing
|
56
|
-
To check if your changes are passing tests, run
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
##
|
70
|
-
|
71
|
-
|
1
|
+
# warframe-ruby
|
2
|
+
[](https://rubygems.org/gems/warframe)
|
3
|
+
[](https://rubygems.org/gems/warframe)
|
4
|
+
[](https://github.com/rubocop/rubocop)
|
5
|
+
[](https://www.ruby-lang.org/en/)
|
6
|
+
|
7
|
+
A Ruby client for [Warframe Stat](https://warframestat.us) bringing you live modeled data from their API.
|
8
|
+
|
9
|
+
## Installation
|
10
|
+
|
11
|
+
Add this line to your application's Gemfile:
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
gem 'warframe'
|
15
|
+
```
|
16
|
+
|
17
|
+
And then execute:
|
18
|
+
|
19
|
+
$ bundle install
|
20
|
+
|
21
|
+
Or install it yourself as:
|
22
|
+
|
23
|
+
$ gem install warframe
|
24
|
+
|
25
|
+
## Usage
|
26
|
+
|
27
|
+
To get started accessing live data, you must instantiate a new `Warframe::REST::Client`
|
28
|
+
```ruby
|
29
|
+
require 'warframe'
|
30
|
+
|
31
|
+
client = Warframe::REST::Client.new # => <Warframe::REST::Client platform='pc' language='en'>
|
32
|
+
|
33
|
+
# You can supply a hash to set your preferred platform or language.
|
34
|
+
my_custom_options = { platform: 'ps4', language: 'de' }
|
35
|
+
german_ps4 = Warframe::REST:Client.new my_custom_options # => <Warframe::REST::Client platform='ps4' language='de'>
|
36
|
+
```
|
37
|
+
|
38
|
+
This gives us access to a plethora of methods, check out the [documentation](https://rubydoc.info/gems/warframe) for more info.
|
39
|
+
```ruby
|
40
|
+
|
41
|
+
client = Warframe::REST::Client.new
|
42
|
+
client.nightwave # => <Warframe::Models::Nightwave>
|
43
|
+
client.alerts # => [ <Warframe::Models::Alert>, <Warframe::Models::Alert> ]
|
44
|
+
```
|
45
|
+
|
46
|
+
## Documentation
|
47
|
+
|
48
|
+
Documentation is currently provided by [rubydoc.info](https://rubydoc.info), check out the current versions documentation at https://rubydoc.info/gems/warframe.
|
49
|
+
|
50
|
+
## Development
|
51
|
+
|
52
|
+
### Dependency Management
|
53
|
+
After checking out the repo, run `bundle install` to install required dependencies.
|
54
|
+
|
55
|
+
### Testing
|
56
|
+
To check if your changes are passing tests, run:
|
57
|
+
|
58
|
+
$ rake test
|
59
|
+
|
60
|
+
> Testing framework provided by [RSpec](https://rspec.info/).
|
61
|
+
|
62
|
+
### Linting
|
63
|
+
To auto-correct styling offenses, run:
|
64
|
+
|
65
|
+
$ rake lint
|
66
|
+
|
67
|
+
> All linting is provided by [RuboCop](https://github.com/rubocop/rubocop).
|
68
|
+
|
69
|
+
## Contributing
|
70
|
+
|
71
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/aj-rom/warframe-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/aj-rom/warframe-ruby/blob/master/CODE_OF_CONDUCT.md).
|
72
|
+
|
73
|
+
## License
|
74
|
+
|
75
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
data/lib/warframe/version.rb
CHANGED
data/warframe.gemspec
CHANGED
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
|
|
17
17
|
# MetaData
|
18
18
|
spec.metadata['source_code_uri'] = 'https://github.com/aj-rom/warframe-ruby'
|
19
19
|
spec.metadata['bug_tracker_uri'] = "#{spec.metadata['source_code_uri']}/issues"
|
20
|
-
spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{spec.name}
|
20
|
+
spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{spec.name}"
|
21
21
|
|
22
22
|
# Executables / Files
|
23
23
|
spec.bindir = 'exe'
|
@@ -31,7 +31,6 @@ Gem::Specification.new do |spec|
|
|
31
31
|
end
|
32
32
|
end
|
33
33
|
|
34
|
-
|
35
34
|
# Dependencies
|
36
35
|
spec.required_ruby_version = '>= 2.5.0'
|
37
36
|
spec.add_dependency 'fast_underscore', '~> 0.3.2'
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: warframe
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- A.J. Romaniello
|
@@ -220,7 +220,7 @@ licenses:
|
|
220
220
|
metadata:
|
221
221
|
source_code_uri: https://github.com/aj-rom/warframe-ruby
|
222
222
|
bug_tracker_uri: https://github.com/aj-rom/warframe-ruby/issues
|
223
|
-
documentation_uri: https://rubydoc.info/gems/warframe
|
223
|
+
documentation_uri: https://rubydoc.info/gems/warframe
|
224
224
|
post_install_message:
|
225
225
|
rdoc_options: []
|
226
226
|
require_paths:
|