hearthstone_card_api 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d79457c921527c72de8580ffd57d65f1986c6a6
-  data.tar.gz: 97499ca213a04cddd5872bbd3b2d90df5b6c07d6
+  metadata.gz: 6c1803c850cca3741dd9e94b421d71943eb11216
+  data.tar.gz: 90592bb9d6989151f02fd141bc04042f6e612a8b
 SHA512:
-  metadata.gz: bff57d7eff33868cb9c7a0537b73a0f4af09b2868ee64eb461c7895dad9523b0dcbfe3fab3a567f0d573639e58c26c8aecebdd6943288eafa95cc96b5f0ff387
-  data.tar.gz: 19ca1b33ade1e2da85813d642e01e9009806d42bba5a592614a64e76cf907aba7ccf24f4ed0b5f3778287c8929d02fa985112807bbd44a3a0c7970b057720c17
+  metadata.gz: 49c31241399e22c40e28091da7cb99a221f5e21bf9e9b2642a3a330a532377f3538f5ccf9a44893847502cd8fce9d5b6606efd548491f5a39c1fb258f7805fec
+  data.tar.gz: 5e51ef07fe902960b241cd0bfd04530720d627a7f6f4f9ddfe3ed18aeba3622565f6cfd32af6d9ef2254d39d637bbb6253ee94b1f31c7caeb665de754efe377b

data/.gitignore

@@ -2,3 +2,4 @@
 
 *swo
 *swp
+*.gem

data/README.md

@@ -0,0 +1,108 @@
+# HearthstoneCardApi
+
+[![Gem Version](https://badge.fury.io/rb/hearthstone_card_api.svg)](https://badge.fury.io/rb/hearthstone_card_api)
+
+An easy to use ruby wrapper for the Hearthstone game api located at HearthstoneApi.com
+
+Get cards back in your favorite format (JSON, hash, even ruby objects!)
+
+This gem is currently in *beta* and may be changing frequently until I post otherwise. Use with caution in production applications.
+## How To Install
+If using a Gemfile, add the following line :
+```ruby
+gem 'hearthstone_card_api'
+```
+Then run bundler :
+```ruby
+bundle install
+```
+If not using a Gemfile run :
+```ruby
+gem install hearthstone_card_api
+```
+## Configuration
+Get your api key at https://market.mashape.com/omgvamp/hearthstone
+
+Place this config block in your application, if you are using Rails that place may be in a file you create at **config/initializers/hearthstone_card_api.rb**
+```ruby
+HearthstoneCardApi.configuration do |config|
+   config.api_key = "YOUR_API_KEY_123123"
+   config.data_format = "objects" #THIS LINE IS OPTIONAL!
+end
+```
+Optionally you can also pick your preferred format for the data you receive, currently supported values are "objects", "json", and "hash".
+
+If you do not indicate a **data_format**, "objects" will be the default value.
+## Basic Usage
+```ruby
+foo = HearthstoneCardApi::Public.new
+```
+When you add the above to your code you can access Hearthstone card data very easily :
+```ruby
+cards = foo.get_cards()
+
+cards.count
+  => 1070
+```
+All card methods will return an array of Ruby objects (Assuming your set data format is the default "objects").
+
+When returning objects the only exception to receiving an array is in the **get_card_by_id** method which returns a single object.
+
+By default only player collectible cards are returned, this is equivalent to passing in **collectible: 1**
+
+Passing in **collectible: 0** will return both collectible and non-collectible cards.
+```ruby
+cards = foo.get_cards(collectible:0) 
+
+cards.count
+  => 2844
+```
+See below for many more ways to filter your returned cards.
+
+## Endpoints
+**Return all cards.**
+```ruby
+foo.get_cards
+```
+**Search cards by partial name.**
+```ruby
+cards = foo.search_cards(name:"Boar")
+
+cards[0].name 
+  => "Stonetusk Boar"
+
+cards[0].flavor 
+  => "This card is boaring." 
+```
+**Return a card by its card id.**
+```ruby
+card = foo.get_card_by_id(id:"AT_005")
+
+card.name
+  => "Polymorph: Boar"
+```
+**Return cards by name. (For partial names use the search method instead.)**
+
+This may return more than one card if there are multiple cards with that same name (especially if you are choosing to return both collectible and non-collectible cards), for example "Loatheb" is a collectible card, as well as a boss card.
+
+```ruby
+foo.get_card_by_name(name:"Elven Archer")
+```
+**Returns cards by Type/Race/Quality/Faction/Class.**
+```ruby
+foo.get_cards_by(trait:"qualities", value:"Common") 
+```
+Available trait strings => **"types"**,**"races"**,**"qualities"**,**"factions"**,**"classes"**
+
+For a thorough look at the optional values for the above you can call the **get_info** method or check out HearthstoneApi.com
+
+## Additional Filters
+Pass in a hash with the key "filters" to narrow your card results even further:
+```ruby
+foo.get_cards(filters:{attack:2, cost:3})
+
+foo.search_cards(name:"Archer", filters:{health:1})
+
+foo.get_cards_by(trait:"qualities", value:"Common", filters:{attack:4})
+```
+Available keys for filters => **attack:** , **cost:** , **durability:** , **health:** , **collectible:**

data/hearthstone_card_api.gemspec

@@ -1,6 +1,4 @@
 require File.expand_path('../lib/hearthstone_card_api/version', __FILE__)
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = 'hearthstone_card_api'

data/lib/hearthstone_card_api/version.rb

@@ -1,3 +1,3 @@
 module HearthstoneCardApi
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/hearthstone_card_api.rb

@@ -41,7 +41,12 @@ module HearthstoneCardApi
     def get_card_by_id(args={}) #expects {:id}
       url = "cards/#{args[:id]}"
       args[:url] = url
-      call.return_cards(args)
+      data = call.return_cards(args)
+      if data.is_a? Hash or data.is_a? String #if 404 error, hash, or string
+        return data
+      else 
+        return data[0] #else return single obj
+      end
     end
 
     def get_card_by_name(args={}) #expects {:name}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hearthstone_card_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jeane Ramos
@@ -33,6 +33,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - LICENSE.txt
+- README.md
 - hearthstone_card_api.gemspec
 - lib/hearthstone_card_api.rb
 - lib/hearthstone_card_api/caller.rb