pokedex 0.0.1

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.11.2
+addons:
+  code_climate:
+    repo_token: bb943613033874972517871ea57c9c5e9c2b65120dca6a916d2350c0d5893904

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at daniel.romero.esteban@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pokedex.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel Romero
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# Pokedex
+[![Build Status](https://travis-ci.org/danielRomero/pokedex.svg?branch=master)](https://travis-ci.org/danielRomero/pokedex)
+[![Code Climate](https://codeclimate.com/github/danielRomero/pokedex/badges/gpa.svg)](https://codeclimate.com/github/danielRomero/pokedex)
+[![Test Coverage](https://codeclimate.com/github/danielRomero/pokedex/badges/coverage.svg)](https://codeclimate.com/github/danielRomero/pokedex/coverage)
+
+Ruby wrapper for http://pokeapi.co Pokemon API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pokedex'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pokedex
+
+## Usage
+
+#### Available configuration
+You can set different timeout. The http://pokeapi.co sometimes can be very slow.
+  ```ruby
+  # application.rb
+  Pokedex.timeout = 30 # seconds
+  ```
+#### Methods
+Example of Pokemon info
+```
+pokemon = Pokedex::Pokemon.find 1
+pokemon.name 'zh' # Pokemon's name by locale
+pokemon.evolution_chain
+
+```
+##### Resources Availables:
+  - Area: Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters.
+
+  - EggGroup: Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups.
+
+  - EvolutionChain: Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as Pokémon they can evolve into up through the hierarchy.
+
+  - Generation: A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include.
+
+  - Location: Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.
+
+  - Pokemon: Pokémon are the creatures that inhabit the world of the Pokémon games. They can be caught using Pokéballs and trained by battling with other Pokémon.
+
+  - Region: A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them.
+
+  - VersionGroup: Version groups categorize highly similar versions of the games.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/danielromero/pokedex.
+
+### Steps to contribute:
+  1. Open new issue https://github.com/danielRomero/pokedex/issues/new
+  2. Clone this repo to your local machine `git clone git@github.com:danielRomero/pokedex.git`
+  3. Checkout to new branch with issue ID as name `git checkout -b issue-1234`
+  4. Install dependencies `bundle install`
+  5. Test your changes `bundle exec rake spec`
+  6. Commit and push your branch and make new pull request https://github.com/danielRomero/pokedex/compare
+  7. If everything is ok, your changes will be included to the next version.
+
+## TODO
+
+1. Improve Tests
+2. Cover all http://pokeapi.co resources & attributes
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/pokedex.rb

@@ -0,0 +1,34 @@
+module Pokedex
+  require 'pry' # only for debug
+  require 'awesome_print' # only for debug
+
+  require 'unirest' # for api requests
+
+  require 'pokedex/area'
+  require 'pokedex/egg_group'
+  require 'pokedex/evolution_chain'
+  require 'pokedex/generation'
+  require 'pokedex/location'
+  require 'pokedex/pokemon'
+  require 'pokedex/region'
+  require 'pokedex/version_group'
+
+  class << self
+
+    def get resource_path, options = {}
+      Unirest.timeout(timeout)
+      url = "#{Pokedex::API_BASE_URL}/#{resource_path}"
+      puts "[Pokedex] request to #{url} -- timeout: #{timeout}"
+      response = Unirest.get(url, headers: {}, parameters: options[:params], auth: nil)
+      response.body
+    end
+
+    def timeout=(timeout_value)
+      @@timeout = timeout_value
+    end
+
+    def timeout
+      @@timeout ||= Pokedex::DEFAULT_TIMEOUT
+    end
+  end
+end

data/lib/pokedex/area.rb

@@ -0,0 +1,22 @@
+module Pokedex
+  class Area
+    require 'pokedex/modules_helper/name'
+    include Pokedex::ModulesHelper::Name
+
+    attr_accessor :id, :names
+
+    def initialize(args={})
+      @id     = args['id']
+      extract_names args
+    end
+
+    def self.find id
+      new Pokedex.get "api/v2/location-area/#{id}"
+    end
+
+    def self.find_by_url url
+      new Pokedex.get URI.parse(url).path
+    end
+
+  end
+end

data/lib/pokedex/egg_group.rb

@@ -0,0 +1,22 @@
+module Pokedex
+  class EggGroup
+    require 'pokedex/modules_helper/name'
+    include Pokedex::ModulesHelper::Name
+
+    attr_accessor :id, :names, :pokemon_urls
+
+    def initialize(args = {})
+      @id           = args['id']
+      @pokemon_urls = args['pokemon_species'].map{ |pokemon_specie| pokemon_specie['url'] }
+      extract_names args
+    end
+
+    def self.find id
+      new Pokedex.get "api/v2/egg-group/#{id}"
+    end
+
+    def self.find_by_url url
+      new Pokedex.get URI.parse(url).path
+    end
+  end
+end

data/lib/pokedex/evolution_chain.rb

@@ -0,0 +1,34 @@
+module Pokedex
+  class EvolutionChain
+    attr_accessor :id, :evolves
+
+    def initialize(args = {})
+      @id      = args['id']
+      @evolves = [ generate_evolves(args['chain']) ]
+    end
+
+    def self.find id
+      new Pokedex.get "api/v2/evolution-chain/#{id}"
+    end
+
+    def self.find_by_url url
+      new Pokedex.get URI.parse(url).path
+    end
+
+    private
+
+    def generate_evolves(chain_args={}, evolves={})
+      return evolves if chain_args.empty? || chain_args.nil?
+      evolves[:pokemon]    = chain_args['species'].nil? ?
+                              nil :
+                              Pokemon.find_by_url(chain_args['species']['url'])
+      evolves[:min_level]  = chain_args['evolution_details'].nil? ?
+                              nil :
+                              chain_args['evolution_details']['min_level']
+      evolves[:evolves_to] = chain_args['evolves_to'].map{ |evolve|
+                              generate_evolves(evolve)}
+      evolves
+    end
+
+  end
+end

data/lib/pokedex/generation.rb

@@ -0,0 +1,30 @@
+module Pokedex
+  class Generation
+
+    require 'pokedex/modules_helper/name'
+    include Pokedex::ModulesHelper::Name
+
+    attr_accessor :id, :region_url, :names, :pokemon_urls, :version_groups
+
+    def initialize(args={})
+      @id             = args['id']
+      @pokemon_urls   = args['pokemon_species'].map{ |pokemon_specie| pokemon_specie['url'] }
+      @version_groups = args['version_groups'].map{ |version_group| version_group['url'] }
+      @region_url     = args['main_region']['url']
+      extract_names args
+    end
+
+    def self.find id
+      new Pokedex.get "api/v2/generation/#{id}"
+    end
+
+    def self.find_by_url url
+      new Pokedex.get URI.parse(url).path
+    end
+
+    def region
+      Region.find_by_url region_url
+    end
+
+  end
+end

data/lib/pokedex/location.rb

@@ -0,0 +1,24 @@
+module Pokedex
+  class Location
+    require 'pokedex/modules_helper/name'
+    include Pokedex::ModulesHelper::Name
+
+    attr_accessor :id, :names, :region, :areas
+
+    def initialize(args = {})
+      @id     = args['id']
+      @region = Region.find_by_url args['region']['url']
+      @areas  = args['areas'].map{ |area| Area.find_by_url area['url'] }
+      extract_names args
+    end
+
+    def self.find id
+      new Pokedex.get "api/v2/location/#{id}"
+    end
+
+    def self.find_by_url url
+      new Pokedex.get URI.parse(url).path
+    end
+
+  end
+end

data/lib/pokedex/modules_helper/description.rb

@@ -0,0 +1,12 @@
+module Pokedex
+  module ModulesHelper
+    module Description
+      require 'pokedex/modules_helper/locale'
+      include Pokedex::ModulesHelper::Locale
+
+      def description(locale='es')
+        extract_locale descriptions, locale, :description
+      end
+    end
+  end
+end

data/lib/pokedex/modules_helper/locale.rb

@@ -0,0 +1,14 @@
+module Pokedex
+  module ModulesHelper
+    module Locale
+      # extract elem from array of hashes depends of locale
+      # array => [{elem: 'translation', locale: 'en'}, {elem: 'traduccion', locale: 'es'}]
+      # locale => 'es', 'en', 'it'...
+      # elem => :name, :description, :genus...
+      def extract_locale(array, locale, elem)
+        n = array.find{ |e| e[:locale] == locale.to_s }
+        n ? n[elem] : ''
+      end
+    end
+  end
+end

data/lib/pokedex/modules_helper/name.rb

@@ -0,0 +1,18 @@
+module Pokedex
+  module ModulesHelper
+    module Name
+      require 'pokedex/modules_helper/locale'
+      include Pokedex::ModulesHelper::Locale
+
+      def name(locale='es')
+        extract_locale names, locale, :name
+      end
+
+      private
+
+      def extract_names(args={})
+        @names = args['names'].map{ |name| {name: name['name'], locale: name['language']['name']} }
+      end
+    end
+  end
+end

data/lib/pokedex/pokemon.rb

@@ -0,0 +1,55 @@
+module Pokedex
+  class Pokemon
+    require 'pokedex/modules_helper/name'
+    include Pokedex::ModulesHelper::Name
+    require 'pokedex/modules_helper/description'
+    include Pokedex::ModulesHelper::Description
+
+    attr_accessor :id, :sprite, :capture_rate, :names, :descriptions, :evolution_chain_url, :is_baby, :generas, :egg_groups, :generation_name
+
+    def initialize(args={})
+      @id                  = args['id']
+      @generas             = args['genera'].map{ |genera| { genus: genera['genus'], locale: genera['language']['name']} }
+      @descriptions        = get_descriptions args['flavor_text_entries']
+      @is_baby             = args['is_baby']
+      @sprite              = "#{Pokedex::API_BASE_URL}/media/img/#{args['id']}.png"
+      @capture_rate        = args['capture_rate']
+      @evolution_chain_url = args['evolution_chain']['url']
+      @egg_groups          = args['egg_groups'].map{ |egg_groups| EggGroup.find_by_url egg_groups['url'] }
+      @generation_name     = args['generation']['name']
+      extract_names args
+    end
+
+    def self.find id
+      new Pokedex.get "api/v2/pokemon-species/#{id}"
+    end
+
+    def self.find_by_url url
+      new Pokedex.get URI.parse(url).path
+    end
+
+    def genera locale='es'
+      extract_locale generas, locale, :genus
+    end
+
+    def evolution_chain
+      EvolutionChain.find_by_url evolution_chain_url
+    end
+
+    private
+
+    # return the first description by locale from API response
+    def get_descriptions text_entries
+      checked_locales = []
+      text_entries.map{ |text_entry|
+        if checked_locales.include?(text_entry['language']['name'])
+          nil
+        else
+          checked_locales << text_entry['language']['name']
+          { locale: text_entry['language']['name'], description: text_entry['flavor_text'] }
+        end
+      }.compact
+    end
+
+  end
+end