poke-api-v2 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 55982a103820663bbb2d0652e8a8e9da58636822
-  data.tar.gz: cf6ee064ea3d3805a35f7ad20610a3664aa5bb48
+SHA256:
+  metadata.gz: 32eb66cbf128d30fe3c198c47433bcdd374504ad4255896570465a51e5be6f30
+  data.tar.gz: f54706d6914fcf814a1b75c2ff82d3c7775819749310aa1ab3ed614152b35c8d
 SHA512:
-  metadata.gz: 5b1eba96ccc46ed87a8ffda8642b85397b7826ff2ebe3bd53e122d7f57ee6314e4d1dc6a199eed014822f75e43ecb1363236db16e8f93790b7be37e9e91efad7
-  data.tar.gz: de867553cc0bda3b6d61661862d875a2f284c37a58e7491d8052be62fecfd026834dd063885f38835d0591800a513f3d327ef5ba0373457b03474ec2fd64051c
+  metadata.gz: d5aa6be36c56d673a3d16a0b64b40c85f113f9268ca27c413a09f9ecfaba61725a3c535612f381438afff9a991be1085697e1a3548c532c8099ecd021e5c3a77
+  data.tar.gz: bde6b63c375efc7da980c665122091f573b4ab89df007171015c598479a737104d58177e0a7773787fa32f5a0281eb3fbc562b61ad2fc14de6f8309c7e0d18cc

