scryfall 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dd0a6fe660501c155808d9c1ab0c8ccc601ed85539dc43a98285e2613d7805f
-  data.tar.gz: 796a3d647327cb216fcccd9de9bee31f729bab8225dc26cd37d86cd6db6a20db
+  metadata.gz: cf32af09b3026944696a91897c7653f7f1bb74c7d2bfa7463f72aceb0797fc08
+  data.tar.gz: 671b861417f508c6ce0d71acc45118c58d28c8e70705bde612705806adedd4d8
 SHA512:
-  metadata.gz: 8bac36af77d6698d143869bd599c53e03d694568a2782271861656d98839781f3008acbab83128db8bab1de4e73a967e6ef02d8ef1814cb29ac3a8d85887611e
-  data.tar.gz: ac66a544c02c2db172838c01154572ef39f3c3ca531a516512cb15427db89640fb8bf3a89988b1c21399b4431f83df616b7199bace809736d15e80bc27a161f6
+  metadata.gz: f23d7118d4cc14573b3a9ca5fdbb43f26de2968744f7379155ba4792b607a6c00ebe0fe407b54ff29b67614b130b10c6d042f18e024886b6f3faee369ffa5d08
+  data.tar.gz: 9519a9e4b18ecb194031e325203d43a551affd3aabfcd55843dde379f5d0d807c666808a4fbd9ab8777a7f75bf6a10438e33bf024839105e831f518c8ba0f350

data/README.md

@@ -2,3 +2,52 @@
 [![Gem Version](https://badge.fury.io/rb/scryfall.svg)](https://badge.fury.io/rb/scryfall)
 
 A simple gem that utilizes the Scryfall API to get Magic: the Gathering card information.
+
+
+## Instalation
+
+It will only be needed to specify it on your Gemfile:
+
+```ruby
+gem 'scryfall'
+```
+
+And then run the Bundler
+
+```ruby
+bundle install
+```
+
+# Usage
+
+The Scryfall class will have class methods for each query on the Scryfall API. The methods will reflect their path on the official Scryfall API, following the logic of `Scryfall::<HTTP METHOD>_<PATH IN SNAKE CASE>_<VARIATION>`
+
+At first, there are only a few methods available:
+
+## Cards Named (fuzzy and exact)
+
+It searches for cards named almost as the string passed (fuzzy), or with the exact name as the string passed (exact)
+
+```ruby
+# Fuzzy
+Scryfall::get_cards_named_fuzzy "aust commd"
+
+# Exact
+Scryfall::get_cards_named_exact "Counterspell"
+```
+
+## Search Query
+
+It can search a list of cards using the Scryfall syntax
+
+```ruby
+# The search will return all the cards that fits on the query parameters
+Scryfall::get_cards_search "f:standard t:land id:UW"
+
+# It can be passed the page of the search. Each page of data has a maximum of 175 cards
+Scryfall::get_cards_search "f:standard t:creature", page: 2
+```
+
+# Response
+
+The default response for all calls are JSON. If a `is_struct: true` is passed as argument, the return will be a `OpenStruct` Hash object.

data/lib/scryfall.rb

@@ -19,12 +19,12 @@ class Scryfall
     end
   end
   
-  def self.get_cards_named_fuzy(cardname)
-    get '/cards/named', { fuzzy: cardname }
+  def self.get_cards_named_fuzy(cardname, **args)
+    get '/cards/named', { fuzzy: cardname }, args
   end
 
-  def self.get_cards_named_exact(cardname)
-    get '/cards/named', { exact: cardname }
+  def self.get_cards_named_exact(cardname, **args)
+    get '/cards/named', { exact: cardname }, args
   end
 
   def self.get_cards_search(query, **args)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scryfall
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - João Lucas