hearthstone_api 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01e5c2077c3b00238347ac848b8fbfd94e495b21
+  data.tar.gz: c986de5b61784f8f22d28e0696bf4abeb0899722
+SHA512:
+  metadata.gz: 6fd7721d218f57ebecfcd1419356b60f60d69713816aa88dbcb36d5f7f62dd3433c6fe49161437641451bba41235cac9aaf931ee47961915bf1748ffeb0b571f
+  data.tar.gz: 65562f7449172b4e3191701814aa16bd2bad0a064c71c9aa9873a121dbbd245f07bf84a8657191ea1945fd8490da7b4f48347db2ad18b5c6eac840dbe45391d6

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+*.swo
+*.swp
+.DS_Store
+.env
+*.gem
+.byebug_history

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015, 2016 Bryan Mytko
+
+MIT License
+
+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,259 @@
+![logo](http://i.imgur.com/GisaPGO.png)
+
+# HearthstoneApi
+
+[![Gem Version](https://badge.fury.io/rb/hearthstone_api.svg)](https://badge.fury.io/rb/hearthstone_api)
+
+API Wrapper for hearthstoneapi.com
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hearthstone_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hearthstone_api
+
+Create a .env file and add your [API Key](https://market.mashape.com/omgvamp/hearthstone)
+
+    $ touch .env
+
+**In the .env file:**
+
+    HEARTHSTONE_API_KEY=xxxxxxxxxxxxxxxxxxxx
+
+## Endpoints
+
+All endpoints available via [hearthstoneapi.com](http://hearthstoneapi.com)
+
+1. [All Cards](#all-cards)
+1. [Single Card](#single-card)
+1. [Class Cards](#class-cards)
+1. [Types](#types)
+1. [Sets](#sets)
+1. [Races](#races)
+1. [Qualities](#qualities)
+1. [Factions](#factions)
+1. [Search](#search)
+1. [Card Backs](#card-backs)
+1. [Info](#info)
+
+Examples:
+
+#### All Cards
+_N.B. Cards come back organized by the set they belong to_
+
+```ruby
+HearthstoneApi::Card.all(attack: 12)
+
+=> {"Basic"=>[],
+    "Classic"=>
+      [{"cardId"=>"NEW1_030",
+        "name"=>"Deathwing",
+        "cardSet"=>"Classic",
+        "type"=>"Minion",
+        "rarity"=>"Legendary",
+        "cost"=>10,
+        "attack"=>12,
+        "health"=>12,
+        [...]
+```
+
+#### Single Card
+_This endpoint accepts name or card ID_
+
+```ruby
+HearthstoneApi::Card.single("Ysera", locale: "jaJP")
+
+=> [{"cardId"=>"EX1_572",
+      "name"=>"イセラ",
+      "cardSet"=>"Classic",
+      "type"=>"Minion",
+      "faction"=>"Neutral",
+      "rarity"=>"Legendary",
+      "cost"=>9,
+      [...]
+
+HearthstoneApi::Card.single("EX1_572", locale: "jaJP")
+
+=> [{"cardId"=>"EX1_572",
+      "name"=>"イセラ",
+      "cardSet"=>"Classic",
+      "type"=>"Minion",
+      "faction"=>"Neutral",
+      "rarity"=>"Legendary",
+      "cost"=>9,
+      [...]
+```
+
+#### Class Cards
+
+```ruby
+HearthstoneApi::Card.classes("Paladin", cost: 2)
+
+=> [{"cardId"=>"OG_311",
+      "name"=>"A Light in the Darkness",
+      "cardSet"=>"Whispers of the Old Gods",
+      "type"=>"Spell",
+      "rarity"=>"Common",
+      "cost"=>2,
+      "text"=>"<b>Discover</b> a minion.\nGive it +1/+1.",
+      [...]
+```
+
+#### Types
+
+```ruby
+HearthstoneApi::Cards.type("Weapon")
+
+=> [{"cardId"=>"TB_SPT_BossWeapon",
+      "name"=>"Armory",
+      "cardSet"=>"Tavern Brawl",
+      "type"=>"Weapon",
+      "cost"=>1,
+      "attack"=>0,
+      "durability"=>1,
+      [...]
+```
+
+#### Sets
+
+```ruby
+HearthstoneApi::Cards.sets("Blackrock Mountain")
+
+=> [{"cardId"=>"BRMA16_1",
+      "name"=>"Atramedes",
+      "cardSet"=>"Blackrock Mountain",
+      "type"=>"Hero",
+      "health"=>30,
+      [...]
+```
+
+#### Races
+_Mrglglrglglglglglglgl!_
+
+```ruby
+HearthstoneApi::Cards.races("Murloc")
+
+=> [{"cardId"=>"PRO_001at",
+      "name"=>"Murloc",
+      "cardSet"=>"Promotion",
+      "type"=>"Minion",
+      "cost"=>0,
+      "attack"=>1,
+      "health"=>1,
+      "race"=>"Murloc",
+      [...]
+```
+
+#### Qualities
+
+```ruby
+HearthstoneApi::Cards.qualities("Legendary")
+
+=> [{"cardId"=>"BRMA14_3",
+      "name"=>"Arcanotron",
+      "cardSet"=>"Blackrock Mountain",
+      "type"=>"Minion",
+      "rarity"=>"Legendary",
+      [...]
+```
+
+#### Factions
+
+```ruby
+HearthstoneApi::Cards.factions("Horde")
+
+=> [{"cardId"=>"CS2_189",
+      "name"=>"Elven Archer",
+      "cardSet"=>"Basic",
+      "type"=>"Minion",
+      "faction"=>"Horde",
+      "rarity"=>"Free",
+      "cost"=>1,
+      "attack"=>1,
+      "health"=>1,
+      [...]
+```
+
+#### Search
+_Returns cards by partial name_
+
+** Note: While the official documentation says the search API can accept a locale parameter, it currently breaks the request. Because of this the gem's search API only accepts a search string with no option parameters**
+
+```ruby
+HearthstoneApi::Cards.search("Onyx")
+
+=> [{"cardId"=>"BRMA17_3",
+      "name"=>"Onyxia",
+      "cardSet"=>"Blackrock Mountain",
+      "type"=>"Hero",
+      "health"=>15,
+      [...]
+```
+
+#### Card Backs
+
+```ruby
+HearthstoneApi::Cardbacks.all
+
+=> [{"cardBackId"=>"0",
+      "name"=>"Classic",
+      "description"=>"The only card back you’ll ever need.",
+      "source"=>"startup",
+      "sourceDescription"=>"Default",
+      "enabled"=>true,
+      "img"=>
+        "http://wow.zamimg.com/images/hearthstone/backs/original/Card_Back_Default.png",
+      "imgAnimated"=>
+        "http://wow.zamimg.com/images/hearthstone/backs/animated/Card_Back_Default.gif",
+      "sortCategory"=>"1",
+      "sortOrder"=>"1",
+      [...]
+```
+
+#### Info
+
+```ruby
+HearthstoneApi::Info.all
+
+=> {"patch"=>"5.0.0.12574",
+      "classes"=>
+        ["Druid",
+          "Hunter",
+          "Mage",
+          "Paladin",
+          "Priest",
+          "Rogue",
+          "Shaman",
+          "Warlock",
+          "Warrior",
+          "Dream"],
+      "sets"=>
+        ["Basic",
+          "Classic",
+          "Credits",
+          "Naxxramas",
+          [...]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hearthstone_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Development
+
+    gem build hearthstone_api.gemspec
+    gem install ./hearthstone_api-1.0.2.gem

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/hearthstone_api.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hearthstone_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hearthstone_api"
+  spec.version       = HearthstoneApi::VERSION
+  spec.authors       = ["Bryan Mytko"]
+  spec.email         = ["bryanmytko@gmail.com"]
+  spec.summary       = %q{API Wrapper for hearthstoneapi.com}
+  spec.description   = <<-EOF
+    A wrapper for the Hearthstone API found at hearthstoneapi.com
+  EOF
+  spec.homepage      = "https://github.com/bryanmytko/hearthstone_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10"
+
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "webmock", "~> 1.8"
+  spec.add_development_dependency "byebug", '~> 8.2', '>= 8.2.4'
+
+  spec.add_dependency "httparty", "~> 0.13"
+  spec.add_dependency "json", "~> 1.8"
+  spec.add_dependency "dotenv", "~>2.0"
+end

data/lib/hearthstone_api.rb

@@ -0,0 +1,18 @@
+require "httparty"
+require "dotenv"
+
+Dotenv.load
+
+require "hearthstone_api/base_model"
+require "hearthstone_api/cardbacks"
+require "hearthstone_api/cards"
+require "hearthstone_api/configuration"
+require "hearthstone_api/connection"
+require "hearthstone_api/exceptions"
+require "hearthstone_api/info"
+require "hearthstone_api/version"
+
+module HearthstoneApi
+  include HTTParty
+  extend Configuration
+end

data/lib/hearthstone_api/base_model.rb

@@ -0,0 +1,21 @@
+module HearthstoneApi
+  require "hearthstone_api/request"
+
+  class BaseModel
+    class << self
+      include Request
+
+      private
+
+      def endpoint
+        HearthstoneApi.endpoint
+      end
+    end
+
+    class ::String
+      def capitalize_all
+        split.map(&:capitalize).join(" ")
+      end
+    end
+  end
+end

data/lib/hearthstone_api/cardbacks.rb

@@ -0,0 +1,7 @@
+module HearthstoneApi
+  class Cardbacks < BaseModel
+    def self.all(options = {})
+      get "/cardbacks", options
+    end
+  end
+end

data/lib/hearthstone_api/cards.rb

@@ -0,0 +1,39 @@
+module HearthstoneApi
+  class Cards < BaseModel
+    def self.all(options = {})
+      get "/cards", options
+    end
+
+    def self.single(name_or_id, options = {})
+      get "/cards/#{name_or_id}", options
+    end
+
+    def self.classes(klass, options = {})
+      get "/cards/classes/#{klass.capitalize_all}", options
+    end
+
+    def self.type(type, options = {})
+      get "/cards/types/#{type.capitalize_all}", options
+    end
+
+    def self.sets(set, options = {})
+      get "/cards/sets/#{set.capitalize_all}", options
+    end
+
+    def self.races(race, options = {})
+      get "/cards/races/#{race.capitalize_all}", options
+    end
+
+    def self.qualities(quality, options = {})
+      get "/cards/qualities/#{quality.capitalize_all}", options
+    end
+
+    def self.factions(faction, options = {})
+      get "/cards/factions/#{faction.capitalize_all}", options
+    end
+
+    def self.search(search_term)
+      get "/cards/search/#{search_term}"
+    end
+  end
+end