data/CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing
+
+Thank you for your interest in contributing! We welcome developers of all skill levels to contribute to Poke-Api-V2 and will provide issues for those new to open-source and veterans alike. All tasks that we are looking to complete can be found in the [Issues](https://github.com/rdavid1099/poke-api-v2/issues) section. If you find a bug or would like to implement new functionality, please feel free to open an issue or contact the owner directly at [rdavid1099@gmail.com](mailto:rdavid1099@gmail.com).
+
+## Installation
+
+- Fork and clone Poke-Api-V2 to your local machine, use [this guide](https://help.github.com/articles/fork-a-repo/) if you don't know how to do that.
+- Set the upstream remote so you can keep your copy of Poke-Api-V2 synced with the original. To do that go to your terminal and `cd` into your cloned `poke-api-v2` directory. Then user one of the following commands:
+
+   If you have ssh set up with Git
+   ```
+   $ git remote add upstream git@github.com:rdavid1099/poke-api-v2.git
+   ```
+   Otherwise
+   ```
+   $ git remote add upstream https://github.com/rdavid1099/poke-api-v2.git
+   ```
+
+- From the root directory run `bundle install` to install all gem dependencies.
+- Run `rake` to run all tests.
+
+## Code Style
+
+While we encourage creativity and clever, performant code, your implementation must follow basic Ruby standards and practices. This project is wired with CodeClimate, Rubocop and Reek. All PRs must pass these checks to be merged into production. As a rule of thumb, all contributors are encouraged to:
+
+- Write readable and succinct code, and use standard functions in Ruby to the best of your knowledge.
+- Blank lines should contain no spaces, and there should be no additional white space following the end of a line of code.
+- Follow the [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself) principle.
+- Run `reek` and `rubocop` before committing any work.
+- Have fun!
+
+If you are familiar with and use git hooks, we strongly encourage you to add the following block of code to your project's `pre-commit` hook. You can learn more about git hooks [here](https://githooks.com/).
+
+```
+EXIT=0
+
+FILES=$(git diff --name-only HEAD)
+
+rubocop $(echo $FILES) --force-exclusion
+EXIT1=$?
+reek $(echo $FILES)
+EXIT2=$?
+
+[ $EXIT1 -gt 0 -o $EXIT2 -gt 0 ] && EXIT=1
+
+[ $EXIT -eq 1 ] && echo 'Unable to commit. Fix issues above.'
+
+exit $EXIT
+```
+
+## Testing
+
+Tests are imperative to creating a functional and successful application. We strive to have 100% test coverage across the codebase. Our test suite uses [RSpec](http://rspec.info/documentation/) and should follow basic RSpec formatting and style. All features/ bugs must include coinciding tests to confirm their functionality.
+
+### Running Tests
+
+Run `rake` or `rspec` to run all tests in test suite.
+
+## Documentation
+
+We are in the process of adding documentation using `YARD`. Please stay tuned for updates when that is ready.
+
+## Pull Requests
+
+All branches should be based off the `dev` branch and written using the following format, `<labe>/<issue number>-<summary of issue>` (ex: `chore/142-add-yard-for-documentation`). Before submitting a pull request, run `rake` in the top-level directory to verify that all tests are passing. Make your pull request to `dev` unless stated otherwise in the issue tracker. We will check for new pull requests at the end of every day and review/ comment on them as necessary.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    poke-api-v2 (0.1.0)
+    poke-api-v2 (0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -28,7 +28,7 @@ GEM
     hashdiff (0.3.8)
     ice_nine (0.11.2)
     jaro_winkler (1.5.2)
-    json (2.2.0)
+    json (2.3.1)
     kwalify (0.7.2)
     method_source (0.9.2)
     parallel (1.17.0)
@@ -41,7 +41,7 @@ GEM
     psych (3.1.0)
     public_suffix (3.0.3)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rb-readline (0.5.5)
     reek (5.0.2)
       codeclimate-engine-rb (~> 0.4.0)
@@ -97,7 +97,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   poke-api-v2!
   pry
-  rake (~> 10.0)
+  rake (~> 13.0)
   rb-readline
   reek (= 5.0.2)
   rspec (~> 3.0)
@@ -107,4 +107,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README.md

@@ -1,9 +1,139 @@
-# Poke::Api::V2
+# Poke-Api-V2
 
+[![Gem Version](https://badge.fury.io/rb/poke-api-v2.svg)](https://badge.fury.io/rb/poke-api-v2)
 [![Build Status](https://semaphoreci.com/api/v1/rworkman1099/poke-api-v2/branches/master/badge.svg)](https://semaphoreci.com/rworkman1099/poke-api-v2)
 [![Maintainability](https://api.codeclimate.com/v1/badges/1f0142f320ea41ce5fed/maintainability)](https://codeclimate.com/github/rdavid1099/poke-api-v2/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/1f0142f320ea41ce5fed/test_coverage)](https://codeclimate.com/github/rdavid1099/poke-api-v2/test_coverage)
 
-## Ruby gem wrapping `https://pokeapi.co/api/v2/`.
+A simplified interface for interacting with the [PokéAPI](https://pokeapi.co/docs/v2.html) version 2 - `https://pokeapi.co/api/v2/`
 
-:construction_worker: Under construction...
+## Requirements
+* Ruby >= 2.0.0
+
+Poke-Api-V2 depends on these other gems for usage at runtime:
+* [net/http] consumes the [PokéAPI](https://pokeapi.co/docs/v2.html)
+* [json] parses the [PokéAPI](https://pokeapi.co/docs/v2.html) response
+
+## Installation
+Add the following line to a Gemfile:
+
+    gem 'poke-api-v2'
+
+and run `bundle install` from your shell.
+
+If you use Rubygems, run this command manually from your shell to install the latest poke-api-v2 version:
+
+    gem install poke-api-v2
+
+
+## Usage
+Once the gem is installed simply require it and call any of the 48 endpoints using `PokeApi#get`.
+```ruby
+require 'poke-api-v2'
+
+PokeApi.get(pokemon: 'bulbasaur') # Fetches data from https://pokeapi.co/api/v2/pokemon/bulbasaur/
+# => #<PokeApi::Pokemon:0x007fe36c2cfc70
+# @abilities=
+#  [#<PokeApi::Pokemon::PokemonAbility:0x007fe36c2cfba8 @ability=#<PokeApi::Ability:0x007fe36c2cfb80 @name="chlorophyll", @url="https://pokeapi.co/api/v2/ability/34/">, @is_hidden=true, @slot=3>,
+#   #<PokeApi::Pokemon::PokemonAbility:0x007fe36c2cf630 @ability=#<PokeApi::Ability:0x007fe36c2cf590 @name="overgrow", @url="https://pokeapi.co/api/v2/ability/65/">, @is_hidden=false, @slot=1>],
+# @base_experience=64,
+# @forms=[#<PokeApi::PokemonForm:0x007fe36c2cee10 @name="bulbasaur", @url="https://pokeapi.co/api/v2/pokemon-form/1/">],
+# @game_indices=
+#  [...
+
+PokeApi.get(super_contest_effect: 1) # Fetches data from https://pokeapi.co/api/v2/super-contest-effect/1/
+# => #<PokeApi::SuperContestEffect:0x007fe36b1976d8
+#  @appeal=2,
+#  @flavor_text_entries=
+#   [#<PokeApi::Common::FlavorText:0x007fe36b197430
+#     @flavor_text="Enables the user to perform first in the next turn.",
+#     @language=#<PokeApi::Utility::Language:0x007fe36b197408 @name="en", @url="https://pokeapi.co/api/v2/language/9/">,
+#     @version=nil>],
+#  @id=1,
+#  @moves=
+#   [#<PokeApi::Move:0x007fe36b196f30 @name="agility", @url="https://pokeapi.co/api/v2/move/97/">,
+```
+
+Almost all endpoints can be queried by either the name or id in accordance with the [PokéAPI Docs](https://pokeapi.co/docs/v2.html).
+
+You can also chain fetches together allowing Poke-Api-V2 to make multiple API calls with one command.
+
+```ruby
+# Call https://pokeapi.co/api/v2/pokedex/2/ -> https://pokeapi.co/api/v2/pokemon-species/1/ -> https://pokeapi.co/api/v2/evolution-chain/1/
+evolution_chain = PokeApi.get(pokedex: 2).pokemon_entries.first.pokemon_species.get.evolution_chain.get
+# => [#<PokeApi::EvolutionChain::ChainLink:0x007fe36c31d718
+#   @evolution_details=...
+
+evolution_chain.chain.evolves_to.first.species.name
+# => "ivysaur"
+```
+
+The [PokéAPI](https://pokeapi.co/docs/v2.html) also allows you to create lists of paginated endpoints for any resource. This can be achieved in a couple different ways using Poke-Api-V2.
+
+First, you can call any endpoint without passing an id or name. This will generate a list of the 20 first resources allowing pagination per 20.
+
+```ruby
+PokeApi.get(:ability)
+# => #<PokeApi::ApiResourceList:0x007fe36c31ce80
+#  @count=293,
+#  @next_url="https://pokeapi.co/api/v2/ability/?offset=20&limit=20",
+#  @previous_url=nil,
+#  @results=
+#   [#<PokeApi::Ability:0x007fe36c31cd40 @name="stench", @url="https://pokeapi.co/api/v2/ability/1/">,
+#    #<PokeApi::Ability:0x007fe36c31c610 @name="drizzle", @url="https://pokeapi.co/api/v2/ability/2/">,
+#    #<PokeApi::Ability:0x007fe36c31c250 @name="speed-boost", @url="https://pokeapi.co/api/v2/ability/3/">,
+#    #<PokeApi::Ability:0x007fe36b2b7e50 @name="battle-armor", @url="https://pokeapi.co/api/v2/ability/4/">,
+#    #<PokeApi::Ability:0x007fe36b2b79c8 @name="sturdy", @url="https://pokeapi.co/api/v2/ability/5/">,
+#    #<PokeApi::Ability:0x007fe36b2b75b8 @name="damp", @url="https://pokeapi.co/api/v2/ability/6/">,
+#    #<PokeApi::Ability:0x007fe36b2b71f8 @name="limber", @url="https://pokeapi.co/api/v2/ability/7/">,
+#    #<PokeApi::Ability:0x007fe36b2b6e38 @name="sand-veil", @url="https://pokeapi.co/api/v2/ability/8/">,
+#    #<PokeApi::Ability:0x007fe36b2b6a50 @name="static", @url="https://pokeapi.co/api/v2/ability/9/">,
+#    #<PokeApi::Ability:0x007fe36b2b6690 @name="volt-absorb", @url="https://pokeapi.co/api/v2/ability/10/">,
+#    #<PokeApi::Ability:0x007fe36b2b6230 @name="water-absorb", @url="https://pokeapi.co/api/v2/ability/11/">,
+#    #<PokeApi::Ability:0x007fe36b2b5ee8 @name="oblivious", @url="https://pokeapi.co/api/v2/ability/12/">,
+#    #<PokeApi::Ability:0x007fe36b2b5880 @name="cloud-nine", @url="https://pokeapi.co/api/v2/ability/13/">,
+#    #<PokeApi::Ability:0x007fe36b2b5538 @name="compound-eyes", @url="https://pokeapi.co/api/v2/ability/14/">,
+#    #<PokeApi::Ability:0x007fe36b2b4520 @name="insomnia", @url="https://pokeapi.co/api/v2/ability/15/">,
+#    #<PokeApi::Ability:0x007fe36b2b4020 @name="color-change", @url="https://pokeapi.co/api/v2/ability/16/">,
+# ...
+
+PokeApi.get(:ability).results[4].get # Fetches data from https://pokeapi.co/api/v2/ability/5/
+```
+
+Second, you can specify the limit and pagination values by passing through the parameters.
+
+```ruby
+PokeApi.get(pokemon_shape: {limit: 5, offset: 5})
+# => #<PokeApi::ApiResourceList:0x007fe36c1ad158
+#  @count=14,
+#  @next_url="https://pokeapi.co/api/v2/pokemon-shape/?offset=10&limit=4",
+#  @previous_url="https://pokeapi.co/api/v2/pokemon-shape/?offset=0&limit=5",
+#  @results=
+#   [#<PokeApi::PokemonShape:0x007fe36c1ad0b8 @name="upright", @url="https://pokeapi.co/api/v2/pokemon-shape/6/">,
+#    #<PokeApi::PokemonShape:0x007fe36c1acc30 @name="legs", @url="https://pokeapi.co/api/v2/pokemon-shape/7/">,
+#    #<PokeApi::PokemonShape:0x007fe36c1ac7f8 @name="quadruped", @url="https://pokeapi.co/api/v2/pokemon-shape/8/">,
+#    #<PokeApi::PokemonShape:0x007fe36c1ac460 @name="wings", @url="https://pokeapi.co/api/v2/pokemon-shape/9/">,
+#    #<PokeApi::PokemonShape:0x007fe36b277da0 @name="tentacles", @url="https://pokeapi.co/api/v2/pokemon-shape/10/">]>
+
+PokeApi.get(pokemon_shape: {limit: 5, page: 2})
+# => #<PokeApi::ApiResourceList:0x007fe36c1bc928
+#  @count=14,
+#  @next_url="https://pokeapi.co/api/v2/pokemon-shape/?offset=10&limit=4",
+#  @previous_url="https://pokeapi.co/api/v2/pokemon-shape/?offset=0&limit=5",
+#  @results=
+#   [#<PokeApi::PokemonShape:0x007fe36c1bc658 @name="upright", @url="https://pokeapi.co/api/v2/pokemon-shape/6/">,
+#    #<PokeApi::PokemonShape:0x007fe36c1b6730 @name="legs", @url="https://pokeapi.co/api/v2/pokemon-shape/7/">,
+#    #<PokeApi::PokemonShape:0x007fe36c1b4660 @name="quadruped", @url="https://pokeapi.co/api/v2/pokemon-shape/8/">,
+#    #<PokeApi::PokemonShape:0x007fe36c19de60 @name="wings", @url="https://pokeapi.co/api/v2/pokemon-shape/9/">,
+#    #<PokeApi::PokemonShape:0x007fe36c18f9f0 @name="tentacles", @url="https://pokeapi.co/api/v2/pokemon-shape/10/">]>
+```
+
+All of the data presented follows the identical patterns described by the API. For a complete list of endpoints and keys, please check out the [PokéAPI Docs](https://pokeapi.co/docs/v2.html).
+
+## Contributing
+
+Contributions are welcome! Be sure to read our [contributing guide](https://github.com/rdavid1099/poke-api-v2/blob/master/CONTRIBUTING.md) before working on an issue. Bug reports and pull requests are welcome on GitHub at https://github.com/rdavid1099/poke-api-v2.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/config/version.rb

@@ -1,3 +1,3 @@
 module PokeApi
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/poke-api-v2.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'vcr', '~> 4.0.0'
   spec.add_development_dependency 'rubocop', '~> 0.65.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poke-api-v2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ryan Workman
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-05-04 00:00:00.000000000 Z
+date: 2020-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -292,7 +293,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -307,9 +308,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby gem wrapper for https://pokeapi.co/api/v2/
 test_files: